@aws-sdk/client-cloudformation 3.28.0 → 3.32.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 +38 -0
- package/CloudFormation.ts +126 -61
- package/CloudFormationClient.ts +14 -11
- package/README.md +11 -11
- package/commands/ContinueUpdateRollbackCommand.ts +6 -5
- package/commands/CreateChangeSetCommand.ts +7 -8
- package/commands/CreateStackInstancesCommand.ts +1 -3
- package/commands/DeleteStackInstancesCommand.ts +1 -1
- package/commands/DeleteStackSetCommand.ts +1 -1
- package/commands/DescribeAccountLimitsCommand.ts +2 -2
- package/commands/DescribeChangeSetCommand.ts +2 -1
- package/commands/DescribeStackInstanceCommand.ts +1 -1
- package/commands/DescribeStackResourceDriftsCommand.ts +3 -4
- package/commands/DescribeStacksCommand.ts +1 -1
- package/commands/EstimateTemplateCostCommand.ts +3 -2
- package/commands/ExecuteChangeSetCommand.ts +3 -3
- package/commands/GetTemplateCommand.ts +1 -2
- package/commands/ListChangeSetsCommand.ts +2 -1
- package/commands/ListExportsCommand.ts +1 -1
- package/commands/ListImportsCommand.ts +2 -2
- package/commands/ListStackInstancesCommand.ts +1 -1
- package/commands/ListStackSetsCommand.ts +2 -2
- package/commands/RegisterPublisherCommand.ts +1 -1
- package/commands/RegisterTypeCommand.ts +1 -1
- package/commands/RollbackStackCommand.ts +123 -0
- package/commands/SignalResourceCommand.ts +3 -2
- package/commands/UpdateTerminationProtectionCommand.ts +1 -1
- package/commands/ValidateTemplateCommand.ts +3 -4
- package/dist/cjs/CloudFormation.js +26 -11
- package/dist/cjs/CloudFormation.js.map +1 -1
- package/dist/cjs/CloudFormationClient.js +11 -11
- package/dist/cjs/CloudFormationClient.js.map +1 -1
- package/dist/cjs/commands/ContinueUpdateRollbackCommand.js +6 -5
- package/dist/cjs/commands/ContinueUpdateRollbackCommand.js.map +1 -1
- package/dist/cjs/commands/CreateChangeSetCommand.js +7 -8
- package/dist/cjs/commands/CreateChangeSetCommand.js.map +1 -1
- package/dist/cjs/commands/CreateStackInstancesCommand.js +1 -3
- package/dist/cjs/commands/CreateStackInstancesCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteStackInstancesCommand.js +1 -1
- package/dist/cjs/commands/DeleteStackSetCommand.js +1 -1
- package/dist/cjs/commands/DescribeAccountLimitsCommand.js +2 -2
- package/dist/cjs/commands/DescribeChangeSetCommand.js +2 -1
- package/dist/cjs/commands/DescribeChangeSetCommand.js.map +1 -1
- package/dist/cjs/commands/DescribeStackInstanceCommand.js +1 -1
- package/dist/cjs/commands/DescribeStackResourceDriftsCommand.js +3 -4
- package/dist/cjs/commands/DescribeStackResourceDriftsCommand.js.map +1 -1
- package/dist/cjs/commands/DescribeStacksCommand.js +1 -1
- package/dist/cjs/commands/EstimateTemplateCostCommand.js +3 -2
- package/dist/cjs/commands/EstimateTemplateCostCommand.js.map +1 -1
- package/dist/cjs/commands/ExecuteChangeSetCommand.js +3 -3
- package/dist/cjs/commands/GetTemplateCommand.js +1 -2
- package/dist/cjs/commands/GetTemplateCommand.js.map +1 -1
- package/dist/cjs/commands/ListChangeSetsCommand.js +2 -1
- package/dist/cjs/commands/ListChangeSetsCommand.js.map +1 -1
- package/dist/cjs/commands/ListExportsCommand.js +1 -1
- package/dist/cjs/commands/ListImportsCommand.js +2 -2
- package/dist/cjs/commands/ListStackInstancesCommand.js +1 -1
- package/dist/cjs/commands/ListStackSetsCommand.js +2 -2
- package/dist/cjs/commands/RegisterPublisherCommand.js +1 -1
- package/dist/cjs/commands/RegisterTypeCommand.js +1 -1
- package/dist/cjs/commands/RollbackStackCommand.js +90 -0
- package/dist/cjs/commands/RollbackStackCommand.js.map +1 -0
- package/dist/cjs/commands/SignalResourceCommand.js +3 -2
- package/dist/cjs/commands/SignalResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UpdateTerminationProtectionCommand.js +1 -1
- package/dist/cjs/commands/ValidateTemplateCommand.js +3 -4
- package/dist/cjs/commands/ValidateTemplateCommand.js.map +1 -1
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/models/models_0.js +26 -1
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +32 -32
- package/dist/cjs/protocols/Aws_query.js +135 -47
- package/dist/cjs/protocols/Aws_query.js.map +1 -1
- package/dist/es/CloudFormation.js +26 -11
- package/dist/es/CloudFormation.js.map +1 -1
- package/dist/es/CloudFormationClient.js +11 -11
- package/dist/es/CloudFormationClient.js.map +1 -1
- package/dist/es/commands/ContinueUpdateRollbackCommand.js +6 -5
- package/dist/es/commands/ContinueUpdateRollbackCommand.js.map +1 -1
- package/dist/es/commands/CreateChangeSetCommand.js +7 -8
- package/dist/es/commands/CreateChangeSetCommand.js.map +1 -1
- package/dist/es/commands/CreateStackInstancesCommand.js +1 -3
- package/dist/es/commands/CreateStackInstancesCommand.js.map +1 -1
- package/dist/es/commands/DeleteStackInstancesCommand.js +1 -1
- package/dist/es/commands/DeleteStackSetCommand.js +1 -1
- package/dist/es/commands/DescribeAccountLimitsCommand.js +2 -2
- package/dist/es/commands/DescribeChangeSetCommand.js +2 -1
- package/dist/es/commands/DescribeChangeSetCommand.js.map +1 -1
- package/dist/es/commands/DescribeStackInstanceCommand.js +1 -1
- package/dist/es/commands/DescribeStackResourceDriftsCommand.js +3 -4
- package/dist/es/commands/DescribeStackResourceDriftsCommand.js.map +1 -1
- package/dist/es/commands/DescribeStacksCommand.js +1 -1
- package/dist/es/commands/EstimateTemplateCostCommand.js +3 -2
- package/dist/es/commands/EstimateTemplateCostCommand.js.map +1 -1
- package/dist/es/commands/ExecuteChangeSetCommand.js +3 -3
- package/dist/es/commands/GetTemplateCommand.js +1 -2
- package/dist/es/commands/GetTemplateCommand.js.map +1 -1
- package/dist/es/commands/ListChangeSetsCommand.js +2 -1
- package/dist/es/commands/ListChangeSetsCommand.js.map +1 -1
- package/dist/es/commands/ListExportsCommand.js +1 -1
- package/dist/es/commands/ListImportsCommand.js +2 -2
- package/dist/es/commands/ListStackInstancesCommand.js +1 -1
- package/dist/es/commands/ListStackSetsCommand.js +2 -2
- package/dist/es/commands/RegisterPublisherCommand.js +1 -1
- package/dist/es/commands/RegisterTypeCommand.js +1 -1
- package/dist/es/commands/RollbackStackCommand.js +94 -0
- package/dist/es/commands/RollbackStackCommand.js.map +1 -0
- package/dist/es/commands/SignalResourceCommand.js +3 -2
- package/dist/es/commands/SignalResourceCommand.js.map +1 -1
- package/dist/es/commands/UpdateTerminationProtectionCommand.js +1 -1
- package/dist/es/commands/ValidateTemplateCommand.js +3 -4
- package/dist/es/commands/ValidateTemplateCommand.js.map +1 -1
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/index.js +1 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/models_0.js +21 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +32 -32
- package/dist/es/protocols/Aws_query.js +140 -46
- package/dist/es/protocols/Aws_query.js.map +1 -1
- package/dist/types/CloudFormation.d.ts +96 -61
- package/dist/types/CloudFormationClient.d.ts +14 -13
- package/dist/types/commands/ContinueUpdateRollbackCommand.d.ts +6 -5
- package/dist/types/commands/CreateChangeSetCommand.d.ts +7 -8
- package/dist/types/commands/CreateStackInstancesCommand.d.ts +1 -3
- package/dist/types/commands/DeleteStackInstancesCommand.d.ts +1 -1
- package/dist/types/commands/DeleteStackSetCommand.d.ts +1 -1
- package/dist/types/commands/DescribeAccountLimitsCommand.d.ts +2 -2
- package/dist/types/commands/DescribeChangeSetCommand.d.ts +2 -1
- package/dist/types/commands/DescribeStackInstanceCommand.d.ts +1 -1
- package/dist/types/commands/DescribeStackResourceDriftsCommand.d.ts +3 -4
- package/dist/types/commands/DescribeStacksCommand.d.ts +1 -1
- package/dist/types/commands/EstimateTemplateCostCommand.d.ts +3 -2
- package/dist/types/commands/ExecuteChangeSetCommand.d.ts +3 -3
- package/dist/types/commands/GetTemplateCommand.d.ts +1 -2
- package/dist/types/commands/ListChangeSetsCommand.d.ts +2 -1
- package/dist/types/commands/ListExportsCommand.d.ts +1 -1
- package/dist/types/commands/ListImportsCommand.d.ts +2 -2
- package/dist/types/commands/ListStackInstancesCommand.d.ts +1 -1
- package/dist/types/commands/ListStackSetsCommand.d.ts +2 -2
- package/dist/types/commands/RegisterPublisherCommand.d.ts +1 -1
- package/dist/types/commands/RegisterTypeCommand.d.ts +1 -1
- package/dist/types/commands/RollbackStackCommand.d.ts +64 -0
- package/dist/types/commands/SignalResourceCommand.d.ts +3 -2
- package/dist/types/commands/UpdateTerminationProtectionCommand.d.ts +1 -1
- package/dist/types/commands/ValidateTemplateCommand.d.ts +3 -4
- package/dist/types/index.d.ts +1 -0
- package/dist/types/models/models_0.d.ts +424 -376
- package/dist/types/protocols/Aws_query.d.ts +3 -0
- package/dist/types/ts3.4/CloudFormation.d.ts +96 -61
- package/dist/types/ts3.4/CloudFormationClient.d.ts +14 -13
- package/dist/types/ts3.4/commands/ContinueUpdateRollbackCommand.d.ts +6 -5
- package/dist/types/ts3.4/commands/CreateChangeSetCommand.d.ts +7 -8
- package/dist/types/ts3.4/commands/CreateStackInstancesCommand.d.ts +1 -3
- package/dist/types/ts3.4/commands/DeleteStackInstancesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DeleteStackSetCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DescribeAccountLimitsCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/DescribeChangeSetCommand.d.ts +2 -1
- package/dist/types/ts3.4/commands/DescribeStackInstanceCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DescribeStackResourceDriftsCommand.d.ts +3 -4
- package/dist/types/ts3.4/commands/DescribeStacksCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/EstimateTemplateCostCommand.d.ts +3 -2
- package/dist/types/ts3.4/commands/ExecuteChangeSetCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/GetTemplateCommand.d.ts +1 -2
- package/dist/types/ts3.4/commands/ListChangeSetsCommand.d.ts +2 -1
- package/dist/types/ts3.4/commands/ListExportsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListImportsCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListStackInstancesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListStackSetsCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/RegisterPublisherCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/RegisterTypeCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/RollbackStackCommand.d.ts +64 -0
- package/dist/types/ts3.4/commands/SignalResourceCommand.d.ts +3 -2
- package/dist/types/ts3.4/commands/UpdateTerminationProtectionCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ValidateTemplateCommand.d.ts +3 -4
- package/dist/types/ts3.4/index.d.ts +1 -0
- package/dist/types/ts3.4/models/models_0.d.ts +424 -376
- package/dist/types/ts3.4/protocols/Aws_query.d.ts +3 -0
- package/index.ts +1 -0
- package/models/models_0.ts +435 -375
- package/package.json +32 -32
- package/protocols/Aws_query.ts +151 -46
package/models/models_0.ts
CHANGED
|
@@ -5,13 +5,13 @@ export type AccountGateStatus = "FAILED" | "SKIPPED" | "SUCCEEDED";
|
|
|
5
5
|
/**
|
|
6
6
|
* <p>Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an
|
|
7
7
|
* account and Region.</p>
|
|
8
|
-
* <p>For each account and Region, CloudFormation lets you specify a
|
|
8
|
+
* <p>For each account and Region, CloudFormation lets you specify a Lambda
|
|
9
9
|
* function that encapsulates any requirements that must be met before CloudFormation
|
|
10
10
|
* can proceed with a stack set operation in that account and Region. CloudFormation
|
|
11
11
|
* invokes the function each time a stack set operation is requested for that account and
|
|
12
12
|
* Region; if the function returns <code>FAILED</code>, CloudFormation cancels the
|
|
13
13
|
* operation in that account and Region, and sets the stack set operation result status for
|
|
14
|
-
* that account and Region to <code>FAILED</code
|
|
14
|
+
* that account and Region to <code>FAILED</code>.</p>
|
|
15
15
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html">Configuring a
|
|
16
16
|
* target account gate</a>.</p>
|
|
17
17
|
*/
|
|
@@ -23,22 +23,21 @@ export interface AccountGateResult {
|
|
|
23
23
|
* <p>
|
|
24
24
|
* <code>SUCCEEDED</code>: The account gate function has determined that the
|
|
25
25
|
* account and Region passes any requirements for a stack set operation to occur.
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* CloudFormation proceeds with the stack operation in that account and Region.
|
|
27
|
+
* </p>
|
|
28
28
|
* </li>
|
|
29
29
|
* <li>
|
|
30
30
|
* <p>
|
|
31
31
|
* <code>FAILED</code>: The account gate function has determined that the account
|
|
32
32
|
* and Region does not meet the requirements for a stack set operation to occur. AWS
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* CloudFormation cancels the stack set operation in that account and Region, and sets
|
|
34
|
+
* the stack set operation result status for that account and Region to
|
|
35
35
|
* <code>FAILED</code>. </p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
38
|
* <p>
|
|
39
|
-
* <code>SKIPPED</code>: CloudFormation has skipped calling the account
|
|
40
|
-
*
|
|
41
|
-
* reasons:</p>
|
|
39
|
+
* <code>SKIPPED</code>: CloudFormation has skipped calling the account gate
|
|
40
|
+
* function for this account and Region, for one of the following reasons:</p>
|
|
42
41
|
* <ul>
|
|
43
42
|
* <li>
|
|
44
43
|
* <p>An account gate function has not been specified for the account and
|
|
@@ -47,12 +46,13 @@ export interface AccountGateResult {
|
|
|
47
46
|
* </li>
|
|
48
47
|
* <li>
|
|
49
48
|
* <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set
|
|
50
|
-
* adminstration account lacks permissions to invoke the function.
|
|
49
|
+
* adminstration account lacks permissions to invoke the function.
|
|
50
|
+
* CloudFormation proceeds with the stack set operation in this account and
|
|
51
51
|
* Region.</p>
|
|
52
52
|
* </li>
|
|
53
53
|
* <li>
|
|
54
54
|
* <p>Either no action is necessary, or no action is possible, on the stack.
|
|
55
|
-
*
|
|
55
|
+
* CloudFormation skips the stack set operation in this account and
|
|
56
56
|
* Region.</p>
|
|
57
57
|
* </li>
|
|
58
58
|
* </ul>
|
|
@@ -567,8 +567,8 @@ export interface CancelUpdateStackInput {
|
|
|
567
567
|
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this
|
|
568
568
|
* token if you plan to retry requests so that CloudFormation knows that you're not
|
|
569
569
|
* attempting to cancel an update on a stack with the same name. You might retry
|
|
570
|
-
*
|
|
571
|
-
*
|
|
570
|
+
* <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully
|
|
571
|
+
* received them.</p>
|
|
572
572
|
*/
|
|
573
573
|
ClientRequestToken?: string;
|
|
574
574
|
}
|
|
@@ -688,21 +688,21 @@ export namespace ResourceTargetDefinition {
|
|
|
688
688
|
|
|
689
689
|
/**
|
|
690
690
|
* <p>For a resource with <code>Modify</code> as the action, the
|
|
691
|
-
* <code>ResourceChange</code> structure describes the changes CloudFormation will
|
|
692
|
-
*
|
|
691
|
+
* <code>ResourceChange</code> structure describes the changes CloudFormation will make
|
|
692
|
+
* to that resource.</p>
|
|
693
693
|
*/
|
|
694
694
|
export interface ResourceChangeDetail {
|
|
695
695
|
/**
|
|
696
696
|
* <p>A <code>ResourceTargetDefinition</code> structure that describes the field that
|
|
697
|
-
*
|
|
697
|
+
* CloudFormation will change and whether the resource will be recreated.</p>
|
|
698
698
|
*/
|
|
699
699
|
Target?: ResourceTargetDefinition;
|
|
700
700
|
|
|
701
701
|
/**
|
|
702
|
-
* <p>Indicates whether CloudFormation can determine the target value, and whether
|
|
703
|
-
*
|
|
704
|
-
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the
|
|
705
|
-
*
|
|
702
|
+
* <p>Indicates whether CloudFormation can determine the target value, and whether the
|
|
703
|
+
* target value will change before you execute a change set.</p>
|
|
704
|
+
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the target
|
|
705
|
+
* value will change, and its value. For example, if you directly modify the
|
|
706
706
|
* <code>InstanceType</code> property of an EC2 instance, CloudFormation knows that
|
|
707
707
|
* this property value will change, and its value, so this is a <code>Static</code>
|
|
708
708
|
* evaluation.</p>
|
|
@@ -750,7 +750,7 @@ export interface ResourceChangeDetail {
|
|
|
750
750
|
* <code>AWS::CloudFormation::Stack</code> resource, CloudFormation sets the
|
|
751
751
|
* <code>ChangeSource</code> to <code>Automatic</code> because the nested stack's
|
|
752
752
|
* template might have changed. Changes to a nested stack's template aren't visible to
|
|
753
|
-
*
|
|
753
|
+
* CloudFormation until you run an update on the parent stack.</p>
|
|
754
754
|
* </li>
|
|
755
755
|
* </ul>
|
|
756
756
|
*/
|
|
@@ -831,14 +831,14 @@ export enum Replacement {
|
|
|
831
831
|
|
|
832
832
|
/**
|
|
833
833
|
* <p>The <code>ResourceChange</code> structure describes the resource and the action that
|
|
834
|
-
*
|
|
834
|
+
* CloudFormation will perform on it if you execute this change set.</p>
|
|
835
835
|
*/
|
|
836
836
|
export interface ResourceChange {
|
|
837
837
|
/**
|
|
838
|
-
* <p>The action that CloudFormation takes on the resource, such as
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
*
|
|
838
|
+
* <p>The action that CloudFormation takes on the resource, such as <code>Add</code>
|
|
839
|
+
* (adds a new resource), <code>Modify</code> (changes a resource), <code>Remove</code>
|
|
840
|
+
* (deletes a resource), <code>Import</code> (imports a resource), or <code>Dynamic</code>
|
|
841
|
+
* (exact action for the resource cannot be determined).</p>
|
|
842
842
|
*/
|
|
843
843
|
Action?: ChangeAction | string;
|
|
844
844
|
|
|
@@ -860,9 +860,9 @@ export interface ResourceChange {
|
|
|
860
860
|
ResourceType?: string;
|
|
861
861
|
|
|
862
862
|
/**
|
|
863
|
-
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will
|
|
864
|
-
*
|
|
865
|
-
*
|
|
863
|
+
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will replace
|
|
864
|
+
* the resource by creating a new one and deleting the old one. This value depends on the
|
|
865
|
+
* value of the <code>RequiresRecreation</code> property in the
|
|
866
866
|
* <code>ResourceTargetDefinition</code> structure. For example, if the
|
|
867
867
|
* <code>RequiresRecreation</code> field is <code>Always</code> and the
|
|
868
868
|
* <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is
|
|
@@ -885,8 +885,8 @@ export interface ResourceChange {
|
|
|
885
885
|
|
|
886
886
|
/**
|
|
887
887
|
* <p>For the <code>Modify</code> action, a list of <code>ResourceChangeDetail</code>
|
|
888
|
-
* structures that describes the changes that CloudFormation will make to the
|
|
889
|
-
*
|
|
888
|
+
* structures that describes the changes that CloudFormation will make to the resource.
|
|
889
|
+
* </p>
|
|
890
890
|
*/
|
|
891
891
|
Details?: ResourceChangeDetail[];
|
|
892
892
|
|
|
@@ -921,14 +921,14 @@ export enum ChangeType {
|
|
|
921
921
|
*/
|
|
922
922
|
export interface Change {
|
|
923
923
|
/**
|
|
924
|
-
* <p>The type of entity that CloudFormation changes. Currently, the only entity
|
|
925
|
-
*
|
|
924
|
+
* <p>The type of entity that CloudFormation changes. Currently, the only entity type
|
|
925
|
+
* is <code>Resource</code>.</p>
|
|
926
926
|
*/
|
|
927
927
|
Type?: ChangeType | string;
|
|
928
928
|
|
|
929
929
|
/**
|
|
930
930
|
* <p>A <code>ResourceChange</code> structure that describes the resource and action that
|
|
931
|
-
*
|
|
931
|
+
* CloudFormation will perform.</p>
|
|
932
932
|
*/
|
|
933
933
|
ResourceChange?: ResourceChange;
|
|
934
934
|
}
|
|
@@ -1086,20 +1086,21 @@ export interface ContinueUpdateRollbackInput {
|
|
|
1086
1086
|
StackName: string | undefined;
|
|
1087
1087
|
|
|
1088
1088
|
/**
|
|
1089
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1090
|
-
*
|
|
1091
|
-
*
|
|
1092
|
-
*
|
|
1093
|
-
*
|
|
1094
|
-
*
|
|
1095
|
-
*
|
|
1096
|
-
*
|
|
1089
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1090
|
+
* that CloudFormation assumes to roll back the stack. CloudFormation uses the role's
|
|
1091
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for all
|
|
1092
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
1093
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
1094
|
+
* Ensure that the role grants least privilege.</p>
|
|
1095
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1096
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1097
|
+
* session that is generated from your user credentials.</p>
|
|
1097
1098
|
*/
|
|
1098
1099
|
RoleARN?: string;
|
|
1099
1100
|
|
|
1100
1101
|
/**
|
|
1101
|
-
* <p>A list of the logical IDs of the resources that CloudFormation skips during
|
|
1102
|
-
*
|
|
1102
|
+
* <p>A list of the logical IDs of the resources that CloudFormation skips during the
|
|
1103
|
+
* continue update rollback operation. You can specify only resources that are in the
|
|
1103
1104
|
* <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources
|
|
1104
1105
|
* that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an
|
|
1105
1106
|
* update was cancelled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p>
|
|
@@ -1111,30 +1112,30 @@ export interface ContinueUpdateRollbackInput {
|
|
|
1111
1112
|
* will be inconsistent with the state of the resources in the stack template. Before
|
|
1112
1113
|
* performing another stack update, you must update the stack or resources to be consistent
|
|
1113
1114
|
* with each other. If you don't, subsequent stack updates might fail, and the stack will
|
|
1114
|
-
* become unrecoverable
|
|
1115
|
+
* become unrecoverable.</p>
|
|
1115
1116
|
* </important>
|
|
1116
|
-
* <p>Specify the minimum number of resources required to successfully roll back your
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1117
|
+
* <p>Specify the minimum number of resources required to successfully roll back your stack.
|
|
1118
|
+
* For example, a failed resource update might cause dependent resources to fail. In this
|
|
1119
|
+
* case, it might not be necessary to skip the dependent resources.</p>
|
|
1119
1120
|
* <p>To skip resources that are part of nested stacks, use the following format:
|
|
1120
1121
|
* <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of
|
|
1121
1122
|
* a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the
|
|
1122
1123
|
* <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one
|
|
1123
1124
|
* of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or
|
|
1124
|
-
* <code>DELETE_FAILED</code
|
|
1125
|
+
* <code>DELETE_FAILED</code>.</p>
|
|
1125
1126
|
* <note>
|
|
1126
|
-
* <p>Don't confuse a child stack's name with its corresponding logical ID defined in
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1127
|
+
* <p>Don't confuse a child stack's name with its corresponding logical ID defined in the
|
|
1128
|
+
* parent stack. For an example of a continue update rollback operation with nested stacks,
|
|
1129
|
+
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks">Using ResourcesToSkip to recover a nested stacks hierarchy</a>.</p>
|
|
1129
1130
|
* </note>
|
|
1130
1131
|
*/
|
|
1131
1132
|
ResourcesToSkip?: string[];
|
|
1132
1133
|
|
|
1133
1134
|
/**
|
|
1134
1135
|
* <p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify
|
|
1135
|
-
* this token if you plan to retry requests so that CloudFormationknows that you're
|
|
1136
|
-
*
|
|
1137
|
-
*
|
|
1136
|
+
* this token if you plan to retry requests so that CloudFormationknows that you're not
|
|
1137
|
+
* attempting to continue the rollback to a stack with the same name. You might retry
|
|
1138
|
+
* <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation
|
|
1138
1139
|
* successfully received them.</p>
|
|
1139
1140
|
*/
|
|
1140
1141
|
ClientRequestToken?: string;
|
|
@@ -1169,8 +1170,8 @@ export namespace ContinueUpdateRollbackOutput {
|
|
|
1169
1170
|
export interface Parameter {
|
|
1170
1171
|
/**
|
|
1171
1172
|
* <p>The key associated with the parameter. If you don't specify a key and value for a
|
|
1172
|
-
* particular parameter, CloudFormation uses the default value that is specified in
|
|
1173
|
-
*
|
|
1173
|
+
* particular parameter, CloudFormation uses the default value that is specified in your
|
|
1174
|
+
* template.</p>
|
|
1174
1175
|
*/
|
|
1175
1176
|
ParameterKey?: string;
|
|
1176
1177
|
|
|
@@ -1304,17 +1305,17 @@ export interface RollbackConfiguration {
|
|
|
1304
1305
|
RollbackTriggers?: RollbackTrigger[];
|
|
1305
1306
|
|
|
1306
1307
|
/**
|
|
1307
|
-
* <p>The amount of time, in minutes, during which CloudFormation should monitor
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1308
|
+
* <p>The amount of time, in minutes, during which CloudFormation should monitor all the
|
|
1309
|
+
* rollback triggers after the stack creation or update operation deploys all necessary
|
|
1310
|
+
* resources.</p>
|
|
1310
1311
|
* <p>The default is 0 minutes.</p>
|
|
1311
|
-
* <p>If you specify a monitoring period but do not specify any rollback triggers,
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
*
|
|
1317
|
-
* completes.</p>
|
|
1312
|
+
* <p>If you specify a monitoring period but do not specify any rollback triggers,
|
|
1313
|
+
* CloudFormation still waits the specified period of time before cleaning up old resources
|
|
1314
|
+
* after update operations. You can use this monitoring period to perform any manual stack
|
|
1315
|
+
* validation desired, and manually cancel the stack creation or update (using <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html">CancelUpdateStack</a>, for example) as necessary.</p>
|
|
1316
|
+
* <p>If you specify 0 for this parameter, CloudFormation still monitors the specified
|
|
1317
|
+
* rollback triggers during stack creation and update operations. Then, for update operations,
|
|
1318
|
+
* it begins disposing of old resources immediately once the operation completes.</p>
|
|
1318
1319
|
*/
|
|
1319
1320
|
MonitoringTimeInMinutes?: number;
|
|
1320
1321
|
}
|
|
@@ -1336,7 +1337,8 @@ export interface Tag {
|
|
|
1336
1337
|
/**
|
|
1337
1338
|
* <p>
|
|
1338
1339
|
* <i>Required</i>. A string used to identify this tag. You can specify a
|
|
1339
|
-
* maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the
|
|
1340
|
+
* maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the
|
|
1341
|
+
* reserved prefix: <code>aws:</code>.</p>
|
|
1340
1342
|
*/
|
|
1341
1343
|
Key: string | undefined;
|
|
1342
1344
|
|
|
@@ -1363,16 +1365,16 @@ export namespace Tag {
|
|
|
1363
1365
|
export interface CreateChangeSetInput {
|
|
1364
1366
|
/**
|
|
1365
1367
|
* <p>The name or the unique ID of the stack for which you are creating a change set.
|
|
1366
|
-
*
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1368
|
+
* CloudFormation generates the change set by comparing this stack's information with the
|
|
1369
|
+
* information that you submit, such as a modified template or different parameter input
|
|
1370
|
+
* values.</p>
|
|
1369
1371
|
*/
|
|
1370
1372
|
StackName: string | undefined;
|
|
1371
1373
|
|
|
1372
1374
|
/**
|
|
1373
1375
|
* <p>A structure that contains the body of the revised template, with a minimum length of
|
|
1374
|
-
* 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change
|
|
1375
|
-
*
|
|
1376
|
+
* 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by
|
|
1377
|
+
* comparing this template with the template of the stack that you specified.</p>
|
|
1376
1378
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1377
1379
|
* <code>TemplateURL</code>.</p>
|
|
1378
1380
|
*/
|
|
@@ -1381,8 +1383,8 @@ export interface CreateChangeSetInput {
|
|
|
1381
1383
|
/**
|
|
1382
1384
|
* <p>The location of the file that contains the revised template. The URL must point to a
|
|
1383
1385
|
* template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager
|
|
1384
|
-
* document. CloudFormation generates the change set by comparing this template with
|
|
1385
|
-
*
|
|
1386
|
+
* document. CloudFormation generates the change set by comparing this template with the
|
|
1387
|
+
* stack that you specified.</p>
|
|
1386
1388
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1387
1389
|
* <code>TemplateURL</code>.</p>
|
|
1388
1390
|
*/
|
|
@@ -1409,7 +1411,7 @@ export interface CreateChangeSetInput {
|
|
|
1409
1411
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1410
1412
|
* </p>
|
|
1411
1413
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
1412
|
-
* your account; for example, by creating new Identity and Access Management
|
|
1414
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1413
1415
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
1414
1416
|
* of these capabilities.</p>
|
|
1415
1417
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -1417,11 +1419,12 @@ export interface CreateChangeSetInput {
|
|
|
1417
1419
|
* capability.</p>
|
|
1418
1420
|
* <ul>
|
|
1419
1421
|
* <li>
|
|
1420
|
-
* <p>If you have IAM resources, you can specify either
|
|
1422
|
+
* <p>If you have IAM resources, you can specify either
|
|
1423
|
+
* capability.</p>
|
|
1421
1424
|
* </li>
|
|
1422
1425
|
* <li>
|
|
1423
|
-
* <p>If you have IAM resources with custom names, you
|
|
1424
|
-
*
|
|
1426
|
+
* <p>If you have IAM resources with custom names, you
|
|
1427
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1425
1428
|
* </li>
|
|
1426
1429
|
* <li>
|
|
1427
1430
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -1507,22 +1510,24 @@ export interface CreateChangeSetInput {
|
|
|
1507
1510
|
* this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or
|
|
1508
1511
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
1509
1512
|
* <p>If the list of resource types doesn't include a resource type that you're updating,
|
|
1510
|
-
* the stack update fails. By default, CloudFormation grants permissions to all
|
|
1511
|
-
*
|
|
1512
|
-
* policies for CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1513
|
-
*
|
|
1513
|
+
* the stack update fails. By default, CloudFormation grants permissions to all resource
|
|
1514
|
+
* types. Identity and Access Management (IAM) uses this parameter for condition keys in
|
|
1515
|
+
* IAM policies for CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1516
|
+
* Identity and Access Management</a> in the CloudFormation User
|
|
1517
|
+
* Guide.</p>
|
|
1514
1518
|
*/
|
|
1515
1519
|
ResourceTypes?: string[];
|
|
1516
1520
|
|
|
1517
1521
|
/**
|
|
1518
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1519
|
-
*
|
|
1520
|
-
*
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
1525
|
-
*
|
|
1522
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1523
|
+
* that CloudFormation assumes when executing the change set. CloudFormation uses the
|
|
1524
|
+
* role's credentials to make calls on your behalf. CloudFormation uses this role for all
|
|
1525
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
1526
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
1527
|
+
* Ensure that the role grants least privilege.</p>
|
|
1528
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1529
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1530
|
+
* session that is generated from your user credentials.</p>
|
|
1526
1531
|
*/
|
|
1527
1532
|
RoleARN?: string;
|
|
1528
1533
|
|
|
@@ -1556,8 +1561,8 @@ export interface CreateChangeSetInput {
|
|
|
1556
1561
|
|
|
1557
1562
|
/**
|
|
1558
1563
|
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token
|
|
1559
|
-
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
1560
|
-
*
|
|
1564
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
1565
|
+
* to create another change set with the same name. You might retry
|
|
1561
1566
|
* <code>CreateChangeSet</code> requests to ensure that CloudFormation successfully
|
|
1562
1567
|
* received them.</p>
|
|
1563
1568
|
*/
|
|
@@ -1573,8 +1578,8 @@ export interface CreateChangeSetInput {
|
|
|
1573
1578
|
* <code>CREATE</code>. To create a change set for an existing stack, specify
|
|
1574
1579
|
* <code>UPDATE</code>. To create a change set for an import operation, specify
|
|
1575
1580
|
* <code>IMPORT</code>.</p>
|
|
1576
|
-
* <p>If you create a change set for a new stack, CloudFormation creates a stack
|
|
1577
|
-
*
|
|
1581
|
+
* <p>If you create a change set for a new stack, CloudFormation creates a stack with a
|
|
1582
|
+
* unique stack ID, but no template or resources. The stack will be in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995">
|
|
1578
1583
|
* <code>REVIEW_IN_PROGRESS</code>
|
|
1579
1584
|
* </a> state until you execute the change
|
|
1580
1585
|
* set.</p>
|
|
@@ -1683,8 +1688,8 @@ export interface CreateStackInput {
|
|
|
1683
1688
|
* <p>The name that is associated with the stack. The name must be unique in the Region in
|
|
1684
1689
|
* which you are creating the stack.</p>
|
|
1685
1690
|
* <note>
|
|
1686
|
-
* <p>A stack name can contain only alphanumeric characters (case sensitive) and
|
|
1687
|
-
*
|
|
1691
|
+
* <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens.
|
|
1692
|
+
* It must start with an alphabetical character and cannot be longer than 128
|
|
1688
1693
|
* characters.</p>
|
|
1689
1694
|
* </note>
|
|
1690
1695
|
*/
|
|
@@ -1754,7 +1759,7 @@ export interface CreateStackInput {
|
|
|
1754
1759
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1755
1760
|
* </p>
|
|
1756
1761
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
1757
|
-
* your account; for example, by creating new Identity and Access Management
|
|
1762
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1758
1763
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
1759
1764
|
* of these capabilities.</p>
|
|
1760
1765
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -1762,11 +1767,11 @@ export interface CreateStackInput {
|
|
|
1762
1767
|
* capability.</p>
|
|
1763
1768
|
* <ul>
|
|
1764
1769
|
* <li>
|
|
1765
|
-
* <p>If you have IAM resources, you can specify either capability
|
|
1770
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
1766
1771
|
* </li>
|
|
1767
1772
|
* <li>
|
|
1768
1773
|
* <p>If you have IAM resources with custom names, you <i>must</i>
|
|
1769
|
-
* specify <code>CAPABILITY_NAMED_IAM</code
|
|
1774
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1770
1775
|
* </li>
|
|
1771
1776
|
* <li>
|
|
1772
1777
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -1862,24 +1867,23 @@ export interface CreateStackInput {
|
|
|
1862
1867
|
* <code>AWS::<i>service_name</i>::*</code> (for all resources of a
|
|
1863
1868
|
* particular Amazon Web Services service), and
|
|
1864
1869
|
* <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i>
|
|
1865
|
-
*
|
|
1870
|
+
* </code> (for a specific Amazon Web Services resource).</p>
|
|
1866
1871
|
* <p>If the list of resource types doesn't include a resource that you're creating, the
|
|
1867
1872
|
* stack creation fails. By default, CloudFormation grants permissions to all resource
|
|
1868
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
1869
|
-
* condition keys in IAM policies. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1870
|
-
* Identity and Access Management</a>.</p>
|
|
1873
|
+
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with Identity and Access Management</a>.</p>
|
|
1871
1874
|
*/
|
|
1872
1875
|
ResourceTypes?: string[];
|
|
1873
1876
|
|
|
1874
1877
|
/**
|
|
1875
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1876
|
-
*
|
|
1877
|
-
*
|
|
1878
|
-
*
|
|
1879
|
-
*
|
|
1880
|
-
*
|
|
1881
|
-
*
|
|
1882
|
-
*
|
|
1878
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1879
|
+
* that CloudFormation assumes to create the stack. CloudFormation uses the role's
|
|
1880
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for all
|
|
1881
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
1882
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
1883
|
+
* Ensure that the role grants least privilege.</p>
|
|
1884
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1885
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1886
|
+
* session that is generated from your user credentials.</p>
|
|
1883
1887
|
*/
|
|
1884
1888
|
RoleARN?: string;
|
|
1885
1889
|
|
|
@@ -1894,17 +1898,17 @@ export interface CreateStackInput {
|
|
|
1894
1898
|
|
|
1895
1899
|
/**
|
|
1896
1900
|
* <p>Structure containing the stack policy body. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates
|
|
1897
|
-
* to Stack Resources</a> in the <i>CloudFormation User
|
|
1898
|
-
*
|
|
1899
|
-
*
|
|
1901
|
+
* to Stack Resources</a> in the <i>CloudFormation User Guide</i>.
|
|
1902
|
+
* You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code>
|
|
1903
|
+
* parameter, but not both.</p>
|
|
1900
1904
|
*/
|
|
1901
1905
|
StackPolicyBody?: string;
|
|
1902
1906
|
|
|
1903
1907
|
/**
|
|
1904
1908
|
* <p>Location of a file containing the stack policy. The URL must point to a policy
|
|
1905
|
-
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
1906
|
-
* specify either the <code>StackPolicyBody</code> or the
|
|
1907
|
-
*
|
|
1909
|
+
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
1910
|
+
* Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
1911
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
1908
1912
|
*/
|
|
1909
1913
|
StackPolicyURL?: string;
|
|
1910
1914
|
|
|
@@ -1917,30 +1921,30 @@ export interface CreateStackInput {
|
|
|
1917
1921
|
|
|
1918
1922
|
/**
|
|
1919
1923
|
* <p>A unique identifier for this <code>CreateStack</code> request. Specify this token if
|
|
1920
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
1921
|
-
*
|
|
1924
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1925
|
+
* create a stack with the same name. You might retry <code>CreateStack</code> requests to
|
|
1922
1926
|
* ensure that CloudFormation successfully received them.</p>
|
|
1923
1927
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
1924
1928
|
* token, which you can use to track operations. For example, if you execute a
|
|
1925
|
-
*
|
|
1926
|
-
*
|
|
1927
|
-
*
|
|
1929
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
1930
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
1931
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
1928
1932
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
1929
1933
|
* Stack operations that are initiated from the console use the token format
|
|
1930
1934
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
1931
1935
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
1932
1936
|
* would be assigned the same token in the following format:
|
|
1933
|
-
*
|
|
1937
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>
|
|
1934
1938
|
*/
|
|
1935
1939
|
ClientRequestToken?: string;
|
|
1936
1940
|
|
|
1937
1941
|
/**
|
|
1938
|
-
* <p>Whether to enable termination protection on the specified stack. If a user attempts
|
|
1939
|
-
*
|
|
1942
|
+
* <p>Whether to enable termination protection on the specified stack. If a user attempts to
|
|
1943
|
+
* delete a stack with termination protection enabled, the operation fails and the stack
|
|
1940
1944
|
* remains unchanged. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a Stack From Being
|
|
1941
1945
|
* Deleted</a> in the <i>CloudFormation User Guide</i>. Termination protection is
|
|
1942
|
-
* disabled on stacks by default
|
|
1943
|
-
* <p>
|
|
1946
|
+
* disabled on stacks by default.</p>
|
|
1947
|
+
* <p>For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>,
|
|
1944
1948
|
* termination protection is set on the root stack and cannot be changed directly on the
|
|
1945
1949
|
* nested stack.</p>
|
|
1946
1950
|
*/
|
|
@@ -1986,7 +1990,7 @@ export namespace CreateStackOutput {
|
|
|
1986
1990
|
*/
|
|
1987
1991
|
export interface DeploymentTargets {
|
|
1988
1992
|
/**
|
|
1989
|
-
* <p>The names of one or more accounts for which you want to deploy stack
|
|
1993
|
+
* <p>The names of one or more Amazon Web Services accounts for which you want to deploy stack
|
|
1990
1994
|
* set updates.</p>
|
|
1991
1995
|
*/
|
|
1992
1996
|
Accounts?: string[];
|
|
@@ -2035,9 +2039,9 @@ export interface StackSetOperationPreferences {
|
|
|
2035
2039
|
RegionOrder?: string[];
|
|
2036
2040
|
|
|
2037
2041
|
/**
|
|
2038
|
-
* <p>The number of accounts, per Region, for which this operation can fail before
|
|
2039
|
-
*
|
|
2040
|
-
* Regions.</p>
|
|
2042
|
+
* <p>The number of accounts, per Region, for which this operation can fail before
|
|
2043
|
+
* CloudFormation stops the operation in that Region. If the operation is stopped in a Region,
|
|
2044
|
+
* CloudFormation doesn't attempt the operation in any subsequent Regions.</p>
|
|
2041
2045
|
* <p>Conditional: You must specify either <code>FailureToleranceCount</code> or
|
|
2042
2046
|
* <code>FailureTolerancePercentage</code> (but not both).</p>
|
|
2043
2047
|
* <p>By default, <code>0</code> is specified.</p>
|
|
@@ -2046,10 +2050,11 @@ export interface StackSetOperationPreferences {
|
|
|
2046
2050
|
|
|
2047
2051
|
/**
|
|
2048
2052
|
* <p>The percentage of accounts, per Region, for which this stack operation can fail
|
|
2049
|
-
* before CloudFormation stops the operation in that Region. If the operation is
|
|
2050
|
-
*
|
|
2053
|
+
* before CloudFormation stops the operation in that Region. If the operation is stopped
|
|
2054
|
+
* in a Region, CloudFormation doesn't attempt the operation in any subsequent
|
|
2051
2055
|
* Regions.</p>
|
|
2052
|
-
* <p>When calculating the number of accounts based on the specified percentage,
|
|
2056
|
+
* <p>When calculating the number of accounts based on the specified percentage,
|
|
2057
|
+
* CloudFormation rounds <i>down</i> to the next whole number.</p>
|
|
2053
2058
|
* <p>Conditional: You must specify either <code>FailureToleranceCount</code> or
|
|
2054
2059
|
* <code>FailureTolerancePercentage</code>, but not both.</p>
|
|
2055
2060
|
* <p>By default, <code>0</code> is specified.</p>
|
|
@@ -2058,9 +2063,9 @@ export interface StackSetOperationPreferences {
|
|
|
2058
2063
|
|
|
2059
2064
|
/**
|
|
2060
2065
|
* <p>The maximum number of accounts in which to perform this operation at one time. This
|
|
2061
|
-
* is dependent on the value of
|
|
2062
|
-
* <code>MaxConcurrentCount</code> is at most one more
|
|
2063
|
-
*
|
|
2066
|
+
* is dependent on the value of
|
|
2067
|
+
* <code>FailureToleranceCount</code>. <code>MaxConcurrentCount</code> is at most one more
|
|
2068
|
+
* than the <code>FailureToleranceCount</code>.</p>
|
|
2064
2069
|
* <p>Note that this setting lets you specify the <i>maximum</i> for
|
|
2065
2070
|
* operations. For large deployments, under certain circumstances the actual number of
|
|
2066
2071
|
* accounts acted upon concurrently may be lower due to service throttling.</p>
|
|
@@ -2073,9 +2078,10 @@ export interface StackSetOperationPreferences {
|
|
|
2073
2078
|
/**
|
|
2074
2079
|
* <p>The maximum percentage of accounts in which to perform this operation at one
|
|
2075
2080
|
* time.</p>
|
|
2076
|
-
* <p>When calculating the number of accounts based on the specified percentage,
|
|
2077
|
-
*
|
|
2078
|
-
* as one
|
|
2081
|
+
* <p>When calculating the number of accounts based on the specified percentage,
|
|
2082
|
+
* CloudFormation rounds down to the next whole number. This is true except in cases where
|
|
2083
|
+
* rounding down would result is zero. In this case, CloudFormation sets the number as one
|
|
2084
|
+
* instead.</p>
|
|
2079
2085
|
* <p>Note that this setting lets you specify the <i>maximum</i> for
|
|
2080
2086
|
* operations. For large deployments, under certain circumstances the actual number of
|
|
2081
2087
|
* accounts acted upon concurrently may be lower due to service throttling.</p>
|
|
@@ -2103,10 +2109,9 @@ export interface CreateStackInstancesInput {
|
|
|
2103
2109
|
StackSetName: string | undefined;
|
|
2104
2110
|
|
|
2105
2111
|
/**
|
|
2106
|
-
* <p>[Self-managed permissions] The names of one or more accounts that
|
|
2107
|
-
*
|
|
2108
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
2109
|
-
* both.</p>
|
|
2112
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the
|
|
2113
|
+
* specified Region(s) for.</p>
|
|
2114
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
2110
2115
|
*/
|
|
2111
2116
|
Accounts?: string[];
|
|
2112
2117
|
|
|
@@ -2120,7 +2125,7 @@ export interface CreateStackInstancesInput {
|
|
|
2120
2125
|
|
|
2121
2126
|
/**
|
|
2122
2127
|
* <p>The names of one or more Regions where you want to create stack instances using the
|
|
2123
|
-
* specified accounts
|
|
2128
|
+
* specified Amazon Web Services accounts.</p>
|
|
2124
2129
|
*/
|
|
2125
2130
|
Regions: string[] | undefined;
|
|
2126
2131
|
|
|
@@ -2129,18 +2134,16 @@ export interface CreateStackInstancesInput {
|
|
|
2129
2134
|
* stack instances.</p>
|
|
2130
2135
|
* <p>Any overridden parameter values will be applied to all stack instances in the
|
|
2131
2136
|
* specified accounts and Regions. When specifying parameters and their values, be aware of
|
|
2132
|
-
* how CloudFormation sets parameter values during stack instance
|
|
2133
|
-
* operations:</p>
|
|
2137
|
+
* how CloudFormation sets parameter values during stack instance operations:</p>
|
|
2134
2138
|
* <ul>
|
|
2135
2139
|
* <li>
|
|
2136
2140
|
* <p>To override the current value for a parameter, include the parameter and
|
|
2137
2141
|
* specify its value.</p>
|
|
2138
2142
|
* </li>
|
|
2139
2143
|
* <li>
|
|
2140
|
-
* <p>To leave an overridden parameter set to its present value, include the
|
|
2141
|
-
*
|
|
2142
|
-
*
|
|
2143
|
-
* <code>true</code>.)</p>
|
|
2144
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as
|
|
2145
|
+
* <code>true</code>. (You cannot specify both a value and set
|
|
2146
|
+
* <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
2144
2147
|
* </li>
|
|
2145
2148
|
* <li>
|
|
2146
2149
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
@@ -2159,36 +2162,33 @@ export interface CreateStackInstancesInput {
|
|
|
2159
2162
|
ParameterOverrides?: Parameter[];
|
|
2160
2163
|
|
|
2161
2164
|
/**
|
|
2162
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
2163
|
-
* operation.</p>
|
|
2165
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
2164
2166
|
*/
|
|
2165
2167
|
OperationPreferences?: StackSetOperationPreferences;
|
|
2166
2168
|
|
|
2167
2169
|
/**
|
|
2168
|
-
* <p>The unique identifier for this stack set operation
|
|
2169
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
2170
|
-
*
|
|
2171
|
-
*
|
|
2172
|
-
*
|
|
2173
|
-
*
|
|
2170
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
2171
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
2172
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
2173
|
+
* multiple times. You might retry stack set operation requests to ensure that
|
|
2174
|
+
* CloudFormation successfully received them.</p>
|
|
2175
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2176
|
+
* automatically.</p>
|
|
2177
|
+
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
2178
|
+
* whose status is <code>OUTDATED</code>.</p>
|
|
2174
2179
|
*/
|
|
2175
2180
|
OperationId?: string;
|
|
2176
2181
|
|
|
2177
2182
|
/**
|
|
2178
|
-
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
2179
|
-
*
|
|
2180
|
-
* member account.</p>
|
|
2181
|
-
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2182
|
-
* self-managed permissions.</p>
|
|
2183
|
+
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p>
|
|
2184
|
+
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
|
|
2183
2185
|
* <ul>
|
|
2184
2186
|
* <li>
|
|
2185
2187
|
* <p>If you are signed in to the management account, specify <code>SELF</code>.</p>
|
|
2186
2188
|
* </li>
|
|
2187
2189
|
* <li>
|
|
2188
|
-
* <p>If you are signed in to a delegated administrator account, specify
|
|
2189
|
-
*
|
|
2190
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
2191
|
-
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2190
|
+
* <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
2191
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2192
2192
|
* </li>
|
|
2193
2193
|
* </ul>
|
|
2194
2194
|
*/
|
|
@@ -2376,7 +2376,7 @@ export interface CreateStackSetInput {
|
|
|
2376
2376
|
StackId?: string;
|
|
2377
2377
|
|
|
2378
2378
|
/**
|
|
2379
|
-
* <p>The input parameters for the stack set template
|
|
2379
|
+
* <p>The input parameters for the stack set template.</p>
|
|
2380
2380
|
*/
|
|
2381
2381
|
Parameters?: Parameter[];
|
|
2382
2382
|
|
|
@@ -2390,7 +2390,7 @@ export interface CreateStackSetInput {
|
|
|
2390
2390
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
2391
2391
|
* </p>
|
|
2392
2392
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
2393
|
-
* your account; for example, by creating new Identity and Access Management
|
|
2393
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
2394
2394
|
* (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying
|
|
2395
2395
|
* one of these capabilities.</p>
|
|
2396
2396
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -2398,11 +2398,11 @@ export interface CreateStackSetInput {
|
|
|
2398
2398
|
* capability.</p>
|
|
2399
2399
|
* <ul>
|
|
2400
2400
|
* <li>
|
|
2401
|
-
* <p>If you have IAM resources, you can specify either capability
|
|
2401
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
2402
2402
|
* </li>
|
|
2403
2403
|
* <li>
|
|
2404
2404
|
* <p>If you have IAM resources with custom names, you <i>must</i>
|
|
2405
|
-
* specify <code>CAPABILITY_NAMED_IAM</code
|
|
2405
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
2406
2406
|
* </li>
|
|
2407
2407
|
* <li>
|
|
2408
2408
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -2480,10 +2480,11 @@ export interface CreateStackSetInput {
|
|
|
2480
2480
|
|
|
2481
2481
|
/**
|
|
2482
2482
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
2483
|
-
*
|
|
2484
|
-
*
|
|
2485
|
-
* <p>If you specify tags as part of a <code>CreateStackSet</code> action,
|
|
2486
|
-
*
|
|
2483
|
+
* CloudFormation also propagates these tags to supported resources that are created in
|
|
2484
|
+
* the stacks. A maximum number of 50 tags can be specified.</p>
|
|
2485
|
+
* <p>If you specify tags as part of a <code>CreateStackSet</code> action,
|
|
2486
|
+
* CloudFormation checks to see if you have the required IAM permission to tag resources. If
|
|
2487
|
+
* you don't, the entire <code>CreateStackSet</code> action fails with an <code>access
|
|
2487
2488
|
* denied</code> error, and the stack set is not created.</p>
|
|
2488
2489
|
*/
|
|
2489
2490
|
Tags?: Tag[];
|
|
@@ -2549,7 +2550,7 @@ export interface CreateStackSetInput {
|
|
|
2549
2550
|
* <li>
|
|
2550
2551
|
* <p>To create a stack set with service-managed permissions while signed in to a
|
|
2551
2552
|
* delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
2552
|
-
* <p>Your account must be registered as a delegated admin in the
|
|
2553
|
+
* <p>Your Amazon Web Services account must be registered as a delegated admin in the
|
|
2553
2554
|
* management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2554
2555
|
* </li>
|
|
2555
2556
|
* </ul>
|
|
@@ -2560,12 +2561,11 @@ export interface CreateStackSetInput {
|
|
|
2560
2561
|
|
|
2561
2562
|
/**
|
|
2562
2563
|
* <p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token
|
|
2563
|
-
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
2564
|
-
*
|
|
2565
|
-
*
|
|
2566
|
-
*
|
|
2567
|
-
*
|
|
2568
|
-
* </p>
|
|
2564
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
2565
|
+
* to create another stack set with the same name. You might retry <code>CreateStackSet</code>
|
|
2566
|
+
* requests to ensure that CloudFormation successfully received them.</p>
|
|
2567
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2568
|
+
* automatically.</p>
|
|
2569
2569
|
*/
|
|
2570
2570
|
ClientRequestToken?: string;
|
|
2571
2571
|
}
|
|
@@ -2728,37 +2728,39 @@ export interface DeleteStackInput {
|
|
|
2728
2728
|
|
|
2729
2729
|
/**
|
|
2730
2730
|
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs
|
|
2731
|
-
* that are associated with the resources you want to retain. During deletion,
|
|
2731
|
+
* that are associated with the resources you want to retain. During deletion,
|
|
2732
|
+
* CloudFormation deletes the stack but does not delete the retained resources.</p>
|
|
2732
2733
|
* <p>Retaining resources is useful when you cannot delete a resource, such as a non-empty
|
|
2733
2734
|
* S3 bucket, but you want to delete the stack.</p>
|
|
2734
2735
|
*/
|
|
2735
2736
|
RetainResources?: string[];
|
|
2736
2737
|
|
|
2737
2738
|
/**
|
|
2738
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2739
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2740
|
+
* that CloudFormation assumes to delete the stack. CloudFormation uses the role's
|
|
2739
2741
|
* credentials to make calls on your behalf.</p>
|
|
2740
|
-
* <p>If you don't specify a value, CloudFormation uses the role that was
|
|
2741
|
-
*
|
|
2742
|
-
*
|
|
2742
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
2743
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
2744
|
+
* session that is generated from your user credentials.</p>
|
|
2743
2745
|
*/
|
|
2744
2746
|
RoleARN?: string;
|
|
2745
2747
|
|
|
2746
2748
|
/**
|
|
2747
2749
|
* <p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if
|
|
2748
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
2749
|
-
*
|
|
2750
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
2751
|
+
* delete a stack with the same name. You might retry <code>DeleteStack</code> requests to
|
|
2750
2752
|
* ensure that CloudFormation successfully received them.</p>
|
|
2751
2753
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
2752
2754
|
* token, which you can use to track operations. For example, if you execute a
|
|
2753
|
-
*
|
|
2754
|
-
*
|
|
2755
|
-
*
|
|
2755
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
2756
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
2757
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
2756
2758
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
2757
2759
|
* Stack operations that are initiated from the console use the token format
|
|
2758
2760
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
2759
2761
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
2760
2762
|
* would be assigned the same token in the following format:
|
|
2761
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
2763
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
2762
2764
|
*/
|
|
2763
2765
|
ClientRequestToken?: string;
|
|
2764
2766
|
}
|
|
@@ -2780,10 +2782,8 @@ export interface DeleteStackInstancesInput {
|
|
|
2780
2782
|
StackSetName: string | undefined;
|
|
2781
2783
|
|
|
2782
2784
|
/**
|
|
2783
|
-
* <p>[Self-managed permissions] The names of the accounts that you want
|
|
2784
|
-
*
|
|
2785
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
2786
|
-
* both.</p>
|
|
2785
|
+
* <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
|
|
2786
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
2787
2787
|
*/
|
|
2788
2788
|
Accounts?: string[];
|
|
2789
2789
|
|
|
@@ -2796,13 +2796,12 @@ export interface DeleteStackInstancesInput {
|
|
|
2796
2796
|
DeploymentTargets?: DeploymentTargets;
|
|
2797
2797
|
|
|
2798
2798
|
/**
|
|
2799
|
-
* <p>The Regions where you want to delete stack set instances
|
|
2799
|
+
* <p>The Regions where you want to delete stack set instances.</p>
|
|
2800
2800
|
*/
|
|
2801
2801
|
Regions: string[] | undefined;
|
|
2802
2802
|
|
|
2803
2803
|
/**
|
|
2804
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
2805
|
-
* operation.</p>
|
|
2804
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
2806
2805
|
*/
|
|
2807
2806
|
OperationPreferences?: StackSetOperationPreferences;
|
|
2808
2807
|
|
|
@@ -2815,12 +2814,15 @@ export interface DeleteStackInstancesInput {
|
|
|
2815
2814
|
RetainStacks: boolean | undefined;
|
|
2816
2815
|
|
|
2817
2816
|
/**
|
|
2818
|
-
* <p>The unique identifier for this stack set operation
|
|
2819
|
-
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2820
|
-
*
|
|
2821
|
-
*
|
|
2822
|
-
*
|
|
2823
|
-
*
|
|
2817
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
2818
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2819
|
+
* automatically.</p>
|
|
2820
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
2821
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
2822
|
+
* multiple times. You can retry stack set operation requests to ensure that
|
|
2823
|
+
* CloudFormation successfully received them.</p>
|
|
2824
|
+
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
2825
|
+
* whose status is <code>OUTDATED</code>.</p>
|
|
2824
2826
|
*/
|
|
2825
2827
|
OperationId?: string;
|
|
2826
2828
|
|
|
@@ -2837,7 +2839,7 @@ export interface DeleteStackInstancesInput {
|
|
|
2837
2839
|
* <li>
|
|
2838
2840
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
2839
2841
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
2840
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
2842
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
2841
2843
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2842
2844
|
* </li>
|
|
2843
2845
|
* </ul>
|
|
@@ -2890,7 +2892,7 @@ export interface DeleteStackSetInput {
|
|
|
2890
2892
|
* <li>
|
|
2891
2893
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
2892
2894
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
2893
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
2895
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
2894
2896
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2895
2897
|
* </li>
|
|
2896
2898
|
* </ul>
|
|
@@ -3014,8 +3016,8 @@ export namespace DescribeAccountLimitsInput {
|
|
|
3014
3016
|
*/
|
|
3015
3017
|
export interface DescribeAccountLimitsOutput {
|
|
3016
3018
|
/**
|
|
3017
|
-
* <p>An account limit structure that contain a list of CloudFormation account
|
|
3018
|
-
*
|
|
3019
|
+
* <p>An account limit structure that contain a list of CloudFormation account limits
|
|
3020
|
+
* and their values.</p>
|
|
3019
3021
|
*/
|
|
3020
3022
|
AccountLimits?: AccountLimit[];
|
|
3021
3023
|
|
|
@@ -3153,7 +3155,8 @@ export interface DescribeChangeSetOutput {
|
|
|
3153
3155
|
Tags?: Tag[];
|
|
3154
3156
|
|
|
3155
3157
|
/**
|
|
3156
|
-
* <p>A list of <code>Change</code> structures that describes the resources
|
|
3158
|
+
* <p>A list of <code>Change</code> structures that describes the resources
|
|
3159
|
+
* CloudFormation changes if you execute the change set.</p>
|
|
3157
3160
|
*/
|
|
3158
3161
|
Changes?: Change[];
|
|
3159
3162
|
|
|
@@ -3255,10 +3258,10 @@ export namespace DescribePublisherOutput {
|
|
|
3255
3258
|
|
|
3256
3259
|
export interface DescribeStackDriftDetectionStatusInput {
|
|
3257
3260
|
/**
|
|
3258
|
-
* <p>The ID of the drift detection results of this operation
|
|
3259
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
3260
|
-
*
|
|
3261
|
-
* long, may vary
|
|
3261
|
+
* <p>The ID of the drift detection results of this operation.</p>
|
|
3262
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
3263
|
+
* run. However, the number of drift results CloudFormation retains for any given stack, and for how
|
|
3264
|
+
* long, may vary.</p>
|
|
3262
3265
|
*/
|
|
3263
3266
|
StackDriftDetectionId: string | undefined;
|
|
3264
3267
|
}
|
|
@@ -3292,7 +3295,7 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3292
3295
|
StackId: string | undefined;
|
|
3293
3296
|
|
|
3294
3297
|
/**
|
|
3295
|
-
* <p>The ID of the drift detection results of this operation
|
|
3298
|
+
* <p>The ID of the drift detection results of this operation.</p>
|
|
3296
3299
|
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
3297
3300
|
* is run. However, the number of reports CloudFormation retains for any given stack, and for how long,
|
|
3298
3301
|
* may vary.</p>
|
|
@@ -3300,7 +3303,8 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3300
3303
|
StackDriftDetectionId: string | undefined;
|
|
3301
3304
|
|
|
3302
3305
|
/**
|
|
3303
|
-
* <p>Status of the stack's actual configuration compared to its expected
|
|
3306
|
+
* <p>Status of the stack's actual configuration compared to its expected
|
|
3307
|
+
* configuration.</p>
|
|
3304
3308
|
* <ul>
|
|
3305
3309
|
* <li>
|
|
3306
3310
|
* <p>
|
|
@@ -3429,9 +3433,15 @@ export enum ResourceStatus {
|
|
|
3429
3433
|
IMPORT_ROLLBACK_COMPLETE = "IMPORT_ROLLBACK_COMPLETE",
|
|
3430
3434
|
IMPORT_ROLLBACK_FAILED = "IMPORT_ROLLBACK_FAILED",
|
|
3431
3435
|
IMPORT_ROLLBACK_IN_PROGRESS = "IMPORT_ROLLBACK_IN_PROGRESS",
|
|
3436
|
+
ROLLBACK_COMPLETE = "ROLLBACK_COMPLETE",
|
|
3437
|
+
ROLLBACK_FAILED = "ROLLBACK_FAILED",
|
|
3438
|
+
ROLLBACK_IN_PROGRESS = "ROLLBACK_IN_PROGRESS",
|
|
3432
3439
|
UPDATE_COMPLETE = "UPDATE_COMPLETE",
|
|
3433
3440
|
UPDATE_FAILED = "UPDATE_FAILED",
|
|
3434
3441
|
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
|
|
3442
|
+
UPDATE_ROLLBACK_COMPLETE = "UPDATE_ROLLBACK_COMPLETE",
|
|
3443
|
+
UPDATE_ROLLBACK_FAILED = "UPDATE_ROLLBACK_FAILED",
|
|
3444
|
+
UPDATE_ROLLBACK_IN_PROGRESS = "UPDATE_ROLLBACK_IN_PROGRESS",
|
|
3435
3445
|
}
|
|
3436
3446
|
|
|
3437
3447
|
/**
|
|
@@ -3465,8 +3475,8 @@ export interface StackEvent {
|
|
|
3465
3475
|
PhysicalResourceId?: string;
|
|
3466
3476
|
|
|
3467
3477
|
/**
|
|
3468
|
-
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
3469
|
-
*
|
|
3478
|
+
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
3479
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
3470
3480
|
*/
|
|
3471
3481
|
ResourceType?: string;
|
|
3472
3482
|
|
|
@@ -3494,15 +3504,15 @@ export interface StackEvent {
|
|
|
3494
3504
|
* <p>The token passed to the operation that generated this event.</p>
|
|
3495
3505
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
3496
3506
|
* token, which you can use to track operations. For example, if you execute a
|
|
3497
|
-
*
|
|
3498
|
-
*
|
|
3499
|
-
*
|
|
3507
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
3508
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
3509
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
3500
3510
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
3501
3511
|
* Stack operations that are initiated from the console use the token format
|
|
3502
3512
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
3503
3513
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
3504
3514
|
* would be assigned the same token in the following format:
|
|
3505
|
-
*
|
|
3515
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>
|
|
3506
3516
|
*/
|
|
3507
3517
|
ClientRequestToken?: string;
|
|
3508
3518
|
}
|
|
@@ -3549,8 +3559,7 @@ export interface DescribeStackInstanceInput {
|
|
|
3549
3559
|
StackSetName: string | undefined;
|
|
3550
3560
|
|
|
3551
3561
|
/**
|
|
3552
|
-
* <p>The ID of an account that's associated with this stack
|
|
3553
|
-
* instance.</p>
|
|
3562
|
+
* <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
|
|
3554
3563
|
*/
|
|
3555
3564
|
StackInstanceAccount: string | undefined;
|
|
3556
3565
|
|
|
@@ -3572,7 +3581,7 @@ export interface DescribeStackInstanceInput {
|
|
|
3572
3581
|
* <li>
|
|
3573
3582
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
3574
3583
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
3575
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
3584
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
3576
3585
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
3577
3586
|
* </li>
|
|
3578
3587
|
* </ul>
|
|
@@ -3650,12 +3659,12 @@ export namespace StackInstanceComprehensiveStatus {
|
|
|
3650
3659
|
export type StackInstanceStatus = "CURRENT" | "INOPERABLE" | "OUTDATED";
|
|
3651
3660
|
|
|
3652
3661
|
/**
|
|
3653
|
-
* <p>An CloudFormation stack, in a specific account and Region, that's part of a
|
|
3654
|
-
*
|
|
3655
|
-
*
|
|
3656
|
-
*
|
|
3657
|
-
*
|
|
3658
|
-
*
|
|
3662
|
+
* <p>An CloudFormation stack, in a specific account and Region, that's part of a stack
|
|
3663
|
+
* set operation. A stack instance is a reference to an attempted or actual stack in a given
|
|
3664
|
+
* account within a given Region. A stack instance can exist without a stack—for example, if
|
|
3665
|
+
* the stack couldn't be created for some reason. A stack instance is associated with only one
|
|
3666
|
+
* stack set. Each stack instance contains the ID of its associated stack set, as well as the
|
|
3667
|
+
* ID of the actual stack and the stack status.</p>
|
|
3659
3668
|
*/
|
|
3660
3669
|
export interface StackInstance {
|
|
3661
3670
|
/**
|
|
@@ -3665,14 +3674,12 @@ export interface StackInstance {
|
|
|
3665
3674
|
StackSetId?: string;
|
|
3666
3675
|
|
|
3667
3676
|
/**
|
|
3668
|
-
* <p>The name of the Region that the stack instance is associated
|
|
3669
|
-
* with.</p>
|
|
3677
|
+
* <p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>
|
|
3670
3678
|
*/
|
|
3671
3679
|
Region?: string;
|
|
3672
3680
|
|
|
3673
3681
|
/**
|
|
3674
|
-
* <p>[Self-managed permissions] The name of the account that the stack
|
|
3675
|
-
* instance is associated with.</p>
|
|
3682
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>
|
|
3676
3683
|
*/
|
|
3677
3684
|
Account?: string;
|
|
3678
3685
|
|
|
@@ -3942,8 +3949,8 @@ export interface StackResourceDetail {
|
|
|
3942
3949
|
PhysicalResourceId?: string;
|
|
3943
3950
|
|
|
3944
3951
|
/**
|
|
3945
|
-
* <p>Type of resource. ((For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
3946
|
-
*
|
|
3952
|
+
* <p>Type of resource. ((For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
3953
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
3947
3954
|
*/
|
|
3948
3955
|
ResourceType: string | undefined;
|
|
3949
3956
|
|
|
@@ -4389,8 +4396,8 @@ export interface StackResource {
|
|
|
4389
4396
|
PhysicalResourceId?: string;
|
|
4390
4397
|
|
|
4391
4398
|
/**
|
|
4392
|
-
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
4393
|
-
*
|
|
4399
|
+
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
4400
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
4394
4401
|
*/
|
|
4395
4402
|
ResourceType: string | undefined;
|
|
4396
4403
|
|
|
@@ -4595,6 +4602,7 @@ export enum StackStatus {
|
|
|
4595
4602
|
ROLLBACK_IN_PROGRESS = "ROLLBACK_IN_PROGRESS",
|
|
4596
4603
|
UPDATE_COMPLETE = "UPDATE_COMPLETE",
|
|
4597
4604
|
UPDATE_COMPLETE_CLEANUP_IN_PROGRESS = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS",
|
|
4605
|
+
UPDATE_FAILED = "UPDATE_FAILED",
|
|
4598
4606
|
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
|
|
4599
4607
|
UPDATE_ROLLBACK_COMPLETE = "UPDATE_ROLLBACK_COMPLETE",
|
|
4600
4608
|
UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
|
|
@@ -4699,8 +4707,8 @@ export interface Stack {
|
|
|
4699
4707
|
Outputs?: Output[];
|
|
4700
4708
|
|
|
4701
4709
|
/**
|
|
4702
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4703
|
-
* associated with the stack. During a stack operation, CloudFormation uses this
|
|
4710
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4711
|
+
* that is associated with the stack. During a stack operation, CloudFormation uses this
|
|
4704
4712
|
* role's credentials to make calls on your behalf.</p>
|
|
4705
4713
|
*/
|
|
4706
4714
|
RoleARN?: string;
|
|
@@ -4798,7 +4806,7 @@ export interface DescribeStackSetInput {
|
|
|
4798
4806
|
* <li>
|
|
4799
4807
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
4800
4808
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
4801
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
4809
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
4802
4810
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4803
4811
|
* </li>
|
|
4804
4812
|
* </ul>
|
|
@@ -4962,9 +4970,9 @@ export type StackSetStatus = "ACTIVE" | "DELETED";
|
|
|
4962
4970
|
|
|
4963
4971
|
/**
|
|
4964
4972
|
* <p>A structure that contains information about a stack set. A stack set enables you to
|
|
4965
|
-
* provision stacks into accounts and across Regions by using a single
|
|
4966
|
-
*
|
|
4967
|
-
*
|
|
4973
|
+
* provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation
|
|
4974
|
+
* template. In the stack set, you specify the template to use, as well as any parameters and
|
|
4975
|
+
* capabilities that the template requires. </p>
|
|
4968
4976
|
*/
|
|
4969
4977
|
export interface StackSet {
|
|
4970
4978
|
/**
|
|
@@ -5001,9 +5009,8 @@ export interface StackSet {
|
|
|
5001
5009
|
|
|
5002
5010
|
/**
|
|
5003
5011
|
* <p>The capabilities that are allowed in the stack set. Some stack set templates might
|
|
5004
|
-
* include resources that can affect permissions in your account—for
|
|
5005
|
-
*
|
|
5006
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates.</a>
|
|
5012
|
+
* include resources that can affect permissions in your Amazon Web Services account—for example, by creating
|
|
5013
|
+
* new Identity and Access Management (IAM) users. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates.</a>
|
|
5007
5014
|
* </p>
|
|
5008
5015
|
*/
|
|
5009
5016
|
Capabilities?: (Capability | string)[];
|
|
@@ -5124,7 +5131,7 @@ export interface DescribeStackSetOperationInput {
|
|
|
5124
5131
|
* <li>
|
|
5125
5132
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
5126
5133
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
5127
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
5134
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
5128
5135
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5129
5136
|
* </li>
|
|
5130
5137
|
* </ul>
|
|
@@ -5178,8 +5185,8 @@ export interface StackSetOperation {
|
|
|
5178
5185
|
* Region during stack create and update operations. If the number of failed stacks
|
|
5179
5186
|
* within a Region exceeds the failure tolerance, the status of the operation in the
|
|
5180
5187
|
* Region is set to <code>FAILED</code>. This in turn sets the status of the operation
|
|
5181
|
-
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation
|
|
5182
|
-
*
|
|
5188
|
+
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in
|
|
5189
|
+
* any remaining Regions.</p>
|
|
5183
5190
|
* </li>
|
|
5184
5191
|
* <li>
|
|
5185
5192
|
* <p>
|
|
@@ -5243,9 +5250,9 @@ export interface StackSetOperation {
|
|
|
5243
5250
|
/**
|
|
5244
5251
|
* <p>The time at which the operation was initiated. Note that the creation times for the
|
|
5245
5252
|
* stack set operation might differ from the creation time of the individual stacks
|
|
5246
|
-
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
5247
|
-
*
|
|
5248
|
-
*
|
|
5253
|
+
* themselves. This is because CloudFormation needs to perform preparatory work for the
|
|
5254
|
+
* operation, such as dispatching the work to the requested Regions, before actually creating
|
|
5255
|
+
* the first stacks.</p>
|
|
5249
5256
|
*/
|
|
5250
5257
|
CreationTimestamp?: Date;
|
|
5251
5258
|
|
|
@@ -5791,7 +5798,7 @@ export namespace DescribeTypeRegistrationOutput {
|
|
|
5791
5798
|
|
|
5792
5799
|
export interface DetectStackDriftInput {
|
|
5793
5800
|
/**
|
|
5794
|
-
* <p>The name of the stack for which you want to detect drift
|
|
5801
|
+
* <p>The name of the stack for which you want to detect drift.</p>
|
|
5795
5802
|
*/
|
|
5796
5803
|
StackName: string | undefined;
|
|
5797
5804
|
|
|
@@ -5812,10 +5819,10 @@ export namespace DetectStackDriftInput {
|
|
|
5812
5819
|
|
|
5813
5820
|
export interface DetectStackDriftOutput {
|
|
5814
5821
|
/**
|
|
5815
|
-
* <p>The ID of the drift detection results of this operation
|
|
5816
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
5817
|
-
*
|
|
5818
|
-
* long, may vary
|
|
5822
|
+
* <p>The ID of the drift detection results of this operation.</p>
|
|
5823
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
5824
|
+
* run. However, the number of drift results CloudFormation retains for any given stack, and for how
|
|
5825
|
+
* long, may vary.</p>
|
|
5819
5826
|
*/
|
|
5820
5827
|
StackDriftDetectionId: string | undefined;
|
|
5821
5828
|
}
|
|
@@ -5901,7 +5908,7 @@ export interface DetectStackSetDriftInput {
|
|
|
5901
5908
|
* <li>
|
|
5902
5909
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
5903
5910
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
5904
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
5911
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
5905
5912
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5906
5913
|
* </li>
|
|
5907
5914
|
* </ul>
|
|
@@ -5952,8 +5959,8 @@ export interface EstimateTemplateCostInput {
|
|
|
5952
5959
|
|
|
5953
5960
|
/**
|
|
5954
5961
|
* <p>Location of file containing the template body. The URL must point to a template that
|
|
5955
|
-
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go
|
|
5956
|
-
*
|
|
5962
|
+
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to
|
|
5963
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
5957
5964
|
* in the CloudFormation User Guide.</p>
|
|
5958
5965
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
5959
5966
|
* both are passed, only <code>TemplateBody</code> is used.</p>
|
|
@@ -5980,8 +5987,8 @@ export namespace EstimateTemplateCostInput {
|
|
|
5980
5987
|
*/
|
|
5981
5988
|
export interface EstimateTemplateCostOutput {
|
|
5982
5989
|
/**
|
|
5983
|
-
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that
|
|
5984
|
-
*
|
|
5990
|
+
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources
|
|
5991
|
+
* required to run the template.</p>
|
|
5985
5992
|
*/
|
|
5986
5993
|
Url?: string;
|
|
5987
5994
|
}
|
|
@@ -6015,10 +6022,17 @@ export interface ExecuteChangeSetInput {
|
|
|
6015
6022
|
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this
|
|
6016
6023
|
* token if you plan to retry requests so that CloudFormation knows that you're not
|
|
6017
6024
|
* attempting to execute a change set to update a stack with the same name. You might retry
|
|
6018
|
-
*
|
|
6019
|
-
*
|
|
6025
|
+
* <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully
|
|
6026
|
+
* received them.</p>
|
|
6020
6027
|
*/
|
|
6021
6028
|
ClientRequestToken?: string;
|
|
6029
|
+
|
|
6030
|
+
/**
|
|
6031
|
+
* <p>Preserves the state of previously provisioned resources when an operation fails.</p>
|
|
6032
|
+
* <p>Default: <code>True</code>
|
|
6033
|
+
* </p>
|
|
6034
|
+
*/
|
|
6035
|
+
DisableRollback?: boolean;
|
|
6022
6036
|
}
|
|
6023
6037
|
|
|
6024
6038
|
export namespace ExecuteChangeSetInput {
|
|
@@ -6110,7 +6124,8 @@ export interface GetTemplateInput {
|
|
|
6110
6124
|
StackName?: string;
|
|
6111
6125
|
|
|
6112
6126
|
/**
|
|
6113
|
-
* <p>The name or Amazon Resource Name (ARN) of a change set for which CloudFormation
|
|
6127
|
+
* <p>The name or Amazon Resource Name (ARN) of a change set for which CloudFormation
|
|
6128
|
+
* returns the associated template. If you specify a name, you must also specify the
|
|
6114
6129
|
* <code>StackName</code>.</p>
|
|
6115
6130
|
*/
|
|
6116
6131
|
ChangeSetName?: string;
|
|
@@ -6118,7 +6133,7 @@ export interface GetTemplateInput {
|
|
|
6118
6133
|
/**
|
|
6119
6134
|
* <p>For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify
|
|
6120
6135
|
* <code>Original</code>. To get the template after CloudFormation has processed
|
|
6121
|
-
* all transforms, specify <code>Processed</code
|
|
6136
|
+
* all transforms, specify <code>Processed</code>.</p>
|
|
6122
6137
|
* <p>If the template doesn't include transforms, <code>Original</code> and
|
|
6123
6138
|
* <code>Processed</code> return the same template. By default, CloudFormation
|
|
6124
6139
|
* specifies <code>Processed</code>.</p>
|
|
@@ -6149,7 +6164,8 @@ export interface GetTemplateOutput {
|
|
|
6149
6164
|
/**
|
|
6150
6165
|
* <p>The stage of the template that you can retrieve. For stacks, the
|
|
6151
6166
|
* <code>Original</code> and <code>Processed</code> templates are always available. For
|
|
6152
|
-
* change sets, the <code>Original</code> template is always available. After
|
|
6167
|
+
* change sets, the <code>Original</code> template is always available. After
|
|
6168
|
+
* CloudFormation finishes creating the change set, the <code>Processed</code> template
|
|
6153
6169
|
* becomes available.</p>
|
|
6154
6170
|
*/
|
|
6155
6171
|
StagesAvailable?: (TemplateStage | string)[];
|
|
@@ -6219,7 +6235,7 @@ export interface GetTemplateSummaryInput {
|
|
|
6219
6235
|
* <li>
|
|
6220
6236
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
6221
6237
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
6222
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
6238
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
6223
6239
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6224
6240
|
* </li>
|
|
6225
6241
|
* </ul>
|
|
@@ -6237,9 +6253,9 @@ export namespace GetTemplateSummaryInput {
|
|
|
6237
6253
|
}
|
|
6238
6254
|
|
|
6239
6255
|
/**
|
|
6240
|
-
* <p>A set of criteria that CloudFormation uses to validate parameter values.
|
|
6241
|
-
*
|
|
6242
|
-
*
|
|
6256
|
+
* <p>A set of criteria that CloudFormation uses to validate parameter values. Although
|
|
6257
|
+
* other constraints might be defined in the stack template, CloudFormation returns only
|
|
6258
|
+
* the <code>AllowedValues</code> property.</p>
|
|
6243
6259
|
*/
|
|
6244
6260
|
export interface ParameterConstraints {
|
|
6245
6261
|
/**
|
|
@@ -6278,7 +6294,7 @@ export interface ParameterDeclaration {
|
|
|
6278
6294
|
|
|
6279
6295
|
/**
|
|
6280
6296
|
* <p>Flag that indicates whether the parameter value is shown as plain text in logs and in
|
|
6281
|
-
* the Management Console.</p>
|
|
6297
|
+
* the Amazon Web Services Management Console.</p>
|
|
6282
6298
|
*/
|
|
6283
6299
|
NoEcho?: boolean;
|
|
6284
6300
|
|
|
@@ -6355,9 +6371,9 @@ export interface GetTemplateSummaryOutput {
|
|
|
6355
6371
|
|
|
6356
6372
|
/**
|
|
6357
6373
|
* <p>The capabilities found within the template. If your template contains IAM resources,
|
|
6358
|
-
* you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when
|
|
6374
|
+
* you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when
|
|
6359
6375
|
* you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with
|
|
6360
|
-
* your template; otherwise, those actions return an InsufficientCapabilities error.</p>
|
|
6376
|
+
* your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p>
|
|
6361
6377
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates</a>.</p>
|
|
6362
6378
|
*/
|
|
6363
6379
|
Capabilities?: (Capability | string)[];
|
|
@@ -6376,8 +6392,8 @@ export interface GetTemplateSummaryOutput {
|
|
|
6376
6392
|
ResourceTypes?: string[];
|
|
6377
6393
|
|
|
6378
6394
|
/**
|
|
6379
|
-
* <p>The Amazon Web Services template format version, which identifies the capabilities of
|
|
6380
|
-
*
|
|
6395
|
+
* <p>The Amazon Web Services template format version, which identifies the capabilities of the
|
|
6396
|
+
* template.</p>
|
|
6381
6397
|
*/
|
|
6382
6398
|
Version?: string;
|
|
6383
6399
|
|
|
@@ -6396,7 +6412,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
6396
6412
|
* <p>A list of resource identifier summaries that describe the target resources of an import
|
|
6397
6413
|
* operation and the properties you can provide during the import to identify the target
|
|
6398
6414
|
* resources. For example, <code>BucketName</code> is a possible identifier property for an
|
|
6399
|
-
* <code>AWS::S3::Bucket</code> resource
|
|
6415
|
+
* <code>AWS::S3::Bucket</code> resource.</p>
|
|
6400
6416
|
*/
|
|
6401
6417
|
ResourceIdentifierSummaries?: ResourceIdentifierSummary[];
|
|
6402
6418
|
}
|
|
@@ -6623,14 +6639,13 @@ export namespace ListExportsOutput {
|
|
|
6623
6639
|
export interface ListImportsInput {
|
|
6624
6640
|
/**
|
|
6625
6641
|
* <p>The name of the exported output value. CloudFormation returns the stack names
|
|
6626
|
-
* that are importing this value
|
|
6642
|
+
* that are importing this value.</p>
|
|
6627
6643
|
*/
|
|
6628
6644
|
ExportName: string | undefined;
|
|
6629
6645
|
|
|
6630
6646
|
/**
|
|
6631
|
-
* <p>A string (provided by the <a>ListImports</a> response output) that
|
|
6632
|
-
*
|
|
6633
|
-
* </p>
|
|
6647
|
+
* <p>A string (provided by the <a>ListImports</a> response output) that identifies
|
|
6648
|
+
* the next page of stacks that are importing the specified exported output value.</p>
|
|
6634
6649
|
*/
|
|
6635
6650
|
NextToken?: string;
|
|
6636
6651
|
}
|
|
@@ -6646,8 +6661,7 @@ export namespace ListImportsInput {
|
|
|
6646
6661
|
|
|
6647
6662
|
export interface ListImportsOutput {
|
|
6648
6663
|
/**
|
|
6649
|
-
* <p>A list of stack names that are importing the specified exported output value
|
|
6650
|
-
* </p>
|
|
6664
|
+
* <p>A list of stack names that are importing the specified exported output value.</p>
|
|
6651
6665
|
*/
|
|
6652
6666
|
Imports?: string[];
|
|
6653
6667
|
|
|
@@ -6723,8 +6737,7 @@ export interface ListStackInstancesInput {
|
|
|
6723
6737
|
Filters?: StackInstanceFilter[];
|
|
6724
6738
|
|
|
6725
6739
|
/**
|
|
6726
|
-
* <p>The name of the account that you want to list stack instances
|
|
6727
|
-
* for.</p>
|
|
6740
|
+
* <p>The name of the Amazon Web Services account that you want to list stack instances for.</p>
|
|
6728
6741
|
*/
|
|
6729
6742
|
StackInstanceAccount?: string;
|
|
6730
6743
|
|
|
@@ -6746,7 +6759,7 @@ export interface ListStackInstancesInput {
|
|
|
6746
6759
|
* <li>
|
|
6747
6760
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
6748
6761
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
6749
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
6762
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
6750
6763
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6751
6764
|
* </li>
|
|
6752
6765
|
* </ul>
|
|
@@ -6774,14 +6787,12 @@ export interface StackInstanceSummary {
|
|
|
6774
6787
|
StackSetId?: string;
|
|
6775
6788
|
|
|
6776
6789
|
/**
|
|
6777
|
-
* <p>The name of the Region that the stack instance is associated
|
|
6778
|
-
* with.</p>
|
|
6790
|
+
* <p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>
|
|
6779
6791
|
*/
|
|
6780
6792
|
Region?: string;
|
|
6781
6793
|
|
|
6782
6794
|
/**
|
|
6783
|
-
* <p>[Self-managed permissions] The name of the account that the stack
|
|
6784
|
-
* instance is associated with.</p>
|
|
6795
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>
|
|
6785
6796
|
*/
|
|
6786
6797
|
Account?: string;
|
|
6787
6798
|
|
|
@@ -7022,8 +7033,8 @@ export interface StackResourceSummary {
|
|
|
7022
7033
|
PhysicalResourceId?: string;
|
|
7023
7034
|
|
|
7024
7035
|
/**
|
|
7025
|
-
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
7026
|
-
*
|
|
7036
|
+
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
|
|
7037
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
7027
7038
|
*/
|
|
7028
7039
|
ResourceType: string | undefined;
|
|
7029
7040
|
|
|
@@ -7317,7 +7328,7 @@ export interface ListStackSetOperationResultsInput {
|
|
|
7317
7328
|
* <li>
|
|
7318
7329
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
7319
7330
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
7320
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
7331
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
7321
7332
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7322
7333
|
* </li>
|
|
7323
7334
|
* </ul>
|
|
@@ -7342,13 +7353,12 @@ export type StackSetOperationResultStatus = "CANCELLED" | "FAILED" | "PENDING" |
|
|
|
7342
7353
|
*/
|
|
7343
7354
|
export interface StackSetOperationResultSummary {
|
|
7344
7355
|
/**
|
|
7345
|
-
* <p>[Self-managed permissions] The name of the account for this
|
|
7346
|
-
* operation result.</p>
|
|
7356
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account for this operation result.</p>
|
|
7347
7357
|
*/
|
|
7348
7358
|
Account?: string;
|
|
7349
7359
|
|
|
7350
7360
|
/**
|
|
7351
|
-
* <p>The name of the Region for this operation result.</p>
|
|
7361
|
+
* <p>The name of the Amazon Web Services Region for this operation result.</p>
|
|
7352
7362
|
*/
|
|
7353
7363
|
Region?: string;
|
|
7354
7364
|
|
|
@@ -7479,7 +7489,7 @@ export interface ListStackSetOperationsInput {
|
|
|
7479
7489
|
* <li>
|
|
7480
7490
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
7481
7491
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
7482
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
7492
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
7483
7493
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7484
7494
|
* </li>
|
|
7485
7495
|
* </ul>
|
|
@@ -7525,8 +7535,8 @@ export interface StackSetOperationSummary {
|
|
|
7525
7535
|
* Region during stack create and update operations. If the number of failed stacks
|
|
7526
7536
|
* within a Region exceeds the failure tolerance, the status of the operation in the
|
|
7527
7537
|
* Region is set to <code>FAILED</code>. This in turn sets the status of the operation
|
|
7528
|
-
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation
|
|
7529
|
-
*
|
|
7538
|
+
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in
|
|
7539
|
+
* any remaining Regions.</p>
|
|
7530
7540
|
* </li>
|
|
7531
7541
|
* <li>
|
|
7532
7542
|
* <p>
|
|
@@ -7560,9 +7570,9 @@ export interface StackSetOperationSummary {
|
|
|
7560
7570
|
/**
|
|
7561
7571
|
* <p>The time at which the operation was initiated. Note that the creation times for the
|
|
7562
7572
|
* stack set operation might differ from the creation time of the individual stacks
|
|
7563
|
-
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
7564
|
-
*
|
|
7565
|
-
*
|
|
7573
|
+
* themselves. This is because CloudFormation needs to perform preparatory work for the
|
|
7574
|
+
* operation, such as dispatching the work to the requested Regions, before actually creating
|
|
7575
|
+
* the first stacks.</p>
|
|
7566
7576
|
*/
|
|
7567
7577
|
CreationTimestamp?: Date;
|
|
7568
7578
|
|
|
@@ -7646,7 +7656,7 @@ export interface ListStackSetsInput {
|
|
|
7646
7656
|
* <li>
|
|
7647
7657
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
7648
7658
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
7649
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
7659
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
7650
7660
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7651
7661
|
* </li>
|
|
7652
7662
|
* </ul>
|
|
@@ -8730,6 +8740,48 @@ export namespace RegisterTypeOutput {
|
|
|
8730
8740
|
});
|
|
8731
8741
|
}
|
|
8732
8742
|
|
|
8743
|
+
export interface RollbackStackInput {
|
|
8744
|
+
/**
|
|
8745
|
+
* <p>The name that is associated with the stack.</p>
|
|
8746
|
+
*/
|
|
8747
|
+
StackName: string | undefined;
|
|
8748
|
+
|
|
8749
|
+
/**
|
|
8750
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.</p>
|
|
8751
|
+
*/
|
|
8752
|
+
RoleARN?: string;
|
|
8753
|
+
|
|
8754
|
+
/**
|
|
8755
|
+
* <p>A unique identifier for this <code>RollbackStack</code> request.</p>
|
|
8756
|
+
*/
|
|
8757
|
+
ClientRequestToken?: string;
|
|
8758
|
+
}
|
|
8759
|
+
|
|
8760
|
+
export namespace RollbackStackInput {
|
|
8761
|
+
/**
|
|
8762
|
+
* @internal
|
|
8763
|
+
*/
|
|
8764
|
+
export const filterSensitiveLog = (obj: RollbackStackInput): any => ({
|
|
8765
|
+
...obj,
|
|
8766
|
+
});
|
|
8767
|
+
}
|
|
8768
|
+
|
|
8769
|
+
export interface RollbackStackOutput {
|
|
8770
|
+
/**
|
|
8771
|
+
* <p>Unique identifier of the stack.</p>
|
|
8772
|
+
*/
|
|
8773
|
+
StackId?: string;
|
|
8774
|
+
}
|
|
8775
|
+
|
|
8776
|
+
export namespace RollbackStackOutput {
|
|
8777
|
+
/**
|
|
8778
|
+
* @internal
|
|
8779
|
+
*/
|
|
8780
|
+
export const filterSensitiveLog = (obj: RollbackStackOutput): any => ({
|
|
8781
|
+
...obj,
|
|
8782
|
+
});
|
|
8783
|
+
}
|
|
8784
|
+
|
|
8733
8785
|
/**
|
|
8734
8786
|
* <p>The input for the <a>SetStackPolicy</a> action.</p>
|
|
8735
8787
|
*/
|
|
@@ -8741,17 +8793,17 @@ export interface SetStackPolicyInput {
|
|
|
8741
8793
|
|
|
8742
8794
|
/**
|
|
8743
8795
|
* <p>Structure containing the stack policy body. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates
|
|
8744
|
-
* to Stack Resources</a> in the CloudFormation User Guide. You can specify
|
|
8745
|
-
*
|
|
8746
|
-
*
|
|
8796
|
+
* to Stack Resources</a> in the CloudFormation User Guide. You can specify either
|
|
8797
|
+
* the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
8798
|
+
* both.</p>
|
|
8747
8799
|
*/
|
|
8748
8800
|
StackPolicyBody?: string;
|
|
8749
8801
|
|
|
8750
8802
|
/**
|
|
8751
8803
|
* <p>Location of a file containing the stack policy. The URL must point to a policy
|
|
8752
|
-
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
8753
|
-
* specify either the <code>StackPolicyBody</code> or the
|
|
8754
|
-
*
|
|
8804
|
+
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
8805
|
+
* Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
8806
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
8755
8807
|
*/
|
|
8756
8808
|
StackPolicyURL?: string;
|
|
8757
8809
|
}
|
|
@@ -8915,7 +8967,7 @@ export interface SignalResourceInput {
|
|
|
8915
8967
|
|
|
8916
8968
|
/**
|
|
8917
8969
|
* <p>The status of the signal, which is either success or failure. A failure signal causes
|
|
8918
|
-
*
|
|
8970
|
+
* CloudFormation to immediately fail the stack creation or update.</p>
|
|
8919
8971
|
*/
|
|
8920
8972
|
Status: ResourceSignalStatus | string | undefined;
|
|
8921
8973
|
}
|
|
@@ -8954,7 +9006,7 @@ export interface StopStackSetOperationInput {
|
|
|
8954
9006
|
* <li>
|
|
8955
9007
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
8956
9008
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
8957
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
9009
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
8958
9010
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
8959
9011
|
* </li>
|
|
8960
9012
|
* </ul>
|
|
@@ -9081,8 +9133,8 @@ export interface UpdateStackInput {
|
|
|
9081
9133
|
|
|
9082
9134
|
/**
|
|
9083
9135
|
* <p>Location of file containing the template body. The URL must point to a template that
|
|
9084
|
-
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go
|
|
9085
|
-
*
|
|
9136
|
+
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to
|
|
9137
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
9086
9138
|
* in the CloudFormation User Guide.</p>
|
|
9087
9139
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
9088
9140
|
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
|
@@ -9111,9 +9163,10 @@ export interface UpdateStackInput {
|
|
|
9111
9163
|
|
|
9112
9164
|
/**
|
|
9113
9165
|
* <p>Location of a file containing the temporary overriding stack policy. The URL must
|
|
9114
|
-
* point to a policy (max size: 16KB) located in an S3 bucket in
|
|
9115
|
-
* You can specify either the
|
|
9116
|
-
* <code>
|
|
9166
|
+
* point to a policy (max size: 16KB) located in an S3 bucket in
|
|
9167
|
+
* the same Region as the stack. You can specify either the
|
|
9168
|
+
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code>
|
|
9169
|
+
* parameter, but not both.</p>
|
|
9117
9170
|
* <p>If you want to update protected resources, specify a temporary overriding stack
|
|
9118
9171
|
* policy during this update. If you do not specify a stack policy, the current policy that is
|
|
9119
9172
|
* associated with the stack will be used.</p>
|
|
@@ -9136,7 +9189,7 @@ export interface UpdateStackInput {
|
|
|
9136
9189
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
9137
9190
|
* </p>
|
|
9138
9191
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
9139
|
-
* your account; for example, by creating new Identity and Access Management
|
|
9192
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
9140
9193
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
9141
9194
|
* of these capabilities.</p>
|
|
9142
9195
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -9144,11 +9197,11 @@ export interface UpdateStackInput {
|
|
|
9144
9197
|
* capability.</p>
|
|
9145
9198
|
* <ul>
|
|
9146
9199
|
* <li>
|
|
9147
|
-
* <p>If you have IAM resources, you can specify either capability
|
|
9200
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
9148
9201
|
* </li>
|
|
9149
9202
|
* <li>
|
|
9150
9203
|
* <p>If you have IAM resources with custom names, you <i>must</i>
|
|
9151
|
-
* specify <code>CAPABILITY_NAMED_IAM</code
|
|
9204
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
9152
9205
|
* </li>
|
|
9153
9206
|
* <li>
|
|
9154
9207
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -9239,21 +9292,20 @@ export interface UpdateStackInput {
|
|
|
9239
9292
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
9240
9293
|
* <p>If the list of resource types doesn't include a resource that you're updating, the
|
|
9241
9294
|
* stack update fails. By default, CloudFormation grants permissions to all resource
|
|
9242
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
9243
|
-
* condition keys in IAM policies. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
9244
|
-
* Identity and Access Management</a>.</p>
|
|
9295
|
+
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with Identity and Access Management</a>.</p>
|
|
9245
9296
|
*/
|
|
9246
9297
|
ResourceTypes?: string[];
|
|
9247
9298
|
|
|
9248
9299
|
/**
|
|
9249
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
9250
|
-
*
|
|
9251
|
-
*
|
|
9252
|
-
*
|
|
9253
|
-
*
|
|
9254
|
-
*
|
|
9255
|
-
*
|
|
9256
|
-
*
|
|
9300
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
9301
|
+
* that CloudFormation assumes to update the stack. CloudFormation uses the role's
|
|
9302
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for all
|
|
9303
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
9304
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
9305
|
+
* Ensure that the role grants least privilege.</p>
|
|
9306
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
9307
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
9308
|
+
* session that is generated from your user credentials.</p>
|
|
9257
9309
|
*/
|
|
9258
9310
|
RoleARN?: string;
|
|
9259
9311
|
|
|
@@ -9275,9 +9327,9 @@ export interface UpdateStackInput {
|
|
|
9275
9327
|
|
|
9276
9328
|
/**
|
|
9277
9329
|
* <p>Location of a file containing the updated stack policy. The URL must point to a
|
|
9278
|
-
* policy (max size: 16KB) located in an S3 bucket in the same
|
|
9279
|
-
* specify either the <code>StackPolicyBody</code> or the
|
|
9280
|
-
*
|
|
9330
|
+
* policy (max size: 16KB) located in an S3 bucket in the same
|
|
9331
|
+
* Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
9332
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
9281
9333
|
* <p>You might update the stack policy, for example, in order to protect a new resource
|
|
9282
9334
|
* that you created during a stack update. If you do not specify a stack policy, the current
|
|
9283
9335
|
* policy that is associated with the stack is unchanged.</p>
|
|
@@ -9285,8 +9337,9 @@ export interface UpdateStackInput {
|
|
|
9285
9337
|
StackPolicyURL?: string;
|
|
9286
9338
|
|
|
9287
9339
|
/**
|
|
9288
|
-
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
|
|
9289
|
-
* notification
|
|
9340
|
+
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
|
|
9341
|
+
* CloudFormation associates with the stack. Specify an empty list to remove all notification
|
|
9342
|
+
* topics.</p>
|
|
9290
9343
|
*/
|
|
9291
9344
|
NotificationARNs?: string[];
|
|
9292
9345
|
|
|
@@ -9294,28 +9347,35 @@ export interface UpdateStackInput {
|
|
|
9294
9347
|
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates
|
|
9295
9348
|
* these tags to supported resources in the stack. You can specify a maximum number of 50
|
|
9296
9349
|
* tags.</p>
|
|
9297
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the
|
|
9298
|
-
*
|
|
9350
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
|
9351
|
+
* tags. If you specify an empty value, CloudFormation removes all associated
|
|
9299
9352
|
* tags.</p>
|
|
9300
9353
|
*/
|
|
9301
9354
|
Tags?: Tag[];
|
|
9302
9355
|
|
|
9356
|
+
/**
|
|
9357
|
+
* <p>Preserve the state of previously provisioned resources when an operation fails.</p>
|
|
9358
|
+
* <p>Default: <code>False</code>
|
|
9359
|
+
* </p>
|
|
9360
|
+
*/
|
|
9361
|
+
DisableRollback?: boolean;
|
|
9362
|
+
|
|
9303
9363
|
/**
|
|
9304
9364
|
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if
|
|
9305
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
9306
|
-
*
|
|
9365
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
9366
|
+
* update a stack with the same name. You might retry <code>UpdateStack</code> requests to
|
|
9307
9367
|
* ensure that CloudFormation successfully received them.</p>
|
|
9308
9368
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
9309
9369
|
* token, which you can use to track operations. For example, if you execute a
|
|
9310
|
-
*
|
|
9311
|
-
*
|
|
9312
|
-
*
|
|
9370
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
9371
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
9372
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
9313
9373
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
9314
9374
|
* Stack operations that are initiated from the console use the token format
|
|
9315
9375
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
9316
9376
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
9317
9377
|
* would be assigned the same token in the following format:
|
|
9318
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
9378
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
9319
9379
|
*/
|
|
9320
9380
|
ClientRequestToken?: string;
|
|
9321
9381
|
}
|
|
@@ -9355,12 +9415,10 @@ export interface UpdateStackInstancesInput {
|
|
|
9355
9415
|
StackSetName: string | undefined;
|
|
9356
9416
|
|
|
9357
9417
|
/**
|
|
9358
|
-
* <p>[Self-managed permissions] The names of one or more accounts for
|
|
9359
|
-
*
|
|
9360
|
-
*
|
|
9361
|
-
*
|
|
9362
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
9363
|
-
* both.</p>
|
|
9418
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values
|
|
9419
|
+
* for stack instances. The overridden parameter values will be applied to all stack instances
|
|
9420
|
+
* in the specified accounts and Regions.</p>
|
|
9421
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
9364
9422
|
*/
|
|
9365
9423
|
Accounts?: string[];
|
|
9366
9424
|
|
|
@@ -9395,10 +9453,9 @@ export interface UpdateStackInstancesInput {
|
|
|
9395
9453
|
* specify its value.</p>
|
|
9396
9454
|
* </li>
|
|
9397
9455
|
* <li>
|
|
9398
|
-
* <p>To leave an overridden parameter set to its present value, include the
|
|
9399
|
-
*
|
|
9400
|
-
*
|
|
9401
|
-
* <code>true</code>.)</p>
|
|
9456
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as
|
|
9457
|
+
* <code>true</code>. (You cannot specify both a value and set
|
|
9458
|
+
* <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
9402
9459
|
* </li>
|
|
9403
9460
|
* <li>
|
|
9404
9461
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
@@ -9422,15 +9479,16 @@ export interface UpdateStackInstancesInput {
|
|
|
9422
9479
|
ParameterOverrides?: Parameter[];
|
|
9423
9480
|
|
|
9424
9481
|
/**
|
|
9425
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
9426
|
-
* operation.</p>
|
|
9482
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
9427
9483
|
*/
|
|
9428
9484
|
OperationPreferences?: StackSetOperationPreferences;
|
|
9429
9485
|
|
|
9430
9486
|
/**
|
|
9431
9487
|
* <p>The unique identifier for this stack set operation. </p>
|
|
9432
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
9433
|
-
*
|
|
9488
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
9489
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
9490
|
+
* multiple times. You might retry stack set operation requests to ensure that
|
|
9491
|
+
* CloudFormation successfully received them.</p>
|
|
9434
9492
|
* <p>If you don't specify an operation ID, the SDK generates one automatically.
|
|
9435
9493
|
* </p>
|
|
9436
9494
|
*/
|
|
@@ -9449,7 +9507,7 @@ export interface UpdateStackInstancesInput {
|
|
|
9449
9507
|
* <li>
|
|
9450
9508
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
9451
9509
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
9452
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
9510
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
9453
9511
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
9454
9512
|
* </li>
|
|
9455
9513
|
* </ul>
|
|
@@ -9538,7 +9596,7 @@ export interface UpdateStackSetInput {
|
|
|
9538
9596
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
9539
9597
|
* </p>
|
|
9540
9598
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
9541
|
-
* your account; for example, by creating new Identity and Access Management
|
|
9599
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
9542
9600
|
* (IAM) users. For those stacks sets, you must explicitly acknowledge this by
|
|
9543
9601
|
* specifying one of these capabilities.</p>
|
|
9544
9602
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -9628,8 +9686,8 @@ export interface UpdateStackSetInput {
|
|
|
9628
9686
|
|
|
9629
9687
|
/**
|
|
9630
9688
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
9631
|
-
*
|
|
9632
|
-
*
|
|
9689
|
+
* CloudFormation also propagates these tags to supported resources that are created in
|
|
9690
|
+
* the stacks. You can specify a maximum number of 50 tags.</p>
|
|
9633
9691
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are
|
|
9634
9692
|
* currently associated with this stack set. This means:</p>
|
|
9635
9693
|
* <ul>
|
|
@@ -9650,18 +9708,18 @@ export interface UpdateStackSetInput {
|
|
|
9650
9708
|
* associated tags.</p>
|
|
9651
9709
|
* </li>
|
|
9652
9710
|
* </ul>
|
|
9653
|
-
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action,
|
|
9654
|
-
*
|
|
9655
|
-
*
|
|
9656
|
-
*
|
|
9711
|
+
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action,
|
|
9712
|
+
* CloudFormation checks to see if you have the required IAM permission to tag resources. If
|
|
9713
|
+
* you omit tags that are currently associated with the stack set from the list of tags you
|
|
9714
|
+
* specify, CloudFormation assumes that you want to remove those tags from the stack set,
|
|
9715
|
+
* and checks to see if you have permission to untag resources. If you don't have the
|
|
9657
9716
|
* necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an
|
|
9658
9717
|
* <code>access denied</code> error, and the stack set is not updated.</p>
|
|
9659
9718
|
*/
|
|
9660
9719
|
Tags?: Tag[];
|
|
9661
9720
|
|
|
9662
9721
|
/**
|
|
9663
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
9664
|
-
* operation.</p>
|
|
9722
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
9665
9723
|
*/
|
|
9666
9724
|
OperationPreferences?: StackSetOperationPreferences;
|
|
9667
9725
|
|
|
@@ -9738,8 +9796,10 @@ export interface UpdateStackSetInput {
|
|
|
9738
9796
|
|
|
9739
9797
|
/**
|
|
9740
9798
|
* <p>The unique ID for this stack set operation. </p>
|
|
9741
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
9742
|
-
*
|
|
9799
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
9800
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
9801
|
+
* multiple times. You might retry stack set operation requests to ensure that
|
|
9802
|
+
* CloudFormation successfully received them.</p>
|
|
9743
9803
|
* <p>If you don't specify an operation ID, CloudFormation generates one
|
|
9744
9804
|
* automatically.</p>
|
|
9745
9805
|
* <p>Repeating this stack set operation with a new operation ID retries all stack
|
|
@@ -9791,7 +9851,7 @@ export interface UpdateStackSetInput {
|
|
|
9791
9851
|
* <li>
|
|
9792
9852
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
9793
9853
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
9794
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
9854
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
9795
9855
|
* the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
9796
9856
|
* </li>
|
|
9797
9857
|
* </ul>
|