@aws-sdk/client-cloudformation 3.51.0 → 3.52.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/README.md +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/models/models_0.js +65 -5
- package/dist-cjs/protocols/Aws_query.js +208 -3
- 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/models/models_0.js +50 -0
- package/dist-es/protocols/Aws_query.js +211 -0
- 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/models/models_0.d.ts +1009 -733
- package/dist-types/protocols/Aws_query.d.ts +3 -0
- package/dist-types/ts3.4/CloudFormation.d.ts +5 -0
- package/dist-types/ts3.4/CloudFormationClient.d.ts +3 -2
- package/dist-types/ts3.4/commands/DescribeChangeSetHooksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +116 -2
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
- package/package.json +34 -34
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
2
|
export declare type AccountGateStatus = "FAILED" | "SKIPPED" | "SUCCEEDED";
|
|
3
3
|
/**
|
|
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
|
|
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 account and
|
|
5
|
+
* Region.</p>
|
|
6
|
+
* <p>For each account and Region, CloudFormation lets you specify a Lambda
|
|
7
|
+
* function that encapsulates any requirements that must be met before CloudFormation
|
|
8
|
+
* can proceed with a stack set operation in that account and Region. CloudFormation
|
|
9
9
|
* invokes the function each time a stack set operation is requested for that account and
|
|
10
10
|
* Region; if the function returns <code>FAILED</code>, CloudFormation cancels the
|
|
11
11
|
* operation in that account and Region, and sets the stack set operation result status for
|
|
@@ -20,15 +20,15 @@ export interface AccountGateResult {
|
|
|
20
20
|
* <li>
|
|
21
21
|
* <p>
|
|
22
22
|
* <code>SUCCEEDED</code>: The account gate function has determined that the account
|
|
23
|
-
* and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and
|
|
24
|
-
*
|
|
23
|
+
* and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and
|
|
24
|
+
* Region.</p>
|
|
25
25
|
* </li>
|
|
26
26
|
* <li>
|
|
27
27
|
* <p>
|
|
28
28
|
* <code>FAILED</code>: The account gate function has determined that the account and
|
|
29
|
-
* Region
|
|
30
|
-
*
|
|
31
|
-
* <code>FAILED</code
|
|
29
|
+
* 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
|
|
30
|
+
* the stack set operation result status for that account and Region to
|
|
31
|
+
* <code>FAILED</code>.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
34
|
* <p>
|
|
@@ -36,13 +36,13 @@ export interface AccountGateResult {
|
|
|
36
36
|
* function for this account and Region, for one of the following reasons:</p>
|
|
37
37
|
* <ul>
|
|
38
38
|
* <li>
|
|
39
|
-
* <p>An account gate function
|
|
39
|
+
* <p>An account gate function hasn't been specified for the account and Region.
|
|
40
40
|
* CloudFormation proceeds with the stack set operation in this account
|
|
41
41
|
* and Region.</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* <li>
|
|
44
44
|
* <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set
|
|
45
|
-
*
|
|
45
|
+
* administration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and
|
|
46
46
|
* Region.</p>
|
|
47
47
|
* </li>
|
|
48
48
|
* <li>
|
|
@@ -68,7 +68,7 @@ export declare namespace AccountGateResult {
|
|
|
68
68
|
const filterSensitiveLog: (obj: AccountGateResult) => any;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* <p>The AccountLimit data type
|
|
71
|
+
* <p>The AccountLimit data type.</p>
|
|
72
72
|
* <p>CloudFormation has the following limits per account:</p>
|
|
73
73
|
* <ul>
|
|
74
74
|
* <li>
|
|
@@ -82,7 +82,8 @@ export declare namespace AccountGateResult {
|
|
|
82
82
|
* </li>
|
|
83
83
|
* </ul>
|
|
84
84
|
* <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
|
|
85
|
+
* limits, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
86
|
+
* quotas</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
86
87
|
*/
|
|
87
88
|
export interface AccountLimit {
|
|
88
89
|
/**
|
|
@@ -93,7 +94,7 @@ export interface AccountLimit {
|
|
|
93
94
|
*/
|
|
94
95
|
Name?: string;
|
|
95
96
|
/**
|
|
96
|
-
* <p>The value that
|
|
97
|
+
* <p>The value that's associated with the account limit name.</p>
|
|
97
98
|
*/
|
|
98
99
|
Value?: number;
|
|
99
100
|
}
|
|
@@ -108,12 +109,12 @@ export declare namespace AccountLimit {
|
|
|
108
109
|
*/
|
|
109
110
|
export interface LoggingConfig {
|
|
110
111
|
/**
|
|
111
|
-
* <p>The ARN of the role that CloudFormation should assume
|
|
112
|
-
* to CloudWatch
|
|
112
|
+
* <p>The Amazon Resource Name (ARN) of the role that CloudFormation should assume
|
|
113
|
+
* when sending log entries to CloudWatch Logs.</p>
|
|
113
114
|
*/
|
|
114
115
|
LogRoleArn: string | undefined;
|
|
115
116
|
/**
|
|
116
|
-
* <p>The Amazon CloudWatch
|
|
117
|
+
* <p>The Amazon CloudWatch Logs group to which CloudFormation sends error logging
|
|
117
118
|
* information when invoking the extension's handlers.</p>
|
|
118
119
|
*/
|
|
119
120
|
LogGroupName: string | undefined;
|
|
@@ -125,6 +126,7 @@ export declare namespace LoggingConfig {
|
|
|
125
126
|
const filterSensitiveLog: (obj: LoggingConfig) => any;
|
|
126
127
|
}
|
|
127
128
|
export declare enum ThirdPartyType {
|
|
129
|
+
HOOK = "HOOK",
|
|
128
130
|
MODULE = "MODULE",
|
|
129
131
|
RESOURCE = "RESOURCE"
|
|
130
132
|
}
|
|
@@ -159,9 +161,9 @@ export interface ActivateTypeInput {
|
|
|
159
161
|
TypeName?: string;
|
|
160
162
|
/**
|
|
161
163
|
* <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>
|
|
164
|
+
* an alias for the extension, CloudFormation treats the alias as the extension type
|
|
165
|
+
* name within this account and region. You must use the alias to refer to the extension in
|
|
166
|
+
* your templates, API calls, and CloudFormation console.</p>
|
|
165
167
|
* <p>An extension alias must be unique within a given account and region. You can activate
|
|
166
168
|
* the same public resource multiple times in the same account and region, using different
|
|
167
169
|
* type name aliases.</p>
|
|
@@ -179,7 +181,8 @@ export interface ActivateTypeInput {
|
|
|
179
181
|
*/
|
|
180
182
|
LoggingConfig?: LoggingConfig;
|
|
181
183
|
/**
|
|
182
|
-
* <p>The name of the IAM execution role to use to activate the
|
|
184
|
+
* <p>The name of the IAM execution role to use to activate the
|
|
185
|
+
* extension.</p>
|
|
183
186
|
*/
|
|
184
187
|
ExecutionRoleArn?: string;
|
|
185
188
|
/**
|
|
@@ -189,13 +192,13 @@ export interface ActivateTypeInput {
|
|
|
189
192
|
* <ul>
|
|
190
193
|
* <li>
|
|
191
194
|
* <p>
|
|
192
|
-
* <code>MAJOR</code>: CloudFormation updates the extension to the newest
|
|
193
|
-
* version, if one is available.</p>
|
|
195
|
+
* <code>MAJOR</code>: CloudFormation updates the extension to the newest
|
|
196
|
+
* major version, if one is available.</p>
|
|
194
197
|
* </li>
|
|
195
198
|
* <li>
|
|
196
199
|
* <p>
|
|
197
|
-
* <code>MINOR</code>: CloudFormation updates the extension to the newest
|
|
198
|
-
* version, if one is available.</p>
|
|
200
|
+
* <code>MINOR</code>: CloudFormation updates the extension to the newest
|
|
201
|
+
* minor version, if one is available.</p>
|
|
199
202
|
* </li>
|
|
200
203
|
* </ul>
|
|
201
204
|
*/
|
|
@@ -237,7 +240,7 @@ export interface CFNRegistryException extends __SmithyException, $MetadataBearer
|
|
|
237
240
|
Message?: string;
|
|
238
241
|
}
|
|
239
242
|
/**
|
|
240
|
-
* <p>The specified extension
|
|
243
|
+
* <p>The specified extension doesn't exist in the CloudFormation registry.</p>
|
|
241
244
|
*/
|
|
242
245
|
export interface TypeNotFoundException extends __SmithyException, $MetadataBearer {
|
|
243
246
|
name: "TypeNotFoundException";
|
|
@@ -279,13 +282,14 @@ export declare namespace AutoDeployment {
|
|
|
279
282
|
const filterSensitiveLog: (obj: AutoDeployment) => any;
|
|
280
283
|
}
|
|
281
284
|
/**
|
|
282
|
-
* <p>Identifying information for the configuration of a CloudFormation
|
|
285
|
+
* <p>Identifying information for the configuration of a CloudFormation
|
|
286
|
+
* extension.</p>
|
|
283
287
|
*/
|
|
284
288
|
export interface TypeConfigurationIdentifier {
|
|
285
289
|
/**
|
|
286
290
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and region.</p>
|
|
287
291
|
* <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
|
|
292
|
+
* 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
293
|
*/
|
|
290
294
|
TypeArn?: string;
|
|
291
295
|
/**
|
|
@@ -338,7 +342,8 @@ export interface BatchDescribeTypeConfigurationsError {
|
|
|
338
342
|
*/
|
|
339
343
|
ErrorMessage?: string;
|
|
340
344
|
/**
|
|
341
|
-
* <p>Identifying information for the configuration of a CloudFormation
|
|
345
|
+
* <p>Identifying information for the configuration of a CloudFormation
|
|
346
|
+
* extension.</p>
|
|
342
347
|
*/
|
|
343
348
|
TypeConfigurationIdentifier?: TypeConfigurationIdentifier;
|
|
344
349
|
}
|
|
@@ -349,8 +354,8 @@ export declare namespace BatchDescribeTypeConfigurationsError {
|
|
|
349
354
|
const filterSensitiveLog: (obj: BatchDescribeTypeConfigurationsError) => any;
|
|
350
355
|
}
|
|
351
356
|
/**
|
|
352
|
-
* <p>Detailed information concerning the specification of a CloudFormation extension
|
|
353
|
-
* given account and region.</p>
|
|
357
|
+
* <p>Detailed information concerning the specification of a CloudFormation extension
|
|
358
|
+
* in a given account and region.</p>
|
|
354
359
|
* <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
360
|
* <i>CloudFormation User Guide</i>.</p>
|
|
356
361
|
*/
|
|
@@ -367,21 +372,21 @@ export interface TypeConfigurationDetails {
|
|
|
367
372
|
Alias?: string;
|
|
368
373
|
/**
|
|
369
374
|
* <p>A JSON string specifying the configuration data for the extension, in this account and
|
|
370
|
-
* region
|
|
371
|
-
* <p>If a configuration
|
|
372
|
-
*
|
|
375
|
+
* region.</p>
|
|
376
|
+
* <p>If a configuration hasn't been set for a specified extension, CloudFormation
|
|
377
|
+
* returns <code>{}</code>.</p>
|
|
373
378
|
*/
|
|
374
379
|
Configuration?: string;
|
|
375
380
|
/**
|
|
376
381
|
* <p>When the configuration data was last updated for this extension.</p>
|
|
377
|
-
* <p>If a configuration
|
|
378
|
-
*
|
|
382
|
+
* <p>If a configuration hasn't been set for a specified extension, CloudFormation
|
|
383
|
+
* returns <code>null</code>.</p>
|
|
379
384
|
*/
|
|
380
385
|
LastUpdated?: Date;
|
|
381
386
|
/**
|
|
382
387
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and region.</p>
|
|
383
388
|
* <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
|
|
389
|
+
* 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
390
|
*/
|
|
386
391
|
TypeArn?: string;
|
|
387
392
|
/**
|
|
@@ -407,8 +412,8 @@ export interface BatchDescribeTypeConfigurationsOutput {
|
|
|
407
412
|
*/
|
|
408
413
|
Errors?: BatchDescribeTypeConfigurationsError[];
|
|
409
414
|
/**
|
|
410
|
-
* <p>A list of any of the specified extension configurations that CloudFormation
|
|
411
|
-
* process for any reason.</p>
|
|
415
|
+
* <p>A list of any of the specified extension configurations that CloudFormation
|
|
416
|
+
* could not process for any reason.</p>
|
|
412
417
|
*/
|
|
413
418
|
UnprocessedTypeConfigurations?: TypeConfigurationIdentifier[];
|
|
414
419
|
/**
|
|
@@ -424,7 +429,7 @@ export declare namespace BatchDescribeTypeConfigurationsOutput {
|
|
|
424
429
|
const filterSensitiveLog: (obj: BatchDescribeTypeConfigurationsOutput) => any;
|
|
425
430
|
}
|
|
426
431
|
/**
|
|
427
|
-
* <p>The specified extension configuration
|
|
432
|
+
* <p>The specified extension configuration can't be found.</p>
|
|
428
433
|
*/
|
|
429
434
|
export interface TypeConfigurationNotFoundException extends __SmithyException, $MetadataBearer {
|
|
430
435
|
name: "TypeConfigurationNotFoundException";
|
|
@@ -440,15 +445,15 @@ export declare enum CallAs {
|
|
|
440
445
|
*/
|
|
441
446
|
export interface CancelUpdateStackInput {
|
|
442
447
|
/**
|
|
443
|
-
* <p>The name or the unique stack ID that
|
|
448
|
+
* <p>The name or the unique stack ID that's associated with the stack.</p>
|
|
444
449
|
*/
|
|
445
450
|
StackName: string | undefined;
|
|
446
451
|
/**
|
|
447
452
|
* <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
|
-
*
|
|
453
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
454
|
+
* to cancel an update on a stack with the same name. You might retry
|
|
455
|
+
* <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully
|
|
456
|
+
* received them.</p>
|
|
452
457
|
*/
|
|
453
458
|
ClientRequestToken?: string;
|
|
454
459
|
}
|
|
@@ -551,15 +556,15 @@ export interface ResourceChangeDetail {
|
|
|
551
556
|
/**
|
|
552
557
|
* <p>Indicates whether CloudFormation can determine the target value, and whether the
|
|
553
558
|
* target value will change before you execute a change set.</p>
|
|
554
|
-
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the
|
|
555
|
-
*
|
|
559
|
+
* <p>For <code>Static</code> evaluations, CloudFormation can determine that the target
|
|
560
|
+
* value will change, and its value. For example, if you directly modify the
|
|
556
561
|
* <code>InstanceType</code> property of an EC2 instance, CloudFormation knows that
|
|
557
562
|
* this property value will change, and its value, so this is a <code>Static</code>
|
|
558
563
|
* evaluation.</p>
|
|
559
|
-
* <p>For <code>Dynamic</code> evaluations,
|
|
564
|
+
* <p>For <code>Dynamic</code> evaluations, can't determine the target value because it
|
|
560
565
|
* depends on the result of an intrinsic function, such as a <code>Ref</code> or
|
|
561
566
|
* <code>Fn::GetAtt</code> intrinsic function, when the stack is updated. For example, if
|
|
562
|
-
* your template includes a reference to a resource that
|
|
567
|
+
* your template includes a reference to a resource that's conditionally recreated, the value
|
|
563
568
|
* of the reference (the physical ID of the resource) might change, depending on if the
|
|
564
569
|
* resource is recreated. If the resource is recreated, it will have a new physical ID, so all
|
|
565
570
|
* references to that resource will also be updated.</p>
|
|
@@ -606,10 +611,9 @@ export interface ResourceChangeDetail {
|
|
|
606
611
|
ChangeSource?: ChangeSource | string;
|
|
607
612
|
/**
|
|
608
613
|
* <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>
|
|
614
|
+
* group that's specified by the <code>ChangeSource</code> field. For example, if you modified
|
|
615
|
+
* the value of the <code>KeyPairName</code> parameter, the <code>CausingEntity</code> is the
|
|
616
|
+
* name of the parameter (<code>KeyPairName</code>).</p>
|
|
613
617
|
* <p>If the <code>ChangeSource</code> value is <code>DirectModification</code>, no value is
|
|
614
618
|
* given for <code>CausingEntity</code>.</p>
|
|
615
619
|
*/
|
|
@@ -625,16 +629,16 @@ export declare namespace ResourceChangeDetail {
|
|
|
625
629
|
* <p>Contains information about the module from which the resource was created, if the
|
|
626
630
|
* resource was created from a module included in the stack template.</p>
|
|
627
631
|
* <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
|
-
*
|
|
632
|
+
* reuse resource configurations</a> in the
|
|
633
|
+
* <i>CloudFormation User Guide</i>.</p>
|
|
630
634
|
*/
|
|
631
635
|
export interface ModuleInfo {
|
|
632
636
|
/**
|
|
633
|
-
* <p>A
|
|
634
|
-
*
|
|
635
|
-
*
|
|
637
|
+
* <p>A concatenated list of the module type or types containing the resource. Module types
|
|
638
|
+
* are listed starting with the inner-most nested module, and separated by
|
|
639
|
+
* <code>/</code>.</p>
|
|
636
640
|
* <p>In the following example, the resource was created from a module of type
|
|
637
|
-
* <code>AWS::First::Example::MODULE</code>, that
|
|
641
|
+
* <code>AWS::First::Example::MODULE</code>, that's nested inside a parent module of type
|
|
638
642
|
* <code>AWS::Second::Example::MODULE</code>.</p>
|
|
639
643
|
* <p>
|
|
640
644
|
* <code>AWS::First::Example::MODULE/AWS::Second::Example::MODULE</code>
|
|
@@ -642,11 +646,11 @@ export interface ModuleInfo {
|
|
|
642
646
|
*/
|
|
643
647
|
TypeHierarchy?: string;
|
|
644
648
|
/**
|
|
645
|
-
* <p>A
|
|
646
|
-
*
|
|
649
|
+
* <p>A concatenated list of the logical IDs of the module or modules containing the resource.
|
|
650
|
+
* Modules are listed starting with the inner-most nested module, and separated by
|
|
647
651
|
* <code>/</code>.</p>
|
|
648
652
|
* <p>In the following example, the resource was created from a module, <code>moduleA</code>,
|
|
649
|
-
* that
|
|
653
|
+
* that's nested inside a parent module, <code>moduleB</code>.</p>
|
|
650
654
|
* <p>
|
|
651
655
|
* <code>moduleA/moduleB</code>
|
|
652
656
|
* </p>
|
|
@@ -673,10 +677,10 @@ export declare enum Replacement {
|
|
|
673
677
|
*/
|
|
674
678
|
export interface ResourceChange {
|
|
675
679
|
/**
|
|
676
|
-
* <p>The action that CloudFormation takes on the resource, such as <code>Add</code>
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
+
* <p>The action that CloudFormation takes on the resource, such as <code>Add</code> (adds
|
|
681
|
+
* a new resource), <code>Modify</code> (changes a resource), <code>Remove</code> (deletes a
|
|
682
|
+
* resource), <code>Import</code> (imports a resource), or <code>Dynamic</code> (exact action
|
|
683
|
+
* for the resource can't be determined).</p>
|
|
680
684
|
*/
|
|
681
685
|
Action?: ChangeAction | string;
|
|
682
686
|
/**
|
|
@@ -689,14 +693,13 @@ export interface ResourceChange {
|
|
|
689
693
|
*/
|
|
690
694
|
PhysicalResourceId?: string;
|
|
691
695
|
/**
|
|
692
|
-
* <p>The type of CloudFormation resource, such as
|
|
693
|
-
* <code>AWS::S3::Bucket</code>.</p>
|
|
696
|
+
* <p>The type of CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>
|
|
694
697
|
*/
|
|
695
698
|
ResourceType?: string;
|
|
696
699
|
/**
|
|
697
|
-
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will
|
|
698
|
-
*
|
|
699
|
-
*
|
|
700
|
+
* <p>For the <code>Modify</code> action, indicates whether CloudFormation will replace
|
|
701
|
+
* the resource by creating a new one and deleting the old one. This value depends on the
|
|
702
|
+
* value of the <code>RequiresRecreation</code> property in the
|
|
700
703
|
* <code>ResourceTargetDefinition</code> structure. For example, if the
|
|
701
704
|
* <code>RequiresRecreation</code> field is <code>Always</code> and the
|
|
702
705
|
* <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is
|
|
@@ -718,7 +721,7 @@ export interface ResourceChange {
|
|
|
718
721
|
/**
|
|
719
722
|
* <p>For the <code>Modify</code> action, a list of <code>ResourceChangeDetail</code>
|
|
720
723
|
* structures that describes the changes that CloudFormation will make to the
|
|
721
|
-
* resource
|
|
724
|
+
* resource.</p>
|
|
722
725
|
*/
|
|
723
726
|
Details?: ResourceChangeDetail[];
|
|
724
727
|
/**
|
|
@@ -741,15 +744,20 @@ export declare enum ChangeType {
|
|
|
741
744
|
Resource = "Resource"
|
|
742
745
|
}
|
|
743
746
|
/**
|
|
744
|
-
* <p>The <code>Change</code> structure describes the changes CloudFormation will
|
|
745
|
-
*
|
|
747
|
+
* <p>The <code>Change</code> structure describes the changes CloudFormation will perform
|
|
748
|
+
* if you execute the change set.</p>
|
|
746
749
|
*/
|
|
747
750
|
export interface Change {
|
|
748
751
|
/**
|
|
749
|
-
* <p>The type of entity that CloudFormation changes. Currently, the only entity type
|
|
750
|
-
*
|
|
752
|
+
* <p>The type of entity that CloudFormation changes. Currently, the only entity type is
|
|
753
|
+
* <code>Resource</code>.</p>
|
|
751
754
|
*/
|
|
752
755
|
Type?: ChangeType | string;
|
|
756
|
+
/**
|
|
757
|
+
* <p>Is either <code>null</code>, if no hooks invoke for the resource, or contains the number
|
|
758
|
+
* of hooks that will invoke for the resource.</p>
|
|
759
|
+
*/
|
|
760
|
+
HookInvocationCount?: number;
|
|
753
761
|
/**
|
|
754
762
|
* <p>A <code>ResourceChange</code> structure that describes the resource and action that
|
|
755
763
|
* CloudFormation will perform.</p>
|
|
@@ -762,9 +770,153 @@ export declare namespace Change {
|
|
|
762
770
|
*/
|
|
763
771
|
const filterSensitiveLog: (obj: Change) => any;
|
|
764
772
|
}
|
|
773
|
+
export declare enum HookFailureMode {
|
|
774
|
+
FAIL = "FAIL",
|
|
775
|
+
WARN = "WARN"
|
|
776
|
+
}
|
|
777
|
+
export declare enum HookInvocationPoint {
|
|
778
|
+
PRE_PROVISION = "PRE_PROVISION"
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* <p>Specifies <code>RESOURCE</code> type target details for activated hooks.</p>
|
|
782
|
+
*/
|
|
783
|
+
export interface ChangeSetHookResourceTargetDetails {
|
|
784
|
+
/**
|
|
785
|
+
* <p>The resource's logical ID, which is defined in the stack's template.</p>
|
|
786
|
+
*/
|
|
787
|
+
LogicalResourceId?: string;
|
|
788
|
+
/**
|
|
789
|
+
* <p>The type of CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>
|
|
790
|
+
*/
|
|
791
|
+
ResourceType?: string;
|
|
792
|
+
/**
|
|
793
|
+
* <p>Specifies the action of the resource.</p>
|
|
794
|
+
*/
|
|
795
|
+
ResourceAction?: ChangeAction | string;
|
|
796
|
+
}
|
|
797
|
+
export declare namespace ChangeSetHookResourceTargetDetails {
|
|
798
|
+
/**
|
|
799
|
+
* @internal
|
|
800
|
+
*/
|
|
801
|
+
const filterSensitiveLog: (obj: ChangeSetHookResourceTargetDetails) => any;
|
|
802
|
+
}
|
|
803
|
+
export declare enum HookTargetType {
|
|
804
|
+
RESOURCE = "RESOURCE"
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* <p>Specifies target details for an activated hook.</p>
|
|
808
|
+
*/
|
|
809
|
+
export interface ChangeSetHookTargetDetails {
|
|
810
|
+
/**
|
|
811
|
+
* <p>The name of the type.</p>
|
|
812
|
+
*/
|
|
813
|
+
TargetType?: HookTargetType | string;
|
|
814
|
+
/**
|
|
815
|
+
* <p>Required if <code>TargetType</code> is <code>RESOURCE</code>.</p>
|
|
816
|
+
*/
|
|
817
|
+
ResourceTargetDetails?: ChangeSetHookResourceTargetDetails;
|
|
818
|
+
}
|
|
819
|
+
export declare namespace ChangeSetHookTargetDetails {
|
|
820
|
+
/**
|
|
821
|
+
* @internal
|
|
822
|
+
*/
|
|
823
|
+
const filterSensitiveLog: (obj: ChangeSetHookTargetDetails) => any;
|
|
824
|
+
}
|
|
825
|
+
/**
|
|
826
|
+
* <p>Specifies the resource, the hook, and the hook version to be invoked.</p>
|
|
827
|
+
*/
|
|
828
|
+
export interface ChangeSetHook {
|
|
829
|
+
/**
|
|
830
|
+
* <p>Specifies the points in provisioning logic where a hook is invoked.</p>
|
|
831
|
+
*/
|
|
832
|
+
InvocationPoint?: HookInvocationPoint | string;
|
|
833
|
+
/**
|
|
834
|
+
* <p>Specify the hook failure mode for non-compliant resources in the followings ways.</p>
|
|
835
|
+
* <ul>
|
|
836
|
+
* <li>
|
|
837
|
+
* <p>
|
|
838
|
+
* <code>FAIL</code> Stops provisioning resources.</p>
|
|
839
|
+
* </li>
|
|
840
|
+
* <li>
|
|
841
|
+
* <p>
|
|
842
|
+
* <code>WARN</code> Allows provisioning to continue with a warning message.</p>
|
|
843
|
+
* </li>
|
|
844
|
+
* </ul>
|
|
845
|
+
*/
|
|
846
|
+
FailureMode?: HookFailureMode | string;
|
|
847
|
+
/**
|
|
848
|
+
* <p>The unique name for your hook. Specifies a three-part namespace for your hook, with a
|
|
849
|
+
* recommended pattern of <code>Organization::Service::Hook</code>.</p>
|
|
850
|
+
* <note>
|
|
851
|
+
* <p>The following organization namespaces are reserved and can't be used in your hook
|
|
852
|
+
* type names:</p>
|
|
853
|
+
* <ul>
|
|
854
|
+
* <li>
|
|
855
|
+
* <p>
|
|
856
|
+
* <code>Alexa</code>
|
|
857
|
+
* </p>
|
|
858
|
+
* </li>
|
|
859
|
+
* <li>
|
|
860
|
+
* <p>
|
|
861
|
+
* <code>AMZN</code>
|
|
862
|
+
* </p>
|
|
863
|
+
* </li>
|
|
864
|
+
* <li>
|
|
865
|
+
* <p>
|
|
866
|
+
* <code>Amazon</code>
|
|
867
|
+
* </p>
|
|
868
|
+
* </li>
|
|
869
|
+
* <li>
|
|
870
|
+
* <p>
|
|
871
|
+
* <code>ASK</code>
|
|
872
|
+
* </p>
|
|
873
|
+
* </li>
|
|
874
|
+
* <li>
|
|
875
|
+
* <p>
|
|
876
|
+
* <code>AWS</code>
|
|
877
|
+
* </p>
|
|
878
|
+
* </li>
|
|
879
|
+
* <li>
|
|
880
|
+
* <p>
|
|
881
|
+
* <code>Custom</code>
|
|
882
|
+
* </p>
|
|
883
|
+
* </li>
|
|
884
|
+
* <li>
|
|
885
|
+
* <p>
|
|
886
|
+
* <code>Dev</code>
|
|
887
|
+
* </p>
|
|
888
|
+
* </li>
|
|
889
|
+
* </ul>
|
|
890
|
+
* </note>
|
|
891
|
+
*/
|
|
892
|
+
TypeName?: string;
|
|
893
|
+
/**
|
|
894
|
+
* <p>The version ID of the type specified.</p>
|
|
895
|
+
*/
|
|
896
|
+
TypeVersionId?: string;
|
|
897
|
+
/**
|
|
898
|
+
* <p>The version ID of the type configuration.</p>
|
|
899
|
+
*/
|
|
900
|
+
TypeConfigurationVersionId?: string;
|
|
901
|
+
/**
|
|
902
|
+
* <p>Specifies details about the target that the hook will run against.</p>
|
|
903
|
+
*/
|
|
904
|
+
TargetDetails?: ChangeSetHookTargetDetails;
|
|
905
|
+
}
|
|
906
|
+
export declare namespace ChangeSetHook {
|
|
907
|
+
/**
|
|
908
|
+
* @internal
|
|
909
|
+
*/
|
|
910
|
+
const filterSensitiveLog: (obj: ChangeSetHook) => any;
|
|
911
|
+
}
|
|
912
|
+
export declare enum ChangeSetHooksStatus {
|
|
913
|
+
PLANNED = "PLANNED",
|
|
914
|
+
PLANNING = "PLANNING",
|
|
915
|
+
UNAVAILABLE = "UNAVAILABLE"
|
|
916
|
+
}
|
|
765
917
|
/**
|
|
766
918
|
* <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>
|
|
919
|
+
* use the <code>ListChangeSets</code> operation.</p>
|
|
768
920
|
*/
|
|
769
921
|
export interface ChangeSetNotFoundException extends __SmithyException, $MetadataBearer {
|
|
770
922
|
name: "ChangeSetNotFoundException";
|
|
@@ -812,7 +964,7 @@ export interface ChangeSetSummary {
|
|
|
812
964
|
ChangeSetName?: string;
|
|
813
965
|
/**
|
|
814
966
|
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
815
|
-
* set. If you can
|
|
967
|
+
* set. If you can't execute the change set, the status indicates why. For example, a change
|
|
816
968
|
* set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still
|
|
817
969
|
* creating it or in an <code>OBSOLETE</code> state because the stack was already
|
|
818
970
|
* updated.</p>
|
|
@@ -876,14 +1028,15 @@ export interface ContinueUpdateRollbackInput {
|
|
|
876
1028
|
*/
|
|
877
1029
|
StackName: string | undefined;
|
|
878
1030
|
/**
|
|
879
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
880
|
-
*
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
-
*
|
|
1031
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1032
|
+
* that CloudFormation assumes to roll back the stack. CloudFormation uses the
|
|
1033
|
+
* role's credentials to make calls on your behalf. CloudFormation always uses this
|
|
1034
|
+
* role for all future operations on the stack. Provided that users have permission to operate
|
|
1035
|
+
* on the stack, CloudFormation uses this role even if the users don't have permission
|
|
1036
|
+
* to pass it. Ensure that the role grants least permission.</p>
|
|
884
1037
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
885
1038
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
886
|
-
* session that
|
|
1039
|
+
* session that's generated from your user credentials.</p>
|
|
887
1040
|
*/
|
|
888
1041
|
RoleARN?: string;
|
|
889
1042
|
/**
|
|
@@ -891,7 +1044,7 @@ export interface ContinueUpdateRollbackInput {
|
|
|
891
1044
|
* continue update rollback operation. You can specify only resources that are in the
|
|
892
1045
|
* <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources
|
|
893
1046
|
* that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an
|
|
894
|
-
* update was
|
|
1047
|
+
* update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason.</p>
|
|
895
1048
|
* <important>
|
|
896
1049
|
* <p>Specify this property to skip rolling back resources that CloudFormation
|
|
897
1050
|
* 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 +1087,7 @@ export declare namespace ContinueUpdateRollbackInput {
|
|
|
934
1087
|
const filterSensitiveLog: (obj: ContinueUpdateRollbackInput) => any;
|
|
935
1088
|
}
|
|
936
1089
|
/**
|
|
937
|
-
* <p>The output for a <a>ContinueUpdateRollback</a>
|
|
1090
|
+
* <p>The output for a <a>ContinueUpdateRollback</a> operation.</p>
|
|
938
1091
|
*/
|
|
939
1092
|
export interface ContinueUpdateRollbackOutput {
|
|
940
1093
|
}
|
|
@@ -950,8 +1103,8 @@ export declare namespace ContinueUpdateRollbackOutput {
|
|
|
950
1103
|
export interface Parameter {
|
|
951
1104
|
/**
|
|
952
1105
|
* <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
|
-
*
|
|
1106
|
+
* particular parameter, CloudFormation uses the default value that's specified in your
|
|
1107
|
+
* template.</p>
|
|
955
1108
|
*/
|
|
956
1109
|
ParameterKey?: string;
|
|
957
1110
|
/**
|
|
@@ -965,8 +1118,8 @@ export interface Parameter {
|
|
|
965
1118
|
*/
|
|
966
1119
|
UsePreviousValue?: boolean;
|
|
967
1120
|
/**
|
|
968
|
-
* <p>Read-only.
|
|
969
|
-
*
|
|
1121
|
+
* <p>Read-only. The value that corresponds to a SSM parameter key. This field is
|
|
1122
|
+
* returned only for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types">
|
|
970
1123
|
* <code>SSM</code>
|
|
971
1124
|
* </a> parameter types in the template.</p>
|
|
972
1125
|
*/
|
|
@@ -984,8 +1137,7 @@ export declare namespace Parameter {
|
|
|
984
1137
|
export interface ResourceToImport {
|
|
985
1138
|
/**
|
|
986
1139
|
* <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>
|
|
1140
|
+
* 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
1141
|
*/
|
|
990
1142
|
ResourceType: string | undefined;
|
|
991
1143
|
/**
|
|
@@ -1011,13 +1163,13 @@ export declare namespace ResourceToImport {
|
|
|
1011
1163
|
* <p>A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the
|
|
1012
1164
|
* alarms you specify goes to ALARM state during the stack operation or within the specified
|
|
1013
1165
|
* monitoring period afterwards, CloudFormation rolls back the entire stack
|
|
1014
|
-
* operation
|
|
1166
|
+
* operation.</p>
|
|
1015
1167
|
*/
|
|
1016
1168
|
export interface RollbackTrigger {
|
|
1017
1169
|
/**
|
|
1018
1170
|
* <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
|
-
*
|
|
1171
|
+
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1172
|
+
* back.</p>
|
|
1021
1173
|
*/
|
|
1022
1174
|
Arn: string | undefined;
|
|
1023
1175
|
/**
|
|
@@ -1041,7 +1193,7 @@ export declare namespace RollbackTrigger {
|
|
|
1041
1193
|
*/
|
|
1042
1194
|
export interface RollbackConfiguration {
|
|
1043
1195
|
/**
|
|
1044
|
-
* <p>The triggers to monitor during stack creation or update actions
|
|
1196
|
+
* <p>The triggers to monitor during stack creation or update actions.</p>
|
|
1045
1197
|
* <p>By default, CloudFormation saves the rollback triggers specified for a stack and applies them to
|
|
1046
1198
|
* any subsequent update operations for the stack, unless you specify otherwise. If you do
|
|
1047
1199
|
* specify rollback triggers for this parameter, those triggers replace any list of triggers
|
|
@@ -1054,7 +1206,7 @@ export interface RollbackConfiguration {
|
|
|
1054
1206
|
* <li>
|
|
1055
1207
|
* <p>To specify new or updated rollback triggers, you must specify
|
|
1056
1208
|
* <i>all</i> the triggers that you want used for this stack, even
|
|
1057
|
-
* triggers you've
|
|
1209
|
+
* triggers you've specified before (for example, when creating the stack or during a
|
|
1058
1210
|
* previous stack update). Any triggers that you don't include in the updated list of
|
|
1059
1211
|
* triggers are no longer applied to the stack.</p>
|
|
1060
1212
|
* </li>
|
|
@@ -1063,8 +1215,8 @@ export interface RollbackConfiguration {
|
|
|
1063
1215
|
* parameter.</p>
|
|
1064
1216
|
* </li>
|
|
1065
1217
|
* </ul>
|
|
1066
|
-
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1067
|
-
*
|
|
1218
|
+
* <p>If a specified trigger is missing, the entire stack operation fails and is rolled
|
|
1219
|
+
* back.</p>
|
|
1068
1220
|
*/
|
|
1069
1221
|
RollbackTriggers?: RollbackTrigger[];
|
|
1070
1222
|
/**
|
|
@@ -1072,7 +1224,7 @@ export interface RollbackConfiguration {
|
|
|
1072
1224
|
* the rollback triggers after the stack creation or update operation deploys all necessary
|
|
1073
1225
|
* resources.</p>
|
|
1074
1226
|
* <p>The default is 0 minutes.</p>
|
|
1075
|
-
* <p>If you specify a monitoring period but
|
|
1227
|
+
* <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
1228
|
* resources after update operations. You can use this monitoring period to perform any manual
|
|
1077
1229
|
* 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
1230
|
* <p>If you specify 0 for this parameter, CloudFormation still monitors the
|
|
@@ -1124,23 +1276,23 @@ export interface CreateChangeSetInput {
|
|
|
1124
1276
|
StackName: string | undefined;
|
|
1125
1277
|
/**
|
|
1126
1278
|
* <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
|
-
*
|
|
1279
|
+
* byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by
|
|
1280
|
+
* comparing this template with the template of the stack that you specified.</p>
|
|
1129
1281
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1130
1282
|
* <code>TemplateURL</code>.</p>
|
|
1131
1283
|
*/
|
|
1132
1284
|
TemplateBody?: string;
|
|
1133
1285
|
/**
|
|
1134
1286
|
* <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>
|
|
1287
|
+
* template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a
|
|
1288
|
+
* Systems Manager document. CloudFormation generates the change set by comparing this
|
|
1289
|
+
* template with the stack that you specified.</p>
|
|
1138
1290
|
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1139
1291
|
* <code>TemplateURL</code>.</p>
|
|
1140
1292
|
*/
|
|
1141
1293
|
TemplateURL?: string;
|
|
1142
1294
|
/**
|
|
1143
|
-
* <p>Whether to reuse the template that
|
|
1295
|
+
* <p>Whether to reuse the template that's associated with the stack to create the change
|
|
1144
1296
|
* set.</p>
|
|
1145
1297
|
*/
|
|
1146
1298
|
UsePreviousTemplate?: boolean;
|
|
@@ -1159,8 +1311,8 @@ export interface CreateChangeSetInput {
|
|
|
1159
1311
|
* </p>
|
|
1160
1312
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1161
1313
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1162
|
-
*
|
|
1163
|
-
* of these capabilities.</p>
|
|
1314
|
+
* (IAM) users. For those stacks, you must explicitly acknowledge this
|
|
1315
|
+
* by specifying one of these capabilities.</p>
|
|
1164
1316
|
* <p>The following IAM resources require you to specify either the
|
|
1165
1317
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
1166
1318
|
* capability.</p>
|
|
@@ -1174,8 +1326,8 @@ export interface CreateChangeSetInput {
|
|
|
1174
1326
|
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1175
1327
|
* </li>
|
|
1176
1328
|
* <li>
|
|
1177
|
-
* <p>If you don't specify either of these capabilities, CloudFormation
|
|
1178
|
-
*
|
|
1329
|
+
* <p>If you don't specify either of these capabilities, CloudFormation
|
|
1330
|
+
* returns an <code>InsufficientCapabilities</code> error.</p>
|
|
1179
1331
|
* </li>
|
|
1180
1332
|
* </ul>
|
|
1181
1333
|
* <p>If your stack template contains these resources, we recommend that you review all
|
|
@@ -1195,7 +1347,7 @@ export interface CreateChangeSetInput {
|
|
|
1195
1347
|
* </li>
|
|
1196
1348
|
* <li>
|
|
1197
1349
|
* <p>
|
|
1198
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
1350
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
1199
1351
|
* </p>
|
|
1200
1352
|
* </li>
|
|
1201
1353
|
* <li>
|
|
@@ -1218,12 +1370,11 @@ export interface CreateChangeSetInput {
|
|
|
1218
1370
|
* </li>
|
|
1219
1371
|
* <li>
|
|
1220
1372
|
* <p>
|
|
1221
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
1373
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
1222
1374
|
* </p>
|
|
1223
1375
|
* </li>
|
|
1224
1376
|
* </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>
|
|
1377
|
+
* <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
1378
|
* </li>
|
|
1228
1379
|
* <li>
|
|
1229
1380
|
* <p>
|
|
@@ -1238,14 +1389,14 @@ export interface CreateChangeSetInput {
|
|
|
1238
1389
|
* without first reviewing the resulting changes in a change set, you must acknowledge
|
|
1239
1390
|
* 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
1391
|
* <note>
|
|
1241
|
-
* <p>This capacity
|
|
1392
|
+
* <p>This capacity doesn't apply to creating change sets, and specifying it when
|
|
1242
1393
|
* creating change sets has no effect.</p>
|
|
1243
1394
|
* <p>If you want to create a stack from a stack template that contains macros
|
|
1244
1395
|
* <i>and</i> nested stacks, you must create or update the stack
|
|
1245
1396
|
* directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability.</p>
|
|
1246
1397
|
* </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
|
-
*
|
|
1398
|
+
* <p>For more information on macros, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation macros to
|
|
1399
|
+
* perform custom processing on templates</a>.</p>
|
|
1249
1400
|
* </li>
|
|
1250
1401
|
* </ul>
|
|
1251
1402
|
*/
|
|
@@ -1256,18 +1407,17 @@ export interface CreateChangeSetInput {
|
|
|
1256
1407
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
1257
1408
|
* <p>If the list of resource types doesn't include a resource type that you're updating, the
|
|
1258
1409
|
* 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>
|
|
1410
|
+
* types. Identity and Access Management (IAM) uses this parameter for condition keys
|
|
1411
|
+
* 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
1412
|
*/
|
|
1263
1413
|
ResourceTypes?: string[];
|
|
1264
1414
|
/**
|
|
1265
1415
|
* <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
|
-
*
|
|
1416
|
+
* that CloudFormation assumes when executing the change set. CloudFormation uses the
|
|
1417
|
+
* role's credentials to make calls on your behalf. CloudFormation uses this role for all
|
|
1418
|
+
* future operations on the stack. Provided that users have permission to operate on the
|
|
1419
|
+
* stack, CloudFormation uses this role even if the users don't have permission to pass
|
|
1420
|
+
* it. Ensure that the role grants least permission.</p>
|
|
1271
1421
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1272
1422
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1273
1423
|
* session that is generated from your user credentials.</p>
|
|
@@ -1279,29 +1429,28 @@ export interface CreateChangeSetInput {
|
|
|
1279
1429
|
*/
|
|
1280
1430
|
RollbackConfiguration?: RollbackConfiguration;
|
|
1281
1431
|
/**
|
|
1282
|
-
* <p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS)
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1432
|
+
* <p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics
|
|
1433
|
+
* that CloudFormation associates with the stack. To remove all associated notification
|
|
1434
|
+
* topics, specify an empty list.</p>
|
|
1285
1435
|
*/
|
|
1286
1436
|
NotificationARNs?: string[];
|
|
1287
1437
|
/**
|
|
1288
|
-
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates
|
|
1289
|
-
*
|
|
1438
|
+
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these
|
|
1439
|
+
* tags to resources in the stack. You can specify a maximum of 50 tags.</p>
|
|
1290
1440
|
*/
|
|
1291
1441
|
Tags?: Tag[];
|
|
1292
1442
|
/**
|
|
1293
1443
|
* <p>The name of the change set. The name must be unique among all change sets that are
|
|
1294
1444
|
* 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
|
|
1445
|
+
* <p>A change set name can contain only alphanumeric, case sensitive characters, and hyphens.
|
|
1446
|
+
* It must start with an alphabetical character and can't exceed 128 characters.</p>
|
|
1297
1447
|
*/
|
|
1298
1448
|
ChangeSetName: string | undefined;
|
|
1299
1449
|
/**
|
|
1300
1450
|
* <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>
|
|
1451
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1452
|
+
* create another change set with the same name. You might retry <code>CreateChangeSet</code>
|
|
1453
|
+
* requests to ensure that CloudFormation successfully received them.</p>
|
|
1305
1454
|
*/
|
|
1306
1455
|
ClientToken?: string;
|
|
1307
1456
|
/**
|
|
@@ -1313,8 +1462,8 @@ export interface CreateChangeSetInput {
|
|
|
1313
1462
|
* <code>CREATE</code>. To create a change set for an existing stack, specify
|
|
1314
1463
|
* <code>UPDATE</code>. To create a change set for an import operation, specify
|
|
1315
1464
|
* <code>IMPORT</code>.</p>
|
|
1316
|
-
* <p>If you create a change set for a new stack, CloudFormation creates a stack with
|
|
1317
|
-
*
|
|
1465
|
+
* <p>If you create a change set for a new stack, CloudFormation creates a stack with a
|
|
1466
|
+
* 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
1467
|
* <code>REVIEW_IN_PROGRESS</code>
|
|
1319
1468
|
* </a> state until you execute the change
|
|
1320
1469
|
* set.</p>
|
|
@@ -1370,8 +1519,8 @@ export interface InsufficientCapabilitiesException extends __SmithyException, $M
|
|
|
1370
1519
|
}
|
|
1371
1520
|
/**
|
|
1372
1521
|
* <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
|
-
*
|
|
1522
|
+
* <p>For information on resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation
|
|
1523
|
+
* quotas</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
1375
1524
|
*/
|
|
1376
1525
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
1377
1526
|
name: "LimitExceededException";
|
|
@@ -1388,18 +1537,18 @@ export declare enum OnFailure {
|
|
|
1388
1537
|
*/
|
|
1389
1538
|
export interface CreateStackInput {
|
|
1390
1539
|
/**
|
|
1391
|
-
* <p>The name that
|
|
1540
|
+
* <p>The name that's associated with the stack. The name must be unique in the Region in
|
|
1392
1541
|
* which you are creating the stack.</p>
|
|
1393
1542
|
* <note>
|
|
1394
1543
|
* <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens.
|
|
1395
|
-
* It must start with an alphabetical character and
|
|
1544
|
+
* It must start with an alphabetical character and can't be longer than 128
|
|
1396
1545
|
* characters.</p>
|
|
1397
1546
|
* </note>
|
|
1398
1547
|
*/
|
|
1399
1548
|
StackName: string | undefined;
|
|
1400
1549
|
/**
|
|
1401
1550
|
* <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
|
|
1551
|
+
* 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
1552
|
* in the CloudFormation User Guide.</p>
|
|
1404
1553
|
* <p>Conditional: You must specify either the <code>TemplateBody</code> or the
|
|
1405
1554
|
* <code>TemplateURL</code> parameter, but not both.</p>
|
|
@@ -1407,8 +1556,8 @@ export interface CreateStackInput {
|
|
|
1407
1556
|
TemplateBody?: string;
|
|
1408
1557
|
/**
|
|
1409
1558
|
* <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
|
|
1559
|
+
* size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager
|
|
1560
|
+
* document. For more information, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a>
|
|
1412
1561
|
* in the CloudFormation User Guide.</p>
|
|
1413
1562
|
* <p>Conditional: You must specify either the <code>TemplateBody</code> or the
|
|
1414
1563
|
* <code>TemplateURL</code> parameter, but not both.</p>
|
|
@@ -1440,9 +1589,9 @@ export interface CreateStackInput {
|
|
|
1440
1589
|
*/
|
|
1441
1590
|
TimeoutInMinutes?: number;
|
|
1442
1591
|
/**
|
|
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>
|
|
1592
|
+
* <p>The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related
|
|
1593
|
+
* events. You can find your Amazon SNS topic ARNs using the Amazon SNS
|
|
1594
|
+
* console or your Command Line Interface (CLI).</p>
|
|
1446
1595
|
*/
|
|
1447
1596
|
NotificationARNs?: string[];
|
|
1448
1597
|
/**
|
|
@@ -1455,18 +1604,19 @@ export interface CreateStackInput {
|
|
|
1455
1604
|
* </p>
|
|
1456
1605
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1457
1606
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
1458
|
-
*
|
|
1459
|
-
* of these capabilities.</p>
|
|
1607
|
+
* (IAM) users. For those stacks, you must explicitly acknowledge this
|
|
1608
|
+
* by specifying one of these capabilities.</p>
|
|
1460
1609
|
* <p>The following IAM resources require you to specify either the
|
|
1461
1610
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
1462
1611
|
* capability.</p>
|
|
1463
1612
|
* <ul>
|
|
1464
1613
|
* <li>
|
|
1465
|
-
* <p>If you have IAM resources, you can specify either
|
|
1614
|
+
* <p>If you have IAM resources, you can specify either
|
|
1615
|
+
* capability.</p>
|
|
1466
1616
|
* </li>
|
|
1467
1617
|
* <li>
|
|
1468
|
-
* <p>If you have IAM resources with custom names, you
|
|
1469
|
-
*
|
|
1618
|
+
* <p>If you have IAM resources with custom names, you
|
|
1619
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1470
1620
|
* </li>
|
|
1471
1621
|
* <li>
|
|
1472
1622
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -1490,7 +1640,7 @@ export interface CreateStackInput {
|
|
|
1490
1640
|
* </li>
|
|
1491
1641
|
* <li>
|
|
1492
1642
|
* <p>
|
|
1493
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
1643
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
1494
1644
|
* </p>
|
|
1495
1645
|
* </li>
|
|
1496
1646
|
* <li>
|
|
@@ -1513,12 +1663,11 @@ export interface CreateStackInput {
|
|
|
1513
1663
|
* </li>
|
|
1514
1664
|
* <li>
|
|
1515
1665
|
* <p>
|
|
1516
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
1666
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
1517
1667
|
* </p>
|
|
1518
1668
|
* </li>
|
|
1519
1669
|
* </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>
|
|
1670
|
+
* <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
1671
|
* </li>
|
|
1523
1672
|
* <li>
|
|
1524
1673
|
* <p>
|
|
@@ -1538,13 +1687,13 @@ export interface CreateStackInput {
|
|
|
1538
1687
|
* <important>
|
|
1539
1688
|
* <p>You should only create stacks directly from a stack template that contains
|
|
1540
1689
|
* 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>
|
|
1690
|
+
* <p>Each macro relies on an underlying Lambda service function for
|
|
1691
|
+
* processing stack templates. Be aware that the Lambda function owner
|
|
1692
|
+
* can update the function operation without CloudFormation being notified.</p>
|
|
1544
1693
|
* </important>
|
|
1545
1694
|
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
|
|
1546
|
-
* CloudFormation
|
|
1547
|
-
*
|
|
1695
|
+
* CloudFormation macros to perform custom processing on
|
|
1696
|
+
* templates</a>.</p>
|
|
1548
1697
|
* </li>
|
|
1549
1698
|
* </ul>
|
|
1550
1699
|
*/
|
|
@@ -1563,35 +1712,36 @@ export interface CreateStackInput {
|
|
|
1563
1712
|
* </code> (for a specific Amazon Web Services resource).</p>
|
|
1564
1713
|
* <p>If the list of resource types doesn't include a resource that you're creating, the stack
|
|
1565
1714
|
* creation fails. By default, CloudFormation grants permissions to all resource
|
|
1566
|
-
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific
|
|
1567
|
-
*
|
|
1715
|
+
* types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more
|
|
1716
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with
|
|
1568
1717
|
* Identity and Access Management</a>.</p>
|
|
1569
1718
|
*/
|
|
1570
1719
|
ResourceTypes?: string[];
|
|
1571
1720
|
/**
|
|
1572
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1573
|
-
*
|
|
1574
|
-
*
|
|
1575
|
-
*
|
|
1576
|
-
*
|
|
1721
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
1722
|
+
* that CloudFormation assumes to create the stack. CloudFormation uses the
|
|
1723
|
+
* role's credentials to make calls on your behalf. CloudFormation always uses this
|
|
1724
|
+
* role for all future operations on the stack. Provided that users have permission to operate
|
|
1725
|
+
* on the stack, CloudFormation uses this role even if the users don't have permission
|
|
1726
|
+
* to pass it. Ensure that the role grants least privilege.</p>
|
|
1577
1727
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1578
1728
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1579
|
-
* session that
|
|
1729
|
+
* session that's generated from your user credentials.</p>
|
|
1580
1730
|
*/
|
|
1581
1731
|
RoleARN?: string;
|
|
1582
1732
|
/**
|
|
1583
1733
|
* <p>Determines what action will be taken if stack creation fails. This must be one of:
|
|
1584
|
-
*
|
|
1585
|
-
*
|
|
1734
|
+
* <code>DO_NOTHING</code>, <code>ROLLBACK</code>, or <code>DELETE</code>. You can specify
|
|
1735
|
+
* either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</p>
|
|
1586
1736
|
* <p>Default: <code>ROLLBACK</code>
|
|
1587
1737
|
* </p>
|
|
1588
1738
|
*/
|
|
1589
1739
|
OnFailure?: OnFailure | string;
|
|
1590
1740
|
/**
|
|
1591
1741
|
* <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
|
-
*
|
|
1742
|
+
* to Stack Resources</a> in the <i>CloudFormation User Guide</i>. You can specify
|
|
1743
|
+
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
1744
|
+
* not both.</p>
|
|
1595
1745
|
*/
|
|
1596
1746
|
StackPolicyBody?: string;
|
|
1597
1747
|
/**
|
|
@@ -1612,7 +1762,7 @@ export interface CreateStackInput {
|
|
|
1612
1762
|
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
1613
1763
|
* create a stack with the same name. You might retry <code>CreateStack</code> requests to
|
|
1614
1764
|
* ensure that CloudFormation successfully received them.</p>
|
|
1615
|
-
* <p>All events
|
|
1765
|
+
* <p>All events initiated by a given stack operation are assigned the same client request
|
|
1616
1766
|
* token, which you can use to track operations. For example, if you execute a
|
|
1617
1767
|
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
1618
1768
|
* <code>StackEvents</code> generated by that operation will have
|
|
@@ -1622,7 +1772,7 @@ export interface CreateStackInput {
|
|
|
1622
1772
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
1623
1773
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
1624
1774
|
* would be assigned the same token in the following format:
|
|
1625
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
1775
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
1626
1776
|
*/
|
|
1627
1777
|
ClientRequestToken?: string;
|
|
1628
1778
|
/**
|
|
@@ -1630,10 +1780,10 @@ export interface CreateStackInput {
|
|
|
1630
1780
|
* delete a stack with termination protection enabled, the operation fails and the stack
|
|
1631
1781
|
* 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
1782
|
* Deleted</a> in the <i>CloudFormation User Guide</i>. Termination protection is
|
|
1633
|
-
*
|
|
1783
|
+
* deactivated on stacks by default.</p>
|
|
1634
1784
|
* <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
|
-
*
|
|
1785
|
+
* termination protection is set on the root stack and can't be changed directly on the nested
|
|
1786
|
+
* stack.</p>
|
|
1637
1787
|
*/
|
|
1638
1788
|
EnableTerminationProtection?: boolean;
|
|
1639
1789
|
}
|
|
@@ -1660,9 +1810,8 @@ export declare namespace CreateStackOutput {
|
|
|
1660
1810
|
}
|
|
1661
1811
|
/**
|
|
1662
1812
|
* <p>[Service-managed permissions] The Organizations accounts to which StackSets
|
|
1663
|
-
* deploys. StackSets
|
|
1664
|
-
*
|
|
1665
|
-
* organization.</p>
|
|
1813
|
+
* deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in
|
|
1814
|
+
* your organization or in an OU in your organization.</p>
|
|
1666
1815
|
* <p>For update operations, you can specify either <code>Accounts</code> or
|
|
1667
1816
|
* <code>OrganizationalUnitIds</code>. For create and delete operations, specify
|
|
1668
1817
|
* <code>OrganizationalUnitIds</code>.</p>
|
|
@@ -1695,7 +1844,7 @@ export declare enum RegionConcurrencyType {
|
|
|
1695
1844
|
}
|
|
1696
1845
|
/**
|
|
1697
1846
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
1698
|
-
* operation
|
|
1847
|
+
* operation.</p>
|
|
1699
1848
|
* <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
1849
|
*/
|
|
1701
1850
|
export interface StackSetOperationPreferences {
|
|
@@ -1730,9 +1879,9 @@ export interface StackSetOperationPreferences {
|
|
|
1730
1879
|
FailureTolerancePercentage?: number;
|
|
1731
1880
|
/**
|
|
1732
1881
|
* <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
|
-
*
|
|
1882
|
+
* dependent on the value of
|
|
1883
|
+
* <code>FailureToleranceCount</code>.<code>MaxConcurrentCount</code> is at most one more
|
|
1884
|
+
* than the <code>FailureToleranceCount</code>.</p>
|
|
1736
1885
|
* <p>Note that this setting lets you specify the <i>maximum</i> for operations.
|
|
1737
1886
|
* For large deployments, under certain circumstances the actual number of accounts acted upon
|
|
1738
1887
|
* concurrently may be lower due to service throttling.</p>
|
|
@@ -1777,21 +1926,23 @@ export interface CreateStackInstancesInput {
|
|
|
1777
1926
|
Accounts?: string[];
|
|
1778
1927
|
/**
|
|
1779
1928
|
* <p>[Service-managed permissions] The Organizations accounts for which to create
|
|
1780
|
-
* stack instances in the specified Regions.</p>
|
|
1929
|
+
* stack instances in the specified Amazon Web Services Regions.</p>
|
|
1781
1930
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
1782
1931
|
* both.</p>
|
|
1783
1932
|
*/
|
|
1784
1933
|
DeploymentTargets?: DeploymentTargets;
|
|
1785
1934
|
/**
|
|
1786
|
-
* <p>The names of one or more Regions where you want to create stack
|
|
1787
|
-
* specified Amazon Web Services accounts.</p>
|
|
1935
|
+
* <p>The names of one or more Amazon Web Services Regions where you want to create stack
|
|
1936
|
+
* instances using the specified Amazon Web Services accounts.</p>
|
|
1788
1937
|
*/
|
|
1789
1938
|
Regions: string[] | undefined;
|
|
1790
1939
|
/**
|
|
1791
1940
|
* <p>A list of stack set parameters whose values you want to override in the selected stack
|
|
1792
1941
|
* instances.</p>
|
|
1793
1942
|
* <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
|
|
1943
|
+
* accounts and Amazon Web Services Regions. When specifying parameters and their values, be
|
|
1944
|
+
* aware of how CloudFormation sets parameter values during stack instance
|
|
1945
|
+
* operations:</p>
|
|
1795
1946
|
* <ul>
|
|
1796
1947
|
* <li>
|
|
1797
1948
|
* <p>To override the current value for a parameter, include the parameter and specify
|
|
@@ -1799,19 +1950,19 @@ export interface CreateStackInstancesInput {
|
|
|
1799
1950
|
* </li>
|
|
1800
1951
|
* <li>
|
|
1801
1952
|
* <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
|
|
1953
|
+
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You can't specify
|
|
1803
1954
|
* both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
1804
1955
|
* </li>
|
|
1805
1956
|
* <li>
|
|
1806
1957
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
1807
|
-
* specify a parameter list but
|
|
1958
|
+
* specify a parameter list but don't include the parameter in the list.</p>
|
|
1808
1959
|
* </li>
|
|
1809
1960
|
* <li>
|
|
1810
|
-
* <p>To leave all parameters set to their present values,
|
|
1961
|
+
* <p>To leave all parameters set to their present values, don't specify this property
|
|
1811
1962
|
* at all.</p>
|
|
1812
1963
|
* </li>
|
|
1813
1964
|
* </ul>
|
|
1814
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance
|
|
1965
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance aren't
|
|
1815
1966
|
* updated, but retain their overridden value.</p>
|
|
1816
1967
|
* <p>You can only override the parameter <i>values</i> that are specified in
|
|
1817
1968
|
* 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 +1997,8 @@ export interface CreateStackInstancesInput {
|
|
|
1846
1997
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
1847
1998
|
* <code>DELEGATED_ADMIN</code>.</p>
|
|
1848
1999
|
* <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
|
|
2000
|
+
* 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
|
|
2001
|
+
* <i>CloudFormation User Guide</i>.</p>
|
|
1850
2002
|
* </li>
|
|
1851
2003
|
* </ul>
|
|
1852
2004
|
*/
|
|
@@ -1905,7 +2057,7 @@ export interface StackSetNotFoundException extends __SmithyException, $MetadataB
|
|
|
1905
2057
|
}
|
|
1906
2058
|
/**
|
|
1907
2059
|
* <p>Another operation has been performed on this stack set since the specified operation was
|
|
1908
|
-
* performed
|
|
2060
|
+
* performed.</p>
|
|
1909
2061
|
*/
|
|
1910
2062
|
export interface StaleRequestException extends __SmithyException, $MetadataBearer {
|
|
1911
2063
|
name: "StaleRequestException";
|
|
@@ -1973,8 +2125,8 @@ export interface CreateStackSetInput {
|
|
|
1973
2125
|
TemplateBody?: string;
|
|
1974
2126
|
/**
|
|
1975
2127
|
* <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>
|
|
2128
|
+
* template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a
|
|
2129
|
+
* Systems Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
1978
2130
|
* in the CloudFormation User Guide.</p>
|
|
1979
2131
|
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
|
|
1980
2132
|
* not both.</p>
|
|
@@ -2000,18 +2152,19 @@ export interface CreateStackSetInput {
|
|
|
2000
2152
|
* </p>
|
|
2001
2153
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
2002
2154
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
2003
|
-
*
|
|
2004
|
-
* one of these capabilities.</p>
|
|
2155
|
+
* (IAM) users. For those stack sets, you must explicitly acknowledge
|
|
2156
|
+
* this by specifying one of these capabilities.</p>
|
|
2005
2157
|
* <p>The following IAM resources require you to specify either the
|
|
2006
2158
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
2007
2159
|
* capability.</p>
|
|
2008
2160
|
* <ul>
|
|
2009
2161
|
* <li>
|
|
2010
|
-
* <p>If you have IAM resources, you can specify either
|
|
2162
|
+
* <p>If you have IAM resources, you can specify either
|
|
2163
|
+
* capability.</p>
|
|
2011
2164
|
* </li>
|
|
2012
2165
|
* <li>
|
|
2013
|
-
* <p>If you have IAM resources with custom names, you
|
|
2014
|
-
*
|
|
2166
|
+
* <p>If you have IAM resources with custom names, you
|
|
2167
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
2015
2168
|
* </li>
|
|
2016
2169
|
* <li>
|
|
2017
2170
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -2035,7 +2188,7 @@ export interface CreateStackSetInput {
|
|
|
2035
2188
|
* </li>
|
|
2036
2189
|
* <li>
|
|
2037
2190
|
* <p>
|
|
2038
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
2191
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
2039
2192
|
* </p>
|
|
2040
2193
|
* </li>
|
|
2041
2194
|
* <li>
|
|
@@ -2058,12 +2211,11 @@ export interface CreateStackSetInput {
|
|
|
2058
2211
|
* </li>
|
|
2059
2212
|
* <li>
|
|
2060
2213
|
* <p>
|
|
2061
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
2214
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
2062
2215
|
* </p>
|
|
2063
2216
|
* </li>
|
|
2064
2217
|
* </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>
|
|
2218
|
+
* <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
2219
|
* </li>
|
|
2068
2220
|
* <li>
|
|
2069
2221
|
* <p>
|
|
@@ -2075,7 +2227,7 @@ export interface CreateStackSetInput {
|
|
|
2075
2227
|
* 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
2228
|
* Perform Custom Processing on Templates</a>.</p>
|
|
2077
2229
|
* <important>
|
|
2078
|
-
* <p>Stack sets with service-managed permissions
|
|
2230
|
+
* <p>Stack sets with service-managed permissions don't currently support the use of
|
|
2079
2231
|
* 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
2232
|
* transforms, which are macros hosted by CloudFormation.) Even if you specify this capability
|
|
2081
2233
|
* for a stack set with service-managed permissions, if you reference a macro in your
|
|
@@ -2089,33 +2241,32 @@ export interface CreateStackSetInput {
|
|
|
2089
2241
|
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
|
2090
2242
|
* CloudFormation also propagates these tags to supported resources that are
|
|
2091
2243
|
* 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>
|
|
2244
|
+
* <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
|
|
2245
|
+
* tag resources. If you don't, the entire <code>CreateStackSet</code> action fails with an
|
|
2246
|
+
* <code>access denied</code> error, and the stack set is not created.</p>
|
|
2095
2247
|
*/
|
|
2096
2248
|
Tags?: Tag[];
|
|
2097
2249
|
/**
|
|
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>
|
|
2250
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role to use to create this
|
|
2251
|
+
* stack set.</p>
|
|
2252
|
+
* <p>Specify an IAM role only if you are using customized administrator roles
|
|
2253
|
+
* to control which users or groups can manage specific stack sets within the same
|
|
2254
|
+
* administrator account. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites: Granting Permissions for Stack
|
|
2255
|
+
* Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
2104
2256
|
*/
|
|
2105
2257
|
AdministrationRoleARN?: string;
|
|
2106
2258
|
/**
|
|
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>
|
|
2259
|
+
* <p>The name of the IAM execution role to use to create the stack set. If you
|
|
2260
|
+
* do not specify an execution role, CloudFormation uses the
|
|
2261
|
+
* <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set
|
|
2262
|
+
* operation.</p>
|
|
2263
|
+
* <p>Specify an IAM role only if you are using customized execution roles to
|
|
2264
|
+
* control which stack resources users and groups can include in their stack sets.</p>
|
|
2114
2265
|
*/
|
|
2115
2266
|
ExecutionRoleName?: string;
|
|
2116
2267
|
/**
|
|
2117
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
2118
|
-
*
|
|
2268
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
2269
|
+
* created. By default, <code>SELF-MANAGED</code> is specified.</p>
|
|
2119
2270
|
* <ul>
|
|
2120
2271
|
* <li>
|
|
2121
2272
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -2125,8 +2276,7 @@ export interface CreateStackSetInput {
|
|
|
2125
2276
|
* </li>
|
|
2126
2277
|
* <li>
|
|
2127
2278
|
* <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>
|
|
2279
|
+
* 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
2280
|
* </li>
|
|
2131
2281
|
* </ul>
|
|
2132
2282
|
*/
|
|
@@ -2139,24 +2289,24 @@ export interface CreateStackSetInput {
|
|
|
2139
2289
|
AutoDeployment?: AutoDeployment;
|
|
2140
2290
|
/**
|
|
2141
2291
|
* <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>
|
|
2292
|
+
* administrator in the organization's management account or as a delegated
|
|
2293
|
+
* administrator in a member account.</p>
|
|
2144
2294
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2145
2295
|
* self-managed permissions.</p>
|
|
2146
2296
|
* <ul>
|
|
2147
2297
|
* <li>
|
|
2148
2298
|
* <p>To create a stack set with service-managed permissions while signed in to the
|
|
2149
|
-
*
|
|
2299
|
+
* management account, specify <code>SELF</code>.</p>
|
|
2150
2300
|
* </li>
|
|
2151
2301
|
* <li>
|
|
2152
2302
|
* <p>To create a stack set with service-managed permissions while signed in to a
|
|
2153
2303
|
* delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
2154
2304
|
* <p>Your Amazon Web Services account must be registered as a delegated admin in the
|
|
2155
|
-
*
|
|
2305
|
+
* 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
2306
|
* </li>
|
|
2157
2307
|
* </ul>
|
|
2158
|
-
* <p>Stack sets with service-managed permissions are created in the management account,
|
|
2159
|
-
*
|
|
2308
|
+
* <p>Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated
|
|
2309
|
+
* administrators.</p>
|
|
2160
2310
|
*/
|
|
2161
2311
|
CallAs?: CallAs | string;
|
|
2162
2312
|
/**
|
|
@@ -2244,8 +2394,8 @@ export interface DeleteChangeSetInput {
|
|
|
2244
2394
|
*/
|
|
2245
2395
|
ChangeSetName: string | undefined;
|
|
2246
2396
|
/**
|
|
2247
|
-
* <p>If you specified the name of a change set to delete, specify the stack name or
|
|
2248
|
-
* that
|
|
2397
|
+
* <p>If you specified the name of a change set to delete, specify the stack name or Amazon
|
|
2398
|
+
* Resource Name (ARN) that's associated with it.</p>
|
|
2249
2399
|
*/
|
|
2250
2400
|
StackName?: string;
|
|
2251
2401
|
}
|
|
@@ -2281,22 +2431,23 @@ export interface InvalidChangeSetStatusException extends __SmithyException, $Met
|
|
|
2281
2431
|
*/
|
|
2282
2432
|
export interface DeleteStackInput {
|
|
2283
2433
|
/**
|
|
2284
|
-
* <p>The name or the unique stack ID that
|
|
2434
|
+
* <p>The name or the unique stack ID that's associated with the stack.</p>
|
|
2285
2435
|
*/
|
|
2286
2436
|
StackName: string | undefined;
|
|
2287
2437
|
/**
|
|
2288
2438
|
* <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
|
|
2439
|
+
* are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.</p>
|
|
2440
|
+
* <p>Retaining resources is useful when you can't delete a resource, such as a non-empty S3
|
|
2291
2441
|
* bucket, but you want to delete the stack.</p>
|
|
2292
2442
|
*/
|
|
2293
2443
|
RetainResources?: string[];
|
|
2294
2444
|
/**
|
|
2295
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2296
|
-
*
|
|
2445
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
2446
|
+
* that CloudFormation assumes to delete the stack. CloudFormation uses the
|
|
2447
|
+
* role's credentials to make calls on your behalf.</p>
|
|
2297
2448
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
2298
2449
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
2299
|
-
* session that
|
|
2450
|
+
* session that's generated from your user credentials.</p>
|
|
2300
2451
|
*/
|
|
2301
2452
|
RoleARN?: string;
|
|
2302
2453
|
/**
|
|
@@ -2304,7 +2455,7 @@ export interface DeleteStackInput {
|
|
|
2304
2455
|
* plan to retry requests so that CloudFormation knows that you're not attempting to
|
|
2305
2456
|
* delete a stack with the same name. You might retry <code>DeleteStack</code> requests to
|
|
2306
2457
|
* ensure that CloudFormation successfully received them.</p>
|
|
2307
|
-
* <p>All events
|
|
2458
|
+
* <p>All events initiated by a given stack operation are assigned the same client request
|
|
2308
2459
|
* token, which you can use to track operations. For example, if you execute a
|
|
2309
2460
|
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
|
2310
2461
|
* <code>StackEvents</code> generated by that operation will have
|
|
@@ -2345,7 +2496,7 @@ export interface DeleteStackInstancesInput {
|
|
|
2345
2496
|
*/
|
|
2346
2497
|
DeploymentTargets?: DeploymentTargets;
|
|
2347
2498
|
/**
|
|
2348
|
-
* <p>The Regions where you want to delete stack set instances.</p>
|
|
2499
|
+
* <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
|
|
2349
2500
|
*/
|
|
2350
2501
|
Regions: string[] | undefined;
|
|
2351
2502
|
/**
|
|
@@ -2371,13 +2522,14 @@ export interface DeleteStackInstancesInput {
|
|
|
2371
2522
|
OperationId?: string;
|
|
2372
2523
|
/**
|
|
2373
2524
|
* <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>
|
|
2525
|
+
* administrator in the organization's management account or as a delegated
|
|
2526
|
+
* administrator in a member account.</p>
|
|
2376
2527
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2377
2528
|
* self-managed permissions.</p>
|
|
2378
2529
|
* <ul>
|
|
2379
2530
|
* <li>
|
|
2380
|
-
* <p>If you are signed in to the management account, specify
|
|
2531
|
+
* <p>If you are signed in to the management account, specify
|
|
2532
|
+
* <code>SELF</code>.</p>
|
|
2381
2533
|
* </li>
|
|
2382
2534
|
* <li>
|
|
2383
2535
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -2415,13 +2567,14 @@ export interface DeleteStackSetInput {
|
|
|
2415
2567
|
StackSetName: string | undefined;
|
|
2416
2568
|
/**
|
|
2417
2569
|
* <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>
|
|
2570
|
+
* administrator in the organization's management account or as a delegated
|
|
2571
|
+
* administrator in a member account.</p>
|
|
2420
2572
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2421
2573
|
* self-managed permissions.</p>
|
|
2422
2574
|
* <ul>
|
|
2423
2575
|
* <li>
|
|
2424
|
-
* <p>If you are signed in to the management account, specify
|
|
2576
|
+
* <p>If you are signed in to the management account, specify
|
|
2577
|
+
* <code>SELF</code>.</p>
|
|
2425
2578
|
* </li>
|
|
2426
2579
|
* <li>
|
|
2427
2580
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -2457,7 +2610,7 @@ export interface StackSetNotEmptyException extends __SmithyException, $MetadataB
|
|
|
2457
2610
|
$fault: "client";
|
|
2458
2611
|
Message?: string;
|
|
2459
2612
|
}
|
|
2460
|
-
export declare type RegistryType = "MODULE" | "RESOURCE";
|
|
2613
|
+
export declare type RegistryType = "HOOK" | "MODULE" | "RESOURCE";
|
|
2461
2614
|
export interface DeregisterTypeInput {
|
|
2462
2615
|
/**
|
|
2463
2616
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
@@ -2518,8 +2671,8 @@ export declare namespace DescribeAccountLimitsInput {
|
|
|
2518
2671
|
*/
|
|
2519
2672
|
export interface DescribeAccountLimitsOutput {
|
|
2520
2673
|
/**
|
|
2521
|
-
* <p>An account limit structure that contain a list of CloudFormation account limits
|
|
2522
|
-
*
|
|
2674
|
+
* <p>An account limit structure that contain a list of CloudFormation account limits and
|
|
2675
|
+
* their values.</p>
|
|
2523
2676
|
*/
|
|
2524
2677
|
AccountLimits?: AccountLimit[];
|
|
2525
2678
|
/**
|
|
@@ -2569,15 +2722,16 @@ export interface DescribeChangeSetOutput {
|
|
|
2569
2722
|
*/
|
|
2570
2723
|
ChangeSetName?: string;
|
|
2571
2724
|
/**
|
|
2572
|
-
* <p>The ARN of the change set.</p>
|
|
2725
|
+
* <p>The Amazon Resource Name (ARN) of the change set.</p>
|
|
2573
2726
|
*/
|
|
2574
2727
|
ChangeSetId?: string;
|
|
2575
2728
|
/**
|
|
2576
|
-
* <p>The ARN of the stack that
|
|
2729
|
+
* <p>The Amazon Resource Name (ARN) of the stack that's associated with the change
|
|
2730
|
+
* set.</p>
|
|
2577
2731
|
*/
|
|
2578
2732
|
StackId?: string;
|
|
2579
2733
|
/**
|
|
2580
|
-
* <p>The name of the stack that
|
|
2734
|
+
* <p>The name of the stack that's associated with the change set.</p>
|
|
2581
2735
|
*/
|
|
2582
2736
|
StackName?: string;
|
|
2583
2737
|
/**
|
|
@@ -2595,7 +2749,7 @@ export interface DescribeChangeSetOutput {
|
|
|
2595
2749
|
CreationTime?: Date;
|
|
2596
2750
|
/**
|
|
2597
2751
|
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
2598
|
-
* set. If you can
|
|
2752
|
+
* set. If you can't execute the change set, the status indicates why. For example, a change
|
|
2599
2753
|
* set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still
|
|
2600
2754
|
* creating it or in an <code>OBSOLETE</code> state because the stack was already
|
|
2601
2755
|
* updated.</p>
|
|
@@ -2631,7 +2785,8 @@ export interface DescribeChangeSetOutput {
|
|
|
2631
2785
|
*/
|
|
2632
2786
|
Tags?: Tag[];
|
|
2633
2787
|
/**
|
|
2634
|
-
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation
|
|
2788
|
+
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation
|
|
2789
|
+
* changes if you execute the change set.</p>
|
|
2635
2790
|
*/
|
|
2636
2791
|
Changes?: Change[];
|
|
2637
2792
|
/**
|
|
@@ -2660,10 +2815,74 @@ export declare namespace DescribeChangeSetOutput {
|
|
|
2660
2815
|
*/
|
|
2661
2816
|
const filterSensitiveLog: (obj: DescribeChangeSetOutput) => any;
|
|
2662
2817
|
}
|
|
2818
|
+
export interface DescribeChangeSetHooksInput {
|
|
2819
|
+
/**
|
|
2820
|
+
* <p>The name or Amazon Resource Name (ARN) of the change set that you want to
|
|
2821
|
+
* describe.</p>
|
|
2822
|
+
*/
|
|
2823
|
+
ChangeSetName: string | undefined;
|
|
2824
|
+
/**
|
|
2825
|
+
* <p>If you specified the name of a change set, specify the stack name or stack ID (ARN) of
|
|
2826
|
+
* the change set you want to describe.</p>
|
|
2827
|
+
*/
|
|
2828
|
+
StackName?: string;
|
|
2829
|
+
/**
|
|
2830
|
+
* <p>A string, provided by the <code>DescribeChangeSetHooks</code> response output, that
|
|
2831
|
+
* identifies the next page of information that you want to retrieve.</p>
|
|
2832
|
+
*/
|
|
2833
|
+
NextToken?: string;
|
|
2834
|
+
/**
|
|
2835
|
+
* <p>If specified, lists only the hooks related to the specified
|
|
2836
|
+
* <code>LogicalResourceId</code>.</p>
|
|
2837
|
+
*/
|
|
2838
|
+
LogicalResourceId?: string;
|
|
2839
|
+
}
|
|
2840
|
+
export declare namespace DescribeChangeSetHooksInput {
|
|
2841
|
+
/**
|
|
2842
|
+
* @internal
|
|
2843
|
+
*/
|
|
2844
|
+
const filterSensitiveLog: (obj: DescribeChangeSetHooksInput) => any;
|
|
2845
|
+
}
|
|
2846
|
+
export interface DescribeChangeSetHooksOutput {
|
|
2847
|
+
/**
|
|
2848
|
+
* <p>The change set identifier (stack ID).</p>
|
|
2849
|
+
*/
|
|
2850
|
+
ChangeSetId?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* <p>The change set name.</p>
|
|
2853
|
+
*/
|
|
2854
|
+
ChangeSetName?: string;
|
|
2855
|
+
/**
|
|
2856
|
+
* <p>List of hook objects.</p>
|
|
2857
|
+
*/
|
|
2858
|
+
Hooks?: ChangeSetHook[];
|
|
2859
|
+
/**
|
|
2860
|
+
* <p>Provides the status of the change set hook.</p>
|
|
2861
|
+
*/
|
|
2862
|
+
Status?: ChangeSetHooksStatus | string;
|
|
2863
|
+
/**
|
|
2864
|
+
* <p>Pagination token, <code>null</code> or empty if no more results.</p>
|
|
2865
|
+
*/
|
|
2866
|
+
NextToken?: string;
|
|
2867
|
+
/**
|
|
2868
|
+
* <p>The stack identifier (stack ID).</p>
|
|
2869
|
+
*/
|
|
2870
|
+
StackId?: string;
|
|
2871
|
+
/**
|
|
2872
|
+
* <p>The stack name.</p>
|
|
2873
|
+
*/
|
|
2874
|
+
StackName?: string;
|
|
2875
|
+
}
|
|
2876
|
+
export declare namespace DescribeChangeSetHooksOutput {
|
|
2877
|
+
/**
|
|
2878
|
+
* @internal
|
|
2879
|
+
*/
|
|
2880
|
+
const filterSensitiveLog: (obj: DescribeChangeSetHooksOutput) => any;
|
|
2881
|
+
}
|
|
2663
2882
|
export interface DescribePublisherInput {
|
|
2664
2883
|
/**
|
|
2665
2884
|
* <p>The ID of the extension publisher.</p>
|
|
2666
|
-
* <p>If you
|
|
2885
|
+
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension
|
|
2667
2886
|
* publisher, <code>DescribePublisher</code> returns information about your own publisher
|
|
2668
2887
|
* account.</p>
|
|
2669
2888
|
*/
|
|
@@ -2696,7 +2915,7 @@ export interface DescribePublisherOutput {
|
|
|
2696
2915
|
PublisherStatus?: PublisherStatus | string;
|
|
2697
2916
|
/**
|
|
2698
2917
|
* <p>The type of account used as the identity provider when registering this publisher with
|
|
2699
|
-
*
|
|
2918
|
+
* CloudFormation.</p>
|
|
2700
2919
|
*/
|
|
2701
2920
|
IdentityProvider?: IdentityProvider | string;
|
|
2702
2921
|
/**
|
|
@@ -2760,7 +2979,7 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2760
2979
|
* </li>
|
|
2761
2980
|
* <li>
|
|
2762
2981
|
* <p>
|
|
2763
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
2982
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its
|
|
2764
2983
|
* expected template configuration.</p>
|
|
2765
2984
|
* </li>
|
|
2766
2985
|
* <li>
|
|
@@ -2782,7 +3001,7 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
2782
3001
|
* <p>
|
|
2783
3002
|
* <code>DETECTION_COMPLETE</code>: The stack drift detection operation has
|
|
2784
3003
|
* successfully completed for all resources in the stack that support drift detection.
|
|
2785
|
-
* (Resources that
|
|
3004
|
+
* (Resources that don't currently support stack detection remain unchecked.)</p>
|
|
2786
3005
|
* <p>If you specified logical resource IDs for CloudFormation to use as a filter for the stack
|
|
2787
3006
|
* drift detection operation, only the resources with those logical IDs are checked for
|
|
2788
3007
|
* drift.</p>
|
|
@@ -2827,7 +3046,7 @@ export declare namespace DescribeStackDriftDetectionStatusOutput {
|
|
|
2827
3046
|
*/
|
|
2828
3047
|
export interface DescribeStackEventsInput {
|
|
2829
3048
|
/**
|
|
2830
|
-
* <p>The name or the unique stack ID that
|
|
3049
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
2831
3050
|
* interchangeable:</p>
|
|
2832
3051
|
* <ul>
|
|
2833
3052
|
* <li>
|
|
@@ -2852,6 +3071,12 @@ export declare namespace DescribeStackEventsInput {
|
|
|
2852
3071
|
*/
|
|
2853
3072
|
const filterSensitiveLog: (obj: DescribeStackEventsInput) => any;
|
|
2854
3073
|
}
|
|
3074
|
+
export declare enum HookStatus {
|
|
3075
|
+
HOOK_COMPLETE_FAILED = "HOOK_COMPLETE_FAILED",
|
|
3076
|
+
HOOK_COMPLETE_SUCCEEDED = "HOOK_COMPLETE_SUCCEEDED",
|
|
3077
|
+
HOOK_FAILED = "HOOK_FAILED",
|
|
3078
|
+
HOOK_IN_PROGRESS = "HOOK_IN_PROGRESS"
|
|
3079
|
+
}
|
|
2855
3080
|
export declare enum ResourceStatus {
|
|
2856
3081
|
CREATE_COMPLETE = "CREATE_COMPLETE",
|
|
2857
3082
|
CREATE_FAILED = "CREATE_FAILED",
|
|
@@ -2902,8 +3127,7 @@ export interface StackEvent {
|
|
|
2902
3127
|
*/
|
|
2903
3128
|
PhysicalResourceId?: string;
|
|
2904
3129
|
/**
|
|
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>
|
|
3130
|
+
* <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
3131
|
*/
|
|
2908
3132
|
ResourceType?: string;
|
|
2909
3133
|
/**
|
|
@@ -2934,9 +3158,39 @@ export interface StackEvent {
|
|
|
2934
3158
|
* <i>Console-StackOperation-ID</i>, which helps you easily identify the
|
|
2935
3159
|
* stack operation . For example, if you create a stack using the console, each stack event
|
|
2936
3160
|
* would be assigned the same token in the following format:
|
|
2937
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code
|
|
3161
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
2938
3162
|
*/
|
|
2939
3163
|
ClientRequestToken?: string;
|
|
3164
|
+
/**
|
|
3165
|
+
* <p>The name of the hook.</p>
|
|
3166
|
+
*/
|
|
3167
|
+
HookType?: string;
|
|
3168
|
+
/**
|
|
3169
|
+
* <p>Provides the status of the change set hook.</p>
|
|
3170
|
+
*/
|
|
3171
|
+
HookStatus?: HookStatus | string;
|
|
3172
|
+
/**
|
|
3173
|
+
* <p>Provides the reason for the hook status.</p>
|
|
3174
|
+
*/
|
|
3175
|
+
HookStatusReason?: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>Invocation points are points in provisioning logic where hooks are initiated.</p>
|
|
3178
|
+
*/
|
|
3179
|
+
HookInvocationPoint?: HookInvocationPoint | string;
|
|
3180
|
+
/**
|
|
3181
|
+
* <p>Specify the hook failure mode for non-compliant resources in the followings ways.</p>
|
|
3182
|
+
* <ul>
|
|
3183
|
+
* <li>
|
|
3184
|
+
* <p>
|
|
3185
|
+
* <code>FAIL</code> Stops provisioning resources.</p>
|
|
3186
|
+
* </li>
|
|
3187
|
+
* <li>
|
|
3188
|
+
* <p>
|
|
3189
|
+
* <code>WARN</code> Allows provisioning to continue with a warning message.</p>
|
|
3190
|
+
* </li>
|
|
3191
|
+
* </ul>
|
|
3192
|
+
*/
|
|
3193
|
+
HookFailureMode?: HookFailureMode | string;
|
|
2940
3194
|
}
|
|
2941
3195
|
export declare namespace StackEvent {
|
|
2942
3196
|
/**
|
|
@@ -2981,13 +3235,14 @@ export interface DescribeStackInstanceInput {
|
|
|
2981
3235
|
StackInstanceRegion: string | undefined;
|
|
2982
3236
|
/**
|
|
2983
3237
|
* <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>
|
|
3238
|
+
* administrator in the organization's management account or as a delegated
|
|
3239
|
+
* administrator in a member account.</p>
|
|
2986
3240
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
2987
3241
|
* self-managed permissions.</p>
|
|
2988
3242
|
* <ul>
|
|
2989
3243
|
* <li>
|
|
2990
|
-
* <p>If you are signed in to the management account, specify
|
|
3244
|
+
* <p>If you are signed in to the management account, specify
|
|
3245
|
+
* <code>SELF</code>.</p>
|
|
2991
3246
|
* </li>
|
|
2992
3247
|
* <li>
|
|
2993
3248
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -3015,7 +3270,7 @@ export interface StackInstanceComprehensiveStatus {
|
|
|
3015
3270
|
* <li>
|
|
3016
3271
|
* <p>
|
|
3017
3272
|
* <code>CANCELLED</code>: The operation in the specified account and Region has been
|
|
3018
|
-
*
|
|
3273
|
+
* canceled. This is either because a user has stopped the stack set operation, or
|
|
3019
3274
|
* because the failure tolerance of the stack set operation has been exceeded.</p>
|
|
3020
3275
|
* </li>
|
|
3021
3276
|
* <li>
|
|
@@ -3065,7 +3320,7 @@ export declare type StackInstanceStatus = "CURRENT" | "INOPERABLE" | "OUTDATED";
|
|
|
3065
3320
|
* given account within a given Region. A stack instance can exist without a stack—for
|
|
3066
3321
|
* example, if the stack couldn't be created for some reason. A stack instance is associated
|
|
3067
3322
|
* with only one stack set. Each stack instance contains the ID of its associated stack set,
|
|
3068
|
-
*
|
|
3323
|
+
* in addition to the ID of the actual stack and the stack status.</p>
|
|
3069
3324
|
*/
|
|
3070
3325
|
export interface StackInstance {
|
|
3071
3326
|
/**
|
|
@@ -3112,12 +3367,12 @@ export interface StackInstance {
|
|
|
3112
3367
|
* <ul>
|
|
3113
3368
|
* <li>
|
|
3114
3369
|
* <p>The associated stack failed during a <code>CreateStackSet</code> or
|
|
3115
|
-
* <code>UpdateStackSet</code> operation
|
|
3370
|
+
* <code>UpdateStackSet</code> operation.</p>
|
|
3116
3371
|
* </li>
|
|
3117
3372
|
* <li>
|
|
3118
3373
|
* <p>The stack was part of a <code>CreateStackSet</code> or
|
|
3119
3374
|
* <code>UpdateStackSet</code> operation that failed or was stopped before the
|
|
3120
|
-
* stack was created or updated
|
|
3375
|
+
* stack was created or updated.</p>
|
|
3121
3376
|
* </li>
|
|
3122
3377
|
* </ul>
|
|
3123
3378
|
* </li>
|
|
@@ -3133,7 +3388,7 @@ export interface StackInstance {
|
|
|
3133
3388
|
*/
|
|
3134
3389
|
StackInstanceStatus?: StackInstanceComprehensiveStatus;
|
|
3135
3390
|
/**
|
|
3136
|
-
* <p>The explanation for the specific status code that
|
|
3391
|
+
* <p>The explanation for the specific status code that's assigned to this stack
|
|
3137
3392
|
* instance.</p>
|
|
3138
3393
|
*/
|
|
3139
3394
|
StatusReason?: string;
|
|
@@ -3144,7 +3399,7 @@ export interface StackInstance {
|
|
|
3144
3399
|
OrganizationalUnitId?: string;
|
|
3145
3400
|
/**
|
|
3146
3401
|
* <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
|
|
3402
|
+
* and parameter configuration of the stack set to which it belongs.</p>
|
|
3148
3403
|
* <ul>
|
|
3149
3404
|
* <li>
|
|
3150
3405
|
* <p>
|
|
@@ -3155,7 +3410,7 @@ export interface StackInstance {
|
|
|
3155
3410
|
* </li>
|
|
3156
3411
|
* <li>
|
|
3157
3412
|
* <p>
|
|
3158
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
3413
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack instance differs from
|
|
3159
3414
|
* its expected stack set configuration.</p>
|
|
3160
3415
|
* </li>
|
|
3161
3416
|
* <li>
|
|
@@ -3173,7 +3428,7 @@ export interface StackInstance {
|
|
|
3173
3428
|
/**
|
|
3174
3429
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
3175
3430
|
* the stack instance. This value will be <code>NULL</code> for any stack instance on which
|
|
3176
|
-
* drift detection
|
|
3431
|
+
* drift detection hasn't yet been performed.</p>
|
|
3177
3432
|
*/
|
|
3178
3433
|
LastDriftCheckTimestamp?: Date;
|
|
3179
3434
|
}
|
|
@@ -3208,7 +3463,7 @@ export interface StackInstanceNotFoundException extends __SmithyException, $Meta
|
|
|
3208
3463
|
*/
|
|
3209
3464
|
export interface DescribeStackResourceInput {
|
|
3210
3465
|
/**
|
|
3211
|
-
* <p>The name or the unique stack ID that
|
|
3466
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
3212
3467
|
* interchangeable:</p>
|
|
3213
3468
|
* <ul>
|
|
3214
3469
|
* <li>
|
|
@@ -3264,11 +3519,11 @@ export interface StackResourceDriftInformation {
|
|
|
3264
3519
|
* <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from its
|
|
3265
3520
|
* expected configuration.</p>
|
|
3266
3521
|
* <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
|
|
3522
|
+
* <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
3523
|
* </li>
|
|
3269
3524
|
* <li>
|
|
3270
3525
|
* <p>
|
|
3271
|
-
* <code>IN_SYNC</code>: The
|
|
3526
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3272
3527
|
* configuration.</p>
|
|
3273
3528
|
* </li>
|
|
3274
3529
|
* </ul>
|
|
@@ -3308,8 +3563,7 @@ export interface StackResourceDetail {
|
|
|
3308
3563
|
*/
|
|
3309
3564
|
PhysicalResourceId?: string;
|
|
3310
3565
|
/**
|
|
3311
|
-
* <p>Type of resource.
|
|
3312
|
-
* Guide.)</p>
|
|
3566
|
+
* <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
3567
|
*/
|
|
3314
3568
|
ResourceType: string | undefined;
|
|
3315
3569
|
/**
|
|
@@ -3390,12 +3644,12 @@ export interface DescribeStackResourceDriftsInput {
|
|
|
3390
3644
|
* </li>
|
|
3391
3645
|
* <li>
|
|
3392
3646
|
* <p>
|
|
3393
|
-
* <code>IN_SYNC</code>: The
|
|
3647
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3394
3648
|
* template configuration.</p>
|
|
3395
3649
|
* </li>
|
|
3396
3650
|
* <li>
|
|
3397
3651
|
* <p>
|
|
3398
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
3652
|
+
* <code>NOT_CHECKED</code>: CloudFormation doesn't currently return this value.</p>
|
|
3399
3653
|
* </li>
|
|
3400
3654
|
* </ul>
|
|
3401
3655
|
*/
|
|
@@ -3420,7 +3674,7 @@ export declare namespace DescribeStackResourceDriftsInput {
|
|
|
3420
3674
|
}
|
|
3421
3675
|
/**
|
|
3422
3676
|
* <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
|
|
3677
|
+
* context key-value pairs in cases where a resource's logical and physical IDs aren't enough
|
|
3424
3678
|
* to uniquely identify that resource. Each context key-value pair specifies a resource that
|
|
3425
3679
|
* contains the targeted resource.</p>
|
|
3426
3680
|
*/
|
|
@@ -3471,8 +3725,8 @@ export interface PropertyDifference {
|
|
|
3471
3725
|
* <ul>
|
|
3472
3726
|
* <li>
|
|
3473
3727
|
* <p>
|
|
3474
|
-
* <code>ADD</code>: A value has been added to a resource property that
|
|
3475
|
-
*
|
|
3728
|
+
* <code>ADD</code>: A value has been added to a resource property that's an array or
|
|
3729
|
+
* list data type.</p>
|
|
3476
3730
|
* </li>
|
|
3477
3731
|
* <li>
|
|
3478
3732
|
* <p>
|
|
@@ -3501,7 +3755,7 @@ export declare namespace PropertyDifference {
|
|
|
3501
3755
|
* drift. Only resource properties explicitly defined in the stack template are checked for
|
|
3502
3756
|
* drift. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
3503
3757
|
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
3504
|
-
* <p>Resources that
|
|
3758
|
+
* <p>Resources that don't currently support drift detection can't be checked. For a list of
|
|
3505
3759
|
* 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
3760
|
* Drift Detection</a>.</p>
|
|
3507
3761
|
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources,
|
|
@@ -3519,12 +3773,12 @@ export interface StackResourceDrift {
|
|
|
3519
3773
|
LogicalResourceId: string | undefined;
|
|
3520
3774
|
/**
|
|
3521
3775
|
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3522
|
-
* supported by CloudFormation
|
|
3776
|
+
* supported by CloudFormation.</p>
|
|
3523
3777
|
*/
|
|
3524
3778
|
PhysicalResourceId?: string;
|
|
3525
3779
|
/**
|
|
3526
3780
|
* <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
|
|
3781
|
+
* context key-value pairs in cases where a resource's logical and physical IDs aren't enough
|
|
3528
3782
|
* to uniquely identify that resource. Each context key-value pair specifies a unique resource
|
|
3529
3783
|
* that contains the targeted resource.</p>
|
|
3530
3784
|
*/
|
|
@@ -3535,27 +3789,27 @@ export interface StackResourceDrift {
|
|
|
3535
3789
|
ResourceType: string | undefined;
|
|
3536
3790
|
/**
|
|
3537
3791
|
* <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
|
|
3792
|
+
* defined in the stack template and any values specified as template parameters.</p>
|
|
3539
3793
|
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this
|
|
3540
|
-
* structure will not be present
|
|
3794
|
+
* structure will not be present.</p>
|
|
3541
3795
|
*/
|
|
3542
3796
|
ExpectedProperties?: string;
|
|
3543
3797
|
/**
|
|
3544
3798
|
* <p>A JSON structure containing the actual property values of the stack resource.</p>
|
|
3545
3799
|
* <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this
|
|
3546
|
-
* structure will not be present
|
|
3800
|
+
* structure will not be present.</p>
|
|
3547
3801
|
*/
|
|
3548
3802
|
ActualProperties?: string;
|
|
3549
3803
|
/**
|
|
3550
3804
|
* <p>A collection of the resource properties whose actual values differ from their expected
|
|
3551
3805
|
* values. These will be present only for resources whose
|
|
3552
|
-
* <code>StackResourceDriftStatus</code> is
|
|
3553
|
-
* </p>
|
|
3806
|
+
* <code>StackResourceDriftStatus</code> is
|
|
3807
|
+
* <code>MODIFIED</code>.</p>
|
|
3554
3808
|
*/
|
|
3555
3809
|
PropertyDifferences?: PropertyDifference[];
|
|
3556
3810
|
/**
|
|
3557
3811
|
* <p>Status of the resource's actual configuration compared to its expected
|
|
3558
|
-
* configuration
|
|
3812
|
+
* configuration.</p>
|
|
3559
3813
|
* <ul>
|
|
3560
3814
|
* <li>
|
|
3561
3815
|
* <p>
|
|
@@ -3570,7 +3824,7 @@ export interface StackResourceDrift {
|
|
|
3570
3824
|
* </li>
|
|
3571
3825
|
* <li>
|
|
3572
3826
|
* <p>
|
|
3573
|
-
* <code>IN_SYNC</code>: The
|
|
3827
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3574
3828
|
* template configuration.</p>
|
|
3575
3829
|
* </li>
|
|
3576
3830
|
* <li>
|
|
@@ -3602,10 +3856,9 @@ export interface DescribeStackResourceDriftsOutput {
|
|
|
3602
3856
|
* stack. This includes actual and expected configuration values for resources where CloudFormation
|
|
3603
3857
|
* detects drift.</p>
|
|
3604
3858
|
* <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>
|
|
3859
|
+
* resource that has been checked for drift. Resources that haven't yet been checked for drift
|
|
3860
|
+
* aren't included. Resources that do not currently support drift detection aren't checked,
|
|
3861
|
+
* 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
3862
|
*/
|
|
3610
3863
|
StackResourceDrifts: StackResourceDrift[] | undefined;
|
|
3611
3864
|
/**
|
|
@@ -3628,7 +3881,7 @@ export declare namespace DescribeStackResourceDriftsOutput {
|
|
|
3628
3881
|
*/
|
|
3629
3882
|
export interface DescribeStackResourcesInput {
|
|
3630
3883
|
/**
|
|
3631
|
-
* <p>The name or the unique stack ID that is associated with the stack, which
|
|
3884
|
+
* <p>The name or the unique stack ID that is associated with the stack, which aren't always
|
|
3632
3885
|
* interchangeable:</p>
|
|
3633
3886
|
* <ul>
|
|
3634
3887
|
* <li>
|
|
@@ -3640,7 +3893,7 @@ export interface DescribeStackResourcesInput {
|
|
|
3640
3893
|
* </li>
|
|
3641
3894
|
* </ul>
|
|
3642
3895
|
* <p>Default: There is no default value.</p>
|
|
3643
|
-
* <p>Required: Conditional. If you
|
|
3896
|
+
* <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify
|
|
3644
3897
|
* <code>PhysicalResourceId</code>.</p>
|
|
3645
3898
|
*/
|
|
3646
3899
|
StackName?: string;
|
|
@@ -3656,7 +3909,7 @@ export interface DescribeStackResourcesInput {
|
|
|
3656
3909
|
* <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass
|
|
3657
3910
|
* the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack
|
|
3658
3911
|
* the instance belongs to and what other resources are part of the stack.</p>
|
|
3659
|
-
* <p>Required: Conditional. If you
|
|
3912
|
+
* <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must
|
|
3660
3913
|
* specify <code>StackName</code>.</p>
|
|
3661
3914
|
* <p>Default: There is no default value.</p>
|
|
3662
3915
|
*/
|
|
@@ -3690,8 +3943,8 @@ export interface StackResource {
|
|
|
3690
3943
|
*/
|
|
3691
3944
|
PhysicalResourceId?: string;
|
|
3692
3945
|
/**
|
|
3693
|
-
* <p>Type of resource.
|
|
3694
|
-
* Guide
|
|
3946
|
+
* <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
|
|
3947
|
+
* Guide.</p>
|
|
3695
3948
|
*/
|
|
3696
3949
|
ResourceType: string | undefined;
|
|
3697
3950
|
/**
|
|
@@ -3749,7 +4002,7 @@ export declare namespace DescribeStackResourcesOutput {
|
|
|
3749
4002
|
*/
|
|
3750
4003
|
export interface DescribeStacksInput {
|
|
3751
4004
|
/**
|
|
3752
|
-
* <p>The name or the unique stack ID that
|
|
4005
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
3753
4006
|
* interchangeable:</p>
|
|
3754
4007
|
* <ul>
|
|
3755
4008
|
* <li>
|
|
@@ -3783,7 +4036,7 @@ export declare namespace DescribeStacksInput {
|
|
|
3783
4036
|
export interface StackDriftInformation {
|
|
3784
4037
|
/**
|
|
3785
4038
|
* <p>Status of the stack's actual configuration compared to its expected template
|
|
3786
|
-
* configuration
|
|
4039
|
+
* configuration.</p>
|
|
3787
4040
|
* <ul>
|
|
3788
4041
|
* <li>
|
|
3789
4042
|
* <p>
|
|
@@ -3793,7 +4046,7 @@ export interface StackDriftInformation {
|
|
|
3793
4046
|
* </li>
|
|
3794
4047
|
* <li>
|
|
3795
4048
|
* <p>
|
|
3796
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
4049
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its
|
|
3797
4050
|
* expected template configuration.</p>
|
|
3798
4051
|
* </li>
|
|
3799
4052
|
* <li>
|
|
@@ -3927,17 +4180,18 @@ export interface Stack {
|
|
|
3927
4180
|
* <ul>
|
|
3928
4181
|
* <li>
|
|
3929
4182
|
* <p>
|
|
3930
|
-
* <code>true</code>: disable rollback
|
|
4183
|
+
* <code>true</code>: disable rollback.</p>
|
|
3931
4184
|
* </li>
|
|
3932
4185
|
* <li>
|
|
3933
4186
|
* <p>
|
|
3934
|
-
* <code>false</code>: enable rollback
|
|
4187
|
+
* <code>false</code>: enable rollback.</p>
|
|
3935
4188
|
* </li>
|
|
3936
4189
|
* </ul>
|
|
3937
4190
|
*/
|
|
3938
4191
|
DisableRollback?: boolean;
|
|
3939
4192
|
/**
|
|
3940
|
-
* <p>SNS topic ARNs to which stack related events are
|
|
4193
|
+
* <p>Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are
|
|
4194
|
+
* published.</p>
|
|
3941
4195
|
*/
|
|
3942
4196
|
NotificationARNs?: string[];
|
|
3943
4197
|
/**
|
|
@@ -3953,8 +4207,8 @@ export interface Stack {
|
|
|
3953
4207
|
*/
|
|
3954
4208
|
Outputs?: Output[];
|
|
3955
4209
|
/**
|
|
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
|
|
4210
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
4211
|
+
* that's associated with the stack. During a stack operation, CloudFormation uses this
|
|
3958
4212
|
* role's credentials to make calls on your behalf.</p>
|
|
3959
4213
|
*/
|
|
3960
4214
|
RoleARN?: string;
|
|
@@ -3964,7 +4218,7 @@ export interface Stack {
|
|
|
3964
4218
|
Tags?: Tag[];
|
|
3965
4219
|
/**
|
|
3966
4220
|
* <p>Whether termination protection is enabled for the stack.</p>
|
|
3967
|
-
* <p>
|
|
4221
|
+
* <p>For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>,
|
|
3968
4222
|
* termination protection is set on the root stack and cannot be changed directly on the
|
|
3969
4223
|
* 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
4224
|
* Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
@@ -4024,13 +4278,14 @@ export interface DescribeStackSetInput {
|
|
|
4024
4278
|
StackSetName: string | undefined;
|
|
4025
4279
|
/**
|
|
4026
4280
|
* <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>
|
|
4281
|
+
* administrator in the organization's management account or as a delegated
|
|
4282
|
+
* administrator in a member account.</p>
|
|
4029
4283
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
4030
4284
|
* self-managed permissions.</p>
|
|
4031
4285
|
* <ul>
|
|
4032
4286
|
* <li>
|
|
4033
|
-
* <p>If you are signed in to the management account, specify
|
|
4287
|
+
* <p>If you are signed in to the management account, specify
|
|
4288
|
+
* <code>SELF</code>.</p>
|
|
4034
4289
|
* </li>
|
|
4035
4290
|
* <li>
|
|
4036
4291
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -4063,12 +4318,12 @@ export declare enum StackSetDriftStatus {
|
|
|
4063
4318
|
/**
|
|
4064
4319
|
* <p>Detailed information about the drift status of the stack set.</p>
|
|
4065
4320
|
* <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
|
|
4321
|
+
* operation performed on the stack set. Information about drift operations in-progress isn't
|
|
4322
|
+
* included.</p>
|
|
4068
4323
|
* <p>For stack set operations, includes information about drift operations currently being
|
|
4069
4324
|
* 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
|
-
*
|
|
4325
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting unmanaged
|
|
4326
|
+
* changes in stack sets</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4072
4327
|
*/
|
|
4073
4328
|
export interface StackSetDriftDetectionDetails {
|
|
4074
4329
|
/**
|
|
@@ -4086,7 +4341,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4086
4341
|
* </li>
|
|
4087
4342
|
* <li>
|
|
4088
4343
|
* <p>
|
|
4089
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
4344
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked the stack set for drift.</p>
|
|
4090
4345
|
* </li>
|
|
4091
4346
|
* <li>
|
|
4092
4347
|
* <p>
|
|
@@ -4107,7 +4362,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4107
4362
|
* <li>
|
|
4108
4363
|
* <p>
|
|
4109
4364
|
* <code>FAILED</code>: The drift detection operation exceeded the specified failure
|
|
4110
|
-
* tolerance
|
|
4365
|
+
* tolerance.</p>
|
|
4111
4366
|
* </li>
|
|
4112
4367
|
* <li>
|
|
4113
4368
|
* <p>
|
|
@@ -4121,7 +4376,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4121
4376
|
* </li>
|
|
4122
4377
|
* <li>
|
|
4123
4378
|
* <p>
|
|
4124
|
-
* <code>STOPPED</code>: The user has
|
|
4379
|
+
* <code>STOPPED</code>: The user has canceled the drift detection operation.</p>
|
|
4125
4380
|
* </li>
|
|
4126
4381
|
* </ul>
|
|
4127
4382
|
*/
|
|
@@ -4129,18 +4384,18 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4129
4384
|
/**
|
|
4130
4385
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
4131
4386
|
* the stack set. This value will be <code>NULL</code> for any stack set on which drift
|
|
4132
|
-
* detection
|
|
4387
|
+
* detection hasn't yet been performed.</p>
|
|
4133
4388
|
*/
|
|
4134
4389
|
LastDriftCheckTimestamp?: Date;
|
|
4135
4390
|
/**
|
|
4136
|
-
* <p>The total number of stack instances belonging to this stack set
|
|
4391
|
+
* <p>The total number of stack instances belonging to this stack set.</p>
|
|
4137
4392
|
* <p>The total number of stack instances is equal to the total of:</p>
|
|
4138
4393
|
* <ul>
|
|
4139
4394
|
* <li>
|
|
4140
|
-
* <p>Stack instances that match the stack set configuration
|
|
4395
|
+
* <p>Stack instances that match the stack set configuration.</p>
|
|
4141
4396
|
* </li>
|
|
4142
4397
|
* <li>
|
|
4143
|
-
* <p>Stack instances that have drifted from the stack set configuration
|
|
4398
|
+
* <p>Stack instances that have drifted from the stack set configuration.</p>
|
|
4144
4399
|
* </li>
|
|
4145
4400
|
* <li>
|
|
4146
4401
|
* <p>Stack instances where the drift detection operation has failed.</p>
|
|
@@ -4154,7 +4409,7 @@ export interface StackSetDriftDetectionDetails {
|
|
|
4154
4409
|
/**
|
|
4155
4410
|
* <p>The number of stack instances that have drifted from the expected template and parameter
|
|
4156
4411
|
* 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
|
|
4412
|
+
* more of the resources in the associated stack don't match their expected
|
|
4158
4413
|
* configuration.</p>
|
|
4159
4414
|
*/
|
|
4160
4415
|
DriftedStackInstancesCount?: number;
|
|
@@ -4182,8 +4437,8 @@ export declare type StackSetStatus = "ACTIVE" | "DELETED";
|
|
|
4182
4437
|
/**
|
|
4183
4438
|
* <p>A structure that contains information about a stack set. A stack set enables you to
|
|
4184
4439
|
* 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
|
-
*
|
|
4440
|
+
* CloudFormation template. In the stack set, you specify the template to use, in
|
|
4441
|
+
* addition to any parameters and capabilities that the template requires.</p>
|
|
4187
4442
|
*/
|
|
4188
4443
|
export interface StackSet {
|
|
4189
4444
|
/**
|
|
@@ -4215,8 +4470,9 @@ export interface StackSet {
|
|
|
4215
4470
|
/**
|
|
4216
4471
|
* <p>The capabilities that are allowed in the stack set. Some stack set templates might
|
|
4217
4472
|
* 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
|
-
*
|
|
4473
|
+
* example, by creating new Identity and Access Management (IAM) users. For more
|
|
4474
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation
|
|
4475
|
+
* Templates.</a>
|
|
4220
4476
|
* </p>
|
|
4221
4477
|
*/
|
|
4222
4478
|
Capabilities?: (Capability | string)[];
|
|
@@ -4230,24 +4486,25 @@ export interface StackSet {
|
|
|
4230
4486
|
*/
|
|
4231
4487
|
StackSetARN?: string;
|
|
4232
4488
|
/**
|
|
4233
|
-
* <p>The Amazon Resource Number (ARN) of the IAM role used to create or update
|
|
4234
|
-
* set.</p>
|
|
4489
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role used to create or update
|
|
4490
|
+
* the stack set.</p>
|
|
4235
4491
|
* <p>Use customized administrator roles to control which users or groups can manage specific
|
|
4236
4492
|
* 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
4493
|
* Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4238
4494
|
*/
|
|
4239
4495
|
AdministrationRoleARN?: string;
|
|
4240
4496
|
/**
|
|
4241
|
-
* <p>The name of the IAM execution role used to create or update the stack
|
|
4497
|
+
* <p>The name of the IAM execution role used to create or update the stack
|
|
4498
|
+
* set.</p>
|
|
4242
4499
|
* <p>Use customized execution roles to control which stack resources users and groups can
|
|
4243
|
-
* include in their stack sets
|
|
4500
|
+
* include in their stack sets.</p>
|
|
4244
4501
|
*/
|
|
4245
4502
|
ExecutionRoleName?: string;
|
|
4246
4503
|
/**
|
|
4247
4504
|
* <p>Detailed information about the drift status of the stack set.</p>
|
|
4248
4505
|
* <p>For stack sets, contains information about the last <i>completed</i> drift
|
|
4249
4506
|
* operation performed on the stack set. Information about drift operations currently in
|
|
4250
|
-
* progress
|
|
4507
|
+
* progress isn't included.</p>
|
|
4251
4508
|
*/
|
|
4252
4509
|
StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
|
|
4253
4510
|
/**
|
|
@@ -4257,7 +4514,8 @@ export interface StackSet {
|
|
|
4257
4514
|
*/
|
|
4258
4515
|
AutoDeployment?: AutoDeployment;
|
|
4259
4516
|
/**
|
|
4260
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
4517
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
4518
|
+
* created.</p>
|
|
4261
4519
|
* <ul>
|
|
4262
4520
|
* <li>
|
|
4263
4521
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -4267,8 +4525,7 @@ export interface StackSet {
|
|
|
4267
4525
|
* </li>
|
|
4268
4526
|
* <li>
|
|
4269
4527
|
* <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>
|
|
4528
|
+
* 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
4529
|
* </li>
|
|
4273
4530
|
* </ul>
|
|
4274
4531
|
*/
|
|
@@ -4308,18 +4565,19 @@ export interface DescribeStackSetOperationInput {
|
|
|
4308
4565
|
*/
|
|
4309
4566
|
StackSetName: string | undefined;
|
|
4310
4567
|
/**
|
|
4311
|
-
* <p>The unique ID of the stack set operation
|
|
4568
|
+
* <p>The unique ID of the stack set operation.</p>
|
|
4312
4569
|
*/
|
|
4313
4570
|
OperationId: string | undefined;
|
|
4314
4571
|
/**
|
|
4315
4572
|
* <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>
|
|
4573
|
+
* administrator in the organization's management account or as a delegated
|
|
4574
|
+
* administrator in a member account.</p>
|
|
4318
4575
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
4319
4576
|
* self-managed permissions.</p>
|
|
4320
4577
|
* <ul>
|
|
4321
4578
|
* <li>
|
|
4322
|
-
* <p>If you are signed in to the management account, specify
|
|
4579
|
+
* <p>If you are signed in to the management account, specify
|
|
4580
|
+
* <code>SELF</code>.</p>
|
|
4323
4581
|
* </li>
|
|
4324
4582
|
* <li>
|
|
4325
4583
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -4340,7 +4598,7 @@ export declare namespace DescribeStackSetOperationInput {
|
|
|
4340
4598
|
export declare type StackSetOperationAction = "CREATE" | "DELETE" | "DETECT_DRIFT" | "UPDATE";
|
|
4341
4599
|
export declare type StackSetOperationStatus = "FAILED" | "QUEUED" | "RUNNING" | "STOPPED" | "STOPPING" | "SUCCEEDED";
|
|
4342
4600
|
/**
|
|
4343
|
-
* <p>The structure that contains information about a stack set operation
|
|
4601
|
+
* <p>The structure that contains information about a stack set operation.</p>
|
|
4344
4602
|
*/
|
|
4345
4603
|
export interface StackSetOperation {
|
|
4346
4604
|
/**
|
|
@@ -4355,12 +4613,12 @@ export interface StackSetOperation {
|
|
|
4355
4613
|
* <p>The type of stack set operation: <code>CREATE</code>, <code>UPDATE</code>, or
|
|
4356
4614
|
* <code>DELETE</code>. Create and delete operations affect only the specified stack set
|
|
4357
4615
|
* instances that are associated with the specified stack set. Update operations affect both
|
|
4358
|
-
* the stack set itself,
|
|
4616
|
+
* the stack set itself, in addition to <i>all</i> associated stack set
|
|
4359
4617
|
* instances.</p>
|
|
4360
4618
|
*/
|
|
4361
4619
|
Action?: StackSetOperationAction | string;
|
|
4362
4620
|
/**
|
|
4363
|
-
* <p>The status of the operation
|
|
4621
|
+
* <p>The status of the operation.</p>
|
|
4364
4622
|
* <ul>
|
|
4365
4623
|
* <li>
|
|
4366
4624
|
* <p>
|
|
@@ -4376,8 +4634,7 @@ export interface StackSetOperation {
|
|
|
4376
4634
|
* <p>
|
|
4377
4635
|
* <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that
|
|
4378
4636
|
* 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>
|
|
4637
|
+
* 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
4638
|
* </li>
|
|
4382
4639
|
* <li>
|
|
4383
4640
|
* <p>
|
|
@@ -4385,12 +4642,12 @@ export interface StackSetOperation {
|
|
|
4385
4642
|
* </li>
|
|
4386
4643
|
* <li>
|
|
4387
4644
|
* <p>
|
|
4388
|
-
* <code>STOPPED</code>: The user has
|
|
4645
|
+
* <code>STOPPED</code>: The user has canceled the operation.</p>
|
|
4389
4646
|
* </li>
|
|
4390
4647
|
* <li>
|
|
4391
4648
|
* <p>
|
|
4392
4649
|
* <code>STOPPING</code>: The operation is in the process of stopping, at user
|
|
4393
|
-
* request
|
|
4650
|
+
* request.</p>
|
|
4394
4651
|
* </li>
|
|
4395
4652
|
* <li>
|
|
4396
4653
|
* <p>
|
|
@@ -4407,21 +4664,22 @@ export interface StackSetOperation {
|
|
|
4407
4664
|
/**
|
|
4408
4665
|
* <p>For stack set operations of action type <code>DELETE</code>, specifies whether to remove
|
|
4409
4666
|
* the stack instances from the specified stack set, but doesn't delete the stacks. You can't
|
|
4410
|
-
*
|
|
4667
|
+
* re-associate a retained stack, or add an existing, saved stack to a new stack set.</p>
|
|
4411
4668
|
*/
|
|
4412
4669
|
RetainStacks?: boolean;
|
|
4413
4670
|
/**
|
|
4414
|
-
* <p>The Amazon Resource Number (ARN) of the IAM role used to perform this
|
|
4415
|
-
* operation
|
|
4671
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role used to perform this
|
|
4672
|
+
* stack set operation.</p>
|
|
4416
4673
|
* <p>Use customized administrator roles to control which users or groups can manage specific
|
|
4417
4674
|
* 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
4675
|
* Administrators</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
4419
4676
|
*/
|
|
4420
4677
|
AdministrationRoleARN?: string;
|
|
4421
4678
|
/**
|
|
4422
|
-
* <p>The name of the IAM execution role used to create or update the stack
|
|
4679
|
+
* <p>The name of the IAM execution role used to create or update the stack
|
|
4680
|
+
* set.</p>
|
|
4423
4681
|
* <p>Use customized execution roles to control which stack resources users and groups can
|
|
4424
|
-
* include in their stack sets
|
|
4682
|
+
* include in their stack sets.</p>
|
|
4425
4683
|
*/
|
|
4426
4684
|
ExecutionRoleName?: string;
|
|
4427
4685
|
/**
|
|
@@ -4446,7 +4704,7 @@ export interface StackSetOperation {
|
|
|
4446
4704
|
/**
|
|
4447
4705
|
* <p>Detailed information about the drift status of the stack set. This includes information
|
|
4448
4706
|
* about drift operations currently being performed on the stack set.</p>
|
|
4449
|
-
* <p>
|
|
4707
|
+
* <p>This information will only be present for stack set operations whose <code>Action</code>
|
|
4450
4708
|
* type is <code>DETECT_DRIFT</code>.</p>
|
|
4451
4709
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting Unmanaged
|
|
4452
4710
|
* Changes in Stack Sets</a> in the CloudFormation User Guide.</p>
|
|
@@ -4481,7 +4739,7 @@ export interface OperationNotFoundException extends __SmithyException, $Metadata
|
|
|
4481
4739
|
}
|
|
4482
4740
|
export interface DescribeTypeInput {
|
|
4483
4741
|
/**
|
|
4484
|
-
* <p>The kind of extension
|
|
4742
|
+
* <p>The kind of extension.</p>
|
|
4485
4743
|
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
4486
4744
|
* <code>Arn</code>.</p>
|
|
4487
4745
|
*/
|
|
@@ -4535,17 +4793,17 @@ export declare type ProvisioningType = "FULLY_MUTABLE" | "IMMUTABLE" | "NON_PROV
|
|
|
4535
4793
|
export interface RequiredActivatedType {
|
|
4536
4794
|
/**
|
|
4537
4795
|
* <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>
|
|
4796
|
+
* alias for the extension, CloudFormation treats the alias as the extension type
|
|
4797
|
+
* name within this account and region. You must use the alias to refer to the extension in
|
|
4798
|
+
* your templates, API calls, and CloudFormation console.</p>
|
|
4541
4799
|
*/
|
|
4542
4800
|
TypeNameAlias?: string;
|
|
4543
4801
|
/**
|
|
4544
4802
|
* <p>The type name of the public extension.</p>
|
|
4545
4803
|
* <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
|
|
4804
|
+
* account and region, CloudFormation treats that alias as the extension's type name
|
|
4805
|
+
* within the account and region, not the type name of the public extension. For more
|
|
4806
|
+
* 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
4807
|
* <i>CloudFormation User Guide</i>.</p>
|
|
4550
4808
|
*/
|
|
4551
4809
|
OriginalTypeName?: string;
|
|
@@ -4577,24 +4835,23 @@ export interface DescribeTypeOutput {
|
|
|
4577
4835
|
*/
|
|
4578
4836
|
Arn?: string;
|
|
4579
4837
|
/**
|
|
4580
|
-
* <p>The kind of extension
|
|
4838
|
+
* <p>The kind of extension.</p>
|
|
4581
4839
|
*/
|
|
4582
4840
|
Type?: RegistryType | string;
|
|
4583
4841
|
/**
|
|
4584
4842
|
* <p>The name of the extension.</p>
|
|
4585
4843
|
* <p>If the extension is a public third-party type you have activated with a type name alias,
|
|
4586
|
-
*
|
|
4844
|
+
* 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
4845
|
*/
|
|
4588
4846
|
TypeName?: string;
|
|
4589
4847
|
/**
|
|
4590
4848
|
* <p>The ID of the default version of the extension. The default version is used when the
|
|
4591
|
-
* extension version
|
|
4849
|
+
* extension version isn't specified.</p>
|
|
4592
4850
|
* <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>
|
|
4851
|
+
* 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
4852
|
* <p>To set the default version of an extension, use <code>
|
|
4596
4853
|
* <a>SetTypeDefaultVersion</a>
|
|
4597
|
-
* </code
|
|
4854
|
+
* </code>.</p>
|
|
4598
4855
|
*/
|
|
4599
4856
|
DefaultVersionId?: string;
|
|
4600
4857
|
/**
|
|
@@ -4606,10 +4863,11 @@ export interface DescribeTypeOutput {
|
|
|
4606
4863
|
IsDefaultVersion?: boolean;
|
|
4607
4864
|
/**
|
|
4608
4865
|
* <p>The contract test status of the registered extension version. To return the extension
|
|
4609
|
-
* test status of a
|
|
4610
|
-
* <p>
|
|
4611
|
-
*
|
|
4612
|
-
*
|
|
4866
|
+
* test status of a specific extension version, you must specify
|
|
4867
|
+
* <code>VersionId</code>.</p>
|
|
4868
|
+
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4869
|
+
* doesn't return this information for public extensions, whether or not they are activated in
|
|
4870
|
+
* your account.</p>
|
|
4613
4871
|
* <ul>
|
|
4614
4872
|
* <li>
|
|
4615
4873
|
* <p>
|
|
@@ -4630,18 +4888,18 @@ export interface DescribeTypeOutput {
|
|
|
4630
4888
|
* </li>
|
|
4631
4889
|
* <li>
|
|
4632
4890
|
* <p>
|
|
4633
|
-
* <code>NOT_TESTED</code>: Contract tests
|
|
4891
|
+
* <code>NOT_TESTED</code>: Contract tests haven't been performed on the
|
|
4634
4892
|
* extension.</p>
|
|
4635
4893
|
* </li>
|
|
4636
4894
|
* </ul>
|
|
4637
4895
|
*/
|
|
4638
4896
|
TypeTestsStatus?: TypeTestsStatus | string;
|
|
4639
4897
|
/**
|
|
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>
|
|
4898
|
+
* <p>The description of the test status. To return the extension test status of a specific
|
|
4899
|
+
* extension version, you must specify <code>VersionId</code>.</p>
|
|
4900
|
+
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4901
|
+
* doesn't return this information for public extensions, whether or not they are activated in
|
|
4902
|
+
* your account.</p>
|
|
4645
4903
|
*/
|
|
4646
4904
|
TypeTestsStatusDescription?: string;
|
|
4647
4905
|
/**
|
|
@@ -4668,14 +4926,14 @@ export interface DescribeTypeOutput {
|
|
|
4668
4926
|
* </li>
|
|
4669
4927
|
* <li>
|
|
4670
4928
|
* <p>
|
|
4671
|
-
* <code>IMMUTABLE</code>: The resource type
|
|
4672
|
-
* the type
|
|
4929
|
+
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so
|
|
4930
|
+
* the type can't be updated and must instead be replaced during stack update
|
|
4673
4931
|
* operations.</p>
|
|
4674
4932
|
* </li>
|
|
4675
4933
|
* <li>
|
|
4676
4934
|
* <p>
|
|
4677
|
-
* <code>NON_PROVISIONABLE</code>: The resource type
|
|
4678
|
-
* following handlers, and therefore
|
|
4935
|
+
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include all the
|
|
4936
|
+
* following handlers, and therefore can't actually be provisioned.</p>
|
|
4679
4937
|
* <ul>
|
|
4680
4938
|
* <li>
|
|
4681
4939
|
* <p>create</p>
|
|
@@ -4704,17 +4962,18 @@ export interface DescribeTypeOutput {
|
|
|
4704
4962
|
* <li>
|
|
4705
4963
|
* <p>
|
|
4706
4964
|
* <code>DEPRECATED</code>: The extension has been deactivated or deregistered and
|
|
4707
|
-
* can no longer be used in CloudFormation operations
|
|
4965
|
+
* can no longer be used in CloudFormation operations.</p>
|
|
4708
4966
|
* </li>
|
|
4709
4967
|
* </ul>
|
|
4710
|
-
* <p>For public third-party extensions, CloudFormation returns
|
|
4968
|
+
* <p>For public third-party extensions, CloudFormation returns
|
|
4969
|
+
* <code>null</code>.</p>
|
|
4711
4970
|
*/
|
|
4712
4971
|
DeprecatedStatus?: DeprecatedStatus | string;
|
|
4713
4972
|
/**
|
|
4714
4973
|
* <p>Contains logging configuration information for private extensions. This applies only to
|
|
4715
4974
|
* private extensions you have registered in your account. For public extensions, both those
|
|
4716
4975
|
* provided by Amazon and published by third parties, CloudFormation returns
|
|
4717
|
-
*
|
|
4976
|
+
* <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4718
4977
|
*/
|
|
4719
4978
|
LoggingConfig?: LoggingConfig;
|
|
4720
4979
|
/**
|
|
@@ -4723,17 +4982,17 @@ export interface DescribeTypeOutput {
|
|
|
4723
4982
|
*/
|
|
4724
4983
|
RequiredActivatedTypes?: RequiredActivatedType[];
|
|
4725
4984
|
/**
|
|
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>
|
|
4985
|
+
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to register
|
|
4986
|
+
* the extension. This applies only to private extensions you have registered in your account.
|
|
4987
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4729
4988
|
* <p></p>
|
|
4730
4989
|
* <p>If the registered extension calls any Amazon Web Services APIs, you must create an
|
|
4731
4990
|
* <i>
|
|
4732
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
|
4733
|
-
*
|
|
4734
|
-
*
|
|
4735
|
-
*
|
|
4736
|
-
* appropriate credentials.</p>
|
|
4991
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a>
|
|
4992
|
+
* </i> that includes the necessary
|
|
4993
|
+
* permissions to call those Amazon Web Services APIs, and provision that execution role in
|
|
4994
|
+
* your account. CloudFormation then assumes that execution role to provide your
|
|
4995
|
+
* extension with the appropriate credentials.</p>
|
|
4737
4996
|
*/
|
|
4738
4997
|
ExecutionRoleArn?: string;
|
|
4739
4998
|
/**
|
|
@@ -4749,7 +5008,7 @@ export interface DescribeTypeOutput {
|
|
|
4749
5008
|
* </li>
|
|
4750
5009
|
* <li>
|
|
4751
5010
|
* <p>
|
|
4752
|
-
* <code>PUBLIC</code>: The extension is
|
|
5011
|
+
* <code>PUBLIC</code>: The extension is publicly visible and usable within any
|
|
4753
5012
|
* Amazon account.</p>
|
|
4754
5013
|
* </li>
|
|
4755
5014
|
* </ul>
|
|
@@ -4779,29 +5038,29 @@ export interface DescribeTypeOutput {
|
|
|
4779
5038
|
LastUpdated?: Date;
|
|
4780
5039
|
/**
|
|
4781
5040
|
* <p>When the specified private extension version was registered or activated in your
|
|
4782
|
-
* account
|
|
5041
|
+
* account.</p>
|
|
4783
5042
|
*/
|
|
4784
5043
|
TimeCreated?: Date;
|
|
4785
5044
|
/**
|
|
4786
5045
|
* <p>A JSON string that represent the current configuration data for the extension in this
|
|
4787
5046
|
* 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>
|
|
5047
|
+
* <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
5048
|
*/
|
|
4791
5049
|
ConfigurationSchema?: string;
|
|
4792
5050
|
/**
|
|
4793
5051
|
* <p>The publisher ID of the extension publisher.</p>
|
|
4794
5052
|
* <p>This applies only to public third-party extensions. For private registered extensions,
|
|
4795
|
-
* and extensions provided by Amazon, CloudFormation returns
|
|
5053
|
+
* and extensions provided by Amazon Web Services, CloudFormation returns
|
|
5054
|
+
* <code>null</code>.</p>
|
|
4796
5055
|
*/
|
|
4797
5056
|
PublisherId?: string;
|
|
4798
5057
|
/**
|
|
4799
5058
|
* <p>For public extensions that have been activated for this account and region, the type
|
|
4800
5059
|
* name of the public extension.</p>
|
|
4801
5060
|
* <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
|
|
5061
|
+
* account and region, CloudFormation treats that alias as the extension's type name
|
|
5062
|
+
* within the account and region, not the type name of the public extension. For more
|
|
5063
|
+
* 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
5064
|
* <i>CloudFormation User Guide</i>.</p>
|
|
4806
5065
|
*/
|
|
4807
5066
|
OriginalTypeName?: string;
|
|
@@ -4814,27 +5073,26 @@ export interface DescribeTypeOutput {
|
|
|
4814
5073
|
* <p>The version number of a public third-party extension.</p>
|
|
4815
5074
|
* <p>This applies only if you specify a public extension you have activated in your account,
|
|
4816
5075
|
* or specify a public extension without specifying a version. For all other extensions,
|
|
4817
|
-
*
|
|
5076
|
+
* CloudFormation returns <code>null</code>.</p>
|
|
4818
5077
|
*/
|
|
4819
5078
|
PublicVersionNumber?: string;
|
|
4820
5079
|
/**
|
|
4821
5080
|
* <p>The latest version of a public extension <i>that is available</i> for
|
|
4822
5081
|
* use.</p>
|
|
4823
|
-
* <p>This only applies if you specify a public extension, and you
|
|
5082
|
+
* <p>This only applies if you specify a public extension, and you don't specify a version.
|
|
4824
5083
|
* For all other requests, CloudFormation returns <code>null</code>.</p>
|
|
4825
5084
|
*/
|
|
4826
5085
|
LatestPublicVersion?: string;
|
|
4827
5086
|
/**
|
|
4828
5087
|
* <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>
|
|
5088
|
+
* <p>This only applies to public third-party extensions. For all other extensions, CloudFormation returns <code>null</code>.</p>
|
|
4831
5089
|
*/
|
|
4832
5090
|
IsActivated?: boolean;
|
|
4833
5091
|
/**
|
|
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>
|
|
5092
|
+
* <p>Whether CloudFormation automatically updates the extension in this account and
|
|
5093
|
+
* region when a new <i>minor</i> version is published by the extension
|
|
5094
|
+
* publisher. Major versions released by the publisher must be manually updated. For more
|
|
5095
|
+
* 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
5096
|
*/
|
|
4839
5097
|
AutoUpdate?: boolean;
|
|
4840
5098
|
}
|
|
@@ -4958,7 +5216,7 @@ export interface DetectStackSetDriftInput {
|
|
|
4958
5216
|
StackSetName: string | undefined;
|
|
4959
5217
|
/**
|
|
4960
5218
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
4961
|
-
* operation
|
|
5219
|
+
* operation.</p>
|
|
4962
5220
|
* <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
5221
|
*/
|
|
4964
5222
|
OperationPreferences?: StackSetOperationPreferences;
|
|
@@ -4970,13 +5228,14 @@ export interface DetectStackSetDriftInput {
|
|
|
4970
5228
|
OperationId?: string;
|
|
4971
5229
|
/**
|
|
4972
5230
|
* <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>
|
|
5231
|
+
* administrator in the organization's management account or as a delegated
|
|
5232
|
+
* administrator in a member account.</p>
|
|
4975
5233
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
4976
5234
|
* self-managed permissions.</p>
|
|
4977
5235
|
* <ul>
|
|
4978
5236
|
* <li>
|
|
4979
|
-
* <p>If you are signed in to the management account, specify
|
|
5237
|
+
* <p>If you are signed in to the management account, specify
|
|
5238
|
+
* <code>SELF</code>.</p>
|
|
4980
5239
|
* </li>
|
|
4981
5240
|
* <li>
|
|
4982
5241
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -4996,10 +5255,10 @@ export declare namespace DetectStackSetDriftInput {
|
|
|
4996
5255
|
}
|
|
4997
5256
|
export interface DetectStackSetDriftOutput {
|
|
4998
5257
|
/**
|
|
4999
|
-
* <p>The ID of the drift detection stack set operation
|
|
5000
|
-
* <p>
|
|
5258
|
+
* <p>The ID of the drift detection stack set operation.</p>
|
|
5259
|
+
* <p>You can use this operation ID with <code>
|
|
5001
5260
|
* <a>DescribeStackSetOperation</a>
|
|
5002
|
-
* </code> to monitor the progress of the drift detection operation
|
|
5261
|
+
* </code> to monitor the progress of the drift detection operation.</p>
|
|
5003
5262
|
*/
|
|
5004
5263
|
OperationId?: string;
|
|
5005
5264
|
}
|
|
@@ -5022,9 +5281,9 @@ export interface EstimateTemplateCostInput {
|
|
|
5022
5281
|
*/
|
|
5023
5282
|
TemplateBody?: string;
|
|
5024
5283
|
/**
|
|
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
|
-
*
|
|
5284
|
+
* <p>Location of file containing the template body. The URL must point to a template that's
|
|
5285
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
5286
|
+
* go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
5028
5287
|
* in the CloudFormation User Guide.</p>
|
|
5029
5288
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
5030
5289
|
* both are passed, only <code>TemplateBody</code> is used.</p>
|
|
@@ -5062,21 +5321,21 @@ export declare namespace EstimateTemplateCostOutput {
|
|
|
5062
5321
|
*/
|
|
5063
5322
|
export interface ExecuteChangeSetInput {
|
|
5064
5323
|
/**
|
|
5065
|
-
* <p>The name or ARN of the change set that you want use to update the
|
|
5066
|
-
* stack.</p>
|
|
5324
|
+
* <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the
|
|
5325
|
+
* specified stack.</p>
|
|
5067
5326
|
*/
|
|
5068
5327
|
ChangeSetName: string | undefined;
|
|
5069
5328
|
/**
|
|
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>
|
|
5329
|
+
* <p>If you specified the name of a change set, specify the stack name or Amazon Resource
|
|
5330
|
+
* Name (ARN) that's associated with the change set you want to execute.</p>
|
|
5072
5331
|
*/
|
|
5073
5332
|
StackName?: string;
|
|
5074
5333
|
/**
|
|
5075
5334
|
* <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
|
-
*
|
|
5335
|
+
* if you plan to retry requests so that CloudFormation knows that you're not attempting
|
|
5336
|
+
* to execute a change set to update a stack with the same name. You might retry
|
|
5337
|
+
* <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully
|
|
5338
|
+
* received them.</p>
|
|
5080
5339
|
*/
|
|
5081
5340
|
ClientRequestToken?: string;
|
|
5082
5341
|
/**
|
|
@@ -5108,7 +5367,7 @@ export declare namespace ExecuteChangeSetOutput {
|
|
|
5108
5367
|
*/
|
|
5109
5368
|
export interface GetStackPolicyInput {
|
|
5110
5369
|
/**
|
|
5111
|
-
* <p>The name or unique stack ID that
|
|
5370
|
+
* <p>The name or unique stack ID that's associated with the stack whose policy you want to
|
|
5112
5371
|
* get.</p>
|
|
5113
5372
|
*/
|
|
5114
5373
|
StackName: string | undefined;
|
|
@@ -5144,7 +5403,7 @@ export declare enum TemplateStage {
|
|
|
5144
5403
|
*/
|
|
5145
5404
|
export interface GetTemplateInput {
|
|
5146
5405
|
/**
|
|
5147
|
-
* <p>The name or the unique stack ID that
|
|
5406
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
5148
5407
|
* interchangeable:</p>
|
|
5149
5408
|
* <ul>
|
|
5150
5409
|
* <li>
|
|
@@ -5211,7 +5470,7 @@ export declare namespace GetTemplateOutput {
|
|
|
5211
5470
|
export interface GetTemplateSummaryInput {
|
|
5212
5471
|
/**
|
|
5213
5472
|
* <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
|
|
5473
|
+
* 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
5474
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
5216
5475
|
* <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or
|
|
5217
5476
|
* <code>TemplateURL</code>.</p>
|
|
@@ -5219,8 +5478,8 @@ export interface GetTemplateSummaryInput {
|
|
|
5219
5478
|
TemplateBody?: string;
|
|
5220
5479
|
/**
|
|
5221
5480
|
* <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
|
|
5481
|
+
* size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager
|
|
5482
|
+
* document. For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a>
|
|
5224
5483
|
* in the CloudFormation User Guide.</p>
|
|
5225
5484
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
5226
5485
|
* <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or
|
|
@@ -5228,7 +5487,7 @@ export interface GetTemplateSummaryInput {
|
|
|
5228
5487
|
*/
|
|
5229
5488
|
TemplateURL?: string;
|
|
5230
5489
|
/**
|
|
5231
|
-
* <p>The name or the stack ID that
|
|
5490
|
+
* <p>The name or the stack ID that's associated with the stack, which aren't always
|
|
5232
5491
|
* interchangeable. For running stacks, you can specify either the stack's name or its unique
|
|
5233
5492
|
* stack ID. For deleted stack, you must specify the unique stack ID.</p>
|
|
5234
5493
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
@@ -5245,13 +5504,14 @@ export interface GetTemplateSummaryInput {
|
|
|
5245
5504
|
StackSetName?: string;
|
|
5246
5505
|
/**
|
|
5247
5506
|
* <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>
|
|
5507
|
+
* administrator in the organization's management account or as a delegated
|
|
5508
|
+
* administrator in a member account.</p>
|
|
5250
5509
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
5251
5510
|
* self-managed permissions.</p>
|
|
5252
5511
|
* <ul>
|
|
5253
5512
|
* <li>
|
|
5254
|
-
* <p>If you are signed in to the management account, specify
|
|
5513
|
+
* <p>If you are signed in to the management account, specify
|
|
5514
|
+
* <code>SELF</code>.</p>
|
|
5255
5515
|
* </li>
|
|
5256
5516
|
* <li>
|
|
5257
5517
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -5270,9 +5530,9 @@ export declare namespace GetTemplateSummaryInput {
|
|
|
5270
5530
|
const filterSensitiveLog: (obj: GetTemplateSummaryInput) => any;
|
|
5271
5531
|
}
|
|
5272
5532
|
/**
|
|
5273
|
-
* <p>A set of criteria that CloudFormation uses to validate parameter values.
|
|
5274
|
-
*
|
|
5275
|
-
*
|
|
5533
|
+
* <p>A set of criteria that CloudFormation uses to validate parameter values. Although
|
|
5534
|
+
* other constraints might be defined in the stack template, CloudFormation returns only
|
|
5535
|
+
* the <code>AllowedValues</code> property.</p>
|
|
5276
5536
|
*/
|
|
5277
5537
|
export interface ParameterConstraints {
|
|
5278
5538
|
/**
|
|
@@ -5291,7 +5551,7 @@ export declare namespace ParameterConstraints {
|
|
|
5291
5551
|
*/
|
|
5292
5552
|
export interface ParameterDeclaration {
|
|
5293
5553
|
/**
|
|
5294
|
-
* <p>The name that
|
|
5554
|
+
* <p>The name that's associated with the parameter.</p>
|
|
5295
5555
|
*/
|
|
5296
5556
|
ParameterKey?: string;
|
|
5297
5557
|
/**
|
|
@@ -5308,7 +5568,7 @@ export interface ParameterDeclaration {
|
|
|
5308
5568
|
*/
|
|
5309
5569
|
NoEcho?: boolean;
|
|
5310
5570
|
/**
|
|
5311
|
-
* <p>The description that
|
|
5571
|
+
* <p>The description that's associate with the parameter.</p>
|
|
5312
5572
|
*/
|
|
5313
5573
|
Description?: string;
|
|
5314
5574
|
/**
|
|
@@ -5361,7 +5621,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
5361
5621
|
*/
|
|
5362
5622
|
Parameters?: ParameterDeclaration[];
|
|
5363
5623
|
/**
|
|
5364
|
-
* <p>The value that
|
|
5624
|
+
* <p>The value that's defined in the <code>Description</code> property of the
|
|
5365
5625
|
* template.</p>
|
|
5366
5626
|
*/
|
|
5367
5627
|
Description?: string;
|
|
@@ -5391,7 +5651,7 @@ export interface GetTemplateSummaryOutput {
|
|
|
5391
5651
|
*/
|
|
5392
5652
|
Version?: string;
|
|
5393
5653
|
/**
|
|
5394
|
-
* <p>The value that
|
|
5654
|
+
* <p>The value that's defined for the <code>Metadata</code> property of the template.</p>
|
|
5395
5655
|
*/
|
|
5396
5656
|
Metadata?: string;
|
|
5397
5657
|
/**
|
|
@@ -5430,13 +5690,13 @@ export interface ImportStacksToStackSetInput {
|
|
|
5430
5690
|
*/
|
|
5431
5691
|
StackIdsUrl?: string;
|
|
5432
5692
|
/**
|
|
5433
|
-
* <p>The list of OU ID
|
|
5693
|
+
* <p>The list of OU ID's to which the stacks being imported has to be mapped as deployment
|
|
5434
5694
|
* target.</p>
|
|
5435
5695
|
*/
|
|
5436
5696
|
OrganizationalUnitIds?: string[];
|
|
5437
5697
|
/**
|
|
5438
5698
|
* <p>The user-specified preferences for how CloudFormation performs a stack set
|
|
5439
|
-
* operation
|
|
5699
|
+
* operation.</p>
|
|
5440
5700
|
* <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
5701
|
*/
|
|
5442
5702
|
OperationPreferences?: StackSetOperationPreferences;
|
|
@@ -5449,7 +5709,8 @@ export interface ImportStacksToStackSetInput {
|
|
|
5449
5709
|
* self-managed permissions.</p>
|
|
5450
5710
|
* <ul>
|
|
5451
5711
|
* <li>
|
|
5452
|
-
* <p>If you are signed in to the management account, specify
|
|
5712
|
+
* <p>If you are signed in to the management account, specify
|
|
5713
|
+
* <code>SELF</code>.</p>
|
|
5453
5714
|
* </li>
|
|
5454
5715
|
* <li>
|
|
5455
5716
|
* <p>For service managed stack sets, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
@@ -5477,7 +5738,7 @@ export declare namespace ImportStacksToStackSetOutput {
|
|
|
5477
5738
|
const filterSensitiveLog: (obj: ImportStacksToStackSetOutput) => any;
|
|
5478
5739
|
}
|
|
5479
5740
|
/**
|
|
5480
|
-
* <p>The specified stack ARN doesn
|
|
5741
|
+
* <p>The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in
|
|
5481
5742
|
* input.</p>
|
|
5482
5743
|
*/
|
|
5483
5744
|
export interface StackNotFoundException extends __SmithyException, $MetadataBearer {
|
|
@@ -5517,7 +5778,7 @@ export interface ListChangeSetsOutput {
|
|
|
5517
5778
|
Summaries?: ChangeSetSummary[];
|
|
5518
5779
|
/**
|
|
5519
5780
|
* <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
|
|
5781
|
+
* there is no additional page, this value is <code>null</code>.</p>
|
|
5521
5782
|
*/
|
|
5522
5783
|
NextToken?: string;
|
|
5523
5784
|
}
|
|
@@ -5587,8 +5848,8 @@ export declare namespace ListExportsOutput {
|
|
|
5587
5848
|
}
|
|
5588
5849
|
export interface ListImportsInput {
|
|
5589
5850
|
/**
|
|
5590
|
-
* <p>The name of the exported output value. CloudFormation returns the stack names
|
|
5591
|
-
*
|
|
5851
|
+
* <p>The name of the exported output value. CloudFormation returns the stack names that
|
|
5852
|
+
* are importing this value.</p>
|
|
5592
5853
|
*/
|
|
5593
5854
|
ExportName: string | undefined;
|
|
5594
5855
|
/**
|
|
@@ -5670,18 +5931,19 @@ export interface ListStackInstancesInput {
|
|
|
5670
5931
|
*/
|
|
5671
5932
|
StackInstanceAccount?: string;
|
|
5672
5933
|
/**
|
|
5673
|
-
* <p>The name of the Region where you want to list stack instances
|
|
5934
|
+
* <p>The name of the Region where you want to list stack instances.</p>
|
|
5674
5935
|
*/
|
|
5675
5936
|
StackInstanceRegion?: string;
|
|
5676
5937
|
/**
|
|
5677
5938
|
* <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>
|
|
5939
|
+
* administrator in the organization's management account or as a delegated
|
|
5940
|
+
* administrator in a member account.</p>
|
|
5680
5941
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
5681
5942
|
* self-managed permissions.</p>
|
|
5682
5943
|
* <ul>
|
|
5683
5944
|
* <li>
|
|
5684
|
-
* <p>If you are signed in to the management account, specify
|
|
5945
|
+
* <p>If you are signed in to the management account, specify
|
|
5946
|
+
* <code>SELF</code>.</p>
|
|
5685
5947
|
* </li>
|
|
5686
5948
|
* <li>
|
|
5687
5949
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -5742,12 +6004,12 @@ export interface StackInstanceSummary {
|
|
|
5742
6004
|
* <ul>
|
|
5743
6005
|
* <li>
|
|
5744
6006
|
* <p>The associated stack failed during a <code>CreateStackSet</code> or
|
|
5745
|
-
* <code>UpdateStackSet</code> operation
|
|
6007
|
+
* <code>UpdateStackSet</code> operation.</p>
|
|
5746
6008
|
* </li>
|
|
5747
6009
|
* <li>
|
|
5748
6010
|
* <p>The stack was part of a <code>CreateStackSet</code> or
|
|
5749
6011
|
* <code>UpdateStackSet</code> operation that failed or was stopped before the
|
|
5750
|
-
* stack was created or updated
|
|
6012
|
+
* stack was created or updated.</p>
|
|
5751
6013
|
* </li>
|
|
5752
6014
|
* </ul>
|
|
5753
6015
|
* </li>
|
|
@@ -5773,7 +6035,7 @@ export interface StackInstanceSummary {
|
|
|
5773
6035
|
OrganizationalUnitId?: string;
|
|
5774
6036
|
/**
|
|
5775
6037
|
* <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
|
|
6038
|
+
* and parameter configuration of the stack set to which it belongs.</p>
|
|
5777
6039
|
* <ul>
|
|
5778
6040
|
* <li>
|
|
5779
6041
|
* <p>
|
|
@@ -5784,7 +6046,7 @@ export interface StackInstanceSummary {
|
|
|
5784
6046
|
* </li>
|
|
5785
6047
|
* <li>
|
|
5786
6048
|
* <p>
|
|
5787
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6049
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack instance differs from
|
|
5788
6050
|
* its expected stack set configuration.</p>
|
|
5789
6051
|
* </li>
|
|
5790
6052
|
* <li>
|
|
@@ -5802,7 +6064,7 @@ export interface StackInstanceSummary {
|
|
|
5802
6064
|
/**
|
|
5803
6065
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
5804
6066
|
* the stack instance. This value will be <code>NULL</code> for any stack instance on which
|
|
5805
|
-
* drift detection
|
|
6067
|
+
* drift detection hasn't yet been performed.</p>
|
|
5806
6068
|
*/
|
|
5807
6069
|
LastDriftCheckTimestamp?: Date;
|
|
5808
6070
|
}
|
|
@@ -5819,10 +6081,10 @@ export interface ListStackInstancesOutput {
|
|
|
5819
6081
|
*/
|
|
5820
6082
|
Summaries?: StackInstanceSummary[];
|
|
5821
6083
|
/**
|
|
5822
|
-
* <p>If the request doesn't return all
|
|
5823
|
-
*
|
|
5824
|
-
*
|
|
5825
|
-
*
|
|
6084
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set
|
|
6085
|
+
* to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again
|
|
6086
|
+
* and assign that token to the request object's <code>NextToken</code> parameter. If the
|
|
6087
|
+
* request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
5826
6088
|
*/
|
|
5827
6089
|
NextToken?: string;
|
|
5828
6090
|
}
|
|
@@ -5837,7 +6099,7 @@ export declare namespace ListStackInstancesOutput {
|
|
|
5837
6099
|
*/
|
|
5838
6100
|
export interface ListStackResourcesInput {
|
|
5839
6101
|
/**
|
|
5840
|
-
* <p>The name or the unique stack ID that is associated with the stack, which
|
|
6102
|
+
* <p>The name or the unique stack ID that is associated with the stack, which aren't always
|
|
5841
6103
|
* interchangeable:</p>
|
|
5842
6104
|
* <ul>
|
|
5843
6105
|
* <li>
|
|
@@ -5870,7 +6132,7 @@ export declare namespace ListStackResourcesInput {
|
|
|
5870
6132
|
export interface StackResourceDriftInformationSummary {
|
|
5871
6133
|
/**
|
|
5872
6134
|
* <p>Status of the resource's actual configuration compared to its expected
|
|
5873
|
-
* configuration
|
|
6135
|
+
* configuration.</p>
|
|
5874
6136
|
* <ul>
|
|
5875
6137
|
* <li>
|
|
5876
6138
|
* <p>
|
|
@@ -5884,16 +6146,16 @@ export interface StackResourceDriftInformationSummary {
|
|
|
5884
6146
|
* </li>
|
|
5885
6147
|
* <li>
|
|
5886
6148
|
* <p>
|
|
5887
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6149
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the resource differs from its
|
|
5888
6150
|
* expected configuration.</p>
|
|
5889
|
-
* <p>Any resources that
|
|
6151
|
+
* <p>Any resources that don't currently support drift detection have a status of
|
|
5890
6152
|
* <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
6153
|
* <code>ResourcesToSkip</code> will also have a status of <code>NOT_CHECKED</code>.
|
|
5892
6154
|
* 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
6155
|
* </li>
|
|
5894
6156
|
* <li>
|
|
5895
6157
|
* <p>
|
|
5896
|
-
* <code>IN_SYNC</code>: The
|
|
6158
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
5897
6159
|
* configuration.</p>
|
|
5898
6160
|
* </li>
|
|
5899
6161
|
* </ul>
|
|
@@ -5925,8 +6187,7 @@ export interface StackResourceSummary {
|
|
|
5925
6187
|
*/
|
|
5926
6188
|
PhysicalResourceId?: string;
|
|
5927
6189
|
/**
|
|
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>
|
|
6190
|
+
* <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
6191
|
*/
|
|
5931
6192
|
ResourceType: string | undefined;
|
|
5932
6193
|
/**
|
|
@@ -6010,7 +6271,7 @@ export declare namespace ListStacksInput {
|
|
|
6010
6271
|
export interface StackDriftInformationSummary {
|
|
6011
6272
|
/**
|
|
6012
6273
|
* <p>Status of the stack's actual configuration compared to its expected template
|
|
6013
|
-
* configuration
|
|
6274
|
+
* configuration.</p>
|
|
6014
6275
|
* <ul>
|
|
6015
6276
|
* <li>
|
|
6016
6277
|
* <p>
|
|
@@ -6020,7 +6281,7 @@ export interface StackDriftInformationSummary {
|
|
|
6020
6281
|
* </li>
|
|
6021
6282
|
* <li>
|
|
6022
6283
|
* <p>
|
|
6023
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6284
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its
|
|
6024
6285
|
* expected template configuration.</p>
|
|
6025
6286
|
* </li>
|
|
6026
6287
|
* <li>
|
|
@@ -6160,13 +6421,14 @@ export interface ListStackSetOperationResultsInput {
|
|
|
6160
6421
|
MaxResults?: number;
|
|
6161
6422
|
/**
|
|
6162
6423
|
* <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>
|
|
6424
|
+
* administrator in the organization's management account or as a delegated
|
|
6425
|
+
* administrator in a member account.</p>
|
|
6165
6426
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
6166
6427
|
* self-managed permissions.</p>
|
|
6167
6428
|
* <ul>
|
|
6168
6429
|
* <li>
|
|
6169
|
-
* <p>If you are signed in to the management account, specify
|
|
6430
|
+
* <p>If you are signed in to the management account, specify
|
|
6431
|
+
* <code>SELF</code>.</p>
|
|
6170
6432
|
* </li>
|
|
6171
6433
|
* <li>
|
|
6172
6434
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -6206,14 +6468,15 @@ export interface StackSetOperationResultSummary {
|
|
|
6206
6468
|
* <li>
|
|
6207
6469
|
* <p>
|
|
6208
6470
|
* <code>CANCELLED</code>: The operation in the specified account and Region has been
|
|
6209
|
-
*
|
|
6471
|
+
* canceled. This is either because a user has stopped the stack set operation, or
|
|
6210
6472
|
* because the failure tolerance of the stack set operation has been exceeded.</p>
|
|
6211
6473
|
* </li>
|
|
6212
6474
|
* <li>
|
|
6213
6475
|
* <p>
|
|
6214
|
-
* <code>FAILED</code>: The operation in the specified account and Region
|
|
6476
|
+
* <code>FAILED</code>: The operation in the specified account and Region
|
|
6477
|
+
* failed.</p>
|
|
6215
6478
|
* <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
|
|
6479
|
+
* tolerance for the stack set operation as a whole might be exceeded.</p>
|
|
6217
6480
|
* </li>
|
|
6218
6481
|
* <li>
|
|
6219
6482
|
* <p>
|
|
@@ -6223,7 +6486,7 @@ export interface StackSetOperationResultSummary {
|
|
|
6223
6486
|
* <li>
|
|
6224
6487
|
* <p>
|
|
6225
6488
|
* <code>PENDING</code>: The operation in the specified account and Region has yet to
|
|
6226
|
-
* start
|
|
6489
|
+
* start.</p>
|
|
6227
6490
|
* </li>
|
|
6228
6491
|
* <li>
|
|
6229
6492
|
* <p>
|
|
@@ -6239,7 +6502,7 @@ export interface StackSetOperationResultSummary {
|
|
|
6239
6502
|
StatusReason?: string;
|
|
6240
6503
|
/**
|
|
6241
6504
|
* <p>The results of the account gate function CloudFormation invokes, if present,
|
|
6242
|
-
* before proceeding with stack set operations in an account
|
|
6505
|
+
* before proceeding with stack set operations in an account.</p>
|
|
6243
6506
|
*/
|
|
6244
6507
|
AccountGateResult?: AccountGateResult;
|
|
6245
6508
|
/**
|
|
@@ -6257,8 +6520,7 @@ export declare namespace StackSetOperationResultSummary {
|
|
|
6257
6520
|
export interface ListStackSetOperationResultsOutput {
|
|
6258
6521
|
/**
|
|
6259
6522
|
* <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>
|
|
6523
|
+
* information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.</p>
|
|
6262
6524
|
*/
|
|
6263
6525
|
Summaries?: StackSetOperationResultSummary[];
|
|
6264
6526
|
/**
|
|
@@ -6299,13 +6561,14 @@ export interface ListStackSetOperationsInput {
|
|
|
6299
6561
|
MaxResults?: number;
|
|
6300
6562
|
/**
|
|
6301
6563
|
* <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>
|
|
6564
|
+
* administrator in the organization's management account or as a delegated
|
|
6565
|
+
* administrator in a member account.</p>
|
|
6304
6566
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
6305
6567
|
* self-managed permissions.</p>
|
|
6306
6568
|
* <ul>
|
|
6307
6569
|
* <li>
|
|
6308
|
-
* <p>If you are signed in to the management account, specify
|
|
6570
|
+
* <p>If you are signed in to the management account, specify
|
|
6571
|
+
* <code>SELF</code>.</p>
|
|
6309
6572
|
* </li>
|
|
6310
6573
|
* <li>
|
|
6311
6574
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -6334,7 +6597,7 @@ export interface StackSetOperationSummary {
|
|
|
6334
6597
|
/**
|
|
6335
6598
|
* <p>The type of operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>.
|
|
6336
6599
|
* 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
|
|
6600
|
+
* with the specified stack set. Update operations affect both the stack set itself and
|
|
6338
6601
|
* <i>all</i> associated stack set instances.</p>
|
|
6339
6602
|
*/
|
|
6340
6603
|
Action?: StackSetOperationAction | string;
|
|
@@ -6355,8 +6618,7 @@ export interface StackSetOperationSummary {
|
|
|
6355
6618
|
* <p>
|
|
6356
6619
|
* <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that
|
|
6357
6620
|
* 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>
|
|
6621
|
+
* 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
6622
|
* </li>
|
|
6361
6623
|
* <li>
|
|
6362
6624
|
* <p>
|
|
@@ -6364,12 +6626,12 @@ export interface StackSetOperationSummary {
|
|
|
6364
6626
|
* </li>
|
|
6365
6627
|
* <li>
|
|
6366
6628
|
* <p>
|
|
6367
|
-
* <code>STOPPED</code>: The user has
|
|
6629
|
+
* <code>STOPPED</code>: The user has canceled the operation.</p>
|
|
6368
6630
|
* </li>
|
|
6369
6631
|
* <li>
|
|
6370
6632
|
* <p>
|
|
6371
6633
|
* <code>STOPPING</code>: The operation is in the process of stopping, at user
|
|
6372
|
-
* request
|
|
6634
|
+
* request.</p>
|
|
6373
6635
|
* </li>
|
|
6374
6636
|
* <li>
|
|
6375
6637
|
* <p>
|
|
@@ -6422,12 +6684,11 @@ export declare namespace ListStackSetOperationsOutput {
|
|
|
6422
6684
|
}
|
|
6423
6685
|
export interface ListStackSetsInput {
|
|
6424
6686
|
/**
|
|
6425
|
-
* <p>If the previous paginated request didn't return all
|
|
6426
|
-
*
|
|
6427
|
-
*
|
|
6428
|
-
*
|
|
6429
|
-
*
|
|
6430
|
-
* <code>null</code>.</p>
|
|
6687
|
+
* <p>If the previous paginated request didn't return all the remaining results, the response
|
|
6688
|
+
* object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set
|
|
6689
|
+
* of results, call <code>ListStackSets</code> again and assign that token to the request
|
|
6690
|
+
* object's <code>NextToken</code> parameter. If there are no remaining results, the previous
|
|
6691
|
+
* response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6431
6692
|
*/
|
|
6432
6693
|
NextToken?: string;
|
|
6433
6694
|
/**
|
|
@@ -6443,13 +6704,14 @@ export interface ListStackSetsInput {
|
|
|
6443
6704
|
Status?: StackSetStatus | string;
|
|
6444
6705
|
/**
|
|
6445
6706
|
* <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>
|
|
6707
|
+
* administrator in the management account or as a delegated administrator in a
|
|
6708
|
+
* member account.</p>
|
|
6448
6709
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
6449
6710
|
* self-managed permissions.</p>
|
|
6450
6711
|
* <ul>
|
|
6451
6712
|
* <li>
|
|
6452
|
-
* <p>If you are signed in to the management account, specify
|
|
6713
|
+
* <p>If you are signed in to the management account, specify
|
|
6714
|
+
* <code>SELF</code>.</p>
|
|
6453
6715
|
* </li>
|
|
6454
6716
|
* <li>
|
|
6455
6717
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -6495,7 +6757,8 @@ export interface StackSetSummary {
|
|
|
6495
6757
|
*/
|
|
6496
6758
|
AutoDeployment?: AutoDeployment;
|
|
6497
6759
|
/**
|
|
6498
|
-
* <p>Describes how the IAM roles required for stack set operations are
|
|
6760
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
6761
|
+
* created.</p>
|
|
6499
6762
|
* <ul>
|
|
6500
6763
|
* <li>
|
|
6501
6764
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -6505,8 +6768,7 @@ export interface StackSetSummary {
|
|
|
6505
6768
|
* </li>
|
|
6506
6769
|
* <li>
|
|
6507
6770
|
* <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>
|
|
6771
|
+
* 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
6772
|
* </li>
|
|
6511
6773
|
* </ul>
|
|
6512
6774
|
*/
|
|
@@ -6526,11 +6788,11 @@ export interface StackSetSummary {
|
|
|
6526
6788
|
* </li>
|
|
6527
6789
|
* <li>
|
|
6528
6790
|
* <p>
|
|
6529
|
-
* <code>NOT_CHECKED</code>: CloudFormation
|
|
6791
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked the stack set for drift.</p>
|
|
6530
6792
|
* </li>
|
|
6531
6793
|
* <li>
|
|
6532
6794
|
* <p>
|
|
6533
|
-
* <code>IN_SYNC</code>: All
|
|
6795
|
+
* <code>IN_SYNC</code>: All the stack instances belonging to the stack set stack
|
|
6534
6796
|
* match from the expected template and parameter configuration.</p>
|
|
6535
6797
|
* </li>
|
|
6536
6798
|
* <li>
|
|
@@ -6543,7 +6805,7 @@ export interface StackSetSummary {
|
|
|
6543
6805
|
/**
|
|
6544
6806
|
* <p>Most recent time when CloudFormation performed a drift detection operation on
|
|
6545
6807
|
* the stack set. This value will be <code>NULL</code> for any stack set on which drift
|
|
6546
|
-
* detection
|
|
6808
|
+
* detection hasn't yet been performed.</p>
|
|
6547
6809
|
*/
|
|
6548
6810
|
LastDriftCheckTimestamp?: Date;
|
|
6549
6811
|
/**
|
|
@@ -6610,9 +6872,9 @@ export interface ListTypeRegistrationsInput {
|
|
|
6610
6872
|
*/
|
|
6611
6873
|
MaxResults?: number;
|
|
6612
6874
|
/**
|
|
6613
|
-
* <p>If the previous paginated request didn't return all
|
|
6614
|
-
*
|
|
6615
|
-
*
|
|
6875
|
+
* <p>If the previous paginated request didn't return all the remaining results, the response
|
|
6876
|
+
* object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set
|
|
6877
|
+
* of results, call this action again and assign that token to the request object's
|
|
6616
6878
|
* <code>NextToken</code> parameter. If there are no remaining results, the previous
|
|
6617
6879
|
* response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6618
6880
|
*/
|
|
@@ -6626,7 +6888,7 @@ export declare namespace ListTypeRegistrationsInput {
|
|
|
6626
6888
|
}
|
|
6627
6889
|
export interface ListTypeRegistrationsOutput {
|
|
6628
6890
|
/**
|
|
6629
|
-
* <p>
|
|
6891
|
+
* <p>A list of extension registration tokens.</p>
|
|
6630
6892
|
* <p>Use <code>
|
|
6631
6893
|
* <a>DescribeTypeRegistration</a>
|
|
6632
6894
|
* </code> to return detailed
|
|
@@ -6686,9 +6948,9 @@ export interface TypeFilters {
|
|
|
6686
6948
|
*/
|
|
6687
6949
|
Category?: Category | string;
|
|
6688
6950
|
/**
|
|
6689
|
-
* <p>The id of the publisher of the extension
|
|
6690
|
-
* <p>Extensions published by Amazon
|
|
6691
|
-
* <code>
|
|
6951
|
+
* <p>The id of the publisher of the extension.</p>
|
|
6952
|
+
* <p>Extensions published by Amazon aren't assigned a publisher ID. Use the
|
|
6953
|
+
* <code>AWS_TYPES</code> category to specify a list of types published by Amazon.</p>
|
|
6692
6954
|
*/
|
|
6693
6955
|
PublisherId?: string;
|
|
6694
6956
|
/**
|
|
@@ -6744,14 +7006,14 @@ export interface ListTypesInput {
|
|
|
6744
7006
|
* </li>
|
|
6745
7007
|
* <li>
|
|
6746
7008
|
* <p>
|
|
6747
|
-
* <code>IMMUTABLE</code>: The resource type
|
|
6748
|
-
* the type
|
|
7009
|
+
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so
|
|
7010
|
+
* the type can't be updated and must instead be replaced during stack update
|
|
6749
7011
|
* operations.</p>
|
|
6750
7012
|
* </li>
|
|
6751
7013
|
* <li>
|
|
6752
7014
|
* <p>
|
|
6753
|
-
* <code>NON_PROVISIONABLE</code>: The resource type
|
|
6754
|
-
* and delete handlers, and therefore
|
|
7015
|
+
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include create, read,
|
|
7016
|
+
* and delete handlers, and therefore can't actually be provisioned.</p>
|
|
6755
7017
|
* </li>
|
|
6756
7018
|
* </ul>
|
|
6757
7019
|
* <p>The default is <code>FULLY_MUTABLE</code>.</p>
|
|
@@ -6770,7 +7032,7 @@ export interface ListTypesInput {
|
|
|
6770
7032
|
* <li>
|
|
6771
7033
|
* <p>
|
|
6772
7034
|
* <code>DEPRECATED</code>: The extension has been deregistered and can no longer be
|
|
6773
|
-
* used in CloudFormation operations
|
|
7035
|
+
* used in CloudFormation operations.</p>
|
|
6774
7036
|
* </li>
|
|
6775
7037
|
* </ul>
|
|
6776
7038
|
*/
|
|
@@ -6820,19 +7082,18 @@ export interface TypeSummary {
|
|
|
6820
7082
|
Type?: RegistryType | string;
|
|
6821
7083
|
/**
|
|
6822
7084
|
* <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>
|
|
7085
|
+
* <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
|
|
7086
|
+
* considers that alias as the type name.</p>
|
|
6825
7087
|
*/
|
|
6826
7088
|
TypeName?: string;
|
|
6827
7089
|
/**
|
|
6828
7090
|
* <p>The ID of the default version of the extension. The default version is used when the
|
|
6829
|
-
* extension version
|
|
7091
|
+
* extension version isn't specified.</p>
|
|
6830
7092
|
* <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>
|
|
7093
|
+
* 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
7094
|
* <p>To set the default version of an extension, use <code>
|
|
6834
7095
|
* <a>SetTypeDefaultVersion</a>
|
|
6835
|
-
* </code
|
|
7096
|
+
* </code>.</p>
|
|
6836
7097
|
*/
|
|
6837
7098
|
DefaultVersionId?: string;
|
|
6838
7099
|
/**
|
|
@@ -6860,44 +7121,44 @@ export interface TypeSummary {
|
|
|
6860
7121
|
Description?: string;
|
|
6861
7122
|
/**
|
|
6862
7123
|
* <p>The ID of the extension publisher, if the extension is published by a third party.
|
|
6863
|
-
* Extensions published by Amazon
|
|
7124
|
+
* Extensions published by Amazon don't return a publisher ID.</p>
|
|
6864
7125
|
*/
|
|
6865
7126
|
PublisherId?: string;
|
|
6866
7127
|
/**
|
|
6867
7128
|
* <p>For public extensions that have been activated for this account and region, the type
|
|
6868
7129
|
* name of the public extension.</p>
|
|
6869
7130
|
* <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
|
|
7131
|
+
* account and region, CloudFormation treats that alias as the extension's type name
|
|
7132
|
+
* within the account and region, not the type name of the public extension. For more
|
|
7133
|
+
* 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
7134
|
* <i>CloudFormation User Guide</i>.</p>
|
|
6874
7135
|
*/
|
|
6875
7136
|
OriginalTypeName?: string;
|
|
6876
7137
|
/**
|
|
6877
7138
|
* <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
|
-
*
|
|
7139
|
+
* of the public extension to be used for CloudFormation operations in this account
|
|
7140
|
+
* and Region.</p>
|
|
6880
7141
|
* <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>
|
|
7142
|
+
* CloudFormation automatically updates the extension in this account and region
|
|
7143
|
+
* 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
|
|
7144
|
+
* of extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6884
7145
|
*/
|
|
6885
7146
|
PublicVersionNumber?: string;
|
|
6886
7147
|
/**
|
|
6887
7148
|
* <p>For public extensions that have been activated for this account and region, the latest
|
|
6888
7149
|
* version of the public extension <i>that is available</i>. For any extensions
|
|
6889
7150
|
* other than activated third-arty extensions, CloudFormation returns
|
|
6890
|
-
*
|
|
7151
|
+
* <code>null</code>.</p>
|
|
6891
7152
|
* <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>
|
|
7153
|
+
* CloudFormation automatically updates the extension in this account and region
|
|
7154
|
+
* 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
|
|
7155
|
+
* of extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
6895
7156
|
*/
|
|
6896
7157
|
LatestPublicVersion?: string;
|
|
6897
7158
|
/**
|
|
6898
7159
|
* <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>
|
|
7160
|
+
* <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
|
|
7161
|
+
* <i> CFN-CLI User Guide for Extension Development</i>.</p>
|
|
6901
7162
|
*/
|
|
6902
7163
|
PublisherIdentity?: IdentityProvider | string;
|
|
6903
7164
|
/**
|
|
@@ -6906,7 +7167,7 @@ export interface TypeSummary {
|
|
|
6906
7167
|
*/
|
|
6907
7168
|
PublisherName?: string;
|
|
6908
7169
|
/**
|
|
6909
|
-
* <p>Whether or not the extension is activated for this account and region
|
|
7170
|
+
* <p>Whether or not the extension is activated for this account and region.</p>
|
|
6910
7171
|
* <p>This applies only to third-party public extensions. Extensions published by Amazon are
|
|
6911
7172
|
* activated by default.</p>
|
|
6912
7173
|
*/
|
|
@@ -6925,8 +7186,8 @@ export interface ListTypesOutput {
|
|
|
6925
7186
|
*/
|
|
6926
7187
|
TypeSummaries?: TypeSummary[];
|
|
6927
7188
|
/**
|
|
6928
|
-
* <p>If the request doesn't return all
|
|
6929
|
-
*
|
|
7189
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set
|
|
7190
|
+
* to a token. To retrieve the next set of results, call this action again and assign that
|
|
6930
7191
|
* token to the request object's <code>NextToken</code> parameter. If the request returns all
|
|
6931
7192
|
* results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6932
7193
|
*/
|
|
@@ -6986,7 +7247,7 @@ export interface ListTypeVersionsInput {
|
|
|
6986
7247
|
* <li>
|
|
6987
7248
|
* <p>
|
|
6988
7249
|
* <code>DEPRECATED</code>: The extension version has been deregistered and can no
|
|
6989
|
-
* longer be used in CloudFormation operations
|
|
7250
|
+
* longer be used in CloudFormation operations.</p>
|
|
6990
7251
|
* </li>
|
|
6991
7252
|
* </ul>
|
|
6992
7253
|
* <p>The default is <code>LIVE</code>.</p>
|
|
@@ -6994,7 +7255,7 @@ export interface ListTypeVersionsInput {
|
|
|
6994
7255
|
DeprecatedStatus?: DeprecatedStatus | string;
|
|
6995
7256
|
/**
|
|
6996
7257
|
* <p>The publisher ID of the extension publisher.</p>
|
|
6997
|
-
* <p>Extensions published by Amazon
|
|
7258
|
+
* <p>Extensions published by Amazon aren't assigned a publisher ID.</p>
|
|
6998
7259
|
*/
|
|
6999
7260
|
PublisherId?: string;
|
|
7000
7261
|
}
|
|
@@ -7019,15 +7280,15 @@ export interface TypeVersionSummary {
|
|
|
7019
7280
|
TypeName?: string;
|
|
7020
7281
|
/**
|
|
7021
7282
|
* <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
|
|
7283
|
+
* the Amazon Resource Name (ARN) assigned to the extension version when it's
|
|
7023
7284
|
* registered.</p>
|
|
7024
7285
|
*/
|
|
7025
7286
|
VersionId?: string;
|
|
7026
7287
|
/**
|
|
7027
7288
|
* <p>Whether the specified extension version is set as the default version.</p>
|
|
7028
7289
|
* <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
|
-
*
|
|
7290
|
+
* extensions published by Amazon. For public third-party extensions, CloudFormation
|
|
7291
|
+
* returns <code>null</code>.</p>
|
|
7031
7292
|
*/
|
|
7032
7293
|
IsDefaultVersion?: boolean;
|
|
7033
7294
|
/**
|
|
@@ -7044,13 +7305,12 @@ export interface TypeVersionSummary {
|
|
|
7044
7305
|
Description?: string;
|
|
7045
7306
|
/**
|
|
7046
7307
|
* <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>
|
|
7308
|
+
* of the public extension to be used for CloudFormation operations in this account
|
|
7309
|
+
* and region. For any extensions other than activated third-arty extensions, CloudFormation returns <code>null</code>.</p>
|
|
7050
7310
|
* <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>
|
|
7311
|
+
* CloudFormation automatically updates the extension in this account and region
|
|
7312
|
+
* 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
|
|
7313
|
+
* of extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
7054
7314
|
*/
|
|
7055
7315
|
PublicVersionNumber?: string;
|
|
7056
7316
|
}
|
|
@@ -7102,14 +7362,14 @@ export interface PublishTypeInput {
|
|
|
7102
7362
|
/**
|
|
7103
7363
|
* <p>The version number to assign to this version of the extension.</p>
|
|
7104
7364
|
* <p>Use the following format, and adhere to semantic versioning when assigning a version
|
|
7105
|
-
* number to your extension
|
|
7365
|
+
* number to your extension:</p>
|
|
7106
7366
|
* <p>
|
|
7107
7367
|
* <code>MAJOR.MINOR.PATCH</code>
|
|
7108
7368
|
* </p>
|
|
7109
7369
|
* <p>For more information, see <a href="https://semver.org/">Semantic Versioning
|
|
7110
7370
|
* 2.0.0</a>.</p>
|
|
7111
|
-
* <p>If you
|
|
7112
|
-
* one minor version release.</p>
|
|
7371
|
+
* <p>If you don't specify a version number, CloudFormation increments the version
|
|
7372
|
+
* number by one minor version release.</p>
|
|
7113
7373
|
* <p>You cannot specify a version number the first time you publish a type. CloudFormation
|
|
7114
7374
|
* automatically sets the first version number to be <code>1.0.0</code>.</p>
|
|
7115
7375
|
*/
|
|
@@ -7135,7 +7395,7 @@ export declare namespace PublishTypeOutput {
|
|
|
7135
7395
|
const filterSensitiveLog: (obj: PublishTypeOutput) => any;
|
|
7136
7396
|
}
|
|
7137
7397
|
/**
|
|
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
|
|
7398
|
+
* <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
7399
|
* users.</p>
|
|
7140
7400
|
*/
|
|
7141
7401
|
export interface InvalidStateTransitionException extends __SmithyException, $MetadataBearer {
|
|
@@ -7144,7 +7404,7 @@ export interface InvalidStateTransitionException extends __SmithyException, $Met
|
|
|
7144
7404
|
Message?: string;
|
|
7145
7405
|
}
|
|
7146
7406
|
/**
|
|
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
|
|
7407
|
+
* <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
7408
|
* users.</p>
|
|
7149
7409
|
*/
|
|
7150
7410
|
export interface OperationStatusCheckFailedException extends __SmithyException, $MetadataBearer {
|
|
@@ -7162,18 +7422,21 @@ export declare enum HandlerErrorCode {
|
|
|
7162
7422
|
AccessDenied = "AccessDenied",
|
|
7163
7423
|
AlreadyExists = "AlreadyExists",
|
|
7164
7424
|
GeneralServiceException = "GeneralServiceException",
|
|
7425
|
+
HandlerInternalFailure = "HandlerInternalFailure",
|
|
7165
7426
|
InternalFailure = "InternalFailure",
|
|
7166
7427
|
InvalidCredentials = "InvalidCredentials",
|
|
7167
7428
|
InvalidRequest = "InvalidRequest",
|
|
7168
7429
|
InvalidTypeConfiguration = "InvalidTypeConfiguration",
|
|
7169
7430
|
NetworkFailure = "NetworkFailure",
|
|
7431
|
+
NonCompliant = "NonCompliant",
|
|
7170
7432
|
NotFound = "NotFound",
|
|
7171
7433
|
NotUpdatable = "NotUpdatable",
|
|
7172
7434
|
ResourceConflict = "ResourceConflict",
|
|
7173
7435
|
ServiceInternalError = "ServiceInternalError",
|
|
7174
7436
|
ServiceLimitExceeded = "ServiceLimitExceeded",
|
|
7175
7437
|
ServiceTimeout = "NotStabilized",
|
|
7176
|
-
Throttling = "Throttling"
|
|
7438
|
+
Throttling = "Throttling",
|
|
7439
|
+
Unknown = "Unknown"
|
|
7177
7440
|
}
|
|
7178
7441
|
export interface RecordHandlerProgressInput {
|
|
7179
7442
|
/**
|
|
@@ -7221,9 +7484,9 @@ export declare namespace RecordHandlerProgressOutput {
|
|
|
7221
7484
|
}
|
|
7222
7485
|
export interface RegisterPublisherInput {
|
|
7223
7486
|
/**
|
|
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>
|
|
7487
|
+
* <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
|
|
7488
|
+
* registry. You must accept the terms and conditions in order to register to publish public
|
|
7489
|
+
* extensions to the CloudFormation registry.</p>
|
|
7227
7490
|
* <p>The default is <code>false</code>.</p>
|
|
7228
7491
|
*/
|
|
7229
7492
|
AcceptTermsAndConditions?: boolean;
|
|
@@ -7231,7 +7494,8 @@ export interface RegisterPublisherInput {
|
|
|
7231
7494
|
* <p>If you are using a Bitbucket or GitHub account for identity verification, the Amazon
|
|
7232
7495
|
* Resource Name (ARN) for your connection to that account.</p>
|
|
7233
7496
|
* <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
|
|
7497
|
+
* extensions</a> in the <i>CloudFormation CLI User
|
|
7498
|
+
* Guide</i>.</p>
|
|
7235
7499
|
*/
|
|
7236
7500
|
ConnectionArn?: string;
|
|
7237
7501
|
}
|
|
@@ -7243,7 +7507,8 @@ export declare namespace RegisterPublisherInput {
|
|
|
7243
7507
|
}
|
|
7244
7508
|
export interface RegisterPublisherOutput {
|
|
7245
7509
|
/**
|
|
7246
|
-
* <p>The ID assigned this account by CloudFormation for publishing
|
|
7510
|
+
* <p>The ID assigned this account by CloudFormation for publishing
|
|
7511
|
+
* extensions.</p>
|
|
7247
7512
|
*/
|
|
7248
7513
|
PublisherId?: string;
|
|
7249
7514
|
}
|
|
@@ -7260,7 +7525,7 @@ export interface RegisterTypeInput {
|
|
|
7260
7525
|
Type?: RegistryType | string;
|
|
7261
7526
|
/**
|
|
7262
7527
|
* <p>The name of the extension being registered.</p>
|
|
7263
|
-
* <p>We recommend that extension names adhere to the following patterns
|
|
7528
|
+
* <p>We recommend that extension names adhere to the following patterns:</p>
|
|
7264
7529
|
* <ul>
|
|
7265
7530
|
* <li>
|
|
7266
7531
|
* <p>For resource types,
|
|
@@ -7273,7 +7538,7 @@ export interface RegisterTypeInput {
|
|
|
7273
7538
|
* </ul>
|
|
7274
7539
|
*
|
|
7275
7540
|
* <note>
|
|
7276
|
-
* <p>The following organization namespaces are reserved and
|
|
7541
|
+
* <p>The following organization namespaces are reserved and can't be used in your
|
|
7277
7542
|
* extension names:</p>
|
|
7278
7543
|
* <ul>
|
|
7279
7544
|
* <li>
|
|
@@ -7311,17 +7576,17 @@ export interface RegisterTypeInput {
|
|
|
7311
7576
|
*/
|
|
7312
7577
|
TypeName: string | undefined;
|
|
7313
7578
|
/**
|
|
7314
|
-
* <p>A
|
|
7315
|
-
*
|
|
7579
|
+
* <p>A URL to the S3 bucket containing the extension project package that contains the
|
|
7580
|
+
* necessary files for the extension you want to register.</p>
|
|
7316
7581
|
* <p>For information on generating a schema handler package for the extension you want to
|
|
7317
7582
|
* register, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html">submit</a>
|
|
7318
7583
|
* in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
7319
7584
|
* <note>
|
|
7320
7585
|
* <p>The user registering the extension must be able to access the package in the S3
|
|
7321
|
-
* bucket. That
|
|
7586
|
+
* 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
7587
|
* 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
7588
|
* for Amazon S3</a> in the <i>Identity and Access Management User
|
|
7324
|
-
*
|
|
7589
|
+
* Guide</i>.</p>
|
|
7325
7590
|
* </note>
|
|
7326
7591
|
*/
|
|
7327
7592
|
SchemaHandlerPackage: string | undefined;
|
|
@@ -7330,29 +7595,28 @@ export interface RegisterTypeInput {
|
|
|
7330
7595
|
*/
|
|
7331
7596
|
LoggingConfig?: LoggingConfig;
|
|
7332
7597
|
/**
|
|
7333
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume
|
|
7334
|
-
*
|
|
7335
|
-
*
|
|
7336
|
-
* relationship with the CloudFormation service principle
|
|
7598
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.</p>
|
|
7599
|
+
* <p>For CloudFormation to assume the specified execution role, the role must
|
|
7600
|
+
* contain a trust relationship with the CloudFormation service principle
|
|
7337
7601
|
* (<code>resources.cloudformation.amazonaws.com</code>). For more information on adding
|
|
7338
7602
|
* 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
7603
|
* Guide</i>.</p>
|
|
7340
7604
|
* <p>If your extension calls Amazon Web Services APIs in any of its handlers, you must create
|
|
7341
7605
|
* an <i>
|
|
7342
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
|
7343
|
-
*
|
|
7344
|
-
*
|
|
7345
|
-
*
|
|
7346
|
-
*
|
|
7347
|
-
*
|
|
7348
|
-
*
|
|
7606
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a>
|
|
7607
|
+
* </i> that includes the necessary
|
|
7608
|
+
* permissions to call those Amazon Web Services APIs, and provision that execution role in
|
|
7609
|
+
* your account. When CloudFormation needs to invoke the resource type handler,
|
|
7610
|
+
* CloudFormation assumes this execution role to create a temporary session token,
|
|
7611
|
+
* which it then passes to the resource type handler, thereby supplying your resource type
|
|
7612
|
+
* with the appropriate credentials.</p>
|
|
7349
7613
|
*/
|
|
7350
7614
|
ExecutionRoleArn?: string;
|
|
7351
7615
|
/**
|
|
7352
7616
|
* <p>A unique identifier that acts as an idempotency key for this registration request.
|
|
7353
7617
|
* Specifying a client request token prevents CloudFormation from generating more
|
|
7354
|
-
* than one version of an extension from the same
|
|
7355
|
-
*
|
|
7618
|
+
* than one version of an extension from the same registration request, even if the request is
|
|
7619
|
+
* submitted multiple times.</p>
|
|
7356
7620
|
*/
|
|
7357
7621
|
ClientRequestToken?: string;
|
|
7358
7622
|
}
|
|
@@ -7368,7 +7632,7 @@ export interface RegisterTypeOutput {
|
|
|
7368
7632
|
* <p>Use this registration token when calling <code>
|
|
7369
7633
|
* <a>DescribeTypeRegistration</a>
|
|
7370
7634
|
* </code>, which returns information about the status and IDs of the extension
|
|
7371
|
-
* registration
|
|
7635
|
+
* registration.</p>
|
|
7372
7636
|
*/
|
|
7373
7637
|
RegistrationToken?: string;
|
|
7374
7638
|
}
|
|
@@ -7380,7 +7644,7 @@ export declare namespace RegisterTypeOutput {
|
|
|
7380
7644
|
}
|
|
7381
7645
|
export interface RollbackStackInput {
|
|
7382
7646
|
/**
|
|
7383
|
-
* <p>The name that
|
|
7647
|
+
* <p>The name that's associated with the stack.</p>
|
|
7384
7648
|
*/
|
|
7385
7649
|
StackName: string | undefined;
|
|
7386
7650
|
/**
|
|
@@ -7420,17 +7684,17 @@ export interface SetStackPolicyInput {
|
|
|
7420
7684
|
*/
|
|
7421
7685
|
StackName: string | undefined;
|
|
7422
7686
|
/**
|
|
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
|
-
*
|
|
7687
|
+
* <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
|
|
7688
|
+
* to stack resources</a> in the CloudFormation User Guide. You can specify either the
|
|
7689
|
+
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
7690
|
+
* both.</p>
|
|
7427
7691
|
*/
|
|
7428
7692
|
StackPolicyBody?: string;
|
|
7429
7693
|
/**
|
|
7430
7694
|
* <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
|
-
*
|
|
7695
|
+
* size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region
|
|
7696
|
+
* as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
7697
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7434
7698
|
*/
|
|
7435
7699
|
StackPolicyURL?: string;
|
|
7436
7700
|
}
|
|
@@ -7444,16 +7708,16 @@ export interface SetTypeConfigurationInput {
|
|
|
7444
7708
|
/**
|
|
7445
7709
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and region.</p>
|
|
7446
7710
|
* <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
|
|
7711
|
+
* 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
7712
|
* <p>Do not include the extension versions suffix at the end of the ARN. You can set the
|
|
7449
7713
|
* configuration for an extension, but not for a specific extension version.</p>
|
|
7450
7714
|
*/
|
|
7451
7715
|
TypeArn?: string;
|
|
7452
7716
|
/**
|
|
7453
|
-
* <p>The configuration data for the extension, in this account and region
|
|
7717
|
+
* <p>The configuration data for the extension, in this account and region.</p>
|
|
7454
7718
|
* <p>The configuration data must be formatted as JSON, and validate against the schema
|
|
7455
7719
|
* 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
|
-
*
|
|
7720
|
+
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
7457
7721
|
*/
|
|
7458
7722
|
Configuration: string | undefined;
|
|
7459
7723
|
/**
|
|
@@ -7556,10 +7820,9 @@ export interface SignalResourceInput {
|
|
|
7556
7820
|
*/
|
|
7557
7821
|
LogicalResourceId: string | undefined;
|
|
7558
7822
|
/**
|
|
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>
|
|
7823
|
+
* <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
|
|
7824
|
+
* you send multiple signals to a single resource (such as signaling a wait condition), each
|
|
7825
|
+
* signal requires a different unique ID.</p>
|
|
7563
7826
|
*/
|
|
7564
7827
|
UniqueId: string | undefined;
|
|
7565
7828
|
/**
|
|
@@ -7580,18 +7843,19 @@ export interface StopStackSetOperationInput {
|
|
|
7580
7843
|
*/
|
|
7581
7844
|
StackSetName: string | undefined;
|
|
7582
7845
|
/**
|
|
7583
|
-
* <p>The ID of the stack operation
|
|
7846
|
+
* <p>The ID of the stack operation.</p>
|
|
7584
7847
|
*/
|
|
7585
7848
|
OperationId: string | undefined;
|
|
7586
7849
|
/**
|
|
7587
7850
|
* <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>
|
|
7851
|
+
* administrator in the organization's management account or as a delegated
|
|
7852
|
+
* administrator in a member account.</p>
|
|
7590
7853
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
7591
7854
|
* self-managed permissions.</p>
|
|
7592
7855
|
* <ul>
|
|
7593
7856
|
* <li>
|
|
7594
|
-
* <p>If you are signed in to the management account, specify
|
|
7857
|
+
* <p>If you are signed in to the management account, specify
|
|
7858
|
+
* <code>SELF</code>.</p>
|
|
7595
7859
|
* </li>
|
|
7596
7860
|
* <li>
|
|
7597
7861
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -7619,7 +7883,7 @@ export declare namespace StopStackSetOperationOutput {
|
|
|
7619
7883
|
}
|
|
7620
7884
|
export interface TestTypeInput {
|
|
7621
7885
|
/**
|
|
7622
|
-
* <p>The Amazon Resource
|
|
7886
|
+
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
7623
7887
|
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7624
7888
|
* <code>Type</code>.</p>
|
|
7625
7889
|
*/
|
|
@@ -7640,28 +7904,33 @@ export interface TestTypeInput {
|
|
|
7640
7904
|
* <p>The version of the extension to test.</p>
|
|
7641
7905
|
* <p>You can specify the version id with either <code>Arn</code>, or with
|
|
7642
7906
|
* <code>TypeName</code> and <code>Type</code>.</p>
|
|
7643
|
-
* <p>If you
|
|
7907
|
+
* <p>If you don't specify a version, CloudFormation uses the default version of the
|
|
7644
7908
|
* extension in this account and region for testing.</p>
|
|
7645
7909
|
*/
|
|
7646
7910
|
VersionId?: string;
|
|
7647
7911
|
/**
|
|
7648
|
-
* <p>The S3 bucket to which CloudFormation delivers the contract test execution
|
|
7649
|
-
*
|
|
7650
|
-
*
|
|
7912
|
+
* <p>The S3 bucket to which CloudFormation delivers the contract test execution
|
|
7913
|
+
* logs.</p>
|
|
7914
|
+
* <p>CloudFormation delivers the logs by the time contract testing has completed and
|
|
7915
|
+
* the extension has been assigned a test type status of <code>PASSED</code> or
|
|
7651
7916
|
* <code>FAILED</code>.</p>
|
|
7652
7917
|
* <p>The user calling <code>TestType</code> must be able to access items in the specified S3
|
|
7653
7918
|
* bucket. Specifically, the user needs the following permissions:</p>
|
|
7654
7919
|
* <ul>
|
|
7655
7920
|
* <li>
|
|
7656
|
-
* <p>
|
|
7921
|
+
* <p>
|
|
7922
|
+
* <code>GetObject</code>
|
|
7923
|
+
* </p>
|
|
7657
7924
|
* </li>
|
|
7658
7925
|
* <li>
|
|
7659
|
-
* <p>
|
|
7926
|
+
* <p>
|
|
7927
|
+
* <code>PutObject</code>
|
|
7928
|
+
* </p>
|
|
7660
7929
|
* </li>
|
|
7661
7930
|
* </ul>
|
|
7662
7931
|
* <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>
|
|
7932
|
+
* Condition Keys for Amazon S3</a> in the <i>Amazon Web Services
|
|
7933
|
+
* Identity and Access Management User Guide</i>.</p>
|
|
7665
7934
|
*/
|
|
7666
7935
|
LogDeliveryBucket?: string;
|
|
7667
7936
|
}
|
|
@@ -7673,7 +7942,7 @@ export declare namespace TestTypeInput {
|
|
|
7673
7942
|
}
|
|
7674
7943
|
export interface TestTypeOutput {
|
|
7675
7944
|
/**
|
|
7676
|
-
* <p>The Amazon Resource
|
|
7945
|
+
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
7677
7946
|
*/
|
|
7678
7947
|
TypeVersionArn?: string;
|
|
7679
7948
|
}
|
|
@@ -7701,9 +7970,9 @@ export interface UpdateStackInput {
|
|
|
7701
7970
|
*/
|
|
7702
7971
|
TemplateBody?: string;
|
|
7703
7972
|
/**
|
|
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
|
-
*
|
|
7973
|
+
* <p>Location of file containing the template body. The URL must point to a template that's
|
|
7974
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information,
|
|
7975
|
+
* go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
7707
7976
|
* in the CloudFormation User Guide.</p>
|
|
7708
7977
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
7709
7978
|
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
|
@@ -7753,18 +8022,19 @@ export interface UpdateStackInput {
|
|
|
7753
8022
|
* </p>
|
|
7754
8023
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
7755
8024
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
7756
|
-
*
|
|
7757
|
-
* of these capabilities.</p>
|
|
8025
|
+
* (IAM) users. For those stacks, you must explicitly acknowledge this
|
|
8026
|
+
* by specifying one of these capabilities.</p>
|
|
7758
8027
|
* <p>The following IAM resources require you to specify either the
|
|
7759
8028
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
7760
8029
|
* capability.</p>
|
|
7761
8030
|
* <ul>
|
|
7762
8031
|
* <li>
|
|
7763
|
-
* <p>If you have IAM resources, you can specify either
|
|
8032
|
+
* <p>If you have IAM resources, you can specify either
|
|
8033
|
+
* capability.</p>
|
|
7764
8034
|
* </li>
|
|
7765
8035
|
* <li>
|
|
7766
|
-
* <p>If you have IAM resources with custom names, you
|
|
7767
|
-
*
|
|
8036
|
+
* <p>If you have IAM resources with custom names, you
|
|
8037
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
7768
8038
|
* </li>
|
|
7769
8039
|
* <li>
|
|
7770
8040
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -7788,7 +8058,7 @@ export interface UpdateStackInput {
|
|
|
7788
8058
|
* </li>
|
|
7789
8059
|
* <li>
|
|
7790
8060
|
* <p>
|
|
7791
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">
|
|
8061
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>
|
|
7792
8062
|
* </p>
|
|
7793
8063
|
* </li>
|
|
7794
8064
|
* <li>
|
|
@@ -7811,12 +8081,11 @@ export interface UpdateStackInput {
|
|
|
7811
8081
|
* </li>
|
|
7812
8082
|
* <li>
|
|
7813
8083
|
* <p>
|
|
7814
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">
|
|
8084
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>
|
|
7815
8085
|
* </p>
|
|
7816
8086
|
* </li>
|
|
7817
8087
|
* </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>
|
|
8088
|
+
* <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
8089
|
* </li>
|
|
7821
8090
|
* <li>
|
|
7822
8091
|
* <p>
|
|
@@ -7836,9 +8105,9 @@ export interface UpdateStackInput {
|
|
|
7836
8105
|
* <important>
|
|
7837
8106
|
* <p>You should only update stacks directly from a stack template that contains
|
|
7838
8107
|
* 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>
|
|
8108
|
+
* <p>Each macro relies on an underlying Lambda service function for
|
|
8109
|
+
* processing stack templates. Be aware that the Lambda function owner can update the
|
|
8110
|
+
* function operation without CloudFormation being notified.</p>
|
|
7842
8111
|
* </important>
|
|
7843
8112
|
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
|
|
7844
8113
|
* CloudFormation Macros to Perform Custom Processing on
|
|
@@ -7853,17 +8122,16 @@ export interface UpdateStackInput {
|
|
|
7853
8122
|
* <code>Custom::MyCustomInstance</code>.</p>
|
|
7854
8123
|
* <p>If the list of resource types doesn't include a resource that you're updating, the stack
|
|
7855
8124
|
* 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>
|
|
8125
|
+
* 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
8126
|
*/
|
|
7860
8127
|
ResourceTypes?: string[];
|
|
7861
8128
|
/**
|
|
7862
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
7863
|
-
*
|
|
7864
|
-
*
|
|
7865
|
-
*
|
|
7866
|
-
*
|
|
8129
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role
|
|
8130
|
+
* that CloudFormation assumes to update the stack. CloudFormation uses the
|
|
8131
|
+
* role's credentials to make calls on your behalf. CloudFormation always uses this
|
|
8132
|
+
* role for all future operations on the stack. Provided that users have permission to operate
|
|
8133
|
+
* on the stack, CloudFormation uses this role even if the users don't have permission
|
|
8134
|
+
* to pass it. Ensure that the role grants least privilege.</p>
|
|
7867
8135
|
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
7868
8136
|
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
7869
8137
|
* session that is generated from your user credentials.</p>
|
|
@@ -7879,7 +8147,7 @@ export interface UpdateStackInput {
|
|
|
7879
8147
|
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
|
7880
8148
|
* both.</p>
|
|
7881
8149
|
* <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
|
|
8150
|
+
* you created during a stack update. If you don't specify a stack policy, the current policy
|
|
7883
8151
|
* that is associated with the stack is unchanged.</p>
|
|
7884
8152
|
*/
|
|
7885
8153
|
StackPolicyBody?: string;
|
|
@@ -7889,7 +8157,7 @@ export interface UpdateStackInput {
|
|
|
7889
8157
|
* either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but
|
|
7890
8158
|
* not both.</p>
|
|
7891
8159
|
* <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
|
|
8160
|
+
* you created during a stack update. If you don't specify a stack policy, the current policy
|
|
7893
8161
|
* that is associated with the stack is unchanged.</p>
|
|
7894
8162
|
*/
|
|
7895
8163
|
StackPolicyURL?: string;
|
|
@@ -7961,7 +8229,7 @@ export interface UpdateStackInstancesInput {
|
|
|
7961
8229
|
/**
|
|
7962
8230
|
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for
|
|
7963
8231
|
* 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>
|
|
8232
|
+
* values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.</p>
|
|
7965
8233
|
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
|
7966
8234
|
* both.</p>
|
|
7967
8235
|
*/
|
|
@@ -7977,16 +8245,18 @@ export interface UpdateStackInstancesInput {
|
|
|
7977
8245
|
*/
|
|
7978
8246
|
DeploymentTargets?: DeploymentTargets;
|
|
7979
8247
|
/**
|
|
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>
|
|
8248
|
+
* <p>The names of one or more Amazon Web Services Regions in which you want to update
|
|
8249
|
+
* parameter values for stack instances. The overridden parameter values will be applied to
|
|
8250
|
+
* all stack instances in the specified accounts and Amazon Web Services Regions.</p>
|
|
7983
8251
|
*/
|
|
7984
8252
|
Regions: string[] | undefined;
|
|
7985
8253
|
/**
|
|
7986
|
-
* <p>
|
|
7987
|
-
* instances
|
|
8254
|
+
* <p>A list of input parameters whose values you want to update for the specified stack
|
|
8255
|
+
* instances.</p>
|
|
7988
8256
|
* <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
|
|
8257
|
+
* accounts and Amazon Web Services Regions. When specifying parameters and their values, be
|
|
8258
|
+
* aware of how CloudFormation sets parameter values during stack instance update
|
|
8259
|
+
* operations:</p>
|
|
7990
8260
|
* <ul>
|
|
7991
8261
|
* <li>
|
|
7992
8262
|
* <p>To override the current value for a parameter, include the parameter and specify
|
|
@@ -7994,19 +8264,19 @@ export interface UpdateStackInstancesInput {
|
|
|
7994
8264
|
* </li>
|
|
7995
8265
|
* <li>
|
|
7996
8266
|
* <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
|
|
8267
|
+
* and specify <code>UsePreviousValue</code> as <code>true</code>. (You can't specify
|
|
7998
8268
|
* both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
|
7999
8269
|
* </li>
|
|
8000
8270
|
* <li>
|
|
8001
8271
|
* <p>To set an overridden parameter back to the value specified in the stack set,
|
|
8002
|
-
* specify a parameter list but
|
|
8272
|
+
* specify a parameter list but don't include the parameter in the list.</p>
|
|
8003
8273
|
* </li>
|
|
8004
8274
|
* <li>
|
|
8005
|
-
* <p>To leave all parameters set to their present values,
|
|
8275
|
+
* <p>To leave all parameters set to their present values, don't specify this property
|
|
8006
8276
|
* at all.</p>
|
|
8007
8277
|
* </li>
|
|
8008
8278
|
* </ul>
|
|
8009
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance
|
|
8279
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance aren't
|
|
8010
8280
|
* updated, but retain their overridden value.</p>
|
|
8011
8281
|
* <p>You can only override the parameter <i>values</i> that are specified in
|
|
8012
8282
|
* the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to
|
|
@@ -8022,22 +8292,23 @@ export interface UpdateStackInstancesInput {
|
|
|
8022
8292
|
*/
|
|
8023
8293
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8024
8294
|
/**
|
|
8025
|
-
* <p>The unique identifier for this stack set operation
|
|
8295
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
8026
8296
|
* <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
8297
|
* 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
|
-
*
|
|
8298
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
|
8299
|
+
* automatically.</p>
|
|
8030
8300
|
*/
|
|
8031
8301
|
OperationId?: string;
|
|
8032
8302
|
/**
|
|
8033
8303
|
* <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>
|
|
8304
|
+
* administrator in the organization's management account or as a delegated
|
|
8305
|
+
* administrator in a member account.</p>
|
|
8036
8306
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
8037
8307
|
* self-managed permissions.</p>
|
|
8038
8308
|
* <ul>
|
|
8039
8309
|
* <li>
|
|
8040
|
-
* <p>If you are signed in to the management account, specify
|
|
8310
|
+
* <p>If you are signed in to the management account, specify
|
|
8311
|
+
* <code>SELF</code>.</p>
|
|
8041
8312
|
* </li>
|
|
8042
8313
|
* <li>
|
|
8043
8314
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -8057,7 +8328,7 @@ export declare namespace UpdateStackInstancesInput {
|
|
|
8057
8328
|
}
|
|
8058
8329
|
export interface UpdateStackInstancesOutput {
|
|
8059
8330
|
/**
|
|
8060
|
-
* <p>The unique identifier for this stack set operation
|
|
8331
|
+
* <p>The unique identifier for this stack set operation.</p>
|
|
8061
8332
|
*/
|
|
8062
8333
|
OperationId?: string;
|
|
8063
8334
|
}
|
|
@@ -8087,12 +8358,12 @@ export interface UpdateStackSetInput {
|
|
|
8087
8358
|
TemplateBody?: string;
|
|
8088
8359
|
/**
|
|
8089
8360
|
* <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>
|
|
8361
|
+
* template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a
|
|
8362
|
+
* Systems Manager document. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
8092
8363
|
* in the CloudFormation User Guide.</p>
|
|
8093
8364
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
8094
8365
|
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
|
8095
|
-
* <code>UsePreviousTemplate</code> to true
|
|
8366
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
|
8096
8367
|
*/
|
|
8097
8368
|
TemplateURL?: string;
|
|
8098
8369
|
/**
|
|
@@ -8100,11 +8371,11 @@ export interface UpdateStackSetInput {
|
|
|
8100
8371
|
* updating.</p>
|
|
8101
8372
|
* <p>Conditional: You must specify only one of the following parameters:
|
|
8102
8373
|
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
|
8103
|
-
* <code>UsePreviousTemplate</code> to true
|
|
8374
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
|
8104
8375
|
*/
|
|
8105
8376
|
UsePreviousTemplate?: boolean;
|
|
8106
8377
|
/**
|
|
8107
|
-
* <p>A list of input parameters for the stack set template
|
|
8378
|
+
* <p>A list of input parameters for the stack set template.</p>
|
|
8108
8379
|
*/
|
|
8109
8380
|
Parameters?: Parameter[];
|
|
8110
8381
|
/**
|
|
@@ -8118,18 +8389,19 @@ export interface UpdateStackSetInput {
|
|
|
8118
8389
|
* </p>
|
|
8119
8390
|
* <p>Some stack templates might include resources that can affect permissions in your
|
|
8120
8391
|
* Amazon Web Services account; for example, by creating new Identity and Access Management
|
|
8121
|
-
*
|
|
8122
|
-
* specifying one of these capabilities.</p>
|
|
8392
|
+
* (IAM) users. For those stacks sets, you must explicitly acknowledge
|
|
8393
|
+
* this by specifying one of these capabilities.</p>
|
|
8123
8394
|
* <p>The following IAM resources require you to specify either the
|
|
8124
8395
|
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code>
|
|
8125
8396
|
* capability.</p>
|
|
8126
8397
|
* <ul>
|
|
8127
8398
|
* <li>
|
|
8128
|
-
* <p>If you have IAM resources, you can specify either
|
|
8399
|
+
* <p>If you have IAM resources, you can specify either
|
|
8400
|
+
* capability.</p>
|
|
8129
8401
|
* </li>
|
|
8130
8402
|
* <li>
|
|
8131
|
-
* <p>If you have IAM resources with custom names, you
|
|
8132
|
-
*
|
|
8403
|
+
* <p>If you have IAM resources with custom names, you
|
|
8404
|
+
* <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
8133
8405
|
* </li>
|
|
8134
8406
|
* <li>
|
|
8135
8407
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
@@ -8180,8 +8452,7 @@ export interface UpdateStackSetInput {
|
|
|
8180
8452
|
* </p>
|
|
8181
8453
|
* </li>
|
|
8182
8454
|
* </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>
|
|
8455
|
+
* <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
8456
|
* </li>
|
|
8186
8457
|
* <li>
|
|
8187
8458
|
* <p>
|
|
@@ -8205,33 +8476,33 @@ export interface UpdateStackSetInput {
|
|
|
8205
8476
|
Capabilities?: (Capability | string)[];
|
|
8206
8477
|
/**
|
|
8207
8478
|
* <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
|
-
*
|
|
8479
|
+
* CloudFormation also propagates these tags to supported resources that are created in
|
|
8480
|
+
* the stacks. You can specify a maximum number of 50 tags.</p>
|
|
8210
8481
|
* <p>If you specify tags for this parameter, those tags replace any list of tags that are
|
|
8211
8482
|
* currently associated with this stack set. This means:</p>
|
|
8212
8483
|
* <ul>
|
|
8213
8484
|
* <li>
|
|
8214
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the
|
|
8215
|
-
*
|
|
8485
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
|
8486
|
+
* tags.</p>
|
|
8216
8487
|
* </li>
|
|
8217
8488
|
* <li>
|
|
8218
8489
|
* <p>If you specify <i>any</i> tags using this parameter, you must
|
|
8219
8490
|
* specify <i>all</i> the tags that you want associated with this stack
|
|
8220
|
-
* set, even tags you've
|
|
8491
|
+
* set, even tags you've specified before (for example, when creating the stack set or
|
|
8221
8492
|
* during a previous update of the stack set.). Any tags that you don't include in the
|
|
8222
8493
|
* updated list of tags are removed from the stack set, and therefore from the stacks
|
|
8223
|
-
* and resources as well
|
|
8494
|
+
* and resources as well.</p>
|
|
8224
8495
|
* </li>
|
|
8225
8496
|
* <li>
|
|
8226
|
-
* <p>If you specify an empty value, CloudFormation removes all currently
|
|
8227
|
-
*
|
|
8497
|
+
* <p>If you specify an empty value, CloudFormation removes all currently associated
|
|
8498
|
+
* tags.</p>
|
|
8228
8499
|
* </li>
|
|
8229
8500
|
* </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
|
|
8501
|
+
* <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
|
|
8502
|
+
* resources. If you omit tags that are currently associated with the stack set from the list
|
|
8503
|
+
* of tags you specify, CloudFormation assumes that you want to remove those tags from the
|
|
8504
|
+
* stack set, and checks to see if you have permission to untag resources. If you don't have
|
|
8505
|
+
* the necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an
|
|
8235
8506
|
* <code>access denied</code> error, and the stack set is not updated.</p>
|
|
8236
8507
|
*/
|
|
8237
8508
|
Tags?: Tag[];
|
|
@@ -8240,25 +8511,26 @@ export interface UpdateStackSetInput {
|
|
|
8240
8511
|
*/
|
|
8241
8512
|
OperationPreferences?: StackSetOperationPreferences;
|
|
8242
8513
|
/**
|
|
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>
|
|
8514
|
+
* <p>The Amazon Resource Number (ARN) of the IAM role to use to update this
|
|
8515
|
+
* stack set.</p>
|
|
8516
|
+
* <p>Specify an IAM role only if you are using customized administrator roles
|
|
8517
|
+
* to control which users or groups can manage specific stack sets within the same
|
|
8518
|
+
* administrator account. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Granting Permissions for Stack Set
|
|
8519
|
+
* Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
8249
8520
|
* <p>If you specified a customized administrator role when you created the stack set, you
|
|
8250
8521
|
* must specify a customized administrator role, even if it is the same customized
|
|
8251
8522
|
* administrator role used with this stack set previously.</p>
|
|
8252
8523
|
*/
|
|
8253
8524
|
AdministrationRoleARN?: string;
|
|
8254
8525
|
/**
|
|
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
|
|
8526
|
+
* <p>The name of the IAM execution role to use to update the stack set. If you
|
|
8527
|
+
* do not specify an execution role, CloudFormation uses the
|
|
8528
|
+
* <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set
|
|
8529
|
+
* operation.</p>
|
|
8530
|
+
* <p>Specify an IAM role only if you are using customized execution roles to
|
|
8531
|
+
* control which stack resources users and groups can include in their stack sets.</p>
|
|
8532
|
+
* <p>If you specify a customized execution role, CloudFormation uses that role to update the stack. If
|
|
8533
|
+
* you do not specify a customized execution role, CloudFormation performs the update using the role
|
|
8262
8534
|
* previously associated with the stack set, so long as you have permissions to perform
|
|
8263
8535
|
* operations on the stack set.</p>
|
|
8264
8536
|
*/
|
|
@@ -8270,18 +8542,18 @@ export interface UpdateStackSetInput {
|
|
|
8270
8542
|
* <code>DeploymentTargets</code> or <code>Regions</code>.</p>
|
|
8271
8543
|
* <p>If the stack set update includes changes to the template (that is, if
|
|
8272
8544
|
* <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>
|
|
8545
|
+
* <code>Parameters</code>, CloudFormation marks all stack instances with a status of
|
|
8546
|
+
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts
|
|
8547
|
+
* and Amazon Web Services Regions. If the stack set update doesn't include changes to the
|
|
8548
|
+
* template or parameters, CloudFormation updates the stack instances in the specified
|
|
8549
|
+
* accounts and Regions, while leaving all other stack instances with their existing stack
|
|
8550
|
+
* instance status.</p>
|
|
8279
8551
|
*/
|
|
8280
8552
|
DeploymentTargets?: DeploymentTargets;
|
|
8281
8553
|
/**
|
|
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>
|
|
8554
|
+
* <p>Describes how the IAM roles required for stack set operations are
|
|
8555
|
+
* created. You cannot modify <code>PermissionModel</code> if there are stack instances
|
|
8556
|
+
* associated with your stack set.</p>
|
|
8285
8557
|
* <ul>
|
|
8286
8558
|
* <li>
|
|
8287
8559
|
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
|
@@ -8291,8 +8563,7 @@ export interface UpdateStackSetInput {
|
|
|
8291
8563
|
* </li>
|
|
8292
8564
|
* <li>
|
|
8293
8565
|
* <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>
|
|
8566
|
+
* 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
8567
|
* </li>
|
|
8297
8568
|
* </ul>
|
|
8298
8569
|
*/
|
|
@@ -8301,38 +8572,40 @@ export interface UpdateStackSetInput {
|
|
|
8301
8572
|
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to
|
|
8302
8573
|
* Organizations accounts that are added to a target organization or organizational
|
|
8303
8574
|
* unit (OU).</p>
|
|
8304
|
-
* <p>If you specify <code>AutoDeployment</code>,
|
|
8305
|
-
*
|
|
8575
|
+
* <p>If you specify <code>AutoDeployment</code>, don't specify <code>DeploymentTargets</code>
|
|
8576
|
+
* or <code>Regions</code>.</p>
|
|
8306
8577
|
*/
|
|
8307
8578
|
AutoDeployment?: AutoDeployment;
|
|
8308
8579
|
/**
|
|
8309
|
-
* <p>The unique ID for this stack set operation
|
|
8580
|
+
* <p>The unique ID for this stack set operation.</p>
|
|
8310
8581
|
* <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
8582
|
* multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
|
|
8312
8583
|
* <p>If you don't specify an operation ID, CloudFormation generates one
|
|
8313
8584
|
* automatically.</p>
|
|
8314
8585
|
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
|
8315
|
-
* whose status is <code>OUTDATED</code
|
|
8586
|
+
* whose status is <code>OUTDATED</code>.</p>
|
|
8316
8587
|
*/
|
|
8317
8588
|
OperationId?: string;
|
|
8318
8589
|
/**
|
|
8319
8590
|
* <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>
|
|
8591
|
+
* If you specify accounts, you must also specify the Amazon Web Services Regions in which to
|
|
8592
|
+
* update stack set instances.</p>
|
|
8322
8593
|
* <p>To update <i>all</i> the stack instances associated with this stack set,
|
|
8323
|
-
*
|
|
8594
|
+
* don't specify the <code>Accounts</code> or <code>Regions</code> properties.</p>
|
|
8324
8595
|
* <p>If the stack set update includes changes to the template (that is, if the
|
|
8325
8596
|
* <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the
|
|
8326
8597
|
* <code>Parameters</code> property, CloudFormation marks all stack instances with a status of
|
|
8327
8598
|
* <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
|
-
*
|
|
8599
|
+
* and Amazon Web Services Regions. If the stack set update does not include changes to the
|
|
8600
|
+
* template or parameters, CloudFormation updates the stack instances in the specified accounts and
|
|
8601
|
+
* Amazon Web Services Regions, while leaving all other stack instances with their existing
|
|
8602
|
+
* stack instance status.</p>
|
|
8331
8603
|
*/
|
|
8332
8604
|
Accounts?: string[];
|
|
8333
8605
|
/**
|
|
8334
|
-
* <p>The Regions in which to update associated stack instances. If you
|
|
8335
|
-
* must also specify accounts in which to update stack set
|
|
8606
|
+
* <p>The Amazon Web Services Regions in which to update associated stack instances. If you
|
|
8607
|
+
* specify Regions, you must also specify accounts in which to update stack set
|
|
8608
|
+
* instances.</p>
|
|
8336
8609
|
* <p>To update <i>all</i> the stack instances associated with this stack set,
|
|
8337
8610
|
* do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p>
|
|
8338
8611
|
* <p>If the stack set update includes changes to the template (that is, if the
|
|
@@ -8341,18 +8614,19 @@ export interface UpdateStackSetInput {
|
|
|
8341
8614
|
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts
|
|
8342
8615
|
* and Regions. If the stack set update does not include changes to the template or
|
|
8343
8616
|
* 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
|
|
8617
|
+
* leaving all other stack instances with their existing stack instance status.</p>
|
|
8345
8618
|
*/
|
|
8346
8619
|
Regions?: string[];
|
|
8347
8620
|
/**
|
|
8348
8621
|
* <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>
|
|
8622
|
+
* administrator in the organization's management account or as a delegated
|
|
8623
|
+
* administrator in a member account.</p>
|
|
8351
8624
|
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
|
8352
8625
|
* self-managed permissions.</p>
|
|
8353
8626
|
* <ul>
|
|
8354
8627
|
* <li>
|
|
8355
|
-
* <p>If you are signed in to the management account, specify
|
|
8628
|
+
* <p>If you are signed in to the management account, specify
|
|
8629
|
+
* <code>SELF</code>.</p>
|
|
8356
8630
|
* </li>
|
|
8357
8631
|
* <li>
|
|
8358
8632
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
@@ -8430,8 +8704,8 @@ export interface ValidateTemplateInput {
|
|
|
8430
8704
|
TemplateBody?: string;
|
|
8431
8705
|
/**
|
|
8432
8706
|
* <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>
|
|
8707
|
+
* size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager
|
|
8708
|
+
* document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
|
|
8435
8709
|
* in the CloudFormation User Guide.</p>
|
|
8436
8710
|
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If
|
|
8437
8711
|
* both are passed, only <code>TemplateBody</code> is used.</p>
|
|
@@ -8485,11 +8759,13 @@ export interface ValidateTemplateOutput {
|
|
|
8485
8759
|
*/
|
|
8486
8760
|
Description?: string;
|
|
8487
8761
|
/**
|
|
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
|
-
*
|
|
8762
|
+
* <p>The capabilities found within the template. If your template contains IAM
|
|
8763
|
+
* resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this
|
|
8764
|
+
* parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a>
|
|
8765
|
+
* actions with your template; otherwise, those actions return an InsufficientCapabilities
|
|
8766
|
+
* error.</p>
|
|
8767
|
+
* <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
|
|
8768
|
+
* Templates</a>.</p>
|
|
8493
8769
|
*/
|
|
8494
8770
|
Capabilities?: (Capability | string)[];
|
|
8495
8771
|
/**
|