@aws-sdk/client-cloudformation 3.345.0 → 3.347.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/README.md +39 -20
- package/dist-cjs/CloudFormation.js +6 -0
- package/dist-cjs/commands/ActivateOrganizationsAccessCommand.js +46 -0
- package/dist-cjs/commands/DeactivateOrganizationsAccessCommand.js +46 -0
- package/dist-cjs/commands/DescribeOrganizationsAccessCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +35 -30
- package/dist-cjs/protocols/Aws_query.js +174 -3
- package/dist-es/CloudFormation.js +6 -0
- package/dist-es/commands/ActivateOrganizationsAccessCommand.js +42 -0
- package/dist-es/commands/DeactivateOrganizationsAccessCommand.js +42 -0
- package/dist-es/commands/DescribeOrganizationsAccessCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +31 -26
- package/dist-es/protocols/Aws_query.js +165 -0
- package/dist-types/CloudFormation.d.ts +29 -13
- package/dist-types/CloudFormationClient.d.ts +13 -15
- package/dist-types/commands/ActivateOrganizationsAccessCommand.d.ts +77 -0
- package/dist-types/commands/ActivateTypeCommand.d.ts +6 -6
- package/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +3 -3
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -3
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +8 -9
- package/dist-types/commands/CreateChangeSetCommand.d.ts +19 -22
- package/dist-types/commands/CreateStackCommand.d.ts +4 -5
- package/dist-types/commands/CreateStackInstancesCommand.d.ts +9 -10
- package/dist-types/commands/CreateStackSetCommand.d.ts +2 -2
- package/dist-types/commands/DeactivateOrganizationsAccessCommand.d.ts +77 -0
- package/dist-types/commands/DeactivateTypeCommand.d.ts +4 -4
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +8 -9
- package/dist-types/commands/DeleteStackCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackInstancesCommand.d.ts +3 -4
- package/dist-types/commands/DeleteStackSetCommand.d.ts +6 -7
- package/dist-types/commands/DeregisterTypeCommand.d.ts +9 -9
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeChangeSetCommand.d.ts +4 -3
- package/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeOrganizationsAccessCommand.d.ts +82 -0
- package/dist-types/commands/DescribePublisherCommand.d.ts +5 -4
- package/dist-types/commands/DescribeStackDriftDetectionStatusCommand.d.ts +10 -11
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeStackInstanceCommand.d.ts +3 -2
- package/dist-types/commands/DescribeStackResourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +9 -8
- package/dist-types/commands/DescribeStackResourcesCommand.d.ts +10 -11
- package/dist-types/commands/DescribeStackSetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackSetOperationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStacksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTypeCommand.d.ts +2 -2
- package/dist-types/commands/DescribeTypeRegistrationCommand.d.ts +3 -3
- package/dist-types/commands/DetectStackDriftCommand.d.ts +17 -17
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +10 -9
- package/dist-types/commands/DetectStackSetDriftCommand.d.ts +21 -28
- package/dist-types/commands/EstimateTemplateCostCommand.d.ts +2 -2
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +13 -15
- package/dist-types/commands/GetStackPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetTemplateCommand.d.ts +5 -5
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +7 -8
- package/dist-types/commands/ImportStacksToStackSetCommand.d.ts +9 -17
- package/dist-types/commands/ListChangeSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListExportsCommand.d.ts +4 -4
- package/dist-types/commands/ListImportsCommand.d.ts +2 -2
- package/dist-types/commands/ListStackInstancesCommand.d.ts +3 -2
- package/dist-types/commands/ListStackResourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetsCommand.d.ts +8 -10
- package/dist-types/commands/ListStacksCommand.d.ts +3 -4
- package/dist-types/commands/PublishTypeCommand.d.ts +3 -2
- package/dist-types/commands/RecordHandlerProgressCommand.d.ts +4 -4
- package/dist-types/commands/RegisterPublisherCommand.d.ts +5 -5
- package/dist-types/commands/RegisterTypeCommand.d.ts +11 -11
- package/dist-types/commands/RollbackStackCommand.d.ts +6 -6
- package/dist-types/commands/SetTypeConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/SetTypeDefaultVersionCommand.d.ts +1 -1
- package/dist-types/commands/SignalResourceCommand.d.ts +6 -6
- package/dist-types/commands/StopStackSetOperationCommand.d.ts +2 -3
- package/dist-types/commands/TestTypeCommand.d.ts +11 -10
- package/dist-types/commands/UpdateStackCommand.d.ts +4 -5
- package/dist-types/commands/UpdateStackInstancesCommand.d.ts +15 -18
- package/dist-types/commands/UpdateStackSetCommand.d.ts +6 -10
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +6 -6
- package/dist-types/commands/ValidateTemplateCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +8 -13
- package/dist-types/models/models_0.d.ts +2198 -2448
- package/dist-types/protocols/Aws_query.d.ts +27 -0
- package/dist-types/ts3.4/CloudFormation.d.ts +51 -0
- package/dist-types/ts3.4/CloudFormationClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/ActivateOrganizationsAccessCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeactivateOrganizationsAccessCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeOrganizationsAccessCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +33 -16
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +36 -0
- package/package.json +29 -29
|
@@ -24,23 +24,22 @@ export interface DescribeStackResourcesCommandOutput extends DescribeStackResour
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
27
|
+
* <code>StackName</code> is specified, all the associated resources that are part of the stack
|
|
28
|
+
* are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the
|
|
29
|
+
* stack that the resource belongs to are returned.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>Only the first 100 resources will be returned. If your stack has more resources than
|
|
32
|
-
*
|
|
32
|
+
* this, you should use <code>ListStackResources</code> instead.</p>
|
|
33
33
|
* </note>
|
|
34
34
|
* <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for
|
|
35
|
-
*
|
|
36
|
-
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* Guide</a>.</p>
|
|
35
|
+
* up to 90 days after the stack has been deleted.</p>
|
|
36
|
+
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not
|
|
37
|
+
* both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned
|
|
38
|
+
* result. For more information about resources, the <code>LogicalResourceId</code> and
|
|
39
|
+
* <code>PhysicalResourceId</code>, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">CloudFormation User Guide</a>.</p>
|
|
41
40
|
* <note>
|
|
42
41
|
* <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code>
|
|
43
|
-
*
|
|
42
|
+
* and <code>PhysicalResourceId</code> in the same request.</p>
|
|
44
43
|
* </note>
|
|
45
44
|
* @example
|
|
46
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,7 @@ export interface DescribeStackSetCommandOutput extends DescribeStackSetOutput, _
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the description of the specified
|
|
26
|
+
* <p>Returns the description of the specified StackSet.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface DescribeStackSetOperationCommandOutput extends DescribeStackSet
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the description of the specified
|
|
26
|
+
* <p>Returns the description of the specified StackSet operation.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -24,7 +24,7 @@ export interface DescribeStacksCommandOutput extends DescribeStacksOutput, __Met
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the description for the specified stack; if no stack name was specified, then it
|
|
27
|
-
*
|
|
27
|
+
* returns the description for all the stacks created.</p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>If the stack doesn't exist, an <code>ValidationError</code> is returned.</p>
|
|
30
30
|
* </note>
|
|
@@ -25,8 +25,8 @@ export interface DescribeTypeCommandOutput extends DescribeTypeOutput, __Metadat
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns detailed information about an extension that has been registered.</p>
|
|
27
27
|
* <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* about that specific extension version. Otherwise, it returns information about the default
|
|
29
|
+
* extension version.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -24,13 +24,13 @@ export interface DescribeTypeRegistrationCommandOutput extends DescribeTypeRegis
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about an extension's registration, including its current status and
|
|
27
|
-
*
|
|
27
|
+
* type and version identifiers.</p>
|
|
28
28
|
* <p>When you initiate a registration request using <code>
|
|
29
29
|
* <a>RegisterType</a>
|
|
30
30
|
* </code>, you can then use <code>
|
|
31
31
|
* <a>DescribeTypeRegistration</a>
|
|
32
|
-
* </code> to
|
|
33
|
-
*
|
|
32
|
+
* </code> to monitor
|
|
33
|
+
* the progress of that registration request.</p>
|
|
34
34
|
* <p>Once the registration request has completed, use <code>
|
|
35
35
|
* <a>DescribeType</a>
|
|
36
36
|
* </code> to return detailed information about an extension.</p>
|
|
@@ -24,26 +24,26 @@ export interface DetectStackDriftCommandOutput extends DetectStackDriftOutput, _
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Detects whether a stack's actual configuration differs, or has
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
34
|
-
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
27
|
+
* <i>drifted</i>, from its expected configuration, as defined in the stack
|
|
28
|
+
* template and any values specified as template parameters. For each resource in the stack that
|
|
29
|
+
* supports drift detection, CloudFormation compares the actual configuration of the resource with its
|
|
30
|
+
* expected template configuration. Only resource properties explicitly defined in the stack
|
|
31
|
+
* template are checked for drift. A stack is considered to have drifted if one or more of its
|
|
32
|
+
* resources differ from their expected template configurations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
35
33
|
* <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* <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
|
|
34
|
+
* stack, or <a>DetectStackResourceDrift</a> to detect drift on individual
|
|
35
|
+
* resources.</p>
|
|
36
|
+
* <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
|
|
37
|
+
* that Support Drift Detection</a>.</p>
|
|
39
38
|
* <p>
|
|
40
39
|
* <code>DetectStackDrift</code> can take up to several minutes, depending on the number of
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
40
|
+
* resources contained within the stack. Use <a>DescribeStackDriftDetectionStatus</a>
|
|
41
|
+
* to monitor the progress of a detect stack drift operation. Once the drift detection operation
|
|
42
|
+
* has completed, use <a>DescribeStackResourceDrifts</a> to return drift information
|
|
43
|
+
* about the stack and its resources.</p>
|
|
44
|
+
* <p>When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging
|
|
45
|
+
* to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack
|
|
46
|
+
* itself.</p>
|
|
47
47
|
* @example
|
|
48
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
49
49
|
* ```javascript
|
|
@@ -24,17 +24,18 @@ export interface DetectStackResourceDriftCommandOutput extends DetectStackResour
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about whether a resource's actual configuration differs, or has
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
27
|
+
* <i>drifted</i>, from its expected configuration, as defined in the stack
|
|
28
|
+
* template and any values specified as template parameters. This information includes actual and
|
|
29
|
+
* expected property values for resources in which CloudFormation detects drift. Only resource properties
|
|
30
|
+
* explicitly defined in the stack template are checked for drift. For more information about
|
|
31
|
+
* stack and resource drift, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated
|
|
32
|
+
* Configuration Changes to Stacks and Resources</a>.</p>
|
|
33
33
|
* <p>Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <a>DetectStackDrift</a> to detect drift on all resources in a given stack that
|
|
35
|
+
* support drift detection.</p>
|
|
36
36
|
* <p>Resources that don't currently support drift detection can't be checked. For a list of
|
|
37
|
-
*
|
|
37
|
+
* resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources
|
|
38
|
+
* that Support Drift Detection</a>.</p>
|
|
38
39
|
* @example
|
|
39
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
41
|
* ```javascript
|
|
@@ -23,48 +23,41 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Detect drift on a stack set. When CloudFormation performs drift detection on a
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs
|
|
27
|
+
* drift detection on the stack associated with each stack instance in the stack set. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">How CloudFormation
|
|
28
|
+
* performs drift detection on a stack set</a>.</p>
|
|
29
29
|
* <p>
|
|
30
|
-
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set
|
|
31
|
-
*
|
|
30
|
+
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection
|
|
31
|
+
* operation. Use this operation id with <code>
|
|
32
32
|
* <a>DescribeStackSetOperation</a>
|
|
33
|
-
* </code> to monitor the
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* <p>Once the operation has completed, use the following actions to return drift
|
|
38
|
-
* information:</p>
|
|
33
|
+
* </code> to monitor the
|
|
34
|
+
* progress of the drift detection operation. The drift detection operation may take some time, depending on the number
|
|
35
|
+
* of stack instances included in the stack set, in addition to the number of resources included in each stack.</p>
|
|
36
|
+
* <p>Once the operation has completed, use the following actions to return drift information:</p>
|
|
39
37
|
* <ul>
|
|
40
38
|
* <li>
|
|
41
39
|
* <p>Use <code>
|
|
42
40
|
* <a>DescribeStackSet</a>
|
|
43
|
-
* </code> to return detailed information
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* (Information about drift operations that are in progress isn't included.)</p>
|
|
41
|
+
* </code> to return detailed information about the stack set,
|
|
42
|
+
* including detailed information about the last <i>completed</i> drift operation performed on the stack
|
|
43
|
+
* set. (Information about drift operations that are in progress isn't included.)</p>
|
|
47
44
|
* </li>
|
|
48
45
|
* <li>
|
|
49
46
|
* <p>Use <code>
|
|
50
47
|
* <a>ListStackInstances</a>
|
|
51
|
-
* </code> to return a list of stack
|
|
52
|
-
*
|
|
53
|
-
* checked of each instance.</p>
|
|
48
|
+
* </code> to return a list of stack instances belonging to the
|
|
49
|
+
* stack set, including the drift status and last drift time checked of each instance.</p>
|
|
54
50
|
* </li>
|
|
55
51
|
* <li>
|
|
56
52
|
* <p>Use <code>
|
|
57
53
|
* <a>DescribeStackInstance</a>
|
|
58
|
-
* </code> to return detailed
|
|
59
|
-
*
|
|
60
|
-
* drift time checked.</p>
|
|
54
|
+
* </code> to return detailed information about a specific stack
|
|
55
|
+
* instance, including its drift status and last drift time checked.</p>
|
|
61
56
|
* </li>
|
|
62
57
|
* </ul>
|
|
63
|
-
* <p>For more information about performing a drift detection operation on a stack set, see
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* <p>You can only run a single drift detection operation on a given stack set at one
|
|
67
|
-
* time.</p>
|
|
58
|
+
* <p>For more information about performing a drift detection operation on a stack set, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting unmanaged changes in
|
|
59
|
+
* stack sets</a>.</p>
|
|
60
|
+
* <p>You can only run a single drift detection operation on a given stack set at one time.</p>
|
|
68
61
|
* <p>To stop a drift detection stack set operation, use <code>
|
|
69
62
|
* <a>StopStackSetOperation</a>
|
|
70
63
|
* </code>.</p>
|
|
@@ -107,8 +100,8 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
|
|
|
107
100
|
* <p>The specified operation isn't valid.</p>
|
|
108
101
|
*
|
|
109
102
|
* @throws {@link OperationInProgressException} (client fault)
|
|
110
|
-
* <p>Another operation is currently in progress for this stack set. Only one operation can be
|
|
111
|
-
*
|
|
103
|
+
* <p>Another operation is currently in progress for this stack set. Only one operation can be performed for a stack
|
|
104
|
+
* set at a given time.</p>
|
|
112
105
|
*
|
|
113
106
|
* @throws {@link StackSetNotFoundException} (client fault)
|
|
114
107
|
* <p>The specified stack set doesn't exist.</p>
|
|
@@ -23,8 +23,8 @@ export interface EstimateTemplateCostCommandOutput extends EstimateTemplateCostO
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <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
|
|
27
|
-
*
|
|
26
|
+
* <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 resources required to
|
|
27
|
+
* run the template.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -24,16 +24,16 @@ export interface ExecuteChangeSetCommandOutput extends ExecuteChangeSetOutput, _
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Updates a stack using the input information that was provided when the specified change
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <p>When you execute a change set, CloudFormation deletes all other change sets
|
|
31
|
-
*
|
|
27
|
+
* set was created. After the call successfully completes, CloudFormation starts updating the
|
|
28
|
+
* stack. Use the <a>DescribeStacks</a> action to view the status of the
|
|
29
|
+
* update.</p>
|
|
30
|
+
* <p>When you execute a change set, CloudFormation deletes all other change sets associated
|
|
31
|
+
* with the stack because they aren't valid for the updated stack.</p>
|
|
32
32
|
* <p>If a stack policy is associated with the stack, CloudFormation enforces the policy
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* during the update. You can't specify a temporary stack policy that overrides the current
|
|
34
|
+
* policy.</p>
|
|
35
35
|
* <p>To create a change set for the entire stack hierarchy, <code>IncludeNestedStacks</code>
|
|
36
|
-
*
|
|
36
|
+
* must have been set to <code>True</code>.</p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
39
|
* ```javascript
|
|
@@ -59,17 +59,15 @@ export interface ExecuteChangeSetCommandOutput extends ExecuteChangeSetOutput, _
|
|
|
59
59
|
* @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape.
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ChangeSetNotFoundException} (client fault)
|
|
62
|
-
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack,
|
|
63
|
-
*
|
|
62
|
+
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
|
|
63
|
+
* <code>ListChangeSets</code> operation.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link InsufficientCapabilitiesException} (client fault)
|
|
66
|
-
* <p>The template contains resources with capabilities that weren't specified in the
|
|
67
|
-
* Capabilities parameter.</p>
|
|
66
|
+
* <p>The template contains resources with capabilities that weren't specified in the Capabilities parameter.</p>
|
|
68
67
|
*
|
|
69
68
|
* @throws {@link InvalidChangeSetStatusException} (client fault)
|
|
70
|
-
* <p>The specified change set can't be used to update the stack. For example, the change set
|
|
71
|
-
*
|
|
72
|
-
* <code>UPDATE_IN_PROGRESS</code>.</p>
|
|
69
|
+
* <p>The specified change set can't be used to update the stack. For example, the change set status might be
|
|
70
|
+
* <code>CREATE_IN_PROGRESS</code>, or the stack status might be <code>UPDATE_IN_PROGRESS</code>.</p>
|
|
73
71
|
*
|
|
74
72
|
* @throws {@link TokenAlreadyExistsException} (client fault)
|
|
75
73
|
* <p>A client request token already exists.</p>
|
|
@@ -24,7 +24,7 @@ export interface GetStackPolicyCommandOutput extends GetStackPolicyOutput, __Met
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null
|
|
27
|
-
*
|
|
27
|
+
* value is returned.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -24,9 +24,9 @@ export interface GetTemplateCommandOutput extends GetTemplateOutput, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the template body for a specified stack. You can get the template for running or
|
|
27
|
-
*
|
|
28
|
-
* <p>For deleted stacks, <code>GetTemplate</code> returns the template for up to 90 days
|
|
29
|
-
*
|
|
27
|
+
* deleted stacks.</p>
|
|
28
|
+
* <p>For deleted stacks, <code>GetTemplate</code> returns the template for up to 90 days after
|
|
29
|
+
* the stack has been deleted.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>If the template doesn't exist, a <code>ValidationError</code> is returned.</p>
|
|
32
32
|
* </note>
|
|
@@ -59,8 +59,8 @@ export interface GetTemplateCommandOutput extends GetTemplateOutput, __MetadataB
|
|
|
59
59
|
* @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape.
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ChangeSetNotFoundException} (client fault)
|
|
62
|
-
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack,
|
|
63
|
-
*
|
|
62
|
+
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
|
|
63
|
+
* <code>ListChangeSets</code> operation.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link CloudFormationServiceException}
|
|
66
66
|
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
|
|
@@ -23,15 +23,14 @@ export interface GetTemplateSummaryCommandOutput extends GetTemplateSummaryOutpu
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about a new or existing template. The
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* you can get template information for a stack set, or a running or deleted stack.</p>
|
|
26
|
+
* <p>Returns information about a new or existing template. The <code>GetTemplateSummary</code>
|
|
27
|
+
* action is useful for viewing parameter information, such as default parameter values and
|
|
28
|
+
* parameter types, before you create or update a stack or stack set.</p>
|
|
29
|
+
* <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you
|
|
30
|
+
* can get template information for a stack set, or a running or deleted stack.</p>
|
|
32
31
|
* <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for
|
|
33
|
-
*
|
|
34
|
-
*
|
|
32
|
+
* up to 90 days after the stack has been deleted. If the template doesn't exist, a
|
|
33
|
+
* <code>ValidationError</code> is returned.</p>
|
|
35
34
|
* @example
|
|
36
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
36
|
* ```javascript
|
|
@@ -23,15 +23,9 @@ export interface ImportStacksToStackSetCommandOutput extends ImportStacksToStack
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Import existing stacks into a new stack sets. Use the stack import operation to import
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* intend to import.</p>
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>
|
|
32
|
-
* <code>ImportStacksToStackSet</code> is only supported by self-managed
|
|
33
|
-
* permissions.</p>
|
|
34
|
-
* </note>
|
|
26
|
+
* <p>Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a
|
|
27
|
+
* new stack set in the same account as the source stack or in a different administrator account and Region, by
|
|
28
|
+
* specifying the stack ID of the stack you intend to import.</p>
|
|
35
29
|
* @example
|
|
36
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
31
|
* ```javascript
|
|
@@ -79,26 +73,24 @@ export interface ImportStacksToStackSetCommandOutput extends ImportStacksToStack
|
|
|
79
73
|
*
|
|
80
74
|
* @throws {@link LimitExceededException} (client fault)
|
|
81
75
|
* <p>The quota for the resource has already been reached.</p>
|
|
82
|
-
* <p>For information about resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
83
|
-
*
|
|
76
|
+
* <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
|
|
77
|
+
* <i>CloudFormation User Guide</i>.</p>
|
|
84
78
|
*
|
|
85
79
|
* @throws {@link OperationIdAlreadyExistsException} (client fault)
|
|
86
80
|
* <p>The specified operation ID already exists.</p>
|
|
87
81
|
*
|
|
88
82
|
* @throws {@link OperationInProgressException} (client fault)
|
|
89
|
-
* <p>Another operation is currently in progress for this stack set. Only one operation can be
|
|
90
|
-
*
|
|
83
|
+
* <p>Another operation is currently in progress for this stack set. Only one operation can be performed for a stack
|
|
84
|
+
* set at a given time.</p>
|
|
91
85
|
*
|
|
92
86
|
* @throws {@link StackNotFoundException} (client fault)
|
|
93
|
-
* <p>The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in
|
|
94
|
-
* input.</p>
|
|
87
|
+
* <p>The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.</p>
|
|
95
88
|
*
|
|
96
89
|
* @throws {@link StackSetNotFoundException} (client fault)
|
|
97
90
|
* <p>The specified stack set doesn't exist.</p>
|
|
98
91
|
*
|
|
99
92
|
* @throws {@link StaleRequestException} (client fault)
|
|
100
|
-
* <p>Another operation has been performed on this stack set since the specified operation was
|
|
101
|
-
* performed.</p>
|
|
93
|
+
* <p>Another operation has been performed on this stack set since the specified operation was performed.</p>
|
|
102
94
|
*
|
|
103
95
|
* @throws {@link CloudFormationServiceException}
|
|
104
96
|
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
|
|
@@ -24,7 +24,7 @@ export interface ListChangeSetsCommandOutput extends ListChangeSetsOutput, __Met
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <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
|
|
27
|
-
*
|
|
27
|
+
* <code>CREATE_PENDING</code> state.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,13 +23,13 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists all exported output values in the account and Region in which you call this
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Lists all exported output values in the account and Region in which you call this action.
|
|
27
|
+
* Use this action to see the exported output values that you can import into other stacks. To
|
|
28
|
+
* import values, use the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html">
|
|
29
29
|
* <code>Fn::ImportValue</code>
|
|
30
30
|
* </a> function.</p>
|
|
31
31
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html">
|
|
32
|
-
*
|
|
32
|
+
* CloudFormation export stack output values</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -24,8 +24,8 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Lists all stacks that are importing an exported output value. To modify or remove an
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* exported output value, first use this action to see which stacks are using it. To see the
|
|
28
|
+
* exported output values in your account, see <a>ListExports</a>.</p>
|
|
29
29
|
* <p>For more information about importing an exported output value, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html">
|
|
30
30
|
* <code>Fn::ImportValue</code>
|
|
31
31
|
* </a> function.</p>
|
|
@@ -23,8 +23,9 @@ export interface ListStackInstancesCommandOutput extends ListStackInstancesOutpu
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns summary information about stack instances that are associated with the specified
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns summary information about stack instances that are associated with the specified stack set. You can
|
|
27
|
+
* filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that
|
|
28
|
+
* have a specific status.</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
31
|
* ```javascript
|
|
@@ -25,7 +25,7 @@ export interface ListStackResourcesCommandOutput extends ListStackResourcesOutpu
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns descriptions of all resources of the specified stack.</p>
|
|
27
27
|
* <p>For deleted stacks, ListStackResources returns resource information for up to 90 days
|
|
28
|
-
*
|
|
28
|
+
* after the stack has been deleted.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -26,20 +26,18 @@ export interface ListStackSetsCommandOutput extends ListStackSetsOutput, __Metad
|
|
|
26
26
|
* <p>Returns summary information about stack sets that are associated with the user.</p>
|
|
27
27
|
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
* <p>[Self-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
30
|
-
*
|
|
31
|
-
* <code>ListStackSets</code> returns all self-managed stack sets in your Amazon Web Services account.</p>
|
|
29
|
+
* <p>[Self-managed permissions] If you set the <code>CallAs</code> parameter to <code>SELF</code> while signed in
|
|
30
|
+
* to your Amazon Web Services account, <code>ListStackSets</code> returns all self-managed stack sets in your Amazon Web Services account.</p>
|
|
32
31
|
* </li>
|
|
33
32
|
* <li>
|
|
34
|
-
* <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
35
|
-
*
|
|
36
|
-
*
|
|
33
|
+
* <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to <code>SELF</code> while signed
|
|
34
|
+
* in to the organization's management account, <code>ListStackSets</code> returns all stack sets in the
|
|
35
|
+
* management account.</p>
|
|
37
36
|
* </li>
|
|
38
37
|
* <li>
|
|
39
|
-
* <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* in the management account.</p>
|
|
38
|
+
* <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to <code>DELEGATED_ADMIN</code>
|
|
39
|
+
* while signed in to your member account, <code>ListStackSets</code> returns all stack sets with service-managed
|
|
40
|
+
* permissions in the management account.</p>
|
|
43
41
|
* </li>
|
|
44
42
|
* </ul>
|
|
45
43
|
* @example
|
|
@@ -24,10 +24,9 @@ export interface ListStacksCommandOutput extends ListStacksOutput, __MetadataBea
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the summary information for stacks whose status matches the specified
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* deleted).</p>
|
|
27
|
+
* StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days
|
|
28
|
+
* after the stack is deleted. If no StackStatusFilter is specified, summary information for all
|
|
29
|
+
* stacks is returned (including existing stacks and stacks that have been deleted).</p>
|
|
31
30
|
* @example
|
|
32
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
32
|
* ```javascript
|
|
@@ -24,8 +24,9 @@ export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Publishes the specified extension to the CloudFormation registry as a public
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to
|
|
28
|
+
* make them available for public use</a> in the <i>CloudFormation CLI User
|
|
29
|
+
* Guide</i>.</p>
|
|
29
30
|
* <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,12 +53,12 @@ export interface RecordHandlerProgressCommandOutput extends RecordHandlerProgres
|
|
|
53
53
|
* @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link InvalidStateTransitionException} (client fault)
|
|
56
|
-
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.
|
|
57
|
-
*
|
|
56
|
+
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.
|
|
57
|
+
* CloudFormation doesn't return this error to users.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link OperationStatusCheckFailedException} (client fault)
|
|
60
|
-
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.
|
|
61
|
-
*
|
|
60
|
+
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.
|
|
61
|
+
* CloudFormation doesn't return this error to users.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link CloudFormationServiceException}
|
|
64
64
|
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
|
|
@@ -23,12 +23,12 @@ export interface RegisterPublisherCommandOutput extends RegisterPublisherOutput,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Registers your account as a publisher of public extensions in the CloudFormation
|
|
27
|
-
*
|
|
26
|
+
* <p>Registers your account as a publisher of public extensions in the CloudFormation
|
|
27
|
+
* registry. Public extensions are available for use by all CloudFormation users. This
|
|
28
|
+
* publisher ID applies to your account in all Amazon Web Services Regions.</p>
|
|
28
29
|
* <p>For information about requirements for registering as a public extension publisher, see
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* Guide</i>.</p>
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation extensions</a> in the
|
|
31
|
+
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
32
32
|
* <p></p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|