Skip to content

Commit

Permalink
feat(client-cloudformation): AWS CloudFormation StackSets is updating…
Browse files Browse the repository at this point in the history
… 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
  • Loading branch information
awstools committed Jun 7, 2023
1 parent 9a4e143 commit 83514db
Show file tree
Hide file tree
Showing 56 changed files with 1,515 additions and 1,782 deletions.
4 changes: 1 addition & 3 deletions clients/client-cloudformation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ defines a collection of resources as a single unit called a stack. CloudFormatio
resources of the stack together and manages all dependencies between the resources for you.</p>
<p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
<p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
<code>docs.aws.amazon.com</code>
</a>.</p>
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>

## Installing

Expand Down
4 changes: 1 addition & 3 deletions clients/client-cloudformation/src/CloudFormation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1441,9 +1441,7 @@ export interface CloudFormation {
* resources of the stack together and manages all dependencies between the resources for you.</p>
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
* <code>docs.aws.amazon.com</code>
* </a>.</p>
* 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>
*/
export class CloudFormation extends CloudFormationClient implements CloudFormation {}
createAggregatedClient(commands, CloudFormation);
4 changes: 1 addition & 3 deletions clients/client-cloudformation/src/CloudFormationClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -541,9 +541,7 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
* resources of the stack together and manages all dependencies between the resources for you.</p>
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
* <code>docs.aws.amazon.com</code>
* </a>.</p>
* 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>
*/
export class CloudFormationClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat

/**
* @public
* <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-register.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. 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-register.html#registry-set-configuration">Configuring extensions at
* the account level</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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,9 @@ export interface BatchDescribeTypeConfigurationsCommandOutput

/**
* @public
* <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-register.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-register.html#registry-set-configuration">Configuring extensions at
* the account level</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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface CancelUpdateStackCommandOutput extends __MetadataBearer {}

/**
* @public
* <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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollb

/**
* @public
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,22 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M

/**
* @public
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataB

/**
* @public
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,11 @@ export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __Met

/**
* @public
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,11 @@ export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __M

/**
* @public
* <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>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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,8 @@ export interface DeleteStackCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts.
* Deleted stacks don't show up in the <a>DescribeStacks</a> operation if the deletion
* has been completed successfully.</p>
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't
* show up in the <a>DescribeStacks</a> operation if the deletion has been completed successfully.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met

/**
* @public
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or extension
* versions cannot be used in CloudFormation operations.</p>
* <p>To deregister an entire extension, you must individually deregister all active versions of
* that extension. If an extension has only a single active version, deregistering that version
* results in the extension itself being deregistered and marked as deprecated in the
* registry.</p>
* <p>You can't deregister the default version of an extension if there are other active version
* of that extension. If you do deregister the default version of an extension, the extension
* type itself is deregistered as well and marked as deprecated.</p>
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry,
* removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation
* operations.</p>
* <p>To deregister an entire extension, you must individually deregister all active versions of that extension. If an
* extension has only a single active version, deregistering that version results in the extension itself being
* deregistered and marked as deprecated in the registry.</p>
* <p>You can't deregister the default version of an extension if there are other active version of that extension. If
* you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
* as deprecated.</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit

/**
* @public
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks
* 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>
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit 83514db

Please sign in to comment.