Skip to content
This repository was archived by the owner on Dec 7, 2023. It is now read-only.

Commit 48655ad

Browse files
committed
periodic update 29 apr 2020
1 parent bc41be9 commit 48655ad

File tree

269 files changed

+1889
-1277
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

269 files changed

+1889
-1277
lines changed

doc_source/AWS_Transfer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Transfer for SFTP Resource Type Reference<a name="AWS_Transfer"></a>
1+
# AWS Transfer Family Resource Type Reference<a name="AWS_Transfer"></a>
22

33
**Resource Types**
44
+ [AWS::Transfer::Server](aws-resource-transfer-server.md)

doc_source/GettingStarted.Walkthrough.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ First, you'll need a template that specifies the resources that you want in your
1010
AWS CloudFormation is free, but the AWS resources that AWS CloudFormation creates are live \(and not running in a sandbox\)\. You will incur the standard usage fees for these resources until you terminate them in the last task in this tutorial\. The total charges will be minimal\. For information about how you might minimize any charges, go to [http://aws\.amazon\.com/free/](http://aws.amazon.com/free/)\.
1111

1212
**To view the template**
13-
+ You can view the [JSON](https://s3-us-west-2.amazonaws.com/cloudformation-templates-us-west-2/WordPress_Single_Instance.template) or [YAML](https://s3-us-west-2.amazonaws.com/cloudformation-templates-us-west-2/WordPress_Single_Instance.yaml) WordPress sample template\. You don't need to download it because you will use the template URL later in this guide\. For more information about the template formats, see [AWS CloudFormation Template Formats](template-formats.md)\.
13+
+ You can view the [JSON](https://s3.us-west-2.amazonaws.com/cloudformation-templates-us-west-2/WordPress_Single_Instance.template) or [YAML](https://s3.us-west-2.amazonaws.com/cloudformation-templates-us-west-2/WordPress_Single_Instance.yaml) WordPress sample template\. You don't need to download it because you will use the template URL later in this guide\. For more information about the template formats, see [AWS CloudFormation Template Formats](template-formats.md)\.
1414

1515
A template is a JSON or YAML text file that contains the configuration information about the AWS resources you want to create in the stack\. For this walkthrough, the sample template includes six top\-level sections: `AWSTemplateFormatVersion`, `Description`, `Parameters`, `Mappings`, `Resources`, and `Outputs`; however, only the `Resources` section is required\.
1616

@@ -290,7 +290,7 @@ You will create your stack based on the *WordPress\-1\.0\.0* file discussed earl
290290

291291
1. In the **Template** section, select **Specify an Amazon S3 Template URL** to type or paste the URL for the sample WordPress template, and then click **Next**:
292292

293-
`https://s3-us-west-2.amazonaws.com/cloudformation-templates-us-west-2/WordPress_Single_Instance.template`
293+
`https://s3.us-west-2.amazonaws.com/cloudformation-templates-us-west-2/WordPress_Single_Instance.template`
294294
**Note**
295295
AWS CloudFormation templates that are stored in an S3 bucket must be accessible to the user who is creating the stack, and must be located in the *same region* as the stack that is being created\. Therefore, if the S3 bucket is located in the `us-east-2` Region, the stack must also be created in `us-east-2`\.
296296

doc_source/ReleaseHistory.md

Lines changed: 193 additions & 27 deletions
Large diffs are not rendered by default.

doc_source/Welcome.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
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\.
44

5-
## Simplify Infrastructure Management<a name="w5792ab1b5b5"></a>
5+
## Simplify Infrastructure Management<a name="w5979ab1b5b5"></a>
66

77
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\.
88

99
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\.
1010

11-
## Quickly Replicate Your Infrastructure<a name="w5792ab1b5b7"></a>
11+
## Quickly Replicate Your Infrastructure<a name="w5979ab1b5b7"></a>
1212

1313
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\.
1414

1515
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\.
1616

17-
## Easily Control and Track Changes to Your Infrastructure<a name="w5792ab1b5b9"></a>
17+
## Easily Control and Track Changes to Your Infrastructure<a name="w5979ab1b5b9"></a>
1818

1919
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\.
2020

2121
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\.
2222

23-
## Related Information<a name="w5792ab1b5c13"></a>
23+
## Related Information<a name="w5979ab1b5c13"></a>
2424
+ For more information about AWS CloudFormation stacks and templates, see [AWS CloudFormation Concepts](cfn-whatis-concepts.md)\.
2525
+ For an overview about how to use AWS CloudFormation, see [How Does AWS CloudFormation Work?](cfn-whatis-howdoesitwork.md)\.
2626
+ For pricing information, see [AWS CloudFormation Pricing](http://aws.amazon.com/cloudformation/pricing/)\.

doc_source/aws-attribute-creationpolicy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The creation policy is invoked only when AWS CloudFormation creates the associat
66

77
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)\.
88

9-
## Syntax<a name="w5792ab1c25c19b7b9"></a>
9+
## Syntax<a name="w5979ab1c25c23b7b9"></a>
1010

1111
### JSON<a name="aws-attribute-creationpolicy-syntax.json"></a>
1212

@@ -57,9 +57,9 @@ The value must be in [ISO8601 duration format](http://en.wikipedia.org/wiki/ISO_
5757
*Type*: String
5858
*Required*: No
5959

60-
## Examples<a name="w5792ab1c25c19b7c13"></a>
60+
## Examples<a name="w5979ab1c25c23b7c13"></a>
6161

62-
### Auto Scaling Group<a name="w5792ab1c25c19b7c13b2"></a>
62+
### Auto Scaling Group<a name="w5979ab1c25c23b7c13b2"></a>
6363

6464
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\.
6565

@@ -153,7 +153,7 @@ LaunchConfig:
153153
/opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --resource AutoScalingGroup --region ${AWS::Region}
154154
```
155155

156-
### WaitCondition<a name="w5792ab1c25c19b7c13b4"></a>
156+
### WaitCondition<a name="w5979ab1c25c23b7c13b4"></a>
157157

158158
The following example shows how to add a creation policy to a wait condition\.
159159

doc_source/aws-attribute-dependson.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ You can use the `DependsOn` attribute with any resource\. Here are some typical
1515
**Note**
1616
During a stack update, resources that depend on updated resources are updated automatically\. AWS CloudFormation makes no changes to the automatically\-updated resources, but, if a stack policy is associated with these resources, your account must have the permissions to update them\.
1717

18-
## Syntax<a name="w5792ab1c25c19c15c13"></a>
18+
## Syntax<a name="w5979ab1c25c23c15c13"></a>
1919

2020
The `DependsOn` attribute can take a single string or list of strings\.
2121

2222
```
2323
"DependsOn" : [ String, ... ]
2424
```
2525

26-
## Example<a name="w5792ab1c25c19c15c15"></a>
26+
## Example<a name="w5979ab1c25c23c15c15"></a>
2727

2828
The following template contains an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource with a `DependsOn` attribute that specifies myDB, an [AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html)\. When AWS CloudFormation creates this stack, it first creates myDB, then creates Ec2Instance\.
2929

@@ -234,7 +234,7 @@ EC2Host:
234234
Ref: PublicSubnet
235235
```
236236

237-
### Amazon ECS Service and Auto Scaling Group<a name="w5792ab1c25c19c15c17c18"></a>
237+
### Amazon ECS Service and Auto Scaling Group<a name="w5979ab1c25c23c15c17c18"></a>
238238

239239
When you use Auto Scaling or Amazon Elastic Compute Cloud \(Amazon EC2\) to create container instances for an Amazon ECS cluster, the Amazon ECS service resource must have a dependency on the Auto Scaling group or Amazon EC2 instances, as shown in the following snippet\. That way the container instances are available and associated with the Amazon ECS cluster before AWS CloudFormation creates the Amazon ECS service\.
240240

@@ -292,7 +292,7 @@ service:
292292
Ref: taskdefinition
293293
```
294294

295-
### IAM Role Policy<a name="w5792ab1c25c19c15c17c20"></a>
295+
### IAM Role Policy<a name="w5979ab1c25c23c15c17c20"></a>
296296

297297
Resources that make additional calls to AWS require a service role, which permits a service to make calls to AWS on your behalf\. For example, the `AWS::CodeDeploy::DeploymentGroup` resource requires a service role so that CodeDeploy has permissions to deploy applications to your instances\. When you have a single template that defines a service role, the role's policy \(by using the `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy` resource\), and a resource that uses the role, add a dependency so that the resource depends on the role's policy\. This dependency ensures that the policy is available throughout the resource's lifecycle\.
298298

doc_source/aws-attribute-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ AWS CloudFormation does not validate the syntax within the Metadata attribute\.
77

88
You can retrieve this data using the AWS command [https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-stack-resource.html](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-stack-resource.html) or the [DescribeStackResource action](http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeStackResource.html)\.
99

10-
## Example<a name="w5792ab1c25c19c19b9"></a>
10+
## Example<a name="w5979ab1c25c23c19b9"></a>
1111

1212
The following template contains an Amazon S3 bucket resource with a Metadata attribute\.
1313

doc_source/aws-attribute-updatepolicy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ For an example that specifies the `UpdatePolicy` attribute for an `AWS::Lambda::
301301

302302
The following examples show how to add an update policy to an Auto Scaling group and how to maintain availability when updating metadata\.
303303

304-
### Add an UpdatePolicy to an Auto Scaling Group<a name="w5792ab1c25c19c23c19b4"></a>
304+
### Add an UpdatePolicy to an Auto Scaling Group<a name="w5979ab1c25c23c23c19b4"></a>
305305

306306
The following example shows how to add an update policy\. During an update, the Auto Scaling group updates instances in batches of two and keeps a minimum of one instance in service\. Because the `WaitOnResourceSignals` flag is set, the Auto Scaling group waits for new instances that are added to the group\. The new instances must signal the Auto Scaling group before it updates the next batch of instances\.
307307

@@ -377,7 +377,7 @@ ScheduledAction:
377377
StartTime: '2017-06-02T20 : 00 : 00Z'
378378
```
379379

380-
### AutoScalingReplacingUpdate Policy<a name="w5792ab1c25c19c23c19b6"></a>
380+
### AutoScalingReplacingUpdate Policy<a name="w5979ab1c25c23c23c19b6"></a>
381381

382382
The following example declares a policy that forces an associated Auto Scaling group to be replaced during an update\. For the update to succeed, a percentage of instances \(specified by the `MinSuccessfulPercentParameter` parameter\) must signal success within the `Timeout` period\.
383383

@@ -414,7 +414,7 @@ CreationPolicy:
414414
MinSuccessfulInstancesPercent: !Ref 'MinSuccessfulPercentParameter'
415415
```
416416

417-
### Maintain Availability When Updating the Metadata for the cfn\-init Helper Script<a name="w5792ab1c25c19c23c19b8"></a>
417+
### Maintain Availability When Updating the Metadata for the cfn\-init Helper Script<a name="w5979ab1c25c23c23c19b8"></a>
418418

419419
When you install software applications on your instances, you might use the [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-init.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-init.html) metadata key and the [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html) helper script to bootstrap the instances in your Auto Scaling group\. AWS CloudFormation installs the packages, runs the commands, and performs other bootstrapping actions described in the metadata\.
420420

@@ -425,7 +425,7 @@ Forcing a rolling update requires AWS CloudFormation to create a new instance an
425425

426426
To force a rolling update, change the logical ID of the launch configuration resource, and then update the stack and any references pointing to the original logic ID \(such as the associated Auto Scaling group\)\. AWS CloudFormation triggers a rolling update on the Auto Scaling group, replacing all instances\.
427427

428-
### Original Template<a name="w5792ab1c25c19c23c19c10"></a>
428+
### Original Template<a name="w5979ab1c25c23c23c19c10"></a>
429429

430430
```
431431
"LaunchConfig": {
@@ -439,7 +439,7 @@ To force a rolling update, change the logical ID of the launch configuration res
439439
}
440440
```
441441

442-
### Updated Logical ID<a name="w5792ab1c25c19c23c19c12"></a>
442+
### Updated Logical ID<a name="w5979ab1c25c23c23c19c12"></a>
443443

444444
```
445445
"LaunchConfigUpdateRubygemsPkg": {

doc_source/aws-properties-acmpca-certificateauthority-crlconfiguration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Contains configuration information for a certificate revocation list \(CRL\)\. Your private certificate authority \(CA\) creates base CRLs\. Delta CRLs are not supported\. You can enable CRLs for your new or an existing private CA by setting the **Enabled** parameter to `true`\. Your private CA writes CRLs to an S3 bucket that you specify in the **S3BucketName** parameter\. You can hide the name of your bucket by specifying a value for the **CustomCname** parameter\. Your private CA copies the CNAME or the S3 bucket name to the **CRL Distribution Points** extension of each certificate it issues\. Your S3 bucket policy must give write permission to ACM Private CA\.
44

5+
ACM Private CA assets that are stored in Amazon S3 can be protected with encryption\. For more information, see [Encrypting Your CRLs](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption)\.
6+
57
Your private CA uses the value in the **ExpirationInDays** parameter to calculate the **nextUpdate** field in the CRL\. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked\. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report\. Only time valid certificates are listed in the CRL\. Expired certificates are not included\.
68

79
CRLs contain the following fields:

doc_source/aws-properties-apigatewayv2-authorizer-jwtconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To declare this entity in your AWS CloudFormation template, use the following sy
2626
## Properties<a name="aws-properties-apigatewayv2-authorizer-jwtconfiguration-properties"></a>
2727

2828
`Audience` <a name="cfn-apigatewayv2-authorizer-jwtconfiguration-audience"></a>
29-
A list of the intended recipients of the JWT\. A valid JWT must provide an `aud` that matches at least one entry in this list\. See [RFC 7519](https://tools.ietf.org/html/rfc7519#section-4.1.3)\. Supported only for HTTP APIs\.
29+
A list of the intended recipients of the JWT\. A valid JWT must provide an `aud` that matches at least one entry in this list\. See [RFC 7519](https://tools.ietf.org/html/rfc7519#section-4.1.3)\. Required for the `JWT` authorizer type\. Supported only for HTTP APIs\.
3030
*Required*: No
3131
*Type*: List of String
3232
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

doc_source/aws-properties-apigatewayv2-stage-routesettings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Specifies the logging level for this route: `INFO`, `ERROR`, or `OFF`\. This pro
4949
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
5050

5151
`ThrottlingBurstLimit` <a name="cfn-apigatewayv2-stage-routesettings-throttlingburstlimit"></a>
52-
Specifies the throttling burst limit\. Supported only for WebSocket APIs\.
52+
Specifies the throttling burst limit\.
5353
*Required*: No
5454
*Type*: Integer
5555
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
5656

5757
`ThrottlingRateLimit` <a name="cfn-apigatewayv2-stage-routesettings-throttlingratelimit"></a>
58-
Specifies the throttling rate limit\. Supported only for WebSocket APIs\.
58+
Specifies the throttling rate limit\.
5959
*Required*: No
6060
*Type*: Double
6161
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

doc_source/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The maximum capacity\.
3232

3333
`MinCapacity` <a name="cfn-applicationautoscaling-scalabletarget-scalabletargetaction-mincapacity"></a>
3434
The minimum capacity\.
35+
For Lambda provisioned concurrency, the minimum value allowed is 0\. For all other resources, the minimum value allowed is 1\.
3536
*Required*: No
3637
*Type*: Integer
3738
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

doc_source/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The schedule for this action\. The following formats are supported:
5050
+ At expressions \- "`at(yyyy-mm-ddThh:mm:ss)`"
5151
+ Rate expressions \- "`rate(value unit)`"
5252
+ Cron expressions \- "`cron(fields)`"
53-
At expressions are useful for one\-time schedules\. Specify the time, in UTC\.
53+
At expressions are useful for one\-time schedules\. Specify the time in UTC\.
5454
For rate expressions, *value* is a positive integer and *unit* is `minute` \| `minutes` \| `hour` \| `hours` \| `day` \| `days`\.
5555
For more information about cron expressions, see [Cron Expressions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the *Amazon CloudWatch Events User Guide*\.
5656
*Required*: Yes

0 commit comments

Comments
 (0)