initial commit

Author: David Huntsperger

doc_source/CHAP_TemplateQuickRef.md

@@ -0,0 +1,26 @@
+# Template Snippets<a name="CHAP_TemplateQuickRef"></a>
+
+This section provides a number of example scenarios that you can use to understand how to declare various AWS CloudFormation template parts\. You can also use the snippets as a starting point for sections of your custom templates\. 
+
+
++ [General Template Snippets](quickref-general.md)
++ [Auto Scaling Template Snippets](quickref-autoscaling.md)
++ [AWS CloudFormation Template Snippets](quickref-cloudformation.md)
++ [Amazon CloudFront Template Snippets](quickref-cloudfront.md)
++ [Amazon CloudWatch Template Snippets](quickref-cloudwatch.md)
++ [Amazon CloudWatch Logs Template Snippets](quickref-cloudwatchlogs.md)
++ [Amazon DynamoDB Template Snippets](quickref-dynamodb.md)
++ [Amazon EC2 Template Snippets](quickref-ec2.md)
++ [Amazon Elastic Container Service Template Snippets](quickref-ecs.md)
++ [Amazon Elastic File System Sample Template](quickref-efs.md)
++ [Elastic Beanstalk Template Snippets](quickref-elasticbeanstalk.md)
++ [Elastic Load Balancing Template Snippets](quickref-elb.md)
++ [AWS Identity and Access Management Template Snippets](quickref-iam.md)
++ [AWS Lambda Template](quickref-lambda.md)
++ [AWS OpsWorks Template Snippets](quickref-opsworks.md)
++ [Amazon Redshift Template Snippets](quickref-redshift.md)
++ [Amazon RDS Template Snippets](quickref-rds.md)
++ [Route 53 Template Snippets](quickref-route53.md)
++ [Amazon S3 Template Snippets](quickref-s3.md)
++ [Amazon SNS Template Snippets](quickref-sns.md)
++ [Amazon SQS Template Snippets](scenario-sqs-queue.md)

doc_source/CHAP_Using.md

@@ -0,0 +1,14 @@
+# Walkthroughs<a name="CHAP_Using"></a>
+
+ Templates are JSON\- or YAML\-formatted text files that describe the AWS resources that you want to provision or update in your AWS CloudFormation stacks\. To create templates, you can use AWS CloudFormation Designer or a text editor\.
+
+The following walkthroughs show how to create sample AWS CloudFormation templates using AWS CloudFormation Designer and plain text\.
+
+
++ [Walkthrough: Use AWS CloudFormation Designer to Create a Basic Web Server](working-with-templates-cfn-designer-walkthrough-createbasicwebserver.md)
++ [Walkthrough: Use AWS CloudFormation Designer to Modify a Stack's Template](working-with-templates-cfn-designer-walkthrough-updatebasicwebserver.md)
++ [Walkthrough: Peer with an Amazon VPC in Another AWS Account](peer-with-vpc-in-another-account.md)
++ [Walkthrough: Refer to Resource Outputs in Another AWS CloudFormation Stack](walkthrough-crossstackref.md)
++ [Walkthrough: Create a Scalable, Load\-balancing Web Server](example-templates-autoscaling.md)
++ [Deploying Applications on Amazon EC2 with AWS CloudFormation](deploying.applications.md)
++ [Creating Wait Conditions in a Template](using-cfn-waitcondition.md)

doc_source/GettingStarted.Walkthrough.md

@@ -0,0 +1,14 @@
+# Getting Started with AWS CloudFormation<a name="GettingStarted"></a>
+
+Because you can use AWS CloudFormation to launch many different types of resources, the getting started walkthrough will touch on just a few simple concepts to help you get an idea of how to use AWS CloudFormation\.
+
+In this section, you will use the AWS Management Console to create a stack from an example template from the [AWS CloudFormation Sample Template Library](http://aws.amazon.com/cloudformation/aws-cloudformation-templates/) and learn the basics of creating a template\.
+
+In the following walkthrough, we'll use a sample template to launch, update, and delete a stack\. After you learn the fundamentals, you can learn more about creating more complex templates and stacks\.
+
+AWS CloudFormation makes deploying a set of Amazon Web Services \(AWS\) resources as simple as submitting a template\. A *template* is a simple text file that describes a *stack*, a collection of AWS resources you want to deploy together as a group\. You use the template to define all the AWS resources you want in your stack\. This can include Amazon Elastic Compute Cloud instances, Amazon Relational Database Service DB Instances, and other resources\. For a list of resource types, see \.
+
+
++ [Get Started](GettingStarted.Walkthrough.md)
++ [Learn Template Basics](gettingstarted.templatebasics.md)
++ [Walkthrough: Updating a Stack](updating.stacks.walkthrough.md)

doc_source/GettingStarted.md

@@ -0,0 +1,29 @@
+# What is AWS CloudFormation?<a name="Welcome"></a>
+
+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 scenarios demonstrate how AWS CloudFormation can help\.
+
+## Simplify Infrastructure Management<a name="w3ab2b5b5"></a>
+
+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 complexity and time before you even get your application up and running\.
+
+Instead, you can create or modify an existing AWS CloudFormation template\. A template 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<a name="w3ab2b5b7"></a>
+
+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\. 
+
+## Easily Control and Track Changes to Your Infrastructure<a name="w3ab2b5b9"></a>
+
+In some cases, you might have underlying resources that you want to upgrade incrementally\. For example, you might change to a higher performing instance type in your Auto Scaling launch configuration so that you can reduce the maximum number of instances in your Auto Scaling group\. If problems occur after you complete the update, you might need to roll back your infrastructure to the original settings\. To do this manually, you not only have to remember which resources were changed, you also have to know what the original settings were\.
+
+When you provision your infrastructure with AWS CloudFormation, the AWS CloudFormation template describes exactly what resources are provisioned and their settings\. Because these templates are text files, you simply track differences in your templates to track changes to your infrastructure, similar to the way developers control revisions to source code\. For example, you can use a version control system with your templates so that you know exactly what changes were made, who made them, and when\. If at any point you need to reverse changes to your infrastructure, you can use a previous version of your template\.
+
+## Related Information<a name="w3ab2b5c13"></a>
+
++ For more information about AWS CloudFormation stacks and templates, see [AWS CloudFormation Concepts](cfn-whatis-concepts.md)\.
+
++ For an overview about how to use AWS CloudFormation, see [How Does AWS CloudFormation Work?](cfn-whatis-howdoesitwork.md)\.
+
++ For pricing information, see [AWS CloudFormation Pricing](http://aws.amazon.com/cloudformation/pricing/)\.

doc_source/ReleaseHistory.md

@@ -0,0 +1,183 @@
+# CreationPolicy Attribute<a name="aws-attribute-creationpolicy"></a>
+
+Associate the `CreationPolicy` attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded\. To signal a resource, you can use the cfn\-signal helper script or [http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SignalResource.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SignalResource.html) API\. AWS CloudFormation publishes valid signals to the stack events so that you track the number of signals sent\.
+
+The creation policy is invoked only when AWS CloudFormation creates the associated resource\. Currently, the only AWS CloudFormation resources that support creation policies are [AWS::AutoScaling::AutoScalingGroup](aws-properties-as-group.md), [AWS::EC2::Instance](aws-properties-ec2-instance.md), and [AWS::CloudFormation::WaitCondition](aws-properties-waitcondition.md)\.
+
+Use the `CreationPolicy` attribute when you want to wait on resource configuration actions before stack creation proceeds\. For example, if you install and configure software applications on an EC2 instance, you might want those applications to be running before proceeding\. In such cases, you can add a `CreationPolicy` attribute to the instance, and then send a success signal to the instance after the applications are installed and configured\. For a detailed example, see [Deploying Applications on Amazon EC2 with AWS CloudFormation](deploying.applications.md)\.
+
+## Syntax<a name="w3ab2c21c23b7b9"></a>
+
+### JSON<a name="aws-attribute-creationpolicy-syntax.json"></a>
+
+```
+"CreationPolicy" : {
+  "[[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-autoscalingcreationpolicy)" : {
+    "[[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-autoscalingcreationpolicy-minsuccessfulinstancespercent)" : Integer
+  },
+  "[[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-resourcesignal)" : {    
+    "[[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-resourcesignal-count)" : Integer,
+    "[[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-resourcesignal-timeout)" : String
+  }
+}
+```
+
+### YAML<a name="aws-attribute-creationpolicy-syntax.yaml"></a>
+
+```
+CreationPolicy:
+  [[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-autoscalingcreationpolicy):
+    [[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-autoscalingcreationpolicy-minsuccessfulinstancespercent): Integer
+  [[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-resourcesignal):    
+    [[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-resourcesignal-count): Integer
+    [[ERROR] BAD/MISSING LINK TEXT](#cfn-attributes-creationpolicy-resourcesignal-timeout): String
+```
+
+## CreationPolicy Properties<a name="cfn-attributes-creationpolicy-properties"></a>
+
+`AutoScalingCreationPolicy`  
+For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed\.    
+`MinSuccessfulInstancesPercent`  
+Specifies the percentage of instances in an Auto Scaling replacement update that must signal success for the update to succeed\. You can specify a value from `0` to `100`\. AWS CloudFormation rounds to the nearest tenth of a percent\. For example, if you update five instances with a minimum successful percentage of `50`, three instances must signal success\. If an instance doesn't send a signal within the time specified by the `Timeout` property, AWS CloudFormation assumes that the instance wasn't created\.  
+*Default*: `100`  
+*Type*: Integer  
+*Required: *No
+
+`ResourceSignal`  
+When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals\.    
+`Count`  
+The number of success signals AWS CloudFormation must receive before it sets the resource status as `CREATE_COMPLETE`\. If the resource receives a failure signal or doesn't receive the specified number of signals before the timeout period expires, the resource creation fails and AWS CloudFormation rolls the stack back\.  
+*Default*: `1`  
+*Type*: Integer  
+*Required: *No  
+`Timeout`  
+The length of time that AWS CloudFormation waits for the number of signals that was specified in the `Count` property\. The timeout period starts after AWS CloudFormation starts creating the resource, and the timeout expires no sooner than the time you specify but can occur shortly thereafter\. The maximum time that you can specify is 12 hours\.  
+The value must be in [ISO8601 duration format](http://en.wikipedia.org/wiki/ISO_8601#Durations), in the form: "PT*\#*H*\#*M*\#*S", where each *\#* is the number of hours, minutes, and seconds, respectively\. For best results, specify a period of time that gives your instances plenty of time to get up and running\. A shorter timeout can cause a rollback\.  
+*Default*: `PT5M` \(5 minutes\)  
+*Type*: String  
+*Required: *No
+
+## Examples<a name="w3ab2c21c23b7c13"></a>
+
+### Auto Scaling Group<a name="w3ab2c21c23b7c13b2"></a>
+
+The following example shows how to add a creation policy to an Auto Scaling group\. The creation policy requires three success signals and times out after 15 minutes\.
+
+To have instances wait for an Elastic Load Balancing health check before they signal success, add a health\-check verification by using the [cfn\-init](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html) helper script\. For an example, see the `verify_instance_health` command in the [Auto Scaling rolling updates](https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml) sample template\.
+
+#### JSON<a name="aws-attribute-creationpolicy-example-1.json"></a>
+
+```
+"AutoScalingGroup": {
+  "Type": "AWS::AutoScaling::AutoScalingGroup",
+  "Properties": {
+    "AvailabilityZones": { "Fn::GetAZs": "" },
+    "LaunchConfigurationName": { "Ref": "LaunchConfig" },
+    "DesiredCapacity": "3",
+    "MinSize": "1",
+    "MaxSize": "4"
+  },
+  "CreationPolicy": {
+    "ResourceSignal": {
+      "Count": "3",
+      "Timeout": "PT15M"
+    }
+  },
+  "UpdatePolicy" : {
+    "AutoScalingScheduledAction" : {
+      "IgnoreUnmodifiedGroupSizeProperties" : "true"
+    },
+    "AutoScalingRollingUpdate" : {
+      "MinInstancesInService" : "1",
+      "MaxBatchSize" : "2",
+      "PauseTime" : "PT1M",
+      "WaitOnResourceSignals" : "true"
+    }
+  }
+},
+"LaunchConfig": {
+  "Type": "AWS::AutoScaling::LaunchConfiguration",
+  "Properties": {
+    "ImageId": "ami-16d18a7e",
+    "InstanceType": "t2.micro",
+    "UserData": {
+      "Fn::Base64": {
+        "Fn::Join" : [ "", [
+          "#!/bin/bash -xe\n",
+          "yum install -y aws-cfn-bootstrap\n",
+          "/opt/aws/bin/cfn-signal -e 0 --stack ", { "Ref": "AWS::StackName" },
+          " --resource AutoScalingGroup ",
+          " --region ", { "Ref" : "AWS::Region" }, "\n"
+        ] ]
+      }
+    }
+  }
+}
+```
+
+#### YAML<a name="aws-attribute-creationpolicy-example-1.yaml"></a>
+
+```
+AutoScalingGroup:
+  Type: AWS::AutoScaling::AutoScalingGroup
+  Properties:
+    AvailabilityZones:
+      Fn::GetAZs: ''
+    LaunchConfigurationName:
+      Ref: LaunchConfig
+    DesiredCapacity: '3'
+    MinSize: '1'
+    MaxSize: '4'
+  CreationPolicy:
+    ResourceSignal:
+      Count: '3'
+      Timeout: PT15M
+  UpdatePolicy:
+    AutoScalingScheduledAction:
+      IgnoreUnmodifiedGroupSizeProperties: 'true'
+    AutoScalingRollingUpdate:
+      MinInstancesInService: '1'
+      MaxBatchSize: '2'
+      PauseTime: PT1M
+      WaitOnResourceSignals: 'true'
+LaunchConfig:
+  Type: AWS::AutoScaling::LaunchConfiguration
+  Properties:
+    ImageId: ami-16d18a7e
+    InstanceType: t2.micro
+    UserData:
+      "Fn::Base64":
+        !Sub |
+          #!/bin/bash -xe
+          yum update -y aws-cfn-bootstrap
+          /opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --resource AutoScalingGroup --region ${AWS::Region}
+```
+
+### WaitCondition<a name="w3ab2c21c23b7c13b4"></a>
+
+The following example shows how to add a creation policy to a wait condition\.
+
+#### JSON<a name="aws-attribute-creationpolicy-example-2.json"></a>
+
+```
+"WaitCondition" : {
+    "Type" : "AWS::CloudFormation::WaitCondition",
+    "CreationPolicy" : {
+        "ResourceSignal" : {
+            "Timeout" : "PT15M",
+            "Count" : "5"
+        }
+    }
+}
+```
+
+#### YAML<a name="aws-attribute-creationpolicy-example-2.yaml"></a>
+
+```
+WaitCondition:
+  Type: AWS::CloudFormation::WaitCondition
+  CreationPolicy:
+    ResourceSignal:
+      Timeout: PT15M
+      Count: 5
+```