@aws-sdk/client-cloudformation 3.347.0 → 3.348.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/README.md +1 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/CloudFormation.d.ts +1 -3
- package/dist-types/CloudFormationClient.d.ts +1 -3
- package/dist-types/commands/ActivateTypeCommand.d.ts +6 -6
- package/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +3 -4
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -2
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +9 -9
- package/dist-types/commands/CreateChangeSetCommand.d.ts +16 -19
- package/dist-types/commands/CreateStackCommand.d.ts +2 -2
- package/dist-types/commands/DeactivateTypeCommand.d.ts +5 -6
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +5 -8
- package/dist-types/commands/DeleteStackCommand.d.ts +2 -3
- package/dist-types/commands/DeregisterTypeCommand.d.ts +9 -9
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeChangeSetCommand.d.ts +3 -3
- package/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +2 -1
- package/dist-types/commands/DescribeOrganizationsAccessCommand.d.ts +1 -1
- package/dist-types/commands/DescribePublisherCommand.d.ts +5 -6
- package/dist-types/commands/DescribeStackDriftDetectionStatusCommand.d.ts +9 -11
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +4 -5
- package/dist-types/commands/DescribeStackInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackResourceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +7 -11
- package/dist-types/commands/DescribeStackResourcesCommand.d.ts +12 -14
- package/dist-types/commands/DescribeStacksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeTypeCommand.d.ts +2 -3
- package/dist-types/commands/DescribeTypeRegistrationCommand.d.ts +5 -11
- package/dist-types/commands/DetectStackDriftCommand.d.ts +16 -20
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +9 -12
- package/dist-types/commands/DetectStackSetDriftCommand.d.ts +11 -21
- package/dist-types/commands/EstimateTemplateCostCommand.d.ts +2 -2
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +8 -11
- package/dist-types/commands/GetStackPolicyCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +3 -4
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +7 -8
- package/dist-types/commands/ListChangeSetsCommand.d.ts +2 -2
- package/dist-types/commands/ListExportsCommand.d.ts +4 -6
- package/dist-types/commands/ListImportsCommand.d.ts +4 -6
- package/dist-types/commands/ListStackInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListStackResourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListStacksCommand.d.ts +4 -4
- package/dist-types/commands/PublishTypeCommand.d.ts +6 -5
- package/dist-types/commands/RecordHandlerProgressCommand.d.ts +2 -1
- package/dist-types/commands/RegisterPublisherCommand.d.ts +4 -6
- package/dist-types/commands/RegisterTypeCommand.d.ts +10 -16
- package/dist-types/commands/RollbackStackCommand.d.ts +6 -8
- package/dist-types/commands/SetTypeConfigurationCommand.d.ts +9 -10
- package/dist-types/commands/SetTypeDefaultVersionCommand.d.ts +1 -2
- package/dist-types/commands/SignalResourceCommand.d.ts +4 -5
- package/dist-types/commands/TestTypeCommand.d.ts +16 -18
- package/dist-types/commands/UpdateStackCommand.d.ts +6 -6
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +6 -7
- package/dist-types/commands/ValidateTemplateCommand.d.ts +3 -3
- package/dist-types/index.d.ts +1 -3
- package/dist-types/models/models_0.d.ts +929 -1130
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +5 -5
|
@@ -198,42 +198,41 @@ export type VersionBump = (typeof VersionBump)[keyof typeof VersionBump];
|
|
|
198
198
|
export interface ActivateTypeInput {
|
|
199
199
|
/**
|
|
200
200
|
* <p>The extension type.</p>
|
|
201
|
-
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>,
|
|
202
|
-
*
|
|
201
|
+
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and
|
|
202
|
+
* <code>PublisherId</code>.</p>
|
|
203
203
|
*/
|
|
204
204
|
Type?: ThirdPartyType | string;
|
|
205
205
|
/**
|
|
206
206
|
* <p>The Amazon Resource Name (ARN) of the public extension.</p>
|
|
207
|
-
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>,
|
|
208
|
-
*
|
|
207
|
+
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and
|
|
208
|
+
* <code>PublisherId</code>.</p>
|
|
209
209
|
*/
|
|
210
210
|
PublicTypeArn?: string;
|
|
211
211
|
/**
|
|
212
212
|
* <p>The ID of the extension publisher.</p>
|
|
213
|
-
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>,
|
|
214
|
-
*
|
|
213
|
+
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and
|
|
214
|
+
* <code>PublisherId</code>.</p>
|
|
215
215
|
*/
|
|
216
216
|
PublisherId?: string;
|
|
217
217
|
/**
|
|
218
218
|
* <p>The name of the extension.</p>
|
|
219
|
-
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>,
|
|
220
|
-
*
|
|
219
|
+
* <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and
|
|
220
|
+
* <code>PublisherId</code>.</p>
|
|
221
221
|
*/
|
|
222
222
|
TypeName?: string;
|
|
223
223
|
/**
|
|
224
|
-
* <p>An alias to assign to the public extension, in this account and Region. If you specify an
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
* <p>An extension alias must be unique within a given account and Region. You can activate the
|
|
229
|
-
*
|
|
230
|
-
* aliases.</p>
|
|
224
|
+
* <p>An alias to assign to the public extension, in this account and Region. If you specify an alias for the
|
|
225
|
+
* extension, CloudFormation treats the alias as the extension type name within this account and Region. You
|
|
226
|
+
* must use the alias to refer to the extension in your templates, API calls, and CloudFormation
|
|
227
|
+
* console.</p>
|
|
228
|
+
* <p>An extension alias must be unique within a given account and Region. You can activate the same public resource
|
|
229
|
+
* multiple times in the same account and Region, using different type name aliases.</p>
|
|
231
230
|
*/
|
|
232
231
|
TypeNameAlias?: string;
|
|
233
232
|
/**
|
|
234
|
-
* <p>Whether to automatically update the extension in this account and Region when a new
|
|
235
|
-
*
|
|
236
|
-
*
|
|
233
|
+
* <p>Whether to automatically update the extension in this account and Region when a new <i>minor</i>
|
|
234
|
+
* version is published by the extension publisher. Major versions released by the publisher must be manually
|
|
235
|
+
* updated.</p>
|
|
237
236
|
* <p>The default is <code>true</code>.</p>
|
|
238
237
|
*/
|
|
239
238
|
AutoUpdate?: boolean;
|
|
@@ -246,29 +245,27 @@ export interface ActivateTypeInput {
|
|
|
246
245
|
*/
|
|
247
246
|
ExecutionRoleArn?: string;
|
|
248
247
|
/**
|
|
249
|
-
* <p>Manually updates a previously-activated type to a new major or minor version, if
|
|
250
|
-
*
|
|
251
|
-
* <code>AutoUpdate</code>.</p>
|
|
248
|
+
* <p>Manually updates a previously-activated type to a new major or minor version, if available. You can also use
|
|
249
|
+
* this parameter to update the value of <code>AutoUpdate</code>.</p>
|
|
252
250
|
* <ul>
|
|
253
251
|
* <li>
|
|
254
252
|
* <p>
|
|
255
|
-
* <code>MAJOR</code>: CloudFormation updates the extension to the newest major
|
|
256
|
-
*
|
|
253
|
+
* <code>MAJOR</code>: CloudFormation updates the extension to the newest major version, if one is
|
|
254
|
+
* available.</p>
|
|
257
255
|
* </li>
|
|
258
256
|
* <li>
|
|
259
257
|
* <p>
|
|
260
|
-
* <code>MINOR</code>: CloudFormation updates the extension to the newest minor
|
|
261
|
-
*
|
|
258
|
+
* <code>MINOR</code>: CloudFormation updates the extension to the newest minor version, if one is
|
|
259
|
+
* available.</p>
|
|
262
260
|
* </li>
|
|
263
261
|
* </ul>
|
|
264
262
|
*/
|
|
265
263
|
VersionBump?: VersionBump | string;
|
|
266
264
|
/**
|
|
267
|
-
* <p>The major version of this extension you want to activate, if multiple major versions are
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
* <p>You can specify <code>MajorVersion</code> or <code>VersionBump</code>, but not
|
|
271
|
-
* both.</p>
|
|
265
|
+
* <p>The major version of this extension you want to activate, if multiple major versions are available. The default
|
|
266
|
+
* is the latest major version. CloudFormation uses the latest available <i>minor</i> version of
|
|
267
|
+
* the major version selected.</p>
|
|
268
|
+
* <p>You can specify <code>MajorVersion</code> or <code>VersionBump</code>, but not both.</p>
|
|
272
269
|
*/
|
|
273
270
|
MajorVersion?: number;
|
|
274
271
|
}
|
|
@@ -277,8 +274,7 @@ export interface ActivateTypeInput {
|
|
|
277
274
|
*/
|
|
278
275
|
export interface ActivateTypeOutput {
|
|
279
276
|
/**
|
|
280
|
-
* <p>The Amazon Resource Name (ARN) of the activated extension, in this account and
|
|
281
|
-
* Region.</p>
|
|
277
|
+
* <p>The Amazon Resource Name (ARN) of the activated extension, in this account and Region.</p>
|
|
282
278
|
*/
|
|
283
279
|
Arn?: string;
|
|
284
280
|
}
|
|
@@ -446,18 +442,16 @@ export interface TypeConfigurationDetails {
|
|
|
446
442
|
*/
|
|
447
443
|
export interface BatchDescribeTypeConfigurationsOutput {
|
|
448
444
|
/**
|
|
449
|
-
* <p>A list of information concerning any errors generated during the setting of the specified
|
|
450
|
-
* configurations.</p>
|
|
445
|
+
* <p>A list of information concerning any errors generated during the setting of the specified configurations.</p>
|
|
451
446
|
*/
|
|
452
447
|
Errors?: BatchDescribeTypeConfigurationsError[];
|
|
453
448
|
/**
|
|
454
|
-
* <p>A list of any of the specified extension configurations that CloudFormation could
|
|
455
|
-
*
|
|
449
|
+
* <p>A list of any of the specified extension configurations that CloudFormation could not process for any
|
|
450
|
+
* reason.</p>
|
|
456
451
|
*/
|
|
457
452
|
UnprocessedTypeConfigurations?: TypeConfigurationIdentifier[];
|
|
458
453
|
/**
|
|
459
|
-
* <p>A list of any of the specified extension configurations from the CloudFormation
|
|
460
|
-
* registry.</p>
|
|
454
|
+
* <p>A list of any of the specified extension configurations from the CloudFormation registry.</p>
|
|
461
455
|
*/
|
|
462
456
|
TypeConfigurations?: TypeConfigurationDetails[];
|
|
463
457
|
}
|
|
@@ -493,25 +487,25 @@ export type CallAs = (typeof CallAs)[keyof typeof CallAs];
|
|
|
493
487
|
export interface CancelUpdateStackInput {
|
|
494
488
|
/**
|
|
495
489
|
* <note>
|
|
496
|
-
* <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response that
|
|
497
|
-
*
|
|
498
|
-
* <p>The IAM policy below can be added to
|
|
499
|
-
*
|
|
500
|
-
*
|
|
490
|
+
* <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response that describes
|
|
491
|
+
* all resources in the account.</p>
|
|
492
|
+
* <p>The IAM policy below can be added to
|
|
493
|
+
* IAM policies when you want to limit resource-level permissions and
|
|
494
|
+
* avoid returning a response when no parameter is sent in the request:</p>
|
|
501
495
|
* <p>
|
|
502
496
|
* <code>\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny", "Action":
|
|
503
|
-
*
|
|
504
|
-
*
|
|
497
|
+
* "cloudformation:DescribeStacks", "NotResource":
|
|
498
|
+
* "arn:aws:cloudformation:*:*:stack/*\/*" \}] \}</code>
|
|
505
499
|
* </p>
|
|
506
500
|
* </note>
|
|
507
501
|
* <p>The name or the unique stack ID that's associated with the stack.</p>
|
|
508
502
|
*/
|
|
509
503
|
StackName: string | undefined;
|
|
510
504
|
/**
|
|
511
|
-
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token if
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
505
|
+
* <p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token if you plan to retry
|
|
506
|
+
* requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same
|
|
507
|
+
* name. You might retry <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully received
|
|
508
|
+
* them.</p>
|
|
515
509
|
*/
|
|
516
510
|
ClientRequestToken?: string;
|
|
517
511
|
}
|
|
@@ -1144,62 +1138,56 @@ export interface ContinueUpdateRollbackInput {
|
|
|
1144
1138
|
* <p>The name or the unique ID of the stack that you want to continue rolling back.</p>
|
|
1145
1139
|
* <note>
|
|
1146
1140
|
* <p>Don't specify the name of a nested stack (a stack that was created by using the
|
|
1147
|
-
*
|
|
1148
|
-
*
|
|
1149
|
-
* resource).</p>
|
|
1141
|
+
* <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that
|
|
1142
|
+
* contains the <code>AWS::CloudFormation::Stack</code> resource).</p>
|
|
1150
1143
|
* </note>
|
|
1151
1144
|
*/
|
|
1152
1145
|
StackName: string | undefined;
|
|
1153
1146
|
/**
|
|
1154
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
|
|
1155
|
-
*
|
|
1156
|
-
*
|
|
1157
|
-
*
|
|
1158
|
-
*
|
|
1159
|
-
*
|
|
1160
|
-
*
|
|
1161
|
-
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1162
|
-
* session that's generated from your user credentials.</p>
|
|
1147
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf.
|
|
1148
|
+
* CloudFormation always uses this role for all future operations on the stack. Provided that users have
|
|
1149
|
+
* permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to
|
|
1150
|
+
* pass it. Ensure that the role grants least permission.</p>
|
|
1151
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the
|
|
1152
|
+
* stack. If no role is available, CloudFormation uses a temporary session that's generated from your user
|
|
1153
|
+
* credentials.</p>
|
|
1163
1154
|
*/
|
|
1164
1155
|
RoleARN?: string;
|
|
1165
1156
|
/**
|
|
1166
|
-
* <p>A list of the logical IDs of the resources that CloudFormation skips during the
|
|
1167
|
-
*
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
1170
|
-
*
|
|
1157
|
+
* <p>A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback
|
|
1158
|
+
* operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed.
|
|
1159
|
+
* You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because
|
|
1160
|
+
* an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a>
|
|
1161
|
+
* action, and view the resource status reason.</p>
|
|
1171
1162
|
* <important>
|
|
1172
|
-
* <p>Specify this property to skip rolling back resources that CloudFormation can't
|
|
1173
|
-
*
|
|
1174
|
-
*
|
|
1175
|
-
*
|
|
1176
|
-
*
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1179
|
-
* unrecoverable.</p>
|
|
1163
|
+
* <p>Specify this property to skip rolling back resources that CloudFormation can't successfully roll back.
|
|
1164
|
+
* We recommend that you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed">
|
|
1165
|
+
* troubleshoot</a> resources before skipping them. CloudFormation sets the status of the specified
|
|
1166
|
+
* resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the
|
|
1167
|
+
* state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
|
|
1168
|
+
* performing another stack update, you must update the stack or resources to be consistent with each other. If you
|
|
1169
|
+
* don't, subsequent stack updates might fail, and the stack will become unrecoverable.</p>
|
|
1180
1170
|
* </important>
|
|
1181
|
-
* <p>Specify the minimum number of resources required to successfully roll back your stack. For
|
|
1182
|
-
*
|
|
1183
|
-
*
|
|
1171
|
+
* <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
|
|
1172
|
+
* resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
|
|
1173
|
+
* dependent resources.</p>
|
|
1184
1174
|
* <p>To skip resources that are part of nested stacks, use the following format:
|
|
1185
|
-
*
|
|
1186
|
-
*
|
|
1187
|
-
*
|
|
1188
|
-
*
|
|
1189
|
-
* <code>DELETE_FAILED</code>.</p>
|
|
1175
|
+
* <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource
|
|
1176
|
+
* (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding
|
|
1177
|
+
* embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>,
|
|
1178
|
+
* or <code>DELETE_FAILED</code>.</p>
|
|
1190
1179
|
* <note>
|
|
1191
|
-
* <p>Don't confuse a child stack's name with its corresponding logical ID defined in the
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1180
|
+
* <p>Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an
|
|
1181
|
+
* example of a continue update rollback operation with nested stacks, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks">Using
|
|
1182
|
+
* ResourcesToSkip to recover a nested stacks hierarchy</a>.</p>
|
|
1194
1183
|
* </note>
|
|
1195
1184
|
*/
|
|
1196
1185
|
ResourcesToSkip?: string[];
|
|
1197
1186
|
/**
|
|
1198
|
-
* <p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
* successfully received them.</p>
|
|
1187
|
+
* <p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this token if you plan to
|
|
1188
|
+
* retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with
|
|
1189
|
+
* the same name. You might retry <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation
|
|
1190
|
+
* successfully received them.</p>
|
|
1203
1191
|
*/
|
|
1204
1192
|
ClientRequestToken?: string;
|
|
1205
1193
|
}
|
|
@@ -1229,9 +1217,8 @@ export interface Parameter {
|
|
|
1229
1217
|
UsePreviousValue?: boolean;
|
|
1230
1218
|
/**
|
|
1231
1219
|
* <p>Read-only. The value that corresponds to a SSM parameter key. This field is returned only for
|
|
1232
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types">
|
|
1233
|
-
*
|
|
1234
|
-
* </a> parameter types in the template.</p>
|
|
1220
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types"> SSM</a>
|
|
1221
|
+
* parameter types in the template.</p>
|
|
1235
1222
|
*/
|
|
1236
1223
|
ResolvedValue?: string;
|
|
1237
1224
|
}
|
|
@@ -1342,78 +1329,73 @@ export interface Tag {
|
|
|
1342
1329
|
*/
|
|
1343
1330
|
export interface CreateChangeSetInput {
|
|
1344
1331
|
/**
|
|
1345
|
-
* <p>The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1332
|
+
* <p>The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the
|
|
1333
|
+
* change set by comparing this stack's information with the information that you submit, such as a modified template or
|
|
1334
|
+
* different parameter input values.</p>
|
|
1348
1335
|
*/
|
|
1349
1336
|
StackName: string | undefined;
|
|
1350
1337
|
/**
|
|
1351
|
-
* <p>A structure that contains the body of the revised template, with a minimum length of 1
|
|
1352
|
-
*
|
|
1353
|
-
*
|
|
1354
|
-
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1355
|
-
* <code>TemplateURL</code>.</p>
|
|
1338
|
+
* <p>A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length
|
|
1339
|
+
* of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the
|
|
1340
|
+
* stack that you specified.</p>
|
|
1341
|
+
* <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>
|
|
1356
1342
|
*/
|
|
1357
1343
|
TemplateBody?: string;
|
|
1358
1344
|
/**
|
|
1359
|
-
* <p>The location of the file that contains the revised template. The URL must point to a
|
|
1360
|
-
*
|
|
1361
|
-
*
|
|
1362
|
-
*
|
|
1363
|
-
* <p>Conditional: You must specify only <code>TemplateBody</code> or
|
|
1364
|
-
* <code>TemplateURL</code>.</p>
|
|
1345
|
+
* <p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
|
|
1346
|
+
* bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the
|
|
1347
|
+
* change set by comparing this template with the stack that you specified.</p>
|
|
1348
|
+
* <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>
|
|
1365
1349
|
*/
|
|
1366
1350
|
TemplateURL?: string;
|
|
1367
1351
|
/**
|
|
1368
|
-
* <p>Whether to reuse the template that's associated with the stack to create the change
|
|
1369
|
-
* set.</p>
|
|
1352
|
+
* <p>Whether to reuse the template that's associated with the stack to create the change set.</p>
|
|
1370
1353
|
*/
|
|
1371
1354
|
UsePreviousTemplate?: boolean;
|
|
1372
1355
|
/**
|
|
1373
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the change
|
|
1374
|
-
*
|
|
1356
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more
|
|
1357
|
+
* information, see the <a>Parameter</a> data type.</p>
|
|
1375
1358
|
*/
|
|
1376
1359
|
Parameters?: Parameter[];
|
|
1377
1360
|
/**
|
|
1378
|
-
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
|
1379
|
-
*
|
|
1361
|
+
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
1362
|
+
* for CloudFormation to create the stack.</p>
|
|
1380
1363
|
* <ul>
|
|
1381
1364
|
* <li>
|
|
1382
1365
|
* <p>
|
|
1383
1366
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1384
1367
|
* </p>
|
|
1385
|
-
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1386
|
-
*
|
|
1387
|
-
*
|
|
1388
|
-
* <p>The following IAM resources require you to specify either the
|
|
1389
|
-
*
|
|
1368
|
+
* <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account;
|
|
1369
|
+
* for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must
|
|
1370
|
+
* explicitly acknowledge this by specifying one of these capabilities.</p>
|
|
1371
|
+
* <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or
|
|
1372
|
+
* <code>CAPABILITY_NAMED_IAM</code> capability.</p>
|
|
1390
1373
|
* <ul>
|
|
1391
1374
|
* <li>
|
|
1392
|
-
* <p>If you have IAM resources, you can specify either
|
|
1393
|
-
* capability.</p>
|
|
1375
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
1394
1376
|
* </li>
|
|
1395
1377
|
* <li>
|
|
1396
|
-
* <p>If you have IAM resources with custom names, you
|
|
1397
|
-
*
|
|
1378
|
+
* <p>If you have IAM resources with custom names, you <i>must</i> specify
|
|
1379
|
+
* <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1398
1380
|
* </li>
|
|
1399
1381
|
* <li>
|
|
1400
|
-
* <p>If you don't specify either of these capabilities, CloudFormation returns
|
|
1401
|
-
*
|
|
1382
|
+
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
1383
|
+
* <code>InsufficientCapabilities</code> error.</p>
|
|
1402
1384
|
* </li>
|
|
1403
1385
|
* </ul>
|
|
1404
|
-
* <p>If your stack template contains these resources, we suggest that you review all
|
|
1405
|
-
*
|
|
1386
|
+
* <p>If your stack template contains these resources, we suggest that you review all permissions associated with
|
|
1387
|
+
* them and edit their permissions if necessary.</p>
|
|
1406
1388
|
* <ul>
|
|
1407
1389
|
* <li>
|
|
1408
1390
|
* <p>
|
|
1409
1391
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">
|
|
1410
|
-
*
|
|
1392
|
+
* AWS::IAM::AccessKey</a>
|
|
1411
1393
|
* </p>
|
|
1412
1394
|
* </li>
|
|
1413
1395
|
* <li>
|
|
1414
1396
|
* <p>
|
|
1415
1397
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">
|
|
1416
|
-
*
|
|
1398
|
+
* AWS::IAM::Group</a>
|
|
1417
1399
|
* </p>
|
|
1418
1400
|
* </li>
|
|
1419
1401
|
* <li>
|
|
@@ -1424,19 +1406,19 @@ export interface CreateChangeSetInput {
|
|
|
1424
1406
|
* <li>
|
|
1425
1407
|
* <p>
|
|
1426
1408
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">
|
|
1427
|
-
*
|
|
1409
|
+
* AWS::IAM::Policy</a>
|
|
1428
1410
|
* </p>
|
|
1429
1411
|
* </li>
|
|
1430
1412
|
* <li>
|
|
1431
1413
|
* <p>
|
|
1432
1414
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html">
|
|
1433
|
-
*
|
|
1415
|
+
* AWS::IAM::Role</a>
|
|
1434
1416
|
* </p>
|
|
1435
1417
|
* </li>
|
|
1436
1418
|
* <li>
|
|
1437
1419
|
* <p>
|
|
1438
1420
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">
|
|
1439
|
-
*
|
|
1421
|
+
* AWS::IAM::User</a>
|
|
1440
1422
|
* </p>
|
|
1441
1423
|
* </li>
|
|
1442
1424
|
* <li>
|
|
@@ -1445,82 +1427,80 @@ export interface CreateChangeSetInput {
|
|
|
1445
1427
|
* </p>
|
|
1446
1428
|
* </li>
|
|
1447
1429
|
* </ul>
|
|
1448
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
1430
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
1431
|
+
* IAM resources in CloudFormation templates</a>.</p>
|
|
1449
1432
|
* </li>
|
|
1450
1433
|
* <li>
|
|
1451
1434
|
* <p>
|
|
1452
1435
|
* <code>CAPABILITY_AUTO_EXPAND</code>
|
|
1453
1436
|
* </p>
|
|
1454
|
-
* <p>Some template contain macros. Macros perform custom processing on templates; this can
|
|
1455
|
-
*
|
|
1456
|
-
*
|
|
1457
|
-
*
|
|
1458
|
-
*
|
|
1459
|
-
*
|
|
1460
|
-
*
|
|
1461
|
-
* 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>
|
|
1437
|
+
* <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions
|
|
1438
|
+
* like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,
|
|
1439
|
+
* users typically create a change set from the processed template, so that they can review the changes resulting from
|
|
1440
|
+
* the macros before actually creating the stack. If your stack template contains one or more macros, and you choose
|
|
1441
|
+
* to create a stack directly from the processed template, without first reviewing the resulting changes in a change
|
|
1442
|
+
* set, you must acknowledge 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>
|
|
1443
|
+
* transforms, which are macros hosted by CloudFormation.</p>
|
|
1462
1444
|
* <note>
|
|
1463
|
-
* <p>This capacity doesn't apply to creating change sets, and specifying it when creating
|
|
1464
|
-
*
|
|
1465
|
-
* <p>If you want to create a stack from a stack template that contains macros
|
|
1466
|
-
*
|
|
1467
|
-
*
|
|
1445
|
+
* <p>This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no
|
|
1446
|
+
* effect.</p>
|
|
1447
|
+
* <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested
|
|
1448
|
+
* stacks, you must create or update the stack directly from the template using the <a>CreateStack</a> or
|
|
1449
|
+
* <a>UpdateStack</a> action, and specifying this capability.</p>
|
|
1468
1450
|
* </note>
|
|
1469
|
-
* <p>For more information about macros, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation macros to perform custom processing on
|
|
1470
|
-
* templates</a>.</p>
|
|
1451
|
+
* <p>For more information about macros, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation macros to perform custom processing on templates</a>.</p>
|
|
1471
1452
|
* </li>
|
|
1472
1453
|
* </ul>
|
|
1473
1454
|
*/
|
|
1474
1455
|
Capabilities?: (Capability | string)[];
|
|
1475
1456
|
/**
|
|
1476
|
-
* <p>The template resource types that you have permissions to work with if you execute this
|
|
1477
|
-
*
|
|
1478
|
-
*
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1457
|
+
* <p>The template resource types that you have permissions to work with if you execute this change set, such as
|
|
1458
|
+
* <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p>
|
|
1459
|
+
* <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By
|
|
1460
|
+
* default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
|
|
1461
|
+
* uses this parameter for condition keys in IAM policies for CloudFormation. For more information,
|
|
1462
|
+
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling access
|
|
1463
|
+
* with Identity and Access Management</a> in the CloudFormation User Guide.</p>
|
|
1483
1464
|
*/
|
|
1484
1465
|
ResourceTypes?: string[];
|
|
1485
1466
|
/**
|
|
1486
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
|
|
1487
|
-
*
|
|
1488
|
-
*
|
|
1489
|
-
*
|
|
1490
|
-
*
|
|
1491
|
-
* <p>If you don't specify a value, CloudFormation uses the role that was previously
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1467
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation
|
|
1468
|
+
* assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.
|
|
1469
|
+
* CloudFormation uses this role for all future operations on the stack. Provided that users have permission to
|
|
1470
|
+
* operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure
|
|
1471
|
+
* that the role grants least permission.</p>
|
|
1472
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If
|
|
1473
|
+
* no role is available, CloudFormation uses a temporary session that is generated from your user
|
|
1474
|
+
* credentials.</p>
|
|
1494
1475
|
*/
|
|
1495
1476
|
RoleARN?: string;
|
|
1496
1477
|
/**
|
|
1497
|
-
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating
|
|
1498
|
-
*
|
|
1478
|
+
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
|
|
1479
|
+
* the specified monitoring period afterwards.</p>
|
|
1499
1480
|
*/
|
|
1500
1481
|
RollbackConfiguration?: RollbackConfiguration;
|
|
1501
1482
|
/**
|
|
1502
|
-
* <p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics
|
|
1503
|
-
*
|
|
1504
|
-
* topics, specify an empty list.</p>
|
|
1483
|
+
* <p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
|
|
1484
|
+
* associates with the stack. To remove all associated notification topics, specify an empty list.</p>
|
|
1505
1485
|
*/
|
|
1506
1486
|
NotificationARNs?: string[];
|
|
1507
1487
|
/**
|
|
1508
|
-
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these
|
|
1509
|
-
*
|
|
1488
|
+
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the
|
|
1489
|
+
* stack. You can specify a maximum of 50 tags.</p>
|
|
1510
1490
|
*/
|
|
1511
1491
|
Tags?: Tag[];
|
|
1512
1492
|
/**
|
|
1513
|
-
* <p>The name of the change set. The name must be unique among all change sets that are
|
|
1514
|
-
*
|
|
1515
|
-
* <p>A change set name can contain only alphanumeric, case sensitive characters, and hyphens.
|
|
1516
|
-
*
|
|
1493
|
+
* <p>The name of the change set. The name must be unique among all change sets that are associated with the specified
|
|
1494
|
+
* stack.</p>
|
|
1495
|
+
* <p>A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an
|
|
1496
|
+
* alphabetical character and can't exceed 128 characters.</p>
|
|
1517
1497
|
*/
|
|
1518
1498
|
ChangeSetName: string | undefined;
|
|
1519
1499
|
/**
|
|
1520
|
-
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1500
|
+
* <p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if you plan to retry
|
|
1501
|
+
* requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
|
|
1502
|
+
* You might retry <code>CreateChangeSet</code> requests to ensure that CloudFormation successfully received
|
|
1503
|
+
* them.</p>
|
|
1524
1504
|
*/
|
|
1525
1505
|
ClientToken?: string;
|
|
1526
1506
|
/**
|
|
@@ -1528,17 +1508,15 @@ export interface CreateChangeSetInput {
|
|
|
1528
1508
|
*/
|
|
1529
1509
|
Description?: string;
|
|
1530
1510
|
/**
|
|
1531
|
-
* <p>The type of change set operation. To create a change set for a new stack, specify
|
|
1532
|
-
*
|
|
1533
|
-
*
|
|
1534
|
-
*
|
|
1535
|
-
*
|
|
1536
|
-
*
|
|
1537
|
-
*
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1540
|
-
* <code>UPDATE</code> type to create a change set for a new stack or the <code>CREATE</code>
|
|
1541
|
-
* type to create a change set for an existing stack.</p>
|
|
1511
|
+
* <p>The type of change set operation. To create a change set for a new stack, specify <code>CREATE</code>. To create
|
|
1512
|
+
* a change set for an existing stack, specify <code>UPDATE</code>. To create a change set for an import operation,
|
|
1513
|
+
* specify <code>IMPORT</code>.</p>
|
|
1514
|
+
* <p>If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no
|
|
1515
|
+
* 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">REVIEW_IN_PROGRESS</a> state
|
|
1516
|
+
* until you execute the change set.</p>
|
|
1517
|
+
* <p>By default, CloudFormation specifies <code>UPDATE</code>. You can't use the <code>UPDATE</code> type to
|
|
1518
|
+
* create a change set for a new stack or the <code>CREATE</code> type to create a change set for an existing
|
|
1519
|
+
* stack.</p>
|
|
1542
1520
|
*/
|
|
1543
1521
|
ChangeSetType?: ChangeSetType | string;
|
|
1544
1522
|
/**
|
|
@@ -1546,9 +1524,8 @@ export interface CreateChangeSetInput {
|
|
|
1546
1524
|
*/
|
|
1547
1525
|
ResourcesToImport?: ResourceToImport[];
|
|
1548
1526
|
/**
|
|
1549
|
-
* <p>Creates a change set for the all nested stacks specified in the template. The default
|
|
1550
|
-
*
|
|
1551
|
-
* specify <code>True</code>.</p>
|
|
1527
|
+
* <p>Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
|
|
1528
|
+
* set to <code>False</code>. To include nested sets in a change set, specify <code>True</code>.</p>
|
|
1552
1529
|
*/
|
|
1553
1530
|
IncludeNestedStacks?: boolean;
|
|
1554
1531
|
}
|
|
@@ -1613,102 +1590,96 @@ export type OnFailure = (typeof OnFailure)[keyof typeof OnFailure];
|
|
|
1613
1590
|
*/
|
|
1614
1591
|
export interface CreateStackInput {
|
|
1615
1592
|
/**
|
|
1616
|
-
* <p>The name that's associated with the stack. The name must be unique in the Region in which
|
|
1617
|
-
*
|
|
1593
|
+
* <p>The name that's associated with the stack. The name must be unique in the Region in which you are creating the
|
|
1594
|
+
* stack.</p>
|
|
1618
1595
|
* <note>
|
|
1619
|
-
* <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It
|
|
1620
|
-
*
|
|
1596
|
+
* <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
|
|
1597
|
+
* alphabetical character and can't be longer than 128 characters.</p>
|
|
1621
1598
|
* </note>
|
|
1622
1599
|
*/
|
|
1623
1600
|
StackName: string | undefined;
|
|
1624
1601
|
/**
|
|
1625
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
1626
|
-
*
|
|
1627
|
-
*
|
|
1628
|
-
*
|
|
1629
|
-
* <code>TemplateURL</code> parameter, but not both.</p>
|
|
1602
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
|
|
1603
|
+
* more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a> in the CloudFormation User Guide.</p>
|
|
1604
|
+
* <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter,
|
|
1605
|
+
* but not both.</p>
|
|
1630
1606
|
*/
|
|
1631
1607
|
TemplateBody?: string;
|
|
1632
1608
|
/**
|
|
1633
|
-
* <p>Location of file containing the template body. The URL must point to a template (max size:
|
|
1634
|
-
*
|
|
1635
|
-
*
|
|
1636
|
-
*
|
|
1637
|
-
*
|
|
1638
|
-
* <code>TemplateURL</code> parameter, but not both.</p>
|
|
1609
|
+
* <p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
|
|
1610
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a> in the
|
|
1611
|
+
* CloudFormation User Guide.</p>
|
|
1612
|
+
* <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter,
|
|
1613
|
+
* but not both.</p>
|
|
1639
1614
|
*/
|
|
1640
1615
|
TemplateURL?: string;
|
|
1641
1616
|
/**
|
|
1642
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack.
|
|
1643
|
-
*
|
|
1644
|
-
*
|
|
1617
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information,
|
|
1618
|
+
* see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a>
|
|
1619
|
+
* data type.</p>
|
|
1645
1620
|
*/
|
|
1646
1621
|
Parameters?: Parameter[];
|
|
1647
1622
|
/**
|
|
1648
|
-
* <p>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You
|
|
1649
|
-
*
|
|
1650
|
-
* both.</p>
|
|
1623
|
+
* <p>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either
|
|
1624
|
+
* <code>DisableRollback</code> or <code>OnFailure</code>, but not both.</p>
|
|
1651
1625
|
* <p>Default: <code>false</code>
|
|
1652
1626
|
* </p>
|
|
1653
1627
|
*/
|
|
1654
1628
|
DisableRollback?: boolean;
|
|
1655
1629
|
/**
|
|
1656
|
-
* <p>The rollback triggers for CloudFormation to monitor during stack creation and
|
|
1657
|
-
*
|
|
1630
|
+
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and
|
|
1631
|
+
* for the specified monitoring period afterwards.</p>
|
|
1658
1632
|
*/
|
|
1659
1633
|
RollbackConfiguration?: RollbackConfiguration;
|
|
1660
1634
|
/**
|
|
1661
|
-
* <p>The amount of time that can pass before the stack status becomes CREATE_FAILED; if
|
|
1662
|
-
*
|
|
1663
|
-
* rolled back.</p>
|
|
1635
|
+
* <p>The amount of time that can pass before the stack status becomes CREATE_FAILED; if <code>DisableRollback</code>
|
|
1636
|
+
* is not set or is set to <code>false</code>, the stack will be rolled back.</p>
|
|
1664
1637
|
*/
|
|
1665
1638
|
TimeoutInMinutes?: number;
|
|
1666
1639
|
/**
|
|
1667
|
-
* <p>The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related
|
|
1668
|
-
*
|
|
1669
|
-
* or your Command Line Interface (CLI).</p>
|
|
1640
|
+
* <p>The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your
|
|
1641
|
+
* Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).</p>
|
|
1670
1642
|
*/
|
|
1671
1643
|
NotificationARNs?: string[];
|
|
1672
1644
|
/**
|
|
1673
|
-
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
|
1674
|
-
*
|
|
1645
|
+
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
1646
|
+
* for CloudFormation to create the stack.</p>
|
|
1675
1647
|
* <ul>
|
|
1676
1648
|
* <li>
|
|
1677
1649
|
* <p>
|
|
1678
1650
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
1679
1651
|
* </p>
|
|
1680
|
-
* <p>Some stack templates might include resources that can affect permissions in your
|
|
1681
|
-
*
|
|
1682
|
-
*
|
|
1683
|
-
* <p>The following IAM resources require you to specify either the
|
|
1684
|
-
*
|
|
1652
|
+
* <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account;
|
|
1653
|
+
* for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must
|
|
1654
|
+
* explicitly acknowledge this by specifying one of these capabilities.</p>
|
|
1655
|
+
* <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or
|
|
1656
|
+
* <code>CAPABILITY_NAMED_IAM</code> capability.</p>
|
|
1685
1657
|
* <ul>
|
|
1686
1658
|
* <li>
|
|
1687
|
-
* <p>If you have IAM resources, you can specify either
|
|
1688
|
-
* capability.</p>
|
|
1659
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
1689
1660
|
* </li>
|
|
1690
1661
|
* <li>
|
|
1691
|
-
* <p>If you have IAM resources with custom names, you
|
|
1692
|
-
*
|
|
1662
|
+
* <p>If you have IAM resources with custom names, you <i>must</i> specify
|
|
1663
|
+
* <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
1693
1664
|
* </li>
|
|
1694
1665
|
* <li>
|
|
1695
1666
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
1696
|
-
*
|
|
1667
|
+
* <code>InsufficientCapabilities</code> error.</p>
|
|
1697
1668
|
* </li>
|
|
1698
1669
|
* </ul>
|
|
1699
|
-
* <p>If your stack template contains these resources, we recommend that you review all
|
|
1700
|
-
*
|
|
1670
|
+
* <p>If your stack template contains these resources, we recommend that you review all permissions associated with
|
|
1671
|
+
* them and edit their permissions if necessary.</p>
|
|
1701
1672
|
* <ul>
|
|
1702
1673
|
* <li>
|
|
1703
1674
|
* <p>
|
|
1704
1675
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">
|
|
1705
|
-
*
|
|
1676
|
+
* AWS::IAM::AccessKey</a>
|
|
1706
1677
|
* </p>
|
|
1707
1678
|
* </li>
|
|
1708
1679
|
* <li>
|
|
1709
1680
|
* <p>
|
|
1710
1681
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">
|
|
1711
|
-
*
|
|
1682
|
+
* AWS::IAM::Group</a>
|
|
1712
1683
|
* </p>
|
|
1713
1684
|
* </li>
|
|
1714
1685
|
* <li>
|
|
@@ -1719,19 +1690,19 @@ export interface CreateStackInput {
|
|
|
1719
1690
|
* <li>
|
|
1720
1691
|
* <p>
|
|
1721
1692
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">
|
|
1722
|
-
*
|
|
1693
|
+
* AWS::IAM::Policy</a>
|
|
1723
1694
|
* </p>
|
|
1724
1695
|
* </li>
|
|
1725
1696
|
* <li>
|
|
1726
1697
|
* <p>
|
|
1727
1698
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html">
|
|
1728
|
-
*
|
|
1699
|
+
* AWS::IAM::Role</a>
|
|
1729
1700
|
* </p>
|
|
1730
1701
|
* </li>
|
|
1731
1702
|
* <li>
|
|
1732
1703
|
* <p>
|
|
1733
1704
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">
|
|
1734
|
-
*
|
|
1705
|
+
* AWS::IAM::User</a>
|
|
1735
1706
|
* </p>
|
|
1736
1707
|
* </li>
|
|
1737
1708
|
* <li>
|
|
@@ -1740,120 +1711,106 @@ export interface CreateStackInput {
|
|
|
1740
1711
|
* </p>
|
|
1741
1712
|
* </li>
|
|
1742
1713
|
* </ul>
|
|
1743
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
1714
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
1715
|
+
* IAM Resources in CloudFormation Templates</a>.</p>
|
|
1744
1716
|
* </li>
|
|
1745
1717
|
* <li>
|
|
1746
1718
|
* <p>
|
|
1747
1719
|
* <code>CAPABILITY_AUTO_EXPAND</code>
|
|
1748
1720
|
* </p>
|
|
1749
|
-
* <p>Some template contain macros. Macros perform custom processing on templates; this can
|
|
1750
|
-
*
|
|
1751
|
-
*
|
|
1752
|
-
*
|
|
1753
|
-
*
|
|
1754
|
-
*
|
|
1755
|
-
*
|
|
1756
|
-
*
|
|
1757
|
-
*
|
|
1758
|
-
* <i>and</i> nested stacks, you must create the stack directly from the
|
|
1759
|
-
* template using this capability.</p>
|
|
1721
|
+
* <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions
|
|
1722
|
+
* like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,
|
|
1723
|
+
* users typically create a change set from the processed template, so that they can review the changes resulting from
|
|
1724
|
+
* the macros before actually creating the stack. If your stack template contains one or more macros, and you choose
|
|
1725
|
+
* to create a stack directly from the processed template, without first reviewing the resulting changes in a change
|
|
1726
|
+
* set, you must acknowledge 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>
|
|
1727
|
+
* transforms, which are macros hosted by CloudFormation.</p>
|
|
1728
|
+
* <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested
|
|
1729
|
+
* stacks, you must create the stack directly from the template using this capability.</p>
|
|
1760
1730
|
* <important>
|
|
1761
|
-
* <p>You should only create stacks directly from a stack template that contains macros if
|
|
1762
|
-
*
|
|
1763
|
-
* <p>Each macro relies on an underlying Lambda service function for
|
|
1764
|
-
*
|
|
1765
|
-
*
|
|
1731
|
+
* <p>You should only create stacks directly from a stack template that contains macros if you know what processing
|
|
1732
|
+
* the macro performs.</p>
|
|
1733
|
+
* <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be
|
|
1734
|
+
* aware that the Lambda function owner can update the function operation without CloudFormation being
|
|
1735
|
+
* notified.</p>
|
|
1766
1736
|
* </important>
|
|
1767
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
|
|
1768
|
-
*
|
|
1769
|
-
* templates</a>.</p>
|
|
1737
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation macros
|
|
1738
|
+
* to perform custom processing on templates</a>.</p>
|
|
1770
1739
|
* </li>
|
|
1771
1740
|
* </ul>
|
|
1772
1741
|
*/
|
|
1773
1742
|
Capabilities?: (Capability | string)[];
|
|
1774
1743
|
/**
|
|
1775
|
-
* <p>The template resource types that you have permissions to work with for this create stack
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1780
|
-
*
|
|
1781
|
-
*
|
|
1782
|
-
* <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular
|
|
1783
|
-
* Amazon Web Services service), and
|
|
1784
|
-
* <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i>
|
|
1744
|
+
* <p>The template resource types that you have permissions to work with for this create stack action, such as
|
|
1745
|
+
* <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the
|
|
1746
|
+
* following syntax to describe template resource types: <code>AWS::*</code> (for all Amazon Web Services resources),
|
|
1747
|
+
* <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i>
|
|
1748
|
+
* </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources
|
|
1749
|
+
* of a particular Amazon Web Services service), and
|
|
1750
|
+
* <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i>
|
|
1785
1751
|
* </code> (for a specific Amazon Web Services resource).</p>
|
|
1786
|
-
* <p>If the list of resource types doesn't include a resource that you're creating, the stack
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1752
|
+
* <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
|
|
1753
|
+
* default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
|
|
1754
|
+
* uses this parameter for CloudFormation-specific condition keys in IAM policies. For more
|
|
1755
|
+
* 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>
|
|
1789
1756
|
*/
|
|
1790
1757
|
ResourceTypes?: string[];
|
|
1791
1758
|
/**
|
|
1792
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
|
|
1793
|
-
*
|
|
1794
|
-
*
|
|
1795
|
-
*
|
|
1796
|
-
*
|
|
1797
|
-
*
|
|
1798
|
-
*
|
|
1799
|
-
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
1800
|
-
* session that's generated from your user credentials.</p>
|
|
1759
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf.
|
|
1760
|
+
* CloudFormation always uses this role for all future operations on the stack. Provided that users have
|
|
1761
|
+
* permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to
|
|
1762
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
|
1763
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the
|
|
1764
|
+
* stack. If no role is available, CloudFormation uses a temporary session that's generated from your user
|
|
1765
|
+
* credentials.</p>
|
|
1801
1766
|
*/
|
|
1802
1767
|
RoleARN?: string;
|
|
1803
1768
|
/**
|
|
1804
|
-
* <p>Determines what action will be taken if stack creation fails. This must be one of:
|
|
1805
|
-
*
|
|
1806
|
-
*
|
|
1769
|
+
* <p>Determines what action will be taken if stack creation fails. This must be one of: <code>DO_NOTHING</code>,
|
|
1770
|
+
* <code>ROLLBACK</code>, or <code>DELETE</code>. You can specify either <code>OnFailure</code> or
|
|
1771
|
+
* <code>DisableRollback</code>, but not both.</p>
|
|
1807
1772
|
* <p>Default: <code>ROLLBACK</code>
|
|
1808
1773
|
* </p>
|
|
1809
1774
|
*/
|
|
1810
1775
|
OnFailure?: OnFailure | string;
|
|
1811
1776
|
/**
|
|
1812
|
-
* <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">
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
1815
|
-
* parameter, but not both.</p>
|
|
1777
|
+
* <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 to Stack Resources</a> in
|
|
1778
|
+
* the <i>CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the
|
|
1779
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
1816
1780
|
*/
|
|
1817
1781
|
StackPolicyBody?: string;
|
|
1818
1782
|
/**
|
|
1819
|
-
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1822
|
-
* both.</p>
|
|
1783
|
+
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
|
|
1784
|
+
* an S3 bucket in the same Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
1785
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
1823
1786
|
*/
|
|
1824
1787
|
StackPolicyURL?: string;
|
|
1825
1788
|
/**
|
|
1826
|
-
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these
|
|
1827
|
-
*
|
|
1828
|
-
* specified.</p>
|
|
1789
|
+
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources
|
|
1790
|
+
* created in the stack. A maximum number of 50 tags can be specified.</p>
|
|
1829
1791
|
*/
|
|
1830
1792
|
Tags?: Tag[];
|
|
1831
1793
|
/**
|
|
1832
|
-
* <p>A unique identifier for this <code>CreateStack</code> request. Specify this token if you
|
|
1833
|
-
*
|
|
1834
|
-
*
|
|
1835
|
-
*
|
|
1836
|
-
*
|
|
1837
|
-
*
|
|
1838
|
-
*
|
|
1839
|
-
*
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
*
|
|
1843
|
-
*
|
|
1844
|
-
* operation . For example, if you create a stack using the console, each stack event would be
|
|
1845
|
-
* assigned the same token in the following format:
|
|
1846
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
1794
|
+
* <p>A unique identifier for this <code>CreateStack</code> request. Specify this token if you plan to retry requests
|
|
1795
|
+
* so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
|
|
1796
|
+
* <code>CreateStack</code> requests to ensure that CloudFormation successfully received them.</p>
|
|
1797
|
+
* <p>All events initiated by a given stack operation are assigned the same client request token, which you can use to
|
|
1798
|
+
* track operations. For example, if you execute a <code>CreateStack</code> operation with the token
|
|
1799
|
+
* <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have
|
|
1800
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
1801
|
+
* <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are
|
|
1802
|
+
* initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you
|
|
1803
|
+
* easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
|
|
1804
|
+
* assigned the same token in the following format:
|
|
1805
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
1847
1806
|
*/
|
|
1848
1807
|
ClientRequestToken?: string;
|
|
1849
1808
|
/**
|
|
1850
|
-
* <p>Whether to enable termination protection on the specified stack. If a user attempts to
|
|
1851
|
-
*
|
|
1852
|
-
*
|
|
1853
|
-
*
|
|
1854
|
-
*
|
|
1855
|
-
* termination protection is set on the root stack and can't be changed directly on the nested
|
|
1856
|
-
* stack.</p>
|
|
1809
|
+
* <p>Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
|
|
1810
|
+
* termination protection enabled, the operation fails and the stack 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 Deleted</a> in the
|
|
1811
|
+
* <i>CloudFormation User Guide</i>. Termination protection is deactivated on stacks by default.</p>
|
|
1812
|
+
* <p>For <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>, termination protection is set
|
|
1813
|
+
* on the root stack and can't be changed directly on the nested stack.</p>
|
|
1857
1814
|
*/
|
|
1858
1815
|
EnableTerminationProtection?: boolean;
|
|
1859
1816
|
}
|
|
@@ -1941,7 +1898,7 @@ export interface StackSetOperationPreferences {
|
|
|
1941
1898
|
*/
|
|
1942
1899
|
RegionConcurrencyType?: RegionConcurrencyType | string;
|
|
1943
1900
|
/**
|
|
1944
|
-
* <p>The order of the Regions
|
|
1901
|
+
* <p>The order of the Regions where you want to perform the stack operation.</p>
|
|
1945
1902
|
*/
|
|
1946
1903
|
RegionOrder?: string[];
|
|
1947
1904
|
/**
|
|
@@ -2433,22 +2390,19 @@ export interface DeactivateOrganizationsAccessOutput {
|
|
|
2433
2390
|
*/
|
|
2434
2391
|
export interface DeactivateTypeInput {
|
|
2435
2392
|
/**
|
|
2436
|
-
* <p>The type name of the extension, in this account and Region. If you specified a type name
|
|
2437
|
-
*
|
|
2438
|
-
* <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and
|
|
2439
|
-
* <code>Type</code>.</p>
|
|
2393
|
+
* <p>The type name of the extension, in this account and Region. If you specified a type name alias when enabling the
|
|
2394
|
+
* extension, use the type name alias.</p>
|
|
2395
|
+
* <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
2440
2396
|
*/
|
|
2441
2397
|
TypeName?: string;
|
|
2442
2398
|
/**
|
|
2443
2399
|
* <p>The extension type.</p>
|
|
2444
|
-
* <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and
|
|
2445
|
-
* <code>Type</code>.</p>
|
|
2400
|
+
* <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
2446
2401
|
*/
|
|
2447
2402
|
Type?: ThirdPartyType | string;
|
|
2448
2403
|
/**
|
|
2449
2404
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and Region.</p>
|
|
2450
|
-
* <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and
|
|
2451
|
-
* <code>Type</code>.</p>
|
|
2405
|
+
* <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
2452
2406
|
*/
|
|
2453
2407
|
Arn?: string;
|
|
2454
2408
|
}
|
|
@@ -2467,8 +2421,8 @@ export interface DeleteChangeSetInput {
|
|
|
2467
2421
|
*/
|
|
2468
2422
|
ChangeSetName: string | undefined;
|
|
2469
2423
|
/**
|
|
2470
|
-
* <p>If you specified the name of a change set to delete, specify the stack name or Amazon
|
|
2471
|
-
*
|
|
2424
|
+
* <p>If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's
|
|
2425
|
+
* associated with it.</p>
|
|
2472
2426
|
*/
|
|
2473
2427
|
StackName?: string;
|
|
2474
2428
|
}
|
|
@@ -2502,38 +2456,34 @@ export interface DeleteStackInput {
|
|
|
2502
2456
|
*/
|
|
2503
2457
|
StackName: string | undefined;
|
|
2504
2458
|
/**
|
|
2505
|
-
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that
|
|
2506
|
-
*
|
|
2507
|
-
*
|
|
2508
|
-
* <p>Retaining resources is useful when you can't delete a resource, such as a non-empty S3
|
|
2509
|
-
*
|
|
2459
|
+
* <p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that are associated with the
|
|
2460
|
+
* resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the
|
|
2461
|
+
* retained resources.</p>
|
|
2462
|
+
* <p>Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to
|
|
2463
|
+
* delete the stack.</p>
|
|
2510
2464
|
*/
|
|
2511
2465
|
RetainResources?: string[];
|
|
2512
2466
|
/**
|
|
2513
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
|
|
2514
|
-
*
|
|
2515
|
-
*
|
|
2516
|
-
*
|
|
2517
|
-
*
|
|
2518
|
-
* session that's generated from your user credentials.</p>
|
|
2467
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your
|
|
2468
|
+
* behalf.</p>
|
|
2469
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the
|
|
2470
|
+
* stack. If no role is available, CloudFormation uses a temporary session that's generated from your user
|
|
2471
|
+
* credentials.</p>
|
|
2519
2472
|
*/
|
|
2520
2473
|
RoleARN?: string;
|
|
2521
2474
|
/**
|
|
2522
|
-
* <p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if you
|
|
2523
|
-
*
|
|
2524
|
-
*
|
|
2525
|
-
*
|
|
2526
|
-
*
|
|
2527
|
-
*
|
|
2528
|
-
*
|
|
2529
|
-
*
|
|
2530
|
-
*
|
|
2531
|
-
*
|
|
2532
|
-
*
|
|
2533
|
-
*
|
|
2534
|
-
* operation . For example, if you create a stack using the console, each stack event would be
|
|
2535
|
-
* assigned the same token in the following format:
|
|
2536
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
2475
|
+
* <p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if you plan to retry requests
|
|
2476
|
+
* so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry
|
|
2477
|
+
* <code>DeleteStack</code> requests to ensure that CloudFormation successfully received them.</p>
|
|
2478
|
+
* <p>All events initiated by a given stack operation are assigned the same client request token, which you can use to
|
|
2479
|
+
* track operations. For example, if you execute a <code>CreateStack</code> operation with the token
|
|
2480
|
+
* <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have
|
|
2481
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
2482
|
+
* <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are
|
|
2483
|
+
* initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you
|
|
2484
|
+
* easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
|
|
2485
|
+
* assigned the same token in the following format:
|
|
2486
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
2537
2487
|
*/
|
|
2538
2488
|
ClientRequestToken?: string;
|
|
2539
2489
|
}
|
|
@@ -2672,25 +2622,22 @@ export type RegistryType = (typeof RegistryType)[keyof typeof RegistryType];
|
|
|
2672
2622
|
export interface DeregisterTypeInput {
|
|
2673
2623
|
/**
|
|
2674
2624
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
2675
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
2676
|
-
* <code>Arn</code>.</p>
|
|
2625
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
2677
2626
|
*/
|
|
2678
2627
|
Arn?: string;
|
|
2679
2628
|
/**
|
|
2680
2629
|
* <p>The kind of extension.</p>
|
|
2681
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
2682
|
-
* <code>Arn</code>.</p>
|
|
2630
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
2683
2631
|
*/
|
|
2684
2632
|
Type?: RegistryType | string;
|
|
2685
2633
|
/**
|
|
2686
2634
|
* <p>The name of the extension.</p>
|
|
2687
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
2688
|
-
* <code>Arn</code>.</p>
|
|
2635
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
2689
2636
|
*/
|
|
2690
2637
|
TypeName?: string;
|
|
2691
2638
|
/**
|
|
2692
|
-
* <p>The ID of a specific version of the extension. The version ID is the value at the end of
|
|
2693
|
-
*
|
|
2639
|
+
* <p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource
|
|
2640
|
+
* Name (ARN) assigned to the extension version when it is registered.</p>
|
|
2694
2641
|
*/
|
|
2695
2642
|
VersionId?: string;
|
|
2696
2643
|
}
|
|
@@ -2715,13 +2662,12 @@ export interface DescribeAccountLimitsInput {
|
|
|
2715
2662
|
*/
|
|
2716
2663
|
export interface DescribeAccountLimitsOutput {
|
|
2717
2664
|
/**
|
|
2718
|
-
* <p>An account limit structure that contain a list of CloudFormation account limits and
|
|
2719
|
-
* their values.</p>
|
|
2665
|
+
* <p>An account limit structure that contain a list of CloudFormation account limits and their values.</p>
|
|
2720
2666
|
*/
|
|
2721
2667
|
AccountLimits?: AccountLimit[];
|
|
2722
2668
|
/**
|
|
2723
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of limits. If
|
|
2724
|
-
*
|
|
2669
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page
|
|
2670
|
+
* exists, this value is null.</p>
|
|
2725
2671
|
*/
|
|
2726
2672
|
NextToken?: string;
|
|
2727
2673
|
}
|
|
@@ -2735,13 +2681,13 @@ export interface DescribeChangeSetInput {
|
|
|
2735
2681
|
*/
|
|
2736
2682
|
ChangeSetName: string | undefined;
|
|
2737
2683
|
/**
|
|
2738
|
-
* <p>If you specified the name of a change set, specify the stack name or ID (ARN) of the
|
|
2739
|
-
*
|
|
2684
|
+
* <p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to
|
|
2685
|
+
* describe.</p>
|
|
2740
2686
|
*/
|
|
2741
2687
|
StackName?: string;
|
|
2742
2688
|
/**
|
|
2743
|
-
* <p>A string (provided by the <a>DescribeChangeSet</a> response output) that
|
|
2744
|
-
*
|
|
2689
|
+
* <p>A string (provided by the <a>DescribeChangeSet</a> response output) that identifies the next page of
|
|
2690
|
+
* information that you want to retrieve.</p>
|
|
2745
2691
|
*/
|
|
2746
2692
|
NextToken?: string;
|
|
2747
2693
|
}
|
|
@@ -2771,8 +2717,8 @@ export interface DescribeChangeSetOutput {
|
|
|
2771
2717
|
*/
|
|
2772
2718
|
Description?: string;
|
|
2773
2719
|
/**
|
|
2774
|
-
* <p>A list of <code>Parameter</code> structures that describes the input parameters and their
|
|
2775
|
-
*
|
|
2720
|
+
* <p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create
|
|
2721
|
+
* the change set. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</p>
|
|
2776
2722
|
*/
|
|
2777
2723
|
Parameters?: Parameter[];
|
|
2778
2724
|
/**
|
|
@@ -2780,35 +2726,34 @@ export interface DescribeChangeSetOutput {
|
|
|
2780
2726
|
*/
|
|
2781
2727
|
CreationTime?: Date;
|
|
2782
2728
|
/**
|
|
2783
|
-
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change
|
|
2784
|
-
*
|
|
2785
|
-
*
|
|
2786
|
-
*
|
|
2729
|
+
* <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't
|
|
2730
|
+
* execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code>
|
|
2731
|
+
* state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was
|
|
2732
|
+
* already updated.</p>
|
|
2787
2733
|
*/
|
|
2788
2734
|
ExecutionStatus?: ExecutionStatus | string;
|
|
2789
2735
|
/**
|
|
2790
|
-
* <p>The current status of the change set, such as <code>CREATE_IN_PROGRESS</code>,
|
|
2791
|
-
*
|
|
2736
|
+
* <p>The current status of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or
|
|
2737
|
+
* <code>FAILED</code>.</p>
|
|
2792
2738
|
*/
|
|
2793
2739
|
Status?: ChangeSetStatus | string;
|
|
2794
2740
|
/**
|
|
2795
|
-
* <p>A description of the change set's status. For example, if your attempt to create a change
|
|
2796
|
-
* set failed, CloudFormation shows the error message.</p>
|
|
2741
|
+
* <p>A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.</p>
|
|
2797
2742
|
*/
|
|
2798
2743
|
StatusReason?: string;
|
|
2799
2744
|
/**
|
|
2800
|
-
* <p>The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated
|
|
2801
|
-
*
|
|
2745
|
+
* <p>The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you
|
|
2746
|
+
* execute the change set.</p>
|
|
2802
2747
|
*/
|
|
2803
2748
|
NotificationARNs?: string[];
|
|
2804
2749
|
/**
|
|
2805
|
-
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating
|
|
2806
|
-
*
|
|
2750
|
+
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
|
|
2751
|
+
* the specified monitoring period afterwards.</p>
|
|
2807
2752
|
*/
|
|
2808
2753
|
RollbackConfiguration?: RollbackConfiguration;
|
|
2809
2754
|
/**
|
|
2810
|
-
* <p>If you execute the change set, the list of capabilities that were explicitly acknowledged
|
|
2811
|
-
*
|
|
2755
|
+
* <p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set
|
|
2756
|
+
* was created.</p>
|
|
2812
2757
|
*/
|
|
2813
2758
|
Capabilities?: (Capability | string)[];
|
|
2814
2759
|
/**
|
|
@@ -2816,13 +2761,13 @@ export interface DescribeChangeSetOutput {
|
|
|
2816
2761
|
*/
|
|
2817
2762
|
Tags?: Tag[];
|
|
2818
2763
|
/**
|
|
2819
|
-
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation
|
|
2820
|
-
*
|
|
2764
|
+
* <p>A list of <code>Change</code> structures that describes the resources CloudFormation changes if you execute
|
|
2765
|
+
* the change set.</p>
|
|
2821
2766
|
*/
|
|
2822
2767
|
Changes?: Change[];
|
|
2823
2768
|
/**
|
|
2824
|
-
* <p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there is
|
|
2825
|
-
*
|
|
2769
|
+
* <p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,
|
|
2770
|
+
* this value is null.</p>
|
|
2826
2771
|
*/
|
|
2827
2772
|
NextToken?: string;
|
|
2828
2773
|
/**
|
|
@@ -2830,13 +2775,11 @@ export interface DescribeChangeSetOutput {
|
|
|
2830
2775
|
*/
|
|
2831
2776
|
IncludeNestedStacks?: boolean;
|
|
2832
2777
|
/**
|
|
2833
|
-
* <p>Specifies the change set ID of the parent change set in the current nested change set
|
|
2834
|
-
* hierarchy.</p>
|
|
2778
|
+
* <p>Specifies the change set ID of the parent change set in the current nested change set hierarchy.</p>
|
|
2835
2779
|
*/
|
|
2836
2780
|
ParentChangeSetId?: string;
|
|
2837
2781
|
/**
|
|
2838
|
-
* <p>Specifies the change set ID of the root change set in the current nested change set
|
|
2839
|
-
* hierarchy.</p>
|
|
2782
|
+
* <p>Specifies the change set ID of the root change set in the current nested change set hierarchy.</p>
|
|
2840
2783
|
*/
|
|
2841
2784
|
RootChangeSetId?: string;
|
|
2842
2785
|
}
|
|
@@ -2849,18 +2792,17 @@ export interface DescribeChangeSetHooksInput {
|
|
|
2849
2792
|
*/
|
|
2850
2793
|
ChangeSetName: string | undefined;
|
|
2851
2794
|
/**
|
|
2852
|
-
* <p>If you specified the name of a change set, specify the stack name or stack ID (ARN) of the
|
|
2853
|
-
*
|
|
2795
|
+
* <p>If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want
|
|
2796
|
+
* to describe.</p>
|
|
2854
2797
|
*/
|
|
2855
2798
|
StackName?: string;
|
|
2856
2799
|
/**
|
|
2857
|
-
* <p>A string, provided by the <code>DescribeChangeSetHooks</code> response output, that
|
|
2858
|
-
*
|
|
2800
|
+
* <p>A string, provided by the <code>DescribeChangeSetHooks</code> response output, that identifies the next page of
|
|
2801
|
+
* information that you want to retrieve.</p>
|
|
2859
2802
|
*/
|
|
2860
2803
|
NextToken?: string;
|
|
2861
2804
|
/**
|
|
2862
|
-
* <p>If specified, lists only the hooks related to the specified
|
|
2863
|
-
* <code>LogicalResourceId</code>.</p>
|
|
2805
|
+
* <p>If specified, lists only the hooks related to the specified <code>LogicalResourceId</code>.</p>
|
|
2864
2806
|
*/
|
|
2865
2807
|
LogicalResourceId?: string;
|
|
2866
2808
|
}
|
|
@@ -2913,11 +2855,11 @@ export interface DescribeOrganizationsAccessInput {
|
|
|
2913
2855
|
* </li>
|
|
2914
2856
|
* <li>
|
|
2915
2857
|
* <p>If you are signed in to a delegated administrator account, specify
|
|
2916
|
-
*
|
|
2858
|
+
* <code>DELEGATED_ADMIN</code>.</p>
|
|
2917
2859
|
* <p>Your Amazon Web Services account must be registered as a delegated administrator in the
|
|
2918
|
-
*
|
|
2860
|
+
* management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a
|
|
2919
2861
|
* delegated administrator</a> in the <i>CloudFormation User
|
|
2920
|
-
*
|
|
2862
|
+
* Guide</i>.</p>
|
|
2921
2863
|
* </li>
|
|
2922
2864
|
* </ul>
|
|
2923
2865
|
*/
|
|
@@ -2951,9 +2893,8 @@ export interface DescribeOrganizationsAccessOutput {
|
|
|
2951
2893
|
export interface DescribePublisherInput {
|
|
2952
2894
|
/**
|
|
2953
2895
|
* <p>The ID of the extension publisher.</p>
|
|
2954
|
-
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension
|
|
2955
|
-
*
|
|
2956
|
-
* account.</p>
|
|
2896
|
+
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension publisher,
|
|
2897
|
+
* <code>DescribePublisher</code> returns information about your own publisher account.</p>
|
|
2957
2898
|
*/
|
|
2958
2899
|
PublisherId?: string;
|
|
2959
2900
|
}
|
|
@@ -2991,13 +2932,11 @@ export interface DescribePublisherOutput {
|
|
|
2991
2932
|
*/
|
|
2992
2933
|
PublisherId?: string;
|
|
2993
2934
|
/**
|
|
2994
|
-
* <p>Whether the publisher is verified. Currently, all registered publishers are
|
|
2995
|
-
* verified.</p>
|
|
2935
|
+
* <p>Whether the publisher is verified. Currently, all registered publishers are verified.</p>
|
|
2996
2936
|
*/
|
|
2997
2937
|
PublisherStatus?: PublisherStatus | string;
|
|
2998
2938
|
/**
|
|
2999
|
-
* <p>The type of account used as the identity provider when registering this publisher with
|
|
3000
|
-
* CloudFormation.</p>
|
|
2939
|
+
* <p>The type of account used as the identity provider when registering this publisher with CloudFormation.</p>
|
|
3001
2940
|
*/
|
|
3002
2941
|
IdentityProvider?: IdentityProvider | string;
|
|
3003
2942
|
/**
|
|
@@ -3011,9 +2950,8 @@ export interface DescribePublisherOutput {
|
|
|
3011
2950
|
export interface DescribeStackDriftDetectionStatusInput {
|
|
3012
2951
|
/**
|
|
3013
2952
|
* <p>The ID of the drift detection results of this operation.</p>
|
|
3014
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
3015
|
-
*
|
|
3016
|
-
* may vary.</p>
|
|
2953
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number
|
|
2954
|
+
* of drift results CloudFormation retains for any given stack, and for how long, may vary.</p>
|
|
3017
2955
|
*/
|
|
3018
2956
|
StackDriftDetectionId: string | undefined;
|
|
3019
2957
|
}
|
|
@@ -3054,9 +2992,8 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3054
2992
|
StackId: string | undefined;
|
|
3055
2993
|
/**
|
|
3056
2994
|
* <p>The ID of the drift detection results of this operation.</p>
|
|
3057
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
3058
|
-
*
|
|
3059
|
-
* vary.</p>
|
|
2995
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number
|
|
2996
|
+
* of reports CloudFormation retains for any given stack, and for how long, may vary.</p>
|
|
3060
2997
|
*/
|
|
3061
2998
|
StackDriftDetectionId: string | undefined;
|
|
3062
2999
|
/**
|
|
@@ -3064,18 +3001,17 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3064
3001
|
* <ul>
|
|
3065
3002
|
* <li>
|
|
3066
3003
|
* <p>
|
|
3067
|
-
* <code>DRIFTED</code>: The stack differs from its expected template configuration. A
|
|
3068
|
-
*
|
|
3004
|
+
* <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to
|
|
3005
|
+
* have drifted if one or more of its resources have drifted.</p>
|
|
3069
3006
|
* </li>
|
|
3070
3007
|
* <li>
|
|
3071
3008
|
* <p>
|
|
3072
|
-
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its expected
|
|
3073
|
-
*
|
|
3009
|
+
* <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack differs from its expected template
|
|
3010
|
+
* configuration.</p>
|
|
3074
3011
|
* </li>
|
|
3075
3012
|
* <li>
|
|
3076
3013
|
* <p>
|
|
3077
|
-
* <code>IN_SYNC</code>: The stack's actual configuration matches its expected template
|
|
3078
|
-
* configuration.</p>
|
|
3014
|
+
* <code>IN_SYNC</code>: The stack's actual configuration matches its expected template configuration.</p>
|
|
3079
3015
|
* </li>
|
|
3080
3016
|
* <li>
|
|
3081
3017
|
* <p>
|
|
@@ -3089,23 +3025,20 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3089
3025
|
* <ul>
|
|
3090
3026
|
* <li>
|
|
3091
3027
|
* <p>
|
|
3092
|
-
* <code>DETECTION_COMPLETE</code>: The stack drift detection operation has successfully
|
|
3093
|
-
*
|
|
3094
|
-
*
|
|
3095
|
-
* <p>If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift
|
|
3096
|
-
*
|
|
3097
|
-
* drift.</p>
|
|
3028
|
+
* <code>DETECTION_COMPLETE</code>: The stack drift detection operation has successfully completed for all
|
|
3029
|
+
* resources in the stack that support drift detection. (Resources that don't currently support stack detection remain
|
|
3030
|
+
* unchecked.)</p>
|
|
3031
|
+
* <p>If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,
|
|
3032
|
+
* only the resources with those logical IDs are checked for drift.</p>
|
|
3098
3033
|
* </li>
|
|
3099
3034
|
* <li>
|
|
3100
3035
|
* <p>
|
|
3101
|
-
* <code>DETECTION_FAILED</code>: The stack drift detection operation has failed for at
|
|
3102
|
-
*
|
|
3103
|
-
* successfully completed drift detection.</p>
|
|
3036
|
+
* <code>DETECTION_FAILED</code>: The stack drift detection operation has failed for at least one resource in the
|
|
3037
|
+
* stack. Results will be available for resources on which CloudFormation successfully completed drift detection.</p>
|
|
3104
3038
|
* </li>
|
|
3105
3039
|
* <li>
|
|
3106
3040
|
* <p>
|
|
3107
|
-
* <code>DETECTION_IN_PROGRESS</code>: The stack drift detection operation is currently
|
|
3108
|
-
* in progress.</p>
|
|
3041
|
+
* <code>DETECTION_IN_PROGRESS</code>: The stack drift detection operation is currently in progress.</p>
|
|
3109
3042
|
* </li>
|
|
3110
3043
|
* </ul>
|
|
3111
3044
|
*/
|
|
@@ -3115,9 +3048,9 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3115
3048
|
*/
|
|
3116
3049
|
DetectionStatusReason?: string;
|
|
3117
3050
|
/**
|
|
3118
|
-
* <p>Total number of stack resources that have drifted. This is NULL until the drift detection
|
|
3119
|
-
*
|
|
3120
|
-
*
|
|
3051
|
+
* <p>Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a
|
|
3052
|
+
* status of <code>DETECTION_COMPLETE</code>. This value will be 0 for stacks whose drift status is
|
|
3053
|
+
* <code>IN_SYNC</code>.</p>
|
|
3121
3054
|
*/
|
|
3122
3055
|
DriftedStackResourceCount?: number;
|
|
3123
3056
|
/**
|
|
@@ -3131,8 +3064,7 @@ export interface DescribeStackDriftDetectionStatusOutput {
|
|
|
3131
3064
|
*/
|
|
3132
3065
|
export interface DescribeStackEventsInput {
|
|
3133
3066
|
/**
|
|
3134
|
-
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
3135
|
-
* interchangeable:</p>
|
|
3067
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
|
|
3136
3068
|
* <ul>
|
|
3137
3069
|
* <li>
|
|
3138
3070
|
* <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p>
|
|
@@ -3295,8 +3227,8 @@ export interface DescribeStackEventsOutput {
|
|
|
3295
3227
|
*/
|
|
3296
3228
|
StackEvents?: StackEvent[];
|
|
3297
3229
|
/**
|
|
3298
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of events. If
|
|
3299
|
-
*
|
|
3230
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page
|
|
3231
|
+
* exists, this value is null.</p>
|
|
3300
3232
|
*/
|
|
3301
3233
|
NextToken?: string;
|
|
3302
3234
|
}
|
|
@@ -3344,6 +3276,7 @@ export declare const StackInstanceDetailedStatus: {
|
|
|
3344
3276
|
readonly INOPERABLE: "INOPERABLE";
|
|
3345
3277
|
readonly PENDING: "PENDING";
|
|
3346
3278
|
readonly RUNNING: "RUNNING";
|
|
3279
|
+
readonly SKIPPED_SUSPENDED_ACCOUNT: "SKIPPED_SUSPENDED_ACCOUNT";
|
|
3347
3280
|
readonly SUCCEEDED: "SUCCEEDED";
|
|
3348
3281
|
};
|
|
3349
3282
|
/**
|
|
@@ -3386,6 +3319,11 @@ export interface StackInstanceComprehensiveStatus {
|
|
|
3386
3319
|
* </li>
|
|
3387
3320
|
* <li>
|
|
3388
3321
|
* <p>
|
|
3322
|
+
* <code>SKIPPED_SUSPENDED_ACCOUNT</code>: The operation in the specified account and Region has been skipped
|
|
3323
|
+
* because the account was suspended at the time of the operation.</p>
|
|
3324
|
+
* </li>
|
|
3325
|
+
* <li>
|
|
3326
|
+
* <p>
|
|
3389
3327
|
* <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p>
|
|
3390
3328
|
* </li>
|
|
3391
3329
|
* </ul>
|
|
@@ -3545,8 +3483,7 @@ export declare class StackInstanceNotFoundException extends __BaseException {
|
|
|
3545
3483
|
*/
|
|
3546
3484
|
export interface DescribeStackResourceInput {
|
|
3547
3485
|
/**
|
|
3548
|
-
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
3549
|
-
* interchangeable:</p>
|
|
3486
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
|
|
3550
3487
|
* <ul>
|
|
3551
3488
|
* <li>
|
|
3552
3489
|
* <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p>
|
|
@@ -3681,8 +3618,8 @@ export interface StackResourceDetail {
|
|
|
3681
3618
|
*/
|
|
3682
3619
|
export interface DescribeStackResourceOutput {
|
|
3683
3620
|
/**
|
|
3684
|
-
* <p>A <code>StackResourceDetail</code> structure containing the description of the specified
|
|
3685
|
-
*
|
|
3621
|
+
* <p>A <code>StackResourceDetail</code> structure containing the description of the specified resource in the
|
|
3622
|
+
* specified stack.</p>
|
|
3686
3623
|
*/
|
|
3687
3624
|
StackResourceDetail?: StackResourceDetail;
|
|
3688
3625
|
}
|
|
@@ -3695,23 +3632,20 @@ export interface DescribeStackResourceDriftsInput {
|
|
|
3695
3632
|
*/
|
|
3696
3633
|
StackName: string | undefined;
|
|
3697
3634
|
/**
|
|
3698
|
-
* <p>The resource drift status values to use as filters for the resource drift results
|
|
3699
|
-
* returned.</p>
|
|
3635
|
+
* <p>The resource drift status values to use as filters for the resource drift results returned.</p>
|
|
3700
3636
|
* <ul>
|
|
3701
3637
|
* <li>
|
|
3702
3638
|
* <p>
|
|
3703
|
-
* <code>DELETED</code>: The resource differs from its expected template configuration in
|
|
3704
|
-
*
|
|
3639
|
+
* <code>DELETED</code>: The resource differs from its expected template configuration in that the resource has
|
|
3640
|
+
* been deleted.</p>
|
|
3705
3641
|
* </li>
|
|
3706
3642
|
* <li>
|
|
3707
3643
|
* <p>
|
|
3708
|
-
* <code>MODIFIED</code>: One or more resource properties differ from their expected
|
|
3709
|
-
* template values.</p>
|
|
3644
|
+
* <code>MODIFIED</code>: One or more resource properties differ from their expected template values.</p>
|
|
3710
3645
|
* </li>
|
|
3711
3646
|
* <li>
|
|
3712
3647
|
* <p>
|
|
3713
|
-
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected
|
|
3714
|
-
* template configuration.</p>
|
|
3648
|
+
* <code>IN_SYNC</code>: The resource's actual configuration matches its expected template configuration.</p>
|
|
3715
3649
|
* </li>
|
|
3716
3650
|
* <li>
|
|
3717
3651
|
* <p>
|
|
@@ -3725,10 +3659,9 @@ export interface DescribeStackResourceDriftsInput {
|
|
|
3725
3659
|
*/
|
|
3726
3660
|
NextToken?: string;
|
|
3727
3661
|
/**
|
|
3728
|
-
* <p>The maximum number of results to be returned with a single call. If the number of
|
|
3729
|
-
*
|
|
3730
|
-
*
|
|
3731
|
-
* results.</p>
|
|
3662
|
+
* <p>The maximum number of results to be returned with a single call. If the number of available results exceeds this
|
|
3663
|
+
* maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code>
|
|
3664
|
+
* request parameter to get the next set of results.</p>
|
|
3732
3665
|
*/
|
|
3733
3666
|
MaxResults?: number;
|
|
3734
3667
|
}
|
|
@@ -3895,21 +3828,19 @@ export interface StackResourceDrift {
|
|
|
3895
3828
|
*/
|
|
3896
3829
|
export interface DescribeStackResourceDriftsOutput {
|
|
3897
3830
|
/**
|
|
3898
|
-
* <p>Drift information for the resources that have been checked for drift in the specified
|
|
3899
|
-
*
|
|
3900
|
-
*
|
|
3901
|
-
*
|
|
3902
|
-
*
|
|
3903
|
-
*
|
|
3904
|
-
* 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
|
|
3905
|
-
* that Support Drift Detection</a>.</p>
|
|
3831
|
+
* <p>Drift information for the resources that have been checked for drift in the specified stack. This includes
|
|
3832
|
+
* actual and expected configuration values for resources where CloudFormation detects drift.</p>
|
|
3833
|
+
* <p>For a given stack, there will be one <code>StackResourceDrift</code> for each stack resource that has been
|
|
3834
|
+
* checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently
|
|
3835
|
+
* support drift detection aren't checked, and so not included. For a list of resources that support drift detection,
|
|
3836
|
+
* 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>
|
|
3906
3837
|
*/
|
|
3907
3838
|
StackResourceDrifts: StackResourceDrift[] | undefined;
|
|
3908
3839
|
/**
|
|
3909
|
-
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to
|
|
3910
|
-
*
|
|
3911
|
-
*
|
|
3912
|
-
*
|
|
3840
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve
|
|
3841
|
+
* the next set of results, call <code>DescribeStackResourceDrifts</code> again and assign that token to the request
|
|
3842
|
+
* object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to
|
|
3843
|
+
* <code>null</code>.</p>
|
|
3913
3844
|
*/
|
|
3914
3845
|
NextToken?: string;
|
|
3915
3846
|
}
|
|
@@ -3919,8 +3850,7 @@ export interface DescribeStackResourceDriftsOutput {
|
|
|
3919
3850
|
*/
|
|
3920
3851
|
export interface DescribeStackResourcesInput {
|
|
3921
3852
|
/**
|
|
3922
|
-
* <p>The name or the unique stack ID that is associated with the stack, which aren't always
|
|
3923
|
-
* interchangeable:</p>
|
|
3853
|
+
* <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
|
|
3924
3854
|
* <ul>
|
|
3925
3855
|
* <li>
|
|
3926
3856
|
* <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p>
|
|
@@ -3931,7 +3861,7 @@ export interface DescribeStackResourcesInput {
|
|
|
3931
3861
|
* </ul>
|
|
3932
3862
|
* <p>Default: There is no default value.</p>
|
|
3933
3863
|
* <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify
|
|
3934
|
-
*
|
|
3864
|
+
* <code>PhysicalResourceId</code>.</p>
|
|
3935
3865
|
*/
|
|
3936
3866
|
StackName?: string;
|
|
3937
3867
|
/**
|
|
@@ -3940,14 +3870,12 @@ export interface DescribeStackResourcesInput {
|
|
|
3940
3870
|
*/
|
|
3941
3871
|
LogicalResourceId?: string;
|
|
3942
3872
|
/**
|
|
3943
|
-
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource
|
|
3944
|
-
*
|
|
3945
|
-
*
|
|
3946
|
-
*
|
|
3947
|
-
*
|
|
3948
|
-
*
|
|
3949
|
-
* <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must
|
|
3950
|
-
* specify <code>StackName</code>.</p>
|
|
3873
|
+
* <p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>
|
|
3874
|
+
* <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to
|
|
3875
|
+
* the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to
|
|
3876
|
+
* find which stack the instance belongs to and what other resources are part of the stack.</p>
|
|
3877
|
+
* <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify
|
|
3878
|
+
* <code>StackName</code>.</p>
|
|
3951
3879
|
* <p>Default: There is no default value.</p>
|
|
3952
3880
|
*/
|
|
3953
3881
|
PhysicalResourceId?: string;
|
|
@@ -4024,18 +3952,14 @@ export interface DescribeStackResourcesOutput {
|
|
|
4024
3952
|
export interface DescribeStacksInput {
|
|
4025
3953
|
/**
|
|
4026
3954
|
* <note>
|
|
4027
|
-
* <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response
|
|
4028
|
-
*
|
|
4029
|
-
*
|
|
4030
|
-
*
|
|
4031
|
-
*
|
|
4032
|
-
*
|
|
4033
|
-
* <p>\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny", "Action":
|
|
4034
|
-
* "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*\/*" \}]
|
|
4035
|
-
* \}</p>
|
|
3955
|
+
* <p>If you don't pass a parameter to <code>StackName</code>, the API returns a response that describes all
|
|
3956
|
+
* resources in the account. This requires <code>ListStacks</code> and <code>DescribeStacks</code> permissions.</p>
|
|
3957
|
+
* <p>The IAM policy below can be added to IAM policies when you want to limit
|
|
3958
|
+
* resource-level permissions and avoid returning a response when no parameter is sent in the request:</p>
|
|
3959
|
+
* <p>\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks",
|
|
3960
|
+
* "NotResource": "arn:aws:cloudformation:*:*:stack/*\/*" \}] \}</p>
|
|
4036
3961
|
* </note>
|
|
4037
|
-
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
4038
|
-
* interchangeable:</p>
|
|
3962
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
|
|
4039
3963
|
* <ul>
|
|
4040
3964
|
* <li>
|
|
4041
3965
|
* <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p>
|
|
@@ -4274,8 +4198,8 @@ export interface DescribeStacksOutput {
|
|
|
4274
4198
|
*/
|
|
4275
4199
|
Stacks?: Stack[];
|
|
4276
4200
|
/**
|
|
4277
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If
|
|
4278
|
-
*
|
|
4201
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page
|
|
4202
|
+
* exists, this value is null.</p>
|
|
4279
4203
|
*/
|
|
4280
4204
|
NextToken?: string;
|
|
4281
4205
|
}
|
|
@@ -4760,28 +4684,24 @@ export interface DescribeStackSetOperationOutput {
|
|
|
4760
4684
|
export interface DescribeTypeInput {
|
|
4761
4685
|
/**
|
|
4762
4686
|
* <p>The kind of extension.</p>
|
|
4763
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
4764
|
-
* <code>Arn</code>.</p>
|
|
4687
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
4765
4688
|
*/
|
|
4766
4689
|
Type?: RegistryType | string;
|
|
4767
4690
|
/**
|
|
4768
4691
|
* <p>The name of the extension.</p>
|
|
4769
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
4770
|
-
* <code>Arn</code>.</p>
|
|
4692
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
4771
4693
|
*/
|
|
4772
4694
|
TypeName?: string;
|
|
4773
4695
|
/**
|
|
4774
4696
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
4775
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
4776
|
-
* <code>Arn</code>.</p>
|
|
4697
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
4777
4698
|
*/
|
|
4778
4699
|
Arn?: string;
|
|
4779
4700
|
/**
|
|
4780
|
-
* <p>The ID of a specific version of the extension. The version ID is the value at the end of
|
|
4781
|
-
*
|
|
4782
|
-
* <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information
|
|
4783
|
-
*
|
|
4784
|
-
* extension version.</p>
|
|
4701
|
+
* <p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource
|
|
4702
|
+
* Name (ARN) assigned to the extension version when it is registered.</p>
|
|
4703
|
+
* <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific
|
|
4704
|
+
* extension version. Otherwise, it returns information about the default extension version.</p>
|
|
4785
4705
|
*/
|
|
4786
4706
|
VersionId?: string;
|
|
4787
4707
|
/**
|
|
@@ -4890,40 +4810,38 @@ export interface DescribeTypeOutput {
|
|
|
4890
4810
|
Type?: RegistryType | string;
|
|
4891
4811
|
/**
|
|
4892
4812
|
* <p>The name of the extension.</p>
|
|
4893
|
-
* <p>If the extension is a public third-party type you have activated with a type name alias,
|
|
4894
|
-
*
|
|
4813
|
+
* <p>If the extension is a public third-party type you have activated with a type name alias, CloudFormation
|
|
4814
|
+
* 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>
|
|
4895
4815
|
*/
|
|
4896
4816
|
TypeName?: string;
|
|
4897
4817
|
/**
|
|
4898
|
-
* <p>The ID of the default version of the extension. The default version is used when the
|
|
4899
|
-
*
|
|
4900
|
-
* <p>This applies only to private extensions you have registered in your account. For public
|
|
4901
|
-
*
|
|
4902
|
-
*
|
|
4903
|
-
*
|
|
4904
|
-
* </code>.</p>
|
|
4818
|
+
* <p>The ID of the default version of the extension. The default version is used when the extension version isn't
|
|
4819
|
+
* specified.</p>
|
|
4820
|
+
* <p>This applies only to private extensions you have registered in your account. For public extensions, both those
|
|
4821
|
+
* provided by Amazon Web Services and published by third parties, CloudFormation returns <code>null</code>. For
|
|
4822
|
+
* more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4823
|
+
* <p>To set the default version of an extension, use <a>SetTypeDefaultVersion</a>.</p>
|
|
4905
4824
|
*/
|
|
4906
4825
|
DefaultVersionId?: string;
|
|
4907
4826
|
/**
|
|
4908
4827
|
* <p>Whether the specified extension version is set as the default version.</p>
|
|
4909
|
-
* <p>This applies only to private extensions you have registered in your account, and
|
|
4910
|
-
*
|
|
4911
|
-
* are activated in your account, CloudFormation returns <code>null</code>.</p>
|
|
4828
|
+
* <p>This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation
|
|
4829
|
+
* returns <code>null</code>.</p>
|
|
4912
4830
|
*/
|
|
4913
4831
|
IsDefaultVersion?: boolean;
|
|
4914
4832
|
/**
|
|
4915
|
-
* <p>The contract test status of the registered extension version. To return the extension test
|
|
4916
|
-
*
|
|
4917
|
-
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4918
|
-
*
|
|
4919
|
-
* account.</p>
|
|
4833
|
+
* <p>The contract test status of the registered extension version. To return the extension test status of a specific
|
|
4834
|
+
* extension version, you must specify <code>VersionId</code>.</p>
|
|
4835
|
+
* <p>This applies only to registered private extension versions. CloudFormation doesn't return this
|
|
4836
|
+
* information for public extensions, whether they are activated in your account.</p>
|
|
4920
4837
|
* <ul>
|
|
4921
4838
|
* <li>
|
|
4922
4839
|
* <p>
|
|
4923
4840
|
* <code>PASSED</code>: The extension has passed all its contract tests.</p>
|
|
4924
|
-
* <p>An extension must have a test status of <code>PASSED</code> before it can be
|
|
4925
|
-
*
|
|
4926
|
-
*
|
|
4841
|
+
* <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information,
|
|
4842
|
+
* see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing
|
|
4843
|
+
* extensions to make them available for public use</a> in the <i>CloudFormation Command Line
|
|
4844
|
+
* Interface User Guide</i>.</p>
|
|
4927
4845
|
* </li>
|
|
4928
4846
|
* <li>
|
|
4929
4847
|
* <p>
|
|
@@ -4931,23 +4849,20 @@ export interface DescribeTypeOutput {
|
|
|
4931
4849
|
* </li>
|
|
4932
4850
|
* <li>
|
|
4933
4851
|
* <p>
|
|
4934
|
-
* <code>IN_PROGRESS</code>: Contract tests are currently being performed on the
|
|
4935
|
-
* extension.</p>
|
|
4852
|
+
* <code>IN_PROGRESS</code>: Contract tests are currently being performed on the extension.</p>
|
|
4936
4853
|
* </li>
|
|
4937
4854
|
* <li>
|
|
4938
4855
|
* <p>
|
|
4939
|
-
* <code>NOT_TESTED</code>: Contract tests haven't been performed on the
|
|
4940
|
-
* extension.</p>
|
|
4856
|
+
* <code>NOT_TESTED</code>: Contract tests haven't been performed on the extension.</p>
|
|
4941
4857
|
* </li>
|
|
4942
4858
|
* </ul>
|
|
4943
4859
|
*/
|
|
4944
4860
|
TypeTestsStatus?: TypeTestsStatus | string;
|
|
4945
4861
|
/**
|
|
4946
|
-
* <p>The description of the test status. To return the extension test status of a specific
|
|
4947
|
-
*
|
|
4948
|
-
* <p>This applies only to registered private extension versions. CloudFormation
|
|
4949
|
-
*
|
|
4950
|
-
* account.</p>
|
|
4862
|
+
* <p>The description of the test status. To return the extension test status of a specific extension version, you
|
|
4863
|
+
* must specify <code>VersionId</code>.</p>
|
|
4864
|
+
* <p>This applies only to registered private extension versions. CloudFormation doesn't return this
|
|
4865
|
+
* information for public extensions, whether they are activated in your account.</p>
|
|
4951
4866
|
*/
|
|
4952
4867
|
TypeTestsStatusDescription?: string;
|
|
4953
4868
|
/**
|
|
@@ -4956,30 +4871,29 @@ export interface DescribeTypeOutput {
|
|
|
4956
4871
|
Description?: string;
|
|
4957
4872
|
/**
|
|
4958
4873
|
* <p>The schema that defines the extension.</p>
|
|
4959
|
-
* <p>For more information about extension schemas, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">Resource Provider
|
|
4960
|
-
*
|
|
4874
|
+
* <p>For more information about extension schemas, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">Resource Provider Schema</a> in the
|
|
4875
|
+
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
4961
4876
|
*/
|
|
4962
4877
|
Schema?: string;
|
|
4963
4878
|
/**
|
|
4964
|
-
* <p>For resource type extensions, the provisioning behavior of the resource type. CloudFormation
|
|
4965
|
-
*
|
|
4966
|
-
* schema handler package submitted.</p>
|
|
4879
|
+
* <p>For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning
|
|
4880
|
+
* type during registration, based on the types of handlers in the schema handler package submitted.</p>
|
|
4967
4881
|
* <p>Valid values include:</p>
|
|
4968
4882
|
* <ul>
|
|
4969
4883
|
* <li>
|
|
4970
4884
|
* <p>
|
|
4971
|
-
* <code>FULLY_MUTABLE</code>: The resource type includes an update handler to process
|
|
4972
|
-
*
|
|
4885
|
+
* <code>FULLY_MUTABLE</code>: The resource type includes an update handler to process updates to the type during
|
|
4886
|
+
* stack update operations.</p>
|
|
4973
4887
|
* </li>
|
|
4974
4888
|
* <li>
|
|
4975
4889
|
* <p>
|
|
4976
|
-
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so the
|
|
4977
|
-
*
|
|
4890
|
+
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so the type can't be updated and
|
|
4891
|
+
* must instead be replaced during stack update operations.</p>
|
|
4978
4892
|
* </li>
|
|
4979
4893
|
* <li>
|
|
4980
4894
|
* <p>
|
|
4981
|
-
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include all the following
|
|
4982
|
-
*
|
|
4895
|
+
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include all the following handlers, and therefore
|
|
4896
|
+
* can't actually be provisioned.</p>
|
|
4983
4897
|
* <ul>
|
|
4984
4898
|
* <li>
|
|
4985
4899
|
* <p>create</p>
|
|
@@ -5001,57 +4915,53 @@ export interface DescribeTypeOutput {
|
|
|
5001
4915
|
* <ul>
|
|
5002
4916
|
* <li>
|
|
5003
4917
|
* <p>
|
|
5004
|
-
* <code>LIVE</code>: The extension is activated or registered and can be used in CloudFormation
|
|
5005
|
-
*
|
|
4918
|
+
* <code>LIVE</code>: The extension is activated or registered and can be used in CloudFormation
|
|
4919
|
+
* operations, dependent on its provisioning behavior and visibility scope.</p>
|
|
5006
4920
|
* </li>
|
|
5007
4921
|
* <li>
|
|
5008
4922
|
* <p>
|
|
5009
|
-
* <code>DEPRECATED</code>: The extension has been deactivated or deregistered and can no
|
|
5010
|
-
*
|
|
4923
|
+
* <code>DEPRECATED</code>: The extension has been deactivated or deregistered and can no longer be used in
|
|
4924
|
+
* CloudFormation operations.</p>
|
|
5011
4925
|
* </li>
|
|
5012
4926
|
* </ul>
|
|
5013
|
-
* <p>For public third-party extensions, CloudFormation returns
|
|
5014
|
-
* <code>null</code>.</p>
|
|
4927
|
+
* <p>For public third-party extensions, CloudFormation returns <code>null</code>.</p>
|
|
5015
4928
|
*/
|
|
5016
4929
|
DeprecatedStatus?: DeprecatedStatus | string;
|
|
5017
4930
|
/**
|
|
5018
|
-
* <p>Contains logging configuration information for private extensions. This applies only to
|
|
5019
|
-
*
|
|
5020
|
-
*
|
|
5021
|
-
* <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4931
|
+
* <p>Contains logging configuration information for private extensions. This applies only to private extensions you
|
|
4932
|
+
* have registered in your account. For public extensions, both those provided by Amazon Web Services and published by
|
|
4933
|
+
* 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>
|
|
5022
4934
|
*/
|
|
5023
4935
|
LoggingConfig?: LoggingConfig;
|
|
5024
4936
|
/**
|
|
5025
|
-
* <p>For extensions that are modules, the public third-party extensions that must be activated
|
|
5026
|
-
*
|
|
4937
|
+
* <p>For extensions that are modules, the public third-party extensions that must be activated in your account in
|
|
4938
|
+
* order for the module itself to be activated.</p>
|
|
5027
4939
|
*/
|
|
5028
4940
|
RequiredActivatedTypes?: RequiredActivatedType[];
|
|
5029
4941
|
/**
|
|
5030
|
-
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to register
|
|
5031
|
-
*
|
|
5032
|
-
*
|
|
5033
|
-
* <p>If the registered extension calls any Amazon Web Services APIs, you must create an
|
|
5034
|
-
* <i>
|
|
4942
|
+
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This
|
|
4943
|
+
* applies only to private extensions you have registered in your account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4944
|
+
* <p>If the registered extension calls any Amazon Web Services APIs, you must create an <i>
|
|
5035
4945
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a>
|
|
5036
|
-
* </i>
|
|
5037
|
-
*
|
|
5038
|
-
*
|
|
4946
|
+
* </i>
|
|
4947
|
+
* that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in
|
|
4948
|
+
* your account. CloudFormation then assumes that execution role to provide your extension with the appropriate
|
|
4949
|
+
* credentials.</p>
|
|
5039
4950
|
*/
|
|
5040
4951
|
ExecutionRoleArn?: string;
|
|
5041
4952
|
/**
|
|
5042
|
-
* <p>The scope at which the extension is visible and usable in CloudFormation
|
|
5043
|
-
* operations.</p>
|
|
4953
|
+
* <p>The scope at which the extension is visible and usable in CloudFormation operations.</p>
|
|
5044
4954
|
* <p>Valid values include:</p>
|
|
5045
4955
|
* <ul>
|
|
5046
4956
|
* <li>
|
|
5047
4957
|
* <p>
|
|
5048
|
-
* <code>PRIVATE</code>: The extension is only visible and usable within the account in
|
|
5049
|
-
*
|
|
5050
|
-
* <code>PRIVATE</code>.</p>
|
|
4958
|
+
* <code>PRIVATE</code>: The extension is only visible and usable within the account in which it is registered.
|
|
4959
|
+
* CloudFormation marks any extensions you register as <code>PRIVATE</code>.</p>
|
|
5051
4960
|
* </li>
|
|
5052
4961
|
* <li>
|
|
5053
4962
|
* <p>
|
|
5054
|
-
* <code>PUBLIC</code>: The extension is publicly visible and usable within any Amazon Web Services
|
|
4963
|
+
* <code>PUBLIC</code>: The extension is publicly visible and usable within any Amazon Web Services
|
|
4964
|
+
* account.</p>
|
|
5055
4965
|
* </li>
|
|
5056
4966
|
* </ul>
|
|
5057
4967
|
*/
|
|
@@ -5068,72 +4978,69 @@ export interface DescribeTypeOutput {
|
|
|
5068
4978
|
* <p>When the specified extension version was registered. This applies only to:</p>
|
|
5069
4979
|
* <ul>
|
|
5070
4980
|
* <li>
|
|
5071
|
-
* <p>Private extensions you have registered in your account. For more information, see
|
|
5072
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
4981
|
+
* <p>Private extensions you have registered in your account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
5073
4982
|
* </li>
|
|
5074
4983
|
* <li>
|
|
5075
|
-
* <p>Public extensions you have activated in your account with auto-update specified. For
|
|
5076
|
-
*
|
|
4984
|
+
* <p>Public extensions you have activated in your account with auto-update specified. For more information, see
|
|
4985
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a>.</p>
|
|
5077
4986
|
* </li>
|
|
5078
4987
|
* </ul>
|
|
5079
4988
|
*/
|
|
5080
4989
|
LastUpdated?: Date;
|
|
5081
4990
|
/**
|
|
5082
|
-
* <p>When the specified private extension version was registered or activated in your
|
|
5083
|
-
* account.</p>
|
|
4991
|
+
* <p>When the specified private extension version was registered or activated in your account.</p>
|
|
5084
4992
|
*/
|
|
5085
4993
|
TimeCreated?: Date;
|
|
5086
4994
|
/**
|
|
5087
|
-
* <p>A JSON string that represent the current configuration data for the extension in this
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
4995
|
+
* <p>A JSON string that represent the current configuration data for the extension in this account and Region.</p>
|
|
4996
|
+
* <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
|
|
4997
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
|
|
4998
|
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5090
4999
|
*/
|
|
5091
5000
|
ConfigurationSchema?: string;
|
|
5092
5001
|
/**
|
|
5093
5002
|
* <p>The publisher ID of the extension publisher.</p>
|
|
5094
|
-
* <p>This applies only to public third-party extensions. For private registered extensions, and
|
|
5095
|
-
*
|
|
5096
|
-
* <code>null</code>.</p>
|
|
5003
|
+
* <p>This applies only to public third-party extensions. For private registered extensions, and extensions provided
|
|
5004
|
+
* by Amazon Web Services, CloudFormation returns <code>null</code>.</p>
|
|
5097
5005
|
*/
|
|
5098
5006
|
PublisherId?: string;
|
|
5099
5007
|
/**
|
|
5100
|
-
* <p>For public extensions that have been activated for this account and Region, the type name
|
|
5101
|
-
*
|
|
5102
|
-
* <p>If you specified a <code>TypeNameAlias</code> when enabling the extension in this account
|
|
5103
|
-
*
|
|
5104
|
-
*
|
|
5105
|
-
* <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
|
|
5106
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
5008
|
+
* <p>For public extensions that have been activated for this account and Region, the type name of the public
|
|
5009
|
+
* extension.</p>
|
|
5010
|
+
* <p>If you specified a <code>TypeNameAlias</code> when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of
|
|
5011
|
+
* the public extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Specifying aliases to
|
|
5012
|
+
* refer to extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5107
5013
|
*/
|
|
5108
5014
|
OriginalTypeName?: string;
|
|
5109
5015
|
/**
|
|
5110
|
-
* <p>For public extensions that have been activated for this account and Region, the Amazon
|
|
5111
|
-
*
|
|
5016
|
+
* <p>For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of
|
|
5017
|
+
* the public extension.</p>
|
|
5112
5018
|
*/
|
|
5113
5019
|
OriginalTypeArn?: string;
|
|
5114
5020
|
/**
|
|
5115
5021
|
* <p>The version number of a public third-party extension.</p>
|
|
5116
|
-
* <p>This applies only if you specify a public extension you have activated in your account, or
|
|
5117
|
-
*
|
|
5022
|
+
* <p>This applies only if you specify a public extension you have activated in your account, or specify a public
|
|
5023
|
+
* extension without specifying a version. For all other extensions, CloudFormation returns
|
|
5024
|
+
* <code>null</code>.</p>
|
|
5118
5025
|
*/
|
|
5119
5026
|
PublicVersionNumber?: string;
|
|
5120
5027
|
/**
|
|
5121
|
-
* <p>The latest version of a public extension <i>that is available</i> for
|
|
5122
|
-
*
|
|
5123
|
-
*
|
|
5124
|
-
* all other requests, CloudFormation returns <code>null</code>.</p>
|
|
5028
|
+
* <p>The latest version of a public extension <i>that is available</i> for use.</p>
|
|
5029
|
+
* <p>This only applies if you specify a public extension, and you don't specify a version. For all other requests,
|
|
5030
|
+
* CloudFormation returns <code>null</code>.</p>
|
|
5125
5031
|
*/
|
|
5126
5032
|
LatestPublicVersion?: string;
|
|
5127
5033
|
/**
|
|
5128
5034
|
* <p>Whether the extension is activated in the account and Region.</p>
|
|
5129
|
-
* <p>This only applies to public third-party extensions. For all other extensions, CloudFormation returns
|
|
5035
|
+
* <p>This only applies to public third-party extensions. For all other extensions, CloudFormation returns
|
|
5036
|
+
* <code>null</code>.</p>
|
|
5130
5037
|
*/
|
|
5131
5038
|
IsActivated?: boolean;
|
|
5132
5039
|
/**
|
|
5133
|
-
* <p>Whether CloudFormation automatically updates the extension in this account and
|
|
5134
|
-
*
|
|
5135
|
-
*
|
|
5136
|
-
*
|
|
5040
|
+
* <p>Whether CloudFormation automatically updates the extension in this account and Region when a new
|
|
5041
|
+
* <i>minor</i> version is published by the extension publisher. Major versions released by the publisher
|
|
5042
|
+
* must be manually updated. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable">Activating public extensions
|
|
5043
|
+
* for use in your account</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5137
5044
|
*/
|
|
5138
5045
|
AutoUpdate?: boolean;
|
|
5139
5046
|
}
|
|
@@ -5143,10 +5050,8 @@ export interface DescribeTypeOutput {
|
|
|
5143
5050
|
export interface DescribeTypeRegistrationInput {
|
|
5144
5051
|
/**
|
|
5145
5052
|
* <p>The identifier for this registration request.</p>
|
|
5146
|
-
* <p>This registration token is generated by CloudFormation when you initiate a
|
|
5147
|
-
*
|
|
5148
|
-
* <a>RegisterType</a>
|
|
5149
|
-
* </code>.</p>
|
|
5053
|
+
* <p>This registration token is generated by CloudFormation when you initiate a registration request using
|
|
5054
|
+
* <a>RegisterType</a>.</p>
|
|
5150
5055
|
*/
|
|
5151
5056
|
RegistrationToken: string | undefined;
|
|
5152
5057
|
}
|
|
@@ -5177,15 +5082,14 @@ export interface DescribeTypeRegistrationOutput {
|
|
|
5177
5082
|
Description?: string;
|
|
5178
5083
|
/**
|
|
5179
5084
|
* <p>The Amazon Resource Name (ARN) of the extension being registered.</p>
|
|
5180
|
-
* <p>For registration requests with a <code>ProgressStatus</code> of other than
|
|
5181
|
-
*
|
|
5085
|
+
* <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be
|
|
5086
|
+
* <code>null</code>.</p>
|
|
5182
5087
|
*/
|
|
5183
5088
|
TypeArn?: string;
|
|
5184
5089
|
/**
|
|
5185
|
-
* <p>The Amazon Resource Name (ARN) of this specific version of the extension being
|
|
5186
|
-
*
|
|
5187
|
-
*
|
|
5188
|
-
* <code>COMPLETE</code>, this will be <code>null</code>.</p>
|
|
5090
|
+
* <p>The Amazon Resource Name (ARN) of this specific version of the extension being registered.</p>
|
|
5091
|
+
* <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be
|
|
5092
|
+
* <code>null</code>.</p>
|
|
5189
5093
|
*/
|
|
5190
5094
|
TypeVersionArn?: string;
|
|
5191
5095
|
}
|
|
@@ -5208,9 +5112,8 @@ export interface DetectStackDriftInput {
|
|
|
5208
5112
|
export interface DetectStackDriftOutput {
|
|
5209
5113
|
/**
|
|
5210
5114
|
* <p>The ID of the drift detection results of this operation.</p>
|
|
5211
|
-
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is
|
|
5212
|
-
*
|
|
5213
|
-
* may vary.</p>
|
|
5115
|
+
* <p>CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number
|
|
5116
|
+
* of drift results CloudFormation retains for any given stack, and for how long, may vary.</p>
|
|
5214
5117
|
*/
|
|
5215
5118
|
StackDriftDetectionId: string | undefined;
|
|
5216
5119
|
}
|
|
@@ -5232,9 +5135,8 @@ export interface DetectStackResourceDriftInput {
|
|
|
5232
5135
|
*/
|
|
5233
5136
|
export interface DetectStackResourceDriftOutput {
|
|
5234
5137
|
/**
|
|
5235
|
-
* <p>Information about whether the resource's actual configuration has drifted from its
|
|
5236
|
-
*
|
|
5237
|
-
* differences detected.</p>
|
|
5138
|
+
* <p>Information about whether the resource's actual configuration has drifted from its expected template
|
|
5139
|
+
* configuration, including actual and expected property values and any differences detected.</p>
|
|
5238
5140
|
*/
|
|
5239
5141
|
StackResourceDrift: StackResourceDrift | undefined;
|
|
5240
5142
|
}
|
|
@@ -5282,10 +5184,8 @@ export interface DetectStackSetDriftInput {
|
|
|
5282
5184
|
export interface DetectStackSetDriftOutput {
|
|
5283
5185
|
/**
|
|
5284
5186
|
* <p>The ID of the drift detection stack set operation.</p>
|
|
5285
|
-
* <p>You can use this operation ID with <
|
|
5286
|
-
*
|
|
5287
|
-
* </code> to monitor the
|
|
5288
|
-
* progress of the drift detection operation.</p>
|
|
5187
|
+
* <p>You can use this operation ID with <a>DescribeStackSetOperation</a> to monitor the progress of the
|
|
5188
|
+
* drift detection operation.</p>
|
|
5289
5189
|
*/
|
|
5290
5190
|
OperationId?: string;
|
|
5291
5191
|
}
|
|
@@ -5295,19 +5195,18 @@ export interface DetectStackSetDriftOutput {
|
|
|
5295
5195
|
*/
|
|
5296
5196
|
export interface EstimateTemplateCostInput {
|
|
5297
5197
|
/**
|
|
5298
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
5299
|
-
*
|
|
5300
|
-
*
|
|
5301
|
-
* <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both
|
|
5302
|
-
*
|
|
5198
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
|
5199
|
+
* (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
5200
|
+
* CloudFormation User Guide.)</p>
|
|
5201
|
+
* <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only
|
|
5202
|
+
* <code>TemplateBody</code> is used.</p>
|
|
5303
5203
|
*/
|
|
5304
5204
|
TemplateBody?: string;
|
|
5305
5205
|
/**
|
|
5306
|
-
* <p>Location of file containing the template body. The URL must point to a template that's
|
|
5307
|
-
*
|
|
5308
|
-
*
|
|
5309
|
-
*
|
|
5310
|
-
* are passed, only <code>TemplateBody</code> is used.</p>
|
|
5206
|
+
* <p>Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
5207
|
+
* CloudFormation User Guide.</p>
|
|
5208
|
+
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
5209
|
+
* <code>TemplateBody</code> is used.</p>
|
|
5311
5210
|
*/
|
|
5312
5211
|
TemplateURL?: string;
|
|
5313
5212
|
/**
|
|
@@ -5321,8 +5220,8 @@ export interface EstimateTemplateCostInput {
|
|
|
5321
5220
|
*/
|
|
5322
5221
|
export interface EstimateTemplateCostOutput {
|
|
5323
5222
|
/**
|
|
5324
|
-
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the
|
|
5325
|
-
*
|
|
5223
|
+
* <p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to
|
|
5224
|
+
* run the template.</p>
|
|
5326
5225
|
*/
|
|
5327
5226
|
Url?: string;
|
|
5328
5227
|
}
|
|
@@ -5332,21 +5231,19 @@ export interface EstimateTemplateCostOutput {
|
|
|
5332
5231
|
*/
|
|
5333
5232
|
export interface ExecuteChangeSetInput {
|
|
5334
5233
|
/**
|
|
5335
|
-
* <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the
|
|
5336
|
-
* specified stack.</p>
|
|
5234
|
+
* <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>
|
|
5337
5235
|
*/
|
|
5338
5236
|
ChangeSetName: string | undefined;
|
|
5339
5237
|
/**
|
|
5340
|
-
* <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name
|
|
5341
|
-
*
|
|
5238
|
+
* <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's
|
|
5239
|
+
* associated with the change set you want to execute.</p>
|
|
5342
5240
|
*/
|
|
5343
5241
|
StackName?: string;
|
|
5344
5242
|
/**
|
|
5345
|
-
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if
|
|
5346
|
-
*
|
|
5347
|
-
*
|
|
5348
|
-
*
|
|
5349
|
-
* received them.</p>
|
|
5243
|
+
* <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry
|
|
5244
|
+
* requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with
|
|
5245
|
+
* the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully
|
|
5246
|
+
* received them.</p>
|
|
5350
5247
|
*/
|
|
5351
5248
|
ClientRequestToken?: string;
|
|
5352
5249
|
/**
|
|
@@ -5368,8 +5265,7 @@ export interface ExecuteChangeSetOutput {
|
|
|
5368
5265
|
*/
|
|
5369
5266
|
export interface GetStackPolicyInput {
|
|
5370
5267
|
/**
|
|
5371
|
-
* <p>The name or unique stack ID that's associated with the stack whose policy you want to
|
|
5372
|
-
* get.</p>
|
|
5268
|
+
* <p>The name or unique stack ID that's associated with the stack whose policy you want to get.</p>
|
|
5373
5269
|
*/
|
|
5374
5270
|
StackName: string | undefined;
|
|
5375
5271
|
}
|
|
@@ -5379,8 +5275,8 @@ export interface GetStackPolicyInput {
|
|
|
5379
5275
|
*/
|
|
5380
5276
|
export interface GetStackPolicyOutput {
|
|
5381
5277
|
/**
|
|
5382
|
-
* <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">
|
|
5383
|
-
*
|
|
5278
|
+
* <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 to Stack Resources</a> in
|
|
5279
|
+
* the CloudFormation User Guide.)</p>
|
|
5384
5280
|
*/
|
|
5385
5281
|
StackPolicyBody?: string;
|
|
5386
5282
|
}
|
|
@@ -5402,8 +5298,7 @@ export type TemplateStage = (typeof TemplateStage)[keyof typeof TemplateStage];
|
|
|
5402
5298
|
*/
|
|
5403
5299
|
export interface GetTemplateInput {
|
|
5404
5300
|
/**
|
|
5405
|
-
* <p>The name or the unique stack ID that's associated with the stack, which aren't always
|
|
5406
|
-
* interchangeable:</p>
|
|
5301
|
+
* <p>The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:</p>
|
|
5407
5302
|
* <ul>
|
|
5408
5303
|
* <li>
|
|
5409
5304
|
* <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p>
|
|
@@ -5416,18 +5311,16 @@ export interface GetTemplateInput {
|
|
|
5416
5311
|
*/
|
|
5417
5312
|
StackName?: string;
|
|
5418
5313
|
/**
|
|
5419
|
-
* <p>The name or Amazon Resource Name (ARN) of a change set for which CloudFormation
|
|
5420
|
-
*
|
|
5421
|
-
* <code>StackName</code>.</p>
|
|
5314
|
+
* <p>The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated
|
|
5315
|
+
* template. If you specify a name, you must also specify the <code>StackName</code>.</p>
|
|
5422
5316
|
*/
|
|
5423
5317
|
ChangeSetName?: string;
|
|
5424
5318
|
/**
|
|
5425
|
-
* <p>For templates that include transforms, the stage of the template that CloudFormation returns. To get the
|
|
5426
|
-
*
|
|
5427
|
-
*
|
|
5428
|
-
* <p>If the template doesn't include transforms, <code>Original</code> and
|
|
5429
|
-
*
|
|
5430
|
-
* specifies <code>Processed</code>.</p>
|
|
5319
|
+
* <p>For templates that include transforms, the stage of the template that CloudFormation returns. To get the
|
|
5320
|
+
* user-submitted template, specify <code>Original</code>. To get the template after CloudFormation has
|
|
5321
|
+
* processed all transforms, specify <code>Processed</code>.</p>
|
|
5322
|
+
* <p>If the template doesn't include transforms, <code>Original</code> and <code>Processed</code> return the same
|
|
5323
|
+
* template. By default, CloudFormation specifies <code>Processed</code>.</p>
|
|
5431
5324
|
*/
|
|
5432
5325
|
TemplateStage?: TemplateStage | string;
|
|
5433
5326
|
}
|
|
@@ -5437,17 +5330,16 @@ export interface GetTemplateInput {
|
|
|
5437
5330
|
*/
|
|
5438
5331
|
export interface GetTemplateOutput {
|
|
5439
5332
|
/**
|
|
5440
|
-
* <p>Structure containing the template body. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
|
|
5441
|
-
*
|
|
5442
|
-
* <p>CloudFormation returns the same template that was used when the stack was
|
|
5443
|
-
* created.</p>
|
|
5333
|
+
* <p>Structure containing the template body. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
5334
|
+
* CloudFormation User Guide.)</p>
|
|
5335
|
+
* <p>CloudFormation returns the same template that was used when the stack was created.</p>
|
|
5444
5336
|
*/
|
|
5445
5337
|
TemplateBody?: string;
|
|
5446
5338
|
/**
|
|
5447
5339
|
* <p>The stage of the template that you can retrieve. For stacks, the <code>Original</code> and
|
|
5448
|
-
*
|
|
5449
|
-
*
|
|
5450
|
-
*
|
|
5340
|
+
* <code>Processed</code> templates are always available. For change sets, the <code>Original</code> template is always
|
|
5341
|
+
* available. After CloudFormation finishes creating the change set, the <code>Processed</code> template becomes
|
|
5342
|
+
* available.</p>
|
|
5451
5343
|
*/
|
|
5452
5344
|
StagesAvailable?: (TemplateStage | string)[];
|
|
5453
5345
|
}
|
|
@@ -5457,58 +5349,49 @@ export interface GetTemplateOutput {
|
|
|
5457
5349
|
*/
|
|
5458
5350
|
export interface GetTemplateSummaryInput {
|
|
5459
5351
|
/**
|
|
5460
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
5461
|
-
*
|
|
5462
|
-
*
|
|
5463
|
-
* <p>Conditional: You must specify only one of the following parameters:
|
|
5464
|
-
*
|
|
5465
|
-
* <code>TemplateURL</code>.</p>
|
|
5352
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
|
|
5353
|
+
* more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a> in the
|
|
5354
|
+
* CloudFormation User Guide.</p>
|
|
5355
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>,
|
|
5356
|
+
* <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>
|
|
5466
5357
|
*/
|
|
5467
5358
|
TemplateBody?: string;
|
|
5468
5359
|
/**
|
|
5469
|
-
* <p>Location of file containing the template body. The URL must point to a template (max size:
|
|
5470
|
-
*
|
|
5471
|
-
*
|
|
5472
|
-
*
|
|
5473
|
-
* <p>Conditional: You must specify only one of the following parameters:
|
|
5474
|
-
*
|
|
5475
|
-
* <code>TemplateURL</code>.</p>
|
|
5360
|
+
* <p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
|
|
5361
|
+
* located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see
|
|
5362
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a>
|
|
5363
|
+
* in the CloudFormation User Guide.</p>
|
|
5364
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>,
|
|
5365
|
+
* <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>
|
|
5476
5366
|
*/
|
|
5477
5367
|
TemplateURL?: string;
|
|
5478
5368
|
/**
|
|
5479
|
-
* <p>The name or the stack ID that's associated with the stack, which aren't always
|
|
5480
|
-
*
|
|
5481
|
-
*
|
|
5482
|
-
* <p>Conditional: You must specify only one of the following parameters:
|
|
5483
|
-
*
|
|
5484
|
-
* <code>TemplateURL</code>.</p>
|
|
5369
|
+
* <p>The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running
|
|
5370
|
+
* stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the
|
|
5371
|
+
* unique stack ID.</p>
|
|
5372
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>,
|
|
5373
|
+
* <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>
|
|
5485
5374
|
*/
|
|
5486
5375
|
StackName?: string;
|
|
5487
5376
|
/**
|
|
5488
5377
|
* <p>The name or unique ID of the stack set from which the stack was created.</p>
|
|
5489
|
-
* <p>Conditional: You must specify only one of the following parameters:
|
|
5490
|
-
*
|
|
5491
|
-
* <code>TemplateURL</code>.</p>
|
|
5378
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>,
|
|
5379
|
+
* <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>
|
|
5492
5380
|
*/
|
|
5493
5381
|
StackSetName?: string;
|
|
5494
5382
|
/**
|
|
5495
|
-
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator
|
|
5496
|
-
*
|
|
5497
|
-
*
|
|
5498
|
-
*
|
|
5499
|
-
* self-managed permissions.</p>
|
|
5383
|
+
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
|
|
5384
|
+
* management account or as a delegated administrator in a member account.</p>
|
|
5385
|
+
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed
|
|
5386
|
+
* permissions.</p>
|
|
5500
5387
|
* <ul>
|
|
5501
5388
|
* <li>
|
|
5502
|
-
* <p>If you are signed in to the management account, specify
|
|
5503
|
-
* <code>SELF</code>.</p>
|
|
5389
|
+
* <p>If you are signed in to the management account, specify <code>SELF</code>.</p>
|
|
5504
5390
|
* </li>
|
|
5505
5391
|
* <li>
|
|
5506
|
-
* <p>If you are signed in to a delegated administrator account, specify
|
|
5507
|
-
*
|
|
5508
|
-
*
|
|
5509
|
-
* management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a
|
|
5510
|
-
* delegated administrator</a> in the <i>CloudFormation User
|
|
5511
|
-
* Guide</i>.</p>
|
|
5392
|
+
* <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
|
5393
|
+
* <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated
|
|
5394
|
+
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
5512
5395
|
* </li>
|
|
5513
5396
|
* </ul>
|
|
5514
5397
|
*/
|
|
@@ -5557,25 +5440,23 @@ export interface ParameterDeclaration {
|
|
|
5557
5440
|
}
|
|
5558
5441
|
/**
|
|
5559
5442
|
* @public
|
|
5560
|
-
* <p>Describes the target resources of a specific type in your import template (for example,
|
|
5561
|
-
*
|
|
5562
|
-
*
|
|
5443
|
+
* <p>Describes the target resources of a specific type in your import template (for example, all
|
|
5444
|
+
* <code>AWS::S3::Bucket</code> resources) and the properties you can provide during the import to identify resources
|
|
5445
|
+
* of that type.</p>
|
|
5563
5446
|
*/
|
|
5564
5447
|
export interface ResourceIdentifierSummary {
|
|
5565
5448
|
/**
|
|
5566
|
-
* <p>The template resource type of the target resources, such as
|
|
5567
|
-
* <code>AWS::S3::Bucket</code>.</p>
|
|
5449
|
+
* <p>The template resource type of the target resources, such as <code>AWS::S3::Bucket</code>.</p>
|
|
5568
5450
|
*/
|
|
5569
5451
|
ResourceType?: string;
|
|
5570
5452
|
/**
|
|
5571
|
-
* <p>The logical IDs of the target resources of the specified <code>ResourceType</code>, as
|
|
5572
|
-
*
|
|
5453
|
+
* <p>The logical IDs of the target resources of the specified <code>ResourceType</code>, as defined in the import
|
|
5454
|
+
* template.</p>
|
|
5573
5455
|
*/
|
|
5574
5456
|
LogicalResourceIds?: string[];
|
|
5575
5457
|
/**
|
|
5576
|
-
* <p>The resource properties you can provide during the import to identify your target
|
|
5577
|
-
*
|
|
5578
|
-
* <code>AWS::S3::Bucket</code> resources.</p>
|
|
5458
|
+
* <p>The resource properties you can provide during the import to identify your target resources. For example,
|
|
5459
|
+
* <code>BucketName</code> is a possible identifier property for <code>AWS::S3::Bucket</code> resources.</p>
|
|
5579
5460
|
*/
|
|
5580
5461
|
ResourceIdentifiers?: string[];
|
|
5581
5462
|
}
|
|
@@ -5585,8 +5466,7 @@ export interface ResourceIdentifierSummary {
|
|
|
5585
5466
|
*/
|
|
5586
5467
|
export interface GetTemplateSummaryOutput {
|
|
5587
5468
|
/**
|
|
5588
|
-
* <p>A list of parameter declarations that describe various properties for each
|
|
5589
|
-
* parameter.</p>
|
|
5469
|
+
* <p>A list of parameter declarations that describe various properties for each parameter.</p>
|
|
5590
5470
|
*/
|
|
5591
5471
|
Parameters?: ParameterDeclaration[];
|
|
5592
5472
|
/**
|
|
@@ -5594,28 +5474,25 @@ export interface GetTemplateSummaryOutput {
|
|
|
5594
5474
|
*/
|
|
5595
5475
|
Description?: string;
|
|
5596
5476
|
/**
|
|
5597
|
-
* <p>The capabilities found within the template. If your template contains IAM
|
|
5598
|
-
*
|
|
5599
|
-
*
|
|
5600
|
-
*
|
|
5601
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
5602
|
-
*
|
|
5477
|
+
* <p>The capabilities found within the template. If your template contains IAM resources, you must
|
|
5478
|
+
* specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use
|
|
5479
|
+
* the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those
|
|
5480
|
+
* actions return an <code>InsufficientCapabilities</code> error.</p>
|
|
5481
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
5482
|
+
* Resources in CloudFormation Templates</a>.</p>
|
|
5603
5483
|
*/
|
|
5604
5484
|
Capabilities?: (Capability | string)[];
|
|
5605
5485
|
/**
|
|
5606
|
-
* <p>The list of resources that generated the values in the <code>Capabilities</code> response
|
|
5607
|
-
* element.</p>
|
|
5486
|
+
* <p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>
|
|
5608
5487
|
*/
|
|
5609
5488
|
CapabilitiesReason?: string;
|
|
5610
5489
|
/**
|
|
5611
5490
|
* <p>A list of all the template resource types that are defined in the template, such as
|
|
5612
|
-
*
|
|
5613
|
-
* <code>Custom::MyCustomInstance</code>.</p>
|
|
5491
|
+
* <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>.</p>
|
|
5614
5492
|
*/
|
|
5615
5493
|
ResourceTypes?: string[];
|
|
5616
5494
|
/**
|
|
5617
|
-
* <p>The Amazon Web Services template format version, which identifies the capabilities of the
|
|
5618
|
-
* template.</p>
|
|
5495
|
+
* <p>The Amazon Web Services template format version, which identifies the capabilities of the template.</p>
|
|
5619
5496
|
*/
|
|
5620
5497
|
Version?: string;
|
|
5621
5498
|
/**
|
|
@@ -5627,10 +5504,9 @@ export interface GetTemplateSummaryOutput {
|
|
|
5627
5504
|
*/
|
|
5628
5505
|
DeclaredTransforms?: string[];
|
|
5629
5506
|
/**
|
|
5630
|
-
* <p>A list of resource identifier summaries that describe the target resources of an import
|
|
5631
|
-
*
|
|
5632
|
-
*
|
|
5633
|
-
* <code>AWS::S3::Bucket</code> resource.</p>
|
|
5507
|
+
* <p>A list of resource identifier summaries that describe the target resources of an import operation and the
|
|
5508
|
+
* properties you can provide during the import to identify the target resources. For example, <code>BucketName</code>
|
|
5509
|
+
* is a possible identifier property for an <code>AWS::S3::Bucket</code> resource.</p>
|
|
5634
5510
|
*/
|
|
5635
5511
|
ResourceIdentifierSummaries?: ResourceIdentifierSummary[];
|
|
5636
5512
|
}
|
|
@@ -5709,13 +5585,12 @@ export declare class StackNotFoundException extends __BaseException {
|
|
|
5709
5585
|
*/
|
|
5710
5586
|
export interface ListChangeSetsInput {
|
|
5711
5587
|
/**
|
|
5712
|
-
* <p>The name or the Amazon Resource Name (ARN) of the stack for which you want to list change
|
|
5713
|
-
* sets.</p>
|
|
5588
|
+
* <p>The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.</p>
|
|
5714
5589
|
*/
|
|
5715
5590
|
StackName: string | undefined;
|
|
5716
5591
|
/**
|
|
5717
|
-
* <p>A string (provided by the <a>ListChangeSets</a> response output) that
|
|
5718
|
-
*
|
|
5592
|
+
* <p>A string (provided by the <a>ListChangeSets</a> response output) that identifies the next page of
|
|
5593
|
+
* change sets that you want to retrieve.</p>
|
|
5719
5594
|
*/
|
|
5720
5595
|
NextToken?: string;
|
|
5721
5596
|
}
|
|
@@ -5725,13 +5600,13 @@ export interface ListChangeSetsInput {
|
|
|
5725
5600
|
*/
|
|
5726
5601
|
export interface ListChangeSetsOutput {
|
|
5727
5602
|
/**
|
|
5728
|
-
* <p>A list of <code>ChangeSetSummary</code> structures that provides the ID and status of each
|
|
5729
|
-
*
|
|
5603
|
+
* <p>A list of <code>ChangeSetSummary</code> structures that provides the ID and status of each change set for the
|
|
5604
|
+
* specified stack.</p>
|
|
5730
5605
|
*/
|
|
5731
5606
|
Summaries?: ChangeSetSummary[];
|
|
5732
5607
|
/**
|
|
5733
|
-
* <p>If the output exceeds 1 MB, a string that identifies the next page of change sets. If
|
|
5734
|
-
*
|
|
5608
|
+
* <p>If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional
|
|
5609
|
+
* page, this value is <code>null</code>.</p>
|
|
5735
5610
|
*/
|
|
5736
5611
|
NextToken?: string;
|
|
5737
5612
|
}
|
|
@@ -5740,8 +5615,8 @@ export interface ListChangeSetsOutput {
|
|
|
5740
5615
|
*/
|
|
5741
5616
|
export interface ListExportsInput {
|
|
5742
5617
|
/**
|
|
5743
|
-
* <p>A string (provided by the <a>ListExports</a> response output) that identifies
|
|
5744
|
-
*
|
|
5618
|
+
* <p>A string (provided by the <a>ListExports</a> response output) that identifies the next page of
|
|
5619
|
+
* exported output values that you asked to retrieve.</p>
|
|
5745
5620
|
*/
|
|
5746
5621
|
NextToken?: string;
|
|
5747
5622
|
}
|
|
@@ -5775,8 +5650,8 @@ export interface ListExportsOutput {
|
|
|
5775
5650
|
*/
|
|
5776
5651
|
Exports?: Export[];
|
|
5777
5652
|
/**
|
|
5778
|
-
* <p>If the output exceeds 100 exported output values, a string that identifies the next page
|
|
5779
|
-
*
|
|
5653
|
+
* <p>If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is
|
|
5654
|
+
* no additional page, this value is null.</p>
|
|
5780
5655
|
*/
|
|
5781
5656
|
NextToken?: string;
|
|
5782
5657
|
}
|
|
@@ -5785,13 +5660,13 @@ export interface ListExportsOutput {
|
|
|
5785
5660
|
*/
|
|
5786
5661
|
export interface ListImportsInput {
|
|
5787
5662
|
/**
|
|
5788
|
-
* <p>The name of the exported output value. CloudFormation returns the stack names that are
|
|
5789
|
-
*
|
|
5663
|
+
* <p>The name of the exported output value. CloudFormation returns the stack names that are importing this
|
|
5664
|
+
* value.</p>
|
|
5790
5665
|
*/
|
|
5791
5666
|
ExportName: string | undefined;
|
|
5792
5667
|
/**
|
|
5793
|
-
* <p>A string (provided by the <a>ListImports</a> response output) that identifies
|
|
5794
|
-
*
|
|
5668
|
+
* <p>A string (provided by the <a>ListImports</a> response output) that identifies the next page of stacks
|
|
5669
|
+
* that are importing the specified exported output value.</p>
|
|
5795
5670
|
*/
|
|
5796
5671
|
NextToken?: string;
|
|
5797
5672
|
}
|
|
@@ -5804,8 +5679,7 @@ export interface ListImportsOutput {
|
|
|
5804
5679
|
*/
|
|
5805
5680
|
Imports?: string[];
|
|
5806
5681
|
/**
|
|
5807
|
-
* <p>A string that identifies the next page of exports. If there is no additional page, this
|
|
5808
|
-
* value is null.</p>
|
|
5682
|
+
* <p>A string that identifies the next page of exports. If there is no additional page, this value is null.</p>
|
|
5809
5683
|
*/
|
|
5810
5684
|
NextToken?: string;
|
|
5811
5685
|
}
|
|
@@ -6012,8 +5886,7 @@ export interface ListStackInstancesOutput {
|
|
|
6012
5886
|
*/
|
|
6013
5887
|
export interface ListStackResourcesInput {
|
|
6014
5888
|
/**
|
|
6015
|
-
* <p>The name or the unique stack ID that is associated with the stack, which aren't always
|
|
6016
|
-
* interchangeable:</p>
|
|
5889
|
+
* <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
|
|
6017
5890
|
* <ul>
|
|
6018
5891
|
* <li>
|
|
6019
5892
|
* <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p>
|
|
@@ -6026,8 +5899,7 @@ export interface ListStackResourcesInput {
|
|
|
6026
5899
|
*/
|
|
6027
5900
|
StackName: string | undefined;
|
|
6028
5901
|
/**
|
|
6029
|
-
* <p>A string that identifies the next page of stack resources that you want to
|
|
6030
|
-
* retrieve.</p>
|
|
5902
|
+
* <p>A string that identifies the next page of stack resources that you want to retrieve.</p>
|
|
6031
5903
|
*/
|
|
6032
5904
|
NextToken?: string;
|
|
6033
5905
|
}
|
|
@@ -6123,8 +5995,8 @@ export interface ListStackResourcesOutput {
|
|
|
6123
5995
|
*/
|
|
6124
5996
|
StackResourceSummaries?: StackResourceSummary[];
|
|
6125
5997
|
/**
|
|
6126
|
-
* <p>If the output exceeds 1 MB, a string that identifies the next page of stack resources. If
|
|
6127
|
-
*
|
|
5998
|
+
* <p>If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page
|
|
5999
|
+
* exists, this value is null.</p>
|
|
6128
6000
|
*/
|
|
6129
6001
|
NextToken?: string;
|
|
6130
6002
|
}
|
|
@@ -6138,9 +6010,8 @@ export interface ListStacksInput {
|
|
|
6138
6010
|
*/
|
|
6139
6011
|
NextToken?: string;
|
|
6140
6012
|
/**
|
|
6141
|
-
* <p>Stack status to use as a filter. Specify one or more stack status codes to list only
|
|
6142
|
-
*
|
|
6143
|
-
* <code>StackStatus</code> parameter of the <a>Stack</a> data type.</p>
|
|
6013
|
+
* <p>Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified
|
|
6014
|
+
* status codes. For a complete list of stack status codes, see the <code>StackStatus</code> parameter of the <a>Stack</a> data type.</p>
|
|
6144
6015
|
*/
|
|
6145
6016
|
StackStatusFilter?: (StackStatus | string)[];
|
|
6146
6017
|
}
|
|
@@ -6247,13 +6118,12 @@ export interface StackSummary {
|
|
|
6247
6118
|
*/
|
|
6248
6119
|
export interface ListStacksOutput {
|
|
6249
6120
|
/**
|
|
6250
|
-
* <p>A list of <code>StackSummary</code> structures containing information about the specified
|
|
6251
|
-
* stacks.</p>
|
|
6121
|
+
* <p>A list of <code>StackSummary</code> structures containing information about the specified stacks.</p>
|
|
6252
6122
|
*/
|
|
6253
6123
|
StackSummaries?: StackSummary[];
|
|
6254
6124
|
/**
|
|
6255
|
-
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If
|
|
6256
|
-
*
|
|
6125
|
+
* <p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page
|
|
6126
|
+
* exists, this value is null.</p>
|
|
6257
6127
|
*/
|
|
6258
6128
|
NextToken?: string;
|
|
6259
6129
|
}
|
|
@@ -6698,20 +6568,17 @@ export interface ListStackSetsOutput {
|
|
|
6698
6568
|
export interface ListTypeRegistrationsInput {
|
|
6699
6569
|
/**
|
|
6700
6570
|
* <p>The kind of extension.</p>
|
|
6701
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
6702
|
-
* <code>Arn</code>.</p>
|
|
6571
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
6703
6572
|
*/
|
|
6704
6573
|
Type?: RegistryType | string;
|
|
6705
6574
|
/**
|
|
6706
6575
|
* <p>The name of the extension.</p>
|
|
6707
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
6708
|
-
* <code>Arn</code>.</p>
|
|
6576
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
6709
6577
|
*/
|
|
6710
6578
|
TypeName?: string;
|
|
6711
6579
|
/**
|
|
6712
6580
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
6713
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
6714
|
-
* <code>Arn</code>.</p>
|
|
6581
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
6715
6582
|
*/
|
|
6716
6583
|
TypeArn?: string;
|
|
6717
6584
|
/**
|
|
@@ -6720,18 +6587,16 @@ export interface ListTypeRegistrationsInput {
|
|
|
6720
6587
|
*/
|
|
6721
6588
|
RegistrationStatusFilter?: RegistrationStatus | string;
|
|
6722
6589
|
/**
|
|
6723
|
-
* <p>The maximum number of results to be returned with a single call. If the number of
|
|
6724
|
-
*
|
|
6725
|
-
*
|
|
6726
|
-
* results.</p>
|
|
6590
|
+
* <p>The maximum number of results to be returned with a single call. If the number of available results exceeds this
|
|
6591
|
+
* maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code>
|
|
6592
|
+
* request parameter to get the next set of results.</p>
|
|
6727
6593
|
*/
|
|
6728
6594
|
MaxResults?: number;
|
|
6729
6595
|
/**
|
|
6730
|
-
* <p>If the previous paginated request didn't return all the remaining results, the response
|
|
6731
|
-
*
|
|
6732
|
-
*
|
|
6733
|
-
*
|
|
6734
|
-
* object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6596
|
+
* <p>If the previous paginated request didn't return all the remaining results, the response object's
|
|
6597
|
+
* <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action
|
|
6598
|
+
* again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining
|
|
6599
|
+
* results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6735
6600
|
*/
|
|
6736
6601
|
NextToken?: string;
|
|
6737
6602
|
}
|
|
@@ -6741,17 +6606,14 @@ export interface ListTypeRegistrationsInput {
|
|
|
6741
6606
|
export interface ListTypeRegistrationsOutput {
|
|
6742
6607
|
/**
|
|
6743
6608
|
* <p>A list of extension registration tokens.</p>
|
|
6744
|
-
* <p>Use <
|
|
6745
|
-
*
|
|
6746
|
-
* </code> to return detailed information
|
|
6747
|
-
* about a type registration request.</p>
|
|
6609
|
+
* <p>Use <a>DescribeTypeRegistration</a> to return detailed information about a type registration
|
|
6610
|
+
* request.</p>
|
|
6748
6611
|
*/
|
|
6749
6612
|
RegistrationTokenList?: string[];
|
|
6750
6613
|
/**
|
|
6751
|
-
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to
|
|
6752
|
-
*
|
|
6753
|
-
*
|
|
6754
|
-
* <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6614
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve
|
|
6615
|
+
* the next set of results, call this action again and assign that token to the request object's <code>NextToken</code>
|
|
6616
|
+
* parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6755
6617
|
*/
|
|
6756
6618
|
NextToken?: string;
|
|
6757
6619
|
}
|
|
@@ -6807,14 +6669,13 @@ export interface TypeFilters {
|
|
|
6807
6669
|
*/
|
|
6808
6670
|
export interface ListTypesInput {
|
|
6809
6671
|
/**
|
|
6810
|
-
* <p>The scope at which the extensions are visible and usable in CloudFormation
|
|
6811
|
-
* operations.</p>
|
|
6672
|
+
* <p>The scope at which the extensions are visible and usable in CloudFormation operations.</p>
|
|
6812
6673
|
* <p>Valid values include:</p>
|
|
6813
6674
|
* <ul>
|
|
6814
6675
|
* <li>
|
|
6815
6676
|
* <p>
|
|
6816
|
-
* <code>PRIVATE</code>: Extensions that are visible and usable within this account and
|
|
6817
|
-
*
|
|
6677
|
+
* <code>PRIVATE</code>: Extensions that are visible and usable within this account and Region. This
|
|
6678
|
+
* includes:</p>
|
|
6818
6679
|
* <ul>
|
|
6819
6680
|
* <li>
|
|
6820
6681
|
* <p>Private extensions you have registered in this account and Region.</p>
|
|
@@ -6826,52 +6687,48 @@ export interface ListTypesInput {
|
|
|
6826
6687
|
* </li>
|
|
6827
6688
|
* <li>
|
|
6828
6689
|
* <p>
|
|
6829
|
-
* <code>PUBLIC</code>: Extensions that are publicly visible and available to be
|
|
6830
|
-
*
|
|
6690
|
+
* <code>PUBLIC</code>: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party
|
|
6691
|
+
* publishers.</p>
|
|
6831
6692
|
* </li>
|
|
6832
6693
|
* </ul>
|
|
6833
6694
|
* <p>The default is <code>PRIVATE</code>.</p>
|
|
6834
6695
|
*/
|
|
6835
6696
|
Visibility?: Visibility | string;
|
|
6836
6697
|
/**
|
|
6837
|
-
* <p>For resource types, the provisioning behavior of the resource type. CloudFormation determines the
|
|
6838
|
-
*
|
|
6839
|
-
* package submitted.</p>
|
|
6698
|
+
* <p>For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type
|
|
6699
|
+
* during registration, based on the types of handlers in the schema handler package submitted.</p>
|
|
6840
6700
|
* <p>Valid values include:</p>
|
|
6841
6701
|
* <ul>
|
|
6842
6702
|
* <li>
|
|
6843
6703
|
* <p>
|
|
6844
|
-
* <code>FULLY_MUTABLE</code>: The resource type includes an update handler to process
|
|
6845
|
-
*
|
|
6704
|
+
* <code>FULLY_MUTABLE</code>: The resource type includes an update handler to process updates to the type during
|
|
6705
|
+
* stack update operations.</p>
|
|
6846
6706
|
* </li>
|
|
6847
6707
|
* <li>
|
|
6848
6708
|
* <p>
|
|
6849
|
-
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so the
|
|
6850
|
-
*
|
|
6709
|
+
* <code>IMMUTABLE</code>: The resource type doesn't include an update handler, so the type can't be updated and
|
|
6710
|
+
* must instead be replaced during stack update operations.</p>
|
|
6851
6711
|
* </li>
|
|
6852
6712
|
* <li>
|
|
6853
6713
|
* <p>
|
|
6854
|
-
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include create, read, and
|
|
6855
|
-
*
|
|
6714
|
+
* <code>NON_PROVISIONABLE</code>: The resource type doesn't include create, read, and delete handlers, and
|
|
6715
|
+
* therefore can't actually be provisioned.</p>
|
|
6856
6716
|
* </li>
|
|
6857
6717
|
* </ul>
|
|
6858
6718
|
* <p>The default is <code>FULLY_MUTABLE</code>.</p>
|
|
6859
6719
|
*/
|
|
6860
6720
|
ProvisioningType?: ProvisioningType | string;
|
|
6861
6721
|
/**
|
|
6862
|
-
* <p>The deprecation status of the extension that you want to get summary information
|
|
6863
|
-
* about.</p>
|
|
6722
|
+
* <p>The deprecation status of the extension that you want to get summary information about.</p>
|
|
6864
6723
|
* <p>Valid values include:</p>
|
|
6865
6724
|
* <ul>
|
|
6866
6725
|
* <li>
|
|
6867
6726
|
* <p>
|
|
6868
|
-
* <code>LIVE</code>: The extension is registered for use in CloudFormation
|
|
6869
|
-
* operations.</p>
|
|
6727
|
+
* <code>LIVE</code>: The extension is registered for use in CloudFormation operations.</p>
|
|
6870
6728
|
* </li>
|
|
6871
6729
|
* <li>
|
|
6872
6730
|
* <p>
|
|
6873
|
-
* <code>DEPRECATED</code>: The extension has been deregistered and can no longer be used
|
|
6874
|
-
* in CloudFormation operations.</p>
|
|
6731
|
+
* <code>DEPRECATED</code>: The extension has been deregistered and can no longer be used in CloudFormation operations.</p>
|
|
6875
6732
|
* </li>
|
|
6876
6733
|
* </ul>
|
|
6877
6734
|
*/
|
|
@@ -6882,25 +6739,22 @@ export interface ListTypesInput {
|
|
|
6882
6739
|
Type?: RegistryType | string;
|
|
6883
6740
|
/**
|
|
6884
6741
|
* <p>Filter criteria to use in determining which extensions to return.</p>
|
|
6885
|
-
* <p>Filters must be compatible with <code>Visibility</code> to return valid results. For
|
|
6886
|
-
*
|
|
6887
|
-
*
|
|
6888
|
-
* for <code>Visibility</code> returns the desired list.</p>
|
|
6742
|
+
* <p>Filters must be compatible with <code>Visibility</code> to return valid results. For example, specifying
|
|
6743
|
+
* <code>AWS_TYPES</code> for <code>Category</code> and <code>PRIVATE</code> for <code>Visibility</code> returns an
|
|
6744
|
+
* empty list of types, but specifying <code>PUBLIC</code> for <code>Visibility</code> returns the desired list.</p>
|
|
6889
6745
|
*/
|
|
6890
6746
|
Filters?: TypeFilters;
|
|
6891
6747
|
/**
|
|
6892
|
-
* <p>The maximum number of results to be returned with a single call. If the number of
|
|
6893
|
-
*
|
|
6894
|
-
*
|
|
6895
|
-
* results.</p>
|
|
6748
|
+
* <p>The maximum number of results to be returned with a single call. If the number of available results exceeds this
|
|
6749
|
+
* maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code>
|
|
6750
|
+
* request parameter to get the next set of results.</p>
|
|
6896
6751
|
*/
|
|
6897
6752
|
MaxResults?: number;
|
|
6898
6753
|
/**
|
|
6899
|
-
* <p>If the previous paginated request didn't return all the remaining results, the response
|
|
6900
|
-
*
|
|
6901
|
-
*
|
|
6902
|
-
*
|
|
6903
|
-
* object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6754
|
+
* <p>If the previous paginated request didn't return all the remaining results, the response object's
|
|
6755
|
+
* <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action
|
|
6756
|
+
* again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining
|
|
6757
|
+
* results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6904
6758
|
*/
|
|
6905
6759
|
NextToken?: string;
|
|
6906
6760
|
}
|
|
@@ -6925,9 +6779,7 @@ export interface TypeSummary {
|
|
|
6925
6779
|
* <p>This applies only to private extensions you have registered in your account. For public extensions, both those
|
|
6926
6780
|
* provided by Amazon and published by third parties, CloudFormation returns <code>null</code>. For more
|
|
6927
6781
|
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
6928
|
-
* <p>To set the default version of an extension, use <
|
|
6929
|
-
* <a>SetTypeDefaultVersion</a>
|
|
6930
|
-
* </code>.</p>
|
|
6782
|
+
* <p>To set the default version of an extension, use <a>SetTypeDefaultVersion</a>.</p>
|
|
6931
6783
|
*/
|
|
6932
6784
|
DefaultVersionId?: string;
|
|
6933
6785
|
/**
|
|
@@ -7007,15 +6859,13 @@ export interface TypeSummary {
|
|
|
7007
6859
|
*/
|
|
7008
6860
|
export interface ListTypesOutput {
|
|
7009
6861
|
/**
|
|
7010
|
-
* <p>A list of <code>TypeSummary</code> structures that contain information about the specified
|
|
7011
|
-
* extensions.</p>
|
|
6862
|
+
* <p>A list of <code>TypeSummary</code> structures that contain information about the specified extensions.</p>
|
|
7012
6863
|
*/
|
|
7013
6864
|
TypeSummaries?: TypeSummary[];
|
|
7014
6865
|
/**
|
|
7015
|
-
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to
|
|
7016
|
-
*
|
|
7017
|
-
*
|
|
7018
|
-
* <code>NextToken</code> is set to <code>null</code>.</p>
|
|
6866
|
+
* <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve
|
|
6867
|
+
* the next set of results, call this action again and assign that token to the request object's <code>NextToken</code>
|
|
6868
|
+
* parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
|
|
7019
6869
|
*/
|
|
7020
6870
|
NextToken?: string;
|
|
7021
6871
|
}
|
|
@@ -7025,52 +6875,44 @@ export interface ListTypesOutput {
|
|
|
7025
6875
|
export interface ListTypeVersionsInput {
|
|
7026
6876
|
/**
|
|
7027
6877
|
* <p>The kind of the extension.</p>
|
|
7028
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
7029
|
-
* <code>Arn</code>.</p>
|
|
6878
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
7030
6879
|
*/
|
|
7031
6880
|
Type?: RegistryType | string;
|
|
7032
6881
|
/**
|
|
7033
6882
|
* <p>The name of the extension for which you want version summary information.</p>
|
|
7034
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
7035
|
-
* <code>Arn</code>.</p>
|
|
6883
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
7036
6884
|
*/
|
|
7037
6885
|
TypeName?: string;
|
|
7038
6886
|
/**
|
|
7039
|
-
* <p>The Amazon Resource Name (ARN) of the extension for which you want version summary
|
|
7040
|
-
*
|
|
7041
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
7042
|
-
* <code>Arn</code>.</p>
|
|
6887
|
+
* <p>The Amazon Resource Name (ARN) of the extension for which you want version summary information.</p>
|
|
6888
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
7043
6889
|
*/
|
|
7044
6890
|
Arn?: string;
|
|
7045
6891
|
/**
|
|
7046
|
-
* <p>The maximum number of results to be returned with a single call. If the number of
|
|
7047
|
-
*
|
|
7048
|
-
*
|
|
7049
|
-
* results.</p>
|
|
6892
|
+
* <p>The maximum number of results to be returned with a single call. If the number of available results exceeds this
|
|
6893
|
+
* maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code>
|
|
6894
|
+
* request parameter to get the next set of results.</p>
|
|
7050
6895
|
*/
|
|
7051
6896
|
MaxResults?: number;
|
|
7052
6897
|
/**
|
|
7053
|
-
* <p>If the previous paginated request didn't return all of the remaining results, the response
|
|
7054
|
-
*
|
|
7055
|
-
*
|
|
7056
|
-
*
|
|
7057
|
-
* object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
6898
|
+
* <p>If the previous paginated request didn't return all of the remaining results, the response object's
|
|
6899
|
+
* <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action
|
|
6900
|
+
* again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining
|
|
6901
|
+
* results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
|
|
7058
6902
|
*/
|
|
7059
6903
|
NextToken?: string;
|
|
7060
6904
|
/**
|
|
7061
|
-
* <p>The deprecation status of the extension versions that you want to get summary information
|
|
7062
|
-
* about.</p>
|
|
6905
|
+
* <p>The deprecation status of the extension versions that you want to get summary information about.</p>
|
|
7063
6906
|
* <p>Valid values include:</p>
|
|
7064
6907
|
* <ul>
|
|
7065
6908
|
* <li>
|
|
7066
6909
|
* <p>
|
|
7067
|
-
* <code>LIVE</code>: The extension version is registered and can be used in CloudFormation operations,
|
|
7068
|
-
*
|
|
6910
|
+
* <code>LIVE</code>: The extension version is registered and can be used in CloudFormation operations,
|
|
6911
|
+
* dependent on its provisioning behavior and visibility scope.</p>
|
|
7069
6912
|
* </li>
|
|
7070
6913
|
* <li>
|
|
7071
6914
|
* <p>
|
|
7072
|
-
* <code>DEPRECATED</code>: The extension version has been deregistered and can no longer
|
|
7073
|
-
* be used in CloudFormation operations.</p>
|
|
6915
|
+
* <code>DEPRECATED</code>: The extension version has been deregistered and can no longer be used in CloudFormation operations.</p>
|
|
7074
6916
|
* </li>
|
|
7075
6917
|
* </ul>
|
|
7076
6918
|
* <p>The default is <code>LIVE</code>.</p>
|
|
@@ -7134,15 +6976,15 @@ export interface TypeVersionSummary {
|
|
|
7134
6976
|
*/
|
|
7135
6977
|
export interface ListTypeVersionsOutput {
|
|
7136
6978
|
/**
|
|
7137
|
-
* <p>A list of <code>TypeVersionSummary</code> structures that contain information about the
|
|
7138
|
-
*
|
|
6979
|
+
* <p>A list of <code>TypeVersionSummary</code> structures that contain information about the specified extension's
|
|
6980
|
+
* versions.</p>
|
|
7139
6981
|
*/
|
|
7140
6982
|
TypeVersionSummaries?: TypeVersionSummary[];
|
|
7141
6983
|
/**
|
|
7142
|
-
* <p>If the request doesn't return all of the remaining results, <code>NextToken</code> is set
|
|
7143
|
-
*
|
|
7144
|
-
*
|
|
7145
|
-
*
|
|
6984
|
+
* <p>If the request doesn't return all of the remaining results, <code>NextToken</code> is set to a token. To
|
|
6985
|
+
* retrieve the next set of results, call this action again and assign that token to the request object's
|
|
6986
|
+
* <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to
|
|
6987
|
+
* <code>null</code>.</p>
|
|
7146
6988
|
*/
|
|
7147
6989
|
NextToken?: string;
|
|
7148
6990
|
}
|
|
@@ -7152,35 +6994,31 @@ export interface ListTypeVersionsOutput {
|
|
|
7152
6994
|
export interface PublishTypeInput {
|
|
7153
6995
|
/**
|
|
7154
6996
|
* <p>The type of the extension.</p>
|
|
7155
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7156
|
-
* <code>Type</code>.</p>
|
|
6997
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
7157
6998
|
*/
|
|
7158
6999
|
Type?: ThirdPartyType | string;
|
|
7159
7000
|
/**
|
|
7160
7001
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
7161
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7162
|
-
* <code>Type</code>.</p>
|
|
7002
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
7163
7003
|
*/
|
|
7164
7004
|
Arn?: string;
|
|
7165
7005
|
/**
|
|
7166
7006
|
* <p>The name of the extension.</p>
|
|
7167
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7168
|
-
* <code>Type</code>.</p>
|
|
7007
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
7169
7008
|
*/
|
|
7170
7009
|
TypeName?: string;
|
|
7171
7010
|
/**
|
|
7172
7011
|
* <p>The version number to assign to this version of the extension.</p>
|
|
7173
|
-
* <p>Use the following format, and adhere to semantic versioning when assigning a version
|
|
7174
|
-
*
|
|
7012
|
+
* <p>Use the following format, and adhere to semantic versioning when assigning a version number to your
|
|
7013
|
+
* extension:</p>
|
|
7175
7014
|
* <p>
|
|
7176
7015
|
* <code>MAJOR.MINOR.PATCH</code>
|
|
7177
7016
|
* </p>
|
|
7178
|
-
* <p>For more information, see <a href="https://semver.org/">Semantic Versioning
|
|
7179
|
-
*
|
|
7180
|
-
*
|
|
7181
|
-
*
|
|
7182
|
-
*
|
|
7183
|
-
* automatically sets the first version number to be <code>1.0.0</code>.</p>
|
|
7017
|
+
* <p>For more information, see <a href="https://semver.org/">Semantic Versioning 2.0.0</a>.</p>
|
|
7018
|
+
* <p>If you don't specify a version number, CloudFormation increments the version number by one minor
|
|
7019
|
+
* version release.</p>
|
|
7020
|
+
* <p>You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first
|
|
7021
|
+
* version number to be <code>1.0.0</code>.</p>
|
|
7184
7022
|
*/
|
|
7185
7023
|
PublicVersionNumber?: string;
|
|
7186
7024
|
}
|
|
@@ -7269,31 +7107,38 @@ export type HandlerErrorCode = (typeof HandlerErrorCode)[keyof typeof HandlerErr
|
|
|
7269
7107
|
*/
|
|
7270
7108
|
export interface RecordHandlerProgressInput {
|
|
7271
7109
|
/**
|
|
7272
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7110
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7111
|
+
* CLI</a>.</p>
|
|
7273
7112
|
*/
|
|
7274
7113
|
BearerToken: string | undefined;
|
|
7275
7114
|
/**
|
|
7276
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7115
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7116
|
+
* CLI</a>.</p>
|
|
7277
7117
|
*/
|
|
7278
7118
|
OperationStatus: OperationStatus | string | undefined;
|
|
7279
7119
|
/**
|
|
7280
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7120
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7121
|
+
* CLI</a>.</p>
|
|
7281
7122
|
*/
|
|
7282
7123
|
CurrentOperationStatus?: OperationStatus | string;
|
|
7283
7124
|
/**
|
|
7284
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7125
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7126
|
+
* CLI</a>.</p>
|
|
7285
7127
|
*/
|
|
7286
7128
|
StatusMessage?: string;
|
|
7287
7129
|
/**
|
|
7288
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7130
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7131
|
+
* CLI</a>.</p>
|
|
7289
7132
|
*/
|
|
7290
7133
|
ErrorCode?: HandlerErrorCode | string;
|
|
7291
7134
|
/**
|
|
7292
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7135
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7136
|
+
* CLI</a>.</p>
|
|
7293
7137
|
*/
|
|
7294
7138
|
ResourceModel?: string;
|
|
7295
7139
|
/**
|
|
7296
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7140
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation
|
|
7141
|
+
* CLI</a>.</p>
|
|
7297
7142
|
*/
|
|
7298
7143
|
ClientRequestToken?: string;
|
|
7299
7144
|
}
|
|
@@ -7307,17 +7152,18 @@ export interface RecordHandlerProgressOutput {
|
|
|
7307
7152
|
*/
|
|
7308
7153
|
export interface RegisterPublisherInput {
|
|
7309
7154
|
/**
|
|
7310
|
-
* <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
|
|
7311
|
-
*
|
|
7312
|
-
*
|
|
7155
|
+
* <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 registry. You must accept the
|
|
7156
|
+
* terms and conditions in order to register to publish public extensions to the CloudFormation
|
|
7157
|
+
* registry.</p>
|
|
7313
7158
|
* <p>The default is <code>false</code>.</p>
|
|
7314
7159
|
*/
|
|
7315
7160
|
AcceptTermsAndConditions?: boolean;
|
|
7316
7161
|
/**
|
|
7317
|
-
* <p>If you are using a Bitbucket or GitHub account for identity verification, the Amazon
|
|
7318
|
-
*
|
|
7319
|
-
* <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
|
|
7320
|
-
*
|
|
7162
|
+
* <p>If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for
|
|
7163
|
+
* your connection to that account.</p>
|
|
7164
|
+
* <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
|
|
7165
|
+
* to publish CloudFormation extensions</a> in the <i>CloudFormation CLI User
|
|
7166
|
+
* Guide</i>.</p>
|
|
7321
7167
|
*/
|
|
7322
7168
|
ConnectionArn?: string;
|
|
7323
7169
|
}
|
|
@@ -7344,20 +7190,19 @@ export interface RegisterTypeInput {
|
|
|
7344
7190
|
* <ul>
|
|
7345
7191
|
* <li>
|
|
7346
7192
|
* <p>For resource types,
|
|
7347
|
-
*
|
|
7193
|
+
* <i>company_or_organization</i>::<i>service</i>::<i>type</i>.</p>
|
|
7348
7194
|
* </li>
|
|
7349
7195
|
* <li>
|
|
7350
7196
|
* <p>For modules,
|
|
7351
|
-
*
|
|
7197
|
+
* <i>company_or_organization</i>::<i>service</i>::<i>type</i>::MODULE.</p>
|
|
7352
7198
|
* </li>
|
|
7353
7199
|
* <li>
|
|
7354
7200
|
* <p>For hooks,
|
|
7355
|
-
*
|
|
7201
|
+
* <i>MyCompany</i>::<i>Testing</i>::<i>MyTestHook</i>.</p>
|
|
7356
7202
|
* </li>
|
|
7357
7203
|
* </ul>
|
|
7358
7204
|
* <note>
|
|
7359
|
-
* <p>The following organization namespaces are reserved and can't be used in your extension
|
|
7360
|
-
* names:</p>
|
|
7205
|
+
* <p>The following organization namespaces are reserved and can't be used in your extension names:</p>
|
|
7361
7206
|
* <ul>
|
|
7362
7207
|
* <li>
|
|
7363
7208
|
* <p>
|
|
@@ -7394,17 +7239,15 @@ export interface RegisterTypeInput {
|
|
|
7394
7239
|
*/
|
|
7395
7240
|
TypeName: string | undefined;
|
|
7396
7241
|
/**
|
|
7397
|
-
* <p>A URL to the S3 bucket containing the extension project package that contains the
|
|
7398
|
-
*
|
|
7399
|
-
* <p>For information about generating a schema handler package for the extension you want to
|
|
7400
|
-
*
|
|
7401
|
-
* the <i>CloudFormation CLI User Guide</i>.</p>
|
|
7242
|
+
* <p>A URL to the S3 bucket containing the extension project package that contains the necessary files for the
|
|
7243
|
+
* extension you want to register.</p>
|
|
7244
|
+
* <p>For information about generating a schema handler package for the extension you want to register, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html">submit</a> in the
|
|
7245
|
+
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
7402
7246
|
* <note>
|
|
7403
|
-
* <p>The user registering the extension must be able to access the package in the S3 bucket.
|
|
7404
|
-
*
|
|
7405
|
-
*
|
|
7406
|
-
*
|
|
7407
|
-
* Guide</i>.</p>
|
|
7247
|
+
* <p>The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs
|
|
7248
|
+
* to have <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> permissions for
|
|
7249
|
+
* the 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 for Amazon S3</a>
|
|
7250
|
+
* in the <i>Identity and Access Management User Guide</i>.</p>
|
|
7408
7251
|
* </note>
|
|
7409
7252
|
*/
|
|
7410
7253
|
SchemaHandlerPackage: string | undefined;
|
|
@@ -7413,29 +7256,25 @@ export interface RegisterTypeInput {
|
|
|
7413
7256
|
*/
|
|
7414
7257
|
LoggingConfig?: LoggingConfig;
|
|
7415
7258
|
/**
|
|
7416
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation
|
|
7417
|
-
*
|
|
7418
|
-
* <p>For CloudFormation to assume the specified execution role, the role must contain
|
|
7419
|
-
*
|
|
7420
|
-
*
|
|
7421
|
-
*
|
|
7422
|
-
*
|
|
7423
|
-
* <p>If your extension calls Amazon Web Services APIs in any of its handlers, you must create an
|
|
7424
|
-
* <i>
|
|
7259
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when
|
|
7260
|
+
* invoking the extension.</p>
|
|
7261
|
+
* <p>For CloudFormation to assume the specified execution role, the role must contain a trust relationship
|
|
7262
|
+
* with the CloudFormation service principle (<code>resources.cloudformation.amazonaws.com</code>). For more
|
|
7263
|
+
* information about adding trust relationships, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy">Modifying a
|
|
7264
|
+
* role trust policy</a> in the <i>Identity and Access Management User Guide</i>.</p>
|
|
7265
|
+
* <p>If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <i>
|
|
7425
7266
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a>
|
|
7426
|
-
* </i>
|
|
7427
|
-
*
|
|
7428
|
-
*
|
|
7429
|
-
*
|
|
7430
|
-
*
|
|
7431
|
-
* credentials.</p>
|
|
7267
|
+
* </i>
|
|
7268
|
+
* that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in
|
|
7269
|
+
* your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this
|
|
7270
|
+
* execution role to create a temporary session token, which it then passes to the resource type handler, thereby
|
|
7271
|
+
* supplying your resource type with the appropriate credentials.</p>
|
|
7432
7272
|
*/
|
|
7433
7273
|
ExecutionRoleArn?: string;
|
|
7434
7274
|
/**
|
|
7435
|
-
* <p>A unique identifier that acts as an idempotency key for this registration request.
|
|
7436
|
-
*
|
|
7437
|
-
*
|
|
7438
|
-
* submitted multiple times.</p>
|
|
7275
|
+
* <p>A unique identifier that acts as an idempotency key for this registration request. Specifying a client request
|
|
7276
|
+
* token prevents CloudFormation from generating more than one version of an extension from the same
|
|
7277
|
+
* registration request, even if the request is submitted multiple times.</p>
|
|
7439
7278
|
*/
|
|
7440
7279
|
ClientRequestToken?: string;
|
|
7441
7280
|
}
|
|
@@ -7445,10 +7284,8 @@ export interface RegisterTypeInput {
|
|
|
7445
7284
|
export interface RegisterTypeOutput {
|
|
7446
7285
|
/**
|
|
7447
7286
|
* <p>The identifier for this registration request.</p>
|
|
7448
|
-
* <p>Use this registration token when calling <
|
|
7449
|
-
*
|
|
7450
|
-
* </code>, which returns information about the status and IDs of the extension
|
|
7451
|
-
* registration.</p>
|
|
7287
|
+
* <p>Use this registration token when calling <a>DescribeTypeRegistration</a>, which returns information
|
|
7288
|
+
* about the status and IDs of the extension registration.</p>
|
|
7452
7289
|
*/
|
|
7453
7290
|
RegistrationToken?: string;
|
|
7454
7291
|
}
|
|
@@ -7461,8 +7298,8 @@ export interface RollbackStackInput {
|
|
|
7461
7298
|
*/
|
|
7462
7299
|
StackName: string | undefined;
|
|
7463
7300
|
/**
|
|
7464
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation
|
|
7465
|
-
*
|
|
7301
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the
|
|
7302
|
+
* stack.</p>
|
|
7466
7303
|
*/
|
|
7467
7304
|
RoleARN?: string;
|
|
7468
7305
|
/**
|
|
@@ -7489,17 +7326,15 @@ export interface SetStackPolicyInput {
|
|
|
7489
7326
|
*/
|
|
7490
7327
|
StackName: string | undefined;
|
|
7491
7328
|
/**
|
|
7492
|
-
* <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">
|
|
7493
|
-
*
|
|
7494
|
-
*
|
|
7495
|
-
* both.</p>
|
|
7329
|
+
* <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 to stack resources</a> in
|
|
7330
|
+
* the CloudFormation User Guide. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code>
|
|
7331
|
+
* parameter, but not both.</p>
|
|
7496
7332
|
*/
|
|
7497
7333
|
StackPolicyBody?: string;
|
|
7498
7334
|
/**
|
|
7499
|
-
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum
|
|
7500
|
-
*
|
|
7501
|
-
*
|
|
7502
|
-
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7335
|
+
* <p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
|
|
7336
|
+
* an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the
|
|
7337
|
+
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7503
7338
|
*/
|
|
7504
7339
|
StackPolicyURL?: string;
|
|
7505
7340
|
}
|
|
@@ -7509,37 +7344,38 @@ export interface SetStackPolicyInput {
|
|
|
7509
7344
|
export interface SetTypeConfigurationInput {
|
|
7510
7345
|
/**
|
|
7511
7346
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and Region.</p>
|
|
7512
|
-
* <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>
|
|
7513
|
-
*
|
|
7514
|
-
*
|
|
7515
|
-
*
|
|
7516
|
-
*
|
|
7517
|
-
* configuration for an extension, but not for a specific extension version.</p>
|
|
7347
|
+
* <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
|
|
7348
|
+
* Region. For private extensions, this will 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
|
|
7349
|
+
* Region.</p>
|
|
7350
|
+
* <p>Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an
|
|
7351
|
+
* extension, but not for a specific extension version.</p>
|
|
7518
7352
|
*/
|
|
7519
7353
|
TypeArn?: string;
|
|
7520
7354
|
/**
|
|
7521
7355
|
* <p>The configuration data for the extension, in this account and Region.</p>
|
|
7522
|
-
* <p>The configuration data must be formatted as JSON, and validate against the schema returned
|
|
7523
|
-
*
|
|
7524
|
-
*
|
|
7356
|
+
* <p>The configuration data must be formatted as JSON, and validate against the schema returned in the
|
|
7357
|
+
* <code>ConfigurationSchema</code> response element of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>. For more information, see
|
|
7358
|
+
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration">Defining
|
|
7359
|
+
* account-level configuration data for an extension</a> in the <i>CloudFormation CLI User
|
|
7360
|
+
* Guide</i>.</p>
|
|
7525
7361
|
*/
|
|
7526
7362
|
Configuration: string | undefined;
|
|
7527
7363
|
/**
|
|
7528
7364
|
* <p>An alias by which to refer to this extension configuration data.</p>
|
|
7529
|
-
* <p>Conditional: Specifying a configuration alias is required when setting a configuration for
|
|
7530
|
-
*
|
|
7365
|
+
* <p>Conditional: Specifying a configuration alias is required when setting a configuration for a resource type
|
|
7366
|
+
* extension.</p>
|
|
7531
7367
|
*/
|
|
7532
7368
|
ConfigurationAlias?: string;
|
|
7533
7369
|
/**
|
|
7534
7370
|
* <p>The name of the extension.</p>
|
|
7535
7371
|
* <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
|
|
7536
|
-
*
|
|
7372
|
+
* <code>TypeName</code>.</p>
|
|
7537
7373
|
*/
|
|
7538
7374
|
TypeName?: string;
|
|
7539
7375
|
/**
|
|
7540
7376
|
* <p>The type of extension.</p>
|
|
7541
7377
|
* <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
|
|
7542
|
-
*
|
|
7378
|
+
* <code>TypeName</code>.</p>
|
|
7543
7379
|
*/
|
|
7544
7380
|
Type?: ThirdPartyType | string;
|
|
7545
7381
|
}
|
|
@@ -7548,10 +7384,9 @@ export interface SetTypeConfigurationInput {
|
|
|
7548
7384
|
*/
|
|
7549
7385
|
export interface SetTypeConfigurationOutput {
|
|
7550
7386
|
/**
|
|
7551
|
-
* <p>The Amazon Resource Name (ARN) for the configuration data, in this account and
|
|
7552
|
-
* Region.</p>
|
|
7387
|
+
* <p>The Amazon Resource Name (ARN) for the configuration data, in this account and Region.</p>
|
|
7553
7388
|
* <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
|
|
7554
|
-
*
|
|
7389
|
+
* <code>TypeName</code>.</p>
|
|
7555
7390
|
*/
|
|
7556
7391
|
ConfigurationArn?: string;
|
|
7557
7392
|
}
|
|
@@ -7560,27 +7395,23 @@ export interface SetTypeConfigurationOutput {
|
|
|
7560
7395
|
*/
|
|
7561
7396
|
export interface SetTypeDefaultVersionInput {
|
|
7562
7397
|
/**
|
|
7563
|
-
* <p>The Amazon Resource Name (ARN) of the extension for which you want version summary
|
|
7564
|
-
*
|
|
7565
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
7566
|
-
* <code>Arn</code>.</p>
|
|
7398
|
+
* <p>The Amazon Resource Name (ARN) of the extension for which you want version summary information.</p>
|
|
7399
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
7567
7400
|
*/
|
|
7568
7401
|
Arn?: string;
|
|
7569
7402
|
/**
|
|
7570
7403
|
* <p>The kind of extension.</p>
|
|
7571
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
7572
|
-
* <code>Arn</code>.</p>
|
|
7404
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
7573
7405
|
*/
|
|
7574
7406
|
Type?: RegistryType | string;
|
|
7575
7407
|
/**
|
|
7576
7408
|
* <p>The name of the extension.</p>
|
|
7577
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
|
7578
|
-
* <code>Arn</code>.</p>
|
|
7409
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
|
|
7579
7410
|
*/
|
|
7580
7411
|
TypeName?: string;
|
|
7581
7412
|
/**
|
|
7582
|
-
* <p>The ID of a specific version of the extension. The version ID is the value at the end of
|
|
7583
|
-
*
|
|
7413
|
+
* <p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource
|
|
7414
|
+
* Name (ARN) assigned to the extension version when it is registered.</p>
|
|
7584
7415
|
*/
|
|
7585
7416
|
VersionId?: string;
|
|
7586
7417
|
}
|
|
@@ -7607,24 +7438,23 @@ export type ResourceSignalStatus = (typeof ResourceSignalStatus)[keyof typeof Re
|
|
|
7607
7438
|
*/
|
|
7608
7439
|
export interface SignalResourceInput {
|
|
7609
7440
|
/**
|
|
7610
|
-
* <p>The stack name or unique stack ID that includes the resource that you want to
|
|
7611
|
-
* signal.</p>
|
|
7441
|
+
* <p>The stack name or unique stack ID that includes the resource that you want to signal.</p>
|
|
7612
7442
|
*/
|
|
7613
7443
|
StackName: string | undefined;
|
|
7614
7444
|
/**
|
|
7615
|
-
* <p>The logical ID of the resource that you want to signal. The logical ID is the name of the
|
|
7616
|
-
*
|
|
7445
|
+
* <p>The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in
|
|
7446
|
+
* the template.</p>
|
|
7617
7447
|
*/
|
|
7618
7448
|
LogicalResourceId: string | undefined;
|
|
7619
7449
|
/**
|
|
7620
|
-
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the
|
|
7621
|
-
*
|
|
7622
|
-
*
|
|
7450
|
+
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the
|
|
7451
|
+
* instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as
|
|
7452
|
+
* signaling a wait condition), each signal requires a different unique ID.</p>
|
|
7623
7453
|
*/
|
|
7624
7454
|
UniqueId: string | undefined;
|
|
7625
7455
|
/**
|
|
7626
|
-
* <p>The status of the signal, which is either success or failure. A failure signal causes
|
|
7627
|
-
*
|
|
7456
|
+
* <p>The status of the signal, which is either success or failure. A failure signal causes CloudFormation to
|
|
7457
|
+
* immediately fail the stack creation or update.</p>
|
|
7628
7458
|
*/
|
|
7629
7459
|
Status: ResourceSignalStatus | string | undefined;
|
|
7630
7460
|
}
|
|
@@ -7669,38 +7499,33 @@ export interface StopStackSetOperationOutput {
|
|
|
7669
7499
|
export interface TestTypeInput {
|
|
7670
7500
|
/**
|
|
7671
7501
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
|
7672
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7673
|
-
* <code>Type</code>.</p>
|
|
7502
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
7674
7503
|
*/
|
|
7675
7504
|
Arn?: string;
|
|
7676
7505
|
/**
|
|
7677
7506
|
* <p>The type of the extension to test.</p>
|
|
7678
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7679
|
-
* <code>Type</code>.</p>
|
|
7507
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
7680
7508
|
*/
|
|
7681
7509
|
Type?: ThirdPartyType | string;
|
|
7682
7510
|
/**
|
|
7683
7511
|
* <p>The name of the extension to test.</p>
|
|
7684
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
|
7685
|
-
* <code>Type</code>.</p>
|
|
7512
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
|
|
7686
7513
|
*/
|
|
7687
7514
|
TypeName?: string;
|
|
7688
7515
|
/**
|
|
7689
7516
|
* <p>The version of the extension to test.</p>
|
|
7690
|
-
* <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code>
|
|
7691
|
-
*
|
|
7692
|
-
* <p>If you don't specify a version, CloudFormation uses the default version of the
|
|
7693
|
-
*
|
|
7517
|
+
* <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and
|
|
7518
|
+
* <code>Type</code>.</p>
|
|
7519
|
+
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in this
|
|
7520
|
+
* account and Region for testing.</p>
|
|
7694
7521
|
*/
|
|
7695
7522
|
VersionId?: string;
|
|
7696
7523
|
/**
|
|
7697
|
-
* <p>The S3 bucket to which CloudFormation delivers the contract test execution
|
|
7698
|
-
*
|
|
7699
|
-
*
|
|
7700
|
-
*
|
|
7701
|
-
*
|
|
7702
|
-
* <p>The user calling <code>TestType</code> must be able to access items in the specified S3
|
|
7703
|
-
* bucket. Specifically, the user needs the following permissions:</p>
|
|
7524
|
+
* <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
|
|
7525
|
+
* <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been
|
|
7526
|
+
* assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
|
|
7527
|
+
* <p>The user calling <code>TestType</code> must be able to access items in the specified S3 bucket. Specifically,
|
|
7528
|
+
* the user needs the following permissions:</p>
|
|
7704
7529
|
* <ul>
|
|
7705
7530
|
* <li>
|
|
7706
7531
|
* <p>
|
|
@@ -7713,9 +7538,7 @@ export interface TestTypeInput {
|
|
|
7713
7538
|
* </p>
|
|
7714
7539
|
* </li>
|
|
7715
7540
|
* </ul>
|
|
7716
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and
|
|
7717
|
-
* Condition Keys for Amazon S3</a> in the <i>Amazon Web Services Identity
|
|
7718
|
-
* and Access Management User Guide</i>.</p>
|
|
7541
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
7719
7542
|
*/
|
|
7720
7543
|
LogDeliveryBucket?: string;
|
|
7721
7544
|
}
|
|
@@ -7738,96 +7561,88 @@ export interface UpdateStackInput {
|
|
|
7738
7561
|
*/
|
|
7739
7562
|
StackName: string | undefined;
|
|
7740
7563
|
/**
|
|
7741
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
7742
|
-
*
|
|
7743
|
-
*
|
|
7744
|
-
* <p>Conditional: You must specify only one of the following parameters:
|
|
7745
|
-
*
|
|
7746
|
-
* <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
7564
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
|
7565
|
+
* (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
7566
|
+
* CloudFormation User Guide.)</p>
|
|
7567
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
7568
|
+
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
7747
7569
|
*/
|
|
7748
7570
|
TemplateBody?: string;
|
|
7749
7571
|
/**
|
|
7750
|
-
* <p>Location of file containing the template body. The URL must point to a template that's
|
|
7751
|
-
*
|
|
7752
|
-
*
|
|
7753
|
-
*
|
|
7754
|
-
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
|
7755
|
-
* <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
7572
|
+
* <p>Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
7573
|
+
* CloudFormation User Guide.</p>
|
|
7574
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
7575
|
+
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
7756
7576
|
*/
|
|
7757
7577
|
TemplateURL?: string;
|
|
7758
7578
|
/**
|
|
7759
|
-
* <p>Reuse the existing template that is associated with the stack that you are
|
|
7760
|
-
*
|
|
7761
|
-
*
|
|
7762
|
-
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
|
7763
|
-
* <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
7579
|
+
* <p>Reuse the existing template that is associated with the stack that you are updating.</p>
|
|
7580
|
+
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>,
|
|
7581
|
+
* <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
|
7764
7582
|
*/
|
|
7765
7583
|
UsePreviousTemplate?: boolean;
|
|
7766
7584
|
/**
|
|
7767
|
-
* <p>Structure containing the temporary overriding stack policy body. You can specify either
|
|
7768
|
-
*
|
|
7769
|
-
*
|
|
7770
|
-
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
|
7771
|
-
*
|
|
7772
|
-
* with the stack will be used.</p>
|
|
7585
|
+
* <p>Structure containing the temporary overriding stack policy body. You can specify either the
|
|
7586
|
+
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not
|
|
7587
|
+
* both.</p>
|
|
7588
|
+
* <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If
|
|
7589
|
+
* you don't specify a stack policy, the current policy that is associated with the stack will be used.</p>
|
|
7773
7590
|
*/
|
|
7774
7591
|
StackPolicyDuringUpdateBody?: string;
|
|
7775
7592
|
/**
|
|
7776
|
-
* <p>Location of a file containing the temporary overriding stack policy. The URL must point to
|
|
7777
|
-
*
|
|
7778
|
-
*
|
|
7779
|
-
*
|
|
7780
|
-
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
|
7781
|
-
*
|
|
7782
|
-
* with the stack will be used.</p>
|
|
7593
|
+
* <p>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
|
|
7594
|
+
* 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the
|
|
7595
|
+
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not
|
|
7596
|
+
* both.</p>
|
|
7597
|
+
* <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If
|
|
7598
|
+
* you don't specify a stack policy, the current policy that is associated with the stack will be used.</p>
|
|
7783
7599
|
*/
|
|
7784
7600
|
StackPolicyDuringUpdateURL?: string;
|
|
7785
7601
|
/**
|
|
7786
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack.
|
|
7787
|
-
*
|
|
7788
|
-
*
|
|
7602
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information,
|
|
7603
|
+
* see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a>
|
|
7604
|
+
* data type.</p>
|
|
7789
7605
|
*/
|
|
7790
7606
|
Parameters?: Parameter[];
|
|
7791
7607
|
/**
|
|
7792
|
-
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
|
7793
|
-
*
|
|
7608
|
+
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
|
|
7609
|
+
* for CloudFormation to update the stack.</p>
|
|
7794
7610
|
* <ul>
|
|
7795
7611
|
* <li>
|
|
7796
7612
|
* <p>
|
|
7797
7613
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
|
7798
7614
|
* </p>
|
|
7799
|
-
* <p>Some stack templates might include resources that can affect permissions in your
|
|
7800
|
-
*
|
|
7801
|
-
*
|
|
7802
|
-
* <p>The following IAM resources require you to specify either the
|
|
7803
|
-
*
|
|
7615
|
+
* <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account;
|
|
7616
|
+
* for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must
|
|
7617
|
+
* explicitly acknowledge this by specifying one of these capabilities.</p>
|
|
7618
|
+
* <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or
|
|
7619
|
+
* <code>CAPABILITY_NAMED_IAM</code> capability.</p>
|
|
7804
7620
|
* <ul>
|
|
7805
7621
|
* <li>
|
|
7806
|
-
* <p>If you have IAM resources, you can specify either
|
|
7807
|
-
* capability.</p>
|
|
7622
|
+
* <p>If you have IAM resources, you can specify either capability.</p>
|
|
7808
7623
|
* </li>
|
|
7809
7624
|
* <li>
|
|
7810
|
-
* <p>If you have IAM resources with custom names, you
|
|
7811
|
-
*
|
|
7625
|
+
* <p>If you have IAM resources with custom names, you <i>must</i> specify
|
|
7626
|
+
* <code>CAPABILITY_NAMED_IAM</code>.</p>
|
|
7812
7627
|
* </li>
|
|
7813
7628
|
* <li>
|
|
7814
7629
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
|
7815
|
-
*
|
|
7630
|
+
* <code>InsufficientCapabilities</code> error.</p>
|
|
7816
7631
|
* </li>
|
|
7817
7632
|
* </ul>
|
|
7818
|
-
* <p>If your stack template contains these resources, we suggest that you review all
|
|
7819
|
-
*
|
|
7633
|
+
* <p>If your stack template contains these resources, we suggest that you review all permissions associated with
|
|
7634
|
+
* them and edit their permissions if necessary.</p>
|
|
7820
7635
|
* <ul>
|
|
7821
7636
|
* <li>
|
|
7822
7637
|
* <p>
|
|
7823
7638
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">
|
|
7824
|
-
*
|
|
7639
|
+
* AWS::IAM::AccessKey</a>
|
|
7825
7640
|
* </p>
|
|
7826
7641
|
* </li>
|
|
7827
7642
|
* <li>
|
|
7828
7643
|
* <p>
|
|
7829
7644
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">
|
|
7830
|
-
*
|
|
7645
|
+
* AWS::IAM::Group</a>
|
|
7831
7646
|
* </p>
|
|
7832
7647
|
* </li>
|
|
7833
7648
|
* <li>
|
|
@@ -7838,19 +7653,19 @@ export interface UpdateStackInput {
|
|
|
7838
7653
|
* <li>
|
|
7839
7654
|
* <p>
|
|
7840
7655
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">
|
|
7841
|
-
*
|
|
7656
|
+
* AWS::IAM::Policy</a>
|
|
7842
7657
|
* </p>
|
|
7843
7658
|
* </li>
|
|
7844
7659
|
* <li>
|
|
7845
7660
|
* <p>
|
|
7846
7661
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html">
|
|
7847
|
-
*
|
|
7662
|
+
* AWS::IAM::Role</a>
|
|
7848
7663
|
* </p>
|
|
7849
7664
|
* </li>
|
|
7850
7665
|
* <li>
|
|
7851
7666
|
* <p>
|
|
7852
7667
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">
|
|
7853
|
-
*
|
|
7668
|
+
* AWS::IAM::User</a>
|
|
7854
7669
|
* </p>
|
|
7855
7670
|
* </li>
|
|
7856
7671
|
* <li>
|
|
@@ -7859,93 +7674,86 @@ export interface UpdateStackInput {
|
|
|
7859
7674
|
* </p>
|
|
7860
7675
|
* </li>
|
|
7861
7676
|
* </ul>
|
|
7862
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
7677
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
7678
|
+
* IAM Resources in CloudFormation Templates</a>.</p>
|
|
7863
7679
|
* </li>
|
|
7864
7680
|
* <li>
|
|
7865
7681
|
* <p>
|
|
7866
7682
|
* <code>CAPABILITY_AUTO_EXPAND</code>
|
|
7867
7683
|
* </p>
|
|
7868
|
-
* <p>Some template contain macros. Macros perform custom processing on templates; this can
|
|
7869
|
-
*
|
|
7870
|
-
*
|
|
7871
|
-
*
|
|
7872
|
-
*
|
|
7873
|
-
*
|
|
7874
|
-
*
|
|
7875
|
-
*
|
|
7876
|
-
*
|
|
7877
|
-
* <i>and</i> nested stacks, you must update the stack directly from the
|
|
7878
|
-
* template using this capability.</p>
|
|
7684
|
+
* <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions
|
|
7685
|
+
* like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,
|
|
7686
|
+
* users typically create a change set from the processed template, so that they can review the changes resulting from
|
|
7687
|
+
* the macros before actually updating the stack. If your stack template contains one or more macros, and you choose
|
|
7688
|
+
* to update a stack directly from the processed template, without first reviewing the resulting changes in a change
|
|
7689
|
+
* set, you must acknowledge 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>
|
|
7690
|
+
* transforms, which are macros hosted by CloudFormation.</p>
|
|
7691
|
+
* <p>If you want to update a stack from a stack template that contains macros <i>and</i> nested
|
|
7692
|
+
* stacks, you must update the stack directly from the template using this capability.</p>
|
|
7879
7693
|
* <important>
|
|
7880
|
-
* <p>You should only update stacks directly from a stack template that contains macros if
|
|
7881
|
-
*
|
|
7882
|
-
* <p>Each macro relies on an underlying Lambda service function for
|
|
7883
|
-
*
|
|
7884
|
-
*
|
|
7694
|
+
* <p>You should only update stacks directly from a stack template that contains macros if you know what processing
|
|
7695
|
+
* the macro performs.</p>
|
|
7696
|
+
* <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be
|
|
7697
|
+
* aware that the Lambda function owner can update the function operation without CloudFormation being
|
|
7698
|
+
* notified.</p>
|
|
7885
7699
|
* </important>
|
|
7886
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
|
|
7887
|
-
*
|
|
7888
|
-
* Templates</a>.</p>
|
|
7700
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation Macros
|
|
7701
|
+
* to Perform Custom Processing on Templates</a>.</p>
|
|
7889
7702
|
* </li>
|
|
7890
7703
|
* </ul>
|
|
7891
7704
|
*/
|
|
7892
7705
|
Capabilities?: (Capability | string)[];
|
|
7893
7706
|
/**
|
|
7894
|
-
* <p>The template resource types that you have permissions to work with for this update stack
|
|
7895
|
-
*
|
|
7896
|
-
*
|
|
7897
|
-
*
|
|
7898
|
-
*
|
|
7899
|
-
*
|
|
7707
|
+
* <p>The template resource types that you have permissions to work with for this update stack action, such as
|
|
7708
|
+
* <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p>
|
|
7709
|
+
* <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By
|
|
7710
|
+
* default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)
|
|
7711
|
+
* uses this parameter for CloudFormation-specific condition keys in IAM policies. For more
|
|
7712
|
+
* 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>
|
|
7900
7713
|
*/
|
|
7901
7714
|
ResourceTypes?: string[];
|
|
7902
7715
|
/**
|
|
7903
|
-
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
|
|
7904
|
-
*
|
|
7905
|
-
*
|
|
7906
|
-
*
|
|
7907
|
-
*
|
|
7908
|
-
*
|
|
7909
|
-
*
|
|
7910
|
-
* associated with the stack. If no role is available, CloudFormation uses a temporary
|
|
7911
|
-
* session that is generated from your user credentials.</p>
|
|
7716
|
+
* <p>The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf.
|
|
7717
|
+
* CloudFormation always uses this role for all future operations on the stack. Provided that users have
|
|
7718
|
+
* permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to
|
|
7719
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
|
7720
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with the
|
|
7721
|
+
* stack. If no role is available, CloudFormation uses a temporary session that is generated from your user
|
|
7722
|
+
* credentials.</p>
|
|
7912
7723
|
*/
|
|
7913
7724
|
RoleARN?: string;
|
|
7914
7725
|
/**
|
|
7915
|
-
* <p>The rollback triggers for CloudFormation to monitor during stack creation and
|
|
7916
|
-
*
|
|
7726
|
+
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and
|
|
7727
|
+
* for the specified monitoring period afterwards.</p>
|
|
7917
7728
|
*/
|
|
7918
7729
|
RollbackConfiguration?: RollbackConfiguration;
|
|
7919
7730
|
/**
|
|
7920
|
-
* <p>Structure containing a new stack policy body. You can specify either the
|
|
7921
|
-
*
|
|
7922
|
-
*
|
|
7923
|
-
*
|
|
7924
|
-
*
|
|
7925
|
-
* that is associated with the stack is unchanged.</p>
|
|
7731
|
+
* <p>Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the
|
|
7732
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7733
|
+
* <p>You might update the stack policy, for example, in order to protect a new resource that you created during a
|
|
7734
|
+
* stack update. If you don't specify a stack policy, the current policy that is associated with the stack is
|
|
7735
|
+
* unchanged.</p>
|
|
7926
7736
|
*/
|
|
7927
7737
|
StackPolicyBody?: string;
|
|
7928
7738
|
/**
|
|
7929
|
-
* <p>Location of a file containing the updated stack policy. The URL must point to a policy
|
|
7930
|
-
*
|
|
7931
|
-
*
|
|
7932
|
-
*
|
|
7933
|
-
*
|
|
7934
|
-
*
|
|
7935
|
-
* that is associated with the stack is unchanged.</p>
|
|
7739
|
+
* <p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
|
|
7740
|
+
* in an S3 bucket in the same Region as the stack. You can specify either the <code>StackPolicyBody</code> or the
|
|
7741
|
+
* <code>StackPolicyURL</code> parameter, but not both.</p>
|
|
7742
|
+
* <p>You might update the stack policy, for example, in order to protect a new resource that you created during a
|
|
7743
|
+
* stack update. If you don't specify a stack policy, the current policy that is associated with the stack is
|
|
7744
|
+
* unchanged.</p>
|
|
7936
7745
|
*/
|
|
7937
7746
|
StackPolicyURL?: string;
|
|
7938
7747
|
/**
|
|
7939
|
-
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates
|
|
7940
|
-
*
|
|
7748
|
+
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates
|
|
7749
|
+
* with the stack. Specify an empty list to remove all notification topics.</p>
|
|
7941
7750
|
*/
|
|
7942
7751
|
NotificationARNs?: string[];
|
|
7943
7752
|
/**
|
|
7944
|
-
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these
|
|
7945
|
-
*
|
|
7946
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
|
7947
|
-
*
|
|
7948
|
-
* tags.</p>
|
|
7753
|
+
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported
|
|
7754
|
+
* resources in the stack. You can specify a maximum number of 50 tags.</p>
|
|
7755
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an
|
|
7756
|
+
* empty value, CloudFormation removes all associated tags.</p>
|
|
7949
7757
|
*/
|
|
7950
7758
|
Tags?: Tag[];
|
|
7951
7759
|
/**
|
|
@@ -7955,21 +7763,18 @@ export interface UpdateStackInput {
|
|
|
7955
7763
|
*/
|
|
7956
7764
|
DisableRollback?: boolean;
|
|
7957
7765
|
/**
|
|
7958
|
-
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you
|
|
7959
|
-
*
|
|
7960
|
-
*
|
|
7961
|
-
*
|
|
7962
|
-
*
|
|
7963
|
-
*
|
|
7964
|
-
*
|
|
7965
|
-
*
|
|
7966
|
-
*
|
|
7967
|
-
*
|
|
7968
|
-
*
|
|
7969
|
-
*
|
|
7970
|
-
* operation . For example, if you create a stack using the console, each stack event would be
|
|
7971
|
-
* assigned the same token in the following format:
|
|
7972
|
-
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
7766
|
+
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests
|
|
7767
|
+
* so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
|
|
7768
|
+
* <code>UpdateStack</code> requests to ensure that CloudFormation successfully received them.</p>
|
|
7769
|
+
* <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to
|
|
7770
|
+
* track operations. For example, if you execute a <code>CreateStack</code> operation with the token
|
|
7771
|
+
* <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have
|
|
7772
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
|
7773
|
+
* <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are
|
|
7774
|
+
* initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you
|
|
7775
|
+
* easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
|
|
7776
|
+
* assigned the same token in the following format:
|
|
7777
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
|
7973
7778
|
*/
|
|
7974
7779
|
ClientRequestToken?: string;
|
|
7975
7780
|
}
|
|
@@ -8378,8 +8183,7 @@ export interface UpdateTerminationProtectionInput {
|
|
|
8378
8183
|
*/
|
|
8379
8184
|
EnableTerminationProtection: boolean | undefined;
|
|
8380
8185
|
/**
|
|
8381
|
-
* <p>The name or unique ID of the stack for which you want to set termination
|
|
8382
|
-
* protection.</p>
|
|
8186
|
+
* <p>The name or unique ID of the stack for which you want to set termination protection.</p>
|
|
8383
8187
|
*/
|
|
8384
8188
|
StackName: string | undefined;
|
|
8385
8189
|
}
|
|
@@ -8398,20 +8202,18 @@ export interface UpdateTerminationProtectionOutput {
|
|
|
8398
8202
|
*/
|
|
8399
8203
|
export interface ValidateTemplateInput {
|
|
8400
8204
|
/**
|
|
8401
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
|
8402
|
-
*
|
|
8403
|
-
*
|
|
8404
|
-
*
|
|
8405
|
-
* are passed, only <code>TemplateBody</code> is used.</p>
|
|
8205
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
|
|
8206
|
+
* more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the CloudFormation User Guide.</p>
|
|
8207
|
+
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
8208
|
+
* <code>TemplateBody</code> is used.</p>
|
|
8406
8209
|
*/
|
|
8407
8210
|
TemplateBody?: string;
|
|
8408
8211
|
/**
|
|
8409
|
-
* <p>Location of file containing the template body. The URL must point to a template (max size:
|
|
8410
|
-
*
|
|
8411
|
-
*
|
|
8412
|
-
*
|
|
8413
|
-
*
|
|
8414
|
-
* are passed, only <code>TemplateBody</code> is used.</p>
|
|
8212
|
+
* <p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that
|
|
8213
|
+
* is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
|
|
8214
|
+
* CloudFormation User Guide.</p>
|
|
8215
|
+
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only
|
|
8216
|
+
* <code>TemplateBody</code> is used.</p>
|
|
8415
8217
|
*/
|
|
8416
8218
|
TemplateURL?: string;
|
|
8417
8219
|
}
|
|
@@ -8451,18 +8253,15 @@ export interface ValidateTemplateOutput {
|
|
|
8451
8253
|
*/
|
|
8452
8254
|
Description?: string;
|
|
8453
8255
|
/**
|
|
8454
|
-
* <p>The capabilities found within the template. If your template contains IAM
|
|
8455
|
-
*
|
|
8456
|
-
*
|
|
8457
|
-
*
|
|
8458
|
-
*
|
|
8459
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
|
|
8460
|
-
* IAM Resources in CloudFormation Templates</a>.</p>
|
|
8256
|
+
* <p>The capabilities found within the template. If your template contains IAM resources, you must
|
|
8257
|
+
* specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return
|
|
8258
|
+
* an InsufficientCapabilities error.</p>
|
|
8259
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
|
8260
|
+
* Resources in CloudFormation Templates</a>.</p>
|
|
8461
8261
|
*/
|
|
8462
8262
|
Capabilities?: (Capability | string)[];
|
|
8463
8263
|
/**
|
|
8464
|
-
* <p>The list of resources that generated the values in the <code>Capabilities</code> response
|
|
8465
|
-
* element.</p>
|
|
8264
|
+
* <p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>
|
|
8466
8265
|
*/
|
|
8467
8266
|
CapabilitiesReason?: string;
|
|
8468
8267
|
/**
|