docs(client-cloudformation): Documentation update for AWS CloudFormation API Reference.

Author: awstools

clients/client-cloudformation/README.md

@@ -9,7 +9,8 @@ AWS SDK for JavaScript CloudFormation Client for Node.js, Browser and React Nati
 <fullname>CloudFormation</fullname>
 
 <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably 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 highly reliable, highly
+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 Amazon EC2 Auto Scaling to build highly reliable, highly
 scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
 infrastructure.</p>
 <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a

clients/client-cloudformation/src/CloudFormation.ts

@@ -1761,7 +1761,8 @@ export interface CloudFormation {
 /**
  * <fullname>CloudFormation</fullname>
  *          <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably 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 highly reliable, highly
+ *    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 Amazon EC2 Auto Scaling to build highly reliable, highly
  *    scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
  *    infrastructure.</p>
  *          <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a

clients/client-cloudformation/src/CloudFormationClient.ts

@@ -617,7 +617,8 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
 /**
  * <fullname>CloudFormation</fullname>
  *          <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably 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 highly reliable, highly
+ *    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 Amazon EC2 Auto Scaling to build highly reliable, highly
  *    scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services
  *    infrastructure.</p>
  *          <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

@@ -28,9 +28,9 @@ export interface ActivateOrganizationsAccessCommandInput extends ActivateOrganiz
 export interface ActivateOrganizationsAccessCommandOutput extends ActivateOrganizationsAccessOutput, __MetadataBearer {}
 
 /**
- * <p>Activate trusted access with Organizations. With trusted access between StackSets and Organizations
- *    activated, the management account has permissions to create and manage StackSets for your
- *    organization.</p>
+ * <p>Activate trusted access with Organizations. With trusted access between StackSets
+ *       and Organizations activated, the management account has permissions to create
+ *       and manage StackSets for your organization.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,12 +28,10 @@ export interface ActivateTypeCommandInput extends ActivateTypeInput {}
 export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __MetadataBearer {}
 
 /**
- * <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
- *    see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
- *    extensions</a> in the <i>CloudFormation User Guide</i>.</p>
- *          <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
- *     <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration">Configuring extensions at
- *     the account level</a> in the <i>CloudFormation User Guide</i>.</p>
+ * <p>Activates a public third-party extension, making it available for use in stack templates.
+ *       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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
+ *         extensions</a> in the <i>CloudFormation User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -33,10 +33,11 @@ export interface BatchDescribeTypeConfigurationsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry
- *    for the account and Region.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration">Configuring extensions at
- *    the account level</a> in the <i>CloudFormation User Guide</i>.</p>
+ * <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation
+ *       registry for the account and Region.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
+ *         data for extensions in your account</a> in the
+ *       <i>CloudFormation User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,8 +28,8 @@ export interface CancelUpdateStackCommandInput extends CancelUpdateStackInput {}
 export interface CancelUpdateStackCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update
- *    and reverts to the previous stack configuration.</p>
+ * <p>Cancels an update on the specified stack. If the call completes successfully, the stack
+ *       rolls back the update and reverts to the previous stack configuration.</p>
  *          <note>
  *             <p>You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state.</p>
  *          </note>

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

@@ -28,14 +28,16 @@ export interface ContinueUpdateRollbackCommandInput extends ContinueUpdateRollba
 export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollbackOutput, __MetadataBearer {}
 
 /**
- * <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the
- *    <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
- *    error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state
- *    (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p>
- *          <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all changes after
- *    a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was
- *    deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance
- *    still exists and attempts to roll back to it, causing the update rollback to fail.</p>
+ * <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues
+ *       rolling it back to the <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 error</a> and continue the rollback. By continuing the rollback, you can
+ *       return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and
+ *       then try to update the stack again.</p>
+ *          <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll
+ *       back all changes after a failed stack update. For example, you might have a stack that's
+ *       rolling back to an old database instance that was deleted outside of CloudFormation. Because
+ *       CloudFormation doesn't know the database was deleted, it assumes that the database instance still
+ *       exists and attempts to roll back to it, causing the update rollback to fail.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,19 +28,25 @@ export interface CreateChangeSetCommandInput extends CreateChangeSetInput {}
 export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __MetadataBearer {}
 
 /**
- * <p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing
- *    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
- *    a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change
- *    set for an existing stack, CloudFormation compares the stack's information with the information 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 a stack.</p>
- *          <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify
- *    <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the
- *    <code>ChangeSetType</code> parameter. To create a change set for an import operation, specify <code>IMPORT</code> for
- *    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>
- *          <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>
- *          <p>To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to
- *    <code>True</code>.</p>
+ * <p>Creates a list of changes that will be applied to a stack so that you can review the
+ *       changes before executing 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 a stack that doesn't exist, the change set
+ *       shows all of the resources that CloudFormation will create. If you create a change set for an
+ *       existing stack, CloudFormation compares the stack's information with the information 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 a stack.</p>
+ *          <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code>
+ *       parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify
+ *         <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. To create a change set for
+ *       an import operation, specify <code>IMPORT</code> for 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>
+ *          <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>
+ *          <p>To create a change set for the entire stack hierarchy, set
+ *         <code>IncludeNestedStacks</code> to <code>True</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,8 +28,9 @@ export interface CreateGeneratedTemplateCommandInput extends CreateGeneratedTemp
 export interface CreateGeneratedTemplateCommandOutput extends CreateGeneratedTemplateOutput, __MetadataBearer {}
 
 /**
- * <p>Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of
- *    the template generation using the <code>DescribeGeneratedTemplate</code> API action.</p>
+ * <p>Creates a template from existing resources that are not already managed with CloudFormation.
+ *       You can check the status of the template generation using the
+ *         <code>DescribeGeneratedTemplate</code> API action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,8 +28,11 @@ export interface CreateStackCommandInput extends CreateStackInput {}
 export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataBearer {}
 
 /**
- * <p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.
- *    You can check the status of the stack through the <a>DescribeStacks</a> operation.</p>
+ * <p>Creates a stack as specified in the template. After the call completes successfully, the
+ *       stack creation starts. You can check the status of the stack through the <a>DescribeStacks</a> operation.</p>
+ *          <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
+ *         resources as a single unit with CloudFormation stacks</a> in the
+ *         <i>CloudFormation User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,10 +28,10 @@ export interface CreateStackInstancesCommandInput extends CreateStackInstancesIn
 export interface CreateStackInstancesCommandOutput extends CreateStackInstancesOutput, __MetadataBearer {}
 
 /**
- * <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
- *    instance refers to a stack in a specific account and Region. You must specify at least one value for either
- *     <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for
- *     <code>Regions</code>.</p>
+ * <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A
+ *       stack instance refers to a stack in a specific account and Region. You must specify at least
+ *       one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you must
+ *       specify at least one value for <code>Regions</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -33,8 +33,9 @@ export interface DeactivateOrganizationsAccessCommandOutput
     __MetadataBearer {}
 
 /**
- * <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
- *    organization.</p>
+ * <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 organization.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,10 +28,12 @@ export interface DeactivateTypeCommandInput extends DeactivateTypeInput {}
 export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __MetadataBearer {}
 
 /**
- * <p>Deactivates a public extension that was previously activated in this account and Region.</p>
- *          <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations
- *    where the stack template includes the extension, even if no updates are being made to the extension. In addition,
- *    deactivated extensions aren't automatically updated if a new version of the extension is released.</p>
+ * <p>Deactivates a public extension that was previously activated in this account and
+ *       Region.</p>
+ *          <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes
+ *       stack update operations where the stack template includes the extension, even if no updates
+ *       are being made to the extension. In addition, deactivated extensions aren't automatically
+ *       updated if a new version of the extension is released.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -28,11 +28,13 @@ export interface DeleteChangeSetCommandInput extends DeleteChangeSetInput {}
 export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __MetadataBearer {}
 
 /**
- * <p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p>
+ * <p>Deletes the specified change set. Deleting change sets ensures that no one executes the
+ *       wrong change set.</p>
  *          <p>If the call successfully completes, CloudFormation successfully deleted the change set.</p>
- *          <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the nested change set,
- *    then <code>DeleteChangeSet</code> will delete all change sets that belong to the stacks hierarchy and will also
- *    delete all change sets for nested stacks with the status of <code>REVIEW_IN_PROGRESS</code>.</p>
+ *          <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the
+ *       nested change set, then <code>DeleteChangeSet</code> will delete all change sets that belong
+ *       to the stacks hierarchy and will also delete all change sets for nested stacks with the status
+ *       of <code>REVIEW_IN_PROGRESS</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript