Skip to content

Commit bc971c9

Browse files
author
awstools
committed
docs(client-cloudformation): Documentation update for AWS CloudFormation API Reference.
1 parent 1191ab7 commit bc971c9

File tree

75 files changed

+3631
-3032
lines changed

Some content is hidden

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

75 files changed

+3631
-3032
lines changed

‎clients/client-cloudformation/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ AWS SDK for JavaScript CloudFormation Client for Node.js, Browser and React Nati
99
<fullname>CloudFormation</fullname>
1010

1111
<p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
12-
repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly
12+
repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service,
13+
Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly
1314
scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
1415
infrastructure.</p>
1516
<p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a

‎clients/client-cloudformation/src/CloudFormation.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1761,7 +1761,8 @@ export interface CloudFormation {
17611761
/**
17621762
* <fullname>CloudFormation</fullname>
17631763
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
1764-
* repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly
1764+
* repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service,
1765+
* Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly
17651766
* scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
17661767
* infrastructure.</p>
17671768
* <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a

‎clients/client-cloudformation/src/CloudFormationClient.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,8 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
617617
/**
618618
* <fullname>CloudFormation</fullname>
619619
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
620-
* repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly
620+
* repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service,
621+
* Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly
621622
* scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
622623
* infrastructure.</p>
623624
* <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a

‎clients/client-cloudformation/src/commands/ActivateOrganizationsAccessCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ export interface ActivateOrganizationsAccessCommandInput extends ActivateOrganiz
2828
export interface ActivateOrganizationsAccessCommandOutput extends ActivateOrganizationsAccessOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Activate trusted access with Organizations. With trusted access between StackSets and Organizations
32-
* activated, the management account has permissions to create and manage StackSets for your
33-
* organization.</p>
31+
* <p>Activate trusted access with Organizations. With trusted access between StackSets
32+
* and Organizations activated, the management account has permissions to create
33+
* and manage StackSets for your organization.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

‎clients/client-cloudformation/src/commands/ActivateTypeCommand.ts

+4-6
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,10 @@ export interface ActivateTypeCommandInput extends ActivateTypeInput {}
2828
export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
32-
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
33-
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
34-
* <p>Once you have activated a public third-party extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see
35-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration">Configuring extensions at
36-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
31+
* <p>Activates a public third-party extension, making it available for use in stack templates.
32+
* Once you have activated a public third-party extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
33+
* more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
34+
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.
3937
* ```javascript

‎clients/client-cloudformation/src/commands/BatchDescribeTypeConfigurationsCommand.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ export interface BatchDescribeTypeConfigurationsCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry
37-
* for the account and Region.</p>
38-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration">Configuring extensions at
39-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
36+
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation
37+
* registry for the account and Region.</p>
38+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
39+
* data for extensions in your account</a> in the
40+
* <i>CloudFormation User Guide</i>.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

‎clients/client-cloudformation/src/commands/CancelUpdateStackCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface CancelUpdateStackCommandInput extends CancelUpdateStackInput {}
2828
export interface CancelUpdateStackCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update
32-
* and reverts to the previous stack configuration.</p>
31+
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack
32+
* rolls back the update and reverts to the previous stack configuration.</p>
3333
* <note>
3434
* <p>You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state.</p>
3535
* </note>

‎clients/client-cloudformation/src/commands/ContinueUpdateRollbackCommand.ts

+10-8
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@ export interface ContinueUpdateRollbackCommandInput extends ContinueUpdateRollba
2828
export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollbackOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the
32-
* <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the
33-
* error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state
34-
* (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p>
35-
* <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all changes after
36-
* a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was
37-
* deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance
38-
* still exists and attempts to roll back to it, causing the update rollback to fail.</p>
31+
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues
32+
* rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of
33+
* the failure, you can manually <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed">fix the error</a> and continue the rollback. By continuing the rollback, you can
34+
* return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and
35+
* then try to update the stack again.</p>
36+
* <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll
37+
* back all changes after a failed stack update. For example, you might have a stack that's
38+
* rolling back to an old database instance that was deleted outside of CloudFormation. Because
39+
* CloudFormation doesn't know the database was deleted, it assumes that the database instance still
40+
* exists and attempts to roll back to it, causing the update rollback to fail.</p>
3941
* @example
4042
* Use a bare-bones client and the command you need to make an API call.
4143
* ```javascript

‎clients/client-cloudformation/src/commands/CreateChangeSetCommand.ts

+19-13
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,25 @@ export interface CreateChangeSetCommandInput extends CreateChangeSetInput {}
2828
export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing
32-
* them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for
33-
* a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change
34-
* set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change
35-
* set and lists the differences. Use change sets to understand which resources CloudFormation will create or
36-
* change, and how it will change resources in an existing stack, before you create or update a stack.</p>
37-
* <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify
38-
* <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the
39-
* <code>ChangeSetType</code> parameter. To create a change set for an import operation, specify <code>IMPORT</code> for
40-
* the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p>
41-
* <p>When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make changes until you execute the change set.</p>
42-
* <p>To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to
43-
* <code>True</code>.</p>
31+
* <p>Creates a list of changes that will be applied to a stack so that you can review the
32+
* changes before executing them. You can create a change set for a stack that doesn't exist or
33+
* an existing stack. If you create a change set for a stack that doesn't exist, the change set
34+
* shows all of the resources that CloudFormation will create. If you create a change set for an
35+
* existing stack, CloudFormation compares the stack's information with the information that you
36+
* submit in the change set and lists the differences. Use change sets to understand which
37+
* resources CloudFormation will create or change, and how it will change resources in an existing
38+
* stack, before you create or update a stack.</p>
39+
* <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code>
40+
* parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify
41+
* <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. To create a change set for
42+
* an import operation, specify <code>IMPORT</code> for the <code>ChangeSetType</code> parameter.
43+
* After the <code>CreateChangeSet</code> call successfully completes, CloudFormation starts creating
44+
* the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p>
45+
* <p>When you are satisfied with the changes the change set will make, execute the change set
46+
* by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make changes until
47+
* you execute the change set.</p>
48+
* <p>To create a change set for the entire stack hierarchy, set
49+
* <code>IncludeNestedStacks</code> to <code>True</code>.</p>
4450
* @example
4551
* Use a bare-bones client and the command you need to make an API call.
4652
* ```javascript

‎clients/client-cloudformation/src/commands/CreateGeneratedTemplateCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ export interface CreateGeneratedTemplateCommandInput extends CreateGeneratedTemp
2828
export interface CreateGeneratedTemplateCommandOutput extends CreateGeneratedTemplateOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of
32-
* the template generation using the <code>DescribeGeneratedTemplate</code> API action.</p>
31+
* <p>Creates a template from existing resources that are not already managed with CloudFormation.
32+
* You can check the status of the template generation using the
33+
* <code>DescribeGeneratedTemplate</code> API action.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

‎clients/client-cloudformation/src/commands/CreateStackCommand.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ export interface CreateStackCommandInput extends CreateStackInput {}
2828
export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.
32-
* You can check the status of the stack through the <a>DescribeStacks</a> operation.</p>
31+
* <p>Creates a stack as specified in the template. After the call completes successfully, the
32+
* stack creation starts. You can check the status of the stack through the <a>DescribeStacks</a> operation.</p>
33+
* <p>For more information about creating a stack and monitoring stack progress, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Managing Amazon Web Services
34+
* resources as a single unit with CloudFormation stacks</a> in the
35+
* <i>CloudFormation User Guide</i>.</p>
3336
* @example
3437
* Use a bare-bones client and the command you need to make an API call.
3538
* ```javascript

‎clients/client-cloudformation/src/commands/CreateStackInstancesCommand.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export interface CreateStackInstancesCommandInput extends CreateStackInstancesIn
2828
export interface CreateStackInstancesCommandOutput extends CreateStackInstancesOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
32-
* instance refers to a stack in a specific account and Region. You must specify at least one value for either
33-
* <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
34-
* <code>Regions</code>.</p>
31+
* <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A
32+
* stack instance refers to a stack in a specific account and Region. You must specify at least
33+
* one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you must
34+
* specify at least one value for <code>Regions</code>.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

‎clients/client-cloudformation/src/commands/DeactivateOrganizationsAccessCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ export interface DeactivateOrganizationsAccessCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your
37-
* organization.</p>
36+
* <p>Deactivates trusted access with Organizations. If trusted access is deactivated,
37+
* the management account does not have permissions to create and manage
38+
* service-managed StackSets for your organization.</p>
3839
* @example
3940
* Use a bare-bones client and the command you need to make an API call.
4041
* ```javascript

‎clients/client-cloudformation/src/commands/DeactivateTypeCommand.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ export interface DeactivateTypeCommandInput extends DeactivateTypeInput {}
2828
export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deactivates a public extension that was previously activated in this account and Region.</p>
32-
* <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations
33-
* where the stack template includes the extension, even if no updates are being made to the extension. In addition,
34-
* deactivated extensions aren't automatically updated if a new version of the extension is released.</p>
31+
* <p>Deactivates a public extension that was previously activated in this account and
32+
* Region.</p>
33+
* <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes
34+
* stack update operations where the stack template includes the extension, even if no updates
35+
* are being made to the extension. In addition, deactivated extensions aren't automatically
36+
* updated if a new version of the extension is released.</p>
3537
* @example
3638
* Use a bare-bones client and the command you need to make an API call.
3739
* ```javascript

‎clients/client-cloudformation/src/commands/DeleteChangeSetCommand.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,13 @@ export interface DeleteChangeSetCommandInput extends DeleteChangeSetInput {}
2828
export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p>
31+
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the
32+
* wrong change set.</p>
3233
* <p>If the call successfully completes, CloudFormation successfully deleted the change set.</p>
33-
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the nested change set,
34-
* then <code>DeleteChangeSet</code> will delete all change sets that belong to the stacks hierarchy and will also
35-
* delete all change sets for nested stacks with the status of <code>REVIEW_IN_PROGRESS</code>.</p>
34+
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the
35+
* nested change set, then <code>DeleteChangeSet</code> will delete all change sets that belong
36+
* to the stacks hierarchy and will also delete all change sets for nested stacks with the status
37+
* of <code>REVIEW_IN_PROGRESS</code>.</p>
3638
* @example
3739
* Use a bare-bones client and the command you need to make an API call.
3840
* ```javascript

0 commit comments

Comments
 (0)