@aws-sdk/client-cloudformation 3.50.0 → 3.53.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 +30 -0
- package/README.md +10 -10
- package/dist-cjs/CloudFormation.js +15 -0
- package/dist-cjs/commands/DescribeChangeSetHooksCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/CloudFormationServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +374 -5
- package/dist-cjs/protocols/Aws_query.js +622 -1350
- package/dist-es/CloudFormation.js +15 -0
- package/dist-es/commands/DescribeChangeSetHooksCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/CloudFormationServiceException.js +12 -0
- package/dist-es/models/models_0.js +338 -1
- package/dist-es/protocols/Aws_query.js +1166 -1418
- package/dist-types/CloudFormation.d.ts +134 -130
- package/dist-types/CloudFormationClient.d.ts +13 -12
- package/dist-types/commands/ActivateTypeCommand.d.ts +1 -2
- package/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +2 -2
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -1
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +8 -8
- package/dist-types/commands/CreateChangeSetCommand.d.ts +6 -7
- package/dist-types/commands/CreateStackCommand.d.ts +1 -1
- package/dist-types/commands/CreateStackInstancesCommand.d.ts +4 -4
- package/dist-types/commands/DeactivateTypeCommand.d.ts +3 -3
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterTypeCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeChangeSetCommand.d.ts +2 -3
- package/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +35 -0
- package/dist-types/commands/DescribePublisherCommand.d.ts +3 -4
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeStackSetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackSetOperationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStacksCommand.d.ts +1 -1
- package/dist-types/commands/DetectStackDriftCommand.d.ts +1 -1
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +1 -1
- package/dist-types/commands/DetectStackSetDriftCommand.d.ts +7 -6
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +7 -7
- package/dist-types/commands/GetTemplateCommand.d.ts +3 -3
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +1 -1
- package/dist-types/commands/ImportStacksToStackSetCommand.d.ts +9 -6
- package/dist-types/commands/ListExportsCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetOperationResultsCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetOperationsCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetsCommand.d.ts +2 -3
- package/dist-types/commands/PublishTypeCommand.d.ts +4 -6
- package/dist-types/commands/RecordHandlerProgressCommand.d.ts +1 -1
- package/dist-types/commands/RegisterPublisherCommand.d.ts +4 -4
- package/dist-types/commands/RegisterTypeCommand.d.ts +5 -6
- package/dist-types/commands/RollbackStackCommand.d.ts +1 -1
- package/dist-types/commands/SetTypeConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/SignalResourceCommand.d.ts +2 -2
- package/dist-types/commands/StopStackSetOperationCommand.d.ts +1 -1
- package/dist-types/commands/TestTypeCommand.d.ts +4 -5
- package/dist-types/commands/UpdateStackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStackInstancesCommand.d.ts +6 -5
- package/dist-types/commands/UpdateStackSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/CloudFormationServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +1165 -800
- package/dist-types/protocols/Aws_query.d.ts +3 -0
- package/dist-types/ts3.4/CloudFormation.d.ts +335 -0
- package/dist-types/ts3.4/CloudFormationClient.d.ts +139 -0
- package/dist-types/ts3.4/commands/ActivateTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/BatchDescribeTypeConfigurationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CancelUpdateStackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ContinueUpdateRollbackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateChangeSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateStackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateStackInstancesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateStackSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeactivateTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteChangeSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteStackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteStackInstancesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteStackSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeregisterTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAccountLimitsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeChangeSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeChangeSetHooksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribePublisherCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackDriftDetectionStatusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackEventsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackInstanceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackResourceDriftsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackResourcesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStackSetOperationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeStacksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeTypeRegistrationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DetectStackDriftCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DetectStackResourceDriftCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DetectStackSetDriftCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/EstimateTemplateCostCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ExecuteChangeSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetStackPolicyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetTemplateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetTemplateSummaryCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ImportStacksToStackSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListChangeSetsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExportsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListImportsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListStackInstancesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListStackResourcesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListStackSetOperationResultsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListStackSetOperationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListStackSetsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListStacksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListTypeRegistrationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListTypeVersionsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListTypesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/PublishTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/RecordHandlerProgressCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/RegisterPublisherCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/RegisterTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/RollbackStackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SetStackPolicyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SetTypeConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SetTypeDefaultVersionCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SignalResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StopStackSetOperationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/TestTypeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateStackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateStackInstancesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateStackSetCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateTerminationProtectionCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ValidateTemplateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +66 -0
- package/dist-types/ts3.4/endpoints.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +7 -0
- package/dist-types/ts3.4/models/CloudFormationServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +3215 -0
- package/dist-types/ts3.4/pagination/DescribeAccountLimitsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/DescribeStackEventsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/DescribeStackResourceDriftsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/DescribeStacksPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListChangeSetsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListExportsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListImportsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListStackInstancesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListStackResourcesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListStackSetOperationResultsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListStackSetOperationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListStackSetsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListStacksPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListTypeRegistrationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListTypeVersionsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListTypesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +17 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +200 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +38 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +38 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +37 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
- package/dist-types/ts3.4/waiters/index.d.ts +8 -0
- package/dist-types/ts3.4/waiters/waitForChangeSetCreateComplete.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForStackCreateComplete.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForStackDeleteComplete.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForStackExists.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForStackImportComplete.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForStackRollbackComplete.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForStackUpdateComplete.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForTypeRegistrationComplete.d.ts +7 -0
- package/package.json +34 -34
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { CloudFormationServiceException as __BaseException } from "./CloudFormationServiceException";
|
|
2
3
|
export declare type AccountGateStatus = "FAILED" | "SKIPPED" | "SUCCEEDED";
|
|
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
|
-
*
|
|
6
|
-
* <p>For each account and Region, CloudFormation lets you specify a Lambda
|
|
7
|
-
* that encapsulates any requirements that must be met before CloudFormation
|
|
8
|
-
* proceed with a stack set operation in that account and Region. CloudFormation
|
|
5
|
+
* <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 account and
|
|
6
|
+
* Region.</p>
|
|
7
|
+
* <p>For each account and Region, CloudFormation lets you specify a Lambda
|
|
8
|
+
* function that encapsulates any requirements that must be met before CloudFormation
|
|
9
|
+
* can proceed with a stack set operation in that account and Region. CloudFormation
|
|
9
10
|
* invokes the function each time a stack set operation is requested for that account and
|
|
10
11
|
* Region; if the function returns <code>FAILED</code>, CloudFormation cancels the
|
|
11
12
|
* operation in that account and Region, and sets the stack set operation result status for
|
|
@@ -20,15 +21,15 @@ export interface AccountGateResult {
|
|
|
20
21
|
* <li>
|
|
21
22
|
* <p>
|
|
22
23
|
* <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
|
|
24
|
-
*
|
|
24
|
+
* and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and
|
|
25
|
+
* Region.</p>
|
|
25
26
|
* </li>
|
|
26
27
|
* <li>
|
|
27
28
|
* <p>
|
|
28
29
|
* <code>FAILED</code>: The account gate function has determined that the account and
|
|
29
|
-
* Region
|
|
30
|
-
*
|
|
31
|
-
* <code>FAILED</code
|
|
30
|
+
* Region doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets
|
|
31
|
+
* the stack set operation result status for that account and Region to
|
|
32
|
+
* <code>FAILED</code>.</p>
|
|
32
33
|
* </li>
|
|
33
34
|
* <li>
|
|
34
35
|
* <p>
|
|
@@ -36,13 +37,13 @@ export interface AccountGateResult {
|
|
|
36
37
|
* function for this account and Region, for one of the following reasons:</p>
|
|
37
38
|
* <ul>
|
|
38
39
|
* <li>
|
|
39
|
-
* <p>An account gate function
|
|
40
|
+
* <p>An account gate function hasn't been specified for the account and Region.
|
|
40
41
|
* CloudFormation proceeds with the stack set operation in this account
|
|
41
42
|
* and Region.</p>
|
|
42
43
|
* </li>
|
|
43
44
|
* <li>
|
|
44
45
|
* <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set
|
|
45
|
-
*
|
|
46
|
+
* administration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and
|
|
46
47
|
* Region.</p>
|
|
47
48
|
* </li>
|
|
48
49
|
* <li>
|
|
@@ -68,7 +69,7 @@ export declare namespace AccountGateResult {
|
|
|
68
69
|
const filterSensitiveLog: (obj: AccountGateResult) => any;
|
|
69
70
|
}
|
|
70
71
|
/**
|
|
71
|
-
* <p>The AccountLimit data type
|
|
72
|
+
* <p>The AccountLimit data type.</p>
|
|
72
73
|
* <p>CloudFormation has the following limits per account:</p>
|
|
73
74
|
* <ul>
|
|
74
75
|
* <li>
|
|
@@ -82,7 +83,8 @@ export declare namespace AccountGateResult {
|
|
|
82
83
|
* </li>
|
|
83
84
|
* </ul>
|
|
84
85
|
* <p>For more information about these account limits, and other CloudFormation
|
|
85
|
-
* limits, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
86
|
+
* limits, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
87
|
+
* quotas</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
86
88
|
*/
|
|
87
89
|
export interface AccountLimit {
|
|
88
90
|
/**
|
|
@@ -93,7 +95,7 @@ export interface AccountLimit {
|
|
|
93
95
|
*/
|
|
94
96
|
Name?: string;
|
|
95
97
|
/**
|
|
96
|
-
* <p>The value that
|
|
98
|
+
* <p>The value that's associated with the account limit name.</p>
|
|
97
99
|
*/
|
|
98
100
|
Value?: number;
|
|
99
101
|
}
|
|
@@ -108,12 +110,12 @@ export declare namespace AccountLimit {
|
|
|
108
110
|
*/
|
|
109
111
|
export interface LoggingConfig {
|
|
110
112
|
/**
|
|
111
|
-
* <p>The ARN of the role that CloudFormation should assume
|
|
112
|
-
* to CloudWatch
|
|
113
|
+
* <p>The Amazon Resource Name (ARN) of the role that CloudFormation should assume
|
|
114
|
+
* when sending log entries to CloudWatch Logs.</p>
|
|
113
115
|
*/
|
|
114
116
|
LogRoleArn: string | undefined;
|
|
115
117
|
/**
|
|
116
|
-
* <p>The Amazon CloudWatch
|
|
118
|
+
* <p>The Amazon CloudWatch Logs group to which CloudFormation sends error logging
|
|
117
119
|
* information when invoking the extension's handlers.</p>
|
|
118
120
|
*/
|
|
119
121
|
LogGroupName: string | undefined;
|
|
@@ -125,6 +127,7 @@ export declare namespace LoggingConfig {
|
|
|
125
127
|
const filterSensitiveLog: (obj: LoggingConfig) => any;
|
|
126
128
|
}
|
|
127
129
|
export declare enum ThirdPartyType {
|
|
130
|
+
HOOK = "HOOK",
|
|
128
131
|
MODULE = "MODULE",
|
|
129
132
|
RESOURCE = "RESOURCE"
|
|
130
133
|
}
|
|
@@ -159,9 +162,9 @@ export interface ActivateTypeInput {
|
|
|
159
162
|
TypeName?: string;
|
|
160
163
|
/**
|
|
161
164
|
* <p>An alias to assign to the public extension, in this account and region. If you specify
|
|
162
|
-
* an alias for the extension, CloudFormation treats the alias as the extension type
|
|
163
|
-
* within this account and region. You must use the alias to refer to the extension in
|
|
164
|
-
* templates, API calls, and CloudFormation console.</p>
|
|
165
|
+
* an alias for the extension, CloudFormation treats the alias as the extension type
|
|
166
|
+
* name within this account and region. You must use the alias to refer to the extension in
|
|
167
|
+
* your templates, API calls, and CloudFormation console.</p>
|
|
165
168
|
* <p>An extension alias must be unique within a given account and region. You can activate
|
|
166
169
|
* the same public resource multiple times in the same account and region, using different
|
|
167
170
|
* type name aliases.</p>
|
|
@@ -179,7 +182,8 @@ export interface ActivateTypeInput {
|
|
|
179
182
|
*/
|
|
180
183
|
LoggingConfig?: LoggingConfig;
|
|
181
184
|
/**
|
|
182
|
-
* <p>The name of the IAM execution role to use to activate the
|
|
185
|
+
* <p>The name of the IAM execution role to use to activate the
|
|
186
|
+
* extension.</p>
|
|
183
187
|
*/
|
|
184
188
|
ExecutionRoleArn?: string;
|
|
185
189
|
/**
|
|
@@ -189,13 +193,13 @@ export interface ActivateTypeInput {
|
|
|
189
193
|
* <ul>
|
|
190
194
|
* <li>
|
|
191
195
|
* <p>
|
|
192
|
-
* <code>MAJOR</code>: CloudFormation updates the extension to the newest
|
|
193
|
-
* version, if one is available.</p>
|
|
196
|
+
* <code>MAJOR</code>: CloudFormation updates the extension to the newest
|
|
197
|
+
* major version, if one is available.</p>
|
|
194
198
|
* </li>
|
|
195
199
|
* <li>
|
|
196
200
|
* <p>
|
|
197
|
-
* <code>MINOR</code>: CloudFormation updates the extension to the newest
|
|
198
|
-
* version, if one is available.</p>
|
|
201
|
+
* <code>MINOR</code>: CloudFormation updates the extension to the newest
|
|
202
|
+
* minor version, if one is available.</p>
|
|
199
203
|
* </li>
|
|
200
204
|
* </ul>
|
|
201
205
|
*/
|
|
@@ -231,26 +235,38 @@ export declare namespace ActivateTypeOutput {
|
|
|
231
235
|
/**
|
|
232
236
|
* <p>An error occurred during a CloudFormation registry operation.</p>
|
|
233
237
|
*/
|
|
234
|
-
export
|
|
235
|
-
name: "CFNRegistryException";
|
|
236
|
-
$fault: "client";
|
|
238
|
+
export declare class CFNRegistryException extends __BaseException {
|
|
239
|
+
readonly name: "CFNRegistryException";
|
|
240
|
+
readonly $fault: "client";
|
|
237
241
|
Message?: string;
|
|
242
|
+
/**
|
|
243
|
+
* @internal
|
|
244
|
+
*/
|
|
245
|
+
constructor(opts: __ExceptionOptionType<CFNRegistryException, __BaseException>);
|
|
238
246
|
}
|
|
239
247
|
/**
|
|
240
|
-
* <p>The specified extension
|
|
248
|
+
* <p>The specified extension doesn't exist in the CloudFormation registry.</p>
|
|
241
249
|
*/
|
|
242
|
-
export
|
|
243
|
-
name: "TypeNotFoundException";
|
|
244
|
-
$fault: "client";
|
|
250
|
+
export declare class TypeNotFoundException extends __BaseException {
|
|
251
|
+
readonly name: "TypeNotFoundException";
|
|
252
|
+
readonly $fault: "client";
|
|
245
253
|
Message?: string;
|
|
254
|
+
/**
|
|
255
|
+
* @internal
|
|
256
|
+
*/
|
|
257
|
+
constructor(opts: __ExceptionOptionType<TypeNotFoundException, __BaseException>);
|
|
246
258
|
}
|
|
247
259
|
/**
|
|
248
260
|
* <p>The resource with the name requested already exists.</p>
|
|
249
261
|
*/
|
|
250
|
-
export
|
|
251
|
-
name: "AlreadyExistsException";
|
|
252
|
-
$fault: "client";
|
|
262
|
+
export declare class AlreadyExistsException extends __BaseException {
|
|
263
|
+
readonly name: "AlreadyExistsException";
|
|
264
|
+
readonly $fault: "client";
|
|
253
265
|
Message?: string;
|
|
266
|
+
/**
|
|
267
|
+
* @internal
|
|
268
|
+
*/
|
|
269
|
+
constructor(opts: __ExceptionOptionType<AlreadyExistsException, __BaseException>);
|
|
254
270
|
}
|
|
255
271
|
/**
|
|
256
272
|
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to
|
|
@@ -279,13 +295,14 @@ export declare namespace AutoDeployment {
|
|
|
279
295
|
const filterSensitiveLog: (obj: AutoDeployment) => any;
|
|
280
296
|
}
|
|
281
297
|
/**
|
|
282
|
-
* <p>Identifying information for the configuration of a CloudFormation
|
|
298
|
+
* <p>Identifying information for the configuration of a CloudFormation
|
|
299
|
+
* extension.</p>
|
|
283
300
|
*/
|
|
284
301
|
export interface TypeConfigurationIdentifier {
|
|
285
302
|
/**
|
|
286
303
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and region.</p>
|
|
287
304
|
* <p>For public extensions, this will be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">activate the type</a> in this account and region. For private extensions, this will
|
|
288
|
-
* be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">register the type</a> in this account and region
|
|
305
|
+
* be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">register the type</a> in this account and region.</p>
|
|
289
306
|
*/
|
|
290
307
|
TypeArn?: string;
|
|
291
308
|
/**
|
|
@@ -338,7 +355,8 @@ export interface BatchDescribeTypeConfigurationsError {
|
|
|
338
355
|
*/
|
|
339
356
|
ErrorMessage?: string;
|
|
340
357
|
/**
|
|
341
|
-
* <p>Identifying information for the configuration of a CloudFormation
|
|
358
|
+
* <p>Identifying information for the configuration of a CloudFormation
|
|
359
|
+
* extension.</p>
|
|
342
360
|
*/
|
|
343
361
|
TypeConfigurationIdentifier?: TypeConfigurationIdentifier;
|
|
344
362
|
}
|
|
@@ -349,8 +367,8 @@ export declare namespace BatchDescribeTypeConfigurationsError {
|
|
|
349
367
|
const filterSensitiveLog: (obj: BatchDescribeTypeConfigurationsError) => any;
|
|
350
368
|
}
|
|
351
369
|
/**
|
|
352
|
-
* <p>Detailed information concerning the specification of a CloudFormation extension
|
|
353
|
-
* given account and region.</p>
|
|
370
|
+
* <p>Detailed information concerning the specification of a CloudFormation extension
|
|
371
|
+
* in a given account and region.</p>
|
|
354
372
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the
|
|
355
373
|
* <i>CloudFormation User Guide</i>.</p>
|
|
356
374
|
*/
|
|
@@ -367,21 +385,21 @@ export interface TypeConfigurationDetails {
|
|
|
367
385
|
Alias?: string;
|
|
368
386
|
/**
|
|
369
387
|
* <p>A JSON string specifying the configuration data for the extension, in this account and
|
|
370
|
-
* region
|
|
371
|
-
* <p>If a configuration
|
|
372
|
-
*
|
|
388
|
+
* region.</p>
|
|
389
|
+
* <p>If a configuration hasn't been set for a specified extension, CloudFormation
|
|
390
|
+
* returns <code>{}</code>.</p>
|
|
373
391
|
*/
|
|
374
392
|
Configuration?: string;
|
|
375
393
|
/**
|
|
376
394
|
* <p>When the configuration data was last updated for this extension.</p>
|
|
377
|
-
* <p>If a configuration
|
|
378
|
-
*
|
|
395
|
+
* <p>If a configuration hasn't been set for a specified extension, CloudFormation
|
|
396
|
+
* returns <code>null</code>.</p>
|
|
379
397
|
*/
|
|
380
398
|
LastUpdated?: Date;
|
|
381
399
|
/**
|
|
382
400
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and region.</p>
|
|
383
401
|
* <p>For public extensions, this will be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">activate the type</a> in this account and region. For private extensions, this will
|
|
384
|
-
* be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">register the type</a> in this account and region
|
|
402
|
+
* be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">register the type</a> in this account and region.</p>
|
|
385
403
|
*/
|
|
386
404
|
TypeArn?: string;
|
|
387
405
|
/**
|
|
@@ -407,8 +425,8 @@ export interface BatchDescribeTypeConfigurationsOutput {
|
|
|
407
425
|
*/
|
|
408
426
|
Errors?: BatchDescribeTypeConfigurationsError[];
|
|
409
427
|
/**
|
|
410
|
-
* <p>A list of any of the specified extension configurations that CloudFormation
|
|
411
|
-
* process for any reason.</p>
|
|
428
|
+
* <p>A list of any of the specified extension configurations that CloudFormation
|
|
429
|
+
* could not process for any reason.</p>
|
|
412
430
|
*/
|
|
413
431
|
UnprocessedTypeConfigurations?: TypeConfigurationIdentifier[];
|
|
414
432
|
/**
|
|
@@ -424,12 +442,16 @@ export declare namespace BatchDescribeTypeConfigurationsOutput {
|
|
|
424
442
|
const filterSensitiveLog: (obj: BatchDescribeTypeConfigurationsOutput) => any;
|
|
425
443
|
}
|
|
426
444
|
/**
|
|
427
|
-
* <p>The specified extension configuration
|
|
445
|
+
* <p>The specified extension configuration can't be found.</p>
|
|
428
446
|
*/
|
|
429
|
-
export
|
|
430
|
-
name: "TypeConfigurationNotFoundException";
|
|
431
|
-
$fault: "client";
|
|
447
|
+
export declare class TypeConfigurationNotFoundException extends __BaseException {
|
|
448
|
+
readonly name: "TypeConfigurationNotFoundException";
|
|
449
|
+
readonly $fault: "client";
|
|
432
450
|
Message?: string;
|
|
451
|
+
/**
|
|
452
|
+
* @internal
|
|
453
|
+
*/
|
|
454
|
+
constructor(opts: __ExceptionOptionType<TypeConfigurationNotFoundException, __BaseException>);
|
|
433
455
|
}
|
|
434
456
|
export declare enum CallAs {
|
|
435
457
|
DELEGATED_ADMIN = "DELEGATED_ADMIN",
|
|
@@ -440,15 +462,15 @@ export declare enum CallAs {
|
|
|
440
462
|
*/
|
|
441
463
|
export interface CancelUpdateStackInput {
|
|
442
464
|
/**
|
|
443
|
-
* <p>The name or the unique stack ID that
|
|
465
|
+
* <p>The name or the unique stack ID that's associated with the stack.</p>
|
|
444
466
|
*/
|
|
445
467
|
StackName: string | undefined;
|
|
446
468
|
/**
|
|
447
469
|
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token
|
|
448
|
-
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
449
|
-
*
|
|
450
|
-
* <code>CancelUpdateStack</code> requests to ensure that CloudFormation
|
|
451
|
-
*
|
|
470
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
471
|
+
* to cancel an update on a stack with the same name. You might retry
|
|
472
|
+
* <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully
|
|
473
|
+
* received them.</p>
|
|
452
474
|
*/
|
|
453
475
|
ClientRequestToken?: string;
|
|
454
476
|
}
|
|
@@ -461,10 +483,14 @@ export declare namespace CancelUpdateStackInput {
|
|
|
461
483
|
/**
|
|
462
484
|
* <p>A client request token already exists.</p>
|
|
463
485
|
*/
|
|
464
|
-
export
|
|
465
|
-
name: "TokenAlreadyExistsException";
|
|
466
|
-
$fault: "client";
|
|
486
|
+
export declare class TokenAlreadyExistsException extends __BaseException {
|
|
487
|
+
readonly name: "TokenAlreadyExistsException";
|
|
488
|
+
readonly $fault: "client";
|
|
467
489
|
Message?: string;
|
|
490
|
+
/**
|
|
491
|
+
* @internal
|
|
492
|
+
*/
|
|
493
|
+
constructor(opts: __ExceptionOptionType<TokenAlreadyExistsException, __BaseException>);
|
|
468
494
|
}
|
|
469
495
|
export declare enum Capability {
|
|
470
496
|
CAPABILITY_AUTO_EXPAND = "CAPABILITY_AUTO_EXPAND",
|
|
@@ -551,15 +577,15 @@ export interface ResourceChangeDetail {
|
|
|
551
577
|
/**
|
|
552
578
|
* <p>Indicates whether CloudFormation can determine the target value, and whether the
|
|
553
579
|
* target value will change before you execute a change set.</p>
|
|
554
|
-
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the
|
|
555
|
-
*
|
|
580
|
+
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the target
|
|
581
|
+
* value will change, and its value. For example, if you directly modify the
|
|
556
582
|
* <code>InstanceType</code> property of an EC2 instance, CloudFormation knows that
|
|
557
583
|
* this property value will change, and its value, so this is a <code>Static</code>
|
|
558
584
|
* evaluation.</p>
|
|
559
|
-
* <p>For <code>Dynamic</code> evaluations,
|
|
585
|
+
* <p>For <code>Dynamic</code> evaluations, can't determine the target value because it
|
|
560
586
|
* depends on the result of an intrinsic function, such as a <code>Ref</code> or
|
|
561
587
|
* <code>Fn::GetAtt</code> intrinsic function, when the stack is updated. For example, if
|
|
562
|
-
* your template includes a reference to a resource that
|
|
588
|
+
* your template includes a reference to a resource that's conditionally recreated, the value
|
|
563
589
|
* of the reference (the physical ID of the resource) might change, depending on if the
|
|
564
590
|
* resource is recreated. If the resource is recreated, it will have a new physical ID, so all
|
|
565
591
|
* references to that resource will also be updated.</p>
|
|
@@ -606,10 +632,9 @@ export interface ResourceChangeDetail {
|
|
|
606
632
|
ChangeSource?: ChangeSource | string;
|
|
607
633
|
/**
|
|
608
634
|
* <p>The identity of the entity that triggered this change. This entity is a member of the
|
|
609
|
-
* group that
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
* (<code>KeyPairName</code>).</p>
|
|
635
|
+
* group that's specified by the <code>ChangeSource</code> field. For example, if you modified
|
|
636
|
+
* the value of the <code>KeyPairName</code> parameter, the <code>CausingEntity</code> is the
|
|
637
|
+
* name of the parameter (<code>KeyPairName</code>).</p>
|
|
613
638
|
* <p>If the <code>ChangeSource</code> value is <code>DirectModification</code>, no value is
|
|
614
639
|
* given for <code>CausingEntity</code>.</p>
|
|
615
640
|
*/
|
|
@@ -625,16 +650,16 @@ export declare namespace ResourceChangeDetail {
|
|
|
625
650
|
* <p>Contains information about the module from which the resource was created, if the
|
|
626
651
|
* resource was created from a module included in the stack template.</p>
|
|
627
652
|
* <p>For more information on modules, see <a href="AWSCloudFormation/latest/UserGuide/modules.html">Using modules to encapsulate and
|
|
628
|
-
* reuse resource configurations</a> in the
|
|
629
|
-
*
|
|
653
|
+
* reuse resource configurations</a> in the
|
|
654
|
+
* <i>CloudFormation User Guide</i>.</p>
|
|
630
655
|
*/
|
|
631
656
|
export interface ModuleInfo {
|
|
632
657
|
/**
|
|
633
|
-
* <p>A
|
|
634
|
-
*
|
|
635
|
-
*
|
|
658
|
+
* <p>A concatenated list of the module type or types containing the resource. Module types
|
|
659
|
+
* are listed starting with the inner-most nested module, and separated by
|
|
660
|
+
* <code>/</code>.</p>
|
|
636
661
|
* <p>In the following example, the resource was created from a module of type
|
|
637
|
-
* <code>AWS::First::Example::MODULE</code>, that
|
|
662
|
+
* <code>AWS::First::Example::MODULE</code>, that's nested inside a parent module of type
|
|
638
663
|
* <code>AWS::Second::Example::MODULE</code>.</p>
|
|
639
664
|
* <p>
|
|
640
665
|
* <code>AWS::First::Example::MODULE/AWS::Second::Example::MODULE</code>
|
|
@@ -642,11 +667,11 @@ export interface ModuleInfo {
|
|
|
642
667
|
*/
|
|
643
668
|
TypeHierarchy?: string;
|
|
644
669
|
/**
|
|
645
|
-
* <p>A
|
|
646
|
-
*
|
|
670
|
+
* <p>A concatenated list of the logical IDs of the module or modules containing the resource.
|
|
671
|
+
* Modules are listed starting with the inner-most nested module, and separated by
|
|
647
672
|
* <code>/</code>.</p>
|
|
648
673
|
* <p>In the following example, the resource was created from a module, <code>moduleA</code>,
|
|
649
|
-
* that
|
|
674
|
+
* that's nested inside a parent module, <code>moduleB</code>.</p>
|
|
650
675
|
* <p>
|
|
651
676
|
* <code>moduleA/moduleB</code>
|
|
652
677
|
* </p>
|
|
@@ -673,10 +698,10 @@ export declare enum Replacement {
|
|
|
673
698
|
*/
|
|
674
699
|
export interface ResourceChange {
|
|
675
700
|
/**
|
|
676
|
-
* <p>The action that CloudFormation takes on the resource, such as <code>Add</code>
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
701
|
+
* <p>The action that CloudFormation takes on the resource, such as <code>Add</code> (adds
|
|
702
|
+
* a new resource), <code>Modify</code> (changes a resource), <code>Remove</code> (deletes a
|
|
703
|
+
* resource), <code>Import</code> (imports a resource), or <code>Dynamic</code> (exact action
|
|
704
|
+
* for the resource can't be determined).</p>
|
|
680
705
|
*/
|
|
681
706
|
Action?: ChangeAction | string;
|
|
682
707
|
/**
|
|
@@ -689,14 +714,13 @@ export interface ResourceChange {
|
|
|
689
714
|
*/
|
|
690
715
|
PhysicalResourceId?: string;
|
|
691
716
|
/**
|
|
692
|
-
* <p>The type of CloudFormation resource, such as
|
|
693
|
-
* <code>AWS::S3::Bucket</code>.</p>
|
|
717
|
+
* <p>The type of CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>
|
|
694
718
|
*/
|
|
695
719
|
ResourceType?: string;
|
|
696
720
|
/**
|
|
697
|
-
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will
|
|
698
|
-
*
|
|
699
|
-
*
|
|
721
|
+
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will replace
|
|
722
|
+
* the resource by creating a new one and deleting the old one. This value depends on the
|
|
723
|
+
* value of the <code>RequiresRecreation</code> property in the
|
|
700
724
|
* <code>ResourceTargetDefinition</code> structure. For example, if the
|
|
701
725
|
* <code>RequiresRecreation</code> field is <code>Always</code> and the
|
|
702
726
|
* <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is
|
|
@@ -718,7 +742,7 @@ export interface ResourceChange {
|
|
|
718
742
|
/**
|
|
719
743
|
* <p>For the <code>Modify</code> action, a list of <code>ResourceChangeDetail</code>
|
|
720
744
|
* structures that describes the changes that CloudFormation will make to the
|
|
721
|
-
* resource
|
|
745
|
+
* resource.</p>
|
|
722
746
|
*/
|
|
723
747
|
Details?: ResourceChangeDetail[];
|
|
724
748
|
/**
|
|
@@ -741,15 +765,20 @@ export declare enum ChangeType {
|
|
|
741
765
|
Resource = "Resource"
|
|
742
766
|
}
|
|
743
767
|
/**
|
|
744
|
-
* <p>The <code>Change</code> structure describes the changes CloudFormation will
|
|
745
|
-
*
|
|
768
|
+
* <p>The <code>Change</code> structure describes the changes CloudFormation will perform
|
|
769
|
+
* if you execute the change set.</p>
|
|
746
770
|
*/
|
|
747
771
|
export interface Change {
|
|
748
772
|
/**
|
|
749
|
-
* <p>The type of entity that CloudFormation changes. Currently, the only entity type
|
|
750
|
-
*
|
|
773
|
+
* <p>The type of entity that CloudFormation changes. Currently, the only entity type is
|
|
774
|
+
* <code>Resource</code>.</p>
|
|
751
775
|
*/
|
|
752
776
|
Type?: ChangeType | string;
|
|
777
|
+
/**
|
|
778
|
+
* <p>Is either <code>null</code>, if no hooks invoke for the resource, or contains the number
|
|
779
|
+
* of hooks that will invoke for the resource.</p>
|
|
780
|
+
*/
|
|
781
|
+
HookInvocationCount?: number;
|
|
753
782
|
/**
|
|
754
783
|
* <p>A <code>ResourceChange</code> structure that describes the resource and action that
|
|
755
784
|
* CloudFormation will perform.</p>
|
|
@@ -762,14 +791,162 @@ export declare namespace Change {
|
|
|
762
791
|
*/
|
|
763
792
|
const filterSensitiveLog: (obj: Change) => any;
|
|
764
793
|
}
|
|
794
|
+
export declare enum HookFailureMode {
|
|
795
|
+
FAIL = "FAIL",
|
|
796
|
+
WARN = "WARN"
|
|
797
|
+
}
|
|
798
|
+
export declare enum HookInvocationPoint {
|
|
799
|
+
PRE_PROVISION = "PRE_PROVISION"
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* <p>Specifies <code>RESOURCE</code> type target details for activated hooks.</p>
|
|
803
|
+
*/
|
|
804
|
+
export interface ChangeSetHookResourceTargetDetails {
|
|
805
|
+
/**
|
|
806
|
+
* <p>The resource's logical ID, which is defined in the stack's template.</p>
|
|
807
|
+
*/
|
|
808
|
+
LogicalResourceId?: string;
|
|
809
|
+
/**
|
|
810
|
+
* <p>The type of CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>
|
|
811
|
+
*/
|
|
812
|
+
ResourceType?: string;
|
|
813
|
+
/**
|
|
814
|
+
* <p>Specifies the action of the resource.</p>
|
|
815
|
+
*/
|
|
816
|
+
ResourceAction?: ChangeAction | string;
|
|
817
|
+
}
|
|
818
|
+
export declare namespace ChangeSetHookResourceTargetDetails {
|
|
819
|
+
/**
|
|
820
|
+
* @internal
|
|
821
|
+
*/
|
|
822
|
+
const filterSensitiveLog: (obj: ChangeSetHookResourceTargetDetails) => any;
|
|
823
|
+
}
|
|
824
|
+
export declare enum HookTargetType {
|
|
825
|
+
RESOURCE = "RESOURCE"
|
|
826
|
+
}
|
|
827
|
+
/**
|
|
828
|
+
* <p>Specifies target details for an activated hook.</p>
|
|
829
|
+
*/
|
|
830
|
+
export interface ChangeSetHookTargetDetails {
|
|
831
|
+
/**
|
|
832
|
+
* <p>The name of the type.</p>
|
|
833
|
+
*/
|
|
834
|
+
TargetType?: HookTargetType | string;
|
|
835
|
+
/**
|
|
836
|
+
* <p>Required if <code>TargetType</code> is <code>RESOURCE</code>.</p>
|
|
837
|
+
*/
|
|
838
|
+
ResourceTargetDetails?: ChangeSetHookResourceTargetDetails;
|
|
839
|
+
}
|
|
840
|
+
export declare namespace ChangeSetHookTargetDetails {
|
|
841
|
+
/**
|
|
842
|
+
* @internal
|
|
843
|
+
*/
|
|
844
|
+
const filterSensitiveLog: (obj: ChangeSetHookTargetDetails) => any;
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* <p>Specifies the resource, the hook, and the hook version to be invoked.</p>
|
|
848
|
+
*/
|
|
849
|
+
export interface ChangeSetHook {
|
|
850
|
+
/**
|
|
851
|
+
* <p>Specifies the points in provisioning logic where a hook is invoked.</p>
|
|
852
|
+
*/
|
|
853
|
+
InvocationPoint?: HookInvocationPoint | string;
|
|
854
|
+
/**
|
|
855
|
+
* <p>Specify the hook failure mode for non-compliant resources in the followings ways.</p>
|
|
856
|
+
* <ul>
|
|
857
|
+
* <li>
|
|
858
|
+
* <p>
|
|
859
|
+
* <code>FAIL</code> Stops provisioning resources.</p>
|
|
860
|
+
* </li>
|
|
861
|
+
* <li>
|
|
862
|
+
* <p>
|
|
863
|
+
* <code>WARN</code> Allows provisioning to continue with a warning message.</p>
|
|
864
|
+
* </li>
|
|
865
|
+
* </ul>
|
|
866
|
+
*/
|
|
867
|
+
FailureMode?: HookFailureMode | string;
|
|
868
|
+
/**
|
|
869
|
+
* <p>The unique name for your hook. Specifies a three-part namespace for your hook, with a
|
|
870
|
+
* recommended pattern of <code>Organization::Service::Hook</code>.</p>
|
|
871
|
+
* <note>
|
|
872
|
+
* <p>The following organization namespaces are reserved and can't be used in your hook
|
|
873
|
+
* type names:</p>
|
|
874
|
+
* <ul>
|
|
875
|
+
* <li>
|
|
876
|
+
* <p>
|
|
877
|
+
* <code>Alexa</code>
|
|
878
|
+
* </p>
|
|
879
|
+
* </li>
|
|
880
|
+
* <li>
|
|
881
|
+
* <p>
|
|
882
|
+
* <code>AMZN</code>
|
|
883
|
+
* </p>
|
|
884
|
+
* </li>
|
|
885
|
+
* <li>
|
|
886
|
+
* <p>
|
|
887
|
+
* <code>Amazon</code>
|
|
888
|
+
* </p>
|
|
889
|
+
* </li>
|
|
890
|
+
* <li>
|
|
891
|
+
* <p>
|
|
892
|
+
* <code>ASK</code>
|
|
893
|
+
* </p>
|
|
894
|
+
* </li>
|
|
895
|
+
* <li>
|
|
896
|
+
* <p>
|
|
897
|
+
* <code>AWS</code>
|
|
898
|
+
* </p>
|
|
899
|
+
* </li>
|
|
900
|
+
* <li>
|
|
901
|
+
* <p>
|
|
902
|
+
* <code>Custom</code>
|
|
903
|
+
* </p>
|
|
904
|
+
* </li>
|
|
905
|
+
* <li>
|
|
906
|
+
* <p>
|
|
907
|
+
* <code>Dev</code>
|
|
908
|
+
* </p>
|
|
909
|
+
* </li>
|
|
910
|
+
* </ul>
|
|
911
|
+
* </note>
|
|
912
|
+
*/
|
|
913
|
+
TypeName?: string;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The version ID of the type specified.</p>
|
|
916
|
+
*/
|
|
917
|
+
TypeVersionId?: string;
|
|
918
|
+
/**
|
|
919
|
+
* <p>The version ID of the type configuration.</p>
|
|
920
|
+
*/
|
|
921
|
+
TypeConfigurationVersionId?: string;
|
|
922
|
+
/**
|
|
923
|
+
* <p>Specifies details about the target that the hook will run against.</p>
|
|
924
|
+
*/
|
|
925
|
+
TargetDetails?: ChangeSetHookTargetDetails;
|
|
926
|
+
}
|
|
927
|
+
export declare namespace ChangeSetHook {
|
|
928
|
+
/**
|
|
929
|
+
* @internal
|
|
930
|
+
*/
|
|
931
|
+
const filterSensitiveLog: (obj: ChangeSetHook) => any;
|
|
932
|
+
}
|
|
933
|
+
export declare enum ChangeSetHooksStatus {
|
|
934
|
+
PLANNED = "PLANNED",
|
|
935
|
+
PLANNING = "PLANNING",
|
|
936
|
+
UNAVAILABLE = "UNAVAILABLE"
|
|
937
|
+
}
|
|
765
938
|
/**
|
|
766
939
|
* <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack,
|
|
767
|
-
* use the <code>ListChangeSets</code>
|
|
940
|
+
* use the <code>ListChangeSets</code> operation.</p>
|
|
768
941
|
*/
|
|
769
|
-
export
|
|
770
|
-
name: "ChangeSetNotFoundException";
|
|
771
|
-
$fault: "client";
|
|
942
|
+
export declare class ChangeSetNotFoundException extends __BaseException {
|
|
943
|
+
readonly name: "ChangeSetNotFoundException";
|
|
944
|
+
readonly $fault: "client";
|
|
772
945
|
Message?: string;
|
|
946
|
+
/**
|
|
947
|
+
* @internal
|
|
948
|
+
*/
|
|
949
|
+
constructor(opts: __ExceptionOptionType<ChangeSetNotFoundException, __BaseException>);
|
|
773
950
|
}
|
|
774
951
|
export declare enum ChangeSetStatus {
|
|
775
952
|
CREATE_COMPLETE = "CREATE_COMPLETE",
|
|
@@ -812,7 +989,7 @@ export interface ChangeSetSummary {
|
|
|
812
989
|
ChangeSetName?: string;
|
|
813
990
|
/**
|
|
814
991
|
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
815
|
-
* set. If you can
|
|
992
|
+
* set. If you can't execute the change set, the status indicates why. For example, a change
|
|
816
993
|
* set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still
|
|
817
994
|
* creating it or in an <code>OBSOLETE</code> state because the stack was already
|
|
818
995
|
* updated.</p>
|
|
@@ -876,14 +1053,15 @@ export interface ContinueUpdateRollbackInput {
|
|
|
876
1053
|
*/
|
|
877
1054
|
StackName: string | undefined;
|
|
878
1055
|
/**
|
|
879
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
880
|
-
*
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
-
*
|
|
1056
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1057
|
+
* that CloudFormation assumes to roll back the stack. CloudFormation uses the
|
|
1058
|
+
* role's credentials to make calls on your behalf. CloudFormation always uses this
|
|
1059
|
+
* role for all future operations on the stack. Provided that users have permission to operate
|
|
1060
|
+
* on the stack, CloudFormation uses this role even if the users don't have permission
|
|
1061
|
+
* to pass it. Ensure that the role grants least permission.</p>
|
|
884
1062
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
885
1063
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
886
|
-
* session that
|
|
1064
|
+
* session that's generated from your user credentials.</p>
|
|
887
1065
|
*/
|
|
888
1066
|
RoleARN?: string;
|
|
889
1067
|
/**
|
|
@@ -891,7 +1069,7 @@ export interface ContinueUpdateRollbackInput {
|
|
|
891
1069
|
* continue update rollback operation. You can specify only resources that are in the
|
|
892
1070
|
* <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources
|
|
893
1071
|
* that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an
|
|
894
|
-
* update was
|
|
1072
|
+
* update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason.</p>
|
|
895
1073
|
* <important>
|
|
896
1074
|
* <p>Specify this property to skip rolling back resources that CloudFormation
|
|
897
1075
|
* can't successfully roll back. We recommend that you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> troubleshoot</a> resources before skipping them. CloudFormation sets
|
|
@@ -934,7 +1112,7 @@ export declare namespace ContinueUpdateRollbackInput {
|
|
|
934
1112
|
const filterSensitiveLog: (obj: ContinueUpdateRollbackInput) => any;
|
|
935
1113
|
}
|
|
936
1114
|
/**
|
|
937
|
-
* <p>The output for a <a>ContinueUpdateRollback</a>
|
|
1115
|
+
* <p>The output for a <a>ContinueUpdateRollback</a> operation.</p>
|
|
938
1116
|
*/
|
|
939
1117
|
export interface ContinueUpdateRollbackOutput {
|
|
940
1118
|
}
|
|
@@ -950,8 +1128,8 @@ export declare namespace ContinueUpdateRollbackOutput {
|
|
|
950
1128
|
export interface Parameter {
|
|
951
1129
|
/**
|
|
952
1130
|
* <p>The key associated with the parameter. If you don't specify a key and value for a
|
|
953
|
-
* particular parameter, CloudFormation uses the default value that
|
|
954
|
-
*
|
|
1131
|
+
* particular parameter, CloudFormation uses the default value that's specified in your
|
|
1132
|
+
* template.</p>
|
|
955
1133
|
*/
|
|
956
1134
|
ParameterKey?: string;
|
|
957
1135
|
/**
|
|
@@ -965,8 +1143,8 @@ export interface Parameter {
|
|
|
965
1143
|
*/
|
|
966
1144
|
UsePreviousValue?: boolean;
|
|
967
1145
|
/**
|
|
968
|
-
* <p>Read-only.
|
|
969
|
-
*
|
|
1146
|
+
* <p>Read-only. The value that corresponds to a SSM parameter key. This field is
|
|
1147
|
+
* returned only for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types">
|
|
970
1148
|
* <code>SSM</code>
|
|
971
1149
|
* </a> parameter types in the template.</p>
|
|
972
1150
|
*/
|
|
@@ -984,8 +1162,7 @@ export declare namespace Parameter {
|
|
|
984
1162
|
export interface ResourceToImport {
|
|
985
1163
|
/**
|
|
986
1164
|
* <p>The type of resource to import into your stack, such as <code>AWS::S3::Bucket</code>.
|
|
987
|
-
* For a list of supported resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resources that support import operations</a> in the CloudFormation User
|
|
988
|
-
* Guide.</p>
|
|
1165
|
+
* For a list of supported resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resources that support import operations</a> in the CloudFormation User Guide.</p>
|
|
989
1166
|
*/
|
|
990
1167
|
ResourceType: string | undefined;
|
|
991
1168
|
/**
|
|
@@ -1011,13 +1188,13 @@ export declare namespace ResourceToImport {
|
|
|
1011
1188
|
* <p>A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the
|
|
1012
1189
|
* alarms you specify goes to ALARM state during the stack operation or within the specified
|
|
1013
1190
|
* monitoring period afterwards, CloudFormation rolls back the entire stack
|
|
1014
|
-
* operation
|
|
1191
|
+
* operation.</p>
|
|
1015
1192
|
*/
|
|
1016
1193
|
export interface RollbackTrigger {
|
|
1017
1194
|
/**
|
|
1018
1195
|
* <p>The Amazon Resource Name (ARN) of the rollback trigger.</p>
|
|
1019
|
-
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1020
|
-
*
|
|
1196
|
+
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1197
|
+
* back.</p>
|
|
1021
1198
|
*/
|
|
1022
1199
|
Arn: string | undefined;
|
|
1023
1200
|
/**
|
|
@@ -1041,7 +1218,7 @@ export declare namespace RollbackTrigger {
|
|
|
1041
1218
|
*/
|
|
1042
1219
|
export interface RollbackConfiguration {
|
|
1043
1220
|
/**
|
|
1044
|
-
* <p>The triggers to monitor during stack creation or update actions
|
|
1221
|
+
* <p>The triggers to monitor during stack creation or update actions.</p>
|
|
1045
1222
|
* <p>By default, CloudFormation saves the rollback triggers specified for a stack and applies them to
|
|
1046
1223
|
* any subsequent update operations for the stack, unless you specify otherwise. If you do
|
|
1047
1224
|
* specify rollback triggers for this parameter, those triggers replace any list of triggers
|
|
@@ -1054,7 +1231,7 @@ export interface RollbackConfiguration {
|
|
|
1054
1231
|
* <li>
|
|
1055
1232
|
* <p>To specify new or updated rollback triggers, you must specify
|
|
1056
1233
|
* <i>all</i> the triggers that you want used for this stack, even
|
|
1057
|
-
* triggers you've
|
|
1234
|
+
* triggers you've specified before (for example, when creating the stack or during a
|
|
1058
1235
|
* previous stack update). Any triggers that you don't include in the updated list of
|
|
1059
1236
|
* triggers are no longer applied to the stack.</p>
|
|
1060
1237
|
* </li>
|
|
@@ -1063,8 +1240,8 @@ export interface RollbackConfiguration {
|
|
|
1063
1240
|
* parameter.</p>
|
|
1064
1241
|
* </li>
|
|
1065
1242
|
* </ul>
|
|
1066
|
-
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1067
|
-
*
|
|
1243
|
+
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1244
|
+
* back.</p>
|
|
1068
1245
|
*/
|
|
1069
1246
|
RollbackTriggers?: RollbackTrigger[];
|
|
1070
1247
|
/**
|
|
@@ -1072,7 +1249,7 @@ export interface RollbackConfiguration {
|
|
|
1072
1249
|
* the rollback triggers after the stack creation or update operation deploys all necessary
|
|
1073
1250
|
* resources.</p>
|
|
1074
1251
|
* <p>The default is 0 minutes.</p>
|
|
1075
|
-
* <p>If you specify a monitoring period but
|
|
1252
|
+
* <p>If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old
|
|
1076
1253
|
* resources after update operations. You can use this monitoring period to perform any manual
|
|
1077
1254
|
* 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>
|
|
1078
1255
|
* <p>If you specify 0 for this parameter, CloudFormation still monitors the
|
|
@@ -1124,23 +1301,23 @@ export interface CreateChangeSetInput {
|
|
|
1124
1301
|
StackName: string | undefined;
|
|
1125
1302
|
/**
|
|
1126
1303
|
* <p>A structure that contains the body of the revised template, with a minimum length of 1
|
|
1127
|
-
* byte and a maximum length of 51,200 bytes. CloudFormation generates the change set
|
|
1128
|
-
*
|
|
1304
|
+
* byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by
|
|
1305
|
+
* comparing this template with the template of the stack that you specified.</p>
|
|
1129
1306
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1130
1307
|
* <code>TemplateURL</code>.</p>
|
|
1131
1308
|
*/
|
|
1132
1309
|
TemplateBody?: string;
|
|
1133
1310
|
/**
|
|
1134
1311
|
* <p>The location of the file that contains the revised template. The URL must point to a
|
|
1135
|
-
* template (max size: 460,800 bytes) that
|
|
1136
|
-
* document. CloudFormation generates the change set by comparing this
|
|
1137
|
-
* the stack that you specified.</p>
|
|
1312
|
+
* template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a
|
|
1313
|
+
* Systems Manager document. CloudFormation generates the change set by comparing this
|
|
1314
|
+
* template with the stack that you specified.</p>
|
|
1138
1315
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1139
1316
|
* <code>TemplateURL</code>.</p>
|
|
1140
1317
|
*/
|
|
1141
1318
|
TemplateURL?: string;
|
|
1142
1319
|
/**
|
|
1143
|
-
* <p>Whether to reuse the template that
|
|
1320
|
+
* <p>Whether to reuse the template that's associated with the stack to create the change
|
|
1144
1321
|
* set.</p>
|
|
1145
1322
|
*/
|
|
1146
1323
|
UsePreviousTemplate?: boolean;
|
|
@@ -1159,8 +1336,8 @@ export interface CreateChangeSetInput {
|
|
|
1159
1336
|
* </p>
|
|
1160
1337
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1161
1338
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1162
|
-
*
|
|
1163
|
-
* of these capabilities.</p>
|
|
1339
|
+
* (IAM) users. For those stacks, you must explicitly acknowledge this
|
|
1340
|
+
* by specifying one of these capabilities.</p>
|
|
1164
1341
|
* <p>The following IAM resources require you to specify either the
|
|
1165
1342
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
1166
1343
|
* capability.</p>
|
|
@@ -1174,8 +1351,8 @@ export interface CreateChangeSetInput {
|
|
|
1174
1351
|
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1175
1352
|
* </li>
|
|
1176
1353
|
* <li>
|
|
1177
|
-
* <p>If you don't specify either of these capabilities, CloudFormation
|
|
1178
|
-
*
|
|
1354
|
+
* <p>If you don't specify either of these capabilities, CloudFormation
|
|
1355
|
+
* returns an <code>InsufficientCapabilities</code> error.</p>
|
|
1179
1356
|
* </li>
|
|
1180
1357
|
* </ul>
|
|
1181
1358
|
* <p>If your stack template contains these resources, we recommend that you review all
|
|
@@ -1195,7 +1372,7 @@ export interface CreateChangeSetInput {
|
|
|
1195
1372
|
* </li>
|
|
1196
1373
|
* <li>
|
|
1197
1374
|
* <p>
|
|
1198
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
1375
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
1199
1376
|
* </p>
|
|
1200
1377
|
* </li>
|
|
1201
1378
|
* <li>
|
|
@@ -1218,12 +1395,11 @@ export interface CreateChangeSetInput {
|
|
|
1218
1395
|
* </li>
|
|
1219
1396
|
* <li>
|
|
1220
1397
|
* <p>
|
|
1221
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
1398
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
1222
1399
|
* </p>
|
|
1223
1400
|
* </li>
|
|
1224
1401
|
* </ul>
|
|
1225
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
1226
|
-
* Resources in CloudFormation Templates</a>.</p>
|
|
1402
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>
|
|
1227
1403
|
* </li>
|
|
1228
1404
|
* <li>
|
|
1229
1405
|
* <p>
|
|
@@ -1238,14 +1414,14 @@ export interface CreateChangeSetInput {
|
|
|
1238
1414
|
* without first reviewing the resulting changes in a change set, you must acknowledge
|
|
1239
1415
|
* this capability. This includes the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html">AWS::Include</a> and <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p>
|
|
1240
1416
|
* <note>
|
|
1241
|
-
* <p>This capacity
|
|
1417
|
+
* <p>This capacity doesn't apply to creating change sets, and specifying it when
|
|
1242
1418
|
* creating change sets has no effect.</p>
|
|
1243
1419
|
* <p>If you want to create a stack from a stack template that contains macros
|
|
1244
1420
|
* <i>and</i> nested stacks, you must create or update the stack
|
|
1245
1421
|
* directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability.</p>
|
|
1246
1422
|
* </note>
|
|
1247
|
-
* <p>For more information on macros, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation
|
|
1248
|
-
*
|
|
1423
|
+
* <p>For more information on macros, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation macros to
|
|
1424
|
+
* perform custom processing on templates</a>.</p>
|
|
1249
1425
|
* </li>
|
|
1250
1426
|
* </ul>
|
|
1251
1427
|
*/
|
|
@@ -1256,18 +1432,17 @@ export interface CreateChangeSetInput {
|
|
|
1256
1432
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
1257
1433
|
* <p>If the list of resource types doesn't include a resource type that you're updating, the
|
|
1258
1434
|
* stack update fails. By default, CloudFormation grants permissions to all resource
|
|
1259
|
-
* types. Identity and Access Management (IAM) uses this parameter for condition keys
|
|
1260
|
-
* for CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access
|
|
1261
|
-
* Identity and Access Management</a> in the CloudFormation User Guide.</p>
|
|
1435
|
+
* types. Identity and Access Management (IAM) uses this parameter for condition keys
|
|
1436
|
+
* in IAM policies for CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling access with Identity and Access Management</a> in the CloudFormation User Guide.</p>
|
|
1262
1437
|
*/
|
|
1263
1438
|
ResourceTypes?: string[];
|
|
1264
1439
|
/**
|
|
1265
1440
|
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1266
|
-
* that CloudFormation assumes when executing the change set. CloudFormation
|
|
1267
|
-
*
|
|
1268
|
-
*
|
|
1269
|
-
*
|
|
1270
|
-
*
|
|
1441
|
+
* that CloudFormation assumes when executing the change set. CloudFormation uses the
|
|
1442
|
+
* role's credentials to make calls on your behalf. CloudFormation uses this role for all
|
|
1443
|
+
* future operations on the stack. Provided that users have permission to operate on the
|
|
1444
|
+
* stack, CloudFormation uses this role even if the users don't have permission to pass
|
|
1445
|
+
* it. Ensure that the role grants least permission.</p>
|
|
1271
1446
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1272
1447
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1273
1448
|
* session that is generated from your user credentials.</p>
|
|
@@ -1279,29 +1454,28 @@ export interface CreateChangeSetInput {
|
|
|
1279
1454
|
*/
|
|
1280
1455
|
RollbackConfiguration?: RollbackConfiguration;
|
|
1281
1456
|
/**
|
|
1282
|
-
* <p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS)
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1457
|
+
* <p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics
|
|
1458
|
+
* that CloudFormation associates with the stack. To remove all associated notification
|
|
1459
|
+
* topics, specify an empty list.</p>
|
|
1285
1460
|
*/
|
|
1286
1461
|
NotificationARNs?: string[];
|
|
1287
1462
|
/**
|
|
1288
|
-
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates
|
|
1289
|
-
*
|
|
1463
|
+
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these
|
|
1464
|
+
* tags to resources in the stack. You can specify a maximum of 50 tags.</p>
|
|
1290
1465
|
*/
|
|
1291
1466
|
Tags?: Tag[];
|
|
1292
1467
|
/**
|
|
1293
1468
|
* <p>The name of the change set. The name must be unique among all change sets that are
|
|
1294
1469
|
* associated with the specified stack.</p>
|
|
1295
|
-
* <p>A change set name can contain only alphanumeric, case sensitive characters and hyphens.
|
|
1296
|
-
* It must start with an
|
|
1470
|
+
* <p>A change set name can contain only alphanumeric, case sensitive characters, and hyphens.
|
|
1471
|
+
* It must start with an alphabetical character and can't exceed 128 characters.</p>
|
|
1297
1472
|
*/
|
|
1298
1473
|
ChangeSetName: string | undefined;
|
|
1299
1474
|
/**
|
|
1300
1475
|
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if
|
|
1301
|
-
* you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
1302
|
-
*
|
|
1303
|
-
*
|
|
1304
|
-
* received them.</p>
|
|
1476
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1477
|
+
* create another change set with the same name. You might retry <code>CreateChangeSet</code>
|
|
1478
|
+
* requests to ensure that CloudFormation successfully received them.</p>
|
|
1305
1479
|
*/
|
|
1306
1480
|
ClientToken?: string;
|
|
1307
1481
|
/**
|
|
@@ -1313,8 +1487,8 @@ export interface CreateChangeSetInput {
|
|
|
1313
1487
|
* <code>CREATE</code>. To create a change set for an existing stack, specify
|
|
1314
1488
|
* <code>UPDATE</code>. To create a change set for an import operation, specify
|
|
1315
1489
|
* <code>IMPORT</code>.</p>
|
|
1316
|
-
* <p>If you create a change set for a new stack, CloudFormation creates a stack with
|
|
1317
|
-
*
|
|
1490
|
+
* <p>If you create a change set for a new stack, CloudFormation creates a stack with a
|
|
1491
|
+
* 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">
|
|
1318
1492
|
* <code>REVIEW_IN_PROGRESS</code>
|
|
1319
1493
|
* </a> state until you execute the change
|
|
1320
1494
|
* set.</p>
|
|
@@ -1363,20 +1537,28 @@ export declare namespace CreateChangeSetOutput {
|
|
|
1363
1537
|
* <p>The template contains resources with capabilities that weren't specified in the
|
|
1364
1538
|
* Capabilities parameter.</p>
|
|
1365
1539
|
*/
|
|
1366
|
-
export
|
|
1367
|
-
name: "InsufficientCapabilitiesException";
|
|
1368
|
-
$fault: "client";
|
|
1540
|
+
export declare class InsufficientCapabilitiesException extends __BaseException {
|
|
1541
|
+
readonly name: "InsufficientCapabilitiesException";
|
|
1542
|
+
readonly $fault: "client";
|
|
1369
1543
|
Message?: string;
|
|
1544
|
+
/**
|
|
1545
|
+
* @internal
|
|
1546
|
+
*/
|
|
1547
|
+
constructor(opts: __ExceptionOptionType<InsufficientCapabilitiesException, __BaseException>);
|
|
1370
1548
|
}
|
|
1371
1549
|
/**
|
|
1372
1550
|
* <p>The quota for the resource has already been reached.</p>
|
|
1373
|
-
* <p>For information on resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">
|
|
1374
|
-
*
|
|
1551
|
+
* <p>For information on resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
1552
|
+
* quotas</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
1375
1553
|
*/
|
|
1376
|
-
export
|
|
1377
|
-
name: "LimitExceededException";
|
|
1378
|
-
$fault: "client";
|
|
1554
|
+
export declare class LimitExceededException extends __BaseException {
|
|
1555
|
+
readonly name: "LimitExceededException";
|
|
1556
|
+
readonly $fault: "client";
|
|
1379
1557
|
Message?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* @internal
|
|
1560
|
+
*/
|
|
1561
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1380
1562
|
}
|
|
1381
1563
|
export declare enum OnFailure {
|
|
1382
1564
|
DELETE = "DELETE",
|
|
@@ -1388,18 +1570,18 @@ export declare enum OnFailure {
|
|
|
1388
1570
|
*/
|
|
1389
1571
|
export interface CreateStackInput {
|
|
1390
1572
|
/**
|
|
1391
|
-
* <p>The name that
|
|
1573
|
+
* <p>The name that's associated with the stack. The name must be unique in the Region in
|
|
1392
1574
|
* which you are creating the stack.</p>
|
|
1393
1575
|
* <note>
|
|
1394
1576
|
* <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens.
|
|
1395
|
-
* It must start with an alphabetical character and
|
|
1577
|
+
* It must start with an alphabetical character and can't be longer than 128
|
|
1396
1578
|
* characters.</p>
|
|
1397
1579
|
* </note>
|
|
1398
1580
|
*/
|
|
1399
1581
|
StackName: string | undefined;
|
|
1400
1582
|
/**
|
|
1401
1583
|
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
1402
|
-
* length of 51,200 bytes. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
1584
|
+
* length of 51,200 bytes. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a>
|
|
1403
1585
|
* in the CloudFormation User Guide.</p>
|
|
1404
1586
|
* <p>Conditional: You must specify either the <code>TemplateBody</code> or the
|
|
1405
1587
|
* <code>TemplateURL</code> parameter, but not both.</p>
|
|
@@ -1407,8 +1589,8 @@ export interface CreateStackInput {
|
|
|
1407
1589
|
TemplateBody?: string;
|
|
1408
1590
|
/**
|
|
1409
1591
|
* <p>Location of file containing the template body. The URL must point to a template (max
|
|
1410
|
-
* size: 460,800 bytes) that
|
|
1411
|
-
* For more information, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
1592
|
+
* size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager
|
|
1593
|
+
* document. For more information, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a>
|
|
1412
1594
|
* in the CloudFormation User Guide.</p>
|
|
1413
1595
|
* <p>Conditional: You must specify either the <code>TemplateBody</code> or the
|
|
1414
1596
|
* <code>TemplateURL</code> parameter, but not both.</p>
|
|
@@ -1440,9 +1622,9 @@ export interface CreateStackInput {
|
|
|
1440
1622
|
*/
|
|
1441
1623
|
TimeoutInMinutes?: number;
|
|
1442
1624
|
/**
|
|
1443
|
-
* <p>The Simple Notification Service (SNS) topic ARNs to publish stack related
|
|
1444
|
-
* can find your SNS topic ARNs using the SNS
|
|
1445
|
-
* (CLI).</p>
|
|
1625
|
+
* <p>The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related
|
|
1626
|
+
* events. You can find your Amazon SNS topic ARNs using the Amazon SNS
|
|
1627
|
+
* console or your Command Line Interface (CLI).</p>
|
|
1446
1628
|
*/
|
|
1447
1629
|
NotificationARNs?: string[];
|
|
1448
1630
|
/**
|
|
@@ -1455,18 +1637,19 @@ export interface CreateStackInput {
|
|
|
1455
1637
|
* </p>
|
|
1456
1638
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1457
1639
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1458
|
-
*
|
|
1459
|
-
* of these capabilities.</p>
|
|
1640
|
+
* (IAM) users. For those stacks, you must explicitly acknowledge this
|
|
1641
|
+
* by specifying one of these capabilities.</p>
|
|
1460
1642
|
* <p>The following IAM resources require you to specify either the
|
|
1461
1643
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
1462
1644
|
* capability.</p>
|
|
1463
1645
|
* <ul>
|
|
1464
1646
|
* <li>
|
|
1465
|
-
* <p>If you have IAM resources, you can specify either
|
|
1647
|
+
* <p>If you have IAM resources, you can specify either
|
|
1648
|
+
* capability.</p>
|
|
1466
1649
|
* </li>
|
|
1467
1650
|
* <li>
|
|
1468
|
-
* <p>If you have IAM resources with custom names, you
|
|
1469
|
-
*
|
|
1651
|
+
* <p>If you have IAM resources with custom names, you
|
|
1652
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1470
1653
|
* </li>
|
|
1471
1654
|
* <li>
|
|
1472
1655
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -1490,7 +1673,7 @@ export interface CreateStackInput {
|
|
|
1490
1673
|
* </li>
|
|
1491
1674
|
* <li>
|
|
1492
1675
|
* <p>
|
|
1493
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
1676
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
1494
1677
|
* </p>
|
|
1495
1678
|
* </li>
|
|
1496
1679
|
* <li>
|
|
@@ -1513,12 +1696,11 @@ export interface CreateStackInput {
|
|
|
1513
1696
|
* </li>
|
|
1514
1697
|
* <li>
|
|
1515
1698
|
* <p>
|
|
1516
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
1699
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
1517
1700
|
* </p>
|
|
1518
1701
|
* </li>
|
|
1519
1702
|
* </ul>
|
|
1520
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
1521
|
-
* Resources in CloudFormation Templates</a>.</p>
|
|
1703
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates</a>.</p>
|
|
1522
1704
|
* </li>
|
|
1523
1705
|
* <li>
|
|
1524
1706
|
* <p>
|
|
@@ -1538,13 +1720,13 @@ export interface CreateStackInput {
|
|
|
1538
1720
|
* <important>
|
|
1539
1721
|
* <p>You should only create stacks directly from a stack template that contains
|
|
1540
1722
|
* macros if you know what processing the macro performs.</p>
|
|
1541
|
-
* <p>Each macro relies on an underlying Lambda service function for
|
|
1542
|
-
* templates. Be aware that the Lambda function owner
|
|
1543
|
-
* operation without CloudFormation being notified.</p>
|
|
1723
|
+
* <p>Each macro relies on an underlying Lambda service function for
|
|
1724
|
+
* processing stack templates. Be aware that the Lambda function owner
|
|
1725
|
+
* can update the function operation without CloudFormation being notified.</p>
|
|
1544
1726
|
* </important>
|
|
1545
1727
|
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
|
|
1546
|
-
* CloudFormation
|
|
1547
|
-
*
|
|
1728
|
+
* CloudFormation macros to perform custom processing on
|
|
1729
|
+
* templates</a>.</p>
|
|
1548
1730
|
* </li>
|
|
1549
1731
|
* </ul>
|
|
1550
1732
|
*/
|
|
@@ -1563,35 +1745,36 @@ export interface CreateStackInput {
|
|
|
1563
1745
|
* </code> (for a specific Amazon Web Services resource).</p>
|
|
1564
1746
|
* <p>If the list of resource types doesn't include a resource that you're creating, the stack
|
|
1565
1747
|
* creation fails. By default, CloudFormation grants permissions to all resource
|
|
1566
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
1567
|
-
*
|
|
1748
|
+
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more
|
|
1749
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1568
1750
|
* Identity and Access Management</a>.</p>
|
|
1569
1751
|
*/
|
|
1570
1752
|
ResourceTypes?: string[];
|
|
1571
1753
|
/**
|
|
1572
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1573
|
-
*
|
|
1574
|
-
*
|
|
1575
|
-
*
|
|
1576
|
-
*
|
|
1754
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1755
|
+
* that CloudFormation assumes to create the stack. CloudFormation uses the
|
|
1756
|
+
* role's credentials to make calls on your behalf. CloudFormation always uses this
|
|
1757
|
+
* role for all future operations on the stack. Provided that users have permission to operate
|
|
1758
|
+
* on the stack, CloudFormation uses this role even if the users don't have permission
|
|
1759
|
+
* to pass it. Ensure that the role grants least privilege.</p>
|
|
1577
1760
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1578
1761
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1579
|
-
* session that
|
|
1762
|
+
* session that's generated from your user credentials.</p>
|
|
1580
1763
|
*/
|
|
1581
1764
|
RoleARN?: string;
|
|
1582
1765
|
/**
|
|
1583
1766
|
* <p>Determines what action will be taken if stack creation fails. This must be one of:
|
|
1584
|
-
*
|
|
1585
|
-
*
|
|
1767
|
+
* <code>DO_NOTHING</code>, <code>ROLLBACK</code>, or <code>DELETE</code>. You can specify
|
|
1768
|
+
* either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</p>
|
|
1586
1769
|
* <p>Default: <code>ROLLBACK</code>
|
|
1587
1770
|
* </p>
|
|
1588
1771
|
*/
|
|
1589
1772
|
OnFailure?: OnFailure | string;
|
|
1590
1773
|
/**
|
|
1591
1774
|
* <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
|
|
1592
|
-
* to Stack Resources</a> in the <i>CloudFormation User
|
|
1593
|
-
*
|
|
1594
|
-
*
|
|
1775
|
+
* to Stack Resources</a> in the <i>CloudFormation User Guide</i>. You can specify
|
|
1776
|
+
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
1777
|
+
* not both.</p>
|
|
1595
1778
|
*/
|
|
1596
1779
|
StackPolicyBody?: string;
|
|
1597
1780
|
/**
|
|
@@ -1612,7 +1795,7 @@ export interface CreateStackInput {
|
|
|
1612
1795
|
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1613
1796
|
* create a stack with the same name. You might retry <code>CreateStack</code> requests to
|
|
1614
1797
|
* ensure that CloudFormation successfully received them.</p>
|
|
1615
|
-
* <p>All events
|
|
1798
|
+
* <p>All events initiated by a given stack operation are assigned the same client request
|
|
1616
1799
|
* token, which you can use to track operations. For example, if you execute a
|
|
1617
1800
|
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
1618
1801
|
* <code>StackEvents</code> generated by that operation will have
|
|
@@ -1622,7 +1805,7 @@ export interface CreateStackInput {
|
|
|
1622
1805
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
1623
1806
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
1624
1807
|
* would be assigned the same token in the following format:
|
|
1625
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
1808
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
1626
1809
|
*/
|
|
1627
1810
|
ClientRequestToken?: string;
|
|
1628
1811
|
/**
|
|
@@ -1630,10 +1813,10 @@ export interface CreateStackInput {
|
|
|
1630
1813
|
* delete a stack with termination protection enabled, the operation fails and the stack
|
|
1631
1814
|
* remains unchanged. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a Stack From Being
|
|
1632
1815
|
* Deleted</a> in the <i>CloudFormation User Guide</i>. Termination protection is
|
|
1633
|
-
*
|
|
1816
|
+
* deactivated on stacks by default.</p>
|
|
1634
1817
|
* <p>For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>,
|
|
1635
|
-
* termination protection is set on the root stack and
|
|
1636
|
-
*
|
|
1818
|
+
* termination protection is set on the root stack and can't be changed directly on the nested
|
|
1819
|
+
* stack.</p>
|
|
1637
1820
|
*/
|
|
1638
1821
|
EnableTerminationProtection?: boolean;
|
|
1639
1822
|
}
|
|
@@ -1660,9 +1843,8 @@ export declare namespace CreateStackOutput {
|
|
|
1660
1843
|
}
|
|
1661
1844
|
/**
|
|
1662
1845
|
* <p>[Service-managed permissions] The Organizations accounts to which StackSets
|
|
1663
|
-
* deploys. StackSets
|
|
1664
|
-
*
|
|
1665
|
-
* organization.</p>
|
|
1846
|
+
* deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in
|
|
1847
|
+
* your organization or in an OU in your organization.</p>
|
|
1666
1848
|
* <p>For update operations, you can specify either <code>Accounts</code> or
|
|
1667
1849
|
* <code>OrganizationalUnitIds</code>. For create and delete operations, specify
|
|
1668
1850
|
* <code>OrganizationalUnitIds</code>.</p>
|
|
@@ -1695,7 +1877,7 @@ export declare enum RegionConcurrencyType {
|
|
|
1695
1877
|
}
|
|
1696
1878
|
/**
|
|
1697
1879
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
1698
|
-
* operation
|
|
1880
|
+
* operation.</p>
|
|
1699
1881
|
* <p>For more information on maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
|
|
1700
1882
|
*/
|
|
1701
1883
|
export interface StackSetOperationPreferences {
|
|
@@ -1730,9 +1912,9 @@ export interface StackSetOperationPreferences {
|
|
|
1730
1912
|
FailureTolerancePercentage?: number;
|
|
1731
1913
|
/**
|
|
1732
1914
|
* <p>The maximum number of accounts in which to perform this operation at one time. This is
|
|
1733
|
-
* dependent on the value of
|
|
1734
|
-
* <code>MaxConcurrentCount</code> is at most one more
|
|
1735
|
-
*
|
|
1915
|
+
* dependent on the value of
|
|
1916
|
+
* <code>FailureToleranceCount</code>.<code>MaxConcurrentCount</code> is at most one more
|
|
1917
|
+
* than the <code>FailureToleranceCount</code>.</p>
|
|
1736
1918
|
* <p>Note that this setting lets you specify the <i>maximum</i> for operations.
|
|
1737
1919
|
* For large deployments, under certain circumstances the actual number of accounts acted upon
|
|
1738
1920
|
* concurrently may be lower due to service throttling.</p>
|
|
@@ -1777,21 +1959,23 @@ export interface CreateStackInstancesInput {
|
|
|
1777
1959
|
Accounts?: string[];
|
|
1778
1960
|
/**
|
|
1779
1961
|
* <p>[Service-managed permissions] The Organizations accounts for which to create
|
|
1780
|
-
* stack instances in the specified Regions.</p>
|
|
1962
|
+
* stack instances in the specified Amazon Web Services Regions.</p>
|
|
1781
1963
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
1782
1964
|
* both.</p>
|
|
1783
1965
|
*/
|
|
1784
1966
|
DeploymentTargets?: DeploymentTargets;
|
|
1785
1967
|
/**
|
|
1786
|
-
* <p>The names of one or more Regions where you want to create stack
|
|
1787
|
-
* specified Amazon Web Services accounts.</p>
|
|
1968
|
+
* <p>The names of one or more Amazon Web Services Regions where you want to create stack
|
|
1969
|
+
* instances using the specified Amazon Web Services accounts.</p>
|
|
1788
1970
|
*/
|
|
1789
1971
|
Regions: string[] | undefined;
|
|
1790
1972
|
/**
|
|
1791
1973
|
* <p>A list of stack set parameters whose values you want to override in the selected stack
|
|
1792
1974
|
* instances.</p>
|
|
1793
1975
|
* <p>Any overridden parameter values will be applied to all stack instances in the specified
|
|
1794
|
-
* accounts and Regions. When specifying parameters and their values, be
|
|
1976
|
+
* accounts and Amazon Web Services Regions. When specifying parameters and their values, be
|
|
1977
|
+
* aware of how CloudFormation sets parameter values during stack instance
|
|
1978
|
+
* operations:</p>
|
|
1795
1979
|
* <ul>
|
|
1796
1980
|
* <li>
|
|
1797
1981
|
* <p>To override the current value for a parameter, include the parameter and specify
|
|
@@ -1799,19 +1983,19 @@ export interface CreateStackInstancesInput {
|
|
|
1799
1983
|
* </li>
|
|
1800
1984
|
* <li>
|
|
1801
1985
|
* <p>To leave an overridden parameter set to its present value, include the parameter
|
|
1802
|
-
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You
|
|
1986
|
+
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You can't specify
|
|
1803
1987
|
* both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
1804
1988
|
* </li>
|
|
1805
1989
|
* <li>
|
|
1806
1990
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
1807
|
-
* specify a parameter list but
|
|
1991
|
+
* specify a parameter list but don't include the parameter in the list.</p>
|
|
1808
1992
|
* </li>
|
|
1809
1993
|
* <li>
|
|
1810
|
-
* <p>To leave all parameters set to their present values,
|
|
1994
|
+
* <p>To leave all parameters set to their present values, don't specify this property
|
|
1811
1995
|
* at all.</p>
|
|
1812
1996
|
* </li>
|
|
1813
1997
|
* </ul>
|
|
1814
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance
|
|
1998
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance aren't
|
|
1815
1999
|
* updated, but retain their overridden value.</p>
|
|
1816
2000
|
* <p>You can only override the parameter <i>values</i> that are specified in
|
|
1817
2001
|
* 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>
|
|
@@ -1846,7 +2030,8 @@ export interface CreateStackInstancesInput {
|
|
|
1846
2030
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
1847
2031
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
1848
2032
|
* <p>Your Amazon Web Services account must be registered as a delegated administrator in
|
|
1849
|
-
* 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
|
|
2033
|
+
* 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
|
|
2034
|
+
* <i>CloudFormation User Guide</i>.</p>
|
|
1850
2035
|
* </li>
|
|
1851
2036
|
* </ul>
|
|
1852
2037
|
*/
|
|
@@ -1873,52 +2058,76 @@ export declare namespace CreateStackInstancesOutput {
|
|
|
1873
2058
|
/**
|
|
1874
2059
|
* <p>The specified operation isn't valid.</p>
|
|
1875
2060
|
*/
|
|
1876
|
-
export
|
|
1877
|
-
name: "InvalidOperationException";
|
|
1878
|
-
$fault: "client";
|
|
2061
|
+
export declare class InvalidOperationException extends __BaseException {
|
|
2062
|
+
readonly name: "InvalidOperationException";
|
|
2063
|
+
readonly $fault: "client";
|
|
1879
2064
|
Message?: string;
|
|
2065
|
+
/**
|
|
2066
|
+
* @internal
|
|
2067
|
+
*/
|
|
2068
|
+
constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
|
|
1880
2069
|
}
|
|
1881
2070
|
/**
|
|
1882
2071
|
* <p>The specified operation ID already exists.</p>
|
|
1883
2072
|
*/
|
|
1884
|
-
export
|
|
1885
|
-
name: "OperationIdAlreadyExistsException";
|
|
1886
|
-
$fault: "client";
|
|
2073
|
+
export declare class OperationIdAlreadyExistsException extends __BaseException {
|
|
2074
|
+
readonly name: "OperationIdAlreadyExistsException";
|
|
2075
|
+
readonly $fault: "client";
|
|
1887
2076
|
Message?: string;
|
|
2077
|
+
/**
|
|
2078
|
+
* @internal
|
|
2079
|
+
*/
|
|
2080
|
+
constructor(opts: __ExceptionOptionType<OperationIdAlreadyExistsException, __BaseException>);
|
|
1888
2081
|
}
|
|
1889
2082
|
/**
|
|
1890
2083
|
* <p>Another operation is currently in progress for this stack set. Only one operation can be
|
|
1891
2084
|
* performed for a stack set at a given time.</p>
|
|
1892
2085
|
*/
|
|
1893
|
-
export
|
|
1894
|
-
name: "OperationInProgressException";
|
|
1895
|
-
$fault: "client";
|
|
2086
|
+
export declare class OperationInProgressException extends __BaseException {
|
|
2087
|
+
readonly name: "OperationInProgressException";
|
|
2088
|
+
readonly $fault: "client";
|
|
1896
2089
|
Message?: string;
|
|
2090
|
+
/**
|
|
2091
|
+
* @internal
|
|
2092
|
+
*/
|
|
2093
|
+
constructor(opts: __ExceptionOptionType<OperationInProgressException, __BaseException>);
|
|
1897
2094
|
}
|
|
1898
2095
|
/**
|
|
1899
2096
|
* <p>The specified stack set doesn't exist.</p>
|
|
1900
2097
|
*/
|
|
1901
|
-
export
|
|
1902
|
-
name: "StackSetNotFoundException";
|
|
1903
|
-
$fault: "client";
|
|
2098
|
+
export declare class StackSetNotFoundException extends __BaseException {
|
|
2099
|
+
readonly name: "StackSetNotFoundException";
|
|
2100
|
+
readonly $fault: "client";
|
|
1904
2101
|
Message?: string;
|
|
2102
|
+
/**
|
|
2103
|
+
* @internal
|
|
2104
|
+
*/
|
|
2105
|
+
constructor(opts: __ExceptionOptionType<StackSetNotFoundException, __BaseException>);
|
|
1905
2106
|
}
|
|
1906
2107
|
/**
|
|
1907
2108
|
* <p>Another operation has been performed on this stack set since the specified operation was
|
|
1908
|
-
* performed
|
|
2109
|
+
* performed.</p>
|
|
1909
2110
|
*/
|
|
1910
|
-
export
|
|
1911
|
-
name: "StaleRequestException";
|
|
1912
|
-
$fault: "client";
|
|
2111
|
+
export declare class StaleRequestException extends __BaseException {
|
|
2112
|
+
readonly name: "StaleRequestException";
|
|
2113
|
+
readonly $fault: "client";
|
|
1913
2114
|
Message?: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* @internal
|
|
2117
|
+
*/
|
|
2118
|
+
constructor(opts: __ExceptionOptionType<StaleRequestException, __BaseException>);
|
|
1914
2119
|
}
|
|
1915
2120
|
/**
|
|
1916
2121
|
* <p>The specified resource exists, but has been changed.</p>
|
|
1917
2122
|
*/
|
|
1918
|
-
export
|
|
1919
|
-
name: "CreatedButModifiedException";
|
|
1920
|
-
$fault: "client";
|
|
2123
|
+
export declare class CreatedButModifiedException extends __BaseException {
|
|
2124
|
+
readonly name: "CreatedButModifiedException";
|
|
2125
|
+
readonly $fault: "client";
|
|
1921
2126
|
Message?: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* @internal
|
|
2129
|
+
*/
|
|
2130
|
+
constructor(opts: __ExceptionOptionType<CreatedButModifiedException, __BaseException>);
|
|
1922
2131
|
}
|
|
1923
2132
|
/**
|
|
1924
2133
|
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
|
@@ -1973,8 +2182,8 @@ export interface CreateStackSetInput {
|
|
|
1973
2182
|
TemplateBody?: string;
|
|
1974
2183
|
/**
|
|
1975
2184
|
* <p>The location of the file that contains the template body. The URL must point to a
|
|
1976
|
-
* template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a
|
|
1977
|
-
* Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
2185
|
+
* template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a
|
|
2186
|
+
* Systems Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
1978
2187
|
* in the CloudFormation User Guide.</p>
|
|
1979
2188
|
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
|
|
1980
2189
|
* not both.</p>
|
|
@@ -2000,18 +2209,19 @@ export interface CreateStackSetInput {
|
|
|
2000
2209
|
* </p>
|
|
2001
2210
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
2002
2211
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
2003
|
-
*
|
|
2004
|
-
* one of these capabilities.</p>
|
|
2212
|
+
* (IAM) users. For those stack sets, you must explicitly acknowledge
|
|
2213
|
+
* this by specifying one of these capabilities.</p>
|
|
2005
2214
|
* <p>The following IAM resources require you to specify either the
|
|
2006
2215
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
2007
2216
|
* capability.</p>
|
|
2008
2217
|
* <ul>
|
|
2009
2218
|
* <li>
|
|
2010
|
-
* <p>If you have IAM resources, you can specify either
|
|
2219
|
+
* <p>If you have IAM resources, you can specify either
|
|
2220
|
+
* capability.</p>
|
|
2011
2221
|
* </li>
|
|
2012
2222
|
* <li>
|
|
2013
|
-
* <p>If you have IAM resources with custom names, you
|
|
2014
|
-
*
|
|
2223
|
+
* <p>If you have IAM resources with custom names, you
|
|
2224
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
2015
2225
|
* </li>
|
|
2016
2226
|
* <li>
|
|
2017
2227
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -2035,7 +2245,7 @@ export interface CreateStackSetInput {
|
|
|
2035
2245
|
* </li>
|
|
2036
2246
|
* <li>
|
|
2037
2247
|
* <p>
|
|
2038
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
2248
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
2039
2249
|
* </p>
|
|
2040
2250
|
* </li>
|
|
2041
2251
|
* <li>
|
|
@@ -2058,12 +2268,11 @@ export interface CreateStackSetInput {
|
|
|
2058
2268
|
* </li>
|
|
2059
2269
|
* <li>
|
|
2060
2270
|
* <p>
|
|
2061
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
2271
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
2062
2272
|
* </p>
|
|
2063
2273
|
* </li>
|
|
2064
2274
|
* </ul>
|
|
2065
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
2066
|
-
* Resources in CloudFormation Templates</a>.</p>
|
|
2275
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates</a>.</p>
|
|
2067
2276
|
* </li>
|
|
2068
2277
|
* <li>
|
|
2069
2278
|
* <p>
|
|
@@ -2075,7 +2284,7 @@ export interface CreateStackSetInput {
|
|
|
2075
2284
|
* directly, you must acknowledge this capability. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation Macros to
|
|
2076
2285
|
* Perform Custom Processing on Templates</a>.</p>
|
|
2077
2286
|
* <important>
|
|
2078
|
-
* <p>Stack sets with service-managed permissions
|
|
2287
|
+
* <p>Stack sets with service-managed permissions don't currently support the use of
|
|
2079
2288
|
* macros in templates. (This includes the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html">AWS::Include</a> and <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a>
|
|
2080
2289
|
* transforms, which are macros hosted by CloudFormation.) Even if you specify this capability
|
|
2081
2290
|
* for a stack set with service-managed permissions, if you reference a macro in your
|
|
@@ -2089,33 +2298,32 @@ export interface CreateStackSetInput {
|
|
|
2089
2298
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
2090
2299
|
* CloudFormation also propagates these tags to supported resources that are
|
|
2091
2300
|
* created in the stacks. A maximum number of 50 tags can be specified.</p>
|
|
2092
|
-
* <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
|
|
2093
|
-
* If you don't, the entire <code>CreateStackSet</code> action fails with an
|
|
2094
|
-
* denied</code> error, and the stack set is not created.</p>
|
|
2301
|
+
* <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
|
|
2302
|
+
* tag resources. If you don't, the entire <code>CreateStackSet</code> action fails with an
|
|
2303
|
+
* <code>access denied</code> error, and the stack set is not created.</p>
|
|
2095
2304
|
*/
|
|
2096
2305
|
Tags?: Tag[];
|
|
2097
2306
|
/**
|
|
2098
|
-
* <p>The Amazon Resource Number (ARN) of the IAM role to use to create this
|
|
2099
|
-
*
|
|
2100
|
-
*
|
|
2101
|
-
*
|
|
2102
|
-
*
|
|
2103
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
2307
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role to use to create this
|
|
2308
|
+
* stack set.</p>
|
|
2309
|
+
* <p>Specify an IAM role only if you are using customized administrator roles
|
|
2310
|
+
* to control which users or groups can manage specific stack sets within the same
|
|
2311
|
+
* administrator account. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites: Granting Permissions for Stack
|
|
2312
|
+
* Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2104
2313
|
*/
|
|
2105
2314
|
AdministrationRoleARN?: string;
|
|
2106
2315
|
/**
|
|
2107
|
-
* <p>The name of the IAM execution role to use to create the stack set. If you
|
|
2108
|
-
* an execution role, CloudFormation uses the
|
|
2109
|
-
*
|
|
2110
|
-
*
|
|
2111
|
-
*
|
|
2112
|
-
*
|
|
2113
|
-
* </p>
|
|
2316
|
+
* <p>The name of the IAM execution role to use to create the stack set. If you
|
|
2317
|
+
* do not specify an execution role, CloudFormation uses the
|
|
2318
|
+
* <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set
|
|
2319
|
+
* operation.</p>
|
|
2320
|
+
* <p>Specify an IAM role only if you are using customized execution roles to
|
|
2321
|
+
* control which stack resources users and groups can include in their stack sets.</p>
|
|
2114
2322
|
*/
|
|
2115
2323
|
ExecutionRoleName?: string;
|
|
2116
2324
|
/**
|
|
2117
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
2118
|
-
*
|
|
2325
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
2326
|
+
* created. By default, <code>SELF-MANAGED</code> is specified.</p>
|
|
2119
2327
|
* <ul>
|
|
2120
2328
|
* <li>
|
|
2121
2329
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -2125,8 +2333,7 @@ export interface CreateStackSetInput {
|
|
|
2125
2333
|
* </li>
|
|
2126
2334
|
* <li>
|
|
2127
2335
|
* <p>With <code>service-managed</code> permissions, StackSets automatically creates the
|
|
2128
|
-
*
|
|
2129
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
2336
|
+
* IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
2130
2337
|
* </li>
|
|
2131
2338
|
* </ul>
|
|
2132
2339
|
*/
|
|
@@ -2139,24 +2346,24 @@ export interface CreateStackSetInput {
|
|
|
2139
2346
|
AutoDeployment?: AutoDeployment;
|
|
2140
2347
|
/**
|
|
2141
2348
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
2142
|
-
* administrator in the organization's management account or as a delegated
|
|
2143
|
-
* member account.</p>
|
|
2349
|
+
* administrator in the organization's management account or as a delegated
|
|
2350
|
+
* administrator in a member account.</p>
|
|
2144
2351
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2145
2352
|
* self-managed permissions.</p>
|
|
2146
2353
|
* <ul>
|
|
2147
2354
|
* <li>
|
|
2148
2355
|
* <p>To create a stack set with service-managed permissions while signed in to the
|
|
2149
|
-
*
|
|
2356
|
+
* management account, specify <code>SELF</code>.</p>
|
|
2150
2357
|
* </li>
|
|
2151
2358
|
* <li>
|
|
2152
2359
|
* <p>To create a stack set with service-managed permissions while signed in to a
|
|
2153
2360
|
* delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
2154
2361
|
* <p>Your Amazon Web Services account must be registered as a delegated admin in the
|
|
2155
|
-
*
|
|
2362
|
+
* 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>
|
|
2156
2363
|
* </li>
|
|
2157
2364
|
* </ul>
|
|
2158
|
-
* <p>Stack sets with service-managed permissions are created in the management account,
|
|
2159
|
-
*
|
|
2365
|
+
* <p>Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated
|
|
2366
|
+
* administrators.</p>
|
|
2160
2367
|
*/
|
|
2161
2368
|
CallAs?: CallAs | string;
|
|
2162
2369
|
/**
|
|
@@ -2195,10 +2402,14 @@ export declare namespace CreateStackSetOutput {
|
|
|
2195
2402
|
/**
|
|
2196
2403
|
* <p>The specified name is already in use.</p>
|
|
2197
2404
|
*/
|
|
2198
|
-
export
|
|
2199
|
-
name: "NameAlreadyExistsException";
|
|
2200
|
-
$fault: "client";
|
|
2405
|
+
export declare class NameAlreadyExistsException extends __BaseException {
|
|
2406
|
+
readonly name: "NameAlreadyExistsException";
|
|
2407
|
+
readonly $fault: "client";
|
|
2201
2408
|
Message?: string;
|
|
2409
|
+
/**
|
|
2410
|
+
* @internal
|
|
2411
|
+
*/
|
|
2412
|
+
constructor(opts: __ExceptionOptionType<NameAlreadyExistsException, __BaseException>);
|
|
2202
2413
|
}
|
|
2203
2414
|
export interface DeactivateTypeInput {
|
|
2204
2415
|
/**
|
|
@@ -2244,8 +2455,8 @@ export interface DeleteChangeSetInput {
|
|
|
2244
2455
|
*/
|
|
2245
2456
|
ChangeSetName: string | undefined;
|
|
2246
2457
|
/**
|
|
2247
|
-
* <p>If you specified the name of a change set to delete, specify the stack name or
|
|
2248
|
-
* that
|
|
2458
|
+
* <p>If you specified the name of a change set to delete, specify the stack name or Amazon
|
|
2459
|
+
* Resource Name (ARN) that's associated with it.</p>
|
|
2249
2460
|
*/
|
|
2250
2461
|
StackName?: string;
|
|
2251
2462
|
}
|
|
@@ -2271,32 +2482,37 @@ export declare namespace DeleteChangeSetOutput {
|
|
|
2271
2482
|
* status might be <code>CREATE_IN_PROGRESS</code>, or the stack status might be
|
|
2272
2483
|
* <code>UPDATE_IN_PROGRESS</code>.</p>
|
|
2273
2484
|
*/
|
|
2274
|
-
export
|
|
2275
|
-
name: "InvalidChangeSetStatusException";
|
|
2276
|
-
$fault: "client";
|
|
2485
|
+
export declare class InvalidChangeSetStatusException extends __BaseException {
|
|
2486
|
+
readonly name: "InvalidChangeSetStatusException";
|
|
2487
|
+
readonly $fault: "client";
|
|
2277
2488
|
Message?: string;
|
|
2489
|
+
/**
|
|
2490
|
+
* @internal
|
|
2491
|
+
*/
|
|
2492
|
+
constructor(opts: __ExceptionOptionType<InvalidChangeSetStatusException, __BaseException>);
|
|
2278
2493
|
}
|
|
2279
2494
|
/**
|
|
2280
2495
|
* <p>The input for <a>DeleteStack</a> action.</p>
|
|
2281
2496
|
*/
|
|
2282
2497
|
export interface DeleteStackInput {
|
|
2283
2498
|
/**
|
|
2284
|
-
* <p>The name or the unique stack ID that
|
|
2499
|
+
* <p>The name or the unique stack ID that's associated with the stack.</p>
|
|
2285
2500
|
*/
|
|
2286
2501
|
StackName: string | undefined;
|
|
2287
2502
|
/**
|
|
2288
2503
|
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that
|
|
2289
|
-
* are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but
|
|
2290
|
-
* <p>Retaining resources is useful when you
|
|
2504
|
+
* are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.</p>
|
|
2505
|
+
* <p>Retaining resources is useful when you can't delete a resource, such as a non-empty S3
|
|
2291
2506
|
* bucket, but you want to delete the stack.</p>
|
|
2292
2507
|
*/
|
|
2293
2508
|
RetainResources?: string[];
|
|
2294
2509
|
/**
|
|
2295
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2296
|
-
*
|
|
2510
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2511
|
+
* that CloudFormation assumes to delete the stack. CloudFormation uses the
|
|
2512
|
+
* role's credentials to make calls on your behalf.</p>
|
|
2297
2513
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
2298
2514
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
2299
|
-
* session that
|
|
2515
|
+
* session that's generated from your user credentials.</p>
|
|
2300
2516
|
*/
|
|
2301
2517
|
RoleARN?: string;
|
|
2302
2518
|
/**
|
|
@@ -2304,7 +2520,7 @@ export interface DeleteStackInput {
|
|
|
2304
2520
|
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
2305
2521
|
* delete a stack with the same name. You might retry <code>DeleteStack</code> requests to
|
|
2306
2522
|
* ensure that CloudFormation successfully received them.</p>
|
|
2307
|
-
* <p>All events
|
|
2523
|
+
* <p>All events initiated by a given stack operation are assigned the same client request
|
|
2308
2524
|
* token, which you can use to track operations. For example, if you execute a
|
|
2309
2525
|
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
2310
2526
|
* <code>StackEvents</code> generated by that operation will have
|
|
@@ -2345,7 +2561,7 @@ export interface DeleteStackInstancesInput {
|
|
|
2345
2561
|
*/
|
|
2346
2562
|
DeploymentTargets?: DeploymentTargets;
|
|
2347
2563
|
/**
|
|
2348
|
-
* <p>The Regions where you want to delete stack set instances.</p>
|
|
2564
|
+
* <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
|
|
2349
2565
|
*/
|
|
2350
2566
|
Regions: string[] | undefined;
|
|
2351
2567
|
/**
|
|
@@ -2371,13 +2587,14 @@ export interface DeleteStackInstancesInput {
|
|
|
2371
2587
|
OperationId?: string;
|
|
2372
2588
|
/**
|
|
2373
2589
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
2374
|
-
* administrator in the organization's management account or as a delegated
|
|
2375
|
-
* member account.</p>
|
|
2590
|
+
* administrator in the organization's management account or as a delegated
|
|
2591
|
+
* administrator in a member account.</p>
|
|
2376
2592
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2377
2593
|
* self-managed permissions.</p>
|
|
2378
2594
|
* <ul>
|
|
2379
2595
|
* <li>
|
|
2380
|
-
* <p>If you are signed in to the management account, specify
|
|
2596
|
+
* <p>If you are signed in to the management account, specify
|
|
2597
|
+
* <code>SELF</code>.</p>
|
|
2381
2598
|
* </li>
|
|
2382
2599
|
* <li>
|
|
2383
2600
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -2415,13 +2632,14 @@ export interface DeleteStackSetInput {
|
|
|
2415
2632
|
StackSetName: string | undefined;
|
|
2416
2633
|
/**
|
|
2417
2634
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
2418
|
-
* administrator in the organization's management account or as a delegated
|
|
2419
|
-
* member account.</p>
|
|
2635
|
+
* administrator in the organization's management account or as a delegated
|
|
2636
|
+
* administrator in a member account.</p>
|
|
2420
2637
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2421
2638
|
* self-managed permissions.</p>
|
|
2422
2639
|
* <ul>
|
|
2423
2640
|
* <li>
|
|
2424
|
-
* <p>If you are signed in to the management account, specify
|
|
2641
|
+
* <p>If you are signed in to the management account, specify
|
|
2642
|
+
* <code>SELF</code>.</p>
|
|
2425
2643
|
* </li>
|
|
2426
2644
|
* <li>
|
|
2427
2645
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -2452,12 +2670,16 @@ export declare namespace DeleteStackSetOutput {
|
|
|
2452
2670
|
* instances. Delete all stack instances from the stack set before deleting the stack
|
|
2453
2671
|
* set.</p>
|
|
2454
2672
|
*/
|
|
2455
|
-
export
|
|
2456
|
-
name: "StackSetNotEmptyException";
|
|
2457
|
-
$fault: "client";
|
|
2673
|
+
export declare class StackSetNotEmptyException extends __BaseException {
|
|
2674
|
+
readonly name: "StackSetNotEmptyException";
|
|
2675
|
+
readonly $fault: "client";
|
|
2458
2676
|
Message?: string;
|
|
2677
|
+
/**
|
|
2678
|
+
* @internal
|
|
2679
|
+
*/
|
|
2680
|
+
constructor(opts: __ExceptionOptionType<StackSetNotEmptyException, __BaseException>);
|
|
2459
2681
|
}
|
|
2460
|
-
export declare type RegistryType = "MODULE" | "RESOURCE";
|
|
2682
|
+
export declare type RegistryType = "HOOK" | "MODULE" | "RESOURCE";
|
|
2461
2683
|
export interface DeregisterTypeInput {
|
|
2462
2684
|
/**
|
|
2463
2685
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
@@ -2518,8 +2740,8 @@ export declare namespace DescribeAccountLimitsInput {
|
|
|
2518
2740
|
*/
|
|
2519
2741
|
export interface DescribeAccountLimitsOutput {
|
|
2520
2742
|
/**
|
|
2521
|
-
* <p>An account limit structure that contain a list of CloudFormation account limits
|
|
2522
|
-
*
|
|
2743
|
+
* <p>An account limit structure that contain a list of CloudFormation account limits and
|
|
2744
|
+
* their values.</p>
|
|
2523
2745
|
*/
|
|
2524
2746
|
AccountLimits?: AccountLimit[];
|
|
2525
2747
|
/**
|
|
@@ -2569,15 +2791,16 @@ export interface DescribeChangeSetOutput {
|
|
|
2569
2791
|
*/
|
|
2570
2792
|
ChangeSetName?: string;
|
|
2571
2793
|
/**
|
|
2572
|
-
* <p>The ARN of the change set.</p>
|
|
2794
|
+
* <p>The Amazon Resource Name (ARN) of the change set.</p>
|
|
2573
2795
|
*/
|
|
2574
2796
|
ChangeSetId?: string;
|
|
2575
2797
|
/**
|
|
2576
|
-
* <p>The ARN of the stack that
|
|
2798
|
+
* <p>The Amazon Resource Name (ARN) of the stack that's associated with the change
|
|
2799
|
+
* set.</p>
|
|
2577
2800
|
*/
|
|
2578
2801
|
StackId?: string;
|
|
2579
2802
|
/**
|
|
2580
|
-
* <p>The name of the stack that
|
|
2803
|
+
* <p>The name of the stack that's associated with the change set.</p>
|
|
2581
2804
|
*/
|
|
2582
2805
|
StackName?: string;
|
|
2583
2806
|
/**
|
|
@@ -2595,7 +2818,7 @@ export interface DescribeChangeSetOutput {
|
|
|
2595
2818
|
CreationTime?: Date;
|
|
2596
2819
|
/**
|
|
2597
2820
|
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
2598
|
-
* set. If you can
|
|
2821
|
+
* set. If you can't execute the change set, the status indicates why. For example, a change
|
|
2599
2822
|
* set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still
|
|
2600
2823
|
* creating it or in an <code>OBSOLETE</code> state because the stack was already
|
|
2601
2824
|
* updated.</p>
|
|
@@ -2631,7 +2854,8 @@ export interface DescribeChangeSetOutput {
|
|
|
2631
2854
|
*/
|
|
2632
2855
|
Tags?: Tag[];
|
|
2633
2856
|
/**
|
|
2634
|
-
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation
|
|
2857
|
+
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation
|
|
2858
|
+
* changes if you execute the change set.</p>
|
|
2635
2859
|
*/
|
|
2636
2860
|
Changes?: Change[];
|
|
2637
2861
|
/**
|
|
@@ -2660,10 +2884,74 @@ export declare namespace DescribeChangeSetOutput {
|
|
|
2660
2884
|
*/
|
|
2661
2885
|
const filterSensitiveLog: (obj: DescribeChangeSetOutput) => any;
|
|
2662
2886
|
}
|
|
2887
|
+
export interface DescribeChangeSetHooksInput {
|
|
2888
|
+
/**
|
|
2889
|
+
* <p>The name or Amazon Resource Name (ARN) of the change set that you want to
|
|
2890
|
+
* describe.</p>
|
|
2891
|
+
*/
|
|
2892
|
+
ChangeSetName: string | undefined;
|
|
2893
|
+
/**
|
|
2894
|
+
* <p>If you specified the name of a change set, specify the stack name or stack ID (ARN) of
|
|
2895
|
+
* the change set you want to describe.</p>
|
|
2896
|
+
*/
|
|
2897
|
+
StackName?: string;
|
|
2898
|
+
/**
|
|
2899
|
+
* <p>A string, provided by the <code>DescribeChangeSetHooks</code> response output, that
|
|
2900
|
+
* identifies the next page of information that you want to retrieve.</p>
|
|
2901
|
+
*/
|
|
2902
|
+
NextToken?: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* <p>If specified, lists only the hooks related to the specified
|
|
2905
|
+
* <code>LogicalResourceId</code>.</p>
|
|
2906
|
+
*/
|
|
2907
|
+
LogicalResourceId?: string;
|
|
2908
|
+
}
|
|
2909
|
+
export declare namespace DescribeChangeSetHooksInput {
|
|
2910
|
+
/**
|
|
2911
|
+
* @internal
|
|
2912
|
+
*/
|
|
2913
|
+
const filterSensitiveLog: (obj: DescribeChangeSetHooksInput) => any;
|
|
2914
|
+
}
|
|
2915
|
+
export interface DescribeChangeSetHooksOutput {
|
|
2916
|
+
/**
|
|
2917
|
+
* <p>The change set identifier (stack ID).</p>
|
|
2918
|
+
*/
|
|
2919
|
+
ChangeSetId?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* <p>The change set name.</p>
|
|
2922
|
+
*/
|
|
2923
|
+
ChangeSetName?: string;
|
|
2924
|
+
/**
|
|
2925
|
+
* <p>List of hook objects.</p>
|
|
2926
|
+
*/
|
|
2927
|
+
Hooks?: ChangeSetHook[];
|
|
2928
|
+
/**
|
|
2929
|
+
* <p>Provides the status of the change set hook.</p>
|
|
2930
|
+
*/
|
|
2931
|
+
Status?: ChangeSetHooksStatus | string;
|
|
2932
|
+
/**
|
|
2933
|
+
* <p>Pagination token, <code>null</code> or empty if no more results.</p>
|
|
2934
|
+
*/
|
|
2935
|
+
NextToken?: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* <p>The stack identifier (stack ID).</p>
|
|
2938
|
+
*/
|
|
2939
|
+
StackId?: string;
|
|
2940
|
+
/**
|
|
2941
|
+
* <p>The stack name.</p>
|
|
2942
|
+
*/
|
|
2943
|
+
StackName?: string;
|
|
2944
|
+
}
|
|
2945
|
+
export declare namespace DescribeChangeSetHooksOutput {
|
|
2946
|
+
/**
|
|
2947
|
+
* @internal
|
|
2948
|
+
*/
|
|
2949
|
+
const filterSensitiveLog: (obj: DescribeChangeSetHooksOutput) => any;
|
|
2950
|
+
}
|
|
2663
2951
|
export interface DescribePublisherInput {
|
|
2664
2952
|
/**
|
|
2665
2953
|
* <p>The ID of the extension publisher.</p>
|
|
2666
|
-
* <p>If you
|
|
2954
|
+
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension
|
|
2667
2955
|
* publisher, <code>DescribePublisher</code> returns information about your own publisher
|
|
2668
2956
|
* account.</p>
|
|
2669
2957
|
*/
|
|
@@ -2696,7 +2984,7 @@ export interface DescribePublisherOutput {
|
|
|
2696
2984
|
PublisherStatus?: PublisherStatus | string;
|
|
2697
2985
|
/**
|
|
2698
2986
|
* <p>The type of account used as the identity provider when registering this publisher with
|
|
2699
|
-
*
|
|
2987
|
+
* CloudFormation.</p>
|
|
2700
2988
|
*/
|
|
2701
2989
|
IdentityProvider?: IdentityProvider | string;
|
|
2702
2990
|
/**
|
|
@@ -2760,7 +3048,7 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2760
3048
|
* </li>
|
|
2761
3049
|
* <li>
|
|
2762
3050
|
* <p>
|
|
2763
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
3051
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its
|
|
2764
3052
|
* expected template configuration.</p>
|
|
2765
3053
|
* </li>
|
|
2766
3054
|
* <li>
|
|
@@ -2782,7 +3070,7 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2782
3070
|
* <p>
|
|
2783
3071
|
* <code>DETECTION_COMPLETE</code>: The stack drift detection operation has
|
|
2784
3072
|
* successfully completed for all resources in the stack that support drift detection.
|
|
2785
|
-
* (Resources that
|
|
3073
|
+
* (Resources that don't currently support stack detection remain unchecked.)</p>
|
|
2786
3074
|
* <p>If you specified logical resource IDs for CloudFormation to use as a filter for the stack
|
|
2787
3075
|
* drift detection operation, only the resources with those logical IDs are checked for
|
|
2788
3076
|
* drift.</p>
|
|
@@ -2827,7 +3115,7 @@ export declare namespace DescribeStackDriftDetectionStatusOutput {
|
|
|
2827
3115
|
*/
|
|
2828
3116
|
export interface DescribeStackEventsInput {
|
|
2829
3117
|
/**
|
|
2830
|
-
* <p>The name or the unique stack ID that
|
|
3118
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
2831
3119
|
* interchangeable:</p>
|
|
2832
3120
|
* <ul>
|
|
2833
3121
|
* <li>
|
|
@@ -2852,6 +3140,12 @@ export declare namespace DescribeStackEventsInput {
|
|
|
2852
3140
|
*/
|
|
2853
3141
|
const filterSensitiveLog: (obj: DescribeStackEventsInput) => any;
|
|
2854
3142
|
}
|
|
3143
|
+
export declare enum HookStatus {
|
|
3144
|
+
HOOK_COMPLETE_FAILED = "HOOK_COMPLETE_FAILED",
|
|
3145
|
+
HOOK_COMPLETE_SUCCEEDED = "HOOK_COMPLETE_SUCCEEDED",
|
|
3146
|
+
HOOK_FAILED = "HOOK_FAILED",
|
|
3147
|
+
HOOK_IN_PROGRESS = "HOOK_IN_PROGRESS"
|
|
3148
|
+
}
|
|
2855
3149
|
export declare enum ResourceStatus {
|
|
2856
3150
|
CREATE_COMPLETE = "CREATE_COMPLETE",
|
|
2857
3151
|
CREATE_FAILED = "CREATE_FAILED",
|
|
@@ -2902,8 +3196,7 @@ export interface StackEvent {
|
|
|
2902
3196
|
*/
|
|
2903
3197
|
PhysicalResourceId?: string;
|
|
2904
3198
|
/**
|
|
2905
|
-
* <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
|
|
2906
|
-
* Guide.)</p>
|
|
3199
|
+
* <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 Guide.)</p>
|
|
2907
3200
|
*/
|
|
2908
3201
|
ResourceType?: string;
|
|
2909
3202
|
/**
|
|
@@ -2934,9 +3227,39 @@ export interface StackEvent {
|
|
|
2934
3227
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
2935
3228
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
2936
3229
|
* would be assigned the same token in the following format:
|
|
2937
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
3230
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
2938
3231
|
*/
|
|
2939
3232
|
ClientRequestToken?: string;
|
|
3233
|
+
/**
|
|
3234
|
+
* <p>The name of the hook.</p>
|
|
3235
|
+
*/
|
|
3236
|
+
HookType?: string;
|
|
3237
|
+
/**
|
|
3238
|
+
* <p>Provides the status of the change set hook.</p>
|
|
3239
|
+
*/
|
|
3240
|
+
HookStatus?: HookStatus | string;
|
|
3241
|
+
/**
|
|
3242
|
+
* <p>Provides the reason for the hook status.</p>
|
|
3243
|
+
*/
|
|
3244
|
+
HookStatusReason?: string;
|
|
3245
|
+
/**
|
|
3246
|
+
* <p>Invocation points are points in provisioning logic where hooks are initiated.</p>
|
|
3247
|
+
*/
|
|
3248
|
+
HookInvocationPoint?: HookInvocationPoint | string;
|
|
3249
|
+
/**
|
|
3250
|
+
* <p>Specify the hook failure mode for non-compliant resources in the followings ways.</p>
|
|
3251
|
+
* <ul>
|
|
3252
|
+
* <li>
|
|
3253
|
+
* <p>
|
|
3254
|
+
* <code>FAIL</code> Stops provisioning resources.</p>
|
|
3255
|
+
* </li>
|
|
3256
|
+
* <li>
|
|
3257
|
+
* <p>
|
|
3258
|
+
* <code>WARN</code> Allows provisioning to continue with a warning message.</p>
|
|
3259
|
+
* </li>
|
|
3260
|
+
* </ul>
|
|
3261
|
+
*/
|
|
3262
|
+
HookFailureMode?: HookFailureMode | string;
|
|
2940
3263
|
}
|
|
2941
3264
|
export declare namespace StackEvent {
|
|
2942
3265
|
/**
|
|
@@ -2981,13 +3304,14 @@ export interface DescribeStackInstanceInput {
|
|
|
2981
3304
|
StackInstanceRegion: string | undefined;
|
|
2982
3305
|
/**
|
|
2983
3306
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
2984
|
-
* administrator in the organization's management account or as a delegated
|
|
2985
|
-
* member account.</p>
|
|
3307
|
+
* administrator in the organization's management account or as a delegated
|
|
3308
|
+
* administrator in a member account.</p>
|
|
2986
3309
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2987
3310
|
* self-managed permissions.</p>
|
|
2988
3311
|
* <ul>
|
|
2989
3312
|
* <li>
|
|
2990
|
-
* <p>If you are signed in to the management account, specify
|
|
3313
|
+
* <p>If you are signed in to the management account, specify
|
|
3314
|
+
* <code>SELF</code>.</p>
|
|
2991
3315
|
* </li>
|
|
2992
3316
|
* <li>
|
|
2993
3317
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -3015,7 +3339,7 @@ export interface StackInstanceComprehensiveStatus {
|
|
|
3015
3339
|
* <li>
|
|
3016
3340
|
* <p>
|
|
3017
3341
|
* <code>CANCELLED</code>: The operation in the specified account and Region has been
|
|
3018
|
-
*
|
|
3342
|
+
* canceled. This is either because a user has stopped the stack set operation, or
|
|
3019
3343
|
* because the failure tolerance of the stack set operation has been exceeded.</p>
|
|
3020
3344
|
* </li>
|
|
3021
3345
|
* <li>
|
|
@@ -3065,7 +3389,7 @@ export declare type StackInstanceStatus = "CURRENT" | "INOPERABLE" | "OUTDATED";
|
|
|
3065
3389
|
* given account within a given Region. A stack instance can exist without a stack—for
|
|
3066
3390
|
* example, if the stack couldn't be created for some reason. A stack instance is associated
|
|
3067
3391
|
* with only one stack set. Each stack instance contains the ID of its associated stack set,
|
|
3068
|
-
*
|
|
3392
|
+
* in addition to the ID of the actual stack and the stack status.</p>
|
|
3069
3393
|
*/
|
|
3070
3394
|
export interface StackInstance {
|
|
3071
3395
|
/**
|
|
@@ -3112,12 +3436,12 @@ export interface StackInstance {
|
|
|
3112
3436
|
* <ul>
|
|
3113
3437
|
* <li>
|
|
3114
3438
|
* <p>The associated stack failed during a <code>CreateStackSet</code> or
|
|
3115
|
-
* <code>UpdateStackSet</code> operation
|
|
3439
|
+
* <code>UpdateStackSet</code> operation.</p>
|
|
3116
3440
|
* </li>
|
|
3117
3441
|
* <li>
|
|
3118
3442
|
* <p>The stack was part of a <code>CreateStackSet</code> or
|
|
3119
3443
|
* <code>UpdateStackSet</code> operation that failed or was stopped before the
|
|
3120
|
-
* stack was created or updated
|
|
3444
|
+
* stack was created or updated.</p>
|
|
3121
3445
|
* </li>
|
|
3122
3446
|
* </ul>
|
|
3123
3447
|
* </li>
|
|
@@ -3133,7 +3457,7 @@ export interface StackInstance {
|
|
|
3133
3457
|
*/
|
|
3134
3458
|
StackInstanceStatus?: StackInstanceComprehensiveStatus;
|
|
3135
3459
|
/**
|
|
3136
|
-
* <p>The explanation for the specific status code that
|
|
3460
|
+
* <p>The explanation for the specific status code that's assigned to this stack
|
|
3137
3461
|
* instance.</p>
|
|
3138
3462
|
*/
|
|
3139
3463
|
StatusReason?: string;
|
|
@@ -3144,7 +3468,7 @@ export interface StackInstance {
|
|
|
3144
3468
|
OrganizationalUnitId?: string;
|
|
3145
3469
|
/**
|
|
3146
3470
|
* <p>Status of the stack instance's actual configuration compared to the expected template
|
|
3147
|
-
* and parameter configuration of the stack set to which it belongs
|
|
3471
|
+
* and parameter configuration of the stack set to which it belongs.</p>
|
|
3148
3472
|
* <ul>
|
|
3149
3473
|
* <li>
|
|
3150
3474
|
* <p>
|
|
@@ -3155,7 +3479,7 @@ export interface StackInstance {
|
|
|
3155
3479
|
* </li>
|
|
3156
3480
|
* <li>
|
|
3157
3481
|
* <p>
|
|
3158
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
3482
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack instance differs from
|
|
3159
3483
|
* its expected stack set configuration.</p>
|
|
3160
3484
|
* </li>
|
|
3161
3485
|
* <li>
|
|
@@ -3173,7 +3497,7 @@ export interface StackInstance {
|
|
|
3173
3497
|
/**
|
|
3174
3498
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
3175
3499
|
* the stack instance. This value will be <code>NULL</code> for any stack instance on which
|
|
3176
|
-
* drift detection
|
|
3500
|
+
* drift detection hasn't yet been performed.</p>
|
|
3177
3501
|
*/
|
|
3178
3502
|
LastDriftCheckTimestamp?: Date;
|
|
3179
3503
|
}
|
|
@@ -3198,17 +3522,21 @@ export declare namespace DescribeStackInstanceOutput {
|
|
|
3198
3522
|
/**
|
|
3199
3523
|
* <p>The specified stack instance doesn't exist.</p>
|
|
3200
3524
|
*/
|
|
3201
|
-
export
|
|
3202
|
-
name: "StackInstanceNotFoundException";
|
|
3203
|
-
$fault: "client";
|
|
3525
|
+
export declare class StackInstanceNotFoundException extends __BaseException {
|
|
3526
|
+
readonly name: "StackInstanceNotFoundException";
|
|
3527
|
+
readonly $fault: "client";
|
|
3204
3528
|
Message?: string;
|
|
3529
|
+
/**
|
|
3530
|
+
* @internal
|
|
3531
|
+
*/
|
|
3532
|
+
constructor(opts: __ExceptionOptionType<StackInstanceNotFoundException, __BaseException>);
|
|
3205
3533
|
}
|
|
3206
3534
|
/**
|
|
3207
3535
|
* <p>The input for <a>DescribeStackResource</a> action.</p>
|
|
3208
3536
|
*/
|
|
3209
3537
|
export interface DescribeStackResourceInput {
|
|
3210
3538
|
/**
|
|
3211
|
-
* <p>The name or the unique stack ID that
|
|
3539
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
3212
3540
|
* interchangeable:</p>
|
|
3213
3541
|
* <ul>
|
|
3214
3542
|
* <li>
|
|
@@ -3264,11 +3592,11 @@ export interface StackResourceDriftInformation {
|
|
|
3264
3592
|
* <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from its
|
|
3265
3593
|
* expected configuration.</p>
|
|
3266
3594
|
* <p>Any resources that do not currently support drift detection have a status of
|
|
3267
|
-
* <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
|
|
3595
|
+
* <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>
|
|
3268
3596
|
* </li>
|
|
3269
3597
|
* <li>
|
|
3270
3598
|
* <p>
|
|
3271
|
-
* <code>IN_SYNC</code>: The
|
|
3599
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3272
3600
|
* configuration.</p>
|
|
3273
3601
|
* </li>
|
|
3274
3602
|
* </ul>
|
|
@@ -3308,8 +3636,7 @@ export interface StackResourceDetail {
|
|
|
3308
3636
|
*/
|
|
3309
3637
|
PhysicalResourceId?: string;
|
|
3310
3638
|
/**
|
|
3311
|
-
* <p>Type of resource.
|
|
3312
|
-
* Guide.)</p>
|
|
3639
|
+
* <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 Guide.</p>
|
|
3313
3640
|
*/
|
|
3314
3641
|
ResourceType: string | undefined;
|
|
3315
3642
|
/**
|
|
@@ -3390,12 +3717,12 @@ export interface DescribeStackResourceDriftsInput {
|
|
|
3390
3717
|
* </li>
|
|
3391
3718
|
* <li>
|
|
3392
3719
|
* <p>
|
|
3393
|
-
* <code>IN_SYNC</code>: The
|
|
3720
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3394
3721
|
* template configuration.</p>
|
|
3395
3722
|
* </li>
|
|
3396
3723
|
* <li>
|
|
3397
3724
|
* <p>
|
|
3398
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
3725
|
+
* <code>NOT_CHECKED</code>: CloudFormation doesn't currently return this value.</p>
|
|
3399
3726
|
* </li>
|
|
3400
3727
|
* </ul>
|
|
3401
3728
|
*/
|
|
@@ -3420,7 +3747,7 @@ export declare namespace DescribeStackResourceDriftsInput {
|
|
|
3420
3747
|
}
|
|
3421
3748
|
/**
|
|
3422
3749
|
* <p>Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses
|
|
3423
|
-
* context key-value pairs in cases where a resource's logical and physical IDs
|
|
3750
|
+
* context key-value pairs in cases where a resource's logical and physical IDs aren't enough
|
|
3424
3751
|
* to uniquely identify that resource. Each context key-value pair specifies a resource that
|
|
3425
3752
|
* contains the targeted resource.</p>
|
|
3426
3753
|
*/
|
|
@@ -3471,8 +3798,8 @@ export interface PropertyDifference {
|
|
|
3471
3798
|
* <ul>
|
|
3472
3799
|
* <li>
|
|
3473
3800
|
* <p>
|
|
3474
|
-
* <code>ADD</code>: A value has been added to a resource property that
|
|
3475
|
-
*
|
|
3801
|
+
* <code>ADD</code>: A value has been added to a resource property that's an array or
|
|
3802
|
+
* list data type.</p>
|
|
3476
3803
|
* </li>
|
|
3477
3804
|
* <li>
|
|
3478
3805
|
* <p>
|
|
@@ -3501,7 +3828,7 @@ export declare namespace PropertyDifference {
|
|
|
3501
3828
|
* drift. Only resource properties explicitly defined in the stack template are checked for
|
|
3502
3829
|
* drift. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
3503
3830
|
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
3504
|
-
* <p>Resources that
|
|
3831
|
+
* <p>Resources that don't currently support drift detection can't be checked. For a list of
|
|
3505
3832
|
* 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
|
|
3506
3833
|
* Drift Detection</a>.</p>
|
|
3507
3834
|
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources,
|
|
@@ -3519,12 +3846,12 @@ export interface StackResourceDrift {
|
|
|
3519
3846
|
LogicalResourceId: string | undefined;
|
|
3520
3847
|
/**
|
|
3521
3848
|
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3522
|
-
* supported by CloudFormation
|
|
3849
|
+
* supported by CloudFormation.</p>
|
|
3523
3850
|
*/
|
|
3524
3851
|
PhysicalResourceId?: string;
|
|
3525
3852
|
/**
|
|
3526
3853
|
* <p>Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses
|
|
3527
|
-
* context key-value pairs in cases where a resource's logical and physical IDs
|
|
3854
|
+
* context key-value pairs in cases where a resource's logical and physical IDs aren't enough
|
|
3528
3855
|
* to uniquely identify that resource. Each context key-value pair specifies a unique resource
|
|
3529
3856
|
* that contains the targeted resource.</p>
|
|
3530
3857
|
*/
|
|
@@ -3535,27 +3862,27 @@ export interface StackResourceDrift {
|
|
|
3535
3862
|
ResourceType: string | undefined;
|
|
3536
3863
|
/**
|
|
3537
3864
|
* <p>A JSON structure containing the expected property values of the stack resource, as
|
|
3538
|
-
* defined in the stack template and any values specified as template parameters
|
|
3865
|
+
* defined in the stack template and any values specified as template parameters.</p>
|
|
3539
3866
|
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this
|
|
3540
|
-
* structure will not be present
|
|
3867
|
+
* structure will not be present.</p>
|
|
3541
3868
|
*/
|
|
3542
3869
|
ExpectedProperties?: string;
|
|
3543
3870
|
/**
|
|
3544
3871
|
* <p>A JSON structure containing the actual property values of the stack resource.</p>
|
|
3545
3872
|
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this
|
|
3546
|
-
* structure will not be present
|
|
3873
|
+
* structure will not be present.</p>
|
|
3547
3874
|
*/
|
|
3548
3875
|
ActualProperties?: string;
|
|
3549
3876
|
/**
|
|
3550
3877
|
* <p>A collection of the resource properties whose actual values differ from their expected
|
|
3551
3878
|
* values. These will be present only for resources whose
|
|
3552
|
-
* <code>StackResourceDriftStatus</code> is
|
|
3553
|
-
* </p>
|
|
3879
|
+
* <code>StackResourceDriftStatus</code> is
|
|
3880
|
+
* <code>MODIFIED</code>.</p>
|
|
3554
3881
|
*/
|
|
3555
3882
|
PropertyDifferences?: PropertyDifference[];
|
|
3556
3883
|
/**
|
|
3557
3884
|
* <p>Status of the resource's actual configuration compared to its expected
|
|
3558
|
-
* configuration
|
|
3885
|
+
* configuration.</p>
|
|
3559
3886
|
* <ul>
|
|
3560
3887
|
* <li>
|
|
3561
3888
|
* <p>
|
|
@@ -3570,7 +3897,7 @@ export interface StackResourceDrift {
|
|
|
3570
3897
|
* </li>
|
|
3571
3898
|
* <li>
|
|
3572
3899
|
* <p>
|
|
3573
|
-
* <code>IN_SYNC</code>: The
|
|
3900
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3574
3901
|
* template configuration.</p>
|
|
3575
3902
|
* </li>
|
|
3576
3903
|
* <li>
|
|
@@ -3602,10 +3929,9 @@ export interface DescribeStackResourceDriftsOutput {
|
|
|
3602
3929
|
* stack. This includes actual and expected configuration values for resources where CloudFormation
|
|
3603
3930
|
* detects drift.</p>
|
|
3604
3931
|
* <p>For a given stack, there will be one <code>StackResourceDrift</code> for each stack
|
|
3605
|
-
* resource that has been checked for drift. Resources that
|
|
3606
|
-
*
|
|
3607
|
-
*
|
|
3608
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.</p>
|
|
3932
|
+
* resource that has been checked for drift. Resources that haven't yet been checked for drift
|
|
3933
|
+
* aren't included. Resources that do not currently support drift detection aren't checked,
|
|
3934
|
+
* and so not included. For a list of resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.</p>
|
|
3609
3935
|
*/
|
|
3610
3936
|
StackResourceDrifts: StackResourceDrift[] | undefined;
|
|
3611
3937
|
/**
|
|
@@ -3628,7 +3954,7 @@ export declare namespace DescribeStackResourceDriftsOutput {
|
|
|
3628
3954
|
*/
|
|
3629
3955
|
export interface DescribeStackResourcesInput {
|
|
3630
3956
|
/**
|
|
3631
|
-
* <p>The name or the unique stack ID that is associated with the stack, which
|
|
3957
|
+
* <p>The name or the unique stack ID that is associated with the stack, which aren't always
|
|
3632
3958
|
* interchangeable:</p>
|
|
3633
3959
|
* <ul>
|
|
3634
3960
|
* <li>
|
|
@@ -3640,7 +3966,7 @@ export interface DescribeStackResourcesInput {
|
|
|
3640
3966
|
* </li>
|
|
3641
3967
|
* </ul>
|
|
3642
3968
|
* <p>Default: There is no default value.</p>
|
|
3643
|
-
* <p>Required: Conditional. If you
|
|
3969
|
+
* <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify
|
|
3644
3970
|
* <code>PhysicalResourceId</code>.</p>
|
|
3645
3971
|
*/
|
|
3646
3972
|
StackName?: string;
|
|
@@ -3656,7 +3982,7 @@ export interface DescribeStackResourcesInput {
|
|
|
3656
3982
|
* <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass
|
|
3657
3983
|
* the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack
|
|
3658
3984
|
* the instance belongs to and what other resources are part of the stack.</p>
|
|
3659
|
-
* <p>Required: Conditional. If you
|
|
3985
|
+
* <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must
|
|
3660
3986
|
* specify <code>StackName</code>.</p>
|
|
3661
3987
|
* <p>Default: There is no default value.</p>
|
|
3662
3988
|
*/
|
|
@@ -3690,8 +4016,8 @@ export interface StackResource {
|
|
|
3690
4016
|
*/
|
|
3691
4017
|
PhysicalResourceId?: string;
|
|
3692
4018
|
/**
|
|
3693
|
-
* <p>Type of resource.
|
|
3694
|
-
* Guide
|
|
4019
|
+
* <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
|
|
4020
|
+
* Guide.</p>
|
|
3695
4021
|
*/
|
|
3696
4022
|
ResourceType: string | undefined;
|
|
3697
4023
|
/**
|
|
@@ -3749,7 +4075,7 @@ export declare namespace DescribeStackResourcesOutput {
|
|
|
3749
4075
|
*/
|
|
3750
4076
|
export interface DescribeStacksInput {
|
|
3751
4077
|
/**
|
|
3752
|
-
* <p>The name or the unique stack ID that
|
|
4078
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
3753
4079
|
* interchangeable:</p>
|
|
3754
4080
|
* <ul>
|
|
3755
4081
|
* <li>
|
|
@@ -3783,7 +4109,7 @@ export declare namespace DescribeStacksInput {
|
|
|
3783
4109
|
export interface StackDriftInformation {
|
|
3784
4110
|
/**
|
|
3785
4111
|
* <p>Status of the stack's actual configuration compared to its expected template
|
|
3786
|
-
* configuration
|
|
4112
|
+
* configuration.</p>
|
|
3787
4113
|
* <ul>
|
|
3788
4114
|
* <li>
|
|
3789
4115
|
* <p>
|
|
@@ -3793,7 +4119,7 @@ export interface StackDriftInformation {
|
|
|
3793
4119
|
* </li>
|
|
3794
4120
|
* <li>
|
|
3795
4121
|
* <p>
|
|
3796
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
4122
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its
|
|
3797
4123
|
* expected template configuration.</p>
|
|
3798
4124
|
* </li>
|
|
3799
4125
|
* <li>
|
|
@@ -3927,17 +4253,18 @@ export interface Stack {
|
|
|
3927
4253
|
* <ul>
|
|
3928
4254
|
* <li>
|
|
3929
4255
|
* <p>
|
|
3930
|
-
* <code>true</code>: disable rollback
|
|
4256
|
+
* <code>true</code>: disable rollback.</p>
|
|
3931
4257
|
* </li>
|
|
3932
4258
|
* <li>
|
|
3933
4259
|
* <p>
|
|
3934
|
-
* <code>false</code>: enable rollback
|
|
4260
|
+
* <code>false</code>: enable rollback.</p>
|
|
3935
4261
|
* </li>
|
|
3936
4262
|
* </ul>
|
|
3937
4263
|
*/
|
|
3938
4264
|
DisableRollback?: boolean;
|
|
3939
4265
|
/**
|
|
3940
|
-
* <p>SNS topic ARNs to which stack related events are
|
|
4266
|
+
* <p>Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are
|
|
4267
|
+
* published.</p>
|
|
3941
4268
|
*/
|
|
3942
4269
|
NotificationARNs?: string[];
|
|
3943
4270
|
/**
|
|
@@ -3953,8 +4280,8 @@ export interface Stack {
|
|
|
3953
4280
|
*/
|
|
3954
4281
|
Outputs?: Output[];
|
|
3955
4282
|
/**
|
|
3956
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
3957
|
-
* associated with the stack. During a stack operation, CloudFormation uses this
|
|
4283
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4284
|
+
* that's associated with the stack. During a stack operation, CloudFormation uses this
|
|
3958
4285
|
* role's credentials to make calls on your behalf.</p>
|
|
3959
4286
|
*/
|
|
3960
4287
|
RoleARN?: string;
|
|
@@ -3964,7 +4291,7 @@ export interface Stack {
|
|
|
3964
4291
|
Tags?: Tag[];
|
|
3965
4292
|
/**
|
|
3966
4293
|
* <p>Whether termination protection is enabled for the stack.</p>
|
|
3967
|
-
* <p>
|
|
4294
|
+
* <p>For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>,
|
|
3968
4295
|
* termination protection is set on the root stack and cannot be changed directly on the
|
|
3969
4296
|
* nested stack. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a Stack From Being
|
|
3970
4297
|
* Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
@@ -4024,13 +4351,14 @@ export interface DescribeStackSetInput {
|
|
|
4024
4351
|
StackSetName: string | undefined;
|
|
4025
4352
|
/**
|
|
4026
4353
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
4027
|
-
* administrator in the organization's management account or as a delegated
|
|
4028
|
-
* member account.</p>
|
|
4354
|
+
* administrator in the organization's management account or as a delegated
|
|
4355
|
+
* administrator in a member account.</p>
|
|
4029
4356
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
4030
4357
|
* self-managed permissions.</p>
|
|
4031
4358
|
* <ul>
|
|
4032
4359
|
* <li>
|
|
4033
|
-
* <p>If you are signed in to the management account, specify
|
|
4360
|
+
* <p>If you are signed in to the management account, specify
|
|
4361
|
+
* <code>SELF</code>.</p>
|
|
4034
4362
|
* </li>
|
|
4035
4363
|
* <li>
|
|
4036
4364
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -4063,12 +4391,12 @@ export declare enum StackSetDriftStatus {
|
|
|
4063
4391
|
/**
|
|
4064
4392
|
* <p>Detailed information about the drift status of the stack set.</p>
|
|
4065
4393
|
* <p>For stack sets, contains information about the last <i>completed</i> drift
|
|
4066
|
-
* operation performed on the stack set. Information about drift operations in-progress
|
|
4067
|
-
* included
|
|
4394
|
+
* operation performed on the stack set. Information about drift operations in-progress isn't
|
|
4395
|
+
* included.</p>
|
|
4068
4396
|
* <p>For stack set operations, includes information about drift operations currently being
|
|
4069
4397
|
* performed on the stack set.</p>
|
|
4070
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting
|
|
4071
|
-
*
|
|
4398
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting unmanaged
|
|
4399
|
+
* changes in stack sets</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4072
4400
|
*/
|
|
4073
4401
|
export interface StackSetDriftDetectionDetails {
|
|
4074
4402
|
/**
|
|
@@ -4086,7 +4414,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4086
4414
|
* </li>
|
|
4087
4415
|
* <li>
|
|
4088
4416
|
* <p>
|
|
4089
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
4417
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked the stack set for drift.</p>
|
|
4090
4418
|
* </li>
|
|
4091
4419
|
* <li>
|
|
4092
4420
|
* <p>
|
|
@@ -4107,7 +4435,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4107
4435
|
* <li>
|
|
4108
4436
|
* <p>
|
|
4109
4437
|
* <code>FAILED</code>: The drift detection operation exceeded the specified failure
|
|
4110
|
-
* tolerance
|
|
4438
|
+
* tolerance.</p>
|
|
4111
4439
|
* </li>
|
|
4112
4440
|
* <li>
|
|
4113
4441
|
* <p>
|
|
@@ -4121,7 +4449,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4121
4449
|
* </li>
|
|
4122
4450
|
* <li>
|
|
4123
4451
|
* <p>
|
|
4124
|
-
* <code>STOPPED</code>: The user has
|
|
4452
|
+
* <code>STOPPED</code>: The user has canceled the drift detection operation.</p>
|
|
4125
4453
|
* </li>
|
|
4126
4454
|
* </ul>
|
|
4127
4455
|
*/
|
|
@@ -4129,18 +4457,18 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4129
4457
|
/**
|
|
4130
4458
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
4131
4459
|
* the stack set. This value will be <code>NULL</code> for any stack set on which drift
|
|
4132
|
-
* detection
|
|
4460
|
+
* detection hasn't yet been performed.</p>
|
|
4133
4461
|
*/
|
|
4134
4462
|
LastDriftCheckTimestamp?: Date;
|
|
4135
4463
|
/**
|
|
4136
|
-
* <p>The total number of stack instances belonging to this stack set
|
|
4464
|
+
* <p>The total number of stack instances belonging to this stack set.</p>
|
|
4137
4465
|
* <p>The total number of stack instances is equal to the total of:</p>
|
|
4138
4466
|
* <ul>
|
|
4139
4467
|
* <li>
|
|
4140
|
-
* <p>Stack instances that match the stack set configuration
|
|
4468
|
+
* <p>Stack instances that match the stack set configuration.</p>
|
|
4141
4469
|
* </li>
|
|
4142
4470
|
* <li>
|
|
4143
|
-
* <p>Stack instances that have drifted from the stack set configuration
|
|
4471
|
+
* <p>Stack instances that have drifted from the stack set configuration.</p>
|
|
4144
4472
|
* </li>
|
|
4145
4473
|
* <li>
|
|
4146
4474
|
* <p>Stack instances where the drift detection operation has failed.</p>
|
|
@@ -4154,7 +4482,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4154
4482
|
/**
|
|
4155
4483
|
* <p>The number of stack instances that have drifted from the expected template and parameter
|
|
4156
4484
|
* configuration of the stack set. A stack instance is considered to have drifted if one or
|
|
4157
|
-
* more of the resources in the associated stack
|
|
4485
|
+
* more of the resources in the associated stack don't match their expected
|
|
4158
4486
|
* configuration.</p>
|
|
4159
4487
|
*/
|
|
4160
4488
|
DriftedStackInstancesCount?: number;
|
|
@@ -4182,8 +4510,8 @@ export declare type StackSetStatus = "ACTIVE" | "DELETED";
|
|
|
4182
4510
|
/**
|
|
4183
4511
|
* <p>A structure that contains information about a stack set. A stack set enables you to
|
|
4184
4512
|
* provision stacks into Amazon Web Services accounts and across Regions by using a single
|
|
4185
|
-
* CloudFormation template. In the stack set, you specify the template to use,
|
|
4186
|
-
*
|
|
4513
|
+
* CloudFormation template. In the stack set, you specify the template to use, in
|
|
4514
|
+
* addition to any parameters and capabilities that the template requires.</p>
|
|
4187
4515
|
*/
|
|
4188
4516
|
export interface StackSet {
|
|
4189
4517
|
/**
|
|
@@ -4215,8 +4543,9 @@ export interface StackSet {
|
|
|
4215
4543
|
/**
|
|
4216
4544
|
* <p>The capabilities that are allowed in the stack set. Some stack set templates might
|
|
4217
4545
|
* include resources that can affect permissions in your Amazon Web Services account—for
|
|
4218
|
-
* example, by creating new Identity and Access Management (IAM) users. For more
|
|
4219
|
-
*
|
|
4546
|
+
* example, by creating new Identity and Access Management (IAM) users. For more
|
|
4547
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation
|
|
4548
|
+
* Templates.</a>
|
|
4220
4549
|
* </p>
|
|
4221
4550
|
*/
|
|
4222
4551
|
Capabilities?: (Capability | string)[];
|
|
@@ -4230,24 +4559,25 @@ export interface StackSet {
|
|
|
4230
4559
|
*/
|
|
4231
4560
|
StackSetARN?: string;
|
|
4232
4561
|
/**
|
|
4233
|
-
* <p>The Amazon Resource Number (ARN) of the IAM role used to create or update
|
|
4234
|
-
* set.</p>
|
|
4562
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role used to create or update
|
|
4563
|
+
* the stack set.</p>
|
|
4235
4564
|
* <p>Use customized administrator roles to control which users or groups can manage specific
|
|
4236
4565
|
* stack sets within the same administrator account. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites: Granting Permissions for Stack
|
|
4237
4566
|
* Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4238
4567
|
*/
|
|
4239
4568
|
AdministrationRoleARN?: string;
|
|
4240
4569
|
/**
|
|
4241
|
-
* <p>The name of the IAM execution role used to create or update the stack
|
|
4570
|
+
* <p>The name of the IAM execution role used to create or update the stack
|
|
4571
|
+
* set.</p>
|
|
4242
4572
|
* <p>Use customized execution roles to control which stack resources users and groups can
|
|
4243
|
-
* include in their stack sets
|
|
4573
|
+
* include in their stack sets.</p>
|
|
4244
4574
|
*/
|
|
4245
4575
|
ExecutionRoleName?: string;
|
|
4246
4576
|
/**
|
|
4247
4577
|
* <p>Detailed information about the drift status of the stack set.</p>
|
|
4248
4578
|
* <p>For stack sets, contains information about the last <i>completed</i> drift
|
|
4249
4579
|
* operation performed on the stack set. Information about drift operations currently in
|
|
4250
|
-
* progress
|
|
4580
|
+
* progress isn't included.</p>
|
|
4251
4581
|
*/
|
|
4252
4582
|
StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
|
|
4253
4583
|
/**
|
|
@@ -4257,7 +4587,8 @@ export interface StackSet {
|
|
|
4257
4587
|
*/
|
|
4258
4588
|
AutoDeployment?: AutoDeployment;
|
|
4259
4589
|
/**
|
|
4260
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
4590
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
4591
|
+
* created.</p>
|
|
4261
4592
|
* <ul>
|
|
4262
4593
|
* <li>
|
|
4263
4594
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -4267,8 +4598,7 @@ export interface StackSet {
|
|
|
4267
4598
|
* </li>
|
|
4268
4599
|
* <li>
|
|
4269
4600
|
* <p>With <code>service-managed</code> permissions, StackSets automatically creates the
|
|
4270
|
-
*
|
|
4271
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
4601
|
+
* IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
4272
4602
|
* </li>
|
|
4273
4603
|
* </ul>
|
|
4274
4604
|
*/
|
|
@@ -4308,18 +4638,19 @@ export interface DescribeStackSetOperationInput {
|
|
|
4308
4638
|
*/
|
|
4309
4639
|
StackSetName: string | undefined;
|
|
4310
4640
|
/**
|
|
4311
|
-
* <p>The unique ID of the stack set operation
|
|
4641
|
+
* <p>The unique ID of the stack set operation.</p>
|
|
4312
4642
|
*/
|
|
4313
4643
|
OperationId: string | undefined;
|
|
4314
4644
|
/**
|
|
4315
4645
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
4316
|
-
* administrator in the organization's management account or as a delegated
|
|
4317
|
-
* member account.</p>
|
|
4646
|
+
* administrator in the organization's management account or as a delegated
|
|
4647
|
+
* administrator in a member account.</p>
|
|
4318
4648
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
4319
4649
|
* self-managed permissions.</p>
|
|
4320
4650
|
* <ul>
|
|
4321
4651
|
* <li>
|
|
4322
|
-
* <p>If you are signed in to the management account, specify
|
|
4652
|
+
* <p>If you are signed in to the management account, specify
|
|
4653
|
+
* <code>SELF</code>.</p>
|
|
4323
4654
|
* </li>
|
|
4324
4655
|
* <li>
|
|
4325
4656
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -4340,7 +4671,7 @@ export declare namespace DescribeStackSetOperationInput {
|
|
|
4340
4671
|
export declare type StackSetOperationAction = "CREATE" | "DELETE" | "DETECT_DRIFT" | "UPDATE";
|
|
4341
4672
|
export declare type StackSetOperationStatus = "FAILED" | "QUEUED" | "RUNNING" | "STOPPED" | "STOPPING" | "SUCCEEDED";
|
|
4342
4673
|
/**
|
|
4343
|
-
* <p>The structure that contains information about a stack set operation
|
|
4674
|
+
* <p>The structure that contains information about a stack set operation.</p>
|
|
4344
4675
|
*/
|
|
4345
4676
|
export interface StackSetOperation {
|
|
4346
4677
|
/**
|
|
@@ -4355,12 +4686,12 @@ export interface StackSetOperation {
|
|
|
4355
4686
|
* <p>The type of stack set operation: <code>CREATE</code>, <code>UPDATE</code>, or
|
|
4356
4687
|
* <code>DELETE</code>. Create and delete operations affect only the specified stack set
|
|
4357
4688
|
* instances that are associated with the specified stack set. Update operations affect both
|
|
4358
|
-
* the stack set itself,
|
|
4689
|
+
* the stack set itself, in addition to <i>all</i> associated stack set
|
|
4359
4690
|
* instances.</p>
|
|
4360
4691
|
*/
|
|
4361
4692
|
Action?: StackSetOperationAction | string;
|
|
4362
4693
|
/**
|
|
4363
|
-
* <p>The status of the operation
|
|
4694
|
+
* <p>The status of the operation.</p>
|
|
4364
4695
|
* <ul>
|
|
4365
4696
|
* <li>
|
|
4366
4697
|
* <p>
|
|
@@ -4376,8 +4707,7 @@ export interface StackSetOperation {
|
|
|
4376
4707
|
* <p>
|
|
4377
4708
|
* <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that
|
|
4378
4709
|
* require a sequence of operations, the operation is queued to be performed. For more
|
|
4379
|
-
* information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">stack set operation status codes</a> in the CloudFormation User
|
|
4380
|
-
* Guide.</p>
|
|
4710
|
+
* information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">stack set operation status codes</a> in the CloudFormation User Guide.</p>
|
|
4381
4711
|
* </li>
|
|
4382
4712
|
* <li>
|
|
4383
4713
|
* <p>
|
|
@@ -4385,12 +4715,12 @@ export interface StackSetOperation {
|
|
|
4385
4715
|
* </li>
|
|
4386
4716
|
* <li>
|
|
4387
4717
|
* <p>
|
|
4388
|
-
* <code>STOPPED</code>: The user has
|
|
4718
|
+
* <code>STOPPED</code>: The user has canceled the operation.</p>
|
|
4389
4719
|
* </li>
|
|
4390
4720
|
* <li>
|
|
4391
4721
|
* <p>
|
|
4392
4722
|
* <code>STOPPING</code>: The operation is in the process of stopping, at user
|
|
4393
|
-
* request
|
|
4723
|
+
* request.</p>
|
|
4394
4724
|
* </li>
|
|
4395
4725
|
* <li>
|
|
4396
4726
|
* <p>
|
|
@@ -4407,21 +4737,22 @@ export interface StackSetOperation {
|
|
|
4407
4737
|
/**
|
|
4408
4738
|
* <p>For stack set operations of action type <code>DELETE</code>, specifies whether to remove
|
|
4409
4739
|
* the stack instances from the specified stack set, but doesn't delete the stacks. You can't
|
|
4410
|
-
*
|
|
4740
|
+
* re-associate a retained stack, or add an existing, saved stack to a new stack set.</p>
|
|
4411
4741
|
*/
|
|
4412
4742
|
RetainStacks?: boolean;
|
|
4413
4743
|
/**
|
|
4414
|
-
* <p>The Amazon Resource Number (ARN) of the IAM role used to perform this
|
|
4415
|
-
* operation
|
|
4744
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role used to perform this
|
|
4745
|
+
* stack set operation.</p>
|
|
4416
4746
|
* <p>Use customized administrator roles to control which users or groups can manage specific
|
|
4417
4747
|
* stack sets within the same administrator account. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Define Permissions for Multiple
|
|
4418
4748
|
* Administrators</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4419
4749
|
*/
|
|
4420
4750
|
AdministrationRoleARN?: string;
|
|
4421
4751
|
/**
|
|
4422
|
-
* <p>The name of the IAM execution role used to create or update the stack
|
|
4752
|
+
* <p>The name of the IAM execution role used to create or update the stack
|
|
4753
|
+
* set.</p>
|
|
4423
4754
|
* <p>Use customized execution roles to control which stack resources users and groups can
|
|
4424
|
-
* include in their stack sets
|
|
4755
|
+
* include in their stack sets.</p>
|
|
4425
4756
|
*/
|
|
4426
4757
|
ExecutionRoleName?: string;
|
|
4427
4758
|
/**
|
|
@@ -4446,7 +4777,7 @@ export interface StackSetOperation {
|
|
|
4446
4777
|
/**
|
|
4447
4778
|
* <p>Detailed information about the drift status of the stack set. This includes information
|
|
4448
4779
|
* about drift operations currently being performed on the stack set.</p>
|
|
4449
|
-
* <p>
|
|
4780
|
+
* <p>This information will only be present for stack set operations whose <code>Action</code>
|
|
4450
4781
|
* type is <code>DETECT_DRIFT</code>.</p>
|
|
4451
4782
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting Unmanaged
|
|
4452
4783
|
* Changes in Stack Sets</a> in the CloudFormation User Guide.</p>
|
|
@@ -4474,14 +4805,18 @@ export declare namespace DescribeStackSetOperationOutput {
|
|
|
4474
4805
|
/**
|
|
4475
4806
|
* <p>The specified ID refers to an operation that doesn't exist.</p>
|
|
4476
4807
|
*/
|
|
4477
|
-
export
|
|
4478
|
-
name: "OperationNotFoundException";
|
|
4479
|
-
$fault: "client";
|
|
4808
|
+
export declare class OperationNotFoundException extends __BaseException {
|
|
4809
|
+
readonly name: "OperationNotFoundException";
|
|
4810
|
+
readonly $fault: "client";
|
|
4480
4811
|
Message?: string;
|
|
4812
|
+
/**
|
|
4813
|
+
* @internal
|
|
4814
|
+
*/
|
|
4815
|
+
constructor(opts: __ExceptionOptionType<OperationNotFoundException, __BaseException>);
|
|
4481
4816
|
}
|
|
4482
4817
|
export interface DescribeTypeInput {
|
|
4483
4818
|
/**
|
|
4484
|
-
* <p>The kind of extension
|
|
4819
|
+
* <p>The kind of extension.</p>
|
|
4485
4820
|
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
4486
4821
|
* <code>Arn</code>.</p>
|
|
4487
4822
|
*/
|
|
@@ -4535,17 +4870,17 @@ export declare type ProvisioningType = "FULLY_MUTABLE" | "IMMUTABLE" | "NON_PROV
|
|
|
4535
4870
|
export interface RequiredActivatedType {
|
|
4536
4871
|
/**
|
|
4537
4872
|
* <p>An alias assigned to the public extension, in this account and region. If you specify an
|
|
4538
|
-
* alias for the extension, CloudFormation treats the alias as the extension type
|
|
4539
|
-
* this account and region. You must use the alias to refer to the extension in
|
|
4540
|
-
* templates, API calls, and CloudFormation console.</p>
|
|
4873
|
+
* alias for the extension, CloudFormation treats the alias as the extension type
|
|
4874
|
+
* name within this account and region. You must use the alias to refer to the extension in
|
|
4875
|
+
* your templates, API calls, and CloudFormation console.</p>
|
|
4541
4876
|
*/
|
|
4542
4877
|
TypeNameAlias?: string;
|
|
4543
4878
|
/**
|
|
4544
4879
|
* <p>The type name of the public extension.</p>
|
|
4545
4880
|
* <p>If you specified a <code>TypeNameAlias</code> when enabling the extension in this
|
|
4546
|
-
* account and region, CloudFormation treats that alias as the extension's type name
|
|
4547
|
-
* the account and region, not the type name of the public extension. For more
|
|
4548
|
-
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to refer to extensions</a> in the
|
|
4881
|
+
* account and region, CloudFormation treats that alias as the extension's type name
|
|
4882
|
+
* within the account and region, not the type name of the public extension. For more
|
|
4883
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to refer to extensions</a> in the
|
|
4549
4884
|
* <i>CloudFormation User Guide</i>.</p>
|
|
4550
4885
|
*/
|
|
4551
4886
|
OriginalTypeName?: string;
|
|
@@ -4577,24 +4912,23 @@ export interface DescribeTypeOutput {
|
|
|
4577
4912
|
*/
|
|
4578
4913
|
Arn?: string;
|
|
4579
4914
|
/**
|
|
4580
|
-
* <p>The kind of extension
|
|
4915
|
+
* <p>The kind of extension.</p>
|
|
4581
4916
|
*/
|
|
4582
4917
|
Type?: RegistryType | string;
|
|
4583
4918
|
/**
|
|
4584
4919
|
* <p>The name of the extension.</p>
|
|
4585
4920
|
* <p>If the extension is a public third-party type you have activated with a type name alias,
|
|
4586
|
-
*
|
|
4921
|
+
* CloudFormation returns the type name alias. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a>.</p>
|
|
4587
4922
|
*/
|
|
4588
4923
|
TypeName?: string;
|
|
4589
4924
|
/**
|
|
4590
4925
|
* <p>The ID of the default version of the extension. The default version is used when the
|
|
4591
|
-
* extension version
|
|
4926
|
+
* extension version isn't specified.</p>
|
|
4592
4927
|
* <p>This applies only to private extensions you have registered in your account. For public
|
|
4593
|
-
* extensions, both those provided by Amazon and published by third parties, CloudFormation
|
|
4594
|
-
* returns <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4928
|
+
* extensions, both those provided by Amazon and published by third parties, CloudFormation returns <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4595
4929
|
* <p>To set the default version of an extension, use <code>
|
|
4596
4930
|
* <a>SetTypeDefaultVersion</a>
|
|
4597
|
-
* </code
|
|
4931
|
+
* </code>.</p>
|
|
4598
4932
|
*/
|
|
4599
4933
|
DefaultVersionId?: string;
|
|
4600
4934
|
/**
|
|
@@ -4606,10 +4940,11 @@ export interface DescribeTypeOutput {
|
|
|
4606
4940
|
IsDefaultVersion?: boolean;
|
|
4607
4941
|
/**
|
|
4608
4942
|
* <p>The contract test status of the registered extension version. To return the extension
|
|
4609
|
-
* test status of a
|
|
4610
|
-
* <p>
|
|
4611
|
-
*
|
|
4612
|
-
*
|
|
4943
|
+
* test status of a specific extension version, you must specify
|
|
4944
|
+
* <code>VersionId</code>.</p>
|
|
4945
|
+
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4946
|
+
* doesn't return this information for public extensions, whether or not they are activated in
|
|
4947
|
+
* your account.</p>
|
|
4613
4948
|
* <ul>
|
|
4614
4949
|
* <li>
|
|
4615
4950
|
* <p>
|
|
@@ -4630,18 +4965,18 @@ export interface DescribeTypeOutput {
|
|
|
4630
4965
|
* </li>
|
|
4631
4966
|
* <li>
|
|
4632
4967
|
* <p>
|
|
4633
|
-
* <code>NOT_TESTED</code>: Contract tests
|
|
4968
|
+
* <code>NOT_TESTED</code>: Contract tests haven't been performed on the
|
|
4634
4969
|
* extension.</p>
|
|
4635
4970
|
* </li>
|
|
4636
4971
|
* </ul>
|
|
4637
4972
|
*/
|
|
4638
4973
|
TypeTestsStatus?: TypeTestsStatus | string;
|
|
4639
4974
|
/**
|
|
4640
|
-
* <p>The description of the test status. To return the extension test status of a
|
|
4641
|
-
* extension version, you must specify <code>VersionId</code
|
|
4642
|
-
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4643
|
-
* return this information for public extensions, whether or not they are activated in
|
|
4644
|
-
* account.</p>
|
|
4975
|
+
* <p>The description of the test status. To return the extension test status of a specific
|
|
4976
|
+
* extension version, you must specify <code>VersionId</code>.</p>
|
|
4977
|
+
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4978
|
+
* doesn't return this information for public extensions, whether or not they are activated in
|
|
4979
|
+
* your account.</p>
|
|
4645
4980
|
*/
|
|
4646
4981
|
TypeTestsStatusDescription?: string;
|
|
4647
4982
|
/**
|
|
@@ -4668,14 +5003,14 @@ export interface DescribeTypeOutput {
|
|
|
4668
5003
|
* </li>
|
|
4669
5004
|
* <li>
|
|
4670
5005
|
* <p>
|
|
4671
|
-
* <code>IMMUTABLE</code>: The resource type
|
|
4672
|
-
* the type
|
|
5006
|
+
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so
|
|
5007
|
+
* the type can't be updated and must instead be replaced during stack update
|
|
4673
5008
|
* operations.</p>
|
|
4674
5009
|
* </li>
|
|
4675
5010
|
* <li>
|
|
4676
5011
|
* <p>
|
|
4677
|
-
* <code>NON_PROVISIONABLE</code>: The resource type
|
|
4678
|
-
* following handlers, and therefore
|
|
5012
|
+
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include all the
|
|
5013
|
+
* following handlers, and therefore can't actually be provisioned.</p>
|
|
4679
5014
|
* <ul>
|
|
4680
5015
|
* <li>
|
|
4681
5016
|
* <p>create</p>
|
|
@@ -4704,17 +5039,18 @@ export interface DescribeTypeOutput {
|
|
|
4704
5039
|
* <li>
|
|
4705
5040
|
* <p>
|
|
4706
5041
|
* <code>DEPRECATED</code>: The extension has been deactivated or deregistered and
|
|
4707
|
-
* can no longer be used in CloudFormation operations
|
|
5042
|
+
* can no longer be used in CloudFormation operations.</p>
|
|
4708
5043
|
* </li>
|
|
4709
5044
|
* </ul>
|
|
4710
|
-
* <p>For public third-party extensions, CloudFormation returns
|
|
5045
|
+
* <p>For public third-party extensions, CloudFormation returns
|
|
5046
|
+
* <code>null</code>.</p>
|
|
4711
5047
|
*/
|
|
4712
5048
|
DeprecatedStatus?: DeprecatedStatus | string;
|
|
4713
5049
|
/**
|
|
4714
5050
|
* <p>Contains logging configuration information for private extensions. This applies only to
|
|
4715
5051
|
* private extensions you have registered in your account. For public extensions, both those
|
|
4716
5052
|
* provided by Amazon and published by third parties, CloudFormation returns
|
|
4717
|
-
*
|
|
5053
|
+
* <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4718
5054
|
*/
|
|
4719
5055
|
LoggingConfig?: LoggingConfig;
|
|
4720
5056
|
/**
|
|
@@ -4723,17 +5059,17 @@ export interface DescribeTypeOutput {
|
|
|
4723
5059
|
*/
|
|
4724
5060
|
RequiredActivatedTypes?: RequiredActivatedType[];
|
|
4725
5061
|
/**
|
|
4726
|
-
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to register
|
|
4727
|
-
* This applies only to private extensions you have registered in your account.
|
|
4728
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
5062
|
+
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to register
|
|
5063
|
+
* the extension. This applies only to private extensions you have registered in your account.
|
|
5064
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4729
5065
|
* <p></p>
|
|
4730
5066
|
* <p>If the registered extension calls any Amazon Web Services APIs, you must create an
|
|
4731
5067
|
* <i>
|
|
4732
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
|
4733
|
-
*
|
|
4734
|
-
*
|
|
4735
|
-
*
|
|
4736
|
-
* appropriate credentials.</p>
|
|
5068
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a>
|
|
5069
|
+
* </i> that includes the necessary
|
|
5070
|
+
* permissions to call those Amazon Web Services APIs, and provision that execution role in
|
|
5071
|
+
* your account. CloudFormation then assumes that execution role to provide your
|
|
5072
|
+
* extension with the appropriate credentials.</p>
|
|
4737
5073
|
*/
|
|
4738
5074
|
ExecutionRoleArn?: string;
|
|
4739
5075
|
/**
|
|
@@ -4749,7 +5085,7 @@ export interface DescribeTypeOutput {
|
|
|
4749
5085
|
* </li>
|
|
4750
5086
|
* <li>
|
|
4751
5087
|
* <p>
|
|
4752
|
-
* <code>PUBLIC</code>: The extension is
|
|
5088
|
+
* <code>PUBLIC</code>: The extension is publicly visible and usable within any
|
|
4753
5089
|
* Amazon account.</p>
|
|
4754
5090
|
* </li>
|
|
4755
5091
|
* </ul>
|
|
@@ -4779,29 +5115,29 @@ export interface DescribeTypeOutput {
|
|
|
4779
5115
|
LastUpdated?: Date;
|
|
4780
5116
|
/**
|
|
4781
5117
|
* <p>When the specified private extension version was registered or activated in your
|
|
4782
|
-
* account
|
|
5118
|
+
* account.</p>
|
|
4783
5119
|
*/
|
|
4784
5120
|
TimeCreated?: Date;
|
|
4785
5121
|
/**
|
|
4786
5122
|
* <p>A JSON string that represent the current configuration data for the extension in this
|
|
4787
5123
|
* account and region.</p>
|
|
4788
|
-
* <p>To set the configuration data for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation
|
|
4789
|
-
* User Guide</i>.</p>
|
|
5124
|
+
* <p>To set the configuration data for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4790
5125
|
*/
|
|
4791
5126
|
ConfigurationSchema?: string;
|
|
4792
5127
|
/**
|
|
4793
5128
|
* <p>The publisher ID of the extension publisher.</p>
|
|
4794
5129
|
* <p>This applies only to public third-party extensions. For private registered extensions,
|
|
4795
|
-
* and extensions provided by Amazon, CloudFormation returns
|
|
5130
|
+
* and extensions provided by Amazon Web Services, CloudFormation returns
|
|
5131
|
+
* <code>null</code>.</p>
|
|
4796
5132
|
*/
|
|
4797
5133
|
PublisherId?: string;
|
|
4798
5134
|
/**
|
|
4799
5135
|
* <p>For public extensions that have been activated for this account and region, the type
|
|
4800
5136
|
* name of the public extension.</p>
|
|
4801
5137
|
* <p>If you specified a <code>TypeNameAlias</code> when enabling the extension in this
|
|
4802
|
-
* account and region, CloudFormation treats that alias as the extension's type name
|
|
4803
|
-
* the account and region, not the type name of the public extension. For more
|
|
4804
|
-
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to refer to extensions</a> in the
|
|
5138
|
+
* account and region, CloudFormation treats that alias as the extension's type name
|
|
5139
|
+
* within the account and region, not the type name of the public extension. For more
|
|
5140
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to refer to extensions</a> in the
|
|
4805
5141
|
* <i>CloudFormation User Guide</i>.</p>
|
|
4806
5142
|
*/
|
|
4807
5143
|
OriginalTypeName?: string;
|
|
@@ -4814,27 +5150,26 @@ export interface DescribeTypeOutput {
|
|
|
4814
5150
|
* <p>The version number of a public third-party extension.</p>
|
|
4815
5151
|
* <p>This applies only if you specify a public extension you have activated in your account,
|
|
4816
5152
|
* or specify a public extension without specifying a version. For all other extensions,
|
|
4817
|
-
*
|
|
5153
|
+
* CloudFormation returns <code>null</code>.</p>
|
|
4818
5154
|
*/
|
|
4819
5155
|
PublicVersionNumber?: string;
|
|
4820
5156
|
/**
|
|
4821
5157
|
* <p>The latest version of a public extension <i>that is available</i> for
|
|
4822
5158
|
* use.</p>
|
|
4823
|
-
* <p>This only applies if you specify a public extension, and you
|
|
5159
|
+
* <p>This only applies if you specify a public extension, and you don't specify a version.
|
|
4824
5160
|
* For all other requests, CloudFormation returns <code>null</code>.</p>
|
|
4825
5161
|
*/
|
|
4826
5162
|
LatestPublicVersion?: string;
|
|
4827
5163
|
/**
|
|
4828
5164
|
* <p>Whether or not the extension is activated in the account and region.</p>
|
|
4829
|
-
* <p>This only applies to public third-party extensions. For all other extensions,
|
|
4830
|
-
* CloudFormation returns <code>null</code>.</p>
|
|
5165
|
+
* <p>This only applies to public third-party extensions. For all other extensions, CloudFormation returns <code>null</code>.</p>
|
|
4831
5166
|
*/
|
|
4832
5167
|
IsActivated?: boolean;
|
|
4833
5168
|
/**
|
|
4834
|
-
* <p>Whether CloudFormation automatically updates the extension in this account and
|
|
4835
|
-
* when a new <i>minor</i> version is published by the extension
|
|
4836
|
-
* Major versions released by the publisher must be manually updated. For more
|
|
4837
|
-
* see <a href="AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable">Activating public extensions for use in your account</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5169
|
+
* <p>Whether CloudFormation automatically updates the extension in this account and
|
|
5170
|
+
* region when a new <i>minor</i> version is published by the extension
|
|
5171
|
+
* publisher. Major versions released by the publisher must be manually updated. For more
|
|
5172
|
+
* information, see <a href="AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable">Activating public extensions for use in your account</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4838
5173
|
*/
|
|
4839
5174
|
AutoUpdate?: boolean;
|
|
4840
5175
|
}
|
|
@@ -4958,7 +5293,7 @@ export interface DetectStackSetDriftInput {
|
|
|
4958
5293
|
StackSetName: string | undefined;
|
|
4959
5294
|
/**
|
|
4960
5295
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
4961
|
-
* operation
|
|
5296
|
+
* operation.</p>
|
|
4962
5297
|
* <p>For more information on maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
|
|
4963
5298
|
*/
|
|
4964
5299
|
OperationPreferences?: StackSetOperationPreferences;
|
|
@@ -4970,13 +5305,14 @@ export interface DetectStackSetDriftInput {
|
|
|
4970
5305
|
OperationId?: string;
|
|
4971
5306
|
/**
|
|
4972
5307
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
4973
|
-
* administrator in the organization's management account or as a delegated
|
|
4974
|
-
* member account.</p>
|
|
5308
|
+
* administrator in the organization's management account or as a delegated
|
|
5309
|
+
* administrator in a member account.</p>
|
|
4975
5310
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
4976
5311
|
* self-managed permissions.</p>
|
|
4977
5312
|
* <ul>
|
|
4978
5313
|
* <li>
|
|
4979
|
-
* <p>If you are signed in to the management account, specify
|
|
5314
|
+
* <p>If you are signed in to the management account, specify
|
|
5315
|
+
* <code>SELF</code>.</p>
|
|
4980
5316
|
* </li>
|
|
4981
5317
|
* <li>
|
|
4982
5318
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -4996,10 +5332,10 @@ export declare namespace DetectStackSetDriftInput {
|
|
|
4996
5332
|
}
|
|
4997
5333
|
export interface DetectStackSetDriftOutput {
|
|
4998
5334
|
/**
|
|
4999
|
-
* <p>The ID of the drift detection stack set operation
|
|
5000
|
-
* <p>
|
|
5335
|
+
* <p>The ID of the drift detection stack set operation.</p>
|
|
5336
|
+
* <p>You can use this operation ID with <code>
|
|
5001
5337
|
* <a>DescribeStackSetOperation</a>
|
|
5002
|
-
* </code> to monitor the progress of the drift detection operation
|
|
5338
|
+
* </code> to monitor the progress of the drift detection operation.</p>
|
|
5003
5339
|
*/
|
|
5004
5340
|
OperationId?: string;
|
|
5005
5341
|
}
|
|
@@ -5022,9 +5358,9 @@ export interface EstimateTemplateCostInput {
|
|
|
5022
5358
|
*/
|
|
5023
5359
|
TemplateBody?: string;
|
|
5024
5360
|
/**
|
|
5025
|
-
* <p>Location of file containing the template body. The URL must point to a template that
|
|
5026
|
-
* located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
5027
|
-
*
|
|
5361
|
+
* <p>Location of file containing the template body. The URL must point to a template that's
|
|
5362
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
5363
|
+
* go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
5028
5364
|
* in the CloudFormation User Guide.</p>
|
|
5029
5365
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
5030
5366
|
* both are passed, only <code>TemplateBody</code> is used.</p>
|
|
@@ -5062,21 +5398,21 @@ export declare namespace EstimateTemplateCostOutput {
|
|
|
5062
5398
|
*/
|
|
5063
5399
|
export interface ExecuteChangeSetInput {
|
|
5064
5400
|
/**
|
|
5065
|
-
* <p>The name or ARN of the change set that you want use to update the
|
|
5066
|
-
* stack.</p>
|
|
5401
|
+
* <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the
|
|
5402
|
+
* specified stack.</p>
|
|
5067
5403
|
*/
|
|
5068
5404
|
ChangeSetName: string | undefined;
|
|
5069
5405
|
/**
|
|
5070
|
-
* <p>If you specified the name of a change set, specify the stack name or
|
|
5071
|
-
* associated with the change set you want to execute.</p>
|
|
5406
|
+
* <p>If you specified the name of a change set, specify the stack name or Amazon Resource
|
|
5407
|
+
* Name (ARN) that's associated with the change set you want to execute.</p>
|
|
5072
5408
|
*/
|
|
5073
5409
|
StackName?: string;
|
|
5074
5410
|
/**
|
|
5075
5411
|
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token
|
|
5076
|
-
* if you plan to retry requests so that CloudFormation knows that you're not
|
|
5077
|
-
*
|
|
5078
|
-
* <code>ExecuteChangeSet</code> requests to ensure that CloudFormation
|
|
5079
|
-
*
|
|
5412
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
5413
|
+
* to execute a change set to update a stack with the same name. You might retry
|
|
5414
|
+
* <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully
|
|
5415
|
+
* received them.</p>
|
|
5080
5416
|
*/
|
|
5081
5417
|
ClientRequestToken?: string;
|
|
5082
5418
|
/**
|
|
@@ -5108,7 +5444,7 @@ export declare namespace ExecuteChangeSetOutput {
|
|
|
5108
5444
|
*/
|
|
5109
5445
|
export interface GetStackPolicyInput {
|
|
5110
5446
|
/**
|
|
5111
|
-
* <p>The name or unique stack ID that
|
|
5447
|
+
* <p>The name or unique stack ID that's associated with the stack whose policy you want to
|
|
5112
5448
|
* get.</p>
|
|
5113
5449
|
*/
|
|
5114
5450
|
StackName: string | undefined;
|
|
@@ -5144,7 +5480,7 @@ export declare enum TemplateStage {
|
|
|
5144
5480
|
*/
|
|
5145
5481
|
export interface GetTemplateInput {
|
|
5146
5482
|
/**
|
|
5147
|
-
* <p>The name or the unique stack ID that
|
|
5483
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
5148
5484
|
* interchangeable:</p>
|
|
5149
5485
|
* <ul>
|
|
5150
5486
|
* <li>
|
|
@@ -5211,7 +5547,7 @@ export declare namespace GetTemplateOutput {
|
|
|
5211
5547
|
export interface GetTemplateSummaryInput {
|
|
5212
5548
|
/**
|
|
5213
5549
|
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
5214
|
-
* length of 51,200 bytes. For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
5550
|
+
* length of 51,200 bytes. For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a> in the CloudFormation User Guide.</p>
|
|
5215
5551
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
5216
5552
|
* <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or
|
|
5217
5553
|
* <code>TemplateURL</code>.</p>
|
|
@@ -5219,8 +5555,8 @@ export interface GetTemplateSummaryInput {
|
|
|
5219
5555
|
TemplateBody?: string;
|
|
5220
5556
|
/**
|
|
5221
5557
|
* <p>Location of file containing the template body. The URL must point to a template (max
|
|
5222
|
-
* size: 460,800 bytes) that
|
|
5223
|
-
* For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
5558
|
+
* size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager
|
|
5559
|
+
* document. For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a>
|
|
5224
5560
|
* in the CloudFormation User Guide.</p>
|
|
5225
5561
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
5226
5562
|
* <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or
|
|
@@ -5228,7 +5564,7 @@ export interface GetTemplateSummaryInput {
|
|
|
5228
5564
|
*/
|
|
5229
5565
|
TemplateURL?: string;
|
|
5230
5566
|
/**
|
|
5231
|
-
* <p>The name or the stack ID that
|
|
5567
|
+
* <p>The name or the stack ID that's associated with the stack, which aren't always
|
|
5232
5568
|
* interchangeable. For running stacks, you can specify either the stack's name or its unique
|
|
5233
5569
|
* stack ID. For deleted stack, you must specify the unique stack ID.</p>
|
|
5234
5570
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
@@ -5245,13 +5581,14 @@ export interface GetTemplateSummaryInput {
|
|
|
5245
5581
|
StackSetName?: string;
|
|
5246
5582
|
/**
|
|
5247
5583
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
5248
|
-
* administrator in the organization's management account or as a delegated
|
|
5249
|
-
* member account.</p>
|
|
5584
|
+
* administrator in the organization's management account or as a delegated
|
|
5585
|
+
* administrator in a member account.</p>
|
|
5250
5586
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
5251
5587
|
* self-managed permissions.</p>
|
|
5252
5588
|
* <ul>
|
|
5253
5589
|
* <li>
|
|
5254
|
-
* <p>If you are signed in to the management account, specify
|
|
5590
|
+
* <p>If you are signed in to the management account, specify
|
|
5591
|
+
* <code>SELF</code>.</p>
|
|
5255
5592
|
* </li>
|
|
5256
5593
|
* <li>
|
|
5257
5594
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -5270,9 +5607,9 @@ export declare namespace GetTemplateSummaryInput {
|
|
|
5270
5607
|
const filterSensitiveLog: (obj: GetTemplateSummaryInput) => any;
|
|
5271
5608
|
}
|
|
5272
5609
|
/**
|
|
5273
|
-
* <p>A set of criteria that CloudFormation uses to validate parameter values.
|
|
5274
|
-
*
|
|
5275
|
-
*
|
|
5610
|
+
* <p>A set of criteria that CloudFormation uses to validate parameter values. Although
|
|
5611
|
+
* other constraints might be defined in the stack template, CloudFormation returns only
|
|
5612
|
+
* the <code>AllowedValues</code> property.</p>
|
|
5276
5613
|
*/
|
|
5277
5614
|
export interface ParameterConstraints {
|
|
5278
5615
|
/**
|
|
@@ -5291,7 +5628,7 @@ export declare namespace ParameterConstraints {
|
|
|
5291
5628
|
*/
|
|
5292
5629
|
export interface ParameterDeclaration {
|
|
5293
5630
|
/**
|
|
5294
|
-
* <p>The name that
|
|
5631
|
+
* <p>The name that's associated with the parameter.</p>
|
|
5295
5632
|
*/
|
|
5296
5633
|
ParameterKey?: string;
|
|
5297
5634
|
/**
|
|
@@ -5308,7 +5645,7 @@ export interface ParameterDeclaration {
|
|
|
5308
5645
|
*/
|
|
5309
5646
|
NoEcho?: boolean;
|
|
5310
5647
|
/**
|
|
5311
|
-
* <p>The description that
|
|
5648
|
+
* <p>The description that's associate with the parameter.</p>
|
|
5312
5649
|
*/
|
|
5313
5650
|
Description?: string;
|
|
5314
5651
|
/**
|
|
@@ -5361,7 +5698,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
5361
5698
|
*/
|
|
5362
5699
|
Parameters?: ParameterDeclaration[];
|
|
5363
5700
|
/**
|
|
5364
|
-
* <p>The value that
|
|
5701
|
+
* <p>The value that's defined in the <code>Description</code> property of the
|
|
5365
5702
|
* template.</p>
|
|
5366
5703
|
*/
|
|
5367
5704
|
Description?: string;
|
|
@@ -5391,7 +5728,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
5391
5728
|
*/
|
|
5392
5729
|
Version?: string;
|
|
5393
5730
|
/**
|
|
5394
|
-
* <p>The value that
|
|
5731
|
+
* <p>The value that's defined for the <code>Metadata</code> property of the template.</p>
|
|
5395
5732
|
*/
|
|
5396
5733
|
Metadata?: string;
|
|
5397
5734
|
/**
|
|
@@ -5430,13 +5767,13 @@ export interface ImportStacksToStackSetInput {
|
|
|
5430
5767
|
*/
|
|
5431
5768
|
StackIdsUrl?: string;
|
|
5432
5769
|
/**
|
|
5433
|
-
* <p>The list of OU ID
|
|
5770
|
+
* <p>The list of OU ID's to which the stacks being imported has to be mapped as deployment
|
|
5434
5771
|
* target.</p>
|
|
5435
5772
|
*/
|
|
5436
5773
|
OrganizationalUnitIds?: string[];
|
|
5437
5774
|
/**
|
|
5438
5775
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
5439
|
-
* operation
|
|
5776
|
+
* operation.</p>
|
|
5440
5777
|
* <p>For more information on maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
|
|
5441
5778
|
*/
|
|
5442
5779
|
OperationPreferences?: StackSetOperationPreferences;
|
|
@@ -5449,7 +5786,8 @@ export interface ImportStacksToStackSetInput {
|
|
|
5449
5786
|
* self-managed permissions.</p>
|
|
5450
5787
|
* <ul>
|
|
5451
5788
|
* <li>
|
|
5452
|
-
* <p>If you are signed in to the management account, specify
|
|
5789
|
+
* <p>If you are signed in to the management account, specify
|
|
5790
|
+
* <code>SELF</code>.</p>
|
|
5453
5791
|
* </li>
|
|
5454
5792
|
* <li>
|
|
5455
5793
|
* <p>For service managed stack sets, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
@@ -5477,13 +5815,17 @@ export declare namespace ImportStacksToStackSetOutput {
|
|
|
5477
5815
|
const filterSensitiveLog: (obj: ImportStacksToStackSetOutput) => any;
|
|
5478
5816
|
}
|
|
5479
5817
|
/**
|
|
5480
|
-
* <p>The specified stack ARN doesn
|
|
5818
|
+
* <p>The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in
|
|
5481
5819
|
* input.</p>
|
|
5482
5820
|
*/
|
|
5483
|
-
export
|
|
5484
|
-
name: "StackNotFoundException";
|
|
5485
|
-
$fault: "client";
|
|
5821
|
+
export declare class StackNotFoundException extends __BaseException {
|
|
5822
|
+
readonly name: "StackNotFoundException";
|
|
5823
|
+
readonly $fault: "client";
|
|
5486
5824
|
Message?: string;
|
|
5825
|
+
/**
|
|
5826
|
+
* @internal
|
|
5827
|
+
*/
|
|
5828
|
+
constructor(opts: __ExceptionOptionType<StackNotFoundException, __BaseException>);
|
|
5487
5829
|
}
|
|
5488
5830
|
/**
|
|
5489
5831
|
* <p>The input for the <a>ListChangeSets</a> action.</p>
|
|
@@ -5517,7 +5859,7 @@ export interface ListChangeSetsOutput {
|
|
|
5517
5859
|
Summaries?: ChangeSetSummary[];
|
|
5518
5860
|
/**
|
|
5519
5861
|
* <p>If the output exceeds 1 MB, a string that identifies the next page of change sets. If
|
|
5520
|
-
* there is no additional page, this value is null
|
|
5862
|
+
* there is no additional page, this value is <code>null</code>.</p>
|
|
5521
5863
|
*/
|
|
5522
5864
|
NextToken?: string;
|
|
5523
5865
|
}
|
|
@@ -5587,8 +5929,8 @@ export declare namespace ListExportsOutput {
|
|
|
5587
5929
|
}
|
|
5588
5930
|
export interface ListImportsInput {
|
|
5589
5931
|
/**
|
|
5590
|
-
* <p>The name of the exported output value. CloudFormation returns the stack names
|
|
5591
|
-
*
|
|
5932
|
+
* <p>The name of the exported output value. CloudFormation returns the stack names that
|
|
5933
|
+
* are importing this value.</p>
|
|
5592
5934
|
*/
|
|
5593
5935
|
ExportName: string | undefined;
|
|
5594
5936
|
/**
|
|
@@ -5670,18 +6012,19 @@ export interface ListStackInstancesInput {
|
|
|
5670
6012
|
*/
|
|
5671
6013
|
StackInstanceAccount?: string;
|
|
5672
6014
|
/**
|
|
5673
|
-
* <p>The name of the Region where you want to list stack instances
|
|
6015
|
+
* <p>The name of the Region where you want to list stack instances.</p>
|
|
5674
6016
|
*/
|
|
5675
6017
|
StackInstanceRegion?: string;
|
|
5676
6018
|
/**
|
|
5677
6019
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
5678
|
-
* administrator in the organization's management account or as a delegated
|
|
5679
|
-
* member account.</p>
|
|
6020
|
+
* administrator in the organization's management account or as a delegated
|
|
6021
|
+
* administrator in a member account.</p>
|
|
5680
6022
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
5681
6023
|
* self-managed permissions.</p>
|
|
5682
6024
|
* <ul>
|
|
5683
6025
|
* <li>
|
|
5684
|
-
* <p>If you are signed in to the management account, specify
|
|
6026
|
+
* <p>If you are signed in to the management account, specify
|
|
6027
|
+
* <code>SELF</code>.</p>
|
|
5685
6028
|
* </li>
|
|
5686
6029
|
* <li>
|
|
5687
6030
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -5742,12 +6085,12 @@ export interface StackInstanceSummary {
|
|
|
5742
6085
|
* <ul>
|
|
5743
6086
|
* <li>
|
|
5744
6087
|
* <p>The associated stack failed during a <code>CreateStackSet</code> or
|
|
5745
|
-
* <code>UpdateStackSet</code> operation
|
|
6088
|
+
* <code>UpdateStackSet</code> operation.</p>
|
|
5746
6089
|
* </li>
|
|
5747
6090
|
* <li>
|
|
5748
6091
|
* <p>The stack was part of a <code>CreateStackSet</code> or
|
|
5749
6092
|
* <code>UpdateStackSet</code> operation that failed or was stopped before the
|
|
5750
|
-
* stack was created or updated
|
|
6093
|
+
* stack was created or updated.</p>
|
|
5751
6094
|
* </li>
|
|
5752
6095
|
* </ul>
|
|
5753
6096
|
* </li>
|
|
@@ -5773,7 +6116,7 @@ export interface StackInstanceSummary {
|
|
|
5773
6116
|
OrganizationalUnitId?: string;
|
|
5774
6117
|
/**
|
|
5775
6118
|
* <p>Status of the stack instance's actual configuration compared to the expected template
|
|
5776
|
-
* and parameter configuration of the stack set to which it belongs
|
|
6119
|
+
* and parameter configuration of the stack set to which it belongs.</p>
|
|
5777
6120
|
* <ul>
|
|
5778
6121
|
* <li>
|
|
5779
6122
|
* <p>
|
|
@@ -5784,7 +6127,7 @@ export interface StackInstanceSummary {
|
|
|
5784
6127
|
* </li>
|
|
5785
6128
|
* <li>
|
|
5786
6129
|
* <p>
|
|
5787
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6130
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack instance differs from
|
|
5788
6131
|
* its expected stack set configuration.</p>
|
|
5789
6132
|
* </li>
|
|
5790
6133
|
* <li>
|
|
@@ -5802,7 +6145,7 @@ export interface StackInstanceSummary {
|
|
|
5802
6145
|
/**
|
|
5803
6146
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
5804
6147
|
* the stack instance. This value will be <code>NULL</code> for any stack instance on which
|
|
5805
|
-
* drift detection
|
|
6148
|
+
* drift detection hasn't yet been performed.</p>
|
|
5806
6149
|
*/
|
|
5807
6150
|
LastDriftCheckTimestamp?: Date;
|
|
5808
6151
|
}
|
|
@@ -5819,10 +6162,10 @@ export interface ListStackInstancesOutput {
|
|
|
5819
6162
|
*/
|
|
5820
6163
|
Summaries?: StackInstanceSummary[];
|
|
5821
6164
|
/**
|
|
5822
|
-
* <p>If the request doesn't return all
|
|
5823
|
-
*
|
|
5824
|
-
*
|
|
5825
|
-
*
|
|
6165
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set
|
|
6166
|
+
* to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again
|
|
6167
|
+
* and assign that token to the request object's <code>NextToken</code> parameter. If the
|
|
6168
|
+
* request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
5826
6169
|
*/
|
|
5827
6170
|
NextToken?: string;
|
|
5828
6171
|
}
|
|
@@ -5837,7 +6180,7 @@ export declare namespace ListStackInstancesOutput {
|
|
|
5837
6180
|
*/
|
|
5838
6181
|
export interface ListStackResourcesInput {
|
|
5839
6182
|
/**
|
|
5840
|
-
* <p>The name or the unique stack ID that is associated with the stack, which
|
|
6183
|
+
* <p>The name or the unique stack ID that is associated with the stack, which aren't always
|
|
5841
6184
|
* interchangeable:</p>
|
|
5842
6185
|
* <ul>
|
|
5843
6186
|
* <li>
|
|
@@ -5870,7 +6213,7 @@ export declare namespace ListStackResourcesInput {
|
|
|
5870
6213
|
export interface StackResourceDriftInformationSummary {
|
|
5871
6214
|
/**
|
|
5872
6215
|
* <p>Status of the resource's actual configuration compared to its expected
|
|
5873
|
-
* configuration
|
|
6216
|
+
* configuration.</p>
|
|
5874
6217
|
* <ul>
|
|
5875
6218
|
* <li>
|
|
5876
6219
|
* <p>
|
|
@@ -5884,16 +6227,16 @@ export interface StackResourceDriftInformationSummary {
|
|
|
5884
6227
|
* </li>
|
|
5885
6228
|
* <li>
|
|
5886
6229
|
* <p>
|
|
5887
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6230
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the resource differs from its
|
|
5888
6231
|
* expected configuration.</p>
|
|
5889
|
-
* <p>Any resources that
|
|
6232
|
+
* <p>Any resources that don't currently support drift detection have a status of
|
|
5890
6233
|
* <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
|
|
5891
6234
|
* <code>ResourcesToSkip</code> will also have a status of <code>NOT_CHECKED</code>.
|
|
5892
6235
|
* For more information on skipping resources during rollback operations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html">Continue Rolling Back an Update</a> in the CloudFormation User Guide.</p>
|
|
5893
6236
|
* </li>
|
|
5894
6237
|
* <li>
|
|
5895
6238
|
* <p>
|
|
5896
|
-
* <code>IN_SYNC</code>: The
|
|
6239
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
5897
6240
|
* configuration.</p>
|
|
5898
6241
|
* </li>
|
|
5899
6242
|
* </ul>
|
|
@@ -5925,8 +6268,7 @@ export interface StackResourceSummary {
|
|
|
5925
6268
|
*/
|
|
5926
6269
|
PhysicalResourceId?: string;
|
|
5927
6270
|
/**
|
|
5928
|
-
* <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
|
|
5929
|
-
* Guide.)</p>
|
|
6271
|
+
* <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 Guide.)</p>
|
|
5930
6272
|
*/
|
|
5931
6273
|
ResourceType: string | undefined;
|
|
5932
6274
|
/**
|
|
@@ -6010,7 +6352,7 @@ export declare namespace ListStacksInput {
|
|
|
6010
6352
|
export interface StackDriftInformationSummary {
|
|
6011
6353
|
/**
|
|
6012
6354
|
* <p>Status of the stack's actual configuration compared to its expected template
|
|
6013
|
-
* configuration
|
|
6355
|
+
* configuration.</p>
|
|
6014
6356
|
* <ul>
|
|
6015
6357
|
* <li>
|
|
6016
6358
|
* <p>
|
|
@@ -6020,7 +6362,7 @@ export interface StackDriftInformationSummary {
|
|
|
6020
6362
|
* </li>
|
|
6021
6363
|
* <li>
|
|
6022
6364
|
* <p>
|
|
6023
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6365
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its
|
|
6024
6366
|
* expected template configuration.</p>
|
|
6025
6367
|
* </li>
|
|
6026
6368
|
* <li>
|
|
@@ -6160,13 +6502,14 @@ export interface ListStackSetOperationResultsInput {
|
|
|
6160
6502
|
MaxResults?: number;
|
|
6161
6503
|
/**
|
|
6162
6504
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
6163
|
-
* administrator in the organization's management account or as a delegated
|
|
6164
|
-
* member account.</p>
|
|
6505
|
+
* administrator in the organization's management account or as a delegated
|
|
6506
|
+
* administrator in a member account.</p>
|
|
6165
6507
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
6166
6508
|
* self-managed permissions.</p>
|
|
6167
6509
|
* <ul>
|
|
6168
6510
|
* <li>
|
|
6169
|
-
* <p>If you are signed in to the management account, specify
|
|
6511
|
+
* <p>If you are signed in to the management account, specify
|
|
6512
|
+
* <code>SELF</code>.</p>
|
|
6170
6513
|
* </li>
|
|
6171
6514
|
* <li>
|
|
6172
6515
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -6206,14 +6549,15 @@ export interface StackSetOperationResultSummary {
|
|
|
6206
6549
|
* <li>
|
|
6207
6550
|
* <p>
|
|
6208
6551
|
* <code>CANCELLED</code>: The operation in the specified account and Region has been
|
|
6209
|
-
*
|
|
6552
|
+
* canceled. This is either because a user has stopped the stack set operation, or
|
|
6210
6553
|
* because the failure tolerance of the stack set operation has been exceeded.</p>
|
|
6211
6554
|
* </li>
|
|
6212
6555
|
* <li>
|
|
6213
6556
|
* <p>
|
|
6214
|
-
* <code>FAILED</code>: The operation in the specified account and Region
|
|
6557
|
+
* <code>FAILED</code>: The operation in the specified account and Region
|
|
6558
|
+
* failed.</p>
|
|
6215
6559
|
* <p>If the stack set operation fails in enough accounts within a Region, the failure
|
|
6216
|
-
* tolerance for the stack set operation as a whole might be exceeded
|
|
6560
|
+
* tolerance for the stack set operation as a whole might be exceeded.</p>
|
|
6217
6561
|
* </li>
|
|
6218
6562
|
* <li>
|
|
6219
6563
|
* <p>
|
|
@@ -6223,7 +6567,7 @@ export interface StackSetOperationResultSummary {
|
|
|
6223
6567
|
* <li>
|
|
6224
6568
|
* <p>
|
|
6225
6569
|
* <code>PENDING</code>: The operation in the specified account and Region has yet to
|
|
6226
|
-
* start
|
|
6570
|
+
* start.</p>
|
|
6227
6571
|
* </li>
|
|
6228
6572
|
* <li>
|
|
6229
6573
|
* <p>
|
|
@@ -6239,7 +6583,7 @@ export interface StackSetOperationResultSummary {
|
|
|
6239
6583
|
StatusReason?: string;
|
|
6240
6584
|
/**
|
|
6241
6585
|
* <p>The results of the account gate function CloudFormation invokes, if present,
|
|
6242
|
-
* before proceeding with stack set operations in an account
|
|
6586
|
+
* before proceeding with stack set operations in an account.</p>
|
|
6243
6587
|
*/
|
|
6244
6588
|
AccountGateResult?: AccountGateResult;
|
|
6245
6589
|
/**
|
|
@@ -6257,8 +6601,7 @@ export declare namespace StackSetOperationResultSummary {
|
|
|
6257
6601
|
export interface ListStackSetOperationResultsOutput {
|
|
6258
6602
|
/**
|
|
6259
6603
|
* <p>A list of <code>StackSetOperationResultSummary</code> structures that contain
|
|
6260
|
-
* information about the specified operation results, for accounts and Regions that are
|
|
6261
|
-
* included in the operation.</p>
|
|
6604
|
+
* information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.</p>
|
|
6262
6605
|
*/
|
|
6263
6606
|
Summaries?: StackSetOperationResultSummary[];
|
|
6264
6607
|
/**
|
|
@@ -6299,13 +6642,14 @@ export interface ListStackSetOperationsInput {
|
|
|
6299
6642
|
MaxResults?: number;
|
|
6300
6643
|
/**
|
|
6301
6644
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
6302
|
-
* administrator in the organization's management account or as a delegated
|
|
6303
|
-
* member account.</p>
|
|
6645
|
+
* administrator in the organization's management account or as a delegated
|
|
6646
|
+
* administrator in a member account.</p>
|
|
6304
6647
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
6305
6648
|
* self-managed permissions.</p>
|
|
6306
6649
|
* <ul>
|
|
6307
6650
|
* <li>
|
|
6308
|
-
* <p>If you are signed in to the management account, specify
|
|
6651
|
+
* <p>If you are signed in to the management account, specify
|
|
6652
|
+
* <code>SELF</code>.</p>
|
|
6309
6653
|
* </li>
|
|
6310
6654
|
* <li>
|
|
6311
6655
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -6334,7 +6678,7 @@ export interface StackSetOperationSummary {
|
|
|
6334
6678
|
/**
|
|
6335
6679
|
* <p>The type of operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>.
|
|
6336
6680
|
* Create and delete operations affect only the specified stack instances that are associated
|
|
6337
|
-
* with the specified stack set. Update operations affect both the stack set itself
|
|
6681
|
+
* with the specified stack set. Update operations affect both the stack set itself and
|
|
6338
6682
|
* <i>all</i> associated stack set instances.</p>
|
|
6339
6683
|
*/
|
|
6340
6684
|
Action?: StackSetOperationAction | string;
|
|
@@ -6355,8 +6699,7 @@ export interface StackSetOperationSummary {
|
|
|
6355
6699
|
* <p>
|
|
6356
6700
|
* <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that
|
|
6357
6701
|
* require a sequence of operations, the operation is queued to be performed. For more
|
|
6358
|
-
* information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">stack set operation status codes</a> in the CloudFormation User
|
|
6359
|
-
* Guide.</p>
|
|
6702
|
+
* information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">stack set operation status codes</a> in the CloudFormation User Guide.</p>
|
|
6360
6703
|
* </li>
|
|
6361
6704
|
* <li>
|
|
6362
6705
|
* <p>
|
|
@@ -6364,12 +6707,12 @@ export interface StackSetOperationSummary {
|
|
|
6364
6707
|
* </li>
|
|
6365
6708
|
* <li>
|
|
6366
6709
|
* <p>
|
|
6367
|
-
* <code>STOPPED</code>: The user has
|
|
6710
|
+
* <code>STOPPED</code>: The user has canceled the operation.</p>
|
|
6368
6711
|
* </li>
|
|
6369
6712
|
* <li>
|
|
6370
6713
|
* <p>
|
|
6371
6714
|
* <code>STOPPING</code>: The operation is in the process of stopping, at user
|
|
6372
|
-
* request
|
|
6715
|
+
* request.</p>
|
|
6373
6716
|
* </li>
|
|
6374
6717
|
* <li>
|
|
6375
6718
|
* <p>
|
|
@@ -6422,12 +6765,11 @@ export declare namespace ListStackSetOperationsOutput {
|
|
|
6422
6765
|
}
|
|
6423
6766
|
export interface ListStackSetsInput {
|
|
6424
6767
|
/**
|
|
6425
|
-
* <p>If the previous paginated request didn't return all
|
|
6426
|
-
*
|
|
6427
|
-
*
|
|
6428
|
-
*
|
|
6429
|
-
*
|
|
6430
|
-
* <code>null</code>.</p>
|
|
6768
|
+
* <p>If the previous paginated request didn't return all the remaining results, the response
|
|
6769
|
+
* object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set
|
|
6770
|
+
* of results, call <code>ListStackSets</code> again and assign that token to the request
|
|
6771
|
+
* object's <code>NextToken</code> parameter. If there are no remaining results, the previous
|
|
6772
|
+
* response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6431
6773
|
*/
|
|
6432
6774
|
NextToken?: string;
|
|
6433
6775
|
/**
|
|
@@ -6443,13 +6785,14 @@ export interface ListStackSetsInput {
|
|
|
6443
6785
|
Status?: StackSetStatus | string;
|
|
6444
6786
|
/**
|
|
6445
6787
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
6446
|
-
* administrator in the management account or as a delegated administrator in a
|
|
6447
|
-
* account.</p>
|
|
6788
|
+
* administrator in the management account or as a delegated administrator in a
|
|
6789
|
+
* member account.</p>
|
|
6448
6790
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
6449
6791
|
* self-managed permissions.</p>
|
|
6450
6792
|
* <ul>
|
|
6451
6793
|
* <li>
|
|
6452
|
-
* <p>If you are signed in to the management account, specify
|
|
6794
|
+
* <p>If you are signed in to the management account, specify
|
|
6795
|
+
* <code>SELF</code>.</p>
|
|
6453
6796
|
* </li>
|
|
6454
6797
|
* <li>
|
|
6455
6798
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -6495,7 +6838,8 @@ export interface StackSetSummary {
|
|
|
6495
6838
|
*/
|
|
6496
6839
|
AutoDeployment?: AutoDeployment;
|
|
6497
6840
|
/**
|
|
6498
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
6841
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
6842
|
+
* created.</p>
|
|
6499
6843
|
* <ul>
|
|
6500
6844
|
* <li>
|
|
6501
6845
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -6505,8 +6849,7 @@ export interface StackSetSummary {
|
|
|
6505
6849
|
* </li>
|
|
6506
6850
|
* <li>
|
|
6507
6851
|
* <p>With <code>service-managed</code> permissions, StackSets automatically creates the
|
|
6508
|
-
*
|
|
6509
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
6852
|
+
* IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
6510
6853
|
* </li>
|
|
6511
6854
|
* </ul>
|
|
6512
6855
|
*/
|
|
@@ -6526,11 +6869,11 @@ export interface StackSetSummary {
|
|
|
6526
6869
|
* </li>
|
|
6527
6870
|
* <li>
|
|
6528
6871
|
* <p>
|
|
6529
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6872
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked the stack set for drift.</p>
|
|
6530
6873
|
* </li>
|
|
6531
6874
|
* <li>
|
|
6532
6875
|
* <p>
|
|
6533
|
-
* <code>IN_SYNC</code>: All
|
|
6876
|
+
* <code>IN_SYNC</code>: All the stack instances belonging to the stack set stack
|
|
6534
6877
|
* match from the expected template and parameter configuration.</p>
|
|
6535
6878
|
* </li>
|
|
6536
6879
|
* <li>
|
|
@@ -6543,7 +6886,7 @@ export interface StackSetSummary {
|
|
|
6543
6886
|
/**
|
|
6544
6887
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
6545
6888
|
* the stack set. This value will be <code>NULL</code> for any stack set on which drift
|
|
6546
|
-
* detection
|
|
6889
|
+
* detection hasn't yet been performed.</p>
|
|
6547
6890
|
*/
|
|
6548
6891
|
LastDriftCheckTimestamp?: Date;
|
|
6549
6892
|
/**
|
|
@@ -6610,9 +6953,9 @@ export interface ListTypeRegistrationsInput {
|
|
|
6610
6953
|
*/
|
|
6611
6954
|
MaxResults?: number;
|
|
6612
6955
|
/**
|
|
6613
|
-
* <p>If the previous paginated request didn't return all
|
|
6614
|
-
*
|
|
6615
|
-
*
|
|
6956
|
+
* <p>If the previous paginated request didn't return all the remaining results, the response
|
|
6957
|
+
* object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set
|
|
6958
|
+
* of results, call this action again and assign that token to the request object's
|
|
6616
6959
|
* <code>NextToken</code> parameter. If there are no remaining results, the previous
|
|
6617
6960
|
* response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6618
6961
|
*/
|
|
@@ -6626,7 +6969,7 @@ export declare namespace ListTypeRegistrationsInput {
|
|
|
6626
6969
|
}
|
|
6627
6970
|
export interface ListTypeRegistrationsOutput {
|
|
6628
6971
|
/**
|
|
6629
|
-
* <p>
|
|
6972
|
+
* <p>A list of extension registration tokens.</p>
|
|
6630
6973
|
* <p>Use <code>
|
|
6631
6974
|
* <a>DescribeTypeRegistration</a>
|
|
6632
6975
|
* </code> to return detailed
|
|
@@ -6686,9 +7029,9 @@ export interface TypeFilters {
|
|
|
6686
7029
|
*/
|
|
6687
7030
|
Category?: Category | string;
|
|
6688
7031
|
/**
|
|
6689
|
-
* <p>The id of the publisher of the extension
|
|
6690
|
-
* <p>Extensions published by Amazon
|
|
6691
|
-
* <code>
|
|
7032
|
+
* <p>The id of the publisher of the extension.</p>
|
|
7033
|
+
* <p>Extensions published by Amazon aren't assigned a publisher ID. Use the
|
|
7034
|
+
* <code>AWS_TYPES</code> category to specify a list of types published by Amazon.</p>
|
|
6692
7035
|
*/
|
|
6693
7036
|
PublisherId?: string;
|
|
6694
7037
|
/**
|
|
@@ -6744,14 +7087,14 @@ export interface ListTypesInput {
|
|
|
6744
7087
|
* </li>
|
|
6745
7088
|
* <li>
|
|
6746
7089
|
* <p>
|
|
6747
|
-
* <code>IMMUTABLE</code>: The resource type
|
|
6748
|
-
* the type
|
|
7090
|
+
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so
|
|
7091
|
+
* the type can't be updated and must instead be replaced during stack update
|
|
6749
7092
|
* operations.</p>
|
|
6750
7093
|
* </li>
|
|
6751
7094
|
* <li>
|
|
6752
7095
|
* <p>
|
|
6753
|
-
* <code>NON_PROVISIONABLE</code>: The resource type
|
|
6754
|
-
* and delete handlers, and therefore
|
|
7096
|
+
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include create, read,
|
|
7097
|
+
* and delete handlers, and therefore can't actually be provisioned.</p>
|
|
6755
7098
|
* </li>
|
|
6756
7099
|
* </ul>
|
|
6757
7100
|
* <p>The default is <code>FULLY_MUTABLE</code>.</p>
|
|
@@ -6770,7 +7113,7 @@ export interface ListTypesInput {
|
|
|
6770
7113
|
* <li>
|
|
6771
7114
|
* <p>
|
|
6772
7115
|
* <code>DEPRECATED</code>: The extension has been deregistered and can no longer be
|
|
6773
|
-
* used in CloudFormation operations
|
|
7116
|
+
* used in CloudFormation operations.</p>
|
|
6774
7117
|
* </li>
|
|
6775
7118
|
* </ul>
|
|
6776
7119
|
*/
|
|
@@ -6820,19 +7163,18 @@ export interface TypeSummary {
|
|
|
6820
7163
|
Type?: RegistryType | string;
|
|
6821
7164
|
/**
|
|
6822
7165
|
* <p>The name of the extension.</p>
|
|
6823
|
-
* <p>If you specified a <code>TypeNameAlias</code> when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">activate this extension</a> in your account and region, CloudFormation
|
|
6824
|
-
* that alias as the type name.</p>
|
|
7166
|
+
* <p>If you specified a <code>TypeNameAlias</code> when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">activate this extension</a> in your account and region, CloudFormation
|
|
7167
|
+
* considers that alias as the type name.</p>
|
|
6825
7168
|
*/
|
|
6826
7169
|
TypeName?: string;
|
|
6827
7170
|
/**
|
|
6828
7171
|
* <p>The ID of the default version of the extension. The default version is used when the
|
|
6829
|
-
* extension version
|
|
7172
|
+
* extension version isn't specified.</p>
|
|
6830
7173
|
* <p>This applies only to private extensions you have registered in your account. For public
|
|
6831
|
-
* extensions, both those provided by Amazon and published by third parties, CloudFormation
|
|
6832
|
-
* returns <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
7174
|
+
* extensions, both those provided by Amazon and published by third parties, CloudFormation returns <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
6833
7175
|
* <p>To set the default version of an extension, use <code>
|
|
6834
7176
|
* <a>SetTypeDefaultVersion</a>
|
|
6835
|
-
* </code
|
|
7177
|
+
* </code>.</p>
|
|
6836
7178
|
*/
|
|
6837
7179
|
DefaultVersionId?: string;
|
|
6838
7180
|
/**
|
|
@@ -6860,44 +7202,44 @@ export interface TypeSummary {
|
|
|
6860
7202
|
Description?: string;
|
|
6861
7203
|
/**
|
|
6862
7204
|
* <p>The ID of the extension publisher, if the extension is published by a third party.
|
|
6863
|
-
* Extensions published by Amazon
|
|
7205
|
+
* Extensions published by Amazon don't return a publisher ID.</p>
|
|
6864
7206
|
*/
|
|
6865
7207
|
PublisherId?: string;
|
|
6866
7208
|
/**
|
|
6867
7209
|
* <p>For public extensions that have been activated for this account and region, the type
|
|
6868
7210
|
* name of the public extension.</p>
|
|
6869
7211
|
* <p>If you specified a <code>TypeNameAlias</code> when enabling the extension in this
|
|
6870
|
-
* account and region, CloudFormation treats that alias as the extension's type name
|
|
6871
|
-
* the account and region, not the type name of the public extension. For more
|
|
6872
|
-
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to refer to extensions</a> in the
|
|
7212
|
+
* account and region, CloudFormation treats that alias as the extension's type name
|
|
7213
|
+
* within the account and region, not the type name of the public extension. For more
|
|
7214
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to refer to extensions</a> in the
|
|
6873
7215
|
* <i>CloudFormation User Guide</i>.</p>
|
|
6874
7216
|
*/
|
|
6875
7217
|
OriginalTypeName?: string;
|
|
6876
7218
|
/**
|
|
6877
7219
|
* <p>For public extensions that have been activated for this account and region, the version
|
|
6878
|
-
* of the public extension to be used for CloudFormation operations in this account
|
|
6879
|
-
*
|
|
7220
|
+
* of the public extension to be used for CloudFormation operations in this account
|
|
7221
|
+
* and Region.</p>
|
|
6880
7222
|
* <p>How you specified <code>AutoUpdate</code> when enabling the extension affects whether
|
|
6881
|
-
*
|
|
6882
|
-
* version is released. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Setting CloudFormation to automatically use new versions
|
|
6883
|
-
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7223
|
+
* CloudFormation automatically updates the extension in this account and region
|
|
7224
|
+
* when a new version is released. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Setting CloudFormation to automatically use new versions
|
|
7225
|
+
* of extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6884
7226
|
*/
|
|
6885
7227
|
PublicVersionNumber?: string;
|
|
6886
7228
|
/**
|
|
6887
7229
|
* <p>For public extensions that have been activated for this account and region, the latest
|
|
6888
7230
|
* version of the public extension <i>that is available</i>. For any extensions
|
|
6889
7231
|
* other than activated third-arty extensions, CloudFormation returns
|
|
6890
|
-
*
|
|
7232
|
+
* <code>null</code>.</p>
|
|
6891
7233
|
* <p>How you specified <code>AutoUpdate</code> when enabling the extension affects whether
|
|
6892
|
-
*
|
|
6893
|
-
* version is released. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Setting CloudFormation to automatically use new versions
|
|
6894
|
-
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7234
|
+
* CloudFormation automatically updates the extension in this account and region
|
|
7235
|
+
* when a new version is released. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Setting CloudFormation to automatically use new versions
|
|
7236
|
+
* of extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6895
7237
|
*/
|
|
6896
7238
|
LatestPublicVersion?: string;
|
|
6897
7239
|
/**
|
|
6898
7240
|
* <p>The service used to verify the publisher identity.</p>
|
|
6899
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Registering your account to publish CloudFormation extensions</a> in the
|
|
6900
|
-
* CFN-CLI User Guide for Extension Development</i>.</p>
|
|
7241
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Registering your account to publish CloudFormation extensions</a> in the
|
|
7242
|
+
* <i> CFN-CLI User Guide for Extension Development</i>.</p>
|
|
6901
7243
|
*/
|
|
6902
7244
|
PublisherIdentity?: IdentityProvider | string;
|
|
6903
7245
|
/**
|
|
@@ -6906,7 +7248,7 @@ export interface TypeSummary {
|
|
|
6906
7248
|
*/
|
|
6907
7249
|
PublisherName?: string;
|
|
6908
7250
|
/**
|
|
6909
|
-
* <p>Whether or not the extension is activated for this account and region
|
|
7251
|
+
* <p>Whether or not the extension is activated for this account and region.</p>
|
|
6910
7252
|
* <p>This applies only to third-party public extensions. Extensions published by Amazon are
|
|
6911
7253
|
* activated by default.</p>
|
|
6912
7254
|
*/
|
|
@@ -6925,8 +7267,8 @@ export interface ListTypesOutput {
|
|
|
6925
7267
|
*/
|
|
6926
7268
|
TypeSummaries?: TypeSummary[];
|
|
6927
7269
|
/**
|
|
6928
|
-
* <p>If the request doesn't return all
|
|
6929
|
-
*
|
|
7270
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set
|
|
7271
|
+
* to a token. To retrieve the next set of results, call this action again and assign that
|
|
6930
7272
|
* token to the request object's <code>NextToken</code> parameter. If the request returns all
|
|
6931
7273
|
* results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6932
7274
|
*/
|
|
@@ -6986,7 +7328,7 @@ export interface ListTypeVersionsInput {
|
|
|
6986
7328
|
* <li>
|
|
6987
7329
|
* <p>
|
|
6988
7330
|
* <code>DEPRECATED</code>: The extension version has been deregistered and can no
|
|
6989
|
-
* longer be used in CloudFormation operations
|
|
7331
|
+
* longer be used in CloudFormation operations.</p>
|
|
6990
7332
|
* </li>
|
|
6991
7333
|
* </ul>
|
|
6992
7334
|
* <p>The default is <code>LIVE</code>.</p>
|
|
@@ -6994,7 +7336,7 @@ export interface ListTypeVersionsInput {
|
|
|
6994
7336
|
DeprecatedStatus?: DeprecatedStatus | string;
|
|
6995
7337
|
/**
|
|
6996
7338
|
* <p>The publisher ID of the extension publisher.</p>
|
|
6997
|
-
* <p>Extensions published by Amazon
|
|
7339
|
+
* <p>Extensions published by Amazon aren't assigned a publisher ID.</p>
|
|
6998
7340
|
*/
|
|
6999
7341
|
PublisherId?: string;
|
|
7000
7342
|
}
|
|
@@ -7019,15 +7361,15 @@ export interface TypeVersionSummary {
|
|
|
7019
7361
|
TypeName?: string;
|
|
7020
7362
|
/**
|
|
7021
7363
|
* <p>The ID of a specific version of the extension. The version ID is the value at the end of
|
|
7022
|
-
* the Amazon Resource Name (ARN) assigned to the extension version when it
|
|
7364
|
+
* the Amazon Resource Name (ARN) assigned to the extension version when it's
|
|
7023
7365
|
* registered.</p>
|
|
7024
7366
|
*/
|
|
7025
7367
|
VersionId?: string;
|
|
7026
7368
|
/**
|
|
7027
7369
|
* <p>Whether the specified extension version is set as the default version.</p>
|
|
7028
7370
|
* <p>This applies only to private extensions you have registered in your account, and
|
|
7029
|
-
* extensions published by Amazon. For public third-party extensions,
|
|
7030
|
-
*
|
|
7371
|
+
* extensions published by Amazon. For public third-party extensions, CloudFormation
|
|
7372
|
+
* returns <code>null</code>.</p>
|
|
7031
7373
|
*/
|
|
7032
7374
|
IsDefaultVersion?: boolean;
|
|
7033
7375
|
/**
|
|
@@ -7044,13 +7386,12 @@ export interface TypeVersionSummary {
|
|
|
7044
7386
|
Description?: string;
|
|
7045
7387
|
/**
|
|
7046
7388
|
* <p>For public extensions that have been activated for this account and region, the version
|
|
7047
|
-
* of the public extension to be used for CloudFormation operations in this account
|
|
7048
|
-
* region. For any extensions other than activated third-arty extensions, CloudFormation
|
|
7049
|
-
* returns <code>null</code>.</p>
|
|
7389
|
+
* of the public extension to be used for CloudFormation operations in this account
|
|
7390
|
+
* and region. For any extensions other than activated third-arty extensions, CloudFormation returns <code>null</code>.</p>
|
|
7050
7391
|
* <p>How you specified <code>AutoUpdate</code> when enabling the extension affects whether
|
|
7051
|
-
*
|
|
7052
|
-
* version is released. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Setting CloudFormation to automatically use new versions
|
|
7053
|
-
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7392
|
+
* CloudFormation automatically updates the extension in this account and region
|
|
7393
|
+
* when a new version is released. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Setting CloudFormation to automatically use new versions
|
|
7394
|
+
* of extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7054
7395
|
*/
|
|
7055
7396
|
PublicVersionNumber?: string;
|
|
7056
7397
|
}
|
|
@@ -7102,14 +7443,14 @@ export interface PublishTypeInput {
|
|
|
7102
7443
|
/**
|
|
7103
7444
|
* <p>The version number to assign to this version of the extension.</p>
|
|
7104
7445
|
* <p>Use the following format, and adhere to semantic versioning when assigning a version
|
|
7105
|
-
* number to your extension
|
|
7446
|
+
* number to your extension:</p>
|
|
7106
7447
|
* <p>
|
|
7107
7448
|
* <code>MAJOR.MINOR.PATCH</code>
|
|
7108
7449
|
* </p>
|
|
7109
7450
|
* <p>For more information, see <a href="https://semver.org/">Semantic Versioning
|
|
7110
7451
|
* 2.0.0</a>.</p>
|
|
7111
|
-
* <p>If you
|
|
7112
|
-
* one minor version release.</p>
|
|
7452
|
+
* <p>If you don't specify a version number, CloudFormation increments the version
|
|
7453
|
+
* number by one minor version release.</p>
|
|
7113
7454
|
* <p>You cannot specify a version number the first time you publish a type. CloudFormation
|
|
7114
7455
|
* automatically sets the first version number to be <code>1.0.0</code>.</p>
|
|
7115
7456
|
*/
|
|
@@ -7135,22 +7476,30 @@ export declare namespace PublishTypeOutput {
|
|
|
7135
7476
|
const filterSensitiveLog: (obj: PublishTypeOutput) => any;
|
|
7136
7477
|
}
|
|
7137
7478
|
/**
|
|
7138
|
-
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation
|
|
7479
|
+
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation doesn't return this error to
|
|
7139
7480
|
* users.</p>
|
|
7140
7481
|
*/
|
|
7141
|
-
export
|
|
7142
|
-
name: "InvalidStateTransitionException";
|
|
7143
|
-
$fault: "client";
|
|
7482
|
+
export declare class InvalidStateTransitionException extends __BaseException {
|
|
7483
|
+
readonly name: "InvalidStateTransitionException";
|
|
7484
|
+
readonly $fault: "client";
|
|
7144
7485
|
Message?: string;
|
|
7486
|
+
/**
|
|
7487
|
+
* @internal
|
|
7488
|
+
*/
|
|
7489
|
+
constructor(opts: __ExceptionOptionType<InvalidStateTransitionException, __BaseException>);
|
|
7145
7490
|
}
|
|
7146
7491
|
/**
|
|
7147
|
-
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation
|
|
7492
|
+
* <p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation doesn't return this error to
|
|
7148
7493
|
* users.</p>
|
|
7149
7494
|
*/
|
|
7150
|
-
export
|
|
7151
|
-
name: "OperationStatusCheckFailedException";
|
|
7152
|
-
$fault: "client";
|
|
7495
|
+
export declare class OperationStatusCheckFailedException extends __BaseException {
|
|
7496
|
+
readonly name: "OperationStatusCheckFailedException";
|
|
7497
|
+
readonly $fault: "client";
|
|
7153
7498
|
Message?: string;
|
|
7499
|
+
/**
|
|
7500
|
+
* @internal
|
|
7501
|
+
*/
|
|
7502
|
+
constructor(opts: __ExceptionOptionType<OperationStatusCheckFailedException, __BaseException>);
|
|
7154
7503
|
}
|
|
7155
7504
|
export declare enum OperationStatus {
|
|
7156
7505
|
FAILED = "FAILED",
|
|
@@ -7162,18 +7511,21 @@ export declare enum HandlerErrorCode {
|
|
|
7162
7511
|
AccessDenied = "AccessDenied",
|
|
7163
7512
|
AlreadyExists = "AlreadyExists",
|
|
7164
7513
|
GeneralServiceException = "GeneralServiceException",
|
|
7514
|
+
HandlerInternalFailure = "HandlerInternalFailure",
|
|
7165
7515
|
InternalFailure = "InternalFailure",
|
|
7166
7516
|
InvalidCredentials = "InvalidCredentials",
|
|
7167
7517
|
InvalidRequest = "InvalidRequest",
|
|
7168
7518
|
InvalidTypeConfiguration = "InvalidTypeConfiguration",
|
|
7169
7519
|
NetworkFailure = "NetworkFailure",
|
|
7520
|
+
NonCompliant = "NonCompliant",
|
|
7170
7521
|
NotFound = "NotFound",
|
|
7171
7522
|
NotUpdatable = "NotUpdatable",
|
|
7172
7523
|
ResourceConflict = "ResourceConflict",
|
|
7173
7524
|
ServiceInternalError = "ServiceInternalError",
|
|
7174
7525
|
ServiceLimitExceeded = "ServiceLimitExceeded",
|
|
7175
7526
|
ServiceTimeout = "NotStabilized",
|
|
7176
|
-
Throttling = "Throttling"
|
|
7527
|
+
Throttling = "Throttling",
|
|
7528
|
+
Unknown = "Unknown"
|
|
7177
7529
|
}
|
|
7178
7530
|
export interface RecordHandlerProgressInput {
|
|
7179
7531
|
/**
|
|
@@ -7221,9 +7573,9 @@ export declare namespace RecordHandlerProgressOutput {
|
|
|
7221
7573
|
}
|
|
7222
7574
|
export interface RegisterPublisherInput {
|
|
7223
7575
|
/**
|
|
7224
|
-
* <p>Whether you accept the <a href="https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf">Terms and Conditions</a> for publishing extensions in the CloudFormation
|
|
7225
|
-
* You must accept the terms and conditions in order to register to publish public
|
|
7226
|
-
* to the CloudFormation registry.</p>
|
|
7576
|
+
* <p>Whether you accept the <a href="https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf">Terms and Conditions</a> for publishing extensions in the CloudFormation
|
|
7577
|
+
* registry. You must accept the terms and conditions in order to register to publish public
|
|
7578
|
+
* extensions to the CloudFormation registry.</p>
|
|
7227
7579
|
* <p>The default is <code>false</code>.</p>
|
|
7228
7580
|
*/
|
|
7229
7581
|
AcceptTermsAndConditions?: boolean;
|
|
@@ -7231,7 +7583,8 @@ export interface RegisterPublisherInput {
|
|
|
7231
7583
|
* <p>If you are using a Bitbucket or GitHub account for identity verification, the Amazon
|
|
7232
7584
|
* Resource Name (ARN) for your connection to that account.</p>
|
|
7233
7585
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation
|
|
7234
|
-
* extensions</a> in the <i>CloudFormation CLI User
|
|
7586
|
+
* extensions</a> in the <i>CloudFormation CLI User
|
|
7587
|
+
* Guide</i>.</p>
|
|
7235
7588
|
*/
|
|
7236
7589
|
ConnectionArn?: string;
|
|
7237
7590
|
}
|
|
@@ -7243,7 +7596,8 @@ export declare namespace RegisterPublisherInput {
|
|
|
7243
7596
|
}
|
|
7244
7597
|
export interface RegisterPublisherOutput {
|
|
7245
7598
|
/**
|
|
7246
|
-
* <p>The ID assigned this account by CloudFormation for publishing
|
|
7599
|
+
* <p>The ID assigned this account by CloudFormation for publishing
|
|
7600
|
+
* extensions.</p>
|
|
7247
7601
|
*/
|
|
7248
7602
|
PublisherId?: string;
|
|
7249
7603
|
}
|
|
@@ -7260,7 +7614,7 @@ export interface RegisterTypeInput {
|
|
|
7260
7614
|
Type?: RegistryType | string;
|
|
7261
7615
|
/**
|
|
7262
7616
|
* <p>The name of the extension being registered.</p>
|
|
7263
|
-
* <p>We recommend that extension names adhere to the following patterns
|
|
7617
|
+
* <p>We recommend that extension names adhere to the following patterns:</p>
|
|
7264
7618
|
* <ul>
|
|
7265
7619
|
* <li>
|
|
7266
7620
|
* <p>For resource types,
|
|
@@ -7273,7 +7627,7 @@ export interface RegisterTypeInput {
|
|
|
7273
7627
|
* </ul>
|
|
7274
7628
|
*
|
|
7275
7629
|
* <note>
|
|
7276
|
-
* <p>The following organization namespaces are reserved and
|
|
7630
|
+
* <p>The following organization namespaces are reserved and can't be used in your
|
|
7277
7631
|
* extension names:</p>
|
|
7278
7632
|
* <ul>
|
|
7279
7633
|
* <li>
|
|
@@ -7311,17 +7665,17 @@ export interface RegisterTypeInput {
|
|
|
7311
7665
|
*/
|
|
7312
7666
|
TypeName: string | undefined;
|
|
7313
7667
|
/**
|
|
7314
|
-
* <p>A
|
|
7315
|
-
*
|
|
7668
|
+
* <p>A URL to the S3 bucket containing the extension project package that contains the
|
|
7669
|
+
* necessary files for the extension you want to register.</p>
|
|
7316
7670
|
* <p>For information on generating a schema handler package for the extension you want to
|
|
7317
7671
|
* register, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html">submit</a>
|
|
7318
7672
|
* in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
7319
7673
|
* <note>
|
|
7320
7674
|
* <p>The user registering the extension must be able to access the package in the S3
|
|
7321
|
-
* bucket. That
|
|
7675
|
+
* bucket. That's, the user needs to have <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> permissions for the
|
|
7322
7676
|
* schema handler package. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html">Actions, Resources, and Condition Keys
|
|
7323
7677
|
* for Amazon S3</a> in the <i>Identity and Access Management User
|
|
7324
|
-
*
|
|
7678
|
+
* Guide</i>.</p>
|
|
7325
7679
|
* </note>
|
|
7326
7680
|
*/
|
|
7327
7681
|
SchemaHandlerPackage: string | undefined;
|
|
@@ -7330,29 +7684,28 @@ export interface RegisterTypeInput {
|
|
|
7330
7684
|
*/
|
|
7331
7685
|
LoggingConfig?: LoggingConfig;
|
|
7332
7686
|
/**
|
|
7333
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume
|
|
7334
|
-
*
|
|
7335
|
-
*
|
|
7336
|
-
* relationship with the CloudFormation service principle
|
|
7687
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.</p>
|
|
7688
|
+
* <p>For CloudFormation to assume the specified execution role, the role must
|
|
7689
|
+
* contain a trust relationship with the CloudFormation service principle
|
|
7337
7690
|
* (<code>resources.cloudformation.amazonaws.com</code>). For more information on adding
|
|
7338
7691
|
* trust relationships, see <a href="IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy">Modifying a role trust policy</a> in the <i>Identity and Access Management User
|
|
7339
7692
|
* Guide</i>.</p>
|
|
7340
7693
|
* <p>If your extension calls Amazon Web Services APIs in any of its handlers, you must create
|
|
7341
7694
|
* an <i>
|
|
7342
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
|
7343
|
-
*
|
|
7344
|
-
*
|
|
7345
|
-
*
|
|
7346
|
-
*
|
|
7347
|
-
*
|
|
7348
|
-
*
|
|
7695
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a>
|
|
7696
|
+
* </i> that includes the necessary
|
|
7697
|
+
* permissions to call those Amazon Web Services APIs, and provision that execution role in
|
|
7698
|
+
* your account. When CloudFormation needs to invoke the resource type handler,
|
|
7699
|
+
* CloudFormation assumes this execution role to create a temporary session token,
|
|
7700
|
+
* which it then passes to the resource type handler, thereby supplying your resource type
|
|
7701
|
+
* with the appropriate credentials.</p>
|
|
7349
7702
|
*/
|
|
7350
7703
|
ExecutionRoleArn?: string;
|
|
7351
7704
|
/**
|
|
7352
7705
|
* <p>A unique identifier that acts as an idempotency key for this registration request.
|
|
7353
7706
|
* Specifying a client request token prevents CloudFormation from generating more
|
|
7354
|
-
* than one version of an extension from the same
|
|
7355
|
-
*
|
|
7707
|
+
* than one version of an extension from the same registration request, even if the request is
|
|
7708
|
+
* submitted multiple times.</p>
|
|
7356
7709
|
*/
|
|
7357
7710
|
ClientRequestToken?: string;
|
|
7358
7711
|
}
|
|
@@ -7368,7 +7721,7 @@ export interface RegisterTypeOutput {
|
|
|
7368
7721
|
* <p>Use this registration token when calling <code>
|
|
7369
7722
|
* <a>DescribeTypeRegistration</a>
|
|
7370
7723
|
* </code>, which returns information about the status and IDs of the extension
|
|
7371
|
-
* registration
|
|
7724
|
+
* registration.</p>
|
|
7372
7725
|
*/
|
|
7373
7726
|
RegistrationToken?: string;
|
|
7374
7727
|
}
|
|
@@ -7380,7 +7733,7 @@ export declare namespace RegisterTypeOutput {
|
|
|
7380
7733
|
}
|
|
7381
7734
|
export interface RollbackStackInput {
|
|
7382
7735
|
/**
|
|
7383
|
-
* <p>The name that
|
|
7736
|
+
* <p>The name that's associated with the stack.</p>
|
|
7384
7737
|
*/
|
|
7385
7738
|
StackName: string | undefined;
|
|
7386
7739
|
/**
|
|
@@ -7420,17 +7773,17 @@ export interface SetStackPolicyInput {
|
|
|
7420
7773
|
*/
|
|
7421
7774
|
StackName: string | undefined;
|
|
7422
7775
|
/**
|
|
7423
|
-
* <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
|
|
7424
|
-
* to
|
|
7425
|
-
*
|
|
7426
|
-
*
|
|
7776
|
+
* <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
|
|
7777
|
+
* to stack resources</a> in the CloudFormation User Guide. You can specify either the
|
|
7778
|
+
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
7779
|
+
* both.</p>
|
|
7427
7780
|
*/
|
|
7428
7781
|
StackPolicyBody?: string;
|
|
7429
7782
|
/**
|
|
7430
7783
|
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum
|
|
7431
|
-
* size: 16 KB) located in an S3 bucket in the same
|
|
7432
|
-
* either the <code>StackPolicyBody</code> or the
|
|
7433
|
-
*
|
|
7784
|
+
* size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region
|
|
7785
|
+
* as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
7786
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7434
7787
|
*/
|
|
7435
7788
|
StackPolicyURL?: string;
|
|
7436
7789
|
}
|
|
@@ -7444,16 +7797,16 @@ export interface SetTypeConfigurationInput {
|
|
|
7444
7797
|
/**
|
|
7445
7798
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and region.</p>
|
|
7446
7799
|
* <p>For public extensions, this will be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">activate the type</a> in this account and region. For private extensions, this will
|
|
7447
|
-
* be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">register the type</a> in this account and region
|
|
7800
|
+
* be the ARN assigned when you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">register the type</a> in this account and region.</p>
|
|
7448
7801
|
* <p>Do not include the extension versions suffix at the end of the ARN. You can set the
|
|
7449
7802
|
* configuration for an extension, but not for a specific extension version.</p>
|
|
7450
7803
|
*/
|
|
7451
7804
|
TypeArn?: string;
|
|
7452
7805
|
/**
|
|
7453
|
-
* <p>The configuration data for the extension, in this account and region
|
|
7806
|
+
* <p>The configuration data for the extension, in this account and region.</p>
|
|
7454
7807
|
* <p>The configuration data must be formatted as JSON, and validate against the schema
|
|
7455
7808
|
* returned in the <code>ConfigurationSchema</code> response element of <a href="AWSCloudFormation/latest/APIReference/API_DescribeType.html">API_DescribeType</a>. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration">Defining account-level configuration data for an extension</a> in the
|
|
7456
|
-
*
|
|
7809
|
+
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
7457
7810
|
*/
|
|
7458
7811
|
Configuration: string | undefined;
|
|
7459
7812
|
/**
|
|
@@ -7556,10 +7909,9 @@ export interface SignalResourceInput {
|
|
|
7556
7909
|
*/
|
|
7557
7910
|
LogicalResourceId: string | undefined;
|
|
7558
7911
|
/**
|
|
7559
|
-
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups,
|
|
7560
|
-
*
|
|
7561
|
-
*
|
|
7562
|
-
* different unique ID.</p>
|
|
7912
|
+
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If
|
|
7913
|
+
* you send multiple signals to a single resource (such as signaling a wait condition), each
|
|
7914
|
+
* signal requires a different unique ID.</p>
|
|
7563
7915
|
*/
|
|
7564
7916
|
UniqueId: string | undefined;
|
|
7565
7917
|
/**
|
|
@@ -7580,18 +7932,19 @@ export interface StopStackSetOperationInput {
|
|
|
7580
7932
|
*/
|
|
7581
7933
|
StackSetName: string | undefined;
|
|
7582
7934
|
/**
|
|
7583
|
-
* <p>The ID of the stack operation
|
|
7935
|
+
* <p>The ID of the stack operation.</p>
|
|
7584
7936
|
*/
|
|
7585
7937
|
OperationId: string | undefined;
|
|
7586
7938
|
/**
|
|
7587
7939
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
7588
|
-
* administrator in the organization's management account or as a delegated
|
|
7589
|
-
* member account.</p>
|
|
7940
|
+
* administrator in the organization's management account or as a delegated
|
|
7941
|
+
* administrator in a member account.</p>
|
|
7590
7942
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
7591
7943
|
* self-managed permissions.</p>
|
|
7592
7944
|
* <ul>
|
|
7593
7945
|
* <li>
|
|
7594
|
-
* <p>If you are signed in to the management account, specify
|
|
7946
|
+
* <p>If you are signed in to the management account, specify
|
|
7947
|
+
* <code>SELF</code>.</p>
|
|
7595
7948
|
* </li>
|
|
7596
7949
|
* <li>
|
|
7597
7950
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -7619,7 +7972,7 @@ export declare namespace StopStackSetOperationOutput {
|
|
|
7619
7972
|
}
|
|
7620
7973
|
export interface TestTypeInput {
|
|
7621
7974
|
/**
|
|
7622
|
-
* <p>The Amazon Resource
|
|
7975
|
+
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
7623
7976
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7624
7977
|
* <code>Type</code>.</p>
|
|
7625
7978
|
*/
|
|
@@ -7640,28 +7993,33 @@ export interface TestTypeInput {
|
|
|
7640
7993
|
* <p>The version of the extension to test.</p>
|
|
7641
7994
|
* <p>You can specify the version id with either <code>Arn</code>, or with
|
|
7642
7995
|
* <code>TypeName</code> and <code>Type</code>.</p>
|
|
7643
|
-
* <p>If you
|
|
7996
|
+
* <p>If you don't specify a version, CloudFormation uses the default version of the
|
|
7644
7997
|
* extension in this account and region for testing.</p>
|
|
7645
7998
|
*/
|
|
7646
7999
|
VersionId?: string;
|
|
7647
8000
|
/**
|
|
7648
|
-
* <p>The S3 bucket to which CloudFormation delivers the contract test execution
|
|
7649
|
-
*
|
|
7650
|
-
*
|
|
8001
|
+
* <p>The S3 bucket to which CloudFormation delivers the contract test execution
|
|
8002
|
+
* logs.</p>
|
|
8003
|
+
* <p>CloudFormation delivers the logs by the time contract testing has completed and
|
|
8004
|
+
* the extension has been assigned a test type status of <code>PASSED</code> or
|
|
7651
8005
|
* <code>FAILED</code>.</p>
|
|
7652
8006
|
* <p>The user calling <code>TestType</code> must be able to access items in the specified S3
|
|
7653
8007
|
* bucket. Specifically, the user needs the following permissions:</p>
|
|
7654
8008
|
* <ul>
|
|
7655
8009
|
* <li>
|
|
7656
|
-
* <p>
|
|
8010
|
+
* <p>
|
|
8011
|
+
* <code>GetObject</code>
|
|
8012
|
+
* </p>
|
|
7657
8013
|
* </li>
|
|
7658
8014
|
* <li>
|
|
7659
|
-
* <p>
|
|
8015
|
+
* <p>
|
|
8016
|
+
* <code>PutObject</code>
|
|
8017
|
+
* </p>
|
|
7660
8018
|
* </li>
|
|
7661
8019
|
* </ul>
|
|
7662
8020
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and
|
|
7663
|
-
* Condition Keys for Amazon S3</a> in the <i>Amazon Web Services
|
|
7664
|
-
* Access Management User Guide</i>.</p>
|
|
8021
|
+
* Condition Keys for Amazon S3</a> in the <i>Amazon Web Services
|
|
8022
|
+
* Identity and Access Management User Guide</i>.</p>
|
|
7665
8023
|
*/
|
|
7666
8024
|
LogDeliveryBucket?: string;
|
|
7667
8025
|
}
|
|
@@ -7673,7 +8031,7 @@ export declare namespace TestTypeInput {
|
|
|
7673
8031
|
}
|
|
7674
8032
|
export interface TestTypeOutput {
|
|
7675
8033
|
/**
|
|
7676
|
-
* <p>The Amazon Resource
|
|
8034
|
+
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
7677
8035
|
*/
|
|
7678
8036
|
TypeVersionArn?: string;
|
|
7679
8037
|
}
|
|
@@ -7701,9 +8059,9 @@ export interface UpdateStackInput {
|
|
|
7701
8059
|
*/
|
|
7702
8060
|
TemplateBody?: string;
|
|
7703
8061
|
/**
|
|
7704
|
-
* <p>Location of file containing the template body. The URL must point to a template that
|
|
7705
|
-
* located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
7706
|
-
*
|
|
8062
|
+
* <p>Location of file containing the template body. The URL must point to a template that's
|
|
8063
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
8064
|
+
* go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
7707
8065
|
* in the CloudFormation User Guide.</p>
|
|
7708
8066
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
7709
8067
|
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
|
@@ -7753,18 +8111,19 @@ export interface UpdateStackInput {
|
|
|
7753
8111
|
* </p>
|
|
7754
8112
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
7755
8113
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
7756
|
-
*
|
|
7757
|
-
* of these capabilities.</p>
|
|
8114
|
+
* (IAM) users. For those stacks, you must explicitly acknowledge this
|
|
8115
|
+
* by specifying one of these capabilities.</p>
|
|
7758
8116
|
* <p>The following IAM resources require you to specify either the
|
|
7759
8117
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
7760
8118
|
* capability.</p>
|
|
7761
8119
|
* <ul>
|
|
7762
8120
|
* <li>
|
|
7763
|
-
* <p>If you have IAM resources, you can specify either
|
|
8121
|
+
* <p>If you have IAM resources, you can specify either
|
|
8122
|
+
* capability.</p>
|
|
7764
8123
|
* </li>
|
|
7765
8124
|
* <li>
|
|
7766
|
-
* <p>If you have IAM resources with custom names, you
|
|
7767
|
-
*
|
|
8125
|
+
* <p>If you have IAM resources with custom names, you
|
|
8126
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
7768
8127
|
* </li>
|
|
7769
8128
|
* <li>
|
|
7770
8129
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -7788,7 +8147,7 @@ export interface UpdateStackInput {
|
|
|
7788
8147
|
* </li>
|
|
7789
8148
|
* <li>
|
|
7790
8149
|
* <p>
|
|
7791
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
8150
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
7792
8151
|
* </p>
|
|
7793
8152
|
* </li>
|
|
7794
8153
|
* <li>
|
|
@@ -7811,12 +8170,11 @@ export interface UpdateStackInput {
|
|
|
7811
8170
|
* </li>
|
|
7812
8171
|
* <li>
|
|
7813
8172
|
* <p>
|
|
7814
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
8173
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
7815
8174
|
* </p>
|
|
7816
8175
|
* </li>
|
|
7817
8176
|
* </ul>
|
|
7818
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
7819
|
-
* Resources in CloudFormation Templates</a>.</p>
|
|
8177
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates</a>.</p>
|
|
7820
8178
|
* </li>
|
|
7821
8179
|
* <li>
|
|
7822
8180
|
* <p>
|
|
@@ -7836,9 +8194,9 @@ export interface UpdateStackInput {
|
|
|
7836
8194
|
* <important>
|
|
7837
8195
|
* <p>You should only update stacks directly from a stack template that contains
|
|
7838
8196
|
* macros if you know what processing the macro performs.</p>
|
|
7839
|
-
* <p>Each macro relies on an underlying Lambda service function for
|
|
7840
|
-
* templates. Be aware that the Lambda function owner can update the
|
|
7841
|
-
* operation without CloudFormation being notified.</p>
|
|
8197
|
+
* <p>Each macro relies on an underlying Lambda service function for
|
|
8198
|
+
* processing stack templates. Be aware that the Lambda function owner can update the
|
|
8199
|
+
* function operation without CloudFormation being notified.</p>
|
|
7842
8200
|
* </important>
|
|
7843
8201
|
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
|
|
7844
8202
|
* CloudFormation Macros to Perform Custom Processing on
|
|
@@ -7853,17 +8211,16 @@ export interface UpdateStackInput {
|
|
|
7853
8211
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
7854
8212
|
* <p>If the list of resource types doesn't include a resource that you're updating, the stack
|
|
7855
8213
|
* update fails. By default, CloudFormation grants permissions to all resource types.
|
|
7856
|
-
* Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
7857
|
-
* 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
|
|
7858
|
-
* Identity and Access Management</a>.</p>
|
|
8214
|
+
* Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with Identity and Access Management</a>.</p>
|
|
7859
8215
|
*/
|
|
7860
8216
|
ResourceTypes?: string[];
|
|
7861
8217
|
/**
|
|
7862
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
7863
|
-
*
|
|
7864
|
-
*
|
|
7865
|
-
*
|
|
7866
|
-
*
|
|
8218
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
8219
|
+
* that CloudFormation assumes to update the stack. CloudFormation uses the
|
|
8220
|
+
* role's credentials to make calls on your behalf. CloudFormation always uses this
|
|
8221
|
+
* role for all future operations on the stack. Provided that users have permission to operate
|
|
8222
|
+
* on the stack, CloudFormation uses this role even if the users don't have permission
|
|
8223
|
+
* to pass it. Ensure that the role grants least privilege.</p>
|
|
7867
8224
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
7868
8225
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
7869
8226
|
* session that is generated from your user credentials.</p>
|
|
@@ -7879,7 +8236,7 @@ export interface UpdateStackInput {
|
|
|
7879
8236
|
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
7880
8237
|
* both.</p>
|
|
7881
8238
|
* <p>You might update the stack policy, for example, in order to protect a new resource that
|
|
7882
|
-
* you created during a stack update. If you
|
|
8239
|
+
* you created during a stack update. If you don't specify a stack policy, the current policy
|
|
7883
8240
|
* that is associated with the stack is unchanged.</p>
|
|
7884
8241
|
*/
|
|
7885
8242
|
StackPolicyBody?: string;
|
|
@@ -7889,7 +8246,7 @@ export interface UpdateStackInput {
|
|
|
7889
8246
|
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
7890
8247
|
* not both.</p>
|
|
7891
8248
|
* <p>You might update the stack policy, for example, in order to protect a new resource that
|
|
7892
|
-
* you created during a stack update. If you
|
|
8249
|
+
* you created during a stack update. If you don't specify a stack policy, the current policy
|
|
7893
8250
|
* that is associated with the stack is unchanged.</p>
|
|
7894
8251
|
*/
|
|
7895
8252
|
StackPolicyURL?: string;
|
|
@@ -7961,7 +8318,7 @@ export interface UpdateStackInstancesInput {
|
|
|
7961
8318
|
/**
|
|
7962
8319
|
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for
|
|
7963
8320
|
* which you want to update parameter values for stack instances. The overridden parameter
|
|
7964
|
-
* values will be applied to all stack instances in the specified accounts and Regions.</p>
|
|
8321
|
+
* values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.</p>
|
|
7965
8322
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
7966
8323
|
* both.</p>
|
|
7967
8324
|
*/
|
|
@@ -7977,16 +8334,18 @@ export interface UpdateStackInstancesInput {
|
|
|
7977
8334
|
*/
|
|
7978
8335
|
DeploymentTargets?: DeploymentTargets;
|
|
7979
8336
|
/**
|
|
7980
|
-
* <p>The names of one or more Regions in which you want to update
|
|
7981
|
-
* instances. The overridden parameter values will be applied to
|
|
7982
|
-
* specified accounts and Regions.</p>
|
|
8337
|
+
* <p>The names of one or more Amazon Web Services Regions in which you want to update
|
|
8338
|
+
* parameter values for stack instances. The overridden parameter values will be applied to
|
|
8339
|
+
* all stack instances in the specified accounts and Amazon Web Services Regions.</p>
|
|
7983
8340
|
*/
|
|
7984
8341
|
Regions: string[] | undefined;
|
|
7985
8342
|
/**
|
|
7986
|
-
* <p>
|
|
7987
|
-
* instances
|
|
8343
|
+
* <p>A list of input parameters whose values you want to update for the specified stack
|
|
8344
|
+
* instances.</p>
|
|
7988
8345
|
* <p>Any overridden parameter values will be applied to all stack instances in the specified
|
|
7989
|
-
* accounts and Regions. When specifying parameters and their values, be
|
|
8346
|
+
* accounts and Amazon Web Services Regions. When specifying parameters and their values, be
|
|
8347
|
+
* aware of how CloudFormation sets parameter values during stack instance update
|
|
8348
|
+
* operations:</p>
|
|
7990
8349
|
* <ul>
|
|
7991
8350
|
* <li>
|
|
7992
8351
|
* <p>To override the current value for a parameter, include the parameter and specify
|
|
@@ -7994,19 +8353,19 @@ export interface UpdateStackInstancesInput {
|
|
|
7994
8353
|
* </li>
|
|
7995
8354
|
* <li>
|
|
7996
8355
|
* <p>To leave an overridden parameter set to its present value, include the parameter
|
|
7997
|
-
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You
|
|
8356
|
+
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You can't specify
|
|
7998
8357
|
* both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
7999
8358
|
* </li>
|
|
8000
8359
|
* <li>
|
|
8001
8360
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
8002
|
-
* specify a parameter list but
|
|
8361
|
+
* specify a parameter list but don't include the parameter in the list.</p>
|
|
8003
8362
|
* </li>
|
|
8004
8363
|
* <li>
|
|
8005
|
-
* <p>To leave all parameters set to their present values,
|
|
8364
|
+
* <p>To leave all parameters set to their present values, don't specify this property
|
|
8006
8365
|
* at all.</p>
|
|
8007
8366
|
* </li>
|
|
8008
8367
|
* </ul>
|
|
8009
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance
|
|
8368
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance aren't
|
|
8010
8369
|
* updated, but retain their overridden value.</p>
|
|
8011
8370
|
* <p>You can only override the parameter <i>values</i> that are specified in
|
|
8012
8371
|
* the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to
|
|
@@ -8022,22 +8381,23 @@ export interface UpdateStackInstancesInput {
|
|
|
8022
8381
|
*/
|
|
8023
8382
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8024
8383
|
/**
|
|
8025
|
-
* <p>The unique identifier for this stack set operation
|
|
8384
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
8026
8385
|
* <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
|
|
8027
8386
|
* multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
8028
|
-
* <p>If you don't specify an operation ID, the SDK generates one
|
|
8029
|
-
*
|
|
8387
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
8388
|
+
* automatically.</p>
|
|
8030
8389
|
*/
|
|
8031
8390
|
OperationId?: string;
|
|
8032
8391
|
/**
|
|
8033
8392
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
8034
|
-
* administrator in the organization's management account or as a delegated
|
|
8035
|
-
* member account.</p>
|
|
8393
|
+
* administrator in the organization's management account or as a delegated
|
|
8394
|
+
* administrator in a member account.</p>
|
|
8036
8395
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
8037
8396
|
* self-managed permissions.</p>
|
|
8038
8397
|
* <ul>
|
|
8039
8398
|
* <li>
|
|
8040
|
-
* <p>If you are signed in to the management account, specify
|
|
8399
|
+
* <p>If you are signed in to the management account, specify
|
|
8400
|
+
* <code>SELF</code>.</p>
|
|
8041
8401
|
* </li>
|
|
8042
8402
|
* <li>
|
|
8043
8403
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -8057,7 +8417,7 @@ export declare namespace UpdateStackInstancesInput {
|
|
|
8057
8417
|
}
|
|
8058
8418
|
export interface UpdateStackInstancesOutput {
|
|
8059
8419
|
/**
|
|
8060
|
-
* <p>The unique identifier for this stack set operation
|
|
8420
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
8061
8421
|
*/
|
|
8062
8422
|
OperationId?: string;
|
|
8063
8423
|
}
|
|
@@ -8087,12 +8447,12 @@ export interface UpdateStackSetInput {
|
|
|
8087
8447
|
TemplateBody?: string;
|
|
8088
8448
|
/**
|
|
8089
8449
|
* <p>The location of the file that contains the template body. The URL must point to a
|
|
8090
|
-
* template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a
|
|
8091
|
-
* Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
8450
|
+
* template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a
|
|
8451
|
+
* Systems Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
8092
8452
|
* in the CloudFormation User Guide.</p>
|
|
8093
8453
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
8094
8454
|
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
|
8095
|
-
* <code>UsePreviousTemplate</code> to true
|
|
8455
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
|
8096
8456
|
*/
|
|
8097
8457
|
TemplateURL?: string;
|
|
8098
8458
|
/**
|
|
@@ -8100,11 +8460,11 @@ export interface UpdateStackSetInput {
|
|
|
8100
8460
|
* updating.</p>
|
|
8101
8461
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
8102
8462
|
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
|
8103
|
-
* <code>UsePreviousTemplate</code> to true
|
|
8463
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
|
8104
8464
|
*/
|
|
8105
8465
|
UsePreviousTemplate?: boolean;
|
|
8106
8466
|
/**
|
|
8107
|
-
* <p>A list of input parameters for the stack set template
|
|
8467
|
+
* <p>A list of input parameters for the stack set template.</p>
|
|
8108
8468
|
*/
|
|
8109
8469
|
Parameters?: Parameter[];
|
|
8110
8470
|
/**
|
|
@@ -8118,18 +8478,19 @@ export interface UpdateStackSetInput {
|
|
|
8118
8478
|
* </p>
|
|
8119
8479
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
8120
8480
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
8121
|
-
*
|
|
8122
|
-
* specifying one of these capabilities.</p>
|
|
8481
|
+
* (IAM) users. For those stacks sets, you must explicitly acknowledge
|
|
8482
|
+
* this by specifying one of these capabilities.</p>
|
|
8123
8483
|
* <p>The following IAM resources require you to specify either the
|
|
8124
8484
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
8125
8485
|
* capability.</p>
|
|
8126
8486
|
* <ul>
|
|
8127
8487
|
* <li>
|
|
8128
|
-
* <p>If you have IAM resources, you can specify either
|
|
8488
|
+
* <p>If you have IAM resources, you can specify either
|
|
8489
|
+
* capability.</p>
|
|
8129
8490
|
* </li>
|
|
8130
8491
|
* <li>
|
|
8131
|
-
* <p>If you have IAM resources with custom names, you
|
|
8132
|
-
*
|
|
8492
|
+
* <p>If you have IAM resources with custom names, you
|
|
8493
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
8133
8494
|
* </li>
|
|
8134
8495
|
* <li>
|
|
8135
8496
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -8180,8 +8541,7 @@ export interface UpdateStackSetInput {
|
|
|
8180
8541
|
* </p>
|
|
8181
8542
|
* </li>
|
|
8182
8543
|
* </ul>
|
|
8183
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
8184
|
-
* Resources in CloudFormation Templates</a>.</p>
|
|
8544
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates</a>.</p>
|
|
8185
8545
|
* </li>
|
|
8186
8546
|
* <li>
|
|
8187
8547
|
* <p>
|
|
@@ -8205,33 +8565,33 @@ export interface UpdateStackSetInput {
|
|
|
8205
8565
|
Capabilities?: (Capability | string)[];
|
|
8206
8566
|
/**
|
|
8207
8567
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
8208
|
-
* CloudFormation also propagates these tags to supported resources that are
|
|
8209
|
-
*
|
|
8568
|
+
* CloudFormation also propagates these tags to supported resources that are created in
|
|
8569
|
+
* the stacks. You can specify a maximum number of 50 tags.</p>
|
|
8210
8570
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are
|
|
8211
8571
|
* currently associated with this stack set. This means:</p>
|
|
8212
8572
|
* <ul>
|
|
8213
8573
|
* <li>
|
|
8214
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the
|
|
8215
|
-
*
|
|
8574
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
|
8575
|
+
* tags.</p>
|
|
8216
8576
|
* </li>
|
|
8217
8577
|
* <li>
|
|
8218
8578
|
* <p>If you specify <i>any</i> tags using this parameter, you must
|
|
8219
8579
|
* specify <i>all</i> the tags that you want associated with this stack
|
|
8220
|
-
* set, even tags you've
|
|
8580
|
+
* set, even tags you've specified before (for example, when creating the stack set or
|
|
8221
8581
|
* during a previous update of the stack set.). Any tags that you don't include in the
|
|
8222
8582
|
* updated list of tags are removed from the stack set, and therefore from the stacks
|
|
8223
|
-
* and resources as well
|
|
8583
|
+
* and resources as well.</p>
|
|
8224
8584
|
* </li>
|
|
8225
8585
|
* <li>
|
|
8226
|
-
* <p>If you specify an empty value, CloudFormation removes all currently
|
|
8227
|
-
*
|
|
8586
|
+
* <p>If you specify an empty value, CloudFormation removes all currently associated
|
|
8587
|
+
* tags.</p>
|
|
8228
8588
|
* </li>
|
|
8229
8589
|
* </ul>
|
|
8230
|
-
* <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
|
|
8231
|
-
* If you omit tags that are currently associated with the stack set from the list
|
|
8232
|
-
* specify, CloudFormation assumes that you want to remove those tags from the
|
|
8233
|
-
* set, and checks to see if you have permission to untag resources. If you don't have
|
|
8234
|
-
* necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an
|
|
8590
|
+
* <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
|
|
8591
|
+
* resources. If you omit tags that are currently associated with the stack set from the list
|
|
8592
|
+
* of tags you specify, CloudFormation assumes that you want to remove those tags from the
|
|
8593
|
+
* stack set, and checks to see if you have permission to untag resources. If you don't have
|
|
8594
|
+
* the necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an
|
|
8235
8595
|
* <code>access denied</code> error, and the stack set is not updated.</p>
|
|
8236
8596
|
*/
|
|
8237
8597
|
Tags?: Tag[];
|
|
@@ -8240,25 +8600,26 @@ export interface UpdateStackSetInput {
|
|
|
8240
8600
|
*/
|
|
8241
8601
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8242
8602
|
/**
|
|
8243
|
-
* <p>The Amazon Resource Number (ARN) of the IAM role to use to update this
|
|
8244
|
-
*
|
|
8245
|
-
*
|
|
8246
|
-
*
|
|
8247
|
-
*
|
|
8248
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
8603
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role to use to update this
|
|
8604
|
+
* stack set.</p>
|
|
8605
|
+
* <p>Specify an IAM role only if you are using customized administrator roles
|
|
8606
|
+
* to control which users or groups can manage specific stack sets within the same
|
|
8607
|
+
* administrator account. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Granting Permissions for Stack Set
|
|
8608
|
+
* Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
8249
8609
|
* <p>If you specified a customized administrator role when you created the stack set, you
|
|
8250
8610
|
* must specify a customized administrator role, even if it is the same customized
|
|
8251
8611
|
* administrator role used with this stack set previously.</p>
|
|
8252
8612
|
*/
|
|
8253
8613
|
AdministrationRoleARN?: string;
|
|
8254
8614
|
/**
|
|
8255
|
-
* <p>The name of the IAM execution role to use to update the stack set. If you
|
|
8256
|
-
* an execution role, CloudFormation uses the
|
|
8257
|
-
*
|
|
8258
|
-
*
|
|
8259
|
-
*
|
|
8260
|
-
*
|
|
8261
|
-
* If you
|
|
8615
|
+
* <p>The name of the IAM execution role to use to update the stack set. If you
|
|
8616
|
+
* do not specify an execution role, CloudFormation uses the
|
|
8617
|
+
* <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set
|
|
8618
|
+
* operation.</p>
|
|
8619
|
+
* <p>Specify an IAM role only if you are using customized execution roles to
|
|
8620
|
+
* control which stack resources users and groups can include in their stack sets.</p>
|
|
8621
|
+
* <p>If you specify a customized execution role, CloudFormation uses that role to update the stack. If
|
|
8622
|
+
* you do not specify a customized execution role, CloudFormation performs the update using the role
|
|
8262
8623
|
* previously associated with the stack set, so long as you have permissions to perform
|
|
8263
8624
|
* operations on the stack set.</p>
|
|
8264
8625
|
*/
|
|
@@ -8270,18 +8631,18 @@ export interface UpdateStackSetInput {
|
|
|
8270
8631
|
* <code>DeploymentTargets</code> or <code>Regions</code>.</p>
|
|
8271
8632
|
* <p>If the stack set update includes changes to the template (that is, if
|
|
8272
8633
|
* <code>TemplateBody</code> or <code>TemplateURL</code> is specified), or the
|
|
8273
|
-
* <code>Parameters</code>, CloudFormation marks all stack instances with a status
|
|
8274
|
-
*
|
|
8275
|
-
* and Regions. If the stack set update
|
|
8276
|
-
* parameters, CloudFormation updates the stack instances in the specified
|
|
8277
|
-
* and Regions, while leaving all other stack instances with their existing stack
|
|
8278
|
-
* status.</p>
|
|
8634
|
+
* <code>Parameters</code>, CloudFormation marks all stack instances with a status of
|
|
8635
|
+
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts
|
|
8636
|
+
* and Amazon Web Services Regions. If the stack set update doesn't include changes to the
|
|
8637
|
+
* template or parameters, CloudFormation updates the stack instances in the specified
|
|
8638
|
+
* accounts and Regions, while leaving all other stack instances with their existing stack
|
|
8639
|
+
* instance status.</p>
|
|
8279
8640
|
*/
|
|
8280
8641
|
DeploymentTargets?: DeploymentTargets;
|
|
8281
8642
|
/**
|
|
8282
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
8283
|
-
* modify <code>PermissionModel</code> if there are stack instances
|
|
8284
|
-
* set.</p>
|
|
8643
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
8644
|
+
* created. You cannot modify <code>PermissionModel</code> if there are stack instances
|
|
8645
|
+
* associated with your stack set.</p>
|
|
8285
8646
|
* <ul>
|
|
8286
8647
|
* <li>
|
|
8287
8648
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -8291,8 +8652,7 @@ export interface UpdateStackSetInput {
|
|
|
8291
8652
|
* </li>
|
|
8292
8653
|
* <li>
|
|
8293
8654
|
* <p>With <code>service-managed</code> permissions, StackSets automatically creates the
|
|
8294
|
-
*
|
|
8295
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
8655
|
+
* IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant Service-Managed Stack Set Permissions</a>.</p>
|
|
8296
8656
|
* </li>
|
|
8297
8657
|
* </ul>
|
|
8298
8658
|
*/
|
|
@@ -8301,38 +8661,40 @@ export interface UpdateStackSetInput {
|
|
|
8301
8661
|
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to
|
|
8302
8662
|
* Organizations accounts that are added to a target organization or organizational
|
|
8303
8663
|
* unit (OU).</p>
|
|
8304
|
-
* <p>If you specify <code>AutoDeployment</code>,
|
|
8305
|
-
*
|
|
8664
|
+
* <p>If you specify <code>AutoDeployment</code>, don't specify <code>DeploymentTargets</code>
|
|
8665
|
+
* or <code>Regions</code>.</p>
|
|
8306
8666
|
*/
|
|
8307
8667
|
AutoDeployment?: AutoDeployment;
|
|
8308
8668
|
/**
|
|
8309
|
-
* <p>The unique ID for this stack set operation
|
|
8669
|
+
* <p>The unique ID for this stack set operation.</p>
|
|
8310
8670
|
* <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
|
|
8311
8671
|
* multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
8312
8672
|
* <p>If you don't specify an operation ID, CloudFormation generates one
|
|
8313
8673
|
* automatically.</p>
|
|
8314
8674
|
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
8315
|
-
* whose status is <code>OUTDATED</code
|
|
8675
|
+
* whose status is <code>OUTDATED</code>.</p>
|
|
8316
8676
|
*/
|
|
8317
8677
|
OperationId?: string;
|
|
8318
8678
|
/**
|
|
8319
8679
|
* <p>[Self-managed permissions] The accounts in which to update associated stack instances.
|
|
8320
|
-
* If you specify accounts, you must also specify the Regions in which to
|
|
8321
|
-
* instances.</p>
|
|
8680
|
+
* If you specify accounts, you must also specify the Amazon Web Services Regions in which to
|
|
8681
|
+
* update stack set instances.</p>
|
|
8322
8682
|
* <p>To update <i>all</i> the stack instances associated with this stack set,
|
|
8323
|
-
*
|
|
8683
|
+
* don't specify the <code>Accounts</code> or <code>Regions</code> properties.</p>
|
|
8324
8684
|
* <p>If the stack set update includes changes to the template (that is, if the
|
|
8325
8685
|
* <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the
|
|
8326
8686
|
* <code>Parameters</code> property, CloudFormation marks all stack instances with a status of
|
|
8327
8687
|
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts
|
|
8328
|
-
* and Regions. If the stack set update does not include changes to the
|
|
8329
|
-
* parameters, CloudFormation updates the stack instances in the specified accounts and
|
|
8330
|
-
*
|
|
8688
|
+
* and Amazon Web Services Regions. If the stack set update does not include changes to the
|
|
8689
|
+
* template or parameters, CloudFormation updates the stack instances in the specified accounts and
|
|
8690
|
+
* Amazon Web Services Regions, while leaving all other stack instances with their existing
|
|
8691
|
+
* stack instance status.</p>
|
|
8331
8692
|
*/
|
|
8332
8693
|
Accounts?: string[];
|
|
8333
8694
|
/**
|
|
8334
|
-
* <p>The Regions in which to update associated stack instances. If you
|
|
8335
|
-
* must also specify accounts in which to update stack set
|
|
8695
|
+
* <p>The Amazon Web Services Regions in which to update associated stack instances. If you
|
|
8696
|
+
* specify Regions, you must also specify accounts in which to update stack set
|
|
8697
|
+
* instances.</p>
|
|
8336
8698
|
* <p>To update <i>all</i> the stack instances associated with this stack set,
|
|
8337
8699
|
* do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p>
|
|
8338
8700
|
* <p>If the stack set update includes changes to the template (that is, if the
|
|
@@ -8341,18 +8703,19 @@ export interface UpdateStackSetInput {
|
|
|
8341
8703
|
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts
|
|
8342
8704
|
* and Regions. If the stack set update does not include changes to the template or
|
|
8343
8705
|
* parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while
|
|
8344
|
-
* leaving all other stack instances with their existing stack instance status
|
|
8706
|
+
* leaving all other stack instances with their existing stack instance status.</p>
|
|
8345
8707
|
*/
|
|
8346
8708
|
Regions?: string[];
|
|
8347
8709
|
/**
|
|
8348
8710
|
* <p>[Service-managed permissions] Specifies whether you are acting as an account
|
|
8349
|
-
* administrator in the organization's management account or as a delegated
|
|
8350
|
-
* member account.</p>
|
|
8711
|
+
* administrator in the organization's management account or as a delegated
|
|
8712
|
+
* administrator in a member account.</p>
|
|
8351
8713
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
8352
8714
|
* self-managed permissions.</p>
|
|
8353
8715
|
* <ul>
|
|
8354
8716
|
* <li>
|
|
8355
|
-
* <p>If you are signed in to the management account, specify
|
|
8717
|
+
* <p>If you are signed in to the management account, specify
|
|
8718
|
+
* <code>SELF</code>.</p>
|
|
8356
8719
|
* </li>
|
|
8357
8720
|
* <li>
|
|
8358
8721
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -8430,8 +8793,8 @@ export interface ValidateTemplateInput {
|
|
|
8430
8793
|
TemplateBody?: string;
|
|
8431
8794
|
/**
|
|
8432
8795
|
* <p>Location of file containing the template body. The URL must point to a template (max
|
|
8433
|
-
* size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager
|
|
8434
|
-
* For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
8796
|
+
* size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager
|
|
8797
|
+
* document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
8435
8798
|
* in the CloudFormation User Guide.</p>
|
|
8436
8799
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
8437
8800
|
* both are passed, only <code>TemplateBody</code> is used.</p>
|
|
@@ -8485,11 +8848,13 @@ export interface ValidateTemplateOutput {
|
|
|
8485
8848
|
*/
|
|
8486
8849
|
Description?: string;
|
|
8487
8850
|
/**
|
|
8488
|
-
* <p>The capabilities found within the template. If your template contains IAM
|
|
8489
|
-
* must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this
|
|
8490
|
-
* use the <a>CreateStack</a> or <a>UpdateStack</a>
|
|
8491
|
-
* template; otherwise, those actions return an InsufficientCapabilities
|
|
8492
|
-
*
|
|
8851
|
+
* <p>The capabilities found within the template. If your template contains IAM
|
|
8852
|
+
* resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this
|
|
8853
|
+
* parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a>
|
|
8854
|
+
* actions with your template; otherwise, those actions return an InsufficientCapabilities
|
|
8855
|
+
* error.</p>
|
|
8856
|
+
* <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
|
|
8857
|
+
* Templates</a>.</p>
|
|
8493
8858
|
*/
|
|
8494
8859
|
Capabilities?: (Capability | string)[];
|
|
8495
8860
|
/**
|