AWS CloudFormation User Guide - Amazon Web Services

657 Pages·2014·4.59 MB·English

by  Amazon Web Services

AWS CloudFormation
User Guide
API Version 2010-05-15
AWS CloudFormation User Guide
AWS CloudFormation: User Guide
Copyright © 2014 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
The following are trademarks of Amazon Web Services, Inc.: Amazon, Amazon Web Services Design, AWS, Amazon CloudFront,
Cloudfront, CloudTrail, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier,
Kinesis, Kindle, Kindle Fire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, Amazon
VPC. In addition, Amazon.com graphics, logos, page headers, button icons, scripts, and service names are trademarks, or trade dress
of Amazon in the U.S. and/or other countries. Amazon's trademarks and trade dress may not be used in connection with any product
or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages
or discredits Amazon.
All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected
to, or sponsored by Amazon.
AWS CloudFormation User Guide
Table of Contents
What is AWS CloudFormation?........................................................................................................ 1
Simplify Infrastructure Management.......................................................................................... 1
Quickly Replicate Your Infrastructure......................................................................................... 1
Easily Control and Track Changes to Your Infrastructure............................................................... 2
Related Information ............................................................................................................... 2
AWS CloudFormation Concepts............................................................................................... 2
Templates .................................................................................................................... 2
Stacks ......................................................................................................................... 4
How Does AWS CloudFormation Work?.................................................................................... 4
Update Stack Workflow .................................................................................................. 5
Delete Stack Workflow.................................................................................................... 6
Additional Resources ..................................................................................................... 6
Getting Started ............................................................................................................................. 7
Signing Up for an AWS Account............................................................................................... 7
Get Started .......................................................................................................................... 8
Step 1: Sign up for the Service......................................................................................... 8
Step 2: Pick a template................................................................................................... 8
Step 3: Make sure you have prepared any required items for the stack.................................. 11
Step 4: Create the stack................................................................................................ 12
Step 5: Monitor the progress of stack creation................................................................... 12
Step 6: Use your stack resources................................................................................... 13
Step 8: Clean Up......................................................................................................... 14
Learn Template Basics ......................................................................................................... 14
What is an AWS CloudFormation Template?..................................................................... 14
Resources: Hello Bucket! .............................................................................................. 15
Resource Properties and Using Resources Together.......................................................... 15
Receiving User Input Using Input Parameters................................................................... 19
Specifying Conditional Values Using Mappings................................................................. 20
Constructed Values and Output Values............................................................................ 22
Next Steps ................................................................................................................. 24
Walkthrough: Updating a Stack .............................................................................................. 24
A Simple Application .................................................................................................... 25
Create the Initial Stack.................................................................................................. 31
Update the Application.................................................................................................. 32
Changing Resource Properties ...................................................................................... 34
Adding Resource Properties.......................................................................................... 37
Change the Stack's Resources ...................................................................................... 38
Availability and Impact Considerations............................................................................. 46
Related Resources ...................................................................................................... 46
Walkthrough: Custom Resources............................................................................................ 47
What is a Custom Resource?......................................................................................... 47
How Custom Resources Work........................................................................................ 47
What's in this Walkthrough?........................................................................................... 47
................................................................................................................................. 48
Part 2: Stack Updates................................................................................................... 50
Part 3: Stack Deletion................................................................................................... 52
See Also .................................................................................................................... 53
Using CloudFormer to Create Templates.................................................................................. 53
Step 1: Create a CloudFormer Stack............................................................................... 54
Step 2: Launch the CloudFormer Stack............................................................................ 55
Step 3: Use CloudFormer to Create a Template................................................................. 56
AWS CloudFormation Endpoints ............................................................................................ 59
Best Practices............................................................................................................................. 61
Reuse Templates to Replicate Stacks in Multiple Environments.................................................... 61
Verify Quotas for All Resource Types....................................................................................... 62
API Version 2010-05-15
iii
AWS CloudFormation User Guide
Do Not Embed Credentials in Your Templates........................................................................... 62
Use AWS-Specific Parameter Types........................................................................................ 62
Use Parameter Constraints.................................................................................................... 62
Use AWS::CloudFormation::Init to Deploy Software Applications on Amazon EC2 Instances............. 63
Validate Templates Before Using Them.................................................................................... 63
Manage All Stack Resources Through AWS CloudFormation....................................................... 63
Use Stack Policies ............................................................................................................... 63
Use AWS CloudTrail to Log AWS CloudFormation Calls............................................................. 64
Use Code Reviews and Revision Controls to Manage Your Templates........................................... 64
Controlling Access with IAM .......................................................................................................... 65
AWS CloudFormation Actions and Resources........................................................................... 65
AWS CloudFormation Conditions............................................................................................ 67
IAM Resources in AWS CloudFormation Templates................................................................... 67
Manage Credentials for Applications Running on Amazon EC2 Instances...................................... 68
Grant Temporary Access (Federated Access)........................................................................... 68
Working with Stacks..................................................................................................................... 70
Using the Console ............................................................................................................... 70
In This Section ............................................................................................................ 70
Logging In to the Console ............................................................................................. 71
Creating a Stack.......................................................................................................... 72
Creating an EC2 Key Pair.............................................................................................. 76
Estimating the Cost of Your Stack................................................................................... 76
Viewing Stack Data and Resources ................................................................................ 77
Deleting a Stack .......................................................................................................... 78
Viewing Deleted Stacks ................................................................................................ 79
Related Topics ............................................................................................................ 79
Using the AWS CLI.............................................................................................................. 79
Creating a Stack.......................................................................................................... 80
Describing and Listing Your Stacks.................................................................................. 80
Viewing Stack Event History.......................................................................................... 83
Listing Resources ........................................................................................................ 85
Retrieving a Template................................................................................................... 86
Validating a Template ................................................................................................... 87
Deleting a Stack .......................................................................................................... 88
Stack Updates..................................................................................................................... 88
Modifying a Stack Template........................................................................................... 89
Updating a Stack ......................................................................................................... 91
Monitoring Progress..................................................................................................... 93
Canceling a Stack Update............................................................................................. 95
Prevent Updates to Stack Resources.............................................................................. 96
Working with Windows Stacks.............................................................................................. 105
In This Section........................................................................................................... 106
Windows AMIs and Templates...................................................................................... 106
Bootstrapping Windows Stacks..................................................................................... 106
Accessing Windows Instances...................................................................................... 110
Working With Templates.............................................................................................................. 114
Template Anatomy ............................................................................................................. 115
See Also .................................................................................................................. 116
Format Version .......................................................................................................... 116
Description ............................................................................................................... 116
Parameters ............................................................................................................... 116
Mappings ................................................................................................................. 121
Conditions ................................................................................................................ 124
Resources ................................................................................................................ 126
Outputs .................................................................................................................... 128
Example Templates ............................................................................................................ 129
Auto Scaling Group with LoadBalancer, Auto Scaling Policies, and CloudWatch Alarms......... 129
Amazon EC2 Running an Amazon Linux 32-bit AMI......................................................... 138
API Version 2010-05-15
iv
AWS CloudFormation User Guide
Create a Load-Balanced Apache Website ...................................................................... 141
Auto-Scaled Worker that uses Spot Instances to Monitor Work in an SQS Queue.................. 144
Template Snippets ............................................................................................................. 150
Auto Scaling Snippets................................................................................................. 151
Amazon CloudFront Template Snippets.......................................................................... 154
Amazon CloudWatch Logs Sample ............................................................................... 158
Amazon EC2 Snippets................................................................................................ 166
AWS Elastic Beanstalk Snippets................................................................................... 175
Elastic Load Balancing Snippets................................................................................... 177
AWS Identity and Access Management Template Snippets................................................ 178
AWS OpsWorks Snippets............................................................................................ 190
Amazon Redshift Snippets........................................................................................... 193
Amazon RDS Template Snippets .................................................................................. 197
Amazon Route 53 Template Snippets............................................................................ 200
Amazon S3 Template Snippets..................................................................................... 203
Amazon SimpleDB Snippets ........................................................................................ 206
Amazon SNS Snippets................................................................................................ 206
Amazon SQS Queue Snippet....................................................................................... 206
Stack Resource Snippets ............................................................................................ 206
Wait Condition Template Snippets................................................................................. 208
AWS CloudFormation Template Snippets ....................................................................... 210
Creating Templates ............................................................................................................ 214
Specifying Intrinsic Functions....................................................................................... 215
Adding Input Parameters............................................................................................. 215
Use Parameters and Mappings to Specify Values in Your Template..................................... 216
Conditionally Creating Resources ................................................................................. 218
Tagging Your Resources.............................................................................................. 219
Specifying Output Values............................................................................................. 219
Creating Wait Conditions............................................................................................. 220
Deploying Applications................................................................................................ 224
Using Regular Expressions.................................................................................................. 242
Template Reference ................................................................................................................... 243
AWS Resource Types ......................................................................................................... 243
AWS::AutoScaling::AutoScalingGroup ........................................................................... 245
AWS::AutoScaling::LaunchConfiguration ........................................................................ 251
AWS::AutoScaling::ScalingPolicy .................................................................................. 257
AWS::AutoScaling::ScheduledAction ............................................................................. 259
AWS::CloudFormation::Authentication ........................................................................... 261
AWS::CloudFormation::CustomResource ....................................................................... 265
AWS::CloudFormation::Init........................................................................................... 268
AWS::CloudFormation::Stack ....................................................................................... 278
AWS::CloudFormation::WaitCondition............................................................................ 280
AWS::CloudFormation::WaitConditionHandle .................................................................. 282
AWS::CloudFront::Distribution ...................................................................................... 283
AWS::CloudTrail::Trail ................................................................................................. 284
AWS::CloudWatch::Alarm............................................................................................ 287
AWS::DynamoDB::Table.............................................................................................. 291
AWS::EC2::CustomerGateway ..................................................................................... 295
AWS::EC2::DHCPOptions ........................................................................................... 297
AWS::EC2::EIP.......................................................................................................... 299
AWS::EC2::EIPAssociation .......................................................................................... 301
AWS::EC2::Instance ................................................................................................... 302
AWS::EC2::InternetGateway ........................................................................................ 309
AWS::EC2::NetworkAcl ............................................................................................... 310
AWS::EC2::NetworkAclEntry........................................................................................ 311
AWS::EC2::NetworkInterface ....................................................................................... 313
AWS::EC2::NetworkInterfaceAttachment ........................................................................ 317
AWS::EC2::Route ...................................................................................................... 318
API Version 2010-05-15
v
AWS CloudFormation User Guide
AWS::EC2::RouteTable ............................................................................................... 321
AWS::EC2::SecurityGroup ........................................................................................... 322
AWS::EC2::SecurityGroupEgress ................................................................................. 325
AWS::EC2::SecurityGroupIngress ................................................................................. 328
AWS::EC2::Subnet..................................................................................................... 332
AWS::EC2::SubnetNetworkAclAssociation...................................................................... 334
AWS::EC2::SubnetRouteTableAssociation...................................................................... 335
AWS::EC2::Volume .................................................................................................... 337
AWS::EC2::VolumeAttachment ..................................................................................... 339
AWS::EC2::VPC ........................................................................................................ 341
AWS::EC2::VPCDHCPOptionsAssociation ..................................................................... 343
AWS::EC2::VPCGatewayAttachment............................................................................. 344
AWS::EC2::VPCPeeringConnection .............................................................................. 346
AWS::EC2::VPNConnection......................................................................................... 354
AWS::EC2::VPNConnectionRoute ................................................................................ 356
AWS::EC2::VPNGateway ............................................................................................ 357
AWS::EC2::VPNGatewayRoutePropagation.................................................................... 358
AWS::ElastiCache::CacheCluster.................................................................................. 360
AWS::ElastiCache::ParameterGroup ............................................................................. 364
AWS::ElastiCache::SecurityGroup ................................................................................ 366
AWS::ElastiCache::SecurityGroupIngress ...................................................................... 366
AWS::ElastiCache::SubnetGroup ................................................................................. 367
AWS::ElasticBeanstalk::Application ............................................................................... 368
AWS::ElasticBeanstalk::ApplicationVersion..................................................................... 369
AWS::ElasticBeanstalk::ConfigurationTemplate ............................................................... 371
AWS::ElasticBeanstalk::Environment............................................................................. 373
AWS::ElasticLoadBalancing::LoadBalancer .................................................................... 376
AWS::IAM::AccessKey ................................................................................................ 383
AWS::IAM::Group ...................................................................................................... 384
AWS::IAM::InstanceProfile........................................................................................... 385
AWS::IAM::Policy ....................................................................................................... 387
AWS::IAM::Role......................................................................................................... 390
AWS::IAM::User......................................................................................................... 394
AWS::IAM::UserToGroupAddition.................................................................................. 395
AWS::Kinesis::Stream................................................................................................. 396
AWS::Logs::LogGroup ................................................................................................ 397
AWS::Logs::MetricFilter............................................................................................... 398
AWS::OpsWorks::App................................................................................................. 399
AWS::OpsWorks::ElasticLoadBalancerAttachment........................................................... 402
AWS::OpsWorks::Instance........................................................................................... 403
AWS::OpsWorks::Layer............................................................................................... 406
AWS::OpsWorks::Stack............................................................................................... 409
AWS::Redshift::Cluster ............................................................................................... 413
AWS::Redshift::ClusterParameterGroup......................................................................... 418
AWS::Redshift::ClusterSecurityGroup ............................................................................ 420
AWS::Redshift::ClusterSecurityGroupIngress .................................................................. 421
AWS::Redshift::ClusterSubnetGroup ............................................................................. 422
AWS::RDS::DBInstance .............................................................................................. 423
AWS::RDS::DBParameterGroup ................................................................................... 432
AWS::RDS::DBSubnetGroup ....................................................................................... 434
AWS::RDS::DBSecurityGroup ...................................................................................... 435
AWS::RDS::DBSecurityGroupIngress ............................................................................ 437
AWS::Route53::HealthCheck ....................................................................................... 438
AWS::Route53::HostedZone ........................................................................................ 439
AWS::Route53::RecordSet .......................................................................................... 440
AWS::Route53::RecordSetGroup .................................................................................. 444
AWS::S3::Bucket ....................................................................................................... 446
AWS::S3::BucketPolicy ............................................................................................... 453
API Version 2010-05-15
vi
AWS CloudFormation User Guide
AWS::SDB::Domain.................................................................................................... 455
AWS::SNS::Topic ....................................................................................................... 455
AWS::SNS::TopicPolicy ............................................................................................... 457
AWS::SQS::Queue..................................................................................................... 458
AWS::SQS::QueuePolicy............................................................................................. 462
Resource Property Types .................................................................................................... 463
AutoScaling Block Device Mapping ............................................................................... 465
AutoScaling EBS Block Device..................................................................................... 466
Auto Scaling MetricsCollection ..................................................................................... 467
Auto Scaling NotificationConfiguration ........................................................................... 467
Auto Scaling Tags ...................................................................................................... 468
CloudFormation Stack Parameters................................................................................ 469
CloudFront DistributionConfig....................................................................................... 470
CloudFront DistributionConfig CacheBehavior................................................................. 472
CloudFront DistributionConfig CustomErrorResponse....................................................... 474
CloudFront DefaultCacheBehavior ................................................................................ 475
CloudFront Logging.................................................................................................... 476
CloudFront DistributionConfig Origin.............................................................................. 477
CloudFront DistributionConfig Origin CustomOrigin.......................................................... 478
CloudFront DistributionConfig Origin S3Origin................................................................. 479
CloudFront DistributionConfiguration Restrictions ............................................................ 479
CloudFront DistributionConfig Restrictions GeoRestriction................................................. 480
CloudFront DistributionConfiguration ViewerCertificate ..................................................... 481
CloudFront ForwardedValues ....................................................................................... 482
CloudFront ForwardedValues Cookies ........................................................................... 482
CloudWatch Metric Dimension...................................................................................... 483
CloudWatch Logs MetricFilter MetricTransformation Property............................................. 485
DynamoDB Attribute Definitions.................................................................................... 486
DynamoDB Global Secondary Indexes .......................................................................... 486
DynamoDB Key Schema............................................................................................. 487
DynamoDB Local Secondary Indexes............................................................................ 488
DynamoDB Projection Object....................................................................................... 489
DynamoDB Provisioned Throughput.............................................................................. 489
Amazon EC2 Block Device Mapping Property................................................................. 490
Amazon Elastic Block Store Block Device Property.......................................................... 492
EC2 ICMP ................................................................................................................ 493
EC2 MountPoint......................................................................................................... 494
EC2 Network Interface................................................................................................ 495
EC2 Network Interface Association ............................................................................... 497
EC2 Network Interface Attachment................................................................................ 498
EC2 Network Interface Group Item................................................................................ 498
EC2 Network Interface Private IP Specification................................................................ 499
EC2 PortRange ......................................................................................................... 499
EC2 Security Group Rule............................................................................................ 500
AWS Elastic Beanstalk Environment Tier........................................................................ 503
AWS Elastic Beanstalk OptionSettings Property Type....................................................... 504
AWS Elastic Beanstalk SourceBundle Property Type........................................................ 505
AWS Elastic Beanstalk SourceConfiguration Property Type............................................... 506
Elastic Load Balancing AccessLoggingPolicy.................................................................. 506
AppCookieStickinessPolicy .......................................................................................... 507
Elastic Load Balancing ConnectionDrainingPolicy............................................................ 508
ElasticLoadBalancing HealthCheck ............................................................................... 509
LBCookieStickinessPolicy............................................................................................ 510
ElasticLoadBalancing Listener...................................................................................... 510
ElasticLoadBalancing Policy ........................................................................................ 512
IAM Policies .............................................................................................................. 514
Name Type ............................................................................................................... 514
AWS OpsWorks ChefConfiguration Type........................................................................ 516
API Version 2010-05-15
vii
AWS CloudFormation User Guide
AWS OpsWorks Recipes Type...................................................................................... 516
AWS OpsWorks Source Type....................................................................................... 517
AWS OpsWorks SslConfiguration Type .......................................................................... 518
AWS OpsWorks StackConfigurationManager Type........................................................... 519
AWS OpsWorks VolumeConfiguration Type..................................................................... 519
Amazon Redshift Parameter Type................................................................................. 520
AWS CloudFormation Resource Tags............................................................................ 521
RDS Security Group Rule............................................................................................ 522
Route 53 AliasTarget Property...................................................................................... 523
Amazon Route 53 Record Set GeoLocation Property....................................................... 523
Amazon Route 53 HealthCheck Configuration................................................................. 524
Amazon Route 53 Hosted Zone Configuration Property.................................................... 526
Amazon S3 Cors Configuration .................................................................................... 526
Amazon S3 Cors Configuration Rule............................................................................. 527
Amazon S3 Lifecycle Configuration............................................................................... 528
Amazon S3 Lifecycle Rule........................................................................................... 528
Amazon S3 Lifecycle Rule Transition............................................................................. 529
Amazon S3 Logging Configuration................................................................................ 530
Amazon S3 Notification Configuration............................................................................ 531
Amazon S3 Notification Topic Configurations .................................................................. 531
Amazon S3 Versioning Configuration............................................................................. 531
Amazon S3 Website Configuration Property.................................................................... 532
Amazon S3 Website Configuration Redirect All Requests To Property................................. 533
Amazon S3 Website Configuration Routing Rules Property............................................... 534
Amazon S3 Website Configuration Routing Rules Redirect Rule Property............................ 534
Amazon S3 Website Configuration Routing Rules Routing Rule Condition Property............... 535
Amazon SNS Subscription........................................................................................... 536
Amazon SQS RedrivePolicy......................................................................................... 536
Resource Attributes............................................................................................................ 537
CreationPolicy ........................................................................................................... 537
DeletionPolicy ........................................................................................................... 539
DependsOn .............................................................................................................. 540
Metadata .................................................................................................................. 543
UpdatePolicy............................................................................................................. 543
Intrinsic Functions.............................................................................................................. 546
Fn::Base64 ............................................................................................................... 547
Condition Functions.................................................................................................... 547
Fn::FindInMap ........................................................................................................... 557
Fn::GetAtt................................................................................................................. 558
Fn::GetAZs ............................................................................................................... 562
Fn::Join.................................................................................................................... 563
Fn::Select ................................................................................................................. 564
Ref .......................................................................................................................... 565
Pseudo Parameters............................................................................................................ 568
CloudFormation Helper Scripts............................................................................................. 569
cfn-init...................................................................................................................... 570
cfn-signal.................................................................................................................. 573
cfn-get-metadata ....................................................................................................... 576
cfn-hup .................................................................................................................... 577
Sample Templates...................................................................................................................... 581
AWS CloudFormation Limits ........................................................................................................ 582
Custom Resource Reference ....................................................................................................... 585
In This Section................................................................................................................... 585
Request Objects ................................................................................................................ 585
Template Developer Request Properties ........................................................................ 585
Custom Resource Provider Request Fields..................................................................... 586
Response Objects.............................................................................................................. 587
Custom Resource Provider Response Fields.................................................................. 587
API Version 2010-05-15
viii
AWS CloudFormation User Guide
Request Types................................................................................................................... 588
In This Section........................................................................................................... 588
Create ..................................................................................................................... 588
Delete ...................................................................................................................... 590
Update..................................................................................................................... 593
Logging API Calls ...................................................................................................................... 596
AWS CloudFormation Information in CloudTrail....................................................................... 596
Understanding AWS CloudFormation Log File Entries.............................................................. 597
Troubleshooting ......................................................................................................................... 601
Troubleshooting Guide ........................................................................................................ 601
Troubleshooting Errors........................................................................................................ 602
Delete Stack Fails ...................................................................................................... 602
Dependency Error...................................................................................................... 602
Error Parsing Parameter When Passing a List................................................................. 602
Insufficient IAM Permissions ........................................................................................ 602
Invalid Value or Unsupported Resource Property............................................................. 603
Limit Exceeded.......................................................................................................... 603
Security Group Does Not Exist in VPC........................................................................... 603
Update Rollback Failed ............................................................................................... 603
Wait Condition Didn't Receive the Required Number of Signals from an Amazon EC2 In-
stance...................................................................................................................... 603
Contacting Support ............................................................................................................ 604
Document History ...................................................................................................................... 605
AWS Glossary........................................................................................................................... 617
API Version 2010-05-15
ix
AWS CloudFormation User Guide
Simplify Infrastructure Management
What is AWS CloudFormation?
AWS CloudFormation is a service that helps you model and set up your Amazon Web Services resources
so that you can spend less time managing those resources and more time focusing on your applications
that run in AWS.You create a template that describes all the AWS resources that you want (like Amazon
EC2 instances or Amazon RDS DB instances), and AWS CloudFormation takes care of provisioning and
configuring those resources for you.You don't need to individually create and configure AWS resources
and figure out what's dependent on what; AWS CloudFormation handles all of that.The following scen-
arios demonstrate how AWS CloudFormation can help.
Simplify Infrastructure Management
For a scalable web application that also includes a back-end database, you might use an Auto Scaling
group, an Elastic Load Balancing load balancer, and an Amazon Relational Database Service database
instance. Normally, you might use each individual service to provision these resources. And after you
create the resources, you would have to configure them to work together. All these tasks can add com-
plexity and time before you even get your application up and running.
Instead, you can create or modify an existing AWS CloudFormation template.Templates describes all
of your resources and their properties.When you use that template to create an AWS CloudFormation
stack, AWS CloudFormation provisions the Auto Scaling group, load balancer, and database for you.
After the stack has been successfully created, your AWS resources are up and running.You can delete
the stack just as easily, which deletes all the resources in the stack. By using AWS CloudFormation, you
easily manage a collection of resources as a single unit.
Quickly Replicate Your Infrastructure
If your application requires additional availability, you might replicate it in multiple regions so that if one
region becomes unavailable, your users can still use your application in other regions.The challenge in
replicating your application is that it also requires you to replicate your resources. Not only do you need
to record all the resources that your application requires, but you must also provision and configure those
resources in each region.
When you use AWS CloudFormation, you can reuse your template to set up your resources consistently
and repeatedly. Just describe your resources once and then provision the same resources over and over
in multiple regions.
API Version 2010-05-15
1