@aws-sdk/client-cloudformation 3.42.0 → 3.43.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 +11 -0
- package/README.md +11 -11
- package/dist-cjs/models/models_0.js +10 -4
- package/dist-cjs/protocols/Aws_query.js +48 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_query.js +51 -0
- package/dist-types/CloudFormation.d.ts +114 -117
- package/dist-types/CloudFormationClient.d.ts +11 -11
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -2
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +5 -6
- package/dist-types/commands/CreateChangeSetCommand.d.ts +8 -7
- package/dist-types/commands/CreateStackCommand.d.ts +2 -2
- package/dist-types/commands/CreateStackInstancesCommand.d.ts +3 -1
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeStackInstanceCommand.d.ts +1 -2
- package/dist-types/commands/DescribeStackResourceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeStackResourcesCommand.d.ts +8 -9
- package/dist-types/commands/DescribeStacksCommand.d.ts +3 -4
- package/dist-types/commands/DetectStackDriftCommand.d.ts +6 -6
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +2 -2
- package/dist-types/commands/EstimateTemplateCostCommand.d.ts +2 -3
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +2 -2
- package/dist-types/commands/GetStackPolicyCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +4 -4
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +2 -2
- package/dist-types/commands/ImportStacksToStackSetCommand.d.ts +6 -8
- package/dist-types/commands/ListChangeSetsCommand.d.ts +1 -2
- package/dist-types/commands/ListStackInstancesCommand.d.ts +2 -3
- package/dist-types/commands/ListStackSetsCommand.d.ts +1 -2
- package/dist-types/commands/RollbackStackCommand.d.ts +8 -3
- package/dist-types/commands/SignalResourceCommand.d.ts +3 -4
- package/dist-types/commands/UpdateStackCommand.d.ts +4 -4
- package/dist-types/commands/UpdateStackInstancesCommand.d.ts +6 -6
- package/dist-types/commands/UpdateStackSetCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +2 -2
- package/dist-types/commands/ValidateTemplateCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +657 -635
- package/dist-types/ts3.4/models/models_0.d.ts +22 -1
- package/package.json +2 -2
|
@@ -3,9 +3,9 @@ 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 Lambda
|
|
7
|
-
*
|
|
8
|
-
*
|
|
6
|
+
* <p>For each account and Region, CloudFormation lets you specify a Lambda function
|
|
7
|
+
* that encapsulates any requirements that must be met before CloudFormation can
|
|
8
|
+
* 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
|
|
@@ -19,17 +19,15 @@ export interface AccountGateResult {
|
|
|
19
19
|
* <ul>
|
|
20
20
|
* <li>
|
|
21
21
|
* <p>
|
|
22
|
-
* <code>SUCCEEDED</code>: The account gate function has determined that the
|
|
23
|
-
*
|
|
24
|
-
* CloudFormation proceeds with the stack operation in that account and Region.
|
|
22
|
+
* <code>SUCCEEDED</code>: The account gate function has determined that the account
|
|
23
|
+
* and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region.
|
|
25
24
|
* </p>
|
|
26
25
|
* </li>
|
|
27
26
|
* <li>
|
|
28
27
|
* <p>
|
|
29
|
-
* <code>FAILED</code>: The account gate function has determined that the account
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* the stack set operation result status for that account and Region to
|
|
28
|
+
* <code>FAILED</code>: The account gate function has determined that the account and
|
|
29
|
+
* Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and
|
|
30
|
+
* sets the stack set operation result status for that account and Region to
|
|
33
31
|
* <code>FAILED</code>. </p>
|
|
34
32
|
* </li>
|
|
35
33
|
* <li>
|
|
@@ -38,19 +36,18 @@ export interface AccountGateResult {
|
|
|
38
36
|
* function for this account and Region, for one of the following reasons:</p>
|
|
39
37
|
* <ul>
|
|
40
38
|
* <li>
|
|
41
|
-
* <p>An account gate function has not been specified for the account and
|
|
42
|
-
*
|
|
43
|
-
*
|
|
39
|
+
* <p>An account gate function has not been specified for the account and Region.
|
|
40
|
+
* CloudFormation proceeds with the stack set operation in this account
|
|
41
|
+
* and Region.</p>
|
|
44
42
|
* </li>
|
|
45
43
|
* <li>
|
|
46
44
|
* <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set
|
|
47
|
-
* adminstration account lacks permissions to invoke the function.
|
|
48
|
-
* CloudFormation proceeds with the stack set operation in this account and
|
|
45
|
+
* adminstration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and
|
|
49
46
|
* Region.</p>
|
|
50
47
|
* </li>
|
|
51
48
|
* <li>
|
|
52
49
|
* <p>Either no action is necessary, or no action is possible, on the stack.
|
|
53
|
-
*
|
|
50
|
+
* CloudFormation skips the stack set operation in this account and
|
|
54
51
|
* Region.</p>
|
|
55
52
|
* </li>
|
|
56
53
|
* </ul>
|
|
@@ -59,8 +56,8 @@ export interface AccountGateResult {
|
|
|
59
56
|
*/
|
|
60
57
|
Status?: AccountGateStatus | string;
|
|
61
58
|
/**
|
|
62
|
-
* <p>The reason for the account gate status assigned to this account and Region for the
|
|
63
|
-
*
|
|
59
|
+
* <p>The reason for the account gate status assigned to this account and Region for the stack
|
|
60
|
+
* set operation.</p>
|
|
64
61
|
*/
|
|
65
62
|
StatusReason?: string;
|
|
66
63
|
}
|
|
@@ -471,11 +468,11 @@ export interface CancelUpdateStackInput {
|
|
|
471
468
|
*/
|
|
472
469
|
StackName: string | undefined;
|
|
473
470
|
/**
|
|
474
|
-
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this
|
|
475
|
-
*
|
|
471
|
+
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token
|
|
472
|
+
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
476
473
|
* attempting to cancel an update on a stack with the same name. You might retry
|
|
477
|
-
*
|
|
478
|
-
* received them.</p>
|
|
474
|
+
* <code>CancelUpdateStack</code> requests to ensure that CloudFormation
|
|
475
|
+
* successfully received them.</p>
|
|
479
476
|
*/
|
|
480
477
|
ClientRequestToken?: string;
|
|
481
478
|
}
|
|
@@ -573,21 +570,19 @@ export declare namespace ResourceTargetDefinition {
|
|
|
573
570
|
const filterSensitiveLog: (obj: ResourceTargetDefinition) => any;
|
|
574
571
|
}
|
|
575
572
|
/**
|
|
576
|
-
* <p>For a resource with <code>Modify</code> as the action, the
|
|
577
|
-
*
|
|
578
|
-
* to that resource.</p>
|
|
573
|
+
* <p>For a resource with <code>Modify</code> as the action, the <code>ResourceChange</code>
|
|
574
|
+
* structure describes the changes CloudFormation will make to that resource.</p>
|
|
579
575
|
*/
|
|
580
576
|
export interface ResourceChangeDetail {
|
|
581
577
|
/**
|
|
582
|
-
* <p>A <code>ResourceTargetDefinition</code> structure that describes the field that
|
|
583
|
-
* CloudFormation will change and whether the resource will be recreated.</p>
|
|
578
|
+
* <p>A <code>ResourceTargetDefinition</code> structure that describes the field that CloudFormation will change and whether the resource will be recreated.</p>
|
|
584
579
|
*/
|
|
585
580
|
Target?: ResourceTargetDefinition;
|
|
586
581
|
/**
|
|
587
582
|
* <p>Indicates whether CloudFormation can determine the target value, and whether the
|
|
588
583
|
* target value will change before you execute a change set.</p>
|
|
589
|
-
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the
|
|
590
|
-
* value will change, and its value. For example, if you directly modify the
|
|
584
|
+
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the
|
|
585
|
+
* target value will change, and its value. For example, if you directly modify the
|
|
591
586
|
* <code>InstanceType</code> property of an EC2 instance, CloudFormation knows that
|
|
592
587
|
* this property value will change, and its value, so this is a <code>Static</code>
|
|
593
588
|
* evaluation.</p>
|
|
@@ -601,8 +596,8 @@ export interface ResourceChangeDetail {
|
|
|
601
596
|
*/
|
|
602
597
|
Evaluation?: EvaluationType | string;
|
|
603
598
|
/**
|
|
604
|
-
* <p>The group to which the <code>CausingEntity</code> value belongs. There are five
|
|
605
|
-
*
|
|
599
|
+
* <p>The group to which the <code>CausingEntity</code> value belongs. There are five entity
|
|
600
|
+
* groups:</p>
|
|
606
601
|
* <ul>
|
|
607
602
|
* <li>
|
|
608
603
|
* <p>
|
|
@@ -634,7 +629,7 @@ export interface ResourceChangeDetail {
|
|
|
634
629
|
* <code>AWS::CloudFormation::Stack</code> resource, CloudFormation sets the
|
|
635
630
|
* <code>ChangeSource</code> to <code>Automatic</code> because the nested stack's
|
|
636
631
|
* template might have changed. Changes to a nested stack's template aren't visible to
|
|
637
|
-
*
|
|
632
|
+
* CloudFormation until you run an update on the parent stack.</p>
|
|
638
633
|
* </li>
|
|
639
634
|
* </ul>
|
|
640
635
|
*/
|
|
@@ -645,8 +640,8 @@ export interface ResourceChangeDetail {
|
|
|
645
640
|
* modified the value of the <code>KeyPairName</code> parameter, the
|
|
646
641
|
* <code>CausingEntity</code> is the name of the parameter
|
|
647
642
|
* (<code>KeyPairName</code>).</p>
|
|
648
|
-
* <p>If the <code>ChangeSource</code> value is <code>DirectModification</code>, no value
|
|
649
|
-
*
|
|
643
|
+
* <p>If the <code>ChangeSource</code> value is <code>DirectModification</code>, no value is
|
|
644
|
+
* given for <code>CausingEntity</code>.</p>
|
|
650
645
|
*/
|
|
651
646
|
CausingEntity?: string;
|
|
652
647
|
}
|
|
@@ -704,7 +699,7 @@ export declare enum Replacement {
|
|
|
704
699
|
}
|
|
705
700
|
/**
|
|
706
701
|
* <p>The <code>ResourceChange</code> structure describes the resource and the action that
|
|
707
|
-
*
|
|
702
|
+
* CloudFormation will perform on it if you execute this change set.</p>
|
|
708
703
|
*/
|
|
709
704
|
export interface ResourceChange {
|
|
710
705
|
/**
|
|
@@ -729,17 +724,17 @@ export interface ResourceChange {
|
|
|
729
724
|
*/
|
|
730
725
|
ResourceType?: string;
|
|
731
726
|
/**
|
|
732
|
-
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will
|
|
733
|
-
* the resource by creating a new one and deleting the old one. This value depends on
|
|
734
|
-
* value of the <code>RequiresRecreation</code> property in the
|
|
727
|
+
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will
|
|
728
|
+
* replace the resource by creating a new one and deleting the old one. This value depends on
|
|
729
|
+
* the value of the <code>RequiresRecreation</code> property in the
|
|
735
730
|
* <code>ResourceTargetDefinition</code> structure. For example, if the
|
|
736
731
|
* <code>RequiresRecreation</code> field is <code>Always</code> and the
|
|
737
732
|
* <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is
|
|
738
733
|
* <code>True</code>. If the <code>RequiresRecreation</code> field is <code>Always</code>
|
|
739
734
|
* and the <code>Evaluation</code> field is <code>Dynamic</code>, <code>Replacement</code> is
|
|
740
735
|
* <code>Conditionally</code>.</p>
|
|
741
|
-
* <p>If you have multiple changes with different <code>RequiresRecreation</code> values,
|
|
742
|
-
*
|
|
736
|
+
* <p>If you have multiple changes with different <code>RequiresRecreation</code> values, the
|
|
737
|
+
* <code>Replacement</code> value depends on the change with the most impact. A
|
|
743
738
|
* <code>RequiresRecreation</code> value of <code>Always</code> has the most impact,
|
|
744
739
|
* followed by <code>Conditionally</code>, and then <code>Never</code>.</p>
|
|
745
740
|
*/
|
|
@@ -752,8 +747,8 @@ export interface ResourceChange {
|
|
|
752
747
|
Scope?: (ResourceAttribute | string)[];
|
|
753
748
|
/**
|
|
754
749
|
* <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
|
-
*
|
|
750
|
+
* structures that describes the changes that CloudFormation will make to the
|
|
751
|
+
* resource. </p>
|
|
757
752
|
*/
|
|
758
753
|
Details?: ResourceChangeDetail[];
|
|
759
754
|
/**
|
|
@@ -787,7 +782,7 @@ export interface Change {
|
|
|
787
782
|
Type?: ChangeType | string;
|
|
788
783
|
/**
|
|
789
784
|
* <p>A <code>ResourceChange</code> structure that describes the resource and action that
|
|
790
|
-
*
|
|
785
|
+
* CloudFormation will perform.</p>
|
|
791
786
|
*/
|
|
792
787
|
ResourceChange?: ResourceChange;
|
|
793
788
|
}
|
|
@@ -798,8 +793,8 @@ export declare namespace Change {
|
|
|
798
793
|
const filterSensitiveLog: (obj: Change) => any;
|
|
799
794
|
}
|
|
800
795
|
/**
|
|
801
|
-
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a
|
|
802
|
-
*
|
|
796
|
+
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack,
|
|
797
|
+
* use the <code>ListChangeSets</code> action.</p>
|
|
803
798
|
*/
|
|
804
799
|
export interface ChangeSetNotFoundException extends __SmithyException, $MetadataBearer {
|
|
805
800
|
name: "ChangeSetNotFoundException";
|
|
@@ -831,8 +826,8 @@ export declare enum ExecutionStatus {
|
|
|
831
826
|
UNAVAILABLE = "UNAVAILABLE"
|
|
832
827
|
}
|
|
833
828
|
/**
|
|
834
|
-
* <p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and
|
|
835
|
-
*
|
|
829
|
+
* <p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and the
|
|
830
|
+
* stack with which it's associated.</p>
|
|
836
831
|
*/
|
|
837
832
|
export interface ChangeSetSummary {
|
|
838
833
|
/**
|
|
@@ -852,10 +847,10 @@ export interface ChangeSetSummary {
|
|
|
852
847
|
*/
|
|
853
848
|
ChangeSetName?: string;
|
|
854
849
|
/**
|
|
855
|
-
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the
|
|
856
|
-
*
|
|
857
|
-
*
|
|
858
|
-
*
|
|
850
|
+
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
851
|
+
* set. If you can’t execute the change set, the status indicates why. For example, a change
|
|
852
|
+
* set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still
|
|
853
|
+
* creating it or in an <code>OBSOLETE</code> state because the stack was already
|
|
859
854
|
* updated.</p>
|
|
860
855
|
*/
|
|
861
856
|
ExecutionStatus?: ExecutionStatus | string;
|
|
@@ -907,8 +902,7 @@ export declare enum ChangeSetType {
|
|
|
907
902
|
*/
|
|
908
903
|
export interface ContinueUpdateRollbackInput {
|
|
909
904
|
/**
|
|
910
|
-
* <p>The name or the unique ID of the stack that you want to continue rolling
|
|
911
|
-
* back.</p>
|
|
905
|
+
* <p>The name or the unique ID of the stack that you want to continue rolling back.</p>
|
|
912
906
|
* <note>
|
|
913
907
|
* <p>Don't specify the name of a nested stack (a stack that was created by using the
|
|
914
908
|
* <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the
|
|
@@ -918,12 +912,11 @@ export interface ContinueUpdateRollbackInput {
|
|
|
918
912
|
*/
|
|
919
913
|
StackName: string | undefined;
|
|
920
914
|
/**
|
|
921
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
922
|
-
*
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
* Ensure that the role grants least privilege.</p>
|
|
915
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's
|
|
916
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for
|
|
917
|
+
* all future operations on the stack. As long as users have permission to operate on the
|
|
918
|
+
* stack, CloudFormation uses this role even if the users don't have permission to
|
|
919
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
|
927
920
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
928
921
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
929
922
|
* session that is generated from your user credentials.</p>
|
|
@@ -962,10 +955,10 @@ export interface ContinueUpdateRollbackInput {
|
|
|
962
955
|
*/
|
|
963
956
|
ResourcesToSkip?: string[];
|
|
964
957
|
/**
|
|
965
|
-
* <p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify
|
|
966
|
-
*
|
|
958
|
+
* <p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this
|
|
959
|
+
* token if you plan to retry requests so that CloudFormationknows that you're not
|
|
967
960
|
* attempting to continue the rollback to a stack with the same name. You might retry
|
|
968
|
-
*
|
|
961
|
+
* <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation
|
|
969
962
|
* successfully received them.</p>
|
|
970
963
|
*/
|
|
971
964
|
ClientRequestToken?: string;
|
|
@@ -993,8 +986,8 @@ export declare namespace ContinueUpdateRollbackOutput {
|
|
|
993
986
|
export interface Parameter {
|
|
994
987
|
/**
|
|
995
988
|
* <p>The key associated with the parameter. If you don't specify a key and value for a
|
|
996
|
-
* particular parameter, CloudFormation uses the default value that is specified in
|
|
997
|
-
* template.</p>
|
|
989
|
+
* particular parameter, CloudFormation uses the default value that is specified in
|
|
990
|
+
* your template.</p>
|
|
998
991
|
*/
|
|
999
992
|
ParameterKey?: string;
|
|
1000
993
|
/**
|
|
@@ -1008,9 +1001,10 @@ export interface Parameter {
|
|
|
1008
1001
|
*/
|
|
1009
1002
|
UsePreviousValue?: boolean;
|
|
1010
1003
|
/**
|
|
1011
|
-
* <p>Read-only. The value that corresponds to a
|
|
1012
|
-
* is returned only for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types">
|
|
1013
|
-
* <code>SSM</code>
|
|
1004
|
+
* <p>Read-only. Read-only. The value that corresponds to a SSM parameter key.
|
|
1005
|
+
* This field is returned only for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types">
|
|
1006
|
+
* <code>SSM</code>
|
|
1007
|
+
* </a> parameter types in the template.</p>
|
|
1014
1008
|
*/
|
|
1015
1009
|
ResolvedValue?: string;
|
|
1016
1010
|
}
|
|
@@ -1050,20 +1044,20 @@ export declare namespace ResourceToImport {
|
|
|
1050
1044
|
const filterSensitiveLog: (obj: ResourceToImport) => any;
|
|
1051
1045
|
}
|
|
1052
1046
|
/**
|
|
1053
|
-
* <p>A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of
|
|
1054
|
-
*
|
|
1055
|
-
*
|
|
1047
|
+
* <p>A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the
|
|
1048
|
+
* alarms you specify goes to ALARM state during the stack operation or within the specified
|
|
1049
|
+
* monitoring period afterwards, CloudFormation rolls back the entire stack
|
|
1056
1050
|
* operation. </p>
|
|
1057
1051
|
*/
|
|
1058
1052
|
export interface RollbackTrigger {
|
|
1059
1053
|
/**
|
|
1060
1054
|
* <p>The Amazon Resource Name (ARN) of the rollback trigger.</p>
|
|
1061
|
-
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1062
|
-
*
|
|
1055
|
+
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled back.
|
|
1056
|
+
* </p>
|
|
1063
1057
|
*/
|
|
1064
1058
|
Arn: string | undefined;
|
|
1065
1059
|
/**
|
|
1066
|
-
* <p>The resource type of the rollback trigger.
|
|
1060
|
+
* <p>The resource type of the rollback trigger. Specify either <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html">AWS::CloudWatch::Alarm</a> or <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html">AWS::CloudWatch::CompositeAlarm</a> resource types.</p>
|
|
1067
1061
|
*/
|
|
1068
1062
|
Type: string | undefined;
|
|
1069
1063
|
}
|
|
@@ -1076,17 +1070,16 @@ export declare namespace RollbackTrigger {
|
|
|
1076
1070
|
/**
|
|
1077
1071
|
* <p>Structure containing the rollback triggers for CloudFormation to monitor during stack creation
|
|
1078
1072
|
* and updating operations, and for the specified monitoring period afterwards.</p>
|
|
1079
|
-
* <p>Rollback triggers enable you to have CloudFormation monitor the state of your application
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
1082
|
-
* <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html">Monitor and Roll Back Stack
|
|
1073
|
+
* <p>Rollback triggers enable you to have CloudFormation monitor the state of your application during
|
|
1074
|
+
* stack creation and updating, and to roll back that operation if the application breaches
|
|
1075
|
+
* the threshold of any of the alarms you've specified. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html">Monitor and Roll Back Stack
|
|
1083
1076
|
* Operations</a>.</p>
|
|
1084
1077
|
*/
|
|
1085
1078
|
export interface RollbackConfiguration {
|
|
1086
1079
|
/**
|
|
1087
1080
|
* <p>The triggers to monitor during stack creation or update actions. </p>
|
|
1088
|
-
* <p>By default, CloudFormation saves the rollback triggers specified for a stack and applies them
|
|
1089
|
-
*
|
|
1081
|
+
* <p>By default, CloudFormation saves the rollback triggers specified for a stack and applies them to
|
|
1082
|
+
* any subsequent update operations for the stack, unless you specify otherwise. If you do
|
|
1090
1083
|
* specify rollback triggers for this parameter, those triggers replace any list of triggers
|
|
1091
1084
|
* previously specified for the stack. This means:</p>
|
|
1092
1085
|
* <ul>
|
|
@@ -1106,22 +1099,22 @@ export interface RollbackConfiguration {
|
|
|
1106
1099
|
* parameter.</p>
|
|
1107
1100
|
* </li>
|
|
1108
1101
|
* </ul>
|
|
1109
|
-
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1110
|
-
*
|
|
1102
|
+
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled back.
|
|
1103
|
+
* </p>
|
|
1111
1104
|
*/
|
|
1112
1105
|
RollbackTriggers?: RollbackTrigger[];
|
|
1113
1106
|
/**
|
|
1114
|
-
* <p>The amount of time, in minutes, during which CloudFormation should monitor all
|
|
1115
|
-
* rollback triggers after the stack creation or update operation deploys all necessary
|
|
1107
|
+
* <p>The amount of time, in minutes, during which CloudFormation should monitor all
|
|
1108
|
+
* the rollback triggers after the stack creation or update operation deploys all necessary
|
|
1116
1109
|
* resources.</p>
|
|
1117
1110
|
* <p>The default is 0 minutes.</p>
|
|
1118
|
-
* <p>If you specify a monitoring period but do not specify any rollback triggers,
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1121
|
-
*
|
|
1122
|
-
*
|
|
1123
|
-
*
|
|
1124
|
-
*
|
|
1111
|
+
* <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old
|
|
1112
|
+
* resources after update operations. You can use this monitoring period to perform any manual
|
|
1113
|
+
* stack 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>
|
|
1114
|
+
* <p>If you specify 0 for this parameter, CloudFormation still monitors the
|
|
1115
|
+
* specified rollback triggers during stack creation and update operations. Then, for update
|
|
1116
|
+
* operations, it begins disposing of old resources immediately once the operation
|
|
1117
|
+
* completes.</p>
|
|
1125
1118
|
*/
|
|
1126
1119
|
MonitoringTimeInMinutes?: number;
|
|
1127
1120
|
}
|
|
@@ -1139,8 +1132,7 @@ export interface Tag {
|
|
|
1139
1132
|
/**
|
|
1140
1133
|
* <p>
|
|
1141
1134
|
* <i>Required</i>. A string used to identify this tag. You can specify a
|
|
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>
|
|
1135
|
+
* maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: <code>aws:</code>.</p>
|
|
1144
1136
|
*/
|
|
1145
1137
|
Key: string | undefined;
|
|
1146
1138
|
/**
|
|
@@ -1161,27 +1153,26 @@ export declare namespace Tag {
|
|
|
1161
1153
|
*/
|
|
1162
1154
|
export interface CreateChangeSetInput {
|
|
1163
1155
|
/**
|
|
1164
|
-
* <p>The name or the unique ID of the stack for which you are creating a change set.
|
|
1165
|
-
* CloudFormation generates the change set by comparing this stack's information with the
|
|
1156
|
+
* <p>The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the
|
|
1166
1157
|
* information that you submit, such as a modified template or different parameter input
|
|
1167
1158
|
* values.</p>
|
|
1168
1159
|
*/
|
|
1169
1160
|
StackName: string | undefined;
|
|
1170
1161
|
/**
|
|
1171
|
-
* <p>A structure that contains the body of the revised template, with a minimum length of
|
|
1172
|
-
*
|
|
1173
|
-
* comparing this template with the template of the stack that you specified.</p>
|
|
1162
|
+
* <p>A structure that contains the body of the revised template, with a minimum length of 1
|
|
1163
|
+
* byte and a maximum length of 51,200 bytes. CloudFormation generates the change set
|
|
1164
|
+
* by comparing this template with the template of the stack that you specified.</p>
|
|
1174
1165
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1175
|
-
*
|
|
1166
|
+
* <code>TemplateURL</code>.</p>
|
|
1176
1167
|
*/
|
|
1177
1168
|
TemplateBody?: string;
|
|
1178
1169
|
/**
|
|
1179
1170
|
* <p>The location of the file that contains the revised template. The URL must point to a
|
|
1180
1171
|
* template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager
|
|
1181
|
-
* document. CloudFormation generates the change set by comparing this template with
|
|
1182
|
-
* stack that you specified.</p>
|
|
1172
|
+
* document. CloudFormation generates the change set by comparing this template with
|
|
1173
|
+
* the stack that you specified.</p>
|
|
1183
1174
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1184
|
-
*
|
|
1175
|
+
* <code>TemplateURL</code>.</p>
|
|
1185
1176
|
*/
|
|
1186
1177
|
TemplateURL?: string;
|
|
1187
1178
|
/**
|
|
@@ -1190,8 +1181,8 @@ export interface CreateChangeSetInput {
|
|
|
1190
1181
|
*/
|
|
1191
1182
|
UsePreviousTemplate?: boolean;
|
|
1192
1183
|
/**
|
|
1193
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the
|
|
1194
|
-
*
|
|
1184
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the change
|
|
1185
|
+
* set. For more information, see the <a>Parameter</a> data type.</p>
|
|
1195
1186
|
*/
|
|
1196
1187
|
Parameters?: Parameter[];
|
|
1197
1188
|
/**
|
|
@@ -1202,8 +1193,8 @@ export interface CreateChangeSetInput {
|
|
|
1202
1193
|
* <p>
|
|
1203
1194
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1204
1195
|
* </p>
|
|
1205
|
-
* <p>Some stack templates might include resources that can affect permissions in
|
|
1206
|
-
*
|
|
1196
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1197
|
+
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1207
1198
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
1208
1199
|
* of these capabilities.</p>
|
|
1209
1200
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -1223,9 +1214,8 @@ export interface CreateChangeSetInput {
|
|
|
1223
1214
|
* <code>InsufficientCapabilities</code> error.</p>
|
|
1224
1215
|
* </li>
|
|
1225
1216
|
* </ul>
|
|
1226
|
-
* <p>If your stack template contains these resources, we recommend that you review
|
|
1227
|
-
*
|
|
1228
|
-
* necessary.</p>
|
|
1217
|
+
* <p>If your stack template contains these resources, we recommend that you review all
|
|
1218
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
|
1229
1219
|
* <ul>
|
|
1230
1220
|
* <li>
|
|
1231
1221
|
* <p>
|
|
@@ -1297,24 +1287,23 @@ export interface CreateChangeSetInput {
|
|
|
1297
1287
|
*/
|
|
1298
1288
|
Capabilities?: (Capability | string)[];
|
|
1299
1289
|
/**
|
|
1300
|
-
* <p>The template resource types that you have permissions to work with if you execute
|
|
1301
|
-
*
|
|
1290
|
+
* <p>The template resource types that you have permissions to work with if you execute this
|
|
1291
|
+
* change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or
|
|
1302
1292
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
1303
|
-
* <p>If the list of resource types doesn't include a resource type that you're updating,
|
|
1304
|
-
*
|
|
1305
|
-
* types. Identity and Access Management (IAM) uses this parameter for condition keys in
|
|
1306
|
-
*
|
|
1307
|
-
*
|
|
1308
|
-
* Guide.</p>
|
|
1293
|
+
* <p>If the list of resource types doesn't include a resource type that you're updating, the
|
|
1294
|
+
* stack update fails. By default, CloudFormation grants permissions to all resource
|
|
1295
|
+
* types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies
|
|
1296
|
+
* for CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1297
|
+
* Identity and Access Management</a> in the CloudFormation User Guide.</p>
|
|
1309
1298
|
*/
|
|
1310
1299
|
ResourceTypes?: string[];
|
|
1311
1300
|
/**
|
|
1312
1301
|
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1313
|
-
* that CloudFormation assumes when executing the change set. CloudFormation
|
|
1314
|
-
* role's credentials to make calls on your behalf. CloudFormation uses this
|
|
1315
|
-
* future operations on the stack. As long as users have permission to operate on
|
|
1316
|
-
* CloudFormation uses this role even if the users don't have permission to
|
|
1317
|
-
* Ensure that the role grants least privilege.</p>
|
|
1302
|
+
* that CloudFormation assumes when executing the change set. CloudFormation
|
|
1303
|
+
* uses the role's credentials to make calls on your behalf. CloudFormation uses this
|
|
1304
|
+
* role for all future operations on the stack. As long as users have permission to operate on
|
|
1305
|
+
* the stack, CloudFormation uses this role even if the users don't have permission to
|
|
1306
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
|
1318
1307
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1319
1308
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1320
1309
|
* session that is generated from your user credentials.</p>
|
|
@@ -1339,14 +1328,13 @@ export interface CreateChangeSetInput {
|
|
|
1339
1328
|
/**
|
|
1340
1329
|
* <p>The name of the change set. The name must be unique among all change sets that are
|
|
1341
1330
|
* associated with the specified stack.</p>
|
|
1342
|
-
* <p>A change set name can contain only alphanumeric, case sensitive characters and
|
|
1343
|
-
*
|
|
1344
|
-
* characters.</p>
|
|
1331
|
+
* <p>A change set name can contain only alphanumeric, case sensitive characters and hyphens.
|
|
1332
|
+
* It must start with an alphabetic character and cannot exceed 128 characters.</p>
|
|
1345
1333
|
*/
|
|
1346
1334
|
ChangeSetName: string | undefined;
|
|
1347
1335
|
/**
|
|
1348
|
-
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token
|
|
1349
|
-
*
|
|
1336
|
+
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if
|
|
1337
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
1350
1338
|
* to create another change set with the same name. You might retry
|
|
1351
1339
|
* <code>CreateChangeSet</code> requests to ensure that CloudFormation successfully
|
|
1352
1340
|
* received them.</p>
|
|
@@ -1361,8 +1349,8 @@ export interface CreateChangeSetInput {
|
|
|
1361
1349
|
* <code>CREATE</code>. To create a change set for an existing stack, specify
|
|
1362
1350
|
* <code>UPDATE</code>. To create a change set for an import operation, specify
|
|
1363
1351
|
* <code>IMPORT</code>.</p>
|
|
1364
|
-
* <p>If you create a change set for a new stack, CloudFormation creates a stack with
|
|
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">
|
|
1352
|
+
* <p>If you create a change set for a new stack, CloudFormation creates a stack with
|
|
1353
|
+
* a 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">
|
|
1366
1354
|
* <code>REVIEW_IN_PROGRESS</code>
|
|
1367
1355
|
* </a> state until you execute the change
|
|
1368
1356
|
* set.</p>
|
|
@@ -1475,14 +1463,14 @@ export interface CreateStackInput {
|
|
|
1475
1463
|
*/
|
|
1476
1464
|
TemplateURL?: string;
|
|
1477
1465
|
/**
|
|
1478
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the
|
|
1479
|
-
*
|
|
1466
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack.
|
|
1467
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data
|
|
1480
1468
|
* type.</p>
|
|
1481
1469
|
*/
|
|
1482
1470
|
Parameters?: Parameter[];
|
|
1483
1471
|
/**
|
|
1484
|
-
* <p>Set to <code>true</code> to disable rollback of the stack if stack creation failed.
|
|
1485
|
-
*
|
|
1472
|
+
* <p>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You
|
|
1473
|
+
* can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not
|
|
1486
1474
|
* both.</p>
|
|
1487
1475
|
* <p>Default: <code>false</code>
|
|
1488
1476
|
* </p>
|
|
@@ -1513,8 +1501,8 @@ export interface CreateStackInput {
|
|
|
1513
1501
|
* <p>
|
|
1514
1502
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1515
1503
|
* </p>
|
|
1516
|
-
* <p>Some stack templates might include resources that can affect permissions in
|
|
1517
|
-
*
|
|
1504
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1505
|
+
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1518
1506
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
1519
1507
|
* of these capabilities.</p>
|
|
1520
1508
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -1533,9 +1521,8 @@ export interface CreateStackInput {
|
|
|
1533
1521
|
* <code>InsufficientCapabilities</code> error.</p>
|
|
1534
1522
|
* </li>
|
|
1535
1523
|
* </ul>
|
|
1536
|
-
* <p>If your stack template contains these resources, we recommend that you review
|
|
1537
|
-
*
|
|
1538
|
-
* necessary.</p>
|
|
1524
|
+
* <p>If your stack template contains these resources, we recommend that you review all
|
|
1525
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
|
1539
1526
|
* <ul>
|
|
1540
1527
|
* <li>
|
|
1541
1528
|
* <p>
|
|
@@ -1611,8 +1598,8 @@ export interface CreateStackInput {
|
|
|
1611
1598
|
*/
|
|
1612
1599
|
Capabilities?: (Capability | string)[];
|
|
1613
1600
|
/**
|
|
1614
|
-
* <p>The template resource types that you have permissions to work with for this create
|
|
1615
|
-
*
|
|
1601
|
+
* <p>The template resource types that you have permissions to work with for this create stack
|
|
1602
|
+
* action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or
|
|
1616
1603
|
* <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template
|
|
1617
1604
|
* resource types: <code>AWS::*</code> (for all Amazon Web Services resources),
|
|
1618
1605
|
* <code>Custom::*</code> (for all custom resources),
|
|
@@ -1621,19 +1608,20 @@ export interface CreateStackInput {
|
|
|
1621
1608
|
* <code>AWS::<i>service_name</i>::*</code> (for all resources of a
|
|
1622
1609
|
* particular Amazon Web Services service), and
|
|
1623
1610
|
* <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i>
|
|
1624
|
-
*
|
|
1625
|
-
* <p>If the list of resource types doesn't include a resource that you're creating, the
|
|
1626
|
-
*
|
|
1627
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
1611
|
+
* </code> (for a specific Amazon Web Services resource).</p>
|
|
1612
|
+
* <p>If the list of resource types doesn't include a resource that you're creating, the stack
|
|
1613
|
+
* creation fails. By default, CloudFormation grants permissions to all resource
|
|
1614
|
+
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
1615
|
+
* 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
|
|
1616
|
+
* Identity and Access Management</a>.</p>
|
|
1628
1617
|
*/
|
|
1629
1618
|
ResourceTypes?: string[];
|
|
1630
1619
|
/**
|
|
1631
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1632
|
-
*
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1635
|
-
*
|
|
1636
|
-
* Ensure that the role grants least privilege.</p>
|
|
1620
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's
|
|
1621
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for
|
|
1622
|
+
* all future operations on the stack. As long as users have permission to operate on the
|
|
1623
|
+
* stack, CloudFormation uses this role even if the users don't have permission to
|
|
1624
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
|
1637
1625
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1638
1626
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1639
1627
|
* session that is generated from your user credentials.</p>
|
|
@@ -1649,16 +1637,16 @@ export interface CreateStackInput {
|
|
|
1649
1637
|
OnFailure?: OnFailure | string;
|
|
1650
1638
|
/**
|
|
1651
1639
|
* <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
|
|
1652
|
-
* to Stack Resources</a> in the <i>CloudFormation User
|
|
1653
|
-
* You can specify either the <code>StackPolicyBody</code> or the
|
|
1654
|
-
*
|
|
1640
|
+
* to Stack Resources</a> in the <i>CloudFormation User
|
|
1641
|
+
* Guide</i>. You can specify either the <code>StackPolicyBody</code> or the
|
|
1642
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
1655
1643
|
*/
|
|
1656
1644
|
StackPolicyBody?: string;
|
|
1657
1645
|
/**
|
|
1658
|
-
* <p>Location of a file containing the stack policy. The URL must point to a policy
|
|
1659
|
-
*
|
|
1660
|
-
*
|
|
1661
|
-
*
|
|
1646
|
+
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum
|
|
1647
|
+
* size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify
|
|
1648
|
+
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
1649
|
+
* not both.</p>
|
|
1662
1650
|
*/
|
|
1663
1651
|
StackPolicyURL?: string;
|
|
1664
1652
|
/**
|
|
@@ -1668,21 +1656,21 @@ export interface CreateStackInput {
|
|
|
1668
1656
|
*/
|
|
1669
1657
|
Tags?: Tag[];
|
|
1670
1658
|
/**
|
|
1671
|
-
* <p>A unique identifier for this <code>CreateStack</code> request. Specify this token if
|
|
1672
|
-
*
|
|
1659
|
+
* <p>A unique identifier for this <code>CreateStack</code> request. Specify this token if you
|
|
1660
|
+
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1673
1661
|
* create a stack with the same name. You might retry <code>CreateStack</code> requests to
|
|
1674
1662
|
* ensure that CloudFormation successfully received them.</p>
|
|
1675
1663
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
1676
1664
|
* token, which you can use to track operations. For example, if you execute a
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1665
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
1666
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
1667
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
1680
1668
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
1681
1669
|
* Stack operations that are initiated from the console use the token format
|
|
1682
1670
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
1683
1671
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
1684
1672
|
* would be assigned the same token in the following format:
|
|
1685
|
-
*
|
|
1673
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>
|
|
1686
1674
|
*/
|
|
1687
1675
|
ClientRequestToken?: string;
|
|
1688
1676
|
/**
|
|
@@ -1769,34 +1757,33 @@ export interface StackSetOperationPreferences {
|
|
|
1769
1757
|
*/
|
|
1770
1758
|
RegionOrder?: string[];
|
|
1771
1759
|
/**
|
|
1772
|
-
* <p>The number of accounts, per Region, for which this operation can fail before
|
|
1773
|
-
* CloudFormation
|
|
1774
|
-
*
|
|
1760
|
+
* <p>The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a
|
|
1761
|
+
* Region, CloudFormation doesn't attempt the operation in any subsequent
|
|
1762
|
+
* Regions.</p>
|
|
1775
1763
|
* <p>Conditional: You must specify either <code>FailureToleranceCount</code> or
|
|
1776
1764
|
* <code>FailureTolerancePercentage</code> (but not both).</p>
|
|
1777
1765
|
* <p>By default, <code>0</code> is specified.</p>
|
|
1778
1766
|
*/
|
|
1779
1767
|
FailureToleranceCount?: number;
|
|
1780
1768
|
/**
|
|
1781
|
-
* <p>The percentage of accounts, per Region, for which this stack operation can fail
|
|
1782
|
-
*
|
|
1769
|
+
* <p>The percentage of accounts, per Region, for which this stack operation can fail before
|
|
1770
|
+
* CloudFormation stops the operation in that Region. If the operation is stopped
|
|
1783
1771
|
* in a Region, CloudFormation doesn't attempt the operation in any subsequent
|
|
1784
1772
|
* Regions.</p>
|
|
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>
|
|
1773
|
+
* <p>When calculating the number of accounts based on the specified percentage, CloudFormation rounds <i>down</i> to the next whole number.</p>
|
|
1787
1774
|
* <p>Conditional: You must specify either <code>FailureToleranceCount</code> or
|
|
1788
1775
|
* <code>FailureTolerancePercentage</code>, but not both.</p>
|
|
1789
1776
|
* <p>By default, <code>0</code> is specified.</p>
|
|
1790
1777
|
*/
|
|
1791
1778
|
FailureTolerancePercentage?: number;
|
|
1792
1779
|
/**
|
|
1793
|
-
* <p>The maximum number of accounts in which to perform this operation at one time. This
|
|
1794
|
-
*
|
|
1795
|
-
* <code>
|
|
1796
|
-
*
|
|
1797
|
-
* <p>Note that this setting lets you specify the <i>maximum</i> for
|
|
1798
|
-
*
|
|
1799
|
-
*
|
|
1780
|
+
* <p>The maximum number of accounts in which to perform this operation at one time. This is
|
|
1781
|
+
* dependent on the value of <code>FailureToleranceCount</code>.
|
|
1782
|
+
* <code>MaxConcurrentCount</code> is at most one more than the
|
|
1783
|
+
* <code>FailureToleranceCount</code>.</p>
|
|
1784
|
+
* <p>Note that this setting lets you specify the <i>maximum</i> for operations.
|
|
1785
|
+
* For large deployments, under certain circumstances the actual number of accounts acted upon
|
|
1786
|
+
* concurrently may be lower due to service throttling.</p>
|
|
1800
1787
|
* <p>Conditional: You must specify either <code>MaxConcurrentCount</code> or
|
|
1801
1788
|
* <code>MaxConcurrentPercentage</code>, but not both.</p>
|
|
1802
1789
|
* <p>By default, <code>1</code> is specified.</p>
|
|
@@ -1805,13 +1792,12 @@ export interface StackSetOperationPreferences {
|
|
|
1805
1792
|
/**
|
|
1806
1793
|
* <p>The maximum percentage of accounts in which to perform this operation at one
|
|
1807
1794
|
* time.</p>
|
|
1808
|
-
* <p>When calculating the number of accounts based on the specified percentage,
|
|
1809
|
-
*
|
|
1810
|
-
*
|
|
1811
|
-
*
|
|
1812
|
-
*
|
|
1813
|
-
*
|
|
1814
|
-
* accounts acted upon concurrently may be lower due to service throttling.</p>
|
|
1795
|
+
* <p>When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where
|
|
1796
|
+
* rounding down would result is zero. In this case, CloudFormation sets the number
|
|
1797
|
+
* as one instead.</p>
|
|
1798
|
+
* <p>Note that this setting lets you specify the <i>maximum</i> for operations.
|
|
1799
|
+
* For large deployments, under certain circumstances the actual number of accounts acted upon
|
|
1800
|
+
* concurrently may be lower due to service throttling.</p>
|
|
1815
1801
|
* <p>Conditional: You must specify either <code>MaxConcurrentCount</code> or
|
|
1816
1802
|
* <code>MaxConcurrentPercentage</code>, but not both.</p>
|
|
1817
1803
|
* <p>By default, <code>1</code> is specified.</p>
|
|
@@ -1831,9 +1817,10 @@ export interface CreateStackInstancesInput {
|
|
|
1831
1817
|
*/
|
|
1832
1818
|
StackSetName: string | undefined;
|
|
1833
1819
|
/**
|
|
1834
|
-
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts that you
|
|
1835
|
-
* specified Region(s) for.</p>
|
|
1836
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
1820
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts that you
|
|
1821
|
+
* want to create stack instances in the specified Region(s) for.</p>
|
|
1822
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
1823
|
+
* both.</p>
|
|
1837
1824
|
*/
|
|
1838
1825
|
Accounts?: string[];
|
|
1839
1826
|
/**
|
|
@@ -1849,32 +1836,31 @@ export interface CreateStackInstancesInput {
|
|
|
1849
1836
|
*/
|
|
1850
1837
|
Regions: string[] | undefined;
|
|
1851
1838
|
/**
|
|
1852
|
-
* <p>A list of stack set parameters whose values you want to override in the selected
|
|
1853
|
-
*
|
|
1854
|
-
* <p>Any overridden parameter values will be applied to all stack instances in the
|
|
1855
|
-
*
|
|
1856
|
-
* how CloudFormation sets parameter values during stack instance operations:</p>
|
|
1839
|
+
* <p>A list of stack set parameters whose values you want to override in the selected stack
|
|
1840
|
+
* instances.</p>
|
|
1841
|
+
* <p>Any overridden parameter values will be applied to all stack instances in the specified
|
|
1842
|
+
* accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:</p>
|
|
1857
1843
|
* <ul>
|
|
1858
1844
|
* <li>
|
|
1859
|
-
* <p>To override the current value for a parameter, include the parameter and
|
|
1860
|
-
*
|
|
1845
|
+
* <p>To override the current value for a parameter, include the parameter and specify
|
|
1846
|
+
* its value.</p>
|
|
1861
1847
|
* </li>
|
|
1862
1848
|
* <li>
|
|
1863
|
-
* <p>To leave an overridden parameter set to its present value, include the parameter
|
|
1864
|
-
* <code>true</code>. (You cannot specify
|
|
1865
|
-
* <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
1849
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter
|
|
1850
|
+
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify
|
|
1851
|
+
* both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
1866
1852
|
* </li>
|
|
1867
1853
|
* <li>
|
|
1868
1854
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
1869
1855
|
* specify a parameter list but do not include the parameter in the list.</p>
|
|
1870
1856
|
* </li>
|
|
1871
1857
|
* <li>
|
|
1872
|
-
* <p>To leave all parameters set to their present values, do not specify this
|
|
1873
|
-
*
|
|
1858
|
+
* <p>To leave all parameters set to their present values, do not specify this property
|
|
1859
|
+
* at all.</p>
|
|
1874
1860
|
* </li>
|
|
1875
1861
|
* </ul>
|
|
1876
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance are
|
|
1877
|
-
*
|
|
1862
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance are not
|
|
1863
|
+
* updated, but retain their overridden value.</p>
|
|
1878
1864
|
* <p>You can only override the parameter <i>values</i> that are specified in
|
|
1879
1865
|
* the stack set; to add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the stack set template.</p>
|
|
1880
1866
|
*/
|
|
@@ -1885,10 +1871,8 @@ export interface CreateStackInstancesInput {
|
|
|
1885
1871
|
OperationPreferences?: StackSetOperationPreferences;
|
|
1886
1872
|
/**
|
|
1887
1873
|
* <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
|
-
*
|
|
1890
|
-
* multiple times. You might retry stack set operation requests to ensure that
|
|
1891
|
-
* CloudFormation successfully received them.</p>
|
|
1874
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request
|
|
1875
|
+
* multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
1892
1876
|
* <p>If you don't specify an operation ID, the SDK generates one
|
|
1893
1877
|
* automatically.</p>
|
|
1894
1878
|
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
@@ -1896,15 +1880,21 @@ export interface CreateStackInstancesInput {
|
|
|
1896
1880
|
*/
|
|
1897
1881
|
OperationId?: string;
|
|
1898
1882
|
/**
|
|
1899
|
-
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
1900
|
-
*
|
|
1883
|
+
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
1884
|
+
* administrator in the organization's management account or as a delegated
|
|
1885
|
+
* administrator in a member account.</p>
|
|
1886
|
+
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
1887
|
+
* self-managed permissions.</p>
|
|
1901
1888
|
* <ul>
|
|
1902
1889
|
* <li>
|
|
1903
|
-
* <p>If you are signed in to the management account, specify
|
|
1890
|
+
* <p>If you are signed in to the management account, specify
|
|
1891
|
+
* <code>SELF</code>.</p>
|
|
1904
1892
|
* </li>
|
|
1905
1893
|
* <li>
|
|
1906
|
-
* <p>If you are signed in to a delegated administrator account, specify
|
|
1907
|
-
*
|
|
1894
|
+
* <p>If you are signed in to a delegated administrator account, specify
|
|
1895
|
+
* <code>DELEGATED_ADMIN</code>.</p>
|
|
1896
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
1897
|
+
* 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
1898
|
* </li>
|
|
1909
1899
|
* </ul>
|
|
1910
1900
|
*/
|
|
@@ -1957,8 +1947,8 @@ export declare namespace OperationIdAlreadyExistsException {
|
|
|
1957
1947
|
const filterSensitiveLog: (obj: OperationIdAlreadyExistsException) => any;
|
|
1958
1948
|
}
|
|
1959
1949
|
/**
|
|
1960
|
-
* <p>Another operation is currently in progress for this stack set. Only one operation can
|
|
1961
|
-
*
|
|
1950
|
+
* <p>Another operation is currently in progress for this stack set. Only one operation can be
|
|
1951
|
+
* performed for a stack set at a given time.</p>
|
|
1962
1952
|
*/
|
|
1963
1953
|
export interface OperationInProgressException extends __SmithyException, $MetadataBearer {
|
|
1964
1954
|
name: "OperationInProgressException";
|
|
@@ -1986,8 +1976,8 @@ export declare namespace StackSetNotFoundException {
|
|
|
1986
1976
|
const filterSensitiveLog: (obj: StackSetNotFoundException) => any;
|
|
1987
1977
|
}
|
|
1988
1978
|
/**
|
|
1989
|
-
* <p>Another operation has been performed on this stack set since the specified operation
|
|
1990
|
-
*
|
|
1979
|
+
* <p>Another operation has been performed on this stack set since the specified operation was
|
|
1980
|
+
* performed. </p>
|
|
1991
1981
|
*/
|
|
1992
1982
|
export interface StaleRequestException extends __SmithyException, $MetadataBearer {
|
|
1993
1983
|
name: "StaleRequestException";
|
|
@@ -2014,29 +2004,55 @@ export declare namespace CreatedButModifiedException {
|
|
|
2014
2004
|
*/
|
|
2015
2005
|
const filterSensitiveLog: (obj: CreatedButModifiedException) => any;
|
|
2016
2006
|
}
|
|
2007
|
+
/**
|
|
2008
|
+
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
|
2009
|
+
* conflicting operations.</p>
|
|
2010
|
+
*/
|
|
2011
|
+
export interface ManagedExecution {
|
|
2012
|
+
/**
|
|
2013
|
+
* <p>When <code>true</code>, StackSets performs non-conflicting operations concurrently and
|
|
2014
|
+
* queues conflicting operations. After conflicting operations finish, StackSets starts queued
|
|
2015
|
+
* operations in request order.</p>
|
|
2016
|
+
* <note>
|
|
2017
|
+
* <p>If there are already running or queued operations, StackSets queues all incoming
|
|
2018
|
+
* operations even if they are non-conflicting.</p>
|
|
2019
|
+
* <p>You can't modify your stack set's execution configuration while there are running or
|
|
2020
|
+
* queued operations for that stack set.</p>
|
|
2021
|
+
* </note>
|
|
2022
|
+
* <p>When <code>false</code> (default), StackSets performs one operation at a time in request
|
|
2023
|
+
* order.</p>
|
|
2024
|
+
*/
|
|
2025
|
+
Active?: boolean;
|
|
2026
|
+
}
|
|
2027
|
+
export declare namespace ManagedExecution {
|
|
2028
|
+
/**
|
|
2029
|
+
* @internal
|
|
2030
|
+
*/
|
|
2031
|
+
const filterSensitiveLog: (obj: ManagedExecution) => any;
|
|
2032
|
+
}
|
|
2017
2033
|
export declare type PermissionModels = "SELF_MANAGED" | "SERVICE_MANAGED";
|
|
2018
2034
|
export interface CreateStackSetInput {
|
|
2019
2035
|
/**
|
|
2020
2036
|
* <p>The name to associate with the stack set. The name must be unique in the Region where
|
|
2021
2037
|
* you create your stack set.</p>
|
|
2022
2038
|
* <note>
|
|
2023
|
-
* <p>A stack name can contain only alphanumeric characters (case-sensitive) and
|
|
2024
|
-
*
|
|
2039
|
+
* <p>A stack name can contain only alphanumeric characters (case-sensitive) and hyphens.
|
|
2040
|
+
* It must start with an alphabetic character and can't be longer than 128
|
|
2025
2041
|
* characters.</p>
|
|
2026
2042
|
* </note>
|
|
2027
2043
|
*/
|
|
2028
2044
|
StackSetName: string | undefined;
|
|
2029
2045
|
/**
|
|
2030
|
-
* <p>A description of the stack set. You can use the description to identify the stack
|
|
2031
|
-
*
|
|
2046
|
+
* <p>A description of the stack set. You can use the description to identify the stack set's
|
|
2047
|
+
* purpose or other important information.</p>
|
|
2032
2048
|
*/
|
|
2033
2049
|
Description?: string;
|
|
2034
2050
|
/**
|
|
2035
2051
|
* <p>The structure that contains the template body, with a minimum length of 1 byte and a
|
|
2036
2052
|
* maximum length of 51,200 bytes. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
2037
2053
|
* in the CloudFormation User Guide.</p>
|
|
2038
|
-
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter,
|
|
2039
|
-
*
|
|
2054
|
+
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
|
|
2055
|
+
* not both.</p>
|
|
2040
2056
|
*/
|
|
2041
2057
|
TemplateBody?: string;
|
|
2042
2058
|
/**
|
|
@@ -2044,8 +2060,8 @@ export interface CreateStackSetInput {
|
|
|
2044
2060
|
* template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems
|
|
2045
2061
|
* Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
2046
2062
|
* in the CloudFormation User Guide.</p>
|
|
2047
|
-
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter,
|
|
2048
|
-
*
|
|
2063
|
+
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
|
|
2064
|
+
* not both.</p>
|
|
2049
2065
|
*/
|
|
2050
2066
|
TemplateURL?: string;
|
|
2051
2067
|
/**
|
|
@@ -2066,8 +2082,8 @@ export interface CreateStackSetInput {
|
|
|
2066
2082
|
* <p>
|
|
2067
2083
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
2068
2084
|
* </p>
|
|
2069
|
-
* <p>Some stack templates might include resources that can affect permissions in
|
|
2070
|
-
*
|
|
2085
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
|
2086
|
+
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
2071
2087
|
* (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying
|
|
2072
2088
|
* one of these capabilities.</p>
|
|
2073
2089
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -2086,9 +2102,8 @@ export interface CreateStackSetInput {
|
|
|
2086
2102
|
* <code>InsufficientCapabilities</code> error.</p>
|
|
2087
2103
|
* </li>
|
|
2088
2104
|
* </ul>
|
|
2089
|
-
* <p>If your stack template contains these resources, we recommend that you review
|
|
2090
|
-
*
|
|
2091
|
-
* necessary.</p>
|
|
2105
|
+
* <p>If your stack template contains these resources, we recommend that you review all
|
|
2106
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
|
2092
2107
|
* <ul>
|
|
2093
2108
|
* <li>
|
|
2094
2109
|
* <p>
|
|
@@ -2156,11 +2171,10 @@ export interface CreateStackSetInput {
|
|
|
2156
2171
|
Capabilities?: (Capability | string)[];
|
|
2157
2172
|
/**
|
|
2158
2173
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
2159
|
-
*
|
|
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
|
-
*
|
|
2163
|
-
* you don't, the entire <code>CreateStackSet</code> action fails with an <code>access
|
|
2174
|
+
* CloudFormation also propagates these tags to supported resources that are
|
|
2175
|
+
* created in the stacks. A maximum number of 50 tags can be specified.</p>
|
|
2176
|
+
* <p>If you specify tags as part of a <code>CreateStackSet</code> action, CloudFormation checks to see if you have the required IAM permission to tag resources.
|
|
2177
|
+
* If you don't, the entire <code>CreateStackSet</code> action fails with an <code>access
|
|
2164
2178
|
* denied</code> error, and the stack set is not created.</p>
|
|
2165
2179
|
*/
|
|
2166
2180
|
Tags?: Tag[];
|
|
@@ -2230,14 +2244,19 @@ export interface CreateStackSetInput {
|
|
|
2230
2244
|
*/
|
|
2231
2245
|
CallAs?: CallAs | string;
|
|
2232
2246
|
/**
|
|
2233
|
-
* <p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token
|
|
2234
|
-
*
|
|
2247
|
+
* <p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token if
|
|
2248
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
2235
2249
|
* to create another stack set with the same name. You might retry <code>CreateStackSet</code>
|
|
2236
2250
|
* requests to ensure that CloudFormation successfully received them.</p>
|
|
2237
2251
|
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2238
2252
|
* automatically.</p>
|
|
2239
2253
|
*/
|
|
2240
2254
|
ClientRequestToken?: string;
|
|
2255
|
+
/**
|
|
2256
|
+
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
|
2257
|
+
* conflicting operations.</p>
|
|
2258
|
+
*/
|
|
2259
|
+
ManagedExecution?: ManagedExecution;
|
|
2241
2260
|
}
|
|
2242
2261
|
export declare namespace CreateStackSetInput {
|
|
2243
2262
|
/**
|
|
@@ -2311,13 +2330,12 @@ export declare namespace DeactivateTypeOutput {
|
|
|
2311
2330
|
*/
|
|
2312
2331
|
export interface DeleteChangeSetInput {
|
|
2313
2332
|
/**
|
|
2314
|
-
* <p>The name or Amazon Resource Name (ARN) of the change set that you want to
|
|
2315
|
-
* delete.</p>
|
|
2333
|
+
* <p>The name or Amazon Resource Name (ARN) of the change set that you want to delete.</p>
|
|
2316
2334
|
*/
|
|
2317
2335
|
ChangeSetName: string | undefined;
|
|
2318
2336
|
/**
|
|
2319
|
-
* <p>If you specified the name of a change set to delete, specify the stack name or ID
|
|
2320
|
-
*
|
|
2337
|
+
* <p>If you specified the name of a change set to delete, specify the stack name or ID (ARN)
|
|
2338
|
+
* that is associated with it.</p>
|
|
2321
2339
|
*/
|
|
2322
2340
|
StackName?: string;
|
|
2323
2341
|
}
|
|
@@ -2339,8 +2357,8 @@ export declare namespace DeleteChangeSetOutput {
|
|
|
2339
2357
|
const filterSensitiveLog: (obj: DeleteChangeSetOutput) => any;
|
|
2340
2358
|
}
|
|
2341
2359
|
/**
|
|
2342
|
-
* <p>The specified change set can't be used to update the stack. For example, the change
|
|
2343
|
-
*
|
|
2360
|
+
* <p>The specified change set can't be used to update the stack. For example, the change set
|
|
2361
|
+
* status might be <code>CREATE_IN_PROGRESS</code>, or the stack status might be
|
|
2344
2362
|
* <code>UPDATE_IN_PROGRESS</code>.</p>
|
|
2345
2363
|
*/
|
|
2346
2364
|
export interface InvalidChangeSetStatusException extends __SmithyException, $MetadataBearer {
|
|
@@ -2363,16 +2381,14 @@ export interface DeleteStackInput {
|
|
|
2363
2381
|
*/
|
|
2364
2382
|
StackName: string | undefined;
|
|
2365
2383
|
/**
|
|
2366
|
-
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs
|
|
2367
|
-
*
|
|
2368
|
-
*
|
|
2369
|
-
*
|
|
2370
|
-
* S3 bucket, but you want to delete the stack.</p>
|
|
2384
|
+
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that
|
|
2385
|
+
* are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but does not delete the retained resources.</p>
|
|
2386
|
+
* <p>Retaining resources is useful when you cannot delete a resource, such as a non-empty S3
|
|
2387
|
+
* bucket, but you want to delete the stack.</p>
|
|
2371
2388
|
*/
|
|
2372
2389
|
RetainResources?: string[];
|
|
2373
2390
|
/**
|
|
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
|
|
2391
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's
|
|
2376
2392
|
* credentials to make calls on your behalf.</p>
|
|
2377
2393
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
2378
2394
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
@@ -2380,15 +2396,15 @@ export interface DeleteStackInput {
|
|
|
2380
2396
|
*/
|
|
2381
2397
|
RoleARN?: string;
|
|
2382
2398
|
/**
|
|
2383
|
-
* <p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if
|
|
2384
|
-
*
|
|
2399
|
+
* <p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if you
|
|
2400
|
+
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
2385
2401
|
* delete a stack with the same name. You might retry <code>DeleteStack</code> requests to
|
|
2386
2402
|
* ensure that CloudFormation successfully received them.</p>
|
|
2387
2403
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
2388
2404
|
* token, which you can use to track operations. For example, if you execute a
|
|
2389
|
-
*
|
|
2390
|
-
*
|
|
2391
|
-
*
|
|
2405
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
2406
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
2407
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
2392
2408
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
2393
2409
|
* Stack operations that are initiated from the console use the token format
|
|
2394
2410
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
@@ -2411,8 +2427,10 @@ export interface DeleteStackInstancesInput {
|
|
|
2411
2427
|
*/
|
|
2412
2428
|
StackSetName: string | undefined;
|
|
2413
2429
|
/**
|
|
2414
|
-
* <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to
|
|
2415
|
-
*
|
|
2430
|
+
* <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to
|
|
2431
|
+
* delete stack instances for.</p>
|
|
2432
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
2433
|
+
* both.</p>
|
|
2416
2434
|
*/
|
|
2417
2435
|
Accounts?: string[];
|
|
2418
2436
|
/**
|
|
@@ -2431,9 +2449,9 @@ export interface DeleteStackInstancesInput {
|
|
|
2431
2449
|
*/
|
|
2432
2450
|
OperationPreferences?: StackSetOperationPreferences;
|
|
2433
2451
|
/**
|
|
2434
|
-
* <p>Removes the stack instances from the specified stack set, but doesn't delete the
|
|
2435
|
-
*
|
|
2436
|
-
*
|
|
2452
|
+
* <p>Removes the stack instances from the specified stack set, but doesn't delete the stacks.
|
|
2453
|
+
* You can't reassociate a retained stack or add an existing, saved stack to a new stack
|
|
2454
|
+
* set.</p>
|
|
2437
2455
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
|
|
2438
2456
|
*/
|
|
2439
2457
|
RetainStacks: boolean | undefined;
|
|
@@ -2441,10 +2459,8 @@ export interface DeleteStackInstancesInput {
|
|
|
2441
2459
|
* <p>The unique identifier for this stack set operation.</p>
|
|
2442
2460
|
* <p>If you don't specify an operation ID, the SDK generates one
|
|
2443
2461
|
* automatically.</p>
|
|
2444
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
2445
|
-
*
|
|
2446
|
-
* multiple times. You can retry stack set operation requests to ensure that
|
|
2447
|
-
* CloudFormation successfully received them.</p>
|
|
2462
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request
|
|
2463
|
+
* multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
2448
2464
|
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
2449
2465
|
* whose status is <code>OUTDATED</code>.</p>
|
|
2450
2466
|
*/
|
|
@@ -2489,8 +2505,8 @@ export declare namespace DeleteStackInstancesOutput {
|
|
|
2489
2505
|
}
|
|
2490
2506
|
export interface DeleteStackSetInput {
|
|
2491
2507
|
/**
|
|
2492
|
-
* <p>The name or unique ID of the stack set that you're deleting. You can obtain this
|
|
2493
|
-
*
|
|
2508
|
+
* <p>The name or unique ID of the stack set that you're deleting. You can obtain this value
|
|
2509
|
+
* by running <a>ListStackSets</a>.</p>
|
|
2494
2510
|
*/
|
|
2495
2511
|
StackSetName: string | undefined;
|
|
2496
2512
|
/**
|
|
@@ -2609,8 +2625,8 @@ export interface DescribeAccountLimitsOutput {
|
|
|
2609
2625
|
*/
|
|
2610
2626
|
AccountLimits?: AccountLimit[];
|
|
2611
2627
|
/**
|
|
2612
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of limits.
|
|
2613
|
-
*
|
|
2628
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of limits. If
|
|
2629
|
+
* no additional page exists, this value is null.</p>
|
|
2614
2630
|
*/
|
|
2615
2631
|
NextToken?: string;
|
|
2616
2632
|
}
|
|
@@ -2680,10 +2696,10 @@ export interface DescribeChangeSetOutput {
|
|
|
2680
2696
|
*/
|
|
2681
2697
|
CreationTime?: Date;
|
|
2682
2698
|
/**
|
|
2683
|
-
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the
|
|
2684
|
-
*
|
|
2685
|
-
*
|
|
2686
|
-
*
|
|
2699
|
+
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
2700
|
+
* set. If you can’t execute the change set, the status indicates why. For example, a change
|
|
2701
|
+
* set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still
|
|
2702
|
+
* creating it or in an <code>OBSOLETE</code> state because the stack was already
|
|
2687
2703
|
* updated.</p>
|
|
2688
2704
|
*/
|
|
2689
2705
|
ExecutionStatus?: ExecutionStatus | string;
|
|
@@ -2713,18 +2729,16 @@ export interface DescribeChangeSetOutput {
|
|
|
2713
2729
|
*/
|
|
2714
2730
|
Capabilities?: (Capability | string)[];
|
|
2715
2731
|
/**
|
|
2716
|
-
* <p>If you execute the change set, the tags that will be associated with the
|
|
2717
|
-
* stack.</p>
|
|
2732
|
+
* <p>If you execute the change set, the tags that will be associated with the stack.</p>
|
|
2718
2733
|
*/
|
|
2719
2734
|
Tags?: Tag[];
|
|
2720
2735
|
/**
|
|
2721
|
-
* <p>A list of <code>Change</code> structures that describes the resources
|
|
2722
|
-
* CloudFormation changes if you execute the change set.</p>
|
|
2736
|
+
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation changes if you execute the change set.</p>
|
|
2723
2737
|
*/
|
|
2724
2738
|
Changes?: Change[];
|
|
2725
2739
|
/**
|
|
2726
|
-
* <p>If the output exceeds 1 MB, a string that identifies the next page of changes. If
|
|
2727
|
-
*
|
|
2740
|
+
* <p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there
|
|
2741
|
+
* is no additional page, this value is null.</p>
|
|
2728
2742
|
*/
|
|
2729
2743
|
NextToken?: string;
|
|
2730
2744
|
/**
|
|
@@ -2831,8 +2845,8 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2831
2845
|
StackId: string | undefined;
|
|
2832
2846
|
/**
|
|
2833
2847
|
* <p>The ID of the drift detection results of this operation.</p>
|
|
2834
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation
|
|
2835
|
-
*
|
|
2848
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
2849
|
+
* run. However, the number of reports CloudFormation retains for any given stack, and for how long,
|
|
2836
2850
|
* may vary.</p>
|
|
2837
2851
|
*/
|
|
2838
2852
|
StackDriftDetectionId: string | undefined;
|
|
@@ -2842,9 +2856,9 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2842
2856
|
* <ul>
|
|
2843
2857
|
* <li>
|
|
2844
2858
|
* <p>
|
|
2845
|
-
* <code>DRIFTED</code>: The stack differs from its expected template
|
|
2846
|
-
*
|
|
2847
|
-
*
|
|
2859
|
+
* <code>DRIFTED</code>: The stack differs from its expected template configuration.
|
|
2860
|
+
* A stack is considered to have drifted if one or more of its resources have
|
|
2861
|
+
* drifted.</p>
|
|
2848
2862
|
* </li>
|
|
2849
2863
|
* <li>
|
|
2850
2864
|
* <p>
|
|
@@ -2871,15 +2885,15 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2871
2885
|
* <code>DETECTION_COMPLETE</code>: The stack drift detection operation has
|
|
2872
2886
|
* successfully completed for all resources in the stack that support drift detection.
|
|
2873
2887
|
* (Resources that do not currently support stack detection remain unchecked.)</p>
|
|
2874
|
-
* <p>If you specified logical resource IDs for CloudFormation to use as a filter for the
|
|
2875
|
-
*
|
|
2876
|
-
*
|
|
2888
|
+
* <p>If you specified logical resource IDs for CloudFormation to use as a filter for the stack
|
|
2889
|
+
* drift detection operation, only the resources with those logical IDs are checked for
|
|
2890
|
+
* drift.</p>
|
|
2877
2891
|
* </li>
|
|
2878
2892
|
* <li>
|
|
2879
2893
|
* <p>
|
|
2880
|
-
* <code>DETECTION_FAILED</code>: The stack drift detection operation has failed
|
|
2881
|
-
*
|
|
2882
|
-
*
|
|
2894
|
+
* <code>DETECTION_FAILED</code>: The stack drift detection operation has failed for
|
|
2895
|
+
* at least one resource in the stack. Results will be available for resources on which
|
|
2896
|
+
* CloudFormation successfully completed drift detection.</p>
|
|
2883
2897
|
* </li>
|
|
2884
2898
|
* <li>
|
|
2885
2899
|
* <p>
|
|
@@ -2915,8 +2929,8 @@ export declare namespace DescribeStackDriftDetectionStatusOutput {
|
|
|
2915
2929
|
*/
|
|
2916
2930
|
export interface DescribeStackEventsInput {
|
|
2917
2931
|
/**
|
|
2918
|
-
* <p>The name or the unique stack ID that is associated with the stack, which are not
|
|
2919
|
-
*
|
|
2932
|
+
* <p>The name or the unique stack ID that is associated with the stack, which are not always
|
|
2933
|
+
* interchangeable:</p>
|
|
2920
2934
|
* <ul>
|
|
2921
2935
|
* <li>
|
|
2922
2936
|
* <p>Running stacks: You can specify either the stack's name or its unique stack
|
|
@@ -2990,8 +3004,8 @@ export interface StackEvent {
|
|
|
2990
3004
|
*/
|
|
2991
3005
|
PhysicalResourceId?: string;
|
|
2992
3006
|
/**
|
|
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
|
-
*
|
|
3007
|
+
* <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 Resource Types Reference</a> in the CloudFormation User
|
|
3008
|
+
* Guide.)</p>
|
|
2995
3009
|
*/
|
|
2996
3010
|
ResourceType?: string;
|
|
2997
3011
|
/**
|
|
@@ -3014,15 +3028,15 @@ export interface StackEvent {
|
|
|
3014
3028
|
* <p>The token passed to the operation that generated this event.</p>
|
|
3015
3029
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
3016
3030
|
* token, which you can use to track operations. For example, if you execute a
|
|
3017
|
-
*
|
|
3018
|
-
*
|
|
3019
|
-
*
|
|
3031
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
3032
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
3033
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
3020
3034
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
3021
3035
|
* Stack operations that are initiated from the console use the token format
|
|
3022
3036
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
3023
3037
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
3024
3038
|
* would be assigned the same token in the following format:
|
|
3025
|
-
*
|
|
3039
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>
|
|
3026
3040
|
*/
|
|
3027
3041
|
ClientRequestToken?: string;
|
|
3028
3042
|
}
|
|
@@ -3041,8 +3055,8 @@ export interface DescribeStackEventsOutput {
|
|
|
3041
3055
|
*/
|
|
3042
3056
|
StackEvents?: StackEvent[];
|
|
3043
3057
|
/**
|
|
3044
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of events.
|
|
3045
|
-
*
|
|
3058
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of events. If
|
|
3059
|
+
* no additional page exists, this value is null.</p>
|
|
3046
3060
|
*/
|
|
3047
3061
|
NextToken?: string;
|
|
3048
3062
|
}
|
|
@@ -3059,7 +3073,8 @@ export interface DescribeStackInstanceInput {
|
|
|
3059
3073
|
*/
|
|
3060
3074
|
StackSetName: string | undefined;
|
|
3061
3075
|
/**
|
|
3062
|
-
* <p>The ID of an Amazon Web Services account that's associated with this stack
|
|
3076
|
+
* <p>The ID of an Amazon Web Services account that's associated with this stack
|
|
3077
|
+
* instance.</p>
|
|
3063
3078
|
*/
|
|
3064
3079
|
StackInstanceAccount: string | undefined;
|
|
3065
3080
|
/**
|
|
@@ -3147,12 +3162,12 @@ export declare namespace StackInstanceComprehensiveStatus {
|
|
|
3147
3162
|
}
|
|
3148
3163
|
export declare type StackInstanceStatus = "CURRENT" | "INOPERABLE" | "OUTDATED";
|
|
3149
3164
|
/**
|
|
3150
|
-
* <p>An CloudFormation stack, in a specific account and Region, that's part of a
|
|
3151
|
-
* set operation. A stack instance is a reference to an attempted or actual stack in a
|
|
3152
|
-
* account within a given Region. A stack instance can exist without a stack—for
|
|
3153
|
-
* the stack couldn't be created for some reason. A stack instance is associated
|
|
3154
|
-
* stack set. Each stack instance contains the ID of its associated stack set,
|
|
3155
|
-
* ID of the actual stack and the stack status.</p>
|
|
3165
|
+
* <p>An CloudFormation stack, in a specific account and Region, that's part of a
|
|
3166
|
+
* stack set operation. A stack instance is a reference to an attempted or actual stack in a
|
|
3167
|
+
* given account within a given Region. A stack instance can exist without a stack—for
|
|
3168
|
+
* example, if the stack couldn't be created for some reason. A stack instance is associated
|
|
3169
|
+
* with only one stack set. Each stack instance contains the ID of its associated stack set,
|
|
3170
|
+
* as well as the ID of the actual stack and the stack status.</p>
|
|
3156
3171
|
*/
|
|
3157
3172
|
export interface StackInstance {
|
|
3158
3173
|
/**
|
|
@@ -3161,11 +3176,13 @@ export interface StackInstance {
|
|
|
3161
3176
|
*/
|
|
3162
3177
|
StackSetId?: string;
|
|
3163
3178
|
/**
|
|
3164
|
-
* <p>The name of the Amazon Web Services Region that the stack instance is associated
|
|
3179
|
+
* <p>The name of the Amazon Web Services Region that the stack instance is associated
|
|
3180
|
+
* with.</p>
|
|
3165
3181
|
*/
|
|
3166
3182
|
Region?: string;
|
|
3167
3183
|
/**
|
|
3168
|
-
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack
|
|
3184
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack
|
|
3185
|
+
* instance is associated with.</p>
|
|
3169
3186
|
*/
|
|
3170
3187
|
Account?: string;
|
|
3171
3188
|
/**
|
|
@@ -3183,9 +3200,9 @@ export interface StackInstance {
|
|
|
3183
3200
|
* <ul>
|
|
3184
3201
|
* <li>
|
|
3185
3202
|
* <p>
|
|
3186
|
-
* <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has
|
|
3187
|
-
*
|
|
3188
|
-
*
|
|
3203
|
+
* <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed
|
|
3204
|
+
* and left the stack in an unstable state. Stacks in this state are excluded from
|
|
3205
|
+
* further <code>UpdateStackSet</code> operations. You might need to perform a
|
|
3189
3206
|
* <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to
|
|
3190
3207
|
* <code>true</code>, to delete the stack instance, and then delete the stack
|
|
3191
3208
|
* manually.</p>
|
|
@@ -3208,8 +3225,7 @@ export interface StackInstance {
|
|
|
3208
3225
|
* </li>
|
|
3209
3226
|
* <li>
|
|
3210
3227
|
* <p>
|
|
3211
|
-
* <code>CURRENT</code>: The stack is currently up to date with the stack
|
|
3212
|
-
* set.</p>
|
|
3228
|
+
* <code>CURRENT</code>: The stack is currently up to date with the stack set.</p>
|
|
3213
3229
|
* </li>
|
|
3214
3230
|
* </ul>
|
|
3215
3231
|
*/
|
|
@@ -3300,8 +3316,8 @@ export declare namespace StackInstanceNotFoundException {
|
|
|
3300
3316
|
*/
|
|
3301
3317
|
export interface DescribeStackResourceInput {
|
|
3302
3318
|
/**
|
|
3303
|
-
* <p>The name or the unique stack ID that is associated with the stack, which are not
|
|
3304
|
-
*
|
|
3319
|
+
* <p>The name or the unique stack ID that is associated with the stack, which are not always
|
|
3320
|
+
* interchangeable:</p>
|
|
3305
3321
|
* <ul>
|
|
3306
3322
|
* <li>
|
|
3307
3323
|
* <p>Running stacks: You can specify either the stack's name or its unique stack
|
|
@@ -3333,8 +3349,8 @@ export declare enum StackResourceDriftStatus {
|
|
|
3333
3349
|
NOT_CHECKED = "NOT_CHECKED"
|
|
3334
3350
|
}
|
|
3335
3351
|
/**
|
|
3336
|
-
* <p>Contains information about whether the resource's actual configuration differs, or
|
|
3337
|
-
*
|
|
3352
|
+
* <p>Contains information about whether the resource's actual configuration differs, or has
|
|
3353
|
+
* <i>drifted</i>, from its expected configuration.</p>
|
|
3338
3354
|
*/
|
|
3339
3355
|
export interface StackResourceDriftInformation {
|
|
3340
3356
|
/**
|
|
@@ -3343,8 +3359,8 @@ export interface StackResourceDriftInformation {
|
|
|
3343
3359
|
* <ul>
|
|
3344
3360
|
* <li>
|
|
3345
3361
|
* <p>
|
|
3346
|
-
* <code>DELETED</code>: The resource differs from its expected configuration in
|
|
3347
|
-
*
|
|
3362
|
+
* <code>DELETED</code>: The resource differs from its expected configuration in that
|
|
3363
|
+
* it has been deleted.</p>
|
|
3348
3364
|
* </li>
|
|
3349
3365
|
* <li>
|
|
3350
3366
|
* <p>
|
|
@@ -3353,8 +3369,8 @@ export interface StackResourceDriftInformation {
|
|
|
3353
3369
|
* </li>
|
|
3354
3370
|
* <li>
|
|
3355
3371
|
* <p>
|
|
3356
|
-
* <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from
|
|
3357
|
-
*
|
|
3372
|
+
* <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from its
|
|
3373
|
+
* expected configuration.</p>
|
|
3358
3374
|
* <p>Any resources that do not currently support drift detection have a status of
|
|
3359
3375
|
* <code>NOT_CHECKED</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>. </p>
|
|
3360
3376
|
* </li>
|
|
@@ -3395,13 +3411,13 @@ export interface StackResourceDetail {
|
|
|
3395
3411
|
*/
|
|
3396
3412
|
LogicalResourceId: string | undefined;
|
|
3397
3413
|
/**
|
|
3398
|
-
* <p>The name or unique identifier that corresponds to a physical instance ID of a
|
|
3399
|
-
*
|
|
3414
|
+
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3415
|
+
* supported by CloudFormation.</p>
|
|
3400
3416
|
*/
|
|
3401
3417
|
PhysicalResourceId?: string;
|
|
3402
3418
|
/**
|
|
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
|
-
*
|
|
3419
|
+
* <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 Resource Types Reference</a> in the CloudFormation User
|
|
3420
|
+
* Guide.)</p>
|
|
3405
3421
|
*/
|
|
3406
3422
|
ResourceType: string | undefined;
|
|
3407
3423
|
/**
|
|
@@ -3421,8 +3437,8 @@ export interface StackResourceDetail {
|
|
|
3421
3437
|
*/
|
|
3422
3438
|
Description?: string;
|
|
3423
3439
|
/**
|
|
3424
|
-
* <p>The content of the <code>Metadata</code> attribute declared for the resource. For
|
|
3425
|
-
*
|
|
3440
|
+
* <p>The content of the <code>Metadata</code> attribute declared for the resource. For more
|
|
3441
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html">Metadata
|
|
3426
3442
|
* Attribute</a> in the CloudFormation User Guide.</p>
|
|
3427
3443
|
*/
|
|
3428
3444
|
Metadata?: string;
|
|
@@ -3450,8 +3466,8 @@ export declare namespace StackResourceDetail {
|
|
|
3450
3466
|
*/
|
|
3451
3467
|
export interface DescribeStackResourceOutput {
|
|
3452
3468
|
/**
|
|
3453
|
-
* <p>A <code>StackResourceDetail</code> structure containing the description of the
|
|
3454
|
-
*
|
|
3469
|
+
* <p>A <code>StackResourceDetail</code> structure containing the description of the specified
|
|
3470
|
+
* resource in the specified stack.</p>
|
|
3455
3471
|
*/
|
|
3456
3472
|
StackResourceDetail?: StackResourceDetail;
|
|
3457
3473
|
}
|
|
@@ -3477,8 +3493,8 @@ export interface DescribeStackResourceDriftsInput {
|
|
|
3477
3493
|
* </li>
|
|
3478
3494
|
* <li>
|
|
3479
3495
|
* <p>
|
|
3480
|
-
* <code>MODIFIED</code>: One or more resource properties differ from their
|
|
3481
|
-
*
|
|
3496
|
+
* <code>MODIFIED</code>: One or more resource properties differ from their expected
|
|
3497
|
+
* template values.</p>
|
|
3482
3498
|
* </li>
|
|
3483
3499
|
* <li>
|
|
3484
3500
|
* <p>
|
|
@@ -3550,8 +3566,8 @@ export interface PropertyDifference {
|
|
|
3550
3566
|
*/
|
|
3551
3567
|
PropertyPath: string | undefined;
|
|
3552
3568
|
/**
|
|
3553
|
-
* <p>The expected property value of the resource property, as defined in the stack
|
|
3554
|
-
*
|
|
3569
|
+
* <p>The expected property value of the resource property, as defined in the stack template
|
|
3570
|
+
* and any values specified as template parameters.</p>
|
|
3555
3571
|
*/
|
|
3556
3572
|
ExpectedValue: string | undefined;
|
|
3557
3573
|
/**
|
|
@@ -3563,8 +3579,8 @@ export interface PropertyDifference {
|
|
|
3563
3579
|
* <ul>
|
|
3564
3580
|
* <li>
|
|
3565
3581
|
* <p>
|
|
3566
|
-
* <code>ADD</code>: A value has been added to a resource property that is an
|
|
3567
|
-
*
|
|
3582
|
+
* <code>ADD</code>: A value has been added to a resource property that is an array
|
|
3583
|
+
* or list data type.</p>
|
|
3568
3584
|
* </li>
|
|
3569
3585
|
* <li>
|
|
3570
3586
|
* <p>
|
|
@@ -3573,8 +3589,8 @@ export interface PropertyDifference {
|
|
|
3573
3589
|
* </li>
|
|
3574
3590
|
* <li>
|
|
3575
3591
|
* <p>
|
|
3576
|
-
* <code>NOT_EQUAL</code>: The current property value differs from its expected
|
|
3577
|
-
*
|
|
3592
|
+
* <code>NOT_EQUAL</code>: The current property value differs from its expected value
|
|
3593
|
+
* (as defined in the stack template and any values specified as template
|
|
3578
3594
|
* parameters).</p>
|
|
3579
3595
|
* </li>
|
|
3580
3596
|
* </ul>
|
|
@@ -3593,12 +3609,12 @@ export declare namespace PropertyDifference {
|
|
|
3593
3609
|
* drift. Only resource properties explicitly defined in the stack template are checked for
|
|
3594
3610
|
* drift. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
3595
3611
|
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
3596
|
-
* <p>Resources that do not currently support drift detection cannot be checked. For a list
|
|
3597
|
-
*
|
|
3612
|
+
* <p>Resources that do not currently support drift detection cannot be checked. For a list of
|
|
3613
|
+
* resources that support drift detection, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support
|
|
3598
3614
|
* Drift Detection</a>.</p>
|
|
3599
|
-
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual
|
|
3600
|
-
*
|
|
3601
|
-
*
|
|
3615
|
+
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources,
|
|
3616
|
+
* or <a>DetectStackDrift</a> to detect drift on all resources in a given stack
|
|
3617
|
+
* that support drift detection.</p>
|
|
3602
3618
|
*/
|
|
3603
3619
|
export interface StackResourceDrift {
|
|
3604
3620
|
/**
|
|
@@ -3610,8 +3626,8 @@ export interface StackResourceDrift {
|
|
|
3610
3626
|
*/
|
|
3611
3627
|
LogicalResourceId: string | undefined;
|
|
3612
3628
|
/**
|
|
3613
|
-
* <p>The name or unique identifier that corresponds to a physical instance ID of a
|
|
3614
|
-
*
|
|
3629
|
+
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3630
|
+
* supported by CloudFormation. </p>
|
|
3615
3631
|
*/
|
|
3616
3632
|
PhysicalResourceId?: string;
|
|
3617
3633
|
/**
|
|
@@ -3628,20 +3644,19 @@ export interface StackResourceDrift {
|
|
|
3628
3644
|
/**
|
|
3629
3645
|
* <p>A JSON structure containing the expected property values of the stack resource, as
|
|
3630
3646
|
* defined in the stack template and any values specified as template parameters. </p>
|
|
3631
|
-
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>,
|
|
3632
|
-
*
|
|
3647
|
+
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this
|
|
3648
|
+
* structure will not be present. </p>
|
|
3633
3649
|
*/
|
|
3634
3650
|
ExpectedProperties?: string;
|
|
3635
3651
|
/**
|
|
3636
|
-
* <p>A JSON structure containing the actual property values of the stack
|
|
3637
|
-
*
|
|
3638
|
-
*
|
|
3639
|
-
* this structure will not be present. </p>
|
|
3652
|
+
* <p>A JSON structure containing the actual property values of the stack resource.</p>
|
|
3653
|
+
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this
|
|
3654
|
+
* structure will not be present. </p>
|
|
3640
3655
|
*/
|
|
3641
3656
|
ActualProperties?: string;
|
|
3642
3657
|
/**
|
|
3643
|
-
* <p>A collection of the resource properties whose actual values differ from their
|
|
3644
|
-
*
|
|
3658
|
+
* <p>A collection of the resource properties whose actual values differ from their expected
|
|
3659
|
+
* values. These will be present only for resources whose
|
|
3645
3660
|
* <code>StackResourceDriftStatus</code> is <code>MODIFIED</code>.
|
|
3646
3661
|
* </p>
|
|
3647
3662
|
*/
|
|
@@ -3657,9 +3672,9 @@ export interface StackResourceDrift {
|
|
|
3657
3672
|
* </li>
|
|
3658
3673
|
* <li>
|
|
3659
3674
|
* <p>
|
|
3660
|
-
* <code>MODIFIED</code>: One or more resource properties differ from their
|
|
3661
|
-
*
|
|
3662
|
-
*
|
|
3675
|
+
* <code>MODIFIED</code>: One or more resource properties differ from their expected
|
|
3676
|
+
* values (as defined in the stack template and any values specified as template
|
|
3677
|
+
* parameters).</p>
|
|
3663
3678
|
* </li>
|
|
3664
3679
|
* <li>
|
|
3665
3680
|
* <p>
|
|
@@ -3721,8 +3736,8 @@ export declare namespace DescribeStackResourceDriftsOutput {
|
|
|
3721
3736
|
*/
|
|
3722
3737
|
export interface DescribeStackResourcesInput {
|
|
3723
3738
|
/**
|
|
3724
|
-
* <p>The name or the unique stack ID that is associated with the stack, which are not
|
|
3725
|
-
*
|
|
3739
|
+
* <p>The name or the unique stack ID that is associated with the stack, which are not always
|
|
3740
|
+
* interchangeable:</p>
|
|
3726
3741
|
* <ul>
|
|
3727
3742
|
* <li>
|
|
3728
3743
|
* <p>Running stacks: You can specify either the stack's name or its unique stack
|
|
@@ -3743,14 +3758,14 @@ export interface DescribeStackResourcesInput {
|
|
|
3743
3758
|
*/
|
|
3744
3759
|
LogicalResourceId?: string;
|
|
3745
3760
|
/**
|
|
3746
|
-
* <p>The name or unique identifier that corresponds to a physical instance ID of a
|
|
3747
|
-
*
|
|
3761
|
+
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3762
|
+
* supported by CloudFormation.</p>
|
|
3748
3763
|
* <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance,
|
|
3749
3764
|
* <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass
|
|
3750
3765
|
* the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack
|
|
3751
3766
|
* the instance belongs to and what other resources are part of the stack.</p>
|
|
3752
|
-
* <p>Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you
|
|
3753
|
-
*
|
|
3767
|
+
* <p>Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you must
|
|
3768
|
+
* specify <code>StackName</code>.</p>
|
|
3754
3769
|
* <p>Default: There is no default value.</p>
|
|
3755
3770
|
*/
|
|
3756
3771
|
PhysicalResourceId?: string;
|
|
@@ -3778,13 +3793,13 @@ export interface StackResource {
|
|
|
3778
3793
|
*/
|
|
3779
3794
|
LogicalResourceId: string | undefined;
|
|
3780
3795
|
/**
|
|
3781
|
-
* <p>The name or unique identifier that corresponds to a physical instance ID of a
|
|
3782
|
-
*
|
|
3796
|
+
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3797
|
+
* supported by CloudFormation.</p>
|
|
3783
3798
|
*/
|
|
3784
3799
|
PhysicalResourceId?: string;
|
|
3785
3800
|
/**
|
|
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
|
-
*
|
|
3801
|
+
* <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 Resource Types Reference</a> in the CloudFormation User
|
|
3802
|
+
* Guide.)</p>
|
|
3788
3803
|
*/
|
|
3789
3804
|
ResourceType: string | undefined;
|
|
3790
3805
|
/**
|
|
@@ -3842,8 +3857,8 @@ export declare namespace DescribeStackResourcesOutput {
|
|
|
3842
3857
|
*/
|
|
3843
3858
|
export interface DescribeStacksInput {
|
|
3844
3859
|
/**
|
|
3845
|
-
* <p>The name or the unique stack ID that is associated with the stack, which are not
|
|
3846
|
-
*
|
|
3860
|
+
* <p>The name or the unique stack ID that is associated with the stack, which are not always
|
|
3861
|
+
* interchangeable:</p>
|
|
3847
3862
|
* <ul>
|
|
3848
3863
|
* <li>
|
|
3849
3864
|
* <p>Running stacks: You can specify either the stack's name or its unique stack
|
|
@@ -3880,9 +3895,9 @@ export interface StackDriftInformation {
|
|
|
3880
3895
|
* <ul>
|
|
3881
3896
|
* <li>
|
|
3882
3897
|
* <p>
|
|
3883
|
-
* <code>DRIFTED</code>: The stack differs from its expected template
|
|
3884
|
-
*
|
|
3885
|
-
*
|
|
3898
|
+
* <code>DRIFTED</code>: The stack differs from its expected template configuration.
|
|
3899
|
+
* A stack is considered to have drifted if one or more of its resources have
|
|
3900
|
+
* drifted.</p>
|
|
3886
3901
|
* </li>
|
|
3887
3902
|
* <li>
|
|
3888
3903
|
* <p>
|
|
@@ -3902,8 +3917,8 @@ export interface StackDriftInformation {
|
|
|
3902
3917
|
*/
|
|
3903
3918
|
StackDriftStatus: StackDriftStatus | string | undefined;
|
|
3904
3919
|
/**
|
|
3905
|
-
* <p>Most recent time when a drift detection operation was initiated on the stack, or any
|
|
3906
|
-
*
|
|
3920
|
+
* <p>Most recent time when a drift detection operation was initiated on the stack, or any of
|
|
3921
|
+
* its individual resources that support drift detection.</p>
|
|
3907
3922
|
*/
|
|
3908
3923
|
LastCheckTimestamp?: Date;
|
|
3909
3924
|
}
|
|
@@ -3998,8 +4013,8 @@ export interface Stack {
|
|
|
3998
4013
|
*/
|
|
3999
4014
|
DeletionTime?: Date;
|
|
4000
4015
|
/**
|
|
4001
|
-
* <p>The time the stack was last updated. This field will only be returned if the stack
|
|
4002
|
-
*
|
|
4016
|
+
* <p>The time the stack was last updated. This field will only be returned if the stack has
|
|
4017
|
+
* been updated at least once.</p>
|
|
4003
4018
|
*/
|
|
4004
4019
|
LastUpdatedTime?: Date;
|
|
4005
4020
|
/**
|
|
@@ -4046,8 +4061,8 @@ export interface Stack {
|
|
|
4046
4061
|
*/
|
|
4047
4062
|
Outputs?: Output[];
|
|
4048
4063
|
/**
|
|
4049
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4050
|
-
*
|
|
4064
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is
|
|
4065
|
+
* associated with the stack. During a stack operation, CloudFormation uses this
|
|
4051
4066
|
* role's credentials to make calls on your behalf.</p>
|
|
4052
4067
|
*/
|
|
4053
4068
|
RoleARN?: string;
|
|
@@ -4067,15 +4082,13 @@ export interface Stack {
|
|
|
4067
4082
|
* <p>For nested stacks--stacks created as resources for another stack--the stack ID of the
|
|
4068
4083
|
* direct parent of this stack. For the first level of nested stacks, the root stack is also
|
|
4069
4084
|
* the parent stack.</p>
|
|
4070
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the
|
|
4071
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
4085
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4072
4086
|
*/
|
|
4073
4087
|
ParentId?: string;
|
|
4074
4088
|
/**
|
|
4075
4089
|
* <p>For nested stacks--stacks created as resources for another stack--the stack ID of the
|
|
4076
4090
|
* top-level stack to which the nested stack ultimately belongs.</p>
|
|
4077
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the
|
|
4078
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
4091
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4079
4092
|
*/
|
|
4080
4093
|
RootId?: string;
|
|
4081
4094
|
/**
|
|
@@ -4101,8 +4114,8 @@ export interface DescribeStacksOutput {
|
|
|
4101
4114
|
*/
|
|
4102
4115
|
Stacks?: Stack[];
|
|
4103
4116
|
/**
|
|
4104
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks.
|
|
4105
|
-
*
|
|
4117
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If
|
|
4118
|
+
* no additional page exists, this value is null.</p>
|
|
4106
4119
|
*/
|
|
4107
4120
|
NextToken?: string;
|
|
4108
4121
|
}
|
|
@@ -4276,9 +4289,9 @@ export declare namespace StackSetDriftDetectionDetails {
|
|
|
4276
4289
|
export declare type StackSetStatus = "ACTIVE" | "DELETED";
|
|
4277
4290
|
/**
|
|
4278
4291
|
* <p>A structure that contains information about a stack set. A stack set enables you to
|
|
4279
|
-
* provision stacks into Amazon Web Services accounts and across Regions by using a single
|
|
4280
|
-
*
|
|
4281
|
-
* capabilities that the template requires. </p>
|
|
4292
|
+
* provision stacks into Amazon Web Services accounts and across Regions by using a single
|
|
4293
|
+
* CloudFormation template. In the stack set, you specify the template to use, as
|
|
4294
|
+
* well as any parameters and capabilities that the template requires. </p>
|
|
4282
4295
|
*/
|
|
4283
4296
|
export interface StackSet {
|
|
4284
4297
|
/**
|
|
@@ -4299,8 +4312,8 @@ export interface StackSet {
|
|
|
4299
4312
|
*/
|
|
4300
4313
|
Status?: StackSetStatus | string;
|
|
4301
4314
|
/**
|
|
4302
|
-
* <p>The structure that contains the body of the template that was used to create or
|
|
4303
|
-
*
|
|
4315
|
+
* <p>The structure that contains the body of the template that was used to create or update
|
|
4316
|
+
* the stack set.</p>
|
|
4304
4317
|
*/
|
|
4305
4318
|
TemplateBody?: string;
|
|
4306
4319
|
/**
|
|
@@ -4309,14 +4322,15 @@ export interface StackSet {
|
|
|
4309
4322
|
Parameters?: Parameter[];
|
|
4310
4323
|
/**
|
|
4311
4324
|
* <p>The capabilities that are allowed in the stack set. Some stack set templates might
|
|
4312
|
-
* include resources that can affect permissions in your Amazon Web Services account—for
|
|
4313
|
-
* new Identity and Access Management (IAM) users. For more information, see
|
|
4325
|
+
* include resources that can affect permissions in your Amazon Web Services account—for
|
|
4326
|
+
* example, by creating new Identity and Access Management (IAM) users. For more information, see
|
|
4327
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates.</a>
|
|
4314
4328
|
* </p>
|
|
4315
4329
|
*/
|
|
4316
4330
|
Capabilities?: (Capability | string)[];
|
|
4317
4331
|
/**
|
|
4318
|
-
* <p>A list of tags that specify information about the stack set. A maximum number of 50
|
|
4319
|
-
*
|
|
4332
|
+
* <p>A list of tags that specify information about the stack set. A maximum number of 50 tags
|
|
4333
|
+
* can be specified.</p>
|
|
4320
4334
|
*/
|
|
4321
4335
|
Tags?: Tag[];
|
|
4322
4336
|
/**
|
|
@@ -4372,6 +4386,11 @@ export interface StackSet {
|
|
|
4372
4386
|
* that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>
|
|
4373
4387
|
*/
|
|
4374
4388
|
OrganizationalUnitIds?: string[];
|
|
4389
|
+
/**
|
|
4390
|
+
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
|
4391
|
+
* conflicting operations.</p>
|
|
4392
|
+
*/
|
|
4393
|
+
ManagedExecution?: ManagedExecution;
|
|
4375
4394
|
}
|
|
4376
4395
|
export declare namespace StackSet {
|
|
4377
4396
|
/**
|
|
@@ -4453,13 +4472,13 @@ export interface StackSetOperation {
|
|
|
4453
4472
|
* <ul>
|
|
4454
4473
|
* <li>
|
|
4455
4474
|
* <p>
|
|
4456
|
-
* <code>FAILED</code>: The operation exceeded the specified failure tolerance.
|
|
4457
|
-
*
|
|
4458
|
-
*
|
|
4459
|
-
*
|
|
4460
|
-
*
|
|
4461
|
-
*
|
|
4462
|
-
*
|
|
4475
|
+
* <code>FAILED</code>: The operation exceeded the specified failure tolerance. The
|
|
4476
|
+
* failure tolerance value that you've set for an operation is applied for each Region
|
|
4477
|
+
* during stack create and update operations. If the number of failed stacks within a
|
|
4478
|
+
* Region exceeds the failure tolerance, the status of the operation in the Region is
|
|
4479
|
+
* set to <code>FAILED</code>. This in turn sets the status of the operation as a whole
|
|
4480
|
+
* to <code>FAILED</code>, and CloudFormation cancels the operation in any
|
|
4481
|
+
* remaining Regions.</p>
|
|
4463
4482
|
* </li>
|
|
4464
4483
|
* <li>
|
|
4465
4484
|
* <p>
|
|
@@ -4490,15 +4509,13 @@ export interface StackSetOperation {
|
|
|
4490
4509
|
*/
|
|
4491
4510
|
Status?: StackSetOperationStatus | string;
|
|
4492
4511
|
/**
|
|
4493
|
-
* <p>The preferences for how CloudFormation performs this stack set
|
|
4494
|
-
* operation.</p>
|
|
4512
|
+
* <p>The preferences for how CloudFormation performs this stack set operation.</p>
|
|
4495
4513
|
*/
|
|
4496
4514
|
OperationPreferences?: StackSetOperationPreferences;
|
|
4497
4515
|
/**
|
|
4498
|
-
* <p>For stack set operations of action type <code>DELETE</code>, specifies whether to
|
|
4499
|
-
*
|
|
4500
|
-
*
|
|
4501
|
-
* set.</p>
|
|
4516
|
+
* <p>For stack set operations of action type <code>DELETE</code>, specifies whether to remove
|
|
4517
|
+
* the stack instances from the specified stack set, but doesn't delete the stacks. You can't
|
|
4518
|
+
* reassociate a retained stack, or add an existing, saved stack to a new stack set.</p>
|
|
4502
4519
|
*/
|
|
4503
4520
|
RetainStacks?: boolean;
|
|
4504
4521
|
/**
|
|
@@ -4518,9 +4535,9 @@ export interface StackSetOperation {
|
|
|
4518
4535
|
/**
|
|
4519
4536
|
* <p>The time at which the operation was initiated. Note that the creation times for the
|
|
4520
4537
|
* stack set operation might differ from the creation time of the individual stacks
|
|
4521
|
-
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
4522
|
-
* operation, such as dispatching the work to the requested Regions, before actually
|
|
4523
|
-
* the first stacks.</p>
|
|
4538
|
+
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
4539
|
+
* the operation, such as dispatching the work to the requested Regions, before actually
|
|
4540
|
+
* creating the first stacks.</p>
|
|
4524
4541
|
*/
|
|
4525
4542
|
CreationTimestamp?: Date;
|
|
4526
4543
|
/**
|
|
@@ -5119,8 +5136,8 @@ export interface EstimateTemplateCostInput {
|
|
|
5119
5136
|
*/
|
|
5120
5137
|
TemplateBody?: string;
|
|
5121
5138
|
/**
|
|
5122
|
-
* <p>Location of file containing the template body. The URL must point to a template that
|
|
5123
|
-
*
|
|
5139
|
+
* <p>Location of file containing the template body. The URL must point to a template that is
|
|
5140
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information, go to
|
|
5124
5141
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
5125
5142
|
* in the CloudFormation User Guide.</p>
|
|
5126
5143
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
@@ -5143,8 +5160,8 @@ export declare namespace EstimateTemplateCostInput {
|
|
|
5143
5160
|
*/
|
|
5144
5161
|
export interface EstimateTemplateCostOutput {
|
|
5145
5162
|
/**
|
|
5146
|
-
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes
|
|
5147
|
-
* required to run the template.</p>
|
|
5163
|
+
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes
|
|
5164
|
+
* the resources required to run the template.</p>
|
|
5148
5165
|
*/
|
|
5149
5166
|
Url?: string;
|
|
5150
5167
|
}
|
|
@@ -5169,11 +5186,11 @@ export interface ExecuteChangeSetInput {
|
|
|
5169
5186
|
*/
|
|
5170
5187
|
StackName?: string;
|
|
5171
5188
|
/**
|
|
5172
|
-
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this
|
|
5173
|
-
*
|
|
5189
|
+
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token
|
|
5190
|
+
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
5174
5191
|
* attempting to execute a change set to update a stack with the same name. You might retry
|
|
5175
|
-
*
|
|
5176
|
-
* received them.</p>
|
|
5192
|
+
* <code>ExecuteChangeSet</code> requests to ensure that CloudFormation
|
|
5193
|
+
* successfully received them.</p>
|
|
5177
5194
|
*/
|
|
5178
5195
|
ClientRequestToken?: string;
|
|
5179
5196
|
/**
|
|
@@ -5205,8 +5222,8 @@ export declare namespace ExecuteChangeSetOutput {
|
|
|
5205
5222
|
*/
|
|
5206
5223
|
export interface GetStackPolicyInput {
|
|
5207
5224
|
/**
|
|
5208
|
-
* <p>The name or unique stack ID that is associated with the stack whose policy you want
|
|
5209
|
-
*
|
|
5225
|
+
* <p>The name or unique stack ID that is associated with the stack whose policy you want to
|
|
5226
|
+
* get.</p>
|
|
5210
5227
|
*/
|
|
5211
5228
|
StackName: string | undefined;
|
|
5212
5229
|
}
|
|
@@ -5241,8 +5258,8 @@ export declare enum TemplateStage {
|
|
|
5241
5258
|
*/
|
|
5242
5259
|
export interface GetTemplateInput {
|
|
5243
5260
|
/**
|
|
5244
|
-
* <p>The name or the unique stack ID that is associated with the stack, which are not
|
|
5245
|
-
*
|
|
5261
|
+
* <p>The name or the unique stack ID that is associated with the stack, which are not always
|
|
5262
|
+
* interchangeable:</p>
|
|
5246
5263
|
* <ul>
|
|
5247
5264
|
* <li>
|
|
5248
5265
|
* <p>Running stacks: You can specify either the stack's name or its unique stack
|
|
@@ -5288,11 +5305,11 @@ export interface GetTemplateOutput {
|
|
|
5288
5305
|
*/
|
|
5289
5306
|
TemplateBody?: string;
|
|
5290
5307
|
/**
|
|
5291
|
-
* <p>The stage of the template that you can retrieve. For stacks, the
|
|
5292
|
-
*
|
|
5293
|
-
*
|
|
5294
|
-
*
|
|
5295
|
-
*
|
|
5308
|
+
* <p>The stage of the template that you can retrieve. For stacks, the <code>Original</code>
|
|
5309
|
+
* and <code>Processed</code> templates are always available. For change sets, the
|
|
5310
|
+
* <code>Original</code> template is always available. After CloudFormation
|
|
5311
|
+
* finishes creating the change set, the <code>Processed</code> template becomes
|
|
5312
|
+
* available.</p>
|
|
5296
5313
|
*/
|
|
5297
5314
|
StagesAvailable?: (TemplateStage | string)[];
|
|
5298
5315
|
}
|
|
@@ -5367,9 +5384,9 @@ export declare namespace GetTemplateSummaryInput {
|
|
|
5367
5384
|
const filterSensitiveLog: (obj: GetTemplateSummaryInput) => any;
|
|
5368
5385
|
}
|
|
5369
5386
|
/**
|
|
5370
|
-
* <p>A set of criteria that CloudFormation uses to validate parameter values.
|
|
5371
|
-
* other constraints might be defined in the stack template, CloudFormation
|
|
5372
|
-
* the <code>AllowedValues</code> property.</p>
|
|
5387
|
+
* <p>A set of criteria that CloudFormation uses to validate parameter values.
|
|
5388
|
+
* Although other constraints might be defined in the stack template, CloudFormation
|
|
5389
|
+
* returns only the <code>AllowedValues</code> property.</p>
|
|
5373
5390
|
*/
|
|
5374
5391
|
export interface ParameterConstraints {
|
|
5375
5392
|
/**
|
|
@@ -5463,11 +5480,12 @@ export interface GetTemplateSummaryOutput {
|
|
|
5463
5480
|
*/
|
|
5464
5481
|
Description?: string;
|
|
5465
5482
|
/**
|
|
5466
|
-
* <p>The capabilities found within the template. If your template contains IAM
|
|
5467
|
-
* you must specify the <code>CAPABILITY_IAM</code> or
|
|
5468
|
-
*
|
|
5469
|
-
*
|
|
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
|
|
5483
|
+
* <p>The capabilities found within the template. If your template contains IAM
|
|
5484
|
+
* resources, you must specify the <code>CAPABILITY_IAM</code> or
|
|
5485
|
+
* <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template;
|
|
5486
|
+
* otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p>
|
|
5487
|
+
* <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
|
|
5488
|
+
* Templates</a>.</p>
|
|
5471
5489
|
*/
|
|
5472
5490
|
Capabilities?: (Capability | string)[];
|
|
5473
5491
|
/**
|
|
@@ -5487,8 +5505,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
5487
5505
|
*/
|
|
5488
5506
|
Version?: string;
|
|
5489
5507
|
/**
|
|
5490
|
-
* <p>The value that is defined for the <code>Metadata</code> property of the
|
|
5491
|
-
* template.</p>
|
|
5508
|
+
* <p>The value that is defined for the <code>Metadata</code> property of the template.</p>
|
|
5492
5509
|
*/
|
|
5493
5510
|
Metadata?: string;
|
|
5494
5511
|
/**
|
|
@@ -5518,8 +5535,19 @@ export interface ImportStacksToStackSetInput {
|
|
|
5518
5535
|
/**
|
|
5519
5536
|
* <p>The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per
|
|
5520
5537
|
* stack set at a time.</p>
|
|
5538
|
+
* <p>Specify either <code>StackIds</code> or <code>StackIdsUrl</code>.</p>
|
|
5521
5539
|
*/
|
|
5522
|
-
StackIds
|
|
5540
|
+
StackIds?: string[];
|
|
5541
|
+
/**
|
|
5542
|
+
* <p>The Amazon S3 URL which contains list of stack ids to be inputted.</p>
|
|
5543
|
+
* <p>Specify either <code>StackIds</code> or <code>StackIdsUrl</code>.</p>
|
|
5544
|
+
*/
|
|
5545
|
+
StackIdsUrl?: string;
|
|
5546
|
+
/**
|
|
5547
|
+
* <p>The list of OU ID’s to which the stacks being imported has to be mapped as deployment
|
|
5548
|
+
* target.</p>
|
|
5549
|
+
*/
|
|
5550
|
+
OrganizationalUnitIds?: string[];
|
|
5523
5551
|
/**
|
|
5524
5552
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
5525
5553
|
* operation. </p>
|
|
@@ -5621,8 +5649,8 @@ export declare namespace ListChangeSetsOutput {
|
|
|
5621
5649
|
}
|
|
5622
5650
|
export interface ListExportsInput {
|
|
5623
5651
|
/**
|
|
5624
|
-
* <p>A string (provided by the <a>ListExports</a> response output) that
|
|
5625
|
-
*
|
|
5652
|
+
* <p>A string (provided by the <a>ListExports</a> response output) that identifies
|
|
5653
|
+
* the next page of exported output values that you asked to retrieve.</p>
|
|
5626
5654
|
*/
|
|
5627
5655
|
NextToken?: string;
|
|
5628
5656
|
}
|
|
@@ -5644,13 +5672,12 @@ export interface Export {
|
|
|
5644
5672
|
/**
|
|
5645
5673
|
* <p>The name of exported output value. Use this name and the <code>Fn::ImportValue</code>
|
|
5646
5674
|
* function to import the associated value into other stacks. The name is defined in the
|
|
5647
|
-
* <code>Export</code> field in the associated stack's <code>Outputs</code>
|
|
5648
|
-
* section.</p>
|
|
5675
|
+
* <code>Export</code> field in the associated stack's <code>Outputs</code> section.</p>
|
|
5649
5676
|
*/
|
|
5650
5677
|
Name?: string;
|
|
5651
5678
|
/**
|
|
5652
|
-
* <p>The value of the exported output, such as a resource physical ID. This value is
|
|
5653
|
-
*
|
|
5679
|
+
* <p>The value of the exported output, such as a resource physical ID. This value is defined
|
|
5680
|
+
* in the <code>Export</code> field in the associated stack's <code>Outputs</code>
|
|
5654
5681
|
* section.</p>
|
|
5655
5682
|
*/
|
|
5656
5683
|
Value?: string;
|
|
@@ -5667,8 +5694,8 @@ export interface ListExportsOutput {
|
|
|
5667
5694
|
*/
|
|
5668
5695
|
Exports?: Export[];
|
|
5669
5696
|
/**
|
|
5670
|
-
* <p>If the output exceeds 100 exported output values, a string that identifies the next
|
|
5671
|
-
*
|
|
5697
|
+
* <p>If the output exceeds 100 exported output values, a string that identifies the next page
|
|
5698
|
+
* of exports. If there is no additional page, this value is null.</p>
|
|
5672
5699
|
*/
|
|
5673
5700
|
NextToken?: string;
|
|
5674
5701
|
}
|
|
@@ -5702,8 +5729,8 @@ export interface ListImportsOutput {
|
|
|
5702
5729
|
*/
|
|
5703
5730
|
Imports?: string[];
|
|
5704
5731
|
/**
|
|
5705
|
-
* <p>A string that identifies the next page of exports. If there is no additional page,
|
|
5706
|
-
*
|
|
5732
|
+
* <p>A string that identifies the next page of exports. If there is no additional page, this
|
|
5733
|
+
* value is null.</p>
|
|
5707
5734
|
*/
|
|
5708
5735
|
NextToken?: string;
|
|
5709
5736
|
}
|
|
@@ -5735,8 +5762,7 @@ export declare namespace StackInstanceFilter {
|
|
|
5735
5762
|
}
|
|
5736
5763
|
export interface ListStackInstancesInput {
|
|
5737
5764
|
/**
|
|
5738
|
-
* <p>The name or unique ID of the stack set that you want to list stack instances
|
|
5739
|
-
* for.</p>
|
|
5765
|
+
* <p>The name or unique ID of the stack set that you want to list stack instances for.</p>
|
|
5740
5766
|
*/
|
|
5741
5767
|
StackSetName: string | undefined;
|
|
5742
5768
|
/**
|
|
@@ -5759,7 +5785,8 @@ export interface ListStackInstancesInput {
|
|
|
5759
5785
|
*/
|
|
5760
5786
|
Filters?: StackInstanceFilter[];
|
|
5761
5787
|
/**
|
|
5762
|
-
* <p>The name of the Amazon Web Services account that you want to list stack instances
|
|
5788
|
+
* <p>The name of the Amazon Web Services account that you want to list stack instances
|
|
5789
|
+
* for.</p>
|
|
5763
5790
|
*/
|
|
5764
5791
|
StackInstanceAccount?: string;
|
|
5765
5792
|
/**
|
|
@@ -5802,11 +5829,13 @@ export interface StackInstanceSummary {
|
|
|
5802
5829
|
*/
|
|
5803
5830
|
StackSetId?: string;
|
|
5804
5831
|
/**
|
|
5805
|
-
* <p>The name of the Amazon Web Services Region that the stack instance is associated
|
|
5832
|
+
* <p>The name of the Amazon Web Services Region that the stack instance is associated
|
|
5833
|
+
* with.</p>
|
|
5806
5834
|
*/
|
|
5807
5835
|
Region?: string;
|
|
5808
5836
|
/**
|
|
5809
|
-
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack
|
|
5837
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account that the stack
|
|
5838
|
+
* instance is associated with.</p>
|
|
5810
5839
|
*/
|
|
5811
5840
|
Account?: string;
|
|
5812
5841
|
/**
|
|
@@ -5819,9 +5848,9 @@ export interface StackInstanceSummary {
|
|
|
5819
5848
|
* <ul>
|
|
5820
5849
|
* <li>
|
|
5821
5850
|
* <p>
|
|
5822
|
-
* <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has
|
|
5823
|
-
*
|
|
5824
|
-
*
|
|
5851
|
+
* <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed
|
|
5852
|
+
* and left the stack in an unstable state. Stacks in this state are excluded from
|
|
5853
|
+
* further <code>UpdateStackSet</code> operations. You might need to perform a
|
|
5825
5854
|
* <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to
|
|
5826
5855
|
* <code>true</code>, to delete the stack instance, and then delete the stack
|
|
5827
5856
|
* manually.</p>
|
|
@@ -5844,15 +5873,13 @@ export interface StackInstanceSummary {
|
|
|
5844
5873
|
* </li>
|
|
5845
5874
|
* <li>
|
|
5846
5875
|
* <p>
|
|
5847
|
-
* <code>CURRENT</code>: The stack is currently up to date with the stack
|
|
5848
|
-
* set.</p>
|
|
5876
|
+
* <code>CURRENT</code>: The stack is currently up to date with the stack set.</p>
|
|
5849
5877
|
* </li>
|
|
5850
5878
|
* </ul>
|
|
5851
5879
|
*/
|
|
5852
5880
|
Status?: StackInstanceStatus | string;
|
|
5853
5881
|
/**
|
|
5854
|
-
* <p>The explanation for the specific status code assigned to this stack
|
|
5855
|
-
* instance.</p>
|
|
5882
|
+
* <p>The explanation for the specific status code assigned to this stack instance.</p>
|
|
5856
5883
|
*/
|
|
5857
5884
|
StatusReason?: string;
|
|
5858
5885
|
/**
|
|
@@ -5915,8 +5942,7 @@ export interface ListStackInstancesOutput {
|
|
|
5915
5942
|
* <p>If the request doesn't return all of the remaining results, <code>NextToken</code> is
|
|
5916
5943
|
* set to a token. To retrieve the next set of results, call <code>ListStackInstances</code>
|
|
5917
5944
|
* again and assign that token to the request object's <code>NextToken</code> parameter. If
|
|
5918
|
-
* the request returns all results, <code>NextToken</code> is set to
|
|
5919
|
-
* <code>null</code>.</p>
|
|
5945
|
+
* the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
5920
5946
|
*/
|
|
5921
5947
|
NextToken?: string;
|
|
5922
5948
|
}
|
|
@@ -5931,8 +5957,8 @@ export declare namespace ListStackInstancesOutput {
|
|
|
5931
5957
|
*/
|
|
5932
5958
|
export interface ListStackResourcesInput {
|
|
5933
5959
|
/**
|
|
5934
|
-
* <p>The name or the unique stack ID that is associated with the stack, which are not
|
|
5935
|
-
*
|
|
5960
|
+
* <p>The name or the unique stack ID that is associated with the stack, which are not always
|
|
5961
|
+
* interchangeable:</p>
|
|
5936
5962
|
* <ul>
|
|
5937
5963
|
* <li>
|
|
5938
5964
|
* <p>Running stacks: You can specify either the stack's name or its unique stack
|
|
@@ -5958,8 +5984,8 @@ export declare namespace ListStackResourcesInput {
|
|
|
5958
5984
|
const filterSensitiveLog: (obj: ListStackResourcesInput) => any;
|
|
5959
5985
|
}
|
|
5960
5986
|
/**
|
|
5961
|
-
* <p>Summarizes information about whether the resource's actual configuration differs, or
|
|
5962
|
-
*
|
|
5987
|
+
* <p>Summarizes information about whether the resource's actual configuration differs, or has
|
|
5988
|
+
* <i>drifted</i>, from its expected configuration.</p>
|
|
5963
5989
|
*/
|
|
5964
5990
|
export interface StackResourceDriftInformationSummary {
|
|
5965
5991
|
/**
|
|
@@ -5968,8 +5994,8 @@ export interface StackResourceDriftInformationSummary {
|
|
|
5968
5994
|
* <ul>
|
|
5969
5995
|
* <li>
|
|
5970
5996
|
* <p>
|
|
5971
|
-
* <code>DELETED</code>: The resource differs from its expected configuration in
|
|
5972
|
-
*
|
|
5997
|
+
* <code>DELETED</code>: The resource differs from its expected configuration in that
|
|
5998
|
+
* it has been deleted.</p>
|
|
5973
5999
|
* </li>
|
|
5974
6000
|
* <li>
|
|
5975
6001
|
* <p>
|
|
@@ -5978,8 +6004,8 @@ export interface StackResourceDriftInformationSummary {
|
|
|
5978
6004
|
* </li>
|
|
5979
6005
|
* <li>
|
|
5980
6006
|
* <p>
|
|
5981
|
-
* <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from
|
|
5982
|
-
*
|
|
6007
|
+
* <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from its
|
|
6008
|
+
* expected configuration.</p>
|
|
5983
6009
|
* <p>Any resources that do not currently support drift detection have a status of
|
|
5984
6010
|
* <code>NOT_CHECKED</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>. If you performed an <a>ContinueUpdateRollback</a> operation on a stack, any resources included in
|
|
5985
6011
|
* <code>ResourcesToSkip</code> will also have a status of <code>NOT_CHECKED</code>.
|
|
@@ -6019,8 +6045,8 @@ export interface StackResourceSummary {
|
|
|
6019
6045
|
*/
|
|
6020
6046
|
PhysicalResourceId?: string;
|
|
6021
6047
|
/**
|
|
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
|
-
*
|
|
6048
|
+
* <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 Resource Types Reference</a> in the CloudFormation User
|
|
6049
|
+
* Guide.)</p>
|
|
6024
6050
|
*/
|
|
6025
6051
|
ResourceType: string | undefined;
|
|
6026
6052
|
/**
|
|
@@ -6063,8 +6089,8 @@ export interface ListStackResourcesOutput {
|
|
|
6063
6089
|
*/
|
|
6064
6090
|
StackResourceSummaries?: StackResourceSummary[];
|
|
6065
6091
|
/**
|
|
6066
|
-
* <p>If the output exceeds 1 MB, a string that identifies the next page of stack
|
|
6067
|
-
*
|
|
6092
|
+
* <p>If the output exceeds 1 MB, a string that identifies the next page of stack resources.
|
|
6093
|
+
* If no additional page exists, this value is null.</p>
|
|
6068
6094
|
*/
|
|
6069
6095
|
NextToken?: string;
|
|
6070
6096
|
}
|
|
@@ -6108,9 +6134,9 @@ export interface StackDriftInformationSummary {
|
|
|
6108
6134
|
* <ul>
|
|
6109
6135
|
* <li>
|
|
6110
6136
|
* <p>
|
|
6111
|
-
* <code>DRIFTED</code>: The stack differs from its expected template
|
|
6112
|
-
*
|
|
6113
|
-
*
|
|
6137
|
+
* <code>DRIFTED</code>: The stack differs from its expected template configuration.
|
|
6138
|
+
* A stack is considered to have drifted if one or more of its resources have
|
|
6139
|
+
* drifted.</p>
|
|
6114
6140
|
* </li>
|
|
6115
6141
|
* <li>
|
|
6116
6142
|
* <p>
|
|
@@ -6130,8 +6156,8 @@ export interface StackDriftInformationSummary {
|
|
|
6130
6156
|
*/
|
|
6131
6157
|
StackDriftStatus: StackDriftStatus | string | undefined;
|
|
6132
6158
|
/**
|
|
6133
|
-
* <p>Most recent time when a drift detection operation was initiated on the stack, or any
|
|
6134
|
-
*
|
|
6159
|
+
* <p>Most recent time when a drift detection operation was initiated on the stack, or any of
|
|
6160
|
+
* its individual resources that support drift detection.</p>
|
|
6135
6161
|
*/
|
|
6136
6162
|
LastCheckTimestamp?: Date;
|
|
6137
6163
|
}
|
|
@@ -6162,8 +6188,8 @@ export interface StackSummary {
|
|
|
6162
6188
|
*/
|
|
6163
6189
|
CreationTime: Date | undefined;
|
|
6164
6190
|
/**
|
|
6165
|
-
* <p>The time the stack was last updated. This field will only be returned if the stack
|
|
6166
|
-
*
|
|
6191
|
+
* <p>The time the stack was last updated. This field will only be returned if the stack has
|
|
6192
|
+
* been updated at least once.</p>
|
|
6167
6193
|
*/
|
|
6168
6194
|
LastUpdatedTime?: Date;
|
|
6169
6195
|
/**
|
|
@@ -6182,15 +6208,13 @@ export interface StackSummary {
|
|
|
6182
6208
|
* <p>For nested stacks--stacks created as resources for another stack--the stack ID of the
|
|
6183
6209
|
* direct parent of this stack. For the first level of nested stacks, the root stack is also
|
|
6184
6210
|
* the parent stack.</p>
|
|
6185
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the
|
|
6186
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
6211
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6187
6212
|
*/
|
|
6188
6213
|
ParentId?: string;
|
|
6189
6214
|
/**
|
|
6190
6215
|
* <p>For nested stacks--stacks created as resources for another stack--the stack ID of the
|
|
6191
6216
|
* top-level stack to which the nested stack ultimately belongs.</p>
|
|
6192
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the
|
|
6193
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
6217
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Working with Nested Stacks</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6194
6218
|
*/
|
|
6195
6219
|
RootId?: string;
|
|
6196
6220
|
/**
|
|
@@ -6217,8 +6241,8 @@ export interface ListStacksOutput {
|
|
|
6217
6241
|
*/
|
|
6218
6242
|
StackSummaries?: StackSummary[];
|
|
6219
6243
|
/**
|
|
6220
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks.
|
|
6221
|
-
*
|
|
6244
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If
|
|
6245
|
+
* no additional page exists, this value is null.</p>
|
|
6222
6246
|
*/
|
|
6223
6247
|
NextToken?: string;
|
|
6224
6248
|
}
|
|
@@ -6287,7 +6311,8 @@ export declare type StackSetOperationResultStatus = "CANCELLED" | "FAILED" | "PE
|
|
|
6287
6311
|
*/
|
|
6288
6312
|
export interface StackSetOperationResultSummary {
|
|
6289
6313
|
/**
|
|
6290
|
-
* <p>[Self-managed permissions] The name of the Amazon Web Services account for this operation
|
|
6314
|
+
* <p>[Self-managed permissions] The name of the Amazon Web Services account for this operation
|
|
6315
|
+
* result.</p>
|
|
6291
6316
|
*/
|
|
6292
6317
|
Account?: string;
|
|
6293
6318
|
/**
|
|
@@ -6300,16 +6325,15 @@ export interface StackSetOperationResultSummary {
|
|
|
6300
6325
|
* <ul>
|
|
6301
6326
|
* <li>
|
|
6302
6327
|
* <p>
|
|
6303
|
-
* <code>CANCELLED</code>: The operation in the specified account and Region has
|
|
6304
|
-
*
|
|
6328
|
+
* <code>CANCELLED</code>: The operation in the specified account and Region has been
|
|
6329
|
+
* cancelled. This is either because a user has stopped the stack set operation, or
|
|
6305
6330
|
* because the failure tolerance of the stack set operation has been exceeded.</p>
|
|
6306
6331
|
* </li>
|
|
6307
6332
|
* <li>
|
|
6308
6333
|
* <p>
|
|
6309
6334
|
* <code>FAILED</code>: The operation in the specified account and Region failed. </p>
|
|
6310
|
-
* <p>If the stack set operation fails in enough accounts within a Region, the
|
|
6311
|
-
*
|
|
6312
|
-
* </p>
|
|
6335
|
+
* <p>If the stack set operation fails in enough accounts within a Region, the failure
|
|
6336
|
+
* tolerance for the stack set operation as a whole might be exceeded. </p>
|
|
6313
6337
|
* </li>
|
|
6314
6338
|
* <li>
|
|
6315
6339
|
* <p>
|
|
@@ -6318,8 +6342,8 @@ export interface StackSetOperationResultSummary {
|
|
|
6318
6342
|
* </li>
|
|
6319
6343
|
* <li>
|
|
6320
6344
|
* <p>
|
|
6321
|
-
* <code>PENDING</code>: The operation in the specified account and Region has yet
|
|
6322
|
-
*
|
|
6345
|
+
* <code>PENDING</code>: The operation in the specified account and Region has yet to
|
|
6346
|
+
* start. </p>
|
|
6323
6347
|
* </li>
|
|
6324
6348
|
* <li>
|
|
6325
6349
|
* <p>
|
|
@@ -6358,9 +6382,9 @@ export interface ListStackSetOperationResultsOutput {
|
|
|
6358
6382
|
*/
|
|
6359
6383
|
Summaries?: StackSetOperationResultSummary[];
|
|
6360
6384
|
/**
|
|
6361
|
-
* <p>If the request doesn't return all results, <code>NextToken</code> is set to a token.
|
|
6362
|
-
*
|
|
6363
|
-
*
|
|
6385
|
+
* <p>If the request doesn't return all results, <code>NextToken</code> is set to a token. To
|
|
6386
|
+
* retrieve the next set of results, call <code>ListOperationResults</code> again and assign
|
|
6387
|
+
* that token to the request object's <code>NextToken</code> parameter. If there are no
|
|
6364
6388
|
* remaining results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6365
6389
|
*/
|
|
6366
6390
|
NextToken?: string;
|
|
@@ -6420,8 +6444,7 @@ export declare namespace ListStackSetOperationsInput {
|
|
|
6420
6444
|
const filterSensitiveLog: (obj: ListStackSetOperationsInput) => any;
|
|
6421
6445
|
}
|
|
6422
6446
|
/**
|
|
6423
|
-
* <p>The structures that contain summary information about the specified
|
|
6424
|
-
* operation.</p>
|
|
6447
|
+
* <p>The structures that contain summary information about the specified operation.</p>
|
|
6425
6448
|
*/
|
|
6426
6449
|
export interface StackSetOperationSummary {
|
|
6427
6450
|
/**
|
|
@@ -6429,11 +6452,10 @@ export interface StackSetOperationSummary {
|
|
|
6429
6452
|
*/
|
|
6430
6453
|
OperationId?: string;
|
|
6431
6454
|
/**
|
|
6432
|
-
* <p>The type of operation: <code>CREATE</code>, <code>UPDATE</code>, or
|
|
6433
|
-
*
|
|
6434
|
-
*
|
|
6435
|
-
*
|
|
6436
|
-
* instances.</p>
|
|
6455
|
+
* <p>The type of operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>.
|
|
6456
|
+
* Create and delete operations affect only the specified stack instances that are associated
|
|
6457
|
+
* with the specified stack set. Update operations affect both the stack set itself as well as
|
|
6458
|
+
* <i>all</i> associated stack set instances.</p>
|
|
6437
6459
|
*/
|
|
6438
6460
|
Action?: StackSetOperationAction | string;
|
|
6439
6461
|
/**
|
|
@@ -6441,13 +6463,13 @@ export interface StackSetOperationSummary {
|
|
|
6441
6463
|
* <ul>
|
|
6442
6464
|
* <li>
|
|
6443
6465
|
* <p>
|
|
6444
|
-
* <code>FAILED</code>: The operation exceeded the specified failure tolerance.
|
|
6445
|
-
*
|
|
6446
|
-
*
|
|
6447
|
-
*
|
|
6448
|
-
*
|
|
6449
|
-
*
|
|
6450
|
-
*
|
|
6466
|
+
* <code>FAILED</code>: The operation exceeded the specified failure tolerance. The
|
|
6467
|
+
* failure tolerance value that you've set for an operation is applied for each Region
|
|
6468
|
+
* during stack create and update operations. If the number of failed stacks within a
|
|
6469
|
+
* Region exceeds the failure tolerance, the status of the operation in the Region is
|
|
6470
|
+
* set to <code>FAILED</code>. This in turn sets the status of the operation as a whole
|
|
6471
|
+
* to <code>FAILED</code>, and CloudFormation cancels the operation in any
|
|
6472
|
+
* remaining Regions.</p>
|
|
6451
6473
|
* </li>
|
|
6452
6474
|
* <li>
|
|
6453
6475
|
* <p>
|
|
@@ -6480,9 +6502,9 @@ export interface StackSetOperationSummary {
|
|
|
6480
6502
|
/**
|
|
6481
6503
|
* <p>The time at which the operation was initiated. Note that the creation times for the
|
|
6482
6504
|
* stack set operation might differ from the creation time of the individual stacks
|
|
6483
|
-
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
6484
|
-
* operation, such as dispatching the work to the requested Regions, before actually
|
|
6485
|
-
* the first stacks.</p>
|
|
6505
|
+
* themselves. This is because CloudFormation needs to perform preparatory work for
|
|
6506
|
+
* the operation, such as dispatching the work to the requested Regions, before actually
|
|
6507
|
+
* creating the first stacks.</p>
|
|
6486
6508
|
*/
|
|
6487
6509
|
CreationTimestamp?: Date;
|
|
6488
6510
|
/**
|
|
@@ -6505,9 +6527,9 @@ export interface ListStackSetOperationsOutput {
|
|
|
6505
6527
|
*/
|
|
6506
6528
|
Summaries?: StackSetOperationSummary[];
|
|
6507
6529
|
/**
|
|
6508
|
-
* <p>If the request doesn't return all results, <code>NextToken</code> is set to a token.
|
|
6509
|
-
*
|
|
6510
|
-
*
|
|
6530
|
+
* <p>If the request doesn't return all results, <code>NextToken</code> is set to a token. To
|
|
6531
|
+
* retrieve the next set of results, call <code>ListOperationResults</code> again and assign
|
|
6532
|
+
* that token to the request object's <code>NextToken</code> parameter. If there are no
|
|
6511
6533
|
* remaining results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6512
6534
|
*/
|
|
6513
6535
|
NextToken?: string;
|
|
@@ -6536,8 +6558,7 @@ export interface ListStackSetsInput {
|
|
|
6536
6558
|
*/
|
|
6537
6559
|
MaxResults?: number;
|
|
6538
6560
|
/**
|
|
6539
|
-
* <p>The status of the stack sets that you want to get summary information
|
|
6540
|
-
* about.</p>
|
|
6561
|
+
* <p>The status of the stack sets that you want to get summary information about.</p>
|
|
6541
6562
|
*/
|
|
6542
6563
|
Status?: StackSetStatus | string;
|
|
6543
6564
|
/**
|
|
@@ -6567,8 +6588,7 @@ export declare namespace ListStackSetsInput {
|
|
|
6567
6588
|
const filterSensitiveLog: (obj: ListStackSetsInput) => any;
|
|
6568
6589
|
}
|
|
6569
6590
|
/**
|
|
6570
|
-
* <p>The structures that contain summary information about the specified stack
|
|
6571
|
-
* set.</p>
|
|
6591
|
+
* <p>The structures that contain summary information about the specified stack set.</p>
|
|
6572
6592
|
*/
|
|
6573
6593
|
export interface StackSetSummary {
|
|
6574
6594
|
/**
|
|
@@ -6646,6 +6666,11 @@ export interface StackSetSummary {
|
|
|
6646
6666
|
* detection has not yet been performed.</p>
|
|
6647
6667
|
*/
|
|
6648
6668
|
LastDriftCheckTimestamp?: Date;
|
|
6669
|
+
/**
|
|
6670
|
+
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
|
6671
|
+
* conflicting operations.</p>
|
|
6672
|
+
*/
|
|
6673
|
+
ManagedExecution?: ManagedExecution;
|
|
6649
6674
|
}
|
|
6650
6675
|
export declare namespace StackSetSummary {
|
|
6651
6676
|
/**
|
|
@@ -6663,8 +6688,7 @@ export interface ListStackSetsOutput {
|
|
|
6663
6688
|
* <p>If the request doesn't return all of the remaining results, <code>NextToken</code> is
|
|
6664
6689
|
* set to a token. To retrieve the next set of results, call <code>ListStackInstances</code>
|
|
6665
6690
|
* again and assign that token to the request object's <code>NextToken</code> parameter. If
|
|
6666
|
-
* the request returns all results, <code>NextToken</code> is set to
|
|
6667
|
-
* <code>null</code>.</p>
|
|
6691
|
+
* the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6668
6692
|
*/
|
|
6669
6693
|
NextToken?: string;
|
|
6670
6694
|
}
|
|
@@ -6762,7 +6786,7 @@ export interface TypeFilters {
|
|
|
6762
6786
|
* </li>
|
|
6763
6787
|
* <li>
|
|
6764
6788
|
* <p>
|
|
6765
|
-
* <code>
|
|
6789
|
+
* <code>THIRD_PARTY</code>: Extensions available for use from publishers other than
|
|
6766
6790
|
* Amazon. This includes:</p>
|
|
6767
6791
|
* <ul>
|
|
6768
6792
|
* <li>
|
|
@@ -6776,7 +6800,7 @@ export interface TypeFilters {
|
|
|
6776
6800
|
* </li>
|
|
6777
6801
|
* <li>
|
|
6778
6802
|
* <p>
|
|
6779
|
-
* <code>
|
|
6803
|
+
* <code>AWS_TYPES</code>: Extensions available for use from Amazon.</p>
|
|
6780
6804
|
* </li>
|
|
6781
6805
|
* </ul>
|
|
6782
6806
|
*/
|
|
@@ -6784,7 +6808,7 @@ export interface TypeFilters {
|
|
|
6784
6808
|
/**
|
|
6785
6809
|
* <p>The id of the publisher of the extension. </p>
|
|
6786
6810
|
* <p>Extensions published by Amazon are not assigned a publisher ID. Use the
|
|
6787
|
-
* <code>
|
|
6811
|
+
* <code>AWS_TYPE</code> category to specify a list of types published by Amazon.</p>
|
|
6788
6812
|
*/
|
|
6789
6813
|
PublisherId?: string;
|
|
6790
6814
|
/**
|
|
@@ -6877,8 +6901,10 @@ export interface ListTypesInput {
|
|
|
6877
6901
|
Type?: RegistryType | string;
|
|
6878
6902
|
/**
|
|
6879
6903
|
* <p>Filter criteria to use in determining which extensions to return.</p>
|
|
6880
|
-
* <p>
|
|
6881
|
-
*
|
|
6904
|
+
* <p>Filters must be compatible with <code>Visibility</code> to return valid results. For
|
|
6905
|
+
* example, specifying <code>AWS_TYPES</code> for <code>Category</code> and
|
|
6906
|
+
* <code>PRIVATE</code> for <code>Visibility</code> returns an empty list of types, but
|
|
6907
|
+
* specifying <code>PUBLIC</code> for <code>Visibility</code> returns the desired list.</p>
|
|
6882
6908
|
*/
|
|
6883
6909
|
Filters?: TypeFilters;
|
|
6884
6910
|
/**
|
|
@@ -7204,8 +7230,8 @@ export interface PublishTypeInput {
|
|
|
7204
7230
|
* 2.0.0</a>.</p>
|
|
7205
7231
|
* <p>If you do not specify a version number, CloudFormation increments the version number by
|
|
7206
7232
|
* one minor version release.</p>
|
|
7207
|
-
* <p>
|
|
7208
|
-
*
|
|
7233
|
+
* <p>You cannot specify a version number the first time you publish a type. CloudFormation
|
|
7234
|
+
* automatically sets the first version number to be <code>1.0.0</code>.</p>
|
|
7209
7235
|
*/
|
|
7210
7236
|
PublicVersionNumber?: string;
|
|
7211
7237
|
}
|
|
@@ -7490,7 +7516,8 @@ export interface RollbackStackInput {
|
|
|
7490
7516
|
*/
|
|
7491
7517
|
StackName: string | undefined;
|
|
7492
7518
|
/**
|
|
7493
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation
|
|
7519
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation
|
|
7520
|
+
* assumes to rollback the stack.</p>
|
|
7494
7521
|
*/
|
|
7495
7522
|
RoleARN?: string;
|
|
7496
7523
|
/**
|
|
@@ -7526,16 +7553,16 @@ export interface SetStackPolicyInput {
|
|
|
7526
7553
|
StackName: string | undefined;
|
|
7527
7554
|
/**
|
|
7528
7555
|
* <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
|
|
7529
|
-
* to Stack Resources</a> in the CloudFormation User Guide. You can specify
|
|
7530
|
-
* the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
7531
|
-
* both.</p>
|
|
7556
|
+
* to Stack Resources</a> in the CloudFormation User Guide. You can specify
|
|
7557
|
+
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
7558
|
+
* not both.</p>
|
|
7532
7559
|
*/
|
|
7533
7560
|
StackPolicyBody?: string;
|
|
7534
7561
|
/**
|
|
7535
|
-
* <p>Location of a file containing the stack policy. The URL must point to a policy
|
|
7536
|
-
*
|
|
7537
|
-
*
|
|
7538
|
-
*
|
|
7562
|
+
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum
|
|
7563
|
+
* size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify
|
|
7564
|
+
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
7565
|
+
* not both.</p>
|
|
7539
7566
|
*/
|
|
7540
7567
|
StackPolicyURL?: string;
|
|
7541
7568
|
}
|
|
@@ -7661,15 +7688,15 @@ export interface SignalResourceInput {
|
|
|
7661
7688
|
*/
|
|
7662
7689
|
LogicalResourceId: string | undefined;
|
|
7663
7690
|
/**
|
|
7664
|
-
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling
|
|
7665
|
-
*
|
|
7666
|
-
*
|
|
7667
|
-
*
|
|
7691
|
+
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups,
|
|
7692
|
+
* specify the instance ID that you are signaling as the unique ID. If you send multiple
|
|
7693
|
+
* signals to a single resource (such as signaling a wait condition), each signal requires a
|
|
7694
|
+
* different unique ID.</p>
|
|
7668
7695
|
*/
|
|
7669
7696
|
UniqueId: string | undefined;
|
|
7670
7697
|
/**
|
|
7671
7698
|
* <p>The status of the signal, which is either success or failure. A failure signal causes
|
|
7672
|
-
*
|
|
7699
|
+
* CloudFormation to immediately fail the stack creation or update.</p>
|
|
7673
7700
|
*/
|
|
7674
7701
|
Status: ResourceSignalStatus | string | undefined;
|
|
7675
7702
|
}
|
|
@@ -7681,8 +7708,7 @@ export declare namespace SignalResourceInput {
|
|
|
7681
7708
|
}
|
|
7682
7709
|
export interface StopStackSetOperationInput {
|
|
7683
7710
|
/**
|
|
7684
|
-
* <p>The name or unique ID of the stack set that you want to stop the operation
|
|
7685
|
-
* for.</p>
|
|
7711
|
+
* <p>The name or unique ID of the stack set that you want to stop the operation for.</p>
|
|
7686
7712
|
*/
|
|
7687
7713
|
StackSetName: string | undefined;
|
|
7688
7714
|
/**
|
|
@@ -7807,8 +7833,8 @@ export interface UpdateStackInput {
|
|
|
7807
7833
|
*/
|
|
7808
7834
|
TemplateBody?: string;
|
|
7809
7835
|
/**
|
|
7810
|
-
* <p>Location of file containing the template body. The URL must point to a template that
|
|
7811
|
-
*
|
|
7836
|
+
* <p>Location of file containing the template body. The URL must point to a template that is
|
|
7837
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information, go to
|
|
7812
7838
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
7813
7839
|
* in the CloudFormation User Guide.</p>
|
|
7814
7840
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
@@ -7825,28 +7851,27 @@ export interface UpdateStackInput {
|
|
|
7825
7851
|
*/
|
|
7826
7852
|
UsePreviousTemplate?: boolean;
|
|
7827
7853
|
/**
|
|
7828
|
-
* <p>Structure containing the temporary overriding stack policy body. You can specify
|
|
7829
|
-
*
|
|
7830
|
-
*
|
|
7831
|
-
* <p>If you want to update protected resources, specify a temporary overriding stack
|
|
7832
|
-
*
|
|
7854
|
+
* <p>Structure containing the temporary overriding stack policy body. You can specify either
|
|
7855
|
+
* the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code>
|
|
7856
|
+
* parameter, but not both.</p>
|
|
7857
|
+
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
|
7858
|
+
* during this update. If you do not specify a stack policy, the current policy that is
|
|
7833
7859
|
* associated with the stack will be used.</p>
|
|
7834
7860
|
*/
|
|
7835
7861
|
StackPolicyDuringUpdateBody?: string;
|
|
7836
7862
|
/**
|
|
7837
|
-
* <p>Location of a file containing the temporary overriding stack policy. The URL must
|
|
7838
|
-
*
|
|
7839
|
-
*
|
|
7840
|
-
* <code>
|
|
7841
|
-
*
|
|
7842
|
-
*
|
|
7843
|
-
* policy during this update. If you do not specify a stack policy, the current policy that is
|
|
7863
|
+
* <p>Location of a file containing the temporary overriding stack policy. The URL must point
|
|
7864
|
+
* to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You
|
|
7865
|
+
* can specify either the <code>StackPolicyDuringUpdateBody</code> or the
|
|
7866
|
+
* <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p>
|
|
7867
|
+
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
|
7868
|
+
* during this update. If you do not specify a stack policy, the current policy that is
|
|
7844
7869
|
* associated with the stack will be used.</p>
|
|
7845
7870
|
*/
|
|
7846
7871
|
StackPolicyDuringUpdateURL?: string;
|
|
7847
7872
|
/**
|
|
7848
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the
|
|
7849
|
-
*
|
|
7873
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack.
|
|
7874
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data
|
|
7850
7875
|
* type.</p>
|
|
7851
7876
|
*/
|
|
7852
7877
|
Parameters?: Parameter[];
|
|
@@ -7858,8 +7883,8 @@ export interface UpdateStackInput {
|
|
|
7858
7883
|
* <p>
|
|
7859
7884
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
7860
7885
|
* </p>
|
|
7861
|
-
* <p>Some stack templates might include resources that can affect permissions in
|
|
7862
|
-
*
|
|
7886
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
|
7887
|
+
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
7863
7888
|
* (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one
|
|
7864
7889
|
* of these capabilities.</p>
|
|
7865
7890
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -7878,9 +7903,8 @@ export interface UpdateStackInput {
|
|
|
7878
7903
|
* <code>InsufficientCapabilities</code> error.</p>
|
|
7879
7904
|
* </li>
|
|
7880
7905
|
* </ul>
|
|
7881
|
-
* <p>If your stack template contains these resources, we recommend that you review
|
|
7882
|
-
*
|
|
7883
|
-
* necessary.</p>
|
|
7906
|
+
* <p>If your stack template contains these resources, we recommend that you review all
|
|
7907
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
|
7884
7908
|
* <ul>
|
|
7885
7909
|
* <li>
|
|
7886
7910
|
* <p>
|
|
@@ -7956,21 +7980,22 @@ export interface UpdateStackInput {
|
|
|
7956
7980
|
*/
|
|
7957
7981
|
Capabilities?: (Capability | string)[];
|
|
7958
7982
|
/**
|
|
7959
|
-
* <p>The template resource types that you have permissions to work with for this update
|
|
7960
|
-
*
|
|
7983
|
+
* <p>The template resource types that you have permissions to work with for this update stack
|
|
7984
|
+
* action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or
|
|
7961
7985
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
7962
|
-
* <p>If the list of resource types doesn't include a resource that you're updating, the
|
|
7963
|
-
*
|
|
7964
|
-
*
|
|
7986
|
+
* <p>If the list of resource types doesn't include a resource that you're updating, the stack
|
|
7987
|
+
* update fails. By default, CloudFormation grants permissions to all resource types.
|
|
7988
|
+
* Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
7989
|
+
* 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
|
|
7990
|
+
* Identity and Access Management</a>.</p>
|
|
7965
7991
|
*/
|
|
7966
7992
|
ResourceTypes?: string[];
|
|
7967
7993
|
/**
|
|
7968
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
7969
|
-
*
|
|
7970
|
-
*
|
|
7971
|
-
*
|
|
7972
|
-
*
|
|
7973
|
-
* Ensure that the role grants least privilege.</p>
|
|
7994
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's
|
|
7995
|
+
* credentials to make calls on your behalf. CloudFormation always uses this role for
|
|
7996
|
+
* all future operations on the stack. As long as users have permission to operate on the
|
|
7997
|
+
* stack, CloudFormation uses this role even if the users don't have permission to
|
|
7998
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
|
7974
7999
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
7975
8000
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
7976
8001
|
* session that is generated from your user credentials.</p>
|
|
@@ -7985,25 +8010,24 @@ export interface UpdateStackInput {
|
|
|
7985
8010
|
* <p>Structure containing a new stack policy body. You can specify either the
|
|
7986
8011
|
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
7987
8012
|
* both.</p>
|
|
7988
|
-
* <p>You might update the stack policy, for example, in order to protect a new resource
|
|
7989
|
-
*
|
|
7990
|
-
*
|
|
8013
|
+
* <p>You might update the stack policy, for example, in order to protect a new resource that
|
|
8014
|
+
* you created during a stack update. If you do not specify a stack policy, the current policy
|
|
8015
|
+
* that is associated with the stack is unchanged.</p>
|
|
7991
8016
|
*/
|
|
7992
8017
|
StackPolicyBody?: string;
|
|
7993
8018
|
/**
|
|
7994
|
-
* <p>Location of a file containing the updated stack policy. The URL must point to a
|
|
7995
|
-
*
|
|
7996
|
-
*
|
|
7997
|
-
*
|
|
7998
|
-
* <p>You might update the stack policy, for example, in order to protect a new resource
|
|
7999
|
-
*
|
|
8000
|
-
*
|
|
8019
|
+
* <p>Location of a file containing the updated stack policy. The URL must point to a policy
|
|
8020
|
+
* (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify
|
|
8021
|
+
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
8022
|
+
* not both.</p>
|
|
8023
|
+
* <p>You might update the stack policy, for example, in order to protect a new resource that
|
|
8024
|
+
* you created during a stack update. If you do not specify a stack policy, the current policy
|
|
8025
|
+
* that is associated with the stack is unchanged.</p>
|
|
8001
8026
|
*/
|
|
8002
8027
|
StackPolicyURL?: string;
|
|
8003
8028
|
/**
|
|
8004
|
-
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
|
|
8005
|
-
*
|
|
8006
|
-
* topics.</p>
|
|
8029
|
+
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all
|
|
8030
|
+
* notification topics.</p>
|
|
8007
8031
|
*/
|
|
8008
8032
|
NotificationARNs?: string[];
|
|
8009
8033
|
/**
|
|
@@ -8022,15 +8046,15 @@ export interface UpdateStackInput {
|
|
|
8022
8046
|
*/
|
|
8023
8047
|
DisableRollback?: boolean;
|
|
8024
8048
|
/**
|
|
8025
|
-
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if
|
|
8026
|
-
*
|
|
8049
|
+
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you
|
|
8050
|
+
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
8027
8051
|
* update a stack with the same name. You might retry <code>UpdateStack</code> requests to
|
|
8028
8052
|
* ensure that CloudFormation successfully received them.</p>
|
|
8029
8053
|
* <p>All events triggered by a given stack operation are assigned the same client request
|
|
8030
8054
|
* token, which you can use to track operations. For example, if you execute a
|
|
8031
|
-
*
|
|
8032
|
-
*
|
|
8033
|
-
*
|
|
8055
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
8056
|
+
* <code>StackEvents</code> generated by that operation will have
|
|
8057
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
8034
8058
|
* <p>In the console, stack operations display the client request token on the Events tab.
|
|
8035
8059
|
* Stack operations that are initiated from the console use the token format
|
|
8036
8060
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
@@ -8067,10 +8091,11 @@ export interface UpdateStackInstancesInput {
|
|
|
8067
8091
|
*/
|
|
8068
8092
|
StackSetName: string | undefined;
|
|
8069
8093
|
/**
|
|
8070
|
-
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for
|
|
8071
|
-
*
|
|
8072
|
-
* in the specified accounts and Regions.</p>
|
|
8073
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
8094
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for
|
|
8095
|
+
* which you want to update parameter values for stack instances. The overridden parameter
|
|
8096
|
+
* values will be applied to all stack instances in the specified accounts and Regions.</p>
|
|
8097
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
8098
|
+
* both.</p>
|
|
8074
8099
|
*/
|
|
8075
8100
|
Accounts?: string[];
|
|
8076
8101
|
/**
|
|
@@ -8084,39 +8109,37 @@ export interface UpdateStackInstancesInput {
|
|
|
8084
8109
|
*/
|
|
8085
8110
|
DeploymentTargets?: DeploymentTargets;
|
|
8086
8111
|
/**
|
|
8087
|
-
* <p>The names of one or more Regions in which you want to update parameter values for
|
|
8088
|
-
*
|
|
8089
|
-
*
|
|
8112
|
+
* <p>The names of one or more Regions in which you want to update parameter values for stack
|
|
8113
|
+
* instances. The overridden parameter values will be applied to all stack instances in the
|
|
8114
|
+
* specified accounts and Regions.</p>
|
|
8090
8115
|
*/
|
|
8091
8116
|
Regions: string[] | undefined;
|
|
8092
8117
|
/**
|
|
8093
8118
|
* <p> A list of input parameters whose values you want to update for the specified stack
|
|
8094
8119
|
* instances. </p>
|
|
8095
|
-
* <p>Any overridden parameter values will be applied to all stack instances in the
|
|
8096
|
-
*
|
|
8097
|
-
* how CloudFormation sets parameter values during stack instance update
|
|
8098
|
-
* operations:</p>
|
|
8120
|
+
* <p>Any overridden parameter values will be applied to all stack instances in the specified
|
|
8121
|
+
* accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:</p>
|
|
8099
8122
|
* <ul>
|
|
8100
8123
|
* <li>
|
|
8101
|
-
* <p>To override the current value for a parameter, include the parameter and
|
|
8102
|
-
*
|
|
8124
|
+
* <p>To override the current value for a parameter, include the parameter and specify
|
|
8125
|
+
* its value.</p>
|
|
8103
8126
|
* </li>
|
|
8104
8127
|
* <li>
|
|
8105
|
-
* <p>To leave an overridden parameter set to its present value, include the parameter
|
|
8106
|
-
* <code>true</code>. (You cannot specify
|
|
8107
|
-
* <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
8128
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter
|
|
8129
|
+
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify
|
|
8130
|
+
* both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
8108
8131
|
* </li>
|
|
8109
8132
|
* <li>
|
|
8110
8133
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
8111
8134
|
* specify a parameter list but do not include the parameter in the list.</p>
|
|
8112
8135
|
* </li>
|
|
8113
8136
|
* <li>
|
|
8114
|
-
* <p>To leave all parameters set to their present values, do not specify this
|
|
8115
|
-
*
|
|
8137
|
+
* <p>To leave all parameters set to their present values, do not specify this property
|
|
8138
|
+
* at all.</p>
|
|
8116
8139
|
* </li>
|
|
8117
8140
|
* </ul>
|
|
8118
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance are
|
|
8119
|
-
*
|
|
8141
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance are not
|
|
8142
|
+
* updated, but retain their overridden value.</p>
|
|
8120
8143
|
* <p>You can only override the parameter <i>values</i> that are specified in
|
|
8121
8144
|
* the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to
|
|
8122
8145
|
* update the stack set template. If you add a parameter to a template, before you can
|
|
@@ -8132,10 +8155,8 @@ export interface UpdateStackInstancesInput {
|
|
|
8132
8155
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8133
8156
|
/**
|
|
8134
8157
|
* <p>The unique identifier for this stack set operation. </p>
|
|
8135
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
8136
|
-
*
|
|
8137
|
-
* multiple times. You might retry stack set operation requests to ensure that
|
|
8138
|
-
* CloudFormation successfully received them.</p>
|
|
8158
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request
|
|
8159
|
+
* multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
8139
8160
|
* <p>If you don't specify an operation ID, the SDK generates one automatically.
|
|
8140
8161
|
* </p>
|
|
8141
8162
|
*/
|
|
@@ -8227,8 +8248,8 @@ export interface UpdateStackSetInput {
|
|
|
8227
8248
|
* <p>
|
|
8228
8249
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
8229
8250
|
* </p>
|
|
8230
|
-
* <p>Some stack templates might include resources that can affect permissions in
|
|
8231
|
-
*
|
|
8251
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
|
8252
|
+
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
8232
8253
|
* (IAM) users. For those stacks sets, you must explicitly acknowledge this by
|
|
8233
8254
|
* specifying one of these capabilities.</p>
|
|
8234
8255
|
* <p>The following IAM resources require you to specify either the
|
|
@@ -8247,9 +8268,8 @@ export interface UpdateStackSetInput {
|
|
|
8247
8268
|
* <code>InsufficientCapabilities</code> error.</p>
|
|
8248
8269
|
* </li>
|
|
8249
8270
|
* </ul>
|
|
8250
|
-
* <p>If your stack template contains these resources, we recommend that you review
|
|
8251
|
-
*
|
|
8252
|
-
* necessary.</p>
|
|
8271
|
+
* <p>If your stack template contains these resources, we recommend that you review all
|
|
8272
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
|
8253
8273
|
* <ul>
|
|
8254
8274
|
* <li>
|
|
8255
8275
|
* <p>
|
|
@@ -8317,8 +8337,8 @@ export interface UpdateStackSetInput {
|
|
|
8317
8337
|
Capabilities?: (Capability | string)[];
|
|
8318
8338
|
/**
|
|
8319
8339
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
8320
|
-
*
|
|
8321
|
-
* the stacks. You can specify a maximum number of 50 tags.</p>
|
|
8340
|
+
* CloudFormation also propagates these tags to supported resources that are
|
|
8341
|
+
* created in the stacks. You can specify a maximum number of 50 tags.</p>
|
|
8322
8342
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are
|
|
8323
8343
|
* currently associated with this stack set. This means:</p>
|
|
8324
8344
|
* <ul>
|
|
@@ -8339,11 +8359,10 @@ export interface UpdateStackSetInput {
|
|
|
8339
8359
|
* associated tags.</p>
|
|
8340
8360
|
* </li>
|
|
8341
8361
|
* </ul>
|
|
8342
|
-
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action,
|
|
8343
|
-
*
|
|
8344
|
-
*
|
|
8345
|
-
*
|
|
8346
|
-
* and checks to see if you have permission to untag resources. If you don't have the
|
|
8362
|
+
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action, CloudFormation checks to see if you have the required IAM permission to tag resources.
|
|
8363
|
+
* If you omit tags that are currently associated with the stack set from the list of tags you
|
|
8364
|
+
* specify, CloudFormation assumes that you want to remove those tags from the stack
|
|
8365
|
+
* set, and checks to see if you have permission to untag resources. If you don't have the
|
|
8347
8366
|
* necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an
|
|
8348
8367
|
* <code>access denied</code> error, and the stack set is not updated.</p>
|
|
8349
8368
|
*/
|
|
@@ -8420,14 +8439,12 @@ export interface UpdateStackSetInput {
|
|
|
8420
8439
|
AutoDeployment?: AutoDeployment;
|
|
8421
8440
|
/**
|
|
8422
8441
|
* <p>The unique ID for this stack set operation. </p>
|
|
8423
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that
|
|
8424
|
-
*
|
|
8425
|
-
* multiple times. You might retry stack set operation requests to ensure that
|
|
8426
|
-
* CloudFormation successfully received them.</p>
|
|
8442
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request
|
|
8443
|
+
* multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
8427
8444
|
* <p>If you don't specify an operation ID, CloudFormation generates one
|
|
8428
8445
|
* automatically.</p>
|
|
8429
|
-
* <p>Repeating this stack set operation with a new operation ID retries all stack
|
|
8430
|
-
*
|
|
8446
|
+
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
8447
|
+
* whose status is <code>OUTDATED</code>. </p>
|
|
8431
8448
|
*/
|
|
8432
8449
|
OperationId?: string;
|
|
8433
8450
|
/**
|
|
@@ -8478,6 +8495,11 @@ export interface UpdateStackSetInput {
|
|
|
8478
8495
|
* </ul>
|
|
8479
8496
|
*/
|
|
8480
8497
|
CallAs?: CallAs | string;
|
|
8498
|
+
/**
|
|
8499
|
+
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
|
8500
|
+
* conflicting operations.</p>
|
|
8501
|
+
*/
|
|
8502
|
+
ManagedExecution?: ManagedExecution;
|
|
8481
8503
|
}
|
|
8482
8504
|
export declare namespace UpdateStackSetInput {
|
|
8483
8505
|
/**
|
|
@@ -8595,10 +8617,10 @@ export interface ValidateTemplateOutput {
|
|
|
8595
8617
|
*/
|
|
8596
8618
|
Description?: string;
|
|
8597
8619
|
/**
|
|
8598
|
-
* <p>The capabilities found within the template. If your template contains IAM resources,
|
|
8599
|
-
*
|
|
8600
|
-
*
|
|
8601
|
-
*
|
|
8620
|
+
* <p>The capabilities found within the template. If your template contains IAM resources, you
|
|
8621
|
+
* must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you
|
|
8622
|
+
* use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your
|
|
8623
|
+
* template; otherwise, those actions return an InsufficientCapabilities error.</p>
|
|
8602
8624
|
* <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>
|
|
8603
8625
|
*/
|
|
8604
8626
|
Capabilities?: (Capability | string)[];
|