Skip to content

Commit 83514db

Browse files
author
awstools
committed
feat(client-cloudformation): AWS CloudFormation StackSets is updating the deployment experience for all stackset operations to skip suspended AWS accounts during deployments. StackSets will skip target AWS accounts that are suspended and set the Detailed Status of the corresponding stack instances as SKIPPED_SUSPENDED_ACCOUNT
1 parent 9a4e143 commit 83514db

File tree

56 files changed

+1515
-1782
lines changed

Some content is hidden

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

56 files changed

+1515
-1782
lines changed

clients/client-cloudformation/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ defines a collection of resources as a single unit called a stack. CloudFormatio
1616
resources of the stack together and manages all dependencies between the resources for you.</p>
1717
<p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
1818
<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 <a href="https://docs.aws.amazon.com/">
20-
<code>docs.aws.amazon.com</code>
21-
</a>.</p>
19+
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>
2220

2321
## Installing
2422

clients/client-cloudformation/src/CloudFormation.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1441,9 +1441,7 @@ export interface CloudFormation {
14411441
* resources of the stack together and manages all dependencies between the resources for you.</p>
14421442
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
14431443
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
1444-
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
1445-
* <code>docs.aws.amazon.com</code>
1446-
* </a>.</p>
1444+
* 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>
14471445
*/
14481446
export class CloudFormation extends CloudFormationClient implements CloudFormation {}
14491447
createAggregatedClient(commands, CloudFormation);

clients/client-cloudformation/src/CloudFormationClient.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -541,9 +541,7 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
541541
* resources of the stack together and manages all dependencies between the resources for you.</p>
542542
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
543543
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
544-
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
545-
* <code>docs.aws.amazon.com</code>
546-
* </a>.</p>
544+
* 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>
547545
*/
548546
export class CloudFormationClient extends __Client<
549547
__HttpHandlerOptions,

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat
3636

3737
/**
3838
* @public
39-
* <p>Activates a public third-party extension, making it available for use in stack templates.
40-
* For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
41-
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
42-
* <p>Once you have activated a public third-party extension in your account and Region, use
43-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
44-
* 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>
39+
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
40+
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
41+
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
42+
* <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
43+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
44+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.
4747
* ```javascript

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,9 @@ export interface BatchDescribeTypeConfigurationsCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Returns configuration data for the specified CloudFormation extensions, from the
45-
* CloudFormation registry for the account and Region.</p>
46-
* <p>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
47-
* <i>CloudFormation User Guide</i>.</p>
44+
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.</p>
45+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
46+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
4847
* @example
4948
* Use a bare-bones client and the command you need to make an API call.
5049
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface CancelUpdateStackCommandOutput extends __MetadataBearer {}
3636

3737
/**
3838
* @public
39-
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack
40-
* rolls back the update and reverts to the previous stack configuration.</p>
39+
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update
40+
* and reverts to the previous stack configuration.</p>
4141
* <note>
4242
* <p>You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state.</p>
4343
* </note>

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollb
3636

3737
/**
3838
* @public
39-
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues
40-
* rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of
41-
* 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
42-
* return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and
43-
* then try to update the stack again.</p>
44-
* <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
45-
* 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
46-
* that the database instance still exists and attempts to roll back to it, causing the update
47-
* rollback to fail.</p>
39+
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the
40+
* <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
41+
* error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state
42+
* (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p>
43+
* <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all
44+
* changes after a failed stack update. For example, you might have a stack that's rolling back to an old database
45+
* instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was
46+
* deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update
47+
* rollback to fail.</p>
4848
* @example
4949
* Use a bare-bones client and the command you need to make an API call.
5050
* ```javascript

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

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,22 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M
3636

3737
/**
3838
* @public
39-
* <p>Creates a list of changes that will be applied to a stack so that you can review the
40-
* changes before executing them. You can create a change set for a stack that doesn't exist or
41-
* an existing stack. If you create a change set for a stack that doesn't exist, the change set
42-
* shows all of the resources that CloudFormation will create. If you create a change set for
43-
* an existing stack, CloudFormation compares the stack's information with the information
44-
* that you submit in the change set and lists the differences. Use change sets to understand
45-
* which resources CloudFormation will create or change, and how it will change resources in
46-
* an existing stack, before you create or update a stack.</p>
47-
* <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code>
48-
* parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify
49-
* <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. To create a change set for
50-
* an import operation, specify <code>IMPORT</code> for the <code>ChangeSetType</code> parameter.
51-
* After the <code>CreateChangeSet</code> call successfully completes, CloudFormation starts
52-
* creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p>
53-
* <p>When you are satisfied with the changes the change set will make, execute the change set
54-
* by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make
55-
* changes until you execute the change set.</p>
56-
* <p>To create a change set for the entire stack hierarchy, set
57-
* <code>IncludeNestedStacks</code> to <code>True</code>.</p>
39+
* <p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing
40+
* 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
41+
* a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you
42+
* create a change set for an existing stack, CloudFormation compares the stack's information with the information
43+
* 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
44+
* a stack.</p>
45+
* <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify
46+
* <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the
47+
* <code>ChangeSetType</code> parameter. To create a change set for an import operation, specify <code>IMPORT</code>
48+
* for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes,
49+
* CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
50+
* <a>DescribeChangeSet</a> action.</p>
51+
* <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
52+
* set.</p>
53+
* <p>To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to
54+
* <code>True</code>.</p>
5855
* @example
5956
* Use a bare-bones client and the command you need to make an API call.
6057
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataB
3636

3737
/**
3838
* @public
39-
* <p>Creates a stack as specified in the template. After the call completes successfully, the
40-
* stack creation starts. You can check the status of the stack through the <a>DescribeStacks</a>operation.</p>
39+
* <p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.
40+
* You can check the status of the stack through the <a>DescribeStacks</a> operation.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,11 @@ export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __Met
3636

3737
/**
3838
* @public
39-
* <p>Deactivates a public extension that was previously activated in this account and
40-
* Region.</p>
41-
* <p>Once deactivated, an extension can't be used in any CloudFormation operation.
42-
* This includes stack update operations where the stack template includes the extension, even if
43-
* no updates are being made to the extension. In addition, deactivated extensions aren't
44-
* automatically updated if a new version of the extension is released.</p>
39+
* <p>Deactivates a public extension that was previously activated in this account and Region.</p>
40+
* <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack
41+
* update operations where the stack template includes the extension, even if no updates are being made to the
42+
* extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is
43+
* released.</p>
4544
* @example
4645
* Use a bare-bones client and the command you need to make an API call.
4746
* ```javascript

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

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,11 @@ export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __M
3636

3737
/**
3838
* @public
39-
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the
40-
* wrong change set.</p>
41-
* <p>If the call successfully completes, CloudFormation successfully deleted the change
42-
* set.</p>
43-
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the
44-
* nested change set, then <code>DeleteChangeSet</code> will delete all change sets that belong
45-
* to the stacks hierarchy and will also delete all change sets for nested stacks with the status
46-
* of <code>REVIEW_IN_PROGRESS</code>.</p>
39+
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p>
40+
* <p>If the call successfully completes, CloudFormation successfully deleted the change set.</p>
41+
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the nested change set,
42+
* then <code>DeleteChangeSet</code> will delete all change sets that belong to the stacks hierarchy and will also
43+
* delete all change sets for nested stacks with the status of <code>REVIEW_IN_PROGRESS</code>.</p>
4744
* @example
4845
* Use a bare-bones client and the command you need to make an API call.
4946
* ```javascript

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ export interface DeleteStackCommandOutput extends __MetadataBearer {}
3636

3737
/**
3838
* @public
39-
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts.
40-
* Deleted stacks don't show up in the <a>DescribeStacks</a> operation if the deletion
41-
* has been completed successfully.</p>
39+
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't
40+
* show up in the <a>DescribeStacks</a> operation if the deletion has been completed successfully.</p>
4241
* @example
4342
* Use a bare-bones client and the command you need to make an API call.
4443
* ```javascript

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met
3636

3737
/**
3838
* @public
39-
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or extension
40-
* versions cannot be used in CloudFormation operations.</p>
41-
* <p>To deregister an entire extension, you must individually deregister all active versions of
42-
* that extension. If an extension has only a single active version, deregistering that version
43-
* results in the extension itself being deregistered and marked as deprecated in the
44-
* registry.</p>
45-
* <p>You can't deregister the default version of an extension if there are other active version
46-
* of that extension. If you do deregister the default version of an extension, the extension
47-
* type itself is deregistered as well and marked as deprecated.</p>
39+
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry,
40+
* removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation
41+
* operations.</p>
42+
* <p>To deregister an entire extension, you must individually deregister all active versions of that extension. If an
43+
* extension has only a single active version, deregistering that version results in the extension itself being
44+
* deregistered and marked as deprecated in the registry.</p>
45+
* <p>You can't deregister the default version of an extension if there are other active version of that extension. If
46+
* you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
47+
* as deprecated.</p>
4848
* <p>To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>
4949
* @example
5050
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
3636

3737
/**
3838
* @public
39-
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks
40-
* that you can create in your account. For more information about account limits, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation Quotas</a> in the <i>CloudFormation User Guide</i>.</p>
39+
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in
40+
* your account. For more information about account limits, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation Quotas</a> in the
41+
* <i>CloudFormation User Guide</i>.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

0 commit comments

Comments
 (0)