Skip to content

Commit

Permalink
feat(client-cloudformation): Add DetailedStatus field to DescribeStac…
Browse files Browse the repository at this point in the history
…kEvents and DescribeStacks APIs
  • Loading branch information
awstools committed Mar 4, 2024
1 parent af5215a commit eafb296
Show file tree
Hide file tree
Showing 54 changed files with 1,935 additions and 1,799 deletions.
20 changes: 11 additions & 9 deletions clients/client-cloudformation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ 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 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 collection of resources as a single unit called a stack. CloudFormation creates and deletes all member
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/">docs.aws.amazon.com</a>.</p>
<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
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
collection of resources as a single unit called a stack. CloudFormation creates and deletes all member 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/">docs.aws.amazon.com</a>.</p>

## Installing

Expand Down
20 changes: 11 additions & 9 deletions clients/client-cloudformation/src/CloudFormation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1709,15 +1709,17 @@ export interface CloudFormation {
/**
* @public
* <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 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 collection of resources as a single unit called a stack. CloudFormation creates and deletes all member
* 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/">docs.aws.amazon.com</a>.</p>
* <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
* 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
* collection of resources as a single unit called a stack. CloudFormation creates and deletes all member 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/">docs.aws.amazon.com</a>.</p>
*/
export class CloudFormation extends CloudFormationClient implements CloudFormation {}
createAggregatedClient(commands, CloudFormation);
20 changes: 11 additions & 9 deletions clients/client-cloudformation/src/CloudFormationClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -611,15 +611,17 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
/**
* @public
* <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 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 collection of resources as a single unit called a stack. CloudFormation creates and deletes all member
* 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/">docs.aws.amazon.com</a>.</p>
* <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
* 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
* collection of resources as a single unit called a stack. CloudFormation creates and deletes all member 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/">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 @@ -28,9 +28,9 @@ export interface ActivateOrganizationsAccessCommandOutput extends ActivateOrgani

/**
* @public
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ 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>
* 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">
* <code>SetTypeConfiguration</code>
* </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 @@ -33,9 +33,10 @@ export interface BatchDescribeTypeConfigurationsCommandOutput

/**
* @public
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.</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>
* 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 @@ -29,14 +29,13 @@ 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
* <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>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 @@ -30,18 +30,15 @@ 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>
* 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>
* <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
Expand Down Expand Up @@ -129,7 +126,7 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M
* @throws {@link LimitExceededException} (client fault)
* <p>The quota for the resource has already been reached.</p>
* <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
* <i>CloudFormation User Guide</i>.</p>
* <i>CloudFormation User Guide</i>.</p>
*
* @throws {@link CloudFormationServiceException}
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export interface CreateGeneratedTemplateCommandOutput extends CreateGeneratedTem
* @throws {@link LimitExceededException} (client fault)
* <p>The quota for the resource has already been reached.</p>
* <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
* <i>CloudFormation User Guide</i>.</p>
* <i>CloudFormation User Guide</i>.</p>
*
* @throws {@link CloudFormationServiceException}
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataB
* @throws {@link LimitExceededException} (client fault)
* <p>The quota for the resource has already been reached.</p>
* <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
* <i>CloudFormation User Guide</i>.</p>
* <i>CloudFormation User Guide</i>.</p>
*
* @throws {@link TokenAlreadyExistsException} (client fault)
* <p>A client request token already exists.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO
* @public
* <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>
* <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
Expand Down Expand Up @@ -98,7 +98,7 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO
* @throws {@link LimitExceededException} (client fault)
* <p>The quota for the resource has already been reached.</p>
* <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
* <i>CloudFormation User Guide</i>.</p>
* <i>CloudFormation User Guide</i>.</p>
*
* @throws {@link OperationIdAlreadyExistsException} (client fault)
* <p>The specified operation ID already exists.</p>
Expand Down

0 comments on commit eafb296

Please sign in to comment.