@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
|
@@ -3,13 +3,13 @@ export declare type AccountGateStatus = "FAILED" | "SKIPPED" | "SUCCEEDED";
|
|
|
3
3
|
/**
|
|
4
4
|
* <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
|
|
5
5
|
* account and Region.</p>
|
|
6
|
-
* <p>For each account and Region, CloudFormation lets you specify a
|
|
6
|
+
* <p>For each account and Region, CloudFormation lets you specify a Lambda
|
|
7
7
|
* function that encapsulates any requirements that must be met before CloudFormation
|
|
8
8
|
* can proceed with a stack set operation in that account and Region. CloudFormation
|
|
9
9
|
* invokes the function each time a stack set operation is requested for that account and
|
|
10
10
|
* Region; if the function returns <code>FAILED</code>, CloudFormation cancels the
|
|
11
11
|
* operation in that account and Region, and sets the stack set operation result status for
|
|
12
|
-
* that account and Region to <code>FAILED</code
|
|
12
|
+
* that account and Region to <code>FAILED</code>.</p>
|
|
13
13
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html">Configuring a
|
|
14
14
|
* target account gate</a>.</p>
|
|
15
15
|
*/
|
|
@@ -21,22 +21,21 @@ export interface AccountGateResult {
|
|
|
21
21
|
* <p>
|
|
22
22
|
* <code>SUCCEEDED</code>: The account gate function has determined that the
|
|
23
23
|
* account and Region passes any requirements for a stack set operation to occur.
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* CloudFormation proceeds with the stack operation in that account and Region.
|
|
25
|
+
* </p>
|
|
26
26
|
* </li>
|
|
27
27
|
* <li>
|
|
28
28
|
* <p>
|
|
29
29
|
* <code>FAILED</code>: The account gate function has determined that the account
|
|
30
30
|
* and Region does not meet the requirements for a stack set operation to occur. AWS
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* CloudFormation cancels the stack set operation in that account and Region, and sets
|
|
32
|
+
* the stack set operation result status for that account and Region to
|
|
33
33
|
* <code>FAILED</code>. </p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
36
|
* <p>
|
|
37
|
-
* <code>SKIPPED</code>: CloudFormation has skipped calling the account
|
|
38
|
-
*
|
|
39
|
-
* reasons:</p>
|
|
37
|
+
* <code>SKIPPED</code>: CloudFormation has skipped calling the account gate
|
|
38
|
+
* function for this account and Region, for one of the following reasons:</p>
|
|
40
39
|
* <ul>
|
|
41
40
|
* <li>
|
|
42
41
|
* <p>An account gate function has not been specified for the account and
|
|
@@ -45,12 +44,13 @@ export interface AccountGateResult {
|
|
|
45
44
|
* </li>
|
|
46
45
|
* <li>
|
|
47
46
|
* <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set
|
|
48
|
-
* adminstration account lacks permissions to invoke the function.
|
|
47
|
+
* adminstration account lacks permissions to invoke the function.
|
|
48
|
+
* CloudFormation proceeds with the stack set operation in this account and
|
|
49
49
|
* Region.</p>
|
|
50
50
|
* </li>
|
|
51
51
|
* <li>
|
|
52
52
|
* <p>Either no action is necessary, or no action is possible, on the stack.
|
|
53
|
-
*
|
|
53
|
+
* CloudFormation skips the stack set operation in this account and
|
|
54
54
|
* Region.</p>
|
|
55
55
|
* </li>
|
|
56
56
|
* </ul>
|
|
@@ -474,8 +474,8 @@ export interface CancelUpdateStackInput {
|
|
|
474
474
|
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this
|
|
475
475
|
* token if you plan to retry requests so that CloudFormation knows that you're not
|
|
476
476
|
* attempting to cancel an update on a stack with the same name. You might retry
|
|
477
|
-
*
|
|
478
|
-
*
|
|
477
|
+
* <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully
|
|
478
|
+
* received them.</p>
|
|
479
479
|
*/
|
|
480
480
|
ClientRequestToken?: string;
|
|
481
481
|
}
|
|
@@ -574,20 +574,20 @@ export declare namespace ResourceTargetDefinition {
|
|
|
574
574
|
}
|
|
575
575
|
/**
|
|
576
576
|
* <p>For a resource with <code>Modify</code> as the action, the
|
|
577
|
-
* <code>ResourceChange</code> structure describes the changes CloudFormation will
|
|
578
|
-
*
|
|
577
|
+
* <code>ResourceChange</code> structure describes the changes CloudFormation will make
|
|
578
|
+
* to that resource.</p>
|
|
579
579
|
*/
|
|
580
580
|
export interface ResourceChangeDetail {
|
|
581
581
|
/**
|
|
582
582
|
* <p>A <code>ResourceTargetDefinition</code> structure that describes the field that
|
|
583
|
-
*
|
|
583
|
+
* CloudFormation will change and whether the resource will be recreated.</p>
|
|
584
584
|
*/
|
|
585
585
|
Target?: ResourceTargetDefinition;
|
|
586
586
|
/**
|
|
587
|
-
* <p>Indicates whether CloudFormation can determine the target value, and whether
|
|
588
|
-
*
|
|
589
|
-
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the
|
|
590
|
-
*
|
|
587
|
+
* <p>Indicates whether CloudFormation can determine the target value, and whether the
|
|
588
|
+
* target value will change before you execute a change set.</p>
|
|
589
|
+
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the target
|
|
590
|
+
* value will change, and its value. For example, if you directly modify the
|
|
591
591
|
* <code>InstanceType</code> property of an EC2 instance, CloudFormation knows that
|
|
592
592
|
* this property value will change, and its value, so this is a <code>Static</code>
|
|
593
593
|
* evaluation.</p>
|
|
@@ -634,7 +634,7 @@ export interface ResourceChangeDetail {
|
|
|
634
634
|
* <code>AWS::CloudFormation::Stack</code> resource, CloudFormation sets the
|
|
635
635
|
* <code>ChangeSource</code> to <code>Automatic</code> because the nested stack's
|
|
636
636
|
* template might have changed. Changes to a nested stack's template aren't visible to
|
|
637
|
-
*
|
|
637
|
+
* CloudFormation until you run an update on the parent stack.</p>
|
|
638
638
|
* </li>
|
|
639
639
|
* </ul>
|
|
640
640
|
*/
|
|
@@ -704,14 +704,14 @@ export declare enum Replacement {
|
|
|
704
704
|
}
|
|
705
705
|
/**
|
|
706
706
|
* <p>The <code>ResourceChange</code> structure describes the resource and the action that
|
|
707
|
-
*
|
|
707
|
+
* CloudFormation will perform on it if you execute this change set.</p>
|
|
708
708
|
*/
|
|
709
709
|
export interface ResourceChange {
|
|
710
710
|
/**
|
|
711
|
-
* <p>The action that CloudFormation takes on the resource, such as
|
|
712
|
-
*
|
|
713
|
-
*
|
|
714
|
-
*
|
|
711
|
+
* <p>The action that CloudFormation takes on the resource, such as <code>Add</code>
|
|
712
|
+
* (adds a new resource), <code>Modify</code> (changes a resource), <code>Remove</code>
|
|
713
|
+
* (deletes a resource), <code>Import</code> (imports a resource), or <code>Dynamic</code>
|
|
714
|
+
* (exact action for the resource cannot be determined).</p>
|
|
715
715
|
*/
|
|
716
716
|
Action?: ChangeAction | string;
|
|
717
717
|
/**
|
|
@@ -729,9 +729,9 @@ export interface ResourceChange {
|
|
|
729
729
|
*/
|
|
730
730
|
ResourceType?: string;
|
|
731
731
|
/**
|
|
732
|
-
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will
|
|
733
|
-
*
|
|
734
|
-
*
|
|
732
|
+
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will replace
|
|
733
|
+
* the resource by creating a new one and deleting the old one. This value depends on the
|
|
734
|
+
* value of the <code>RequiresRecreation</code> property in the
|
|
735
735
|
* <code>ResourceTargetDefinition</code> structure. For example, if the
|
|
736
736
|
* <code>RequiresRecreation</code> field is <code>Always</code> and the
|
|
737
737
|
* <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is
|
|
@@ -752,8 +752,8 @@ export interface ResourceChange {
|
|
|
752
752
|
Scope?: (ResourceAttribute | string)[];
|
|
753
753
|
/**
|
|
754
754
|
* <p>For the <code>Modify</code> action, a list of <code>ResourceChangeDetail</code>
|
|
755
|
-
* structures that describes the changes that CloudFormation will make to the
|
|
756
|
-
*
|
|
755
|
+
* structures that describes the changes that CloudFormation will make to the resource.
|
|
756
|
+
* </p>
|
|
757
757
|
*/
|
|
758
758
|
Details?: ResourceChangeDetail[];
|
|
759
759
|
/**
|
|
@@ -781,13 +781,13 @@ export declare enum ChangeType {
|
|
|
781
781
|
*/
|
|
782
782
|
export interface Change {
|
|
783
783
|
/**
|
|
784
|
-
* <p>The type of entity that CloudFormation changes. Currently, the only entity
|
|
785
|
-
*
|
|
784
|
+
* <p>The type of entity that CloudFormation changes. Currently, the only entity type
|
|
785
|
+
* is <code>Resource</code>.</p>
|
|
786
786
|
*/
|
|
787
787
|
Type?: ChangeType | string;
|
|
788
788
|
/**
|
|
789
789
|
* <p>A <code>ResourceChange</code> structure that describes the resource and action that
|
|
790
|
-
*
|
|
790
|
+
* CloudFormation will perform.</p>
|
|
791
791
|
*/
|
|
792
792
|
ResourceChange?: ResourceChange;
|
|
793
793
|
}
|
|
@@ -918,19 +918,20 @@ export interface ContinueUpdateRollbackInput {
|
|
|
918
918
|
*/
|
|
919
919
|
StackName: string | undefined;
|
|
920
920
|
/**
|
|
921
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
922
|
-
*
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
927
|
-
*
|
|
928
|
-
*
|
|
921
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
922
|
+
* that CloudFormation assumes to roll back the stack. CloudFormation uses the role's
|
|
923
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for all
|
|
924
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
925
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
926
|
+
* Ensure that the role grants least privilege.</p>
|
|
927
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
928
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
929
|
+
* session that is generated from your user credentials.</p>
|
|
929
930
|
*/
|
|
930
931
|
RoleARN?: string;
|
|
931
932
|
/**
|
|
932
|
-
* <p>A list of the logical IDs of the resources that CloudFormation skips during
|
|
933
|
-
*
|
|
933
|
+
* <p>A list of the logical IDs of the resources that CloudFormation skips during the
|
|
934
|
+
* continue update rollback operation. You can specify only resources that are in the
|
|
934
935
|
* <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources
|
|
935
936
|
* that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an
|
|
936
937
|
* update was cancelled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p>
|
|
@@ -942,29 +943,29 @@ export interface ContinueUpdateRollbackInput {
|
|
|
942
943
|
* will be inconsistent with the state of the resources in the stack template. Before
|
|
943
944
|
* performing another stack update, you must update the stack or resources to be consistent
|
|
944
945
|
* with each other. If you don't, subsequent stack updates might fail, and the stack will
|
|
945
|
-
* become unrecoverable
|
|
946
|
+
* become unrecoverable.</p>
|
|
946
947
|
* </important>
|
|
947
|
-
* <p>Specify the minimum number of resources required to successfully roll back your
|
|
948
|
-
*
|
|
949
|
-
*
|
|
948
|
+
* <p>Specify the minimum number of resources required to successfully roll back your stack.
|
|
949
|
+
* For example, a failed resource update might cause dependent resources to fail. In this
|
|
950
|
+
* case, it might not be necessary to skip the dependent resources.</p>
|
|
950
951
|
* <p>To skip resources that are part of nested stacks, use the following format:
|
|
951
952
|
* <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of
|
|
952
953
|
* a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the
|
|
953
954
|
* <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one
|
|
954
955
|
* of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or
|
|
955
|
-
* <code>DELETE_FAILED</code
|
|
956
|
+
* <code>DELETE_FAILED</code>.</p>
|
|
956
957
|
* <note>
|
|
957
|
-
* <p>Don't confuse a child stack's name with its corresponding logical ID defined in
|
|
958
|
-
*
|
|
959
|
-
*
|
|
958
|
+
* <p>Don't confuse a child stack's name with its corresponding logical ID defined in the
|
|
959
|
+
* parent stack. For an example of a continue update rollback operation with nested stacks,
|
|
960
|
+
* 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>
|
|
960
961
|
* </note>
|
|
961
962
|
*/
|
|
962
963
|
ResourcesToSkip?: string[];
|
|
963
964
|
/**
|
|
964
965
|
* <p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify
|
|
965
|
-
* this token if you plan to retry requests so that CloudFormationknows that you're
|
|
966
|
-
*
|
|
967
|
-
*
|
|
966
|
+
* this token if you plan to retry requests so that CloudFormationknows that you're not
|
|
967
|
+
* attempting to continue the rollback to a stack with the same name. You might retry
|
|
968
|
+
* <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation
|
|
968
969
|
* successfully received them.</p>
|
|
969
970
|
*/
|
|
970
971
|
ClientRequestToken?: string;
|
|
@@ -992,8 +993,8 @@ export declare namespace ContinueUpdateRollbackOutput {
|
|
|
992
993
|
export interface Parameter {
|
|
993
994
|
/**
|
|
994
995
|
* <p>The key associated with the parameter. If you don't specify a key and value for a
|
|
995
|
-
* particular parameter, CloudFormation uses the default value that is specified in
|
|
996
|
-
*
|
|
996
|
+
* particular parameter, CloudFormation uses the default value that is specified in your
|
|
997
|
+
* template.</p>
|
|
997
998
|
*/
|
|
998
999
|
ParameterKey?: string;
|
|
999
1000
|
/**
|
|
@@ -1110,17 +1111,17 @@ export interface RollbackConfiguration {
|
|
|
1110
1111
|
*/
|
|
1111
1112
|
RollbackTriggers?: RollbackTrigger[];
|
|
1112
1113
|
/**
|
|
1113
|
-
* <p>The amount of time, in minutes, during which CloudFormation should monitor
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1114
|
+
* <p>The amount of time, in minutes, during which CloudFormation should monitor all the
|
|
1115
|
+
* rollback triggers after the stack creation or update operation deploys all necessary
|
|
1116
|
+
* resources.</p>
|
|
1116
1117
|
* <p>The default is 0 minutes.</p>
|
|
1117
|
-
* <p>If you specify a monitoring period but do not specify any rollback triggers,
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1121
|
-
*
|
|
1122
|
-
*
|
|
1123
|
-
* completes.</p>
|
|
1118
|
+
* <p>If you specify a monitoring period but do not specify any rollback triggers,
|
|
1119
|
+
* CloudFormation still waits the specified period of time before cleaning up old resources
|
|
1120
|
+
* after update operations. You can use this monitoring period to perform any manual stack
|
|
1121
|
+
* 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>
|
|
1122
|
+
* <p>If you specify 0 for this parameter, CloudFormation still monitors the specified
|
|
1123
|
+
* rollback triggers during stack creation and update operations. Then, for update operations,
|
|
1124
|
+
* it begins disposing of old resources immediately once the operation completes.</p>
|
|
1124
1125
|
*/
|
|
1125
1126
|
MonitoringTimeInMinutes?: number;
|
|
1126
1127
|
}
|
|
@@ -1138,7 +1139,8 @@ export interface Tag {
|
|
|
1138
1139
|
/**
|
|
1139
1140
|
* <p>
|
|
1140
1141
|
* <i>Required</i>. A string used to identify this tag. You can specify a
|
|
1141
|
-
* maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the
|
|
1142
|
+
* maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the
|
|
1143
|
+
* reserved prefix: <code>aws:</code>.</p>
|
|
1142
1144
|
*/
|
|
1143
1145
|
Key: string | undefined;
|
|
1144
1146
|
/**
|
|
@@ -1160,15 +1162,15 @@ export declare namespace Tag {
|
|
|
1160
1162
|
export interface CreateChangeSetInput {
|
|
1161
1163
|
/**
|
|
1162
1164
|
* <p>The name or the unique ID of the stack for which you are creating a change set.
|
|
1163
|
-
*
|
|
1164
|
-
*
|
|
1165
|
-
*
|
|
1165
|
+
* CloudFormation generates the change set by comparing this stack's information with the
|
|
1166
|
+
* information that you submit, such as a modified template or different parameter input
|
|
1167
|
+
* values.</p>
|
|
1166
1168
|
*/
|
|
1167
1169
|
StackName: string | undefined;
|
|
1168
1170
|
/**
|
|
1169
1171
|
* <p>A structure that contains the body of the revised template, with a minimum length of
|
|
1170
|
-
* 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change
|
|
1171
|
-
*
|
|
1172
|
+
* 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by
|
|
1173
|
+
* comparing this template with the template of the stack that you specified.</p>
|
|
1172
1174
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1173
1175
|
* <code>TemplateURL</code>.</p>
|
|
1174
1176
|
*/
|
|
@@ -1176,8 +1178,8 @@ export interface CreateChangeSetInput {
|
|
|
1176
1178
|
/**
|
|
1177
1179
|
* <p>The location of the file that contains the revised template. The URL must point to a
|
|
1178
1180
|
* template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager
|
|
1179
|
-
* document. CloudFormation generates the change set by comparing this template with
|
|
1180
|
-
*
|
|
1181
|
+
* document. CloudFormation generates the change set by comparing this template with the
|
|
1182
|
+
* stack that you specified.</p>
|
|
1181
1183
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1182
1184
|
* <code>TemplateURL</code>.</p>
|
|
1183
1185
|
*/
|
|
@@ -1201,7 +1203,7 @@ export interface CreateChangeSetInput {
|
|
|
1201
1203
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1202
1204
|
* </p>
|
|
1203
1205
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
1204
|
-
* your account; for example, by creating new Identity and Access Management
|
|
1206
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1205
1207
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
1206
1208
|
* of these capabilities.</p>
|
|
1207
1209
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -1209,11 +1211,12 @@ export interface CreateChangeSetInput {
|
|
|
1209
1211
|
* capability.</p>
|
|
1210
1212
|
* <ul>
|
|
1211
1213
|
* <li>
|
|
1212
|
-
* <p>If you have IAM resources, you can specify either
|
|
1214
|
+
* <p>If you have IAM resources, you can specify either
|
|
1215
|
+
* capability.</p>
|
|
1213
1216
|
* </li>
|
|
1214
1217
|
* <li>
|
|
1215
|
-
* <p>If you have IAM resources with custom names, you
|
|
1216
|
-
*
|
|
1218
|
+
* <p>If you have IAM resources with custom names, you
|
|
1219
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1217
1220
|
* </li>
|
|
1218
1221
|
* <li>
|
|
1219
1222
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -1298,21 +1301,23 @@ export interface CreateChangeSetInput {
|
|
|
1298
1301
|
* this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or
|
|
1299
1302
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
1300
1303
|
* <p>If the list of resource types doesn't include a resource type that you're updating,
|
|
1301
|
-
* the stack update fails. By default, CloudFormation grants permissions to all
|
|
1302
|
-
*
|
|
1303
|
-
* policies for CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1304
|
-
*
|
|
1304
|
+
* the stack update fails. By default, CloudFormation grants permissions to all resource
|
|
1305
|
+
* types. Identity and Access Management (IAM) uses this parameter for condition keys in
|
|
1306
|
+
* 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
|
|
1307
|
+
* Identity and Access Management</a> in the CloudFormation User
|
|
1308
|
+
* Guide.</p>
|
|
1305
1309
|
*/
|
|
1306
1310
|
ResourceTypes?: string[];
|
|
1307
1311
|
/**
|
|
1308
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1312
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1313
|
+
* that CloudFormation assumes when executing the change set. CloudFormation uses the
|
|
1314
|
+
* role's credentials to make calls on your behalf. CloudFormation uses this role for all
|
|
1315
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
1316
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
1317
|
+
* Ensure that the role grants least privilege.</p>
|
|
1318
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1319
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1320
|
+
* session that is generated from your user credentials.</p>
|
|
1316
1321
|
*/
|
|
1317
1322
|
RoleARN?: string;
|
|
1318
1323
|
/**
|
|
@@ -1341,8 +1346,8 @@ export interface CreateChangeSetInput {
|
|
|
1341
1346
|
ChangeSetName: string | undefined;
|
|
1342
1347
|
/**
|
|
1343
1348
|
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token
|
|
1344
|
-
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
1345
|
-
*
|
|
1349
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
1350
|
+
* to create another change set with the same name. You might retry
|
|
1346
1351
|
* <code>CreateChangeSet</code> requests to ensure that CloudFormation successfully
|
|
1347
1352
|
* received them.</p>
|
|
1348
1353
|
*/
|
|
@@ -1356,8 +1361,8 @@ export interface CreateChangeSetInput {
|
|
|
1356
1361
|
* <code>CREATE</code>. To create a change set for an existing stack, specify
|
|
1357
1362
|
* <code>UPDATE</code>. To create a change set for an import operation, specify
|
|
1358
1363
|
* <code>IMPORT</code>.</p>
|
|
1359
|
-
* <p>If you create a change set for a new stack, CloudFormation creates a stack
|
|
1360
|
-
*
|
|
1364
|
+
* <p>If you create a change set for a new stack, CloudFormation creates a stack with a
|
|
1365
|
+
* 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">
|
|
1361
1366
|
* <code>REVIEW_IN_PROGRESS</code>
|
|
1362
1367
|
* </a> state until you execute the change
|
|
1363
1368
|
* set.</p>
|
|
@@ -1446,8 +1451,8 @@ export interface CreateStackInput {
|
|
|
1446
1451
|
* <p>The name that is associated with the stack. The name must be unique in the Region in
|
|
1447
1452
|
* which you are creating the stack.</p>
|
|
1448
1453
|
* <note>
|
|
1449
|
-
* <p>A stack name can contain only alphanumeric characters (case sensitive) and
|
|
1450
|
-
*
|
|
1454
|
+
* <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens.
|
|
1455
|
+
* It must start with an alphabetical character and cannot be longer than 128
|
|
1451
1456
|
* characters.</p>
|
|
1452
1457
|
* </note>
|
|
1453
1458
|
*/
|
|
@@ -1509,7 +1514,7 @@ export interface CreateStackInput {
|
|
|
1509
1514
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1510
1515
|
* </p>
|
|
1511
1516
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
1512
|
-
* your account; for example, by creating new Identity and Access Management
|
|
1517
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1513
1518
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
1514
1519
|
* of these capabilities.</p>
|
|
1515
1520
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -1517,11 +1522,11 @@ export interface CreateStackInput {
|
|
|
1517
1522
|
* capability.</p>
|
|
1518
1523
|
* <ul>
|
|
1519
1524
|
* <li>
|
|
1520
|
-
* <p>If you have IAM resources, you can specify either capability
|
|
1525
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
1521
1526
|
* </li>
|
|
1522
1527
|
* <li>
|
|
1523
1528
|
* <p>If you have IAM resources with custom names, you <i>must</i>
|
|
1524
|
-
* specify <code>CAPABILITY_NAMED_IAM</code
|
|
1529
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1525
1530
|
* </li>
|
|
1526
1531
|
* <li>
|
|
1527
1532
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -1616,23 +1621,22 @@ export interface CreateStackInput {
|
|
|
1616
1621
|
* <code>AWS::<i>service_name</i>::*</code> (for all resources of a
|
|
1617
1622
|
* particular Amazon Web Services service), and
|
|
1618
1623
|
* <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i>
|
|
1619
|
-
*
|
|
1624
|
+
* </code> (for a specific Amazon Web Services resource).</p>
|
|
1620
1625
|
* <p>If the list of resource types doesn't include a resource that you're creating, the
|
|
1621
1626
|
* stack creation fails. By default, CloudFormation grants permissions to all resource
|
|
1622
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
1623
|
-
* 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
|
|
1624
|
-
* Identity and Access Management</a>.</p>
|
|
1627
|
+
* 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>
|
|
1625
1628
|
*/
|
|
1626
1629
|
ResourceTypes?: string[];
|
|
1627
1630
|
/**
|
|
1628
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
1632
|
-
*
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1635
|
-
*
|
|
1631
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1632
|
+
* that CloudFormation assumes to create the stack. CloudFormation uses the role's
|
|
1633
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for all
|
|
1634
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
1635
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
1636
|
+
* Ensure that the role grants least privilege.</p>
|
|
1637
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1638
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1639
|
+
* session that is generated from your user credentials.</p>
|
|
1636
1640
|
*/
|
|
1637
1641
|
RoleARN?: string;
|
|
1638
1642
|
/**
|
|
@@ -1645,16 +1649,16 @@ export interface CreateStackInput {
|
|
|
1645
1649
|
OnFailure?: OnFailure | string;
|
|
1646
1650
|
/**
|
|
1647
1651
|
* <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
|
|
1648
|
-
* to Stack Resources</a> in the <i>CloudFormation User
|
|
1649
|
-
*
|
|
1650
|
-
*
|
|
1652
|
+
* to Stack Resources</a> in the <i>CloudFormation User Guide</i>.
|
|
1653
|
+
* You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code>
|
|
1654
|
+
* parameter, but not both.</p>
|
|
1651
1655
|
*/
|
|
1652
1656
|
StackPolicyBody?: string;
|
|
1653
1657
|
/**
|
|
1654
1658
|
* <p>Location of a file containing the stack policy. The URL must point to a policy
|
|
1655
|
-
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
1656
|
-
* specify either the <code>StackPolicyBody</code> or the
|
|
1657
|
-
*
|
|
1659
|
+
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
1660
|
+
* Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
1661
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
1658
1662
|
*/
|
|
1659
1663
|
StackPolicyURL?: string;
|
|
1660
1664
|
/**
|
|
@@ -1665,29 +1669,29 @@ export interface CreateStackInput {
|
|
|
1665
1669
|
Tags?: Tag[];
|
|
1666
1670
|
/**
|
|
1667
1671
|
* <p>A unique identifier for this <code>CreateStack</code> request. Specify this token if
|
|
1668
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
1669
|
-
*
|
|
1672
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1673
|
+
* create a stack with the same name. You might retry <code>CreateStack</code> requests to
|
|
1670
1674
|
* ensure that CloudFormation successfully received them.</p>
|
|
1671
1675
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
1672
1676
|
* token, which you can use to track operations. For example, if you execute a
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1677
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
1678
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
1679
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
1676
1680
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
1677
1681
|
* Stack operations that are initiated from the console use the token format
|
|
1678
1682
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
1679
1683
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
1680
1684
|
* would be assigned the same token in the following format:
|
|
1681
|
-
*
|
|
1685
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>
|
|
1682
1686
|
*/
|
|
1683
1687
|
ClientRequestToken?: string;
|
|
1684
1688
|
/**
|
|
1685
|
-
* <p>Whether to enable termination protection on the specified stack. If a user attempts
|
|
1686
|
-
*
|
|
1689
|
+
* <p>Whether to enable termination protection on the specified stack. If a user attempts to
|
|
1690
|
+
* delete a stack with termination protection enabled, the operation fails and the stack
|
|
1687
1691
|
* 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
|
|
1688
1692
|
* Deleted</a> in the <i>CloudFormation User Guide</i>. Termination protection is
|
|
1689
|
-
* disabled on stacks by default
|
|
1690
|
-
* <p>
|
|
1693
|
+
* disabled on stacks by default.</p>
|
|
1694
|
+
* <p>For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>,
|
|
1691
1695
|
* termination protection is set on the root stack and cannot be changed directly on the
|
|
1692
1696
|
* nested stack.</p>
|
|
1693
1697
|
*/
|
|
@@ -1725,7 +1729,7 @@ export declare namespace CreateStackOutput {
|
|
|
1725
1729
|
*/
|
|
1726
1730
|
export interface DeploymentTargets {
|
|
1727
1731
|
/**
|
|
1728
|
-
* <p>The names of one or more accounts for which you want to deploy stack
|
|
1732
|
+
* <p>The names of one or more Amazon Web Services accounts for which you want to deploy stack
|
|
1729
1733
|
* set updates.</p>
|
|
1730
1734
|
*/
|
|
1731
1735
|
Accounts?: string[];
|
|
@@ -1765,9 +1769,9 @@ export interface StackSetOperationPreferences {
|
|
|
1765
1769
|
*/
|
|
1766
1770
|
RegionOrder?: string[];
|
|
1767
1771
|
/**
|
|
1768
|
-
* <p>The number of accounts, per Region, for which this operation can fail before
|
|
1769
|
-
*
|
|
1770
|
-
* Regions.</p>
|
|
1772
|
+
* <p>The number of accounts, per Region, for which this operation can fail before
|
|
1773
|
+
* CloudFormation stops the operation in that Region. If the operation is stopped in a Region,
|
|
1774
|
+
* CloudFormation doesn't attempt the operation in any subsequent Regions.</p>
|
|
1771
1775
|
* <p>Conditional: You must specify either <code>FailureToleranceCount</code> or
|
|
1772
1776
|
* <code>FailureTolerancePercentage</code> (but not both).</p>
|
|
1773
1777
|
* <p>By default, <code>0</code> is specified.</p>
|
|
@@ -1775,10 +1779,11 @@ export interface StackSetOperationPreferences {
|
|
|
1775
1779
|
FailureToleranceCount?: number;
|
|
1776
1780
|
/**
|
|
1777
1781
|
* <p>The percentage of accounts, per Region, for which this stack operation can fail
|
|
1778
|
-
* before CloudFormation stops the operation in that Region. If the operation is
|
|
1779
|
-
*
|
|
1782
|
+
* before CloudFormation stops the operation in that Region. If the operation is stopped
|
|
1783
|
+
* in a Region, CloudFormation doesn't attempt the operation in any subsequent
|
|
1780
1784
|
* Regions.</p>
|
|
1781
|
-
* <p>When calculating the number of accounts based on the specified percentage,
|
|
1785
|
+
* <p>When calculating the number of accounts based on the specified percentage,
|
|
1786
|
+
* CloudFormation rounds <i>down</i> to the next whole number.</p>
|
|
1782
1787
|
* <p>Conditional: You must specify either <code>FailureToleranceCount</code> or
|
|
1783
1788
|
* <code>FailureTolerancePercentage</code>, but not both.</p>
|
|
1784
1789
|
* <p>By default, <code>0</code> is specified.</p>
|
|
@@ -1786,9 +1791,9 @@ export interface StackSetOperationPreferences {
|
|
|
1786
1791
|
FailureTolerancePercentage?: number;
|
|
1787
1792
|
/**
|
|
1788
1793
|
* <p>The maximum number of accounts in which to perform this operation at one time. This
|
|
1789
|
-
* is dependent on the value of
|
|
1790
|
-
* <code>MaxConcurrentCount</code> is at most one more
|
|
1791
|
-
*
|
|
1794
|
+
* is dependent on the value of
|
|
1795
|
+
* <code>FailureToleranceCount</code>. <code>MaxConcurrentCount</code> is at most one more
|
|
1796
|
+
* than the <code>FailureToleranceCount</code>.</p>
|
|
1792
1797
|
* <p>Note that this setting lets you specify the <i>maximum</i> for
|
|
1793
1798
|
* operations. For large deployments, under certain circumstances the actual number of
|
|
1794
1799
|
* accounts acted upon concurrently may be lower due to service throttling.</p>
|
|
@@ -1800,9 +1805,10 @@ export interface StackSetOperationPreferences {
|
|
|
1800
1805
|
/**
|
|
1801
1806
|
* <p>The maximum percentage of accounts in which to perform this operation at one
|
|
1802
1807
|
* time.</p>
|
|
1803
|
-
* <p>When calculating the number of accounts based on the specified percentage,
|
|
1804
|
-
*
|
|
1805
|
-
* as one
|
|
1808
|
+
* <p>When calculating the number of accounts based on the specified percentage,
|
|
1809
|
+
* CloudFormation rounds down to the next whole number. This is true except in cases where
|
|
1810
|
+
* rounding down would result is zero. In this case, CloudFormation sets the number as one
|
|
1811
|
+
* instead.</p>
|
|
1806
1812
|
* <p>Note that this setting lets you specify the <i>maximum</i> for
|
|
1807
1813
|
* operations. For large deployments, under certain circumstances the actual number of
|
|
1808
1814
|
* accounts acted upon concurrently may be lower due to service throttling.</p>
|
|
@@ -1825,10 +1831,9 @@ export interface CreateStackInstancesInput {
|
|
|
1825
1831
|
*/
|
|
1826
1832
|
StackSetName: string | undefined;
|
|
1827
1833
|
/**
|
|
1828
|
-
* <p>[Self-managed permissions] The names of one or more accounts that
|
|
1829
|
-
*
|
|
1830
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
1831
|
-
* both.</p>
|
|
1834
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the
|
|
1835
|
+
* specified Region(s) for.</p>
|
|
1836
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
1832
1837
|
*/
|
|
1833
1838
|
Accounts?: string[];
|
|
1834
1839
|
/**
|
|
@@ -1840,7 +1845,7 @@ export interface CreateStackInstancesInput {
|
|
|
1840
1845
|
DeploymentTargets?: DeploymentTargets;
|
|
1841
1846
|
/**
|
|
1842
1847
|
* <p>The names of one or more Regions where you want to create stack instances using the
|
|
1843
|
-
* specified accounts
|
|
1848
|
+
* specified Amazon Web Services accounts.</p>
|
|
1844
1849
|
*/
|
|
1845
1850
|
Regions: string[] | undefined;
|
|
1846
1851
|
/**
|
|
@@ -1848,18 +1853,16 @@ export interface CreateStackInstancesInput {
|
|
|
1848
1853
|
* stack instances.</p>
|
|
1849
1854
|
* <p>Any overridden parameter values will be applied to all stack instances in the
|
|
1850
1855
|
* specified accounts and Regions. When specifying parameters and their values, be aware of
|
|
1851
|
-
* how CloudFormation sets parameter values during stack instance
|
|
1852
|
-
* operations:</p>
|
|
1856
|
+
* how CloudFormation sets parameter values during stack instance operations:</p>
|
|
1853
1857
|
* <ul>
|
|
1854
1858
|
* <li>
|
|
1855
1859
|
* <p>To override the current value for a parameter, include the parameter and
|
|
1856
1860
|
* specify its value.</p>
|
|
1857
1861
|
* </li>
|
|
1858
1862
|
* <li>
|
|
1859
|
-
* <p>To leave an overridden parameter set to its present value, include the
|
|
1860
|
-
*
|
|
1861
|
-
*
|
|
1862
|
-
* <code>true</code>.)</p>
|
|
1863
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as
|
|
1864
|
+
* <code>true</code>. (You cannot specify both a value and set
|
|
1865
|
+
* <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
1863
1866
|
* </li>
|
|
1864
1867
|
* <li>
|
|
1865
1868
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
@@ -1877,34 +1880,31 @@ export interface CreateStackInstancesInput {
|
|
|
1877
1880
|
*/
|
|
1878
1881
|
ParameterOverrides?: Parameter[];
|
|
1879
1882
|
/**
|
|
1880
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
1881
|
-
* operation.</p>
|
|
1883
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
1882
1884
|
*/
|
|
1883
1885
|
OperationPreferences?: StackSetOperationPreferences;
|
|
1884
1886
|
/**
|
|
1885
|
-
* <p>The unique identifier for this stack set operation
|
|
1886
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
1887
|
-
*
|
|
1888
|
-
*
|
|
1889
|
-
*
|
|
1890
|
-
*
|
|
1887
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
1888
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
1889
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
1890
|
+
* multiple times. You might retry stack set operation requests to ensure that
|
|
1891
|
+
* CloudFormation successfully received them.</p>
|
|
1892
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
1893
|
+
* automatically.</p>
|
|
1894
|
+
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
1895
|
+
* whose status is <code>OUTDATED</code>.</p>
|
|
1891
1896
|
*/
|
|
1892
1897
|
OperationId?: string;
|
|
1893
1898
|
/**
|
|
1894
|
-
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
1895
|
-
*
|
|
1896
|
-
* member account.</p>
|
|
1897
|
-
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
1898
|
-
* self-managed permissions.</p>
|
|
1899
|
+
* <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>
|
|
1900
|
+
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
|
|
1899
1901
|
* <ul>
|
|
1900
1902
|
* <li>
|
|
1901
1903
|
* <p>If you are signed in to the management account, specify <code>SELF</code>.</p>
|
|
1902
1904
|
* </li>
|
|
1903
1905
|
* <li>
|
|
1904
|
-
* <p>If you are signed in to a delegated administrator account, specify
|
|
1905
|
-
*
|
|
1906
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
1907
|
-
* 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>
|
|
1906
|
+
* <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
1907
|
+
* <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>
|
|
1908
1908
|
* </li>
|
|
1909
1909
|
* </ul>
|
|
1910
1910
|
*/
|
|
@@ -2054,7 +2054,7 @@ export interface CreateStackSetInput {
|
|
|
2054
2054
|
*/
|
|
2055
2055
|
StackId?: string;
|
|
2056
2056
|
/**
|
|
2057
|
-
* <p>The input parameters for the stack set template
|
|
2057
|
+
* <p>The input parameters for the stack set template.</p>
|
|
2058
2058
|
*/
|
|
2059
2059
|
Parameters?: Parameter[];
|
|
2060
2060
|
/**
|
|
@@ -2067,7 +2067,7 @@ export interface CreateStackSetInput {
|
|
|
2067
2067
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
2068
2068
|
* </p>
|
|
2069
2069
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
2070
|
-
* your account; for example, by creating new Identity and Access Management
|
|
2070
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
2071
2071
|
* (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying
|
|
2072
2072
|
* one of these capabilities.</p>
|
|
2073
2073
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -2075,11 +2075,11 @@ export interface CreateStackSetInput {
|
|
|
2075
2075
|
* capability.</p>
|
|
2076
2076
|
* <ul>
|
|
2077
2077
|
* <li>
|
|
2078
|
-
* <p>If you have IAM resources, you can specify either capability
|
|
2078
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
2079
2079
|
* </li>
|
|
2080
2080
|
* <li>
|
|
2081
2081
|
* <p>If you have IAM resources with custom names, you <i>must</i>
|
|
2082
|
-
* specify <code>CAPABILITY_NAMED_IAM</code
|
|
2082
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
2083
2083
|
* </li>
|
|
2084
2084
|
* <li>
|
|
2085
2085
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -2156,10 +2156,11 @@ export interface CreateStackSetInput {
|
|
|
2156
2156
|
Capabilities?: (Capability | string)[];
|
|
2157
2157
|
/**
|
|
2158
2158
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
2159
|
-
*
|
|
2160
|
-
*
|
|
2161
|
-
* <p>If you specify tags as part of a <code>CreateStackSet</code> action,
|
|
2162
|
-
*
|
|
2159
|
+
* CloudFormation also propagates these tags to supported resources that are created in
|
|
2160
|
+
* the stacks. A maximum number of 50 tags can be specified.</p>
|
|
2161
|
+
* <p>If you specify tags as part of a <code>CreateStackSet</code> action,
|
|
2162
|
+
* CloudFormation checks to see if you have the required IAM permission to tag resources. If
|
|
2163
|
+
* you don't, the entire <code>CreateStackSet</code> action fails with an <code>access
|
|
2163
2164
|
* denied</code> error, and the stack set is not created.</p>
|
|
2164
2165
|
*/
|
|
2165
2166
|
Tags?: Tag[];
|
|
@@ -2220,7 +2221,7 @@ export interface CreateStackSetInput {
|
|
|
2220
2221
|
* <li>
|
|
2221
2222
|
* <p>To create a stack set with service-managed permissions while signed in to a
|
|
2222
2223
|
* delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
2223
|
-
* <p>Your account must be registered as a delegated admin in the
|
|
2224
|
+
* <p>Your Amazon Web Services account must be registered as a delegated admin in the
|
|
2224
2225
|
* 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>
|
|
2225
2226
|
* </li>
|
|
2226
2227
|
* </ul>
|
|
@@ -2230,12 +2231,11 @@ export interface CreateStackSetInput {
|
|
|
2230
2231
|
CallAs?: CallAs | string;
|
|
2231
2232
|
/**
|
|
2232
2233
|
* <p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token
|
|
2233
|
-
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
2234
|
-
*
|
|
2235
|
-
*
|
|
2236
|
-
*
|
|
2237
|
-
*
|
|
2238
|
-
* </p>
|
|
2234
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
2235
|
+
* to create another stack set with the same name. You might retry <code>CreateStackSet</code>
|
|
2236
|
+
* requests to ensure that CloudFormation successfully received them.</p>
|
|
2237
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2238
|
+
* automatically.</p>
|
|
2239
2239
|
*/
|
|
2240
2240
|
ClientRequestToken?: string;
|
|
2241
2241
|
}
|
|
@@ -2364,35 +2364,37 @@ export interface DeleteStackInput {
|
|
|
2364
2364
|
StackName: string | undefined;
|
|
2365
2365
|
/**
|
|
2366
2366
|
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs
|
|
2367
|
-
* that are associated with the resources you want to retain. During deletion,
|
|
2367
|
+
* that are associated with the resources you want to retain. During deletion,
|
|
2368
|
+
* CloudFormation deletes the stack but does not delete the retained resources.</p>
|
|
2368
2369
|
* <p>Retaining resources is useful when you cannot delete a resource, such as a non-empty
|
|
2369
2370
|
* S3 bucket, but you want to delete the stack.</p>
|
|
2370
2371
|
*/
|
|
2371
2372
|
RetainResources?: string[];
|
|
2372
2373
|
/**
|
|
2373
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2374
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2375
|
+
* that CloudFormation assumes to delete the stack. CloudFormation uses the role's
|
|
2374
2376
|
* credentials to make calls on your behalf.</p>
|
|
2375
|
-
* <p>If you don't specify a value, CloudFormation uses the role that was
|
|
2376
|
-
*
|
|
2377
|
-
*
|
|
2377
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
2378
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
2379
|
+
* session that is generated from your user credentials.</p>
|
|
2378
2380
|
*/
|
|
2379
2381
|
RoleARN?: string;
|
|
2380
2382
|
/**
|
|
2381
2383
|
* <p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if
|
|
2382
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
2383
|
-
*
|
|
2384
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
2385
|
+
* delete a stack with the same name. You might retry <code>DeleteStack</code> requests to
|
|
2384
2386
|
* ensure that CloudFormation successfully received them.</p>
|
|
2385
2387
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
2386
2388
|
* token, which you can use to track operations. For example, if you execute a
|
|
2387
|
-
*
|
|
2388
|
-
*
|
|
2389
|
-
*
|
|
2389
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
2390
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
2391
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
2390
2392
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
2391
2393
|
* Stack operations that are initiated from the console use the token format
|
|
2392
2394
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
2393
2395
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
2394
2396
|
* would be assigned the same token in the following format:
|
|
2395
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
2397
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
2396
2398
|
*/
|
|
2397
2399
|
ClientRequestToken?: string;
|
|
2398
2400
|
}
|
|
@@ -2409,10 +2411,8 @@ export interface DeleteStackInstancesInput {
|
|
|
2409
2411
|
*/
|
|
2410
2412
|
StackSetName: string | undefined;
|
|
2411
2413
|
/**
|
|
2412
|
-
* <p>[Self-managed permissions] The names of the accounts that you want
|
|
2413
|
-
*
|
|
2414
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
2415
|
-
* both.</p>
|
|
2414
|
+
* <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
|
|
2415
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
2416
2416
|
*/
|
|
2417
2417
|
Accounts?: string[];
|
|
2418
2418
|
/**
|
|
@@ -2423,12 +2423,11 @@ export interface DeleteStackInstancesInput {
|
|
|
2423
2423
|
*/
|
|
2424
2424
|
DeploymentTargets?: DeploymentTargets;
|
|
2425
2425
|
/**
|
|
2426
|
-
* <p>The Regions where you want to delete stack set instances
|
|
2426
|
+
* <p>The Regions where you want to delete stack set instances.</p>
|
|
2427
2427
|
*/
|
|
2428
2428
|
Regions: string[] | undefined;
|
|
2429
2429
|
/**
|
|
2430
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
2431
|
-
* operation.</p>
|
|
2430
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
2432
2431
|
*/
|
|
2433
2432
|
OperationPreferences?: StackSetOperationPreferences;
|
|
2434
2433
|
/**
|
|
@@ -2439,12 +2438,15 @@ export interface DeleteStackInstancesInput {
|
|
|
2439
2438
|
*/
|
|
2440
2439
|
RetainStacks: boolean | undefined;
|
|
2441
2440
|
/**
|
|
2442
|
-
* <p>The unique identifier for this stack set operation
|
|
2443
|
-
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2444
|
-
*
|
|
2445
|
-
*
|
|
2446
|
-
*
|
|
2447
|
-
*
|
|
2441
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
2442
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2443
|
+
* automatically.</p>
|
|
2444
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
2445
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
2446
|
+
* multiple times. You can retry stack set operation requests to ensure that
|
|
2447
|
+
* CloudFormation successfully received them.</p>
|
|
2448
|
+
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
2449
|
+
* whose status is <code>OUTDATED</code>.</p>
|
|
2448
2450
|
*/
|
|
2449
2451
|
OperationId?: string;
|
|
2450
2452
|
/**
|
|
@@ -2460,7 +2462,7 @@ export interface DeleteStackInstancesInput {
|
|
|
2460
2462
|
* <li>
|
|
2461
2463
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
2462
2464
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
2463
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
2465
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
2464
2466
|
* 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>
|
|
2465
2467
|
* </li>
|
|
2466
2468
|
* </ul>
|
|
@@ -2504,7 +2506,7 @@ export interface DeleteStackSetInput {
|
|
|
2504
2506
|
* <li>
|
|
2505
2507
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
2506
2508
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
2507
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
2509
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
2508
2510
|
* 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>
|
|
2509
2511
|
* </li>
|
|
2510
2512
|
* </ul>
|
|
@@ -2602,8 +2604,8 @@ export declare namespace DescribeAccountLimitsInput {
|
|
|
2602
2604
|
*/
|
|
2603
2605
|
export interface DescribeAccountLimitsOutput {
|
|
2604
2606
|
/**
|
|
2605
|
-
* <p>An account limit structure that contain a list of CloudFormation account
|
|
2606
|
-
*
|
|
2607
|
+
* <p>An account limit structure that contain a list of CloudFormation account limits
|
|
2608
|
+
* and their values.</p>
|
|
2607
2609
|
*/
|
|
2608
2610
|
AccountLimits?: AccountLimit[];
|
|
2609
2611
|
/**
|
|
@@ -2716,7 +2718,8 @@ export interface DescribeChangeSetOutput {
|
|
|
2716
2718
|
*/
|
|
2717
2719
|
Tags?: Tag[];
|
|
2718
2720
|
/**
|
|
2719
|
-
* <p>A list of <code>Change</code> structures that describes the resources
|
|
2721
|
+
* <p>A list of <code>Change</code> structures that describes the resources
|
|
2722
|
+
* CloudFormation changes if you execute the change set.</p>
|
|
2720
2723
|
*/
|
|
2721
2724
|
Changes?: Change[];
|
|
2722
2725
|
/**
|
|
@@ -2797,10 +2800,10 @@ export declare namespace DescribePublisherOutput {
|
|
|
2797
2800
|
}
|
|
2798
2801
|
export interface DescribeStackDriftDetectionStatusInput {
|
|
2799
2802
|
/**
|
|
2800
|
-
* <p>The ID of the drift detection results of this operation
|
|
2801
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
2802
|
-
*
|
|
2803
|
-
* long, may vary
|
|
2803
|
+
* <p>The ID of the drift detection results of this operation.</p>
|
|
2804
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
2805
|
+
* run. However, the number of drift results CloudFormation retains for any given stack, and for how
|
|
2806
|
+
* long, may vary.</p>
|
|
2804
2807
|
*/
|
|
2805
2808
|
StackDriftDetectionId: string | undefined;
|
|
2806
2809
|
}
|
|
@@ -2827,14 +2830,15 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2827
2830
|
*/
|
|
2828
2831
|
StackId: string | undefined;
|
|
2829
2832
|
/**
|
|
2830
|
-
* <p>The ID of the drift detection results of this operation
|
|
2833
|
+
* <p>The ID of the drift detection results of this operation.</p>
|
|
2831
2834
|
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
2832
2835
|
* is run. However, the number of reports CloudFormation retains for any given stack, and for how long,
|
|
2833
2836
|
* may vary.</p>
|
|
2834
2837
|
*/
|
|
2835
2838
|
StackDriftDetectionId: string | undefined;
|
|
2836
2839
|
/**
|
|
2837
|
-
* <p>Status of the stack's actual configuration compared to its expected
|
|
2840
|
+
* <p>Status of the stack's actual configuration compared to its expected
|
|
2841
|
+
* configuration.</p>
|
|
2838
2842
|
* <ul>
|
|
2839
2843
|
* <li>
|
|
2840
2844
|
* <p>
|
|
@@ -2950,9 +2954,15 @@ export declare enum ResourceStatus {
|
|
|
2950
2954
|
IMPORT_ROLLBACK_COMPLETE = "IMPORT_ROLLBACK_COMPLETE",
|
|
2951
2955
|
IMPORT_ROLLBACK_FAILED = "IMPORT_ROLLBACK_FAILED",
|
|
2952
2956
|
IMPORT_ROLLBACK_IN_PROGRESS = "IMPORT_ROLLBACK_IN_PROGRESS",
|
|
2957
|
+
ROLLBACK_COMPLETE = "ROLLBACK_COMPLETE",
|
|
2958
|
+
ROLLBACK_FAILED = "ROLLBACK_FAILED",
|
|
2959
|
+
ROLLBACK_IN_PROGRESS = "ROLLBACK_IN_PROGRESS",
|
|
2953
2960
|
UPDATE_COMPLETE = "UPDATE_COMPLETE",
|
|
2954
2961
|
UPDATE_FAILED = "UPDATE_FAILED",
|
|
2955
|
-
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
|
|
2962
|
+
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
|
|
2963
|
+
UPDATE_ROLLBACK_COMPLETE = "UPDATE_ROLLBACK_COMPLETE",
|
|
2964
|
+
UPDATE_ROLLBACK_FAILED = "UPDATE_ROLLBACK_FAILED",
|
|
2965
|
+
UPDATE_ROLLBACK_IN_PROGRESS = "UPDATE_ROLLBACK_IN_PROGRESS"
|
|
2956
2966
|
}
|
|
2957
2967
|
/**
|
|
2958
2968
|
* <p>The StackEvent data type.</p>
|
|
@@ -2980,8 +2990,8 @@ export interface StackEvent {
|
|
|
2980
2990
|
*/
|
|
2981
2991
|
PhysicalResourceId?: string;
|
|
2982
2992
|
/**
|
|
2983
|
-
* <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
|
|
2984
|
-
*
|
|
2993
|
+
* <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
|
|
2994
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
2985
2995
|
*/
|
|
2986
2996
|
ResourceType?: string;
|
|
2987
2997
|
/**
|
|
@@ -3004,15 +3014,15 @@ export interface StackEvent {
|
|
|
3004
3014
|
* <p>The token passed to the operation that generated this event.</p>
|
|
3005
3015
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
3006
3016
|
* token, which you can use to track operations. For example, if you execute a
|
|
3007
|
-
*
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3017
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
3018
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
3019
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
3010
3020
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
3011
3021
|
* Stack operations that are initiated from the console use the token format
|
|
3012
3022
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
3013
3023
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
3014
3024
|
* would be assigned the same token in the following format:
|
|
3015
|
-
*
|
|
3025
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>
|
|
3016
3026
|
*/
|
|
3017
3027
|
ClientRequestToken?: string;
|
|
3018
3028
|
}
|
|
@@ -3049,8 +3059,7 @@ export interface DescribeStackInstanceInput {
|
|
|
3049
3059
|
*/
|
|
3050
3060
|
StackSetName: string | undefined;
|
|
3051
3061
|
/**
|
|
3052
|
-
* <p>The ID of an account that's associated with this stack
|
|
3053
|
-
* instance.</p>
|
|
3062
|
+
* <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
|
|
3054
3063
|
*/
|
|
3055
3064
|
StackInstanceAccount: string | undefined;
|
|
3056
3065
|
/**
|
|
@@ -3070,7 +3079,7 @@ export interface DescribeStackInstanceInput {
|
|
|
3070
3079
|
* <li>
|
|
3071
3080
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
3072
3081
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
3073
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
3082
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
3074
3083
|
* 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>
|
|
3075
3084
|
* </li>
|
|
3076
3085
|
* </ul>
|
|
@@ -3138,12 +3147,12 @@ export declare namespace StackInstanceComprehensiveStatus {
|
|
|
3138
3147
|
}
|
|
3139
3148
|
export declare type StackInstanceStatus = "CURRENT" | "INOPERABLE" | "OUTDATED";
|
|
3140
3149
|
/**
|
|
3141
|
-
* <p>An CloudFormation stack, in a specific account and Region, that's part of a
|
|
3142
|
-
*
|
|
3143
|
-
*
|
|
3144
|
-
*
|
|
3145
|
-
*
|
|
3146
|
-
*
|
|
3150
|
+
* <p>An CloudFormation stack, in a specific account and Region, that's part of a stack
|
|
3151
|
+
* set operation. A stack instance is a reference to an attempted or actual stack in a given
|
|
3152
|
+
* account within a given Region. A stack instance can exist without a stack—for example, if
|
|
3153
|
+
* the stack couldn't be created for some reason. A stack instance is associated with only one
|
|
3154
|
+
* stack set. Each stack instance contains the ID of its associated stack set, as well as the
|
|
3155
|
+
* ID of the actual stack and the stack status.</p>
|
|
3147
3156
|
*/
|
|
3148
3157
|
export interface StackInstance {
|
|
3149
3158
|
/**
|
|
@@ -3152,13 +3161,11 @@ export interface StackInstance {
|
|
|
3152
3161
|
*/
|
|
3153
3162
|
StackSetId?: string;
|
|
3154
3163
|
/**
|
|
3155
|
-
* <p>The name of the Region that the stack instance is associated
|
|
3156
|
-
* with.</p>
|
|
3164
|
+
* <p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>
|
|
3157
3165
|
*/
|
|
3158
3166
|
Region?: string;
|
|
3159
3167
|
/**
|
|
3160
|
-
* <p>[Self-managed permissions] The name of the account that the stack
|
|
3161
|
-
* instance is associated with.</p>
|
|
3168
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>
|
|
3162
3169
|
*/
|
|
3163
3170
|
Account?: string;
|
|
3164
3171
|
/**
|
|
@@ -3393,8 +3400,8 @@ export interface StackResourceDetail {
|
|
|
3393
3400
|
*/
|
|
3394
3401
|
PhysicalResourceId?: string;
|
|
3395
3402
|
/**
|
|
3396
|
-
* <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
|
|
3397
|
-
*
|
|
3403
|
+
* <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
|
|
3404
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
3398
3405
|
*/
|
|
3399
3406
|
ResourceType: string | undefined;
|
|
3400
3407
|
/**
|
|
@@ -3776,8 +3783,8 @@ export interface StackResource {
|
|
|
3776
3783
|
*/
|
|
3777
3784
|
PhysicalResourceId?: string;
|
|
3778
3785
|
/**
|
|
3779
|
-
* <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
|
|
3780
|
-
*
|
|
3786
|
+
* <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
|
|
3787
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
3781
3788
|
*/
|
|
3782
3789
|
ResourceType: string | undefined;
|
|
3783
3790
|
/**
|
|
@@ -3951,6 +3958,7 @@ export declare enum StackStatus {
|
|
|
3951
3958
|
ROLLBACK_IN_PROGRESS = "ROLLBACK_IN_PROGRESS",
|
|
3952
3959
|
UPDATE_COMPLETE = "UPDATE_COMPLETE",
|
|
3953
3960
|
UPDATE_COMPLETE_CLEANUP_IN_PROGRESS = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS",
|
|
3961
|
+
UPDATE_FAILED = "UPDATE_FAILED",
|
|
3954
3962
|
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
|
|
3955
3963
|
UPDATE_ROLLBACK_COMPLETE = "UPDATE_ROLLBACK_COMPLETE",
|
|
3956
3964
|
UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
|
|
@@ -4038,8 +4046,8 @@ export interface Stack {
|
|
|
4038
4046
|
*/
|
|
4039
4047
|
Outputs?: Output[];
|
|
4040
4048
|
/**
|
|
4041
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4042
|
-
* associated with the stack. During a stack operation, CloudFormation uses this
|
|
4049
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4050
|
+
* that is associated with the stack. During a stack operation, CloudFormation uses this
|
|
4043
4051
|
* role's credentials to make calls on your behalf.</p>
|
|
4044
4052
|
*/
|
|
4045
4053
|
RoleARN?: string;
|
|
@@ -4122,7 +4130,7 @@ export interface DescribeStackSetInput {
|
|
|
4122
4130
|
* <li>
|
|
4123
4131
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
4124
4132
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
4125
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
4133
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
4126
4134
|
* 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>
|
|
4127
4135
|
* </li>
|
|
4128
4136
|
* </ul>
|
|
@@ -4268,9 +4276,9 @@ export declare namespace StackSetDriftDetectionDetails {
|
|
|
4268
4276
|
export declare type StackSetStatus = "ACTIVE" | "DELETED";
|
|
4269
4277
|
/**
|
|
4270
4278
|
* <p>A structure that contains information about a stack set. A stack set enables you to
|
|
4271
|
-
* provision stacks into accounts and across Regions by using a single
|
|
4272
|
-
*
|
|
4273
|
-
*
|
|
4279
|
+
* provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation
|
|
4280
|
+
* template. In the stack set, you specify the template to use, as well as any parameters and
|
|
4281
|
+
* capabilities that the template requires. </p>
|
|
4274
4282
|
*/
|
|
4275
4283
|
export interface StackSet {
|
|
4276
4284
|
/**
|
|
@@ -4301,9 +4309,8 @@ export interface StackSet {
|
|
|
4301
4309
|
Parameters?: Parameter[];
|
|
4302
4310
|
/**
|
|
4303
4311
|
* <p>The capabilities that are allowed in the stack set. Some stack set templates might
|
|
4304
|
-
* include resources that can affect permissions in your account—for
|
|
4305
|
-
*
|
|
4306
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates.</a>
|
|
4312
|
+
* include resources that can affect permissions in your Amazon Web Services account—for example, by creating
|
|
4313
|
+
* 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>
|
|
4307
4314
|
* </p>
|
|
4308
4315
|
*/
|
|
4309
4316
|
Capabilities?: (Capability | string)[];
|
|
@@ -4406,7 +4413,7 @@ export interface DescribeStackSetOperationInput {
|
|
|
4406
4413
|
* <li>
|
|
4407
4414
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
4408
4415
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
4409
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
4416
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
4410
4417
|
* 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>
|
|
4411
4418
|
* </li>
|
|
4412
4419
|
* </ul>
|
|
@@ -4451,8 +4458,8 @@ export interface StackSetOperation {
|
|
|
4451
4458
|
* Region during stack create and update operations. If the number of failed stacks
|
|
4452
4459
|
* within a Region exceeds the failure tolerance, the status of the operation in the
|
|
4453
4460
|
* Region is set to <code>FAILED</code>. This in turn sets the status of the operation
|
|
4454
|
-
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation
|
|
4455
|
-
*
|
|
4461
|
+
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in
|
|
4462
|
+
* any remaining Regions.</p>
|
|
4456
4463
|
* </li>
|
|
4457
4464
|
* <li>
|
|
4458
4465
|
* <p>
|
|
@@ -4511,9 +4518,9 @@ export interface StackSetOperation {
|
|
|
4511
4518
|
/**
|
|
4512
4519
|
* <p>The time at which the operation was initiated. Note that the creation times for the
|
|
4513
4520
|
* stack set operation might differ from the creation time of the individual stacks
|
|
4514
|
-
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
4515
|
-
*
|
|
4516
|
-
*
|
|
4521
|
+
* themselves. This is because CloudFormation needs to perform preparatory work for the
|
|
4522
|
+
* operation, such as dispatching the work to the requested Regions, before actually creating
|
|
4523
|
+
* the first stacks.</p>
|
|
4517
4524
|
*/
|
|
4518
4525
|
CreationTimestamp?: Date;
|
|
4519
4526
|
/**
|
|
@@ -4982,7 +4989,7 @@ export declare namespace DescribeTypeRegistrationOutput {
|
|
|
4982
4989
|
}
|
|
4983
4990
|
export interface DetectStackDriftInput {
|
|
4984
4991
|
/**
|
|
4985
|
-
* <p>The name of the stack for which you want to detect drift
|
|
4992
|
+
* <p>The name of the stack for which you want to detect drift.</p>
|
|
4986
4993
|
*/
|
|
4987
4994
|
StackName: string | undefined;
|
|
4988
4995
|
/**
|
|
@@ -4998,10 +5005,10 @@ export declare namespace DetectStackDriftInput {
|
|
|
4998
5005
|
}
|
|
4999
5006
|
export interface DetectStackDriftOutput {
|
|
5000
5007
|
/**
|
|
5001
|
-
* <p>The ID of the drift detection results of this operation
|
|
5002
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
5003
|
-
*
|
|
5004
|
-
* long, may vary
|
|
5008
|
+
* <p>The ID of the drift detection results of this operation.</p>
|
|
5009
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
5010
|
+
* run. However, the number of drift results CloudFormation retains for any given stack, and for how
|
|
5011
|
+
* long, may vary.</p>
|
|
5005
5012
|
*/
|
|
5006
5013
|
StackDriftDetectionId: string | undefined;
|
|
5007
5014
|
}
|
|
@@ -5071,7 +5078,7 @@ export interface DetectStackSetDriftInput {
|
|
|
5071
5078
|
* <li>
|
|
5072
5079
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
5073
5080
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
5074
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
5081
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
5075
5082
|
* 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>
|
|
5076
5083
|
* </li>
|
|
5077
5084
|
* </ul>
|
|
@@ -5113,8 +5120,8 @@ export interface EstimateTemplateCostInput {
|
|
|
5113
5120
|
TemplateBody?: string;
|
|
5114
5121
|
/**
|
|
5115
5122
|
* <p>Location of file containing the template body. The URL must point to a template that
|
|
5116
|
-
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go
|
|
5117
|
-
*
|
|
5123
|
+
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to
|
|
5124
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
5118
5125
|
* in the CloudFormation User Guide.</p>
|
|
5119
5126
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
5120
5127
|
* both are passed, only <code>TemplateBody</code> is used.</p>
|
|
@@ -5136,8 +5143,8 @@ export declare namespace EstimateTemplateCostInput {
|
|
|
5136
5143
|
*/
|
|
5137
5144
|
export interface EstimateTemplateCostOutput {
|
|
5138
5145
|
/**
|
|
5139
|
-
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that
|
|
5140
|
-
*
|
|
5146
|
+
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources
|
|
5147
|
+
* required to run the template.</p>
|
|
5141
5148
|
*/
|
|
5142
5149
|
Url?: string;
|
|
5143
5150
|
}
|
|
@@ -5165,10 +5172,16 @@ export interface ExecuteChangeSetInput {
|
|
|
5165
5172
|
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this
|
|
5166
5173
|
* token if you plan to retry requests so that CloudFormation knows that you're not
|
|
5167
5174
|
* attempting to execute a change set to update a stack with the same name. You might retry
|
|
5168
|
-
*
|
|
5169
|
-
*
|
|
5175
|
+
* <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully
|
|
5176
|
+
* received them.</p>
|
|
5170
5177
|
*/
|
|
5171
5178
|
ClientRequestToken?: string;
|
|
5179
|
+
/**
|
|
5180
|
+
* <p>Preserves the state of previously provisioned resources when an operation fails.</p>
|
|
5181
|
+
* <p>Default: <code>True</code>
|
|
5182
|
+
* </p>
|
|
5183
|
+
*/
|
|
5184
|
+
DisableRollback?: boolean;
|
|
5172
5185
|
}
|
|
5173
5186
|
export declare namespace ExecuteChangeSetInput {
|
|
5174
5187
|
/**
|
|
@@ -5243,14 +5256,15 @@ export interface GetTemplateInput {
|
|
|
5243
5256
|
*/
|
|
5244
5257
|
StackName?: string;
|
|
5245
5258
|
/**
|
|
5246
|
-
* <p>The name or Amazon Resource Name (ARN) of a change set for which CloudFormation
|
|
5259
|
+
* <p>The name or Amazon Resource Name (ARN) of a change set for which CloudFormation
|
|
5260
|
+
* returns the associated template. If you specify a name, you must also specify the
|
|
5247
5261
|
* <code>StackName</code>.</p>
|
|
5248
5262
|
*/
|
|
5249
5263
|
ChangeSetName?: string;
|
|
5250
5264
|
/**
|
|
5251
5265
|
* <p>For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify
|
|
5252
5266
|
* <code>Original</code>. To get the template after CloudFormation has processed
|
|
5253
|
-
* all transforms, specify <code>Processed</code
|
|
5267
|
+
* all transforms, specify <code>Processed</code>.</p>
|
|
5254
5268
|
* <p>If the template doesn't include transforms, <code>Original</code> and
|
|
5255
5269
|
* <code>Processed</code> return the same template. By default, CloudFormation
|
|
5256
5270
|
* specifies <code>Processed</code>.</p>
|
|
@@ -5276,7 +5290,8 @@ export interface GetTemplateOutput {
|
|
|
5276
5290
|
/**
|
|
5277
5291
|
* <p>The stage of the template that you can retrieve. For stacks, the
|
|
5278
5292
|
* <code>Original</code> and <code>Processed</code> templates are always available. For
|
|
5279
|
-
* change sets, the <code>Original</code> template is always available. After
|
|
5293
|
+
* change sets, the <code>Original</code> template is always available. After
|
|
5294
|
+
* CloudFormation finishes creating the change set, the <code>Processed</code> template
|
|
5280
5295
|
* becomes available.</p>
|
|
5281
5296
|
*/
|
|
5282
5297
|
StagesAvailable?: (TemplateStage | string)[];
|
|
@@ -5338,7 +5353,7 @@ export interface GetTemplateSummaryInput {
|
|
|
5338
5353
|
* <li>
|
|
5339
5354
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
5340
5355
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
5341
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
5356
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
5342
5357
|
* 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>
|
|
5343
5358
|
* </li>
|
|
5344
5359
|
* </ul>
|
|
@@ -5352,9 +5367,9 @@ export declare namespace GetTemplateSummaryInput {
|
|
|
5352
5367
|
const filterSensitiveLog: (obj: GetTemplateSummaryInput) => any;
|
|
5353
5368
|
}
|
|
5354
5369
|
/**
|
|
5355
|
-
* <p>A set of criteria that CloudFormation uses to validate parameter values.
|
|
5356
|
-
*
|
|
5357
|
-
*
|
|
5370
|
+
* <p>A set of criteria that CloudFormation uses to validate parameter values. Although
|
|
5371
|
+
* other constraints might be defined in the stack template, CloudFormation returns only
|
|
5372
|
+
* the <code>AllowedValues</code> property.</p>
|
|
5358
5373
|
*/
|
|
5359
5374
|
export interface ParameterConstraints {
|
|
5360
5375
|
/**
|
|
@@ -5386,7 +5401,7 @@ export interface ParameterDeclaration {
|
|
|
5386
5401
|
ParameterType?: string;
|
|
5387
5402
|
/**
|
|
5388
5403
|
* <p>Flag that indicates whether the parameter value is shown as plain text in logs and in
|
|
5389
|
-
* the Management Console.</p>
|
|
5404
|
+
* the Amazon Web Services Management Console.</p>
|
|
5390
5405
|
*/
|
|
5391
5406
|
NoEcho?: boolean;
|
|
5392
5407
|
/**
|
|
@@ -5449,9 +5464,9 @@ export interface GetTemplateSummaryOutput {
|
|
|
5449
5464
|
Description?: string;
|
|
5450
5465
|
/**
|
|
5451
5466
|
* <p>The capabilities found within the template. If your template contains IAM resources,
|
|
5452
|
-
* you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when
|
|
5467
|
+
* you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when
|
|
5453
5468
|
* you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with
|
|
5454
|
-
* your template; otherwise, those actions return an InsufficientCapabilities error.</p>
|
|
5469
|
+
* your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p>
|
|
5455
5470
|
* <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>
|
|
5456
5471
|
*/
|
|
5457
5472
|
Capabilities?: (Capability | string)[];
|
|
@@ -5467,8 +5482,8 @@ export interface GetTemplateSummaryOutput {
|
|
|
5467
5482
|
*/
|
|
5468
5483
|
ResourceTypes?: string[];
|
|
5469
5484
|
/**
|
|
5470
|
-
* <p>The Amazon Web Services template format version, which identifies the capabilities of
|
|
5471
|
-
*
|
|
5485
|
+
* <p>The Amazon Web Services template format version, which identifies the capabilities of the
|
|
5486
|
+
* template.</p>
|
|
5472
5487
|
*/
|
|
5473
5488
|
Version?: string;
|
|
5474
5489
|
/**
|
|
@@ -5484,7 +5499,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
5484
5499
|
* <p>A list of resource identifier summaries that describe the target resources of an import
|
|
5485
5500
|
* operation and the properties you can provide during the import to identify the target
|
|
5486
5501
|
* resources. For example, <code>BucketName</code> is a possible identifier property for an
|
|
5487
|
-
* <code>AWS::S3::Bucket</code> resource
|
|
5502
|
+
* <code>AWS::S3::Bucket</code> resource.</p>
|
|
5488
5503
|
*/
|
|
5489
5504
|
ResourceIdentifierSummaries?: ResourceIdentifierSummary[];
|
|
5490
5505
|
}
|
|
@@ -5666,13 +5681,12 @@ export declare namespace ListExportsOutput {
|
|
|
5666
5681
|
export interface ListImportsInput {
|
|
5667
5682
|
/**
|
|
5668
5683
|
* <p>The name of the exported output value. CloudFormation returns the stack names
|
|
5669
|
-
* that are importing this value
|
|
5684
|
+
* that are importing this value.</p>
|
|
5670
5685
|
*/
|
|
5671
5686
|
ExportName: string | undefined;
|
|
5672
5687
|
/**
|
|
5673
|
-
* <p>A string (provided by the <a>ListImports</a> response output) that
|
|
5674
|
-
*
|
|
5675
|
-
* </p>
|
|
5688
|
+
* <p>A string (provided by the <a>ListImports</a> response output) that identifies
|
|
5689
|
+
* the next page of stacks that are importing the specified exported output value.</p>
|
|
5676
5690
|
*/
|
|
5677
5691
|
NextToken?: string;
|
|
5678
5692
|
}
|
|
@@ -5684,8 +5698,7 @@ export declare namespace ListImportsInput {
|
|
|
5684
5698
|
}
|
|
5685
5699
|
export interface ListImportsOutput {
|
|
5686
5700
|
/**
|
|
5687
|
-
* <p>A list of stack names that are importing the specified exported output value
|
|
5688
|
-
* </p>
|
|
5701
|
+
* <p>A list of stack names that are importing the specified exported output value.</p>
|
|
5689
5702
|
*/
|
|
5690
5703
|
Imports?: string[];
|
|
5691
5704
|
/**
|
|
@@ -5746,8 +5759,7 @@ export interface ListStackInstancesInput {
|
|
|
5746
5759
|
*/
|
|
5747
5760
|
Filters?: StackInstanceFilter[];
|
|
5748
5761
|
/**
|
|
5749
|
-
* <p>The name of the account that you want to list stack instances
|
|
5750
|
-
* for.</p>
|
|
5762
|
+
* <p>The name of the Amazon Web Services account that you want to list stack instances for.</p>
|
|
5751
5763
|
*/
|
|
5752
5764
|
StackInstanceAccount?: string;
|
|
5753
5765
|
/**
|
|
@@ -5767,7 +5779,7 @@ export interface ListStackInstancesInput {
|
|
|
5767
5779
|
* <li>
|
|
5768
5780
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
5769
5781
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
5770
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
5782
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
5771
5783
|
* 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>
|
|
5772
5784
|
* </li>
|
|
5773
5785
|
* </ul>
|
|
@@ -5790,13 +5802,11 @@ export interface StackInstanceSummary {
|
|
|
5790
5802
|
*/
|
|
5791
5803
|
StackSetId?: string;
|
|
5792
5804
|
/**
|
|
5793
|
-
* <p>The name of the Region that the stack instance is associated
|
|
5794
|
-
* with.</p>
|
|
5805
|
+
* <p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>
|
|
5795
5806
|
*/
|
|
5796
5807
|
Region?: string;
|
|
5797
5808
|
/**
|
|
5798
|
-
* <p>[Self-managed permissions] The name of the account that the stack
|
|
5799
|
-
* instance is associated with.</p>
|
|
5809
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>
|
|
5800
5810
|
*/
|
|
5801
5811
|
Account?: string;
|
|
5802
5812
|
/**
|
|
@@ -6009,8 +6019,8 @@ export interface StackResourceSummary {
|
|
|
6009
6019
|
*/
|
|
6010
6020
|
PhysicalResourceId?: string;
|
|
6011
6021
|
/**
|
|
6012
|
-
* <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
|
|
6013
|
-
*
|
|
6022
|
+
* <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
|
|
6023
|
+
* Resource Types Reference</a> in the CloudFormation User Guide.)</p>
|
|
6014
6024
|
*/
|
|
6015
6025
|
ResourceType: string | undefined;
|
|
6016
6026
|
/**
|
|
@@ -6257,7 +6267,7 @@ export interface ListStackSetOperationResultsInput {
|
|
|
6257
6267
|
* <li>
|
|
6258
6268
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
6259
6269
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
6260
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
6270
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
6261
6271
|
* 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>
|
|
6262
6272
|
* </li>
|
|
6263
6273
|
* </ul>
|
|
@@ -6277,12 +6287,11 @@ export declare type StackSetOperationResultStatus = "CANCELLED" | "FAILED" | "PE
|
|
|
6277
6287
|
*/
|
|
6278
6288
|
export interface StackSetOperationResultSummary {
|
|
6279
6289
|
/**
|
|
6280
|
-
* <p>[Self-managed permissions] The name of the account for this
|
|
6281
|
-
* operation result.</p>
|
|
6290
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account for this operation result.</p>
|
|
6282
6291
|
*/
|
|
6283
6292
|
Account?: string;
|
|
6284
6293
|
/**
|
|
6285
|
-
* <p>The name of the Region for this operation result.</p>
|
|
6294
|
+
* <p>The name of the Amazon Web Services Region for this operation result.</p>
|
|
6286
6295
|
*/
|
|
6287
6296
|
Region?: string;
|
|
6288
6297
|
/**
|
|
@@ -6397,7 +6406,7 @@ export interface ListStackSetOperationsInput {
|
|
|
6397
6406
|
* <li>
|
|
6398
6407
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
6399
6408
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
6400
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
6409
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
6401
6410
|
* 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>
|
|
6402
6411
|
* </li>
|
|
6403
6412
|
* </ul>
|
|
@@ -6437,8 +6446,8 @@ export interface StackSetOperationSummary {
|
|
|
6437
6446
|
* Region during stack create and update operations. If the number of failed stacks
|
|
6438
6447
|
* within a Region exceeds the failure tolerance, the status of the operation in the
|
|
6439
6448
|
* Region is set to <code>FAILED</code>. This in turn sets the status of the operation
|
|
6440
|
-
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation
|
|
6441
|
-
*
|
|
6449
|
+
* as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in
|
|
6450
|
+
* any remaining Regions.</p>
|
|
6442
6451
|
* </li>
|
|
6443
6452
|
* <li>
|
|
6444
6453
|
* <p>
|
|
@@ -6471,9 +6480,9 @@ export interface StackSetOperationSummary {
|
|
|
6471
6480
|
/**
|
|
6472
6481
|
* <p>The time at which the operation was initiated. Note that the creation times for the
|
|
6473
6482
|
* stack set operation might differ from the creation time of the individual stacks
|
|
6474
|
-
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
6475
|
-
*
|
|
6476
|
-
*
|
|
6483
|
+
* themselves. This is because CloudFormation needs to perform preparatory work for the
|
|
6484
|
+
* operation, such as dispatching the work to the requested Regions, before actually creating
|
|
6485
|
+
* the first stacks.</p>
|
|
6477
6486
|
*/
|
|
6478
6487
|
CreationTimestamp?: Date;
|
|
6479
6488
|
/**
|
|
@@ -6544,7 +6553,7 @@ export interface ListStackSetsInput {
|
|
|
6544
6553
|
* <li>
|
|
6545
6554
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
6546
6555
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
6547
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
6556
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
6548
6557
|
* 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>
|
|
6549
6558
|
* </li>
|
|
6550
6559
|
* </ul>
|
|
@@ -7475,6 +7484,38 @@ export declare namespace RegisterTypeOutput {
|
|
|
7475
7484
|
*/
|
|
7476
7485
|
const filterSensitiveLog: (obj: RegisterTypeOutput) => any;
|
|
7477
7486
|
}
|
|
7487
|
+
export interface RollbackStackInput {
|
|
7488
|
+
/**
|
|
7489
|
+
* <p>The name that is associated with the stack.</p>
|
|
7490
|
+
*/
|
|
7491
|
+
StackName: string | undefined;
|
|
7492
|
+
/**
|
|
7493
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.</p>
|
|
7494
|
+
*/
|
|
7495
|
+
RoleARN?: string;
|
|
7496
|
+
/**
|
|
7497
|
+
* <p>A unique identifier for this <code>RollbackStack</code> request.</p>
|
|
7498
|
+
*/
|
|
7499
|
+
ClientRequestToken?: string;
|
|
7500
|
+
}
|
|
7501
|
+
export declare namespace RollbackStackInput {
|
|
7502
|
+
/**
|
|
7503
|
+
* @internal
|
|
7504
|
+
*/
|
|
7505
|
+
const filterSensitiveLog: (obj: RollbackStackInput) => any;
|
|
7506
|
+
}
|
|
7507
|
+
export interface RollbackStackOutput {
|
|
7508
|
+
/**
|
|
7509
|
+
* <p>Unique identifier of the stack.</p>
|
|
7510
|
+
*/
|
|
7511
|
+
StackId?: string;
|
|
7512
|
+
}
|
|
7513
|
+
export declare namespace RollbackStackOutput {
|
|
7514
|
+
/**
|
|
7515
|
+
* @internal
|
|
7516
|
+
*/
|
|
7517
|
+
const filterSensitiveLog: (obj: RollbackStackOutput) => any;
|
|
7518
|
+
}
|
|
7478
7519
|
/**
|
|
7479
7520
|
* <p>The input for the <a>SetStackPolicy</a> action.</p>
|
|
7480
7521
|
*/
|
|
@@ -7485,16 +7526,16 @@ export interface SetStackPolicyInput {
|
|
|
7485
7526
|
StackName: string | undefined;
|
|
7486
7527
|
/**
|
|
7487
7528
|
* <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
|
|
7488
|
-
* to Stack Resources</a> in the CloudFormation User Guide. You can specify
|
|
7489
|
-
*
|
|
7490
|
-
*
|
|
7529
|
+
* to Stack Resources</a> in the CloudFormation User Guide. You can specify either
|
|
7530
|
+
* the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
7531
|
+
* both.</p>
|
|
7491
7532
|
*/
|
|
7492
7533
|
StackPolicyBody?: string;
|
|
7493
7534
|
/**
|
|
7494
7535
|
* <p>Location of a file containing the stack policy. The URL must point to a policy
|
|
7495
|
-
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
7496
|
-
* specify either the <code>StackPolicyBody</code> or the
|
|
7497
|
-
*
|
|
7536
|
+
* (maximum size: 16 KB) located in an S3 bucket in the same
|
|
7537
|
+
* Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
7538
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7498
7539
|
*/
|
|
7499
7540
|
StackPolicyURL?: string;
|
|
7500
7541
|
}
|
|
@@ -7628,7 +7669,7 @@ export interface SignalResourceInput {
|
|
|
7628
7669
|
UniqueId: string | undefined;
|
|
7629
7670
|
/**
|
|
7630
7671
|
* <p>The status of the signal, which is either success or failure. A failure signal causes
|
|
7631
|
-
*
|
|
7672
|
+
* CloudFormation to immediately fail the stack creation or update.</p>
|
|
7632
7673
|
*/
|
|
7633
7674
|
Status: ResourceSignalStatus | string | undefined;
|
|
7634
7675
|
}
|
|
@@ -7661,7 +7702,7 @@ export interface StopStackSetOperationInput {
|
|
|
7661
7702
|
* <li>
|
|
7662
7703
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
7663
7704
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
7664
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
7705
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
7665
7706
|
* 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>
|
|
7666
7707
|
* </li>
|
|
7667
7708
|
* </ul>
|
|
@@ -7767,8 +7808,8 @@ export interface UpdateStackInput {
|
|
|
7767
7808
|
TemplateBody?: string;
|
|
7768
7809
|
/**
|
|
7769
7810
|
* <p>Location of file containing the template body. The URL must point to a template that
|
|
7770
|
-
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go
|
|
7771
|
-
*
|
|
7811
|
+
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to
|
|
7812
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
7772
7813
|
* in the CloudFormation User Guide.</p>
|
|
7773
7814
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
7774
7815
|
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
|
@@ -7794,9 +7835,10 @@ export interface UpdateStackInput {
|
|
|
7794
7835
|
StackPolicyDuringUpdateBody?: string;
|
|
7795
7836
|
/**
|
|
7796
7837
|
* <p>Location of a file containing the temporary overriding stack policy. The URL must
|
|
7797
|
-
* point to a policy (max size: 16KB) located in an S3 bucket in
|
|
7798
|
-
* You can specify either the
|
|
7799
|
-
* <code>
|
|
7838
|
+
* point to a policy (max size: 16KB) located in an S3 bucket in
|
|
7839
|
+
* the same Region as the stack. You can specify either the
|
|
7840
|
+
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code>
|
|
7841
|
+
* parameter, but not both.</p>
|
|
7800
7842
|
* <p>If you want to update protected resources, specify a temporary overriding stack
|
|
7801
7843
|
* policy during this update. If you do not specify a stack policy, the current policy that is
|
|
7802
7844
|
* associated with the stack will be used.</p>
|
|
@@ -7817,7 +7859,7 @@ export interface UpdateStackInput {
|
|
|
7817
7859
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
7818
7860
|
* </p>
|
|
7819
7861
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
7820
|
-
* your account; for example, by creating new Identity and Access Management
|
|
7862
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
7821
7863
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
7822
7864
|
* of these capabilities.</p>
|
|
7823
7865
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -7825,11 +7867,11 @@ export interface UpdateStackInput {
|
|
|
7825
7867
|
* capability.</p>
|
|
7826
7868
|
* <ul>
|
|
7827
7869
|
* <li>
|
|
7828
|
-
* <p>If you have IAM resources, you can specify either capability
|
|
7870
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
7829
7871
|
* </li>
|
|
7830
7872
|
* <li>
|
|
7831
7873
|
* <p>If you have IAM resources with custom names, you <i>must</i>
|
|
7832
|
-
* specify <code>CAPABILITY_NAMED_IAM</code
|
|
7874
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
7833
7875
|
* </li>
|
|
7834
7876
|
* <li>
|
|
7835
7877
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -7919,20 +7961,19 @@ export interface UpdateStackInput {
|
|
|
7919
7961
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
7920
7962
|
* <p>If the list of resource types doesn't include a resource that you're updating, the
|
|
7921
7963
|
* stack update fails. By default, CloudFormation grants permissions to all resource
|
|
7922
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
7923
|
-
* 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
|
|
7924
|
-
* Identity and Access Management</a>.</p>
|
|
7964
|
+
* 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>
|
|
7925
7965
|
*/
|
|
7926
7966
|
ResourceTypes?: string[];
|
|
7927
7967
|
/**
|
|
7928
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
7929
|
-
*
|
|
7930
|
-
*
|
|
7931
|
-
*
|
|
7932
|
-
*
|
|
7933
|
-
*
|
|
7934
|
-
*
|
|
7935
|
-
*
|
|
7968
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
7969
|
+
* that CloudFormation assumes to update the stack. CloudFormation uses the role's
|
|
7970
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for all
|
|
7971
|
+
* future operations on the stack. As long as users have permission to operate on the stack,
|
|
7972
|
+
* CloudFormation uses this role even if the users don't have permission to pass it.
|
|
7973
|
+
* Ensure that the role grants least privilege.</p>
|
|
7974
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
7975
|
+
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
7976
|
+
* session that is generated from your user credentials.</p>
|
|
7936
7977
|
*/
|
|
7937
7978
|
RoleARN?: string;
|
|
7938
7979
|
/**
|
|
@@ -7951,44 +7992,51 @@ export interface UpdateStackInput {
|
|
|
7951
7992
|
StackPolicyBody?: string;
|
|
7952
7993
|
/**
|
|
7953
7994
|
* <p>Location of a file containing the updated stack policy. The URL must point to a
|
|
7954
|
-
* policy (max size: 16KB) located in an S3 bucket in the same
|
|
7955
|
-
* specify either the <code>StackPolicyBody</code> or the
|
|
7956
|
-
*
|
|
7995
|
+
* policy (max size: 16KB) located in an S3 bucket in the same
|
|
7996
|
+
* Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
7997
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7957
7998
|
* <p>You might update the stack policy, for example, in order to protect a new resource
|
|
7958
7999
|
* that you created during a stack update. If you do not specify a stack policy, the current
|
|
7959
8000
|
* policy that is associated with the stack is unchanged.</p>
|
|
7960
8001
|
*/
|
|
7961
8002
|
StackPolicyURL?: string;
|
|
7962
8003
|
/**
|
|
7963
|
-
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
|
|
7964
|
-
* notification
|
|
8004
|
+
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
|
|
8005
|
+
* CloudFormation associates with the stack. Specify an empty list to remove all notification
|
|
8006
|
+
* topics.</p>
|
|
7965
8007
|
*/
|
|
7966
8008
|
NotificationARNs?: string[];
|
|
7967
8009
|
/**
|
|
7968
8010
|
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates
|
|
7969
8011
|
* these tags to supported resources in the stack. You can specify a maximum number of 50
|
|
7970
8012
|
* tags.</p>
|
|
7971
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the
|
|
7972
|
-
*
|
|
8013
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
|
8014
|
+
* tags. If you specify an empty value, CloudFormation removes all associated
|
|
7973
8015
|
* tags.</p>
|
|
7974
8016
|
*/
|
|
7975
8017
|
Tags?: Tag[];
|
|
8018
|
+
/**
|
|
8019
|
+
* <p>Preserve the state of previously provisioned resources when an operation fails.</p>
|
|
8020
|
+
* <p>Default: <code>False</code>
|
|
8021
|
+
* </p>
|
|
8022
|
+
*/
|
|
8023
|
+
DisableRollback?: boolean;
|
|
7976
8024
|
/**
|
|
7977
8025
|
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if
|
|
7978
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
7979
|
-
*
|
|
8026
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
8027
|
+
* update a stack with the same name. You might retry <code>UpdateStack</code> requests to
|
|
7980
8028
|
* ensure that CloudFormation successfully received them.</p>
|
|
7981
8029
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
7982
8030
|
* token, which you can use to track operations. For example, if you execute a
|
|
7983
|
-
*
|
|
7984
|
-
*
|
|
7985
|
-
*
|
|
8031
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
8032
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
8033
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
7986
8034
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
7987
8035
|
* Stack operations that are initiated from the console use the token format
|
|
7988
8036
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
7989
8037
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
7990
8038
|
* would be assigned the same token in the following format:
|
|
7991
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
8039
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
7992
8040
|
*/
|
|
7993
8041
|
ClientRequestToken?: string;
|
|
7994
8042
|
}
|
|
@@ -8019,12 +8067,10 @@ export interface UpdateStackInstancesInput {
|
|
|
8019
8067
|
*/
|
|
8020
8068
|
StackSetName: string | undefined;
|
|
8021
8069
|
/**
|
|
8022
|
-
* <p>[Self-managed permissions] The names of one or more accounts for
|
|
8023
|
-
*
|
|
8024
|
-
*
|
|
8025
|
-
*
|
|
8026
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
8027
|
-
* both.</p>
|
|
8070
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values
|
|
8071
|
+
* for stack instances. The overridden parameter values will be applied to all stack instances
|
|
8072
|
+
* in the specified accounts and Regions.</p>
|
|
8073
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
|
|
8028
8074
|
*/
|
|
8029
8075
|
Accounts?: string[];
|
|
8030
8076
|
/**
|
|
@@ -8056,10 +8102,9 @@ export interface UpdateStackInstancesInput {
|
|
|
8056
8102
|
* specify its value.</p>
|
|
8057
8103
|
* </li>
|
|
8058
8104
|
* <li>
|
|
8059
|
-
* <p>To leave an overridden parameter set to its present value, include the
|
|
8060
|
-
*
|
|
8061
|
-
*
|
|
8062
|
-
* <code>true</code>.)</p>
|
|
8105
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as
|
|
8106
|
+
* <code>true</code>. (You cannot specify both a value and set
|
|
8107
|
+
* <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
8063
8108
|
* </li>
|
|
8064
8109
|
* <li>
|
|
8065
8110
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
@@ -8082,14 +8127,15 @@ export interface UpdateStackInstancesInput {
|
|
|
8082
8127
|
*/
|
|
8083
8128
|
ParameterOverrides?: Parameter[];
|
|
8084
8129
|
/**
|
|
8085
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
8086
|
-
* operation.</p>
|
|
8130
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
8087
8131
|
*/
|
|
8088
8132
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8089
8133
|
/**
|
|
8090
8134
|
* <p>The unique identifier for this stack set operation. </p>
|
|
8091
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
8092
|
-
*
|
|
8135
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
8136
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
8137
|
+
* multiple times. You might retry stack set operation requests to ensure that
|
|
8138
|
+
* CloudFormation successfully received them.</p>
|
|
8093
8139
|
* <p>If you don't specify an operation ID, the SDK generates one automatically.
|
|
8094
8140
|
* </p>
|
|
8095
8141
|
*/
|
|
@@ -8107,7 +8153,7 @@ export interface UpdateStackInstancesInput {
|
|
|
8107
8153
|
* <li>
|
|
8108
8154
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
8109
8155
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
8110
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
8156
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
8111
8157
|
* 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>
|
|
8112
8158
|
* </li>
|
|
8113
8159
|
* </ul>
|
|
@@ -8182,7 +8228,7 @@ export interface UpdateStackSetInput {
|
|
|
8182
8228
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
8183
8229
|
* </p>
|
|
8184
8230
|
* <p>Some stack templates might include resources that can affect permissions in
|
|
8185
|
-
* your account; for example, by creating new Identity and Access Management
|
|
8231
|
+
* your Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
8186
8232
|
* (IAM) users. For those stacks sets, you must explicitly acknowledge this by
|
|
8187
8233
|
* specifying one of these capabilities.</p>
|
|
8188
8234
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -8271,8 +8317,8 @@ export interface UpdateStackSetInput {
|
|
|
8271
8317
|
Capabilities?: (Capability | string)[];
|
|
8272
8318
|
/**
|
|
8273
8319
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
8274
|
-
*
|
|
8275
|
-
*
|
|
8320
|
+
* CloudFormation also propagates these tags to supported resources that are created in
|
|
8321
|
+
* the stacks. You can specify a maximum number of 50 tags.</p>
|
|
8276
8322
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are
|
|
8277
8323
|
* currently associated with this stack set. This means:</p>
|
|
8278
8324
|
* <ul>
|
|
@@ -8293,17 +8339,17 @@ export interface UpdateStackSetInput {
|
|
|
8293
8339
|
* associated tags.</p>
|
|
8294
8340
|
* </li>
|
|
8295
8341
|
* </ul>
|
|
8296
|
-
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action,
|
|
8297
|
-
*
|
|
8298
|
-
*
|
|
8299
|
-
*
|
|
8342
|
+
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action,
|
|
8343
|
+
* CloudFormation checks to see if you have the required IAM permission to tag resources. If
|
|
8344
|
+
* you omit tags that are currently associated with the stack set from the list of tags you
|
|
8345
|
+
* specify, CloudFormation assumes that you want to remove those tags from the stack set,
|
|
8346
|
+
* and checks to see if you have permission to untag resources. If you don't have the
|
|
8300
8347
|
* necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an
|
|
8301
8348
|
* <code>access denied</code> error, and the stack set is not updated.</p>
|
|
8302
8349
|
*/
|
|
8303
8350
|
Tags?: Tag[];
|
|
8304
8351
|
/**
|
|
8305
|
-
* <p>Preferences for how CloudFormation performs this stack set
|
|
8306
|
-
* operation.</p>
|
|
8352
|
+
* <p>Preferences for how CloudFormation performs this stack set operation.</p>
|
|
8307
8353
|
*/
|
|
8308
8354
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8309
8355
|
/**
|
|
@@ -8374,8 +8420,10 @@ export interface UpdateStackSetInput {
|
|
|
8374
8420
|
AutoDeployment?: AutoDeployment;
|
|
8375
8421
|
/**
|
|
8376
8422
|
* <p>The unique ID for this stack set operation. </p>
|
|
8377
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
8378
|
-
*
|
|
8423
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
8424
|
+
* CloudFormation performs the stack set operation only once, even if you retry the request
|
|
8425
|
+
* multiple times. You might retry stack set operation requests to ensure that
|
|
8426
|
+
* CloudFormation successfully received them.</p>
|
|
8379
8427
|
* <p>If you don't specify an operation ID, CloudFormation generates one
|
|
8380
8428
|
* automatically.</p>
|
|
8381
8429
|
* <p>Repeating this stack set operation with a new operation ID retries all stack
|
|
@@ -8424,7 +8472,7 @@ export interface UpdateStackSetInput {
|
|
|
8424
8472
|
* <li>
|
|
8425
8473
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
8426
8474
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
8427
|
-
* <p>Your account must be registered as a delegated administrator in
|
|
8475
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
8428
8476
|
* 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>
|
|
8429
8477
|
* </li>
|
|
8430
8478
|
* </ul>
|