You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-cloudformation/README.md
+11-9
Original file line number
Diff line number
Diff line change
@@ -8,15 +8,17 @@ AWS SDK for JavaScript CloudFormation Client for Node.js, Browser and React Nati
8
8
9
9
<fullname>CloudFormation</fullname>
10
10
11
-
<p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably
12
-
and 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
13
-
highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
14
-
<p>With CloudFormation, you declare all your resources and dependencies in a template file. The template
15
-
defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member
16
-
resources of the stack together and manages all dependencies between the resources for you.</p>
17
-
<p>For more information about CloudFormation, see the <ahref="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
18
-
<p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
19
-
about a specific Amazon Web Services product, you can find the product's technical documentation at <ahref="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
11
+
<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
13
+
scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
14
+
infrastructure.</p>
15
+
<p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a
16
+
collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack
17
+
together and manages all dependencies between the resources for you.</p>
18
+
<p>For more information about CloudFormation, see the <ahref="http://aws.amazon.com/cloudformation/">CloudFormation
19
+
product page</a>.</p>
20
+
<p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a
21
+
specific Amazon Web Services product, you can find the product's technical documentation at <ahref="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably
1713
-
* and 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
1714
-
* highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
1715
-
* <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template
1716
-
* defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member
1717
-
* resources of the stack together and manages all dependencies between the resources for you.</p>
1718
-
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
1719
-
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
1720
-
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
1712
+
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
1713
+
* 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
1714
+
* scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
1715
+
* infrastructure.</p>
1716
+
* <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a
1717
+
* collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack
1718
+
* together and manages all dependencies between the resources for you.</p>
1719
+
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation
1720
+
* product page</a>.</p>
1721
+
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a
1722
+
* specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably
615
-
* and 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
616
-
* highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
617
-
* <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template
618
-
* defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member
619
-
* resources of the stack together and manages all dependencies between the resources for you.</p>
620
-
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
621
-
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
622
-
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
614
+
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
615
+
* 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
616
+
* scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
617
+
* infrastructure.</p>
618
+
* <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a
619
+
* collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack
620
+
* together and manages all dependencies between the resources for you.</p>
621
+
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation
622
+
* product page</a>.</p>
623
+
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a
624
+
* specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
32
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-register.html#registry-set-configuration">Configuring extensions at
36
-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
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">
35
+
* <code>SetTypeConfiguration</code>
36
+
* </a> to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation User Guide</i>.</p>
37
37
* @example
38
38
* Use a bare-bones client and the command you need to make an API call.
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.</p>
36
+
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry
37
+
* for the account and Region.</p>
37
38
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
38
-
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
39
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
39
40
* @example
40
41
* Use a bare-bones client and the command you need to make an API call.
* <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
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
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
36
-
* changes after a failed stack update. For example, you might have a stack that's rolling back to an old database
37
-
* instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was
38
-
* deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update
39
-
* rollback to fail.</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>
40
39
* @example
41
40
* Use a bare-bones client and the command you need to make an API call.
* <p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing
32
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
34
-
* create a change set for an existing stack, CloudFormation compares the stack's information with the information
35
-
* that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update
36
-
* a stack.</p>
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
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>
40
-
* for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes,
41
-
* CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
42
-
* <a>DescribeChangeSet</a> action.</p>
43
-
* <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
44
-
* set.</p>
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>
45
42
* <p>To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to
* <p>The quota for the resource has already been reached.</p>
131
128
* <p>For information about resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation quotas</a> in the
132
-
* <i>CloudFormation User Guide</i>.</p>
129
+
* <i>CloudFormation User Guide</i>.</p>
133
130
*
134
131
* @throws {@link CloudFormationServiceException}
135
132
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
* <p>The quota for the resource has already been reached.</p>
80
80
* <p>For information about resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation quotas</a> in the
81
-
* <i>CloudFormation User Guide</i>.</p>
81
+
* <i>CloudFormation User Guide</i>.</p>
82
82
*
83
83
* @throws {@link CloudFormationServiceException}
84
84
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
* <p>The quota for the resource has already been reached.</p>
107
107
* <p>For information about resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation quotas</a> in the
* <p>The quota for the resource has already been reached.</p>
100
100
* <p>For information about resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation quotas</a> in the
0 commit comments