@aws-sdk/client-cloudformation 3.42.0 → 3.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -0
- package/README.md +11 -11
- package/dist-cjs/endpoints.js +1 -16
- package/dist-cjs/models/models_0.js +9 -135
- package/dist-cjs/protocols/Aws_query.js +48 -0
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- package/dist-es/endpoints.js +1 -16
- package/dist-es/models/models_0.js +4 -88
- package/dist-es/protocols/Aws_query.js +51 -0
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/CloudFormation.d.ts +114 -117
- package/dist-types/CloudFormationClient.d.ts +16 -12
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -2
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +5 -6
- package/dist-types/commands/CreateChangeSetCommand.d.ts +8 -7
- package/dist-types/commands/CreateStackCommand.d.ts +2 -2
- package/dist-types/commands/CreateStackInstancesCommand.d.ts +3 -1
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeStackInstanceCommand.d.ts +1 -2
- package/dist-types/commands/DescribeStackResourceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeStackResourcesCommand.d.ts +8 -9
- package/dist-types/commands/DescribeStacksCommand.d.ts +3 -4
- package/dist-types/commands/DetectStackDriftCommand.d.ts +6 -6
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +2 -2
- package/dist-types/commands/EstimateTemplateCostCommand.d.ts +2 -3
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +2 -2
- package/dist-types/commands/GetStackPolicyCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +4 -4
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +2 -2
- package/dist-types/commands/ImportStacksToStackSetCommand.d.ts +6 -8
- package/dist-types/commands/ListChangeSetsCommand.d.ts +1 -2
- package/dist-types/commands/ListStackInstancesCommand.d.ts +2 -3
- package/dist-types/commands/ListStackSetsCommand.d.ts +1 -2
- package/dist-types/commands/RollbackStackCommand.d.ts +8 -3
- package/dist-types/commands/SignalResourceCommand.d.ts +3 -4
- package/dist-types/commands/UpdateStackCommand.d.ts +4 -4
- package/dist-types/commands/UpdateStackInstancesCommand.d.ts +6 -6
- package/dist-types/commands/UpdateStackSetCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +2 -2
- package/dist-types/commands/ValidateTemplateCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +653 -763
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/CloudFormationClient.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +20 -87
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +39 -46
|
@@ -10,11 +10,12 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M
|
|
|
10
10
|
* <p>Creates a list of changes that will be applied to a stack so that you can review the
|
|
11
11
|
* changes before executing them. You can create a change set for a stack that doesn't exist
|
|
12
12
|
* or an existing stack. If you create a change set for a stack that doesn't exist, the change
|
|
13
|
-
* set shows all of the resources that CloudFormation will create. If you create a
|
|
14
|
-
* set for an existing stack, CloudFormation compares the stack's information
|
|
15
|
-
* information that you submit in the change set and lists the differences. Use
|
|
16
|
-
* understand which resources CloudFormation will create or change, and
|
|
17
|
-
* resources in an existing stack, before you create or update a
|
|
13
|
+
* set shows all of the resources that CloudFormation will create. If you create a
|
|
14
|
+
* change set for an existing stack, CloudFormation compares the stack's information
|
|
15
|
+
* with the information that you submit in the change set and lists the differences. Use
|
|
16
|
+
* change sets to understand which resources CloudFormation will create or change, and
|
|
17
|
+
* how it will change resources in an existing stack, before you create or update a
|
|
18
|
+
* stack.</p>
|
|
18
19
|
* <p>To create a change set for a stack that doesn't exist, for the
|
|
19
20
|
* <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change
|
|
20
21
|
* set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code>
|
|
@@ -23,8 +24,8 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M
|
|
|
23
24
|
* successfully completes, CloudFormation starts creating the change set. To check the
|
|
24
25
|
* status of the change set or to review it, use the <a>DescribeChangeSet</a>
|
|
25
26
|
* action.</p>
|
|
26
|
-
* <p>When you are satisfied with the changes the change set will make, execute the change
|
|
27
|
-
*
|
|
27
|
+
* <p>When you are satisfied with the changes the change set will make, execute the change set
|
|
28
|
+
* by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make
|
|
28
29
|
* changes until you execute the change set.</p>
|
|
29
30
|
* <p>To create a change set for the entire stack hierachy, set
|
|
30
31
|
* <code>IncludeNestedStacks</code> to <code>True</code>.</p>
|
|
@@ -7,8 +7,8 @@ export interface CreateStackCommandInput extends CreateStackInput {
|
|
|
7
7
|
export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a stack as specified in the template. After the call completes successfully,
|
|
11
|
-
*
|
|
10
|
+
* <p>Creates a stack as specified in the template. After the call completes successfully, the
|
|
11
|
+
* stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -8,7 +8,9 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates stack instances for the specified accounts, within the specified Regions. A
|
|
11
|
-
* stack instance refers to a stack in a specific account and Region. You must specify at
|
|
11
|
+
* stack instance refers to a stack in a specific account and Region. You must specify at
|
|
12
|
+
* least one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you
|
|
13
|
+
* must specify at least one value for <code>Regions</code>.</p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface DeleteChangeSetCommandInput extends DeleteChangeSetInput {
|
|
|
7
7
|
export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes
|
|
11
|
-
*
|
|
10
|
+
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the
|
|
11
|
+
* wrong change set.</p>
|
|
12
12
|
* <p>If the call successfully completes, CloudFormation successfully deleted the
|
|
13
13
|
* change set.</p>
|
|
14
14
|
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of
|
|
@@ -7,9 +7,9 @@ export interface DeleteStackCommandInput extends DeleteStackInput {
|
|
|
7
7
|
export interface DeleteStackCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts.
|
|
11
|
+
* Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion
|
|
12
|
+
* has been completed successfully.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,8 +9,7 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of
|
|
11
11
|
* stacks that you can create in your account. For more information about account limits, see
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
13
|
-
* Limits</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation Limits</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
15
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface DescribeStackEventsCommandInput extends DescribeStackEventsInpu
|
|
|
7
7
|
export interface DescribeStackEventsCommandOutput extends DescribeStackEventsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns all stack related events for a specified stack in reverse chronological
|
|
11
|
-
*
|
|
10
|
+
* <p>Returns all stack related events for a specified stack in reverse chronological order.
|
|
11
|
+
* For more information about a stack's event history, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the
|
|
12
|
+
* CloudFormation User Guide.</p>
|
|
12
13
|
* <note>
|
|
13
14
|
* <p>You can list events for stacks that have failed to create or have been deleted by
|
|
14
15
|
* specifying the unique stack identifier (stack ID).</p>
|
|
@@ -8,8 +8,7 @@ export interface DescribeStackInstanceCommandOutput extends DescribeStackInstanc
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.</p>
|
|
11
|
-
* <p>For a list of stack instances that are associated with a specific stack set, use
|
|
12
|
-
* <a>ListStackInstances</a>.</p>
|
|
11
|
+
* <p>For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
14
|
* ```javascript
|
|
@@ -8,8 +8,8 @@ export interface DescribeStackResourceCommandOutput extends DescribeStackResourc
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a description of the specified resource in the specified stack.</p>
|
|
11
|
-
* <p>For deleted stacks, DescribeStackResource returns resource information for up to 90
|
|
12
|
-
*
|
|
11
|
+
* <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days
|
|
12
|
+
* after the stack has been deleted.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -14,9 +14,9 @@ export interface DescribeStackResourceDriftsCommandOutput extends DescribeStackR
|
|
|
14
14
|
* resource that has been checked for drift. Resources that haven't yet been checked for drift
|
|
15
15
|
* are not included. Resources that do not currently support drift detection are not checked,
|
|
16
16
|
* and so not included. For a list of resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.</p>
|
|
17
|
-
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual
|
|
18
|
-
*
|
|
19
|
-
*
|
|
17
|
+
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources,
|
|
18
|
+
* or <a>DetectStackDrift</a> to detect drift on all supported resources for a
|
|
19
|
+
* given stack.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -12,20 +12,19 @@ export interface DescribeStackResourcesCommandOutput extends DescribeStackResour
|
|
|
12
12
|
* stack are returned. If <code>PhysicalResourceId</code> is specified, the associated
|
|
13
13
|
* resources of the stack that the resource belongs to are returned.</p>
|
|
14
14
|
* <note>
|
|
15
|
-
* <p>Only the first 100 resources will be returned. If your stack has more resources
|
|
16
|
-
*
|
|
15
|
+
* <p>Only the first 100 resources will be returned. If your stack has more resources than
|
|
16
|
+
* this, you should use <code>ListStackResources</code> instead.</p>
|
|
17
17
|
* </note>
|
|
18
|
-
* <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information
|
|
19
|
-
*
|
|
20
|
-
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>,
|
|
21
|
-
*
|
|
18
|
+
* <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for
|
|
19
|
+
* up to 90 days after the stack has been deleted.</p>
|
|
20
|
+
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but
|
|
21
|
+
* not both. In addition, you can specify <code>LogicalResourceId</code> to filter the
|
|
22
22
|
* returned result. For more information about resources, the <code>LogicalResourceId</code>
|
|
23
23
|
* and <code>PhysicalResourceId</code>, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">CloudFormation User
|
|
24
24
|
* Guide</a>.</p>
|
|
25
25
|
* <note>
|
|
26
|
-
* <p>A <code>ValidationError</code> is returned if you specify both
|
|
27
|
-
*
|
|
28
|
-
* request.</p>
|
|
26
|
+
* <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code>
|
|
27
|
+
* and <code>PhysicalResourceId</code> in the same request.</p>
|
|
29
28
|
* </note>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,11 +7,10 @@ export interface DescribeStacksCommandInput extends DescribeStacksInput {
|
|
|
7
7
|
export interface DescribeStacksCommandOutput extends DescribeStacksOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the description for the specified stack; if no stack name was specified, then
|
|
11
|
-
*
|
|
10
|
+
* <p>Returns the description for the specified stack; if no stack name was specified, then it
|
|
11
|
+
* returns the description for all the stacks created.</p>
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>If the stack does not exist, an <code>ValidationError</code> is
|
|
14
|
-
* returned.</p>
|
|
13
|
+
* <p>If the stack does not exist, an <code>ValidationError</code> is returned.</p>
|
|
15
14
|
* </note>
|
|
16
15
|
* @example
|
|
17
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -16,15 +16,15 @@ export interface DetectStackDriftCommandOutput extends DetectStackDriftOutput, _
|
|
|
16
16
|
* of its resources differ from their expected template configurations. For more information,
|
|
17
17
|
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
18
18
|
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
19
|
-
* <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a
|
|
20
|
-
*
|
|
19
|
+
* <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given
|
|
20
|
+
* stack, or <a>DetectStackResourceDrift</a> to detect drift on individual
|
|
21
21
|
* resources.</p>
|
|
22
22
|
* <p>For a list of stack resources that currently support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.</p>
|
|
23
23
|
* <p>
|
|
24
|
-
* <code>DetectStackDrift</code> can take up to several minutes, depending on the number
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* its resources.</p>
|
|
24
|
+
* <code>DetectStackDrift</code> can take up to several minutes, depending on the number of
|
|
25
|
+
* resources contained within the stack. Use <a>DescribeStackDriftDetectionStatus</a> to monitor the progress of a detect stack drift operation. Once the drift detection
|
|
26
|
+
* operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift
|
|
27
|
+
* information about the stack and its resources.</p>
|
|
28
28
|
* <p>When detecting drift on a stack, CloudFormation does not detect drift on any nested stacks
|
|
29
29
|
* belonging to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack
|
|
30
30
|
* itself.</p>
|
|
@@ -17,8 +17,8 @@ export interface DetectStackResourceDriftCommandOutput extends DetectStackResour
|
|
|
17
17
|
* <p>Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or
|
|
18
18
|
* <a>DetectStackDrift</a> to detect drift on all resources in a given stack
|
|
19
19
|
* that support drift detection.</p>
|
|
20
|
-
* <p>Resources that do not currently support drift detection cannot be checked. For a list
|
|
21
|
-
*
|
|
20
|
+
* <p>Resources that do not currently support drift detection cannot be checked. For a list of
|
|
21
|
+
* resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.</p>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
24
|
* ```javascript
|
|
@@ -7,9 +7,8 @@ export interface EstimateTemplateCostCommandInput extends EstimateTemplateCostIn
|
|
|
7
7
|
export interface EstimateTemplateCostCommandOutput extends EstimateTemplateCostOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple
|
|
11
|
-
*
|
|
12
|
-
* template.</p>
|
|
10
|
+
* <p>Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the
|
|
11
|
+
* resources required to run the template.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
14
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface ExecuteChangeSetCommandInput extends ExecuteChangeSetInput {
|
|
|
7
7
|
export interface ExecuteChangeSetCommandOutput extends ExecuteChangeSetOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates a stack using the input information that was provided when the specified
|
|
11
|
-
*
|
|
10
|
+
* <p>Updates a stack using the input information that was provided when the specified change
|
|
11
|
+
* set was created. After the call successfully completes, CloudFormation starts
|
|
12
12
|
* updating the stack. Use the <a>DescribeStacks</a> action to view the status of
|
|
13
13
|
* the update.</p>
|
|
14
14
|
* <p>When you execute a change set, CloudFormation deletes all other change sets
|
|
@@ -7,8 +7,8 @@ export interface GetStackPolicyCommandInput extends GetStackPolicyInput {
|
|
|
7
7
|
export interface GetStackPolicyCommandOutput extends GetStackPolicyOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a
|
|
11
|
-
*
|
|
10
|
+
* <p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null
|
|
11
|
+
* value is returned.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -7,10 +7,10 @@ export interface GetTemplateCommandInput extends GetTemplateInput {
|
|
|
7
7
|
export interface GetTemplateCommandOutput extends GetTemplateOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the template body for a specified stack. You can get the template for running
|
|
11
|
-
*
|
|
12
|
-
* <p>For deleted stacks, GetTemplate returns the template for up to 90 days after the
|
|
13
|
-
*
|
|
10
|
+
* <p>Returns the template body for a specified stack. You can get the template for running or
|
|
11
|
+
* deleted stacks.</p>
|
|
12
|
+
* <p>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack
|
|
13
|
+
* has been deleted.</p>
|
|
14
14
|
* <note>
|
|
15
15
|
* <p>If the template does not exist, a <code>ValidationError</code> is returned.</p>
|
|
16
16
|
* </note>
|
|
@@ -13,8 +13,8 @@ export interface GetTemplateSummaryCommandOutput extends GetTemplateSummaryOutpu
|
|
|
13
13
|
* stack set.</p>
|
|
14
14
|
* <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or
|
|
15
15
|
* you can get template information for a stack set, or a running or deleted stack.</p>
|
|
16
|
-
* <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information
|
|
17
|
-
*
|
|
16
|
+
* <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for
|
|
17
|
+
* up to 90 days after the stack has been deleted. If the template does not exist, a
|
|
18
18
|
* <code>ValidationError</code> is returned.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,14 +7,12 @@ export interface ImportStacksToStackSetCommandInput extends ImportStacksToStackS
|
|
|
7
7
|
export interface ImportStacksToStackSetCommandOutput extends ImportStacksToStackSetOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
* different
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <code>ImportStacksToStackSet</code> is only supported by self-managed permissions.</p>
|
|
17
|
-
* </note>
|
|
10
|
+
* <p>Use the stack import operations for self-managed or service-managed StackSets. For
|
|
11
|
+
* self-managed StackSets, the import operation can import stacks in the administrator account
|
|
12
|
+
* or in different target accounts and Amazon Web Services Regions. For service-managed
|
|
13
|
+
* StackSets, the import operation can import any stack in the same AWS Organizations as the
|
|
14
|
+
* management account. The import operation can import up to 10 stacks using inline stack IDs
|
|
15
|
+
* or up to 10,000 stacks using an Amazon S3 object.</p>
|
|
18
16
|
* @example
|
|
19
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
18
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface ListChangeSetsCommandInput extends ListChangeSetsInput {
|
|
|
7
7
|
export interface ListChangeSetsCommandOutput extends ListChangeSetsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the ID and status of each active change set for a stack. For example,
|
|
11
|
-
* CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or
|
|
10
|
+
* <p>Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or
|
|
12
11
|
* <code>CREATE_PENDING</code> state.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,9 +7,8 @@ export interface ListStackInstancesCommandInput extends ListStackInstancesInput
|
|
|
7
7
|
export interface ListStackInstancesCommandOutput extends ListStackInstancesOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns summary information about stack instances that are associated with the
|
|
11
|
-
*
|
|
12
|
-
* Amazon Web Services account name or Region, or that have a specific status.</p>
|
|
10
|
+
* <p>Returns summary information about stack instances that are associated with the specified
|
|
11
|
+
* stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
14
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface ListStackSetsCommandInput extends ListStackSetsInput {
|
|
|
7
7
|
export interface ListStackSetsCommandOutput extends ListStackSetsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns summary information about stack sets that are associated with the
|
|
11
|
-
* user.</p>
|
|
10
|
+
* <p>Returns summary information about stack sets that are associated with the user.</p>
|
|
12
11
|
* <ul>
|
|
13
12
|
* <li>
|
|
14
13
|
* <p>[Self-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
@@ -7,9 +7,14 @@ export interface RollbackStackCommandInput extends RollbackStackInput {
|
|
|
7
7
|
export interface RollbackStackCommandOutput extends RollbackStackOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>When specifying <code>RollbackStack</code>, you preserve the state of previously
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>When specifying <code>RollbackStack</code>, you preserve the state of previously
|
|
11
|
+
* provisioned resources when an operation fails. You can check the status of the stack
|
|
12
|
+
* through the <a>DescribeStacks</a> API.</p>
|
|
13
|
+
* <p>Rolls back the specified stack to the last known stable state from
|
|
14
|
+
* <code>CREATE_FAILED</code> or <code>UPDATE_FAILED</code> stack statuses.</p>
|
|
15
|
+
* <p>This operation will delete a stack if it doesn't contain a last known stable state. A
|
|
16
|
+
* last known stable state includes any status in a <code>*_COMPLETE</code>. This includes the
|
|
17
|
+
* following stack statuses.</p>
|
|
13
18
|
* <ul>
|
|
14
19
|
* <li>
|
|
15
20
|
* <p>
|
|
@@ -7,10 +7,9 @@ export interface SignalResourceCommandInput extends SignalResourceInput {
|
|
|
7
7
|
export interface SignalResourceCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Sends a signal to the specified resource with a success or failure status. You can
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* required number of signals or the timeout period is exceeded. The SignalResource API is
|
|
10
|
+
* <p>Sends a signal to the specified resource with a success or failure status. You can use
|
|
11
|
+
* the SignalResource API in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive
|
|
12
|
+
* the required number of signals or the timeout period is exceeded. The SignalResource API is
|
|
14
13
|
* useful in cases where you want to send signals from anywhere other than an Amazon EC2
|
|
15
14
|
* instance.</p>
|
|
16
15
|
* @example
|
|
@@ -7,11 +7,11 @@ export interface UpdateStackCommandInput extends UpdateStackInput {
|
|
|
7
7
|
export interface UpdateStackCommandOutput extends UpdateStackOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates a stack as specified in the template. After the call completes successfully,
|
|
11
|
-
*
|
|
10
|
+
* <p>Updates a stack as specified in the template. After the call completes successfully, the
|
|
11
|
+
* stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p>
|
|
12
12
|
* <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p>
|
|
13
|
-
* <p>For more information about creating an update template, updating a stack, and
|
|
14
|
-
*
|
|
13
|
+
* <p>For more information about creating an update template, updating a stack, and monitoring
|
|
14
|
+
* the progress of the update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a
|
|
15
15
|
* Stack</a>.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,14 +7,14 @@ export interface UpdateStackInstancesCommandInput extends UpdateStackInstancesIn
|
|
|
7
7
|
export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates the parameter values for stack instances for the specified accounts, within
|
|
11
|
-
*
|
|
12
|
-
* <p>You can only update stack instances in Regions and accounts where they already exist;
|
|
13
|
-
*
|
|
10
|
+
* <p>Updates the parameter values for stack instances for the specified accounts, within the
|
|
11
|
+
* specified Regions. A stack instance refers to a stack in a specific account and Region. </p>
|
|
12
|
+
* <p>You can only update stack instances in Regions and accounts where they already exist; to
|
|
13
|
+
* create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>. </p>
|
|
14
14
|
* <p>During stack set updates, any parameters overridden for a stack instance are not
|
|
15
15
|
* updated, but retain their overridden value.</p>
|
|
16
|
-
* <p>You can only update the parameter <i>values</i> that are specified in
|
|
17
|
-
*
|
|
16
|
+
* <p>You can only update the parameter <i>values</i> that are specified in the
|
|
17
|
+
* stack set; to add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the stack set template. If you add a parameter to a
|
|
18
18
|
* template, before you can override the parameter value specified in the stack set you must
|
|
19
19
|
* first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack instances with the updated template and
|
|
20
20
|
* parameter value specified in the stack set. Once a stack instance has been updated with the
|
|
@@ -9,8 +9,8 @@ export interface UpdateStackSetCommandOutput extends UpdateStackSetOutput, __Met
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates the stack set, and associated stack instances in the specified accounts and
|
|
11
11
|
* Regions.</p>
|
|
12
|
-
* <p>Even if the stack set operation created by updating the stack set fails (completely
|
|
13
|
-
*
|
|
12
|
+
* <p>Even if the stack set operation created by updating the stack set fails (completely or
|
|
13
|
+
* partially, below or above a specified failure tolerance), the stack set is updated with
|
|
14
14
|
* your changes. Subsequent <a>CreateStackInstances</a> calls on the specified
|
|
15
15
|
* stack set use the updated stack set.</p>
|
|
16
16
|
* @example
|
|
@@ -7,8 +7,8 @@ export interface UpdateTerminationProtectionCommandInput extends UpdateTerminati
|
|
|
7
7
|
export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminationProtectionOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates termination protection for the specified stack. If a user attempts to delete
|
|
11
|
-
*
|
|
10
|
+
* <p>Updates termination protection for the specified stack. If a user attempts to delete a
|
|
11
|
+
* stack with termination protection enabled, the operation fails and the stack remains
|
|
12
12
|
* unchanged. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a
|
|
13
13
|
* Stack From Being Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
14
14
|
* <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested
|
|
@@ -8,8 +8,8 @@ export interface ValidateTemplateCommandOutput extends ValidateTemplateOutput, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Validates a specified template. CloudFormation first checks if the template is
|
|
11
|
-
* valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If
|
|
12
|
-
* these checks fail, CloudFormation returns a template validation error.</p>
|
|
11
|
+
* valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If
|
|
12
|
+
* both these checks fail, CloudFormation returns a template validation error.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|