@cdk8s/awscdk-resolver 0.0.185 → 0.0.187
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/.jsii +3 -3
- package/lib/resolve.js +1 -1
- package/node_modules/@aws-sdk/client-cloudformation/README.md +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/CloudFormation.d.ts +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/CloudFormationClient.d.ts +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ActivateOrganizationsAccessCommand.d.ts +3 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ActivateTypeCommand.d.ts +4 -6
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +5 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +10 -8
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/CreateChangeSetCommand.d.ts +19 -13
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/CreateGeneratedTemplateCommand.d.ts +3 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/CreateStackCommand.d.ts +5 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/CreateStackInstancesCommand.d.ts +4 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DeactivateOrganizationsAccessCommand.d.ts +3 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DeactivateTypeCommand.d.ts +6 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DeleteChangeSetCommand.d.ts +6 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DeleteStackCommand.d.ts +5 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DeleteStackSetCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DeregisterTypeCommand.d.ts +10 -8
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeAccountLimitsCommand.d.ts +2 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeChangeSetCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeGeneratedTemplateCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeOrganizationsAccessCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribePublisherCommand.d.ts +6 -5
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStackDriftDetectionStatusCommand.d.ts +11 -8
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStackEventsCommand.d.ts +5 -5
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStackInstanceCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStackResourceCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +11 -7
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStackResourcesCommand.d.ts +14 -12
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeStacksCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeTypeCommand.d.ts +3 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DescribeTypeRegistrationCommand.d.ts +7 -5
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DetectStackDriftCommand.d.ts +21 -16
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DetectStackResourceDriftCommand.d.ts +12 -9
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/DetectStackSetDriftCommand.d.ts +24 -18
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/EstimateTemplateCostCommand.d.ts +3 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ExecuteChangeSetCommand.d.ts +9 -9
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/GetGeneratedTemplateCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/GetStackPolicyCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/GetTemplateCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/GetTemplateSummaryCommand.d.ts +8 -7
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ImportStacksToStackSetCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListChangeSetsCommand.d.ts +3 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListExportsCommand.d.ts +5 -5
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListImportsCommand.d.ts +4 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListResourceScanRelatedResourcesCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListResourceScanResourcesCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListResourceScansCommand.d.ts +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListStackInstanceResourceDriftsCommand.d.ts +3 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListStackInstancesCommand.d.ts +3 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListStackResourcesCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListStackSetsCommand.d.ts +10 -8
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListStacksCommand.d.ts +4 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ListTypesCommand.d.ts +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/PublishTypeCommand.d.ts +7 -5
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/RecordHandlerProgressCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/RegisterPublisherCommand.d.ts +6 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/RegisterTypeCommand.d.ts +15 -10
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/RollbackStackCommand.d.ts +8 -6
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/SetTypeConfigurationCommand.d.ts +12 -7
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/SetTypeDefaultVersionCommand.d.ts +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/SignalResourceCommand.d.ts +5 -4
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/StartResourceScanCommand.d.ts +2 -2
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/TestTypeCommand.d.ts +19 -16
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/UpdateGeneratedTemplateCommand.d.ts +4 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/UpdateStackCommand.d.ts +7 -6
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/UpdateStackInstancesCommand.d.ts +14 -12
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/UpdateStackSetCommand.d.ts +6 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +7 -6
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/commands/ValidateTemplateCommand.d.ts +3 -3
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/index.d.ts +2 -1
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/models/models_0.d.ts +2118 -1689
- package/node_modules/@aws-sdk/client-cloudformation/dist-types/models/models_1.d.ts +425 -351
- package/node_modules/@aws-sdk/client-cloudformation/package.json +1 -1
- package/node_modules/tslib/modules/index.d.ts +1 -0
- package/node_modules/tslib/modules/index.js +2 -0
- package/node_modules/tslib/package.json +1 -1
- package/node_modules/tslib/tslib.d.ts +7 -0
- package/node_modules/tslib/tslib.es6.js +14 -0
- package/node_modules/tslib/tslib.es6.mjs +14 -0
- package/node_modules/tslib/tslib.js +46 -0
- package/package.json +8 -8
@@ -7,42 +7,41 @@ import { AutoDeployment, CallAs, Capability, DeploymentTargets, ManagedExecution
|
|
7
7
|
export interface SetTypeConfigurationInput {
|
8
8
|
/**
|
9
9
|
* <p>The Amazon Resource Name (ARN) for the extension, in this account and Region.</p>
|
10
|
-
* <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account
|
11
|
-
*
|
12
|
-
*
|
13
|
-
* <p>Do not include the extension versions suffix at the end of the ARN. You can set the
|
14
|
-
*
|
10
|
+
* <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account and Region. For private extensions, this
|
11
|
+
* will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a> API
|
12
|
+
* operation in this account and Region.</p>
|
13
|
+
* <p>Do not include the extension versions suffix at the end of the ARN. You can set the
|
14
|
+
* configuration for an extension, but not for a specific extension version.</p>
|
15
15
|
* @public
|
16
16
|
*/
|
17
17
|
TypeArn?: string;
|
18
18
|
/**
|
19
19
|
* <p>The configuration data for the extension, in this account and Region.</p>
|
20
|
-
* <p>The configuration data must be formatted as JSON, and validate against the schema returned
|
21
|
-
*
|
22
|
-
*
|
23
|
-
*
|
24
|
-
* Guide</i>.</p>
|
20
|
+
* <p>The configuration data must be formatted as JSON, and validate against the schema returned
|
21
|
+
* in the <code>ConfigurationSchema</code> response element of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>. For
|
22
|
+
* more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration">Defining the account-level configuration of an extension</a> in the
|
23
|
+
* <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>
|
25
24
|
* @public
|
26
25
|
*/
|
27
26
|
Configuration: string | undefined;
|
28
27
|
/**
|
29
28
|
* <p>An alias by which to refer to this extension configuration data.</p>
|
30
|
-
* <p>Conditional: Specifying a configuration alias is required when setting a configuration for
|
31
|
-
*
|
29
|
+
* <p>Conditional: Specifying a configuration alias is required when setting a configuration for
|
30
|
+
* a resource type extension.</p>
|
32
31
|
* @public
|
33
32
|
*/
|
34
33
|
ConfigurationAlias?: string;
|
35
34
|
/**
|
36
35
|
* <p>The name of the extension.</p>
|
37
36
|
* <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
|
38
|
-
*
|
37
|
+
* <code>TypeName</code>.</p>
|
39
38
|
* @public
|
40
39
|
*/
|
41
40
|
TypeName?: string;
|
42
41
|
/**
|
43
42
|
* <p>The type of extension.</p>
|
44
43
|
* <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
|
45
|
-
*
|
44
|
+
* <code>TypeName</code>.</p>
|
46
45
|
* @public
|
47
46
|
*/
|
48
47
|
Type?: ThirdPartyType;
|
@@ -52,9 +51,10 @@ export interface SetTypeConfigurationInput {
|
|
52
51
|
*/
|
53
52
|
export interface SetTypeConfigurationOutput {
|
54
53
|
/**
|
55
|
-
* <p>The Amazon Resource Name (ARN) for the configuration data, in this account and
|
54
|
+
* <p>The Amazon Resource Name (ARN) for the configuration data, in this account and
|
55
|
+
* Region.</p>
|
56
56
|
* <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and
|
57
|
-
*
|
57
|
+
* <code>TypeName</code>.</p>
|
58
58
|
* @public
|
59
59
|
*/
|
60
60
|
ConfigurationArn?: string;
|
@@ -64,26 +64,30 @@ export interface SetTypeConfigurationOutput {
|
|
64
64
|
*/
|
65
65
|
export interface SetTypeDefaultVersionInput {
|
66
66
|
/**
|
67
|
-
* <p>The Amazon Resource Name (ARN) of the extension for which you want version summary
|
68
|
-
*
|
67
|
+
* <p>The Amazon Resource Name (ARN) of the extension for which you want version summary
|
68
|
+
* information.</p>
|
69
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
70
|
+
* <code>Arn</code>.</p>
|
69
71
|
* @public
|
70
72
|
*/
|
71
73
|
Arn?: string;
|
72
74
|
/**
|
73
75
|
* <p>The kind of extension.</p>
|
74
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
76
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
77
|
+
* <code>Arn</code>.</p>
|
75
78
|
* @public
|
76
79
|
*/
|
77
80
|
Type?: RegistryType;
|
78
81
|
/**
|
79
82
|
* <p>The name of the extension.</p>
|
80
|
-
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
83
|
+
* <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or
|
84
|
+
* <code>Arn</code>.</p>
|
81
85
|
* @public
|
82
86
|
*/
|
83
87
|
TypeName?: string;
|
84
88
|
/**
|
85
|
-
* <p>The ID of a specific version of the extension. The version ID is the value at the end of
|
86
|
-
*
|
89
|
+
* <p>The ID of a specific version of the extension. The version ID is the value at the end of
|
90
|
+
* the Amazon Resource Name (ARN) assigned to the extension version when it is registered.</p>
|
87
91
|
* @public
|
88
92
|
*/
|
89
93
|
VersionId?: string;
|
@@ -111,26 +115,28 @@ export type ResourceSignalStatus = (typeof ResourceSignalStatus)[keyof typeof Re
|
|
111
115
|
*/
|
112
116
|
export interface SignalResourceInput {
|
113
117
|
/**
|
114
|
-
* <p>The stack name or unique stack ID that includes the resource that you want to
|
118
|
+
* <p>The stack name or unique stack ID that includes the resource that you want to
|
119
|
+
* signal.</p>
|
115
120
|
* @public
|
116
121
|
*/
|
117
122
|
StackName: string | undefined;
|
118
123
|
/**
|
119
|
-
* <p>The logical ID of the resource that you want to signal. The logical ID is the name of the
|
120
|
-
*
|
124
|
+
* <p>The logical ID of the resource that you want to signal. The logical ID is the name of the
|
125
|
+
* resource that given in the template.</p>
|
121
126
|
* @public
|
122
127
|
*/
|
123
128
|
LogicalResourceId: string | undefined;
|
124
129
|
/**
|
125
130
|
* <p>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the
|
126
|
-
*
|
127
|
-
*
|
131
|
+
* instance ID that you are signaling as the unique ID. If you send multiple signals to a single
|
132
|
+
* resource (such as signaling a wait condition), each signal requires a different unique
|
133
|
+
* ID.</p>
|
128
134
|
* @public
|
129
135
|
*/
|
130
136
|
UniqueId: string | undefined;
|
131
137
|
/**
|
132
|
-
* <p>The status of the signal, which is either success or failure. A failure signal causes
|
133
|
-
*
|
138
|
+
* <p>The status of the signal, which is either success or failure. A failure signal causes
|
139
|
+
* CloudFormation to immediately fail the stack creation or update.</p>
|
134
140
|
* @public
|
135
141
|
*/
|
136
142
|
Status: ResourceSignalStatus | undefined;
|
@@ -165,8 +171,9 @@ export declare class ResourceScanLimitExceededException extends __BaseException
|
|
165
171
|
*/
|
166
172
|
export interface StartResourceScanInput {
|
167
173
|
/**
|
168
|
-
* <p>A unique identifier for this <code>StartResourceScan</code> request. Specify this token if
|
169
|
-
*
|
174
|
+
* <p>A unique identifier for this <code>StartResourceScan</code> request. Specify this token if
|
175
|
+
* you plan to retry requests so that CloudFormation knows that you're not attempting to start a new
|
176
|
+
* resource scan.</p>
|
170
177
|
* @public
|
171
178
|
*/
|
172
179
|
ClientRequestToken?: string;
|
@@ -177,8 +184,9 @@ export interface StartResourceScanInput {
|
|
177
184
|
export interface StartResourceScanOutput {
|
178
185
|
/**
|
179
186
|
* <p>The Amazon Resource Name (ARN) of the resource scan. The format is
|
180
|
-
*
|
181
|
-
*
|
187
|
+
* <code>arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}</code>. An
|
188
|
+
* example is
|
189
|
+
* <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i>
|
182
190
|
* </code>.</p>
|
183
191
|
* @public
|
184
192
|
*/
|
@@ -210,7 +218,7 @@ export interface StopStackSetOperationInput {
|
|
210
218
|
* <li>
|
211
219
|
* <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
|
212
220
|
* <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
|
213
|
-
*
|
221
|
+
* administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
214
222
|
* </li>
|
215
223
|
* </ul>
|
216
224
|
* @public
|
@@ -228,37 +236,40 @@ export interface StopStackSetOperationOutput {
|
|
228
236
|
export interface TestTypeInput {
|
229
237
|
/**
|
230
238
|
* <p>The Amazon Resource Name (ARN) of the extension.</p>
|
231
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
239
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
240
|
+
* <code>Type</code>.</p>
|
232
241
|
* @public
|
233
242
|
*/
|
234
243
|
Arn?: string;
|
235
244
|
/**
|
236
245
|
* <p>The type of the extension to test.</p>
|
237
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
246
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
247
|
+
* <code>Type</code>.</p>
|
238
248
|
* @public
|
239
249
|
*/
|
240
250
|
Type?: ThirdPartyType;
|
241
251
|
/**
|
242
252
|
* <p>The name of the extension to test.</p>
|
243
|
-
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
253
|
+
* <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and
|
254
|
+
* <code>Type</code>.</p>
|
244
255
|
* @public
|
245
256
|
*/
|
246
257
|
TypeName?: string;
|
247
258
|
/**
|
248
259
|
* <p>The version of the extension to test.</p>
|
249
|
-
* <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code>
|
250
|
-
*
|
251
|
-
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in
|
252
|
-
*
|
260
|
+
* <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code>
|
261
|
+
* and <code>Type</code>.</p>
|
262
|
+
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in
|
263
|
+
* this account and Region for testing.</p>
|
253
264
|
* @public
|
254
265
|
*/
|
255
266
|
VersionId?: string;
|
256
267
|
/**
|
257
268
|
* <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
|
258
|
-
* <p>CloudFormation delivers the logs by the time contract testing has completed and the extension
|
259
|
-
*
|
260
|
-
* <p>The user calling <code>TestType</code> must be able to access items in the specified S3
|
261
|
-
*
|
269
|
+
* <p>CloudFormation delivers the logs by the time contract testing has completed and the extension
|
270
|
+
* has been assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
|
271
|
+
* <p>The user calling <code>TestType</code> must be able to access items in the specified S3
|
272
|
+
* bucket. Specifically, the user needs the following permissions:</p>
|
262
273
|
* <ul>
|
263
274
|
* <li>
|
264
275
|
* <p>
|
@@ -271,7 +282,8 @@ export interface TestTypeInput {
|
|
271
282
|
* </p>
|
272
283
|
* </li>
|
273
284
|
* </ul>
|
274
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and
|
285
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and
|
286
|
+
* Condition Keys for Amazon S3</a> in the <i>Identity and Access Management User Guide</i>.</p>
|
275
287
|
* @public
|
276
288
|
*/
|
277
289
|
LogDeliveryBucket?: string;
|
@@ -311,15 +323,16 @@ export interface UpdateGeneratedTemplateInput {
|
|
311
323
|
*/
|
312
324
|
RemoveResources?: string[];
|
313
325
|
/**
|
314
|
-
* <p>If <code>true</code>, update the resource properties in the generated template with their
|
315
|
-
*
|
316
|
-
*
|
326
|
+
* <p>If <code>true</code>, update the resource properties in the generated template with their
|
327
|
+
* current live state. This feature is useful when the resource properties in your generated a
|
328
|
+
* template does not reflect the live state of the resource properties. This happens when a user
|
329
|
+
* update the resource properties after generating a template.</p>
|
317
330
|
* @public
|
318
331
|
*/
|
319
332
|
RefreshAllResources?: boolean;
|
320
333
|
/**
|
321
|
-
* <p>The configuration details of the generated template, including the
|
322
|
-
*
|
334
|
+
* <p>The configuration details of the generated template, including the
|
335
|
+
* <code>DeletionPolicy</code> and <code>UpdateReplacePolicy</code>.</p>
|
323
336
|
* @public
|
324
337
|
*/
|
325
338
|
TemplateConfiguration?: TemplateConfiguration;
|
@@ -330,8 +343,9 @@ export interface UpdateGeneratedTemplateInput {
|
|
330
343
|
export interface UpdateGeneratedTemplateOutput {
|
331
344
|
/**
|
332
345
|
* <p>The Amazon Resource Name (ARN) of the generated template. The format is
|
333
|
-
*
|
334
|
-
*
|
346
|
+
* <code>arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}</code>.
|
347
|
+
* For example,
|
348
|
+
* <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i>
|
335
349
|
* </code>.</p>
|
336
350
|
* @public
|
337
351
|
*/
|
@@ -348,94 +362,101 @@ export interface UpdateStackInput {
|
|
348
362
|
*/
|
349
363
|
StackName: string | undefined;
|
350
364
|
/**
|
351
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
352
|
-
*
|
353
|
-
*
|
354
|
-
*
|
355
|
-
*
|
365
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
366
|
+
* length of 51,200 bytes.</p>
|
367
|
+
* <p>Conditional: You must specify only one of the following parameters:
|
368
|
+
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
369
|
+
* <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
356
370
|
* @public
|
357
371
|
*/
|
358
372
|
TemplateBody?: string;
|
359
373
|
/**
|
360
|
-
* <p>Location of file containing the template body. The URL must point to a template that's
|
361
|
-
*
|
362
|
-
*
|
363
|
-
*
|
374
|
+
* <p>Location of file containing the template body. The URL must point to a template that's
|
375
|
+
* located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must
|
376
|
+
* start with <code>https://</code>.</p>
|
377
|
+
* <p>Conditional: You must specify only one of the following parameters:
|
378
|
+
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
379
|
+
* <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
364
380
|
* @public
|
365
381
|
*/
|
366
382
|
TemplateURL?: string;
|
367
383
|
/**
|
368
|
-
* <p>Reuse the existing template that is associated with the stack that you are
|
369
|
-
*
|
370
|
-
*
|
384
|
+
* <p>Reuse the existing template that is associated with the stack that you are
|
385
|
+
* updating.</p>
|
386
|
+
* <p>Conditional: You must specify only one of the following parameters:
|
387
|
+
* <code>TemplateBody</code>, <code>TemplateURL</code>, or set the
|
388
|
+
* <code>UsePreviousTemplate</code> to <code>true</code>.</p>
|
371
389
|
* @public
|
372
390
|
*/
|
373
391
|
UsePreviousTemplate?: boolean;
|
374
392
|
/**
|
375
|
-
* <p>Structure containing the temporary overriding stack policy body. You can specify either
|
376
|
-
*
|
377
|
-
*
|
378
|
-
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
379
|
-
*
|
393
|
+
* <p>Structure containing the temporary overriding stack policy body. You can specify either
|
394
|
+
* the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code>
|
395
|
+
* parameter, but not both.</p>
|
396
|
+
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
397
|
+
* during this update. If you don't specify a stack policy, the current policy that is associated
|
398
|
+
* with the stack will be used.</p>
|
380
399
|
* @public
|
381
400
|
*/
|
382
401
|
StackPolicyDuringUpdateBody?: string;
|
383
402
|
/**
|
384
|
-
* <p>Location of a file containing the temporary overriding stack policy. The URL must point to
|
385
|
-
*
|
386
|
-
*
|
387
|
-
*
|
388
|
-
*
|
389
|
-
*
|
403
|
+
* <p>Location of a file containing the temporary overriding stack policy. The URL must point to
|
404
|
+
* a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The
|
405
|
+
* location for an Amazon S3 bucket must start with <code>https://</code>. You can specify either the
|
406
|
+
* <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code>
|
407
|
+
* parameter, but not both.</p>
|
408
|
+
* <p>If you want to update protected resources, specify a temporary overriding stack policy
|
409
|
+
* during this update. If you don't specify a stack policy, the current policy that is associated
|
410
|
+
* with the stack will be used.</p>
|
390
411
|
* @public
|
391
412
|
*/
|
392
413
|
StackPolicyDuringUpdateURL?: string;
|
393
414
|
/**
|
394
|
-
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack.
|
395
|
-
*
|
396
|
-
*
|
415
|
+
* <p>A list of <code>Parameter</code> structures that specify input parameters for the stack.
|
416
|
+
* For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data
|
417
|
+
* type.</p>
|
397
418
|
* @public
|
398
419
|
*/
|
399
420
|
Parameters?: Parameter[];
|
400
421
|
/**
|
401
|
-
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
402
|
-
*
|
422
|
+
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
423
|
+
* capabilities in order for CloudFormation to update the stack.</p>
|
403
424
|
* <ul>
|
404
425
|
* <li>
|
405
426
|
* <p>
|
406
427
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
407
428
|
* </p>
|
408
|
-
* <p>Some stack templates might include resources that can affect permissions in your
|
409
|
-
*
|
410
|
-
*
|
411
|
-
* <p>The following IAM resources require you to specify either the
|
412
|
-
*
|
429
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
430
|
+
* Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must
|
431
|
+
* explicitly acknowledge this by specifying one of these capabilities.</p>
|
432
|
+
* <p>The following IAM resources require you to specify either the
|
433
|
+
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p>
|
413
434
|
* <ul>
|
414
435
|
* <li>
|
415
436
|
* <p>If you have IAM resources, you can specify either capability.</p>
|
416
437
|
* </li>
|
417
438
|
* <li>
|
418
|
-
* <p>If you have IAM resources with custom names, you <i>must</i>
|
419
|
-
*
|
439
|
+
* <p>If you have IAM resources with custom names, you <i>must</i>
|
440
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
420
441
|
* </li>
|
421
442
|
* <li>
|
422
443
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
423
|
-
*
|
444
|
+
* <code>InsufficientCapabilities</code> error.</p>
|
424
445
|
* </li>
|
425
446
|
* </ul>
|
426
|
-
* <p>If your stack template contains these resources, we suggest that you review all
|
427
|
-
*
|
447
|
+
* <p>If your stack template contains these resources, we suggest that you review all
|
448
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
428
449
|
* <ul>
|
429
450
|
* <li>
|
430
451
|
* <p>
|
431
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
432
|
-
*
|
452
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html">
|
453
|
+
* AWS::IAM::AccessKey</a>
|
433
454
|
* </p>
|
434
455
|
* </li>
|
435
456
|
* <li>
|
436
457
|
* <p>
|
437
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
438
|
-
*
|
458
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html">
|
459
|
+
* AWS::IAM::Group</a>
|
439
460
|
* </p>
|
440
461
|
* </li>
|
441
462
|
* <li>
|
@@ -445,119 +466,128 @@ export interface UpdateStackInput {
|
|
445
466
|
* </li>
|
446
467
|
* <li>
|
447
468
|
* <p>
|
448
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
469
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html">AWS::IAM::Policy</a>
|
449
470
|
* </p>
|
450
471
|
* </li>
|
451
472
|
* <li>
|
452
473
|
* <p>
|
453
474
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html">
|
454
|
-
*
|
475
|
+
* AWS::IAM::Role</a>
|
455
476
|
* </p>
|
456
477
|
* </li>
|
457
478
|
* <li>
|
458
479
|
* <p>
|
459
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
460
|
-
*
|
480
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html">
|
481
|
+
* AWS::IAM::User</a>
|
461
482
|
* </p>
|
462
483
|
* </li>
|
463
484
|
* <li>
|
464
485
|
* <p>
|
465
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
486
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a>
|
466
487
|
* </p>
|
467
488
|
* </li>
|
468
489
|
* </ul>
|
469
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
470
|
-
* CloudFormation Templates</a>.</p>
|
490
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>
|
471
491
|
* </li>
|
472
492
|
* <li>
|
473
493
|
* <p>
|
474
494
|
* <code>CAPABILITY_AUTO_EXPAND</code>
|
475
495
|
* </p>
|
476
|
-
* <p>Some template contain macros. Macros perform custom processing on templates; this can
|
477
|
-
*
|
478
|
-
*
|
479
|
-
*
|
480
|
-
*
|
481
|
-
*
|
482
|
-
*
|
483
|
-
*
|
484
|
-
*
|
496
|
+
* <p>Some template contain macros. Macros perform custom processing on templates; this can
|
497
|
+
* include simple actions like find-and-replace operations, all the way to extensive
|
498
|
+
* transformations of entire templates. Because of this, users typically create a change set
|
499
|
+
* from the processed template, so that they can review the changes resulting from the macros
|
500
|
+
* before actually updating the stack. If your stack template contains one or more macros,
|
501
|
+
* and you choose to update a stack directly from the processed template, without first
|
502
|
+
* reviewing the resulting changes in a change set, you must acknowledge this capability.
|
503
|
+
* This includes the <a href="https://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="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p>
|
504
|
+
* <p>If you want to update a stack from a stack template that contains macros
|
505
|
+
* <i>and</i> nested stacks, you must update the stack directly from the
|
506
|
+
* template using this capability.</p>
|
485
507
|
* <important>
|
486
|
-
* <p>You should only update stacks directly from a stack template that contains macros if
|
487
|
-
*
|
488
|
-
* <p>Each macro relies on an underlying Lambda service function for processing stack
|
489
|
-
*
|
490
|
-
*
|
508
|
+
* <p>You should only update stacks directly from a stack template that contains macros if
|
509
|
+
* you know what processing the macro performs.</p>
|
510
|
+
* <p>Each macro relies on an underlying Lambda service function for processing stack
|
511
|
+
* templates. Be aware that the Lambda function owner can update the function operation
|
512
|
+
* without CloudFormation being notified.</p>
|
491
513
|
* </important>
|
492
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">
|
493
|
-
*
|
514
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Perform custom processing
|
515
|
+
* on CloudFormation templates with template macros</a>.</p>
|
494
516
|
* </li>
|
495
517
|
* </ul>
|
496
518
|
* <note>
|
497
|
-
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can
|
519
|
+
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can
|
520
|
+
* be specified.</p>
|
498
521
|
* </note>
|
499
522
|
* @public
|
500
523
|
*/
|
501
524
|
Capabilities?: Capability[];
|
502
525
|
/**
|
503
|
-
* <p>The template resource types that you have permissions to work with for this update stack
|
504
|
-
*
|
505
|
-
*
|
506
|
-
*
|
507
|
-
*
|
526
|
+
* <p>The template resource types that you have permissions to work with for this update stack
|
527
|
+
* action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or
|
528
|
+
* <code>Custom::MyCustomInstance</code>.</p>
|
529
|
+
* <p>If the list of resource types doesn't include a resource that you're updating, the stack
|
530
|
+
* update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this
|
531
|
+
* parameter for CloudFormation-specific condition keys in IAM policies. For more information, see
|
532
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Control access with Identity and Access Management</a>.</p>
|
508
533
|
* <note>
|
509
|
-
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can
|
534
|
+
* <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can
|
535
|
+
* be specified.</p>
|
510
536
|
* </note>
|
511
537
|
* @public
|
512
538
|
*/
|
513
539
|
ResourceTypes?: string[];
|
514
540
|
/**
|
515
|
-
* <p>The Amazon Resource Name (ARN) of an
|
516
|
-
*
|
517
|
-
*
|
518
|
-
*
|
519
|
-
*
|
520
|
-
*
|
541
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the
|
542
|
+
* stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always
|
543
|
+
* uses this role for all future operations on the stack. Provided that users have permission to
|
544
|
+
* operate on the stack, CloudFormation uses this role even if the users don't have permission to
|
545
|
+
* pass it. Ensure that the role grants least privilege.</p>
|
546
|
+
* <p>If you don't specify a value, CloudFormation uses the role that was previously associated with
|
547
|
+
* the stack. If no role is available, CloudFormation uses a temporary session that is generated from
|
548
|
+
* your user credentials.</p>
|
521
549
|
* @public
|
522
550
|
*/
|
523
551
|
RoleARN?: string;
|
524
552
|
/**
|
525
|
-
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating
|
526
|
-
*
|
553
|
+
* <p>The rollback triggers for CloudFormation to monitor during stack creation and updating
|
554
|
+
* operations, and for the specified monitoring period afterwards.</p>
|
527
555
|
* @public
|
528
556
|
*/
|
529
557
|
RollbackConfiguration?: RollbackConfiguration;
|
530
558
|
/**
|
531
|
-
* <p>Structure containing a new stack policy body. You can specify either the
|
532
|
-
*
|
533
|
-
*
|
534
|
-
*
|
535
|
-
*
|
559
|
+
* <p>Structure containing a new stack policy body. You can specify either the
|
560
|
+
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
561
|
+
* both.</p>
|
562
|
+
* <p>You might update the stack policy, for example, in order to protect a new resource that
|
563
|
+
* you created during a stack update. If you don't specify a stack policy, the current policy
|
564
|
+
* that is associated with the stack is unchanged.</p>
|
536
565
|
* @public
|
537
566
|
*/
|
538
567
|
StackPolicyBody?: string;
|
539
568
|
/**
|
540
|
-
* <p>Location of a file containing the updated stack policy. The URL must point to a policy
|
541
|
-
*
|
542
|
-
*
|
543
|
-
*
|
544
|
-
*
|
545
|
-
*
|
546
|
-
*
|
569
|
+
* <p>Location of a file containing the updated stack policy. The URL must point to a policy
|
570
|
+
* (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an
|
571
|
+
* Amazon S3 bucket must start with <code>https://</code>. You can specify either the
|
572
|
+
* <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not
|
573
|
+
* both.</p>
|
574
|
+
* <p>You might update the stack policy, for example, in order to protect a new resource that
|
575
|
+
* you created during a stack update. If you don't specify a stack policy, the current policy
|
576
|
+
* that is associated with the stack is unchanged.</p>
|
547
577
|
* @public
|
548
578
|
*/
|
549
579
|
StackPolicyURL?: string;
|
550
580
|
/**
|
551
|
-
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation
|
552
|
-
*
|
581
|
+
* <p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation
|
582
|
+
* associates with the stack. Specify an empty list to remove all notification topics.</p>
|
553
583
|
* @public
|
554
584
|
*/
|
555
585
|
NotificationARNs?: string[];
|
556
586
|
/**
|
557
|
-
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to
|
558
|
-
*
|
559
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you
|
560
|
-
*
|
587
|
+
* <p>Key-value pairs to associate with this stack. CloudFormation also propagates these tags to
|
588
|
+
* supported resources in the stack. You can specify a maximum number of 50 tags.</p>
|
589
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you
|
590
|
+
* specify an empty value, CloudFormation removes all associated tags.</p>
|
561
591
|
* @public
|
562
592
|
*/
|
563
593
|
Tags?: Tag[];
|
@@ -569,24 +599,28 @@ export interface UpdateStackInput {
|
|
569
599
|
*/
|
570
600
|
DisableRollback?: boolean;
|
571
601
|
/**
|
572
|
-
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you
|
573
|
-
*
|
574
|
-
*
|
575
|
-
*
|
576
|
-
*
|
577
|
-
*
|
578
|
-
*
|
579
|
-
*
|
580
|
-
*
|
581
|
-
*
|
582
|
-
*
|
583
|
-
*
|
602
|
+
* <p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you
|
603
|
+
* plan to retry requests so that CloudFormation knows that you're not attempting to update a stack
|
604
|
+
* with the same name. You might retry <code>UpdateStack</code> requests to ensure that
|
605
|
+
* CloudFormation successfully received them.</p>
|
606
|
+
* <p>All events triggered by a given stack operation are assigned the same client request
|
607
|
+
* token, which you can use to track operations. For example, if you execute a
|
608
|
+
* <code>CreateStack</code> operation with the token <code>token1</code>, then all the
|
609
|
+
* <code>StackEvents</code> generated by that operation will have
|
610
|
+
* <code>ClientRequestToken</code> set as <code>token1</code>.</p>
|
611
|
+
* <p>In the console, stack operations display the client request token on the Events tab. Stack
|
612
|
+
* operations that are initiated from the console use the token format
|
613
|
+
* <i>Console-StackOperation-ID</i>, which helps you easily identify the stack
|
614
|
+
* operation . For example, if you create a stack using the console, each stack event would be
|
615
|
+
* assigned the same token in the following format:
|
616
|
+
* <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>
|
584
617
|
* @public
|
585
618
|
*/
|
586
619
|
ClientRequestToken?: string;
|
587
620
|
/**
|
588
|
-
* <p>When set to <code>true</code>, newly created resources are deleted when the operation
|
589
|
-
*
|
621
|
+
* <p>When set to <code>true</code>, newly created resources are deleted when the operation
|
622
|
+
* rolls back. This includes newly created resources marked with a deletion policy of
|
623
|
+
* <code>Retain</code>.</p>
|
590
624
|
* <p>Default: <code>false</code>
|
591
625
|
* </p>
|
592
626
|
* @public
|
@@ -614,58 +648,66 @@ export interface UpdateStackInstancesInput {
|
|
614
648
|
*/
|
615
649
|
StackSetName: string | undefined;
|
616
650
|
/**
|
617
|
-
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to
|
618
|
-
*
|
619
|
-
*
|
620
|
-
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
651
|
+
* <p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to
|
652
|
+
* update parameter values for stack instances. The overridden parameter values will be applied
|
653
|
+
* to all stack instances in the specified accounts and Amazon Web Services Regions.</p>
|
654
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
655
|
+
* both.</p>
|
621
656
|
* @public
|
622
657
|
*/
|
623
658
|
Accounts?: string[];
|
624
659
|
/**
|
625
|
-
* <p>[Service-managed permissions] The Organizations accounts for which you want to
|
626
|
-
*
|
627
|
-
*
|
628
|
-
*
|
629
|
-
*
|
660
|
+
* <p>[Service-managed permissions] The Organizations accounts for which you want to
|
661
|
+
* update parameter values for stack instances. If your update targets OUs, the overridden
|
662
|
+
* parameter values only apply to the accounts that are currently in the target OUs and their
|
663
|
+
* child OUs. Accounts added to the target OUs and their child OUs in the future won't use the
|
664
|
+
* overridden values.</p>
|
665
|
+
* <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not
|
666
|
+
* both.</p>
|
630
667
|
* @public
|
631
668
|
*/
|
632
669
|
DeploymentTargets?: DeploymentTargets;
|
633
670
|
/**
|
634
|
-
* <p>The names of one or more Amazon Web Services Regions in which you want to update parameter values for
|
635
|
-
*
|
636
|
-
*
|
671
|
+
* <p>The names of one or more Amazon Web Services Regions in which you want to update parameter values for
|
672
|
+
* stack instances. The overridden parameter values will be applied to all stack instances in the
|
673
|
+
* specified accounts and Amazon Web Services Regions.</p>
|
637
674
|
* @public
|
638
675
|
*/
|
639
676
|
Regions: string[] | undefined;
|
640
677
|
/**
|
641
|
-
* <p>A list of input parameters whose values you want to update for the specified stack
|
642
|
-
*
|
643
|
-
*
|
678
|
+
* <p>A list of input parameters whose values you want to update for the specified stack
|
679
|
+
* instances.</p>
|
680
|
+
* <p>Any overridden parameter values will be applied to all stack instances in the specified
|
681
|
+
* accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how
|
682
|
+
* CloudFormation sets parameter values during stack instance update operations:</p>
|
644
683
|
* <ul>
|
645
684
|
* <li>
|
646
|
-
* <p>To override the current value for a parameter, include the parameter and specify its
|
685
|
+
* <p>To override the current value for a parameter, include the parameter and specify its
|
686
|
+
* value.</p>
|
647
687
|
* </li>
|
648
688
|
* <li>
|
649
|
-
* <p>To leave an overridden parameter set to its present value, include the parameter and
|
650
|
-
*
|
651
|
-
*
|
689
|
+
* <p>To leave an overridden parameter set to its present value, include the parameter and
|
690
|
+
* specify <code>UsePreviousValue</code> as <code>true</code>. (You can't specify both a
|
691
|
+
* value and set <code>UsePreviousValue</code> to <code>true</code>.)</p>
|
652
692
|
* </li>
|
653
693
|
* <li>
|
654
|
-
* <p>To set an overridden parameter back to the value specified in the stack set, specify a
|
655
|
-
*
|
694
|
+
* <p>To set an overridden parameter back to the value specified in the stack set, specify a
|
695
|
+
* parameter list but don't include the parameter in the list.</p>
|
656
696
|
* </li>
|
657
697
|
* <li>
|
658
|
-
* <p>To leave all parameters set to their present values, don't specify this property at
|
698
|
+
* <p>To leave all parameters set to their present values, don't specify this property at
|
699
|
+
* all.</p>
|
659
700
|
* </li>
|
660
701
|
* </ul>
|
661
|
-
* <p>During stack set updates, any parameter values overridden for a stack instance aren't
|
662
|
-
*
|
663
|
-
* <p>You can only override the parameter <i>values</i> that are specified in the
|
664
|
-
*
|
665
|
-
*
|
666
|
-
*
|
667
|
-
*
|
668
|
-
*
|
702
|
+
* <p>During stack set updates, any parameter values overridden for a stack instance aren't
|
703
|
+
* updated, but retain their overridden value.</p>
|
704
|
+
* <p>You can only override the parameter <i>values</i> that are specified in the
|
705
|
+
* stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the
|
706
|
+
* stack set template. If you add a parameter to a template, before you can override the
|
707
|
+
* parameter value specified in the stack set you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a>
|
708
|
+
* to update all stack instances with the updated template and parameter value specified in the
|
709
|
+
* stack set. Once a stack instance has been updated with the new parameter, you can then
|
710
|
+
* override the parameter value using <code>UpdateStackInstances</code>.</p>
|
669
711
|
* @public
|
670
712
|
*/
|
671
713
|
ParameterOverrides?: Parameter[];
|
@@ -676,26 +718,31 @@ export interface UpdateStackInstancesInput {
|
|
676
718
|
OperationPreferences?: StackSetOperationPreferences;
|
677
719
|
/**
|
678
720
|
* <p>The unique identifier for this stack set operation.</p>
|
679
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation
|
680
|
-
*
|
681
|
-
*
|
682
|
-
*
|
721
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation
|
722
|
+
* performs the stack set operation only once, even if you retry the request multiple times. You
|
723
|
+
* might retry stack set operation requests to ensure that CloudFormation successfully received
|
724
|
+
* them.</p>
|
725
|
+
* <p>If you don't specify an operation ID, the SDK generates one
|
726
|
+
* automatically.</p>
|
683
727
|
* @public
|
684
728
|
*/
|
685
729
|
OperationId?: string;
|
686
730
|
/**
|
687
|
-
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator
|
688
|
-
*
|
689
|
-
*
|
690
|
-
*
|
731
|
+
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator
|
732
|
+
* in the organization's management account or as a delegated administrator in a
|
733
|
+
* member account.</p>
|
734
|
+
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
735
|
+
* self-managed permissions.</p>
|
691
736
|
* <ul>
|
692
737
|
* <li>
|
693
|
-
* <p>If you are signed in to the management account, specify
|
738
|
+
* <p>If you are signed in to the management account, specify
|
739
|
+
* <code>SELF</code>.</p>
|
694
740
|
* </li>
|
695
741
|
* <li>
|
696
|
-
* <p>If you are signed in to a delegated administrator account, specify
|
697
|
-
*
|
698
|
-
*
|
742
|
+
* <p>If you are signed in to a delegated administrator account, specify
|
743
|
+
* <code>DELEGATED_ADMIN</code>.</p>
|
744
|
+
* <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
|
745
|
+
* delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
699
746
|
* </li>
|
700
747
|
* </ul>
|
701
748
|
* @public
|
@@ -727,28 +774,30 @@ export interface UpdateStackSetInput {
|
|
727
774
|
*/
|
728
775
|
Description?: string;
|
729
776
|
/**
|
730
|
-
* <p>The structure that contains the template body, with a minimum length of 1 byte and a
|
731
|
-
*
|
732
|
-
*
|
733
|
-
*
|
734
|
-
*
|
777
|
+
* <p>The structure that contains the template body, with a minimum length of 1 byte and a
|
778
|
+
* maximum length of 51,200 bytes.</p>
|
779
|
+
* <p>Conditional: You must specify only one of the following parameters:
|
780
|
+
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
781
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
735
782
|
* @public
|
736
783
|
*/
|
737
784
|
TemplateBody?: string;
|
738
785
|
/**
|
739
|
-
* <p>The location of the file that contains the template body. The URL must point to a template
|
740
|
-
*
|
741
|
-
*
|
742
|
-
*
|
743
|
-
*
|
744
|
-
*
|
786
|
+
* <p>The location of the file that contains the template body. The URL must point to a template
|
787
|
+
* (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager
|
788
|
+
* document.</p>
|
789
|
+
* <p>Conditional: You must specify only one of the following parameters:
|
790
|
+
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
791
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
745
792
|
* @public
|
746
793
|
*/
|
747
794
|
TemplateURL?: string;
|
748
795
|
/**
|
749
|
-
* <p>Use the existing template that's associated with the stack set that you're
|
750
|
-
*
|
751
|
-
*
|
796
|
+
* <p>Use the existing template that's associated with the stack set that you're
|
797
|
+
* updating.</p>
|
798
|
+
* <p>Conditional: You must specify only one of the following parameters:
|
799
|
+
* <code>TemplateBody</code> or <code>TemplateURL</code>—or set
|
800
|
+
* <code>UsePreviousTemplate</code> to true.</p>
|
752
801
|
* @public
|
753
802
|
*/
|
754
803
|
UsePreviousTemplate?: boolean;
|
@@ -758,42 +807,43 @@ export interface UpdateStackSetInput {
|
|
758
807
|
*/
|
759
808
|
Parameters?: Parameter[];
|
760
809
|
/**
|
761
|
-
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
762
|
-
*
|
810
|
+
* <p>In some cases, you must explicitly acknowledge that your stack template contains certain
|
811
|
+
* capabilities in order for CloudFormation to update the stack set and its associated stack
|
812
|
+
* instances.</p>
|
763
813
|
* <ul>
|
764
814
|
* <li>
|
765
815
|
* <p>
|
766
816
|
* <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>
|
767
817
|
* </p>
|
768
|
-
* <p>Some stack templates might include resources that can affect permissions in your
|
769
|
-
*
|
770
|
-
*
|
771
|
-
* <p>The following IAM resources require you to specify either the
|
772
|
-
*
|
818
|
+
* <p>Some stack templates might include resources that can affect permissions in your
|
819
|
+
* Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must
|
820
|
+
* explicitly acknowledge this by specifying one of these capabilities.</p>
|
821
|
+
* <p>The following IAM resources require you to specify either the
|
822
|
+
* <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p>
|
773
823
|
* <ul>
|
774
824
|
* <li>
|
775
825
|
* <p>If you have IAM resources, you can specify either capability.</p>
|
776
826
|
* </li>
|
777
827
|
* <li>
|
778
|
-
* <p>If you have IAM resources with custom names, you <i>must</i>
|
779
|
-
*
|
828
|
+
* <p>If you have IAM resources with custom names, you <i>must</i>
|
829
|
+
* specify <code>CAPABILITY_NAMED_IAM</code>.</p>
|
780
830
|
* </li>
|
781
831
|
* <li>
|
782
832
|
* <p>If you don't specify either of these capabilities, CloudFormation returns an
|
783
|
-
*
|
833
|
+
* <code>InsufficientCapabilities</code> error.</p>
|
784
834
|
* </li>
|
785
835
|
* </ul>
|
786
|
-
* <p>If your stack template contains these resources, we recommend that you review all
|
787
|
-
*
|
836
|
+
* <p>If your stack template contains these resources, we recommend that you review all
|
837
|
+
* permissions associated with them and edit their permissions if necessary.</p>
|
788
838
|
* <ul>
|
789
839
|
* <li>
|
790
840
|
* <p>
|
791
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
841
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html">AWS::IAM::AccessKey</a>
|
792
842
|
* </p>
|
793
843
|
* </li>
|
794
844
|
* <li>
|
795
845
|
* <p>
|
796
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
846
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html">AWS::IAM::Group</a>
|
797
847
|
* </p>
|
798
848
|
* </li>
|
799
849
|
* <li>
|
@@ -803,7 +853,7 @@ export interface UpdateStackSetInput {
|
|
803
853
|
* </li>
|
804
854
|
* <li>
|
805
855
|
* <p>
|
806
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
856
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html">AWS::IAM::Policy</a>
|
807
857
|
* </p>
|
808
858
|
* </li>
|
809
859
|
* <li>
|
@@ -813,31 +863,31 @@ export interface UpdateStackSetInput {
|
|
813
863
|
* </li>
|
814
864
|
* <li>
|
815
865
|
* <p>
|
816
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
866
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html">AWS::IAM::User</a>
|
817
867
|
* </p>
|
818
868
|
* </li>
|
819
869
|
* <li>
|
820
870
|
* <p>
|
821
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
871
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a>
|
822
872
|
* </p>
|
823
873
|
* </li>
|
824
874
|
* </ul>
|
825
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
826
|
-
* CloudFormation Templates</a>.</p>
|
875
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>
|
827
876
|
* </li>
|
828
877
|
* <li>
|
829
878
|
* <p>
|
830
879
|
* <code>CAPABILITY_AUTO_EXPAND</code>
|
831
880
|
* </p>
|
832
|
-
* <p>Some templates reference macros. If your stack set template references one or more
|
833
|
-
*
|
834
|
-
*
|
835
|
-
*
|
881
|
+
* <p>Some templates reference macros. If your stack set template references one or more
|
882
|
+
* macros, you must update the stack set directly from the processed template, without first
|
883
|
+
* reviewing the resulting changes in a change set. To update the stack set directly, you
|
884
|
+
* must acknowledge this capability. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using CloudFormation Macros to
|
885
|
+
* Perform Custom Processing on Templates</a>.</p>
|
836
886
|
* <important>
|
837
|
-
* <p>Stack sets with service-managed permissions do not currently support the use of
|
838
|
-
*
|
839
|
-
*
|
840
|
-
*
|
887
|
+
* <p>Stack sets with service-managed permissions do not currently support the use of
|
888
|
+
* macros in templates. (This includes the <a href="https://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="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if
|
889
|
+
* you specify this capability for a stack set with service-managed permissions, if you
|
890
|
+
* reference a macro in your template the stack set operation will fail.</p>
|
841
891
|
* </important>
|
842
892
|
* </li>
|
843
893
|
* </ul>
|
@@ -845,30 +895,36 @@ export interface UpdateStackSetInput {
|
|
845
895
|
*/
|
846
896
|
Capabilities?: Capability[];
|
847
897
|
/**
|
848
|
-
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
849
|
-
*
|
850
|
-
*
|
851
|
-
*
|
898
|
+
* <p>The key-value pairs to associate with this stack set and the stacks created from it.
|
899
|
+
* CloudFormation also propagates these tags to supported resources that are created in the stacks.
|
900
|
+
* You can specify a maximum number of 50 tags.</p>
|
901
|
+
* <p>If you specify tags for this parameter, those tags replace any list of tags that are
|
902
|
+
* currently associated with this stack set. This means:</p>
|
852
903
|
* <ul>
|
853
904
|
* <li>
|
854
|
-
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
905
|
+
* <p>If you don't specify this parameter, CloudFormation doesn't modify the stack's
|
906
|
+
* tags.</p>
|
855
907
|
* </li>
|
856
908
|
* <li>
|
857
|
-
* <p>If you specify <i>any</i> tags using this parameter, you must specify
|
858
|
-
*
|
859
|
-
*
|
860
|
-
*
|
909
|
+
* <p>If you specify <i>any</i> tags using this parameter, you must specify
|
910
|
+
* <i>all</i> the tags that you want associated with this stack set, even
|
911
|
+
* tags you've specified before (for example, when creating the stack set or during a
|
912
|
+
* previous update of the stack set.). Any tags that you don't include in the updated list of
|
913
|
+
* tags are removed from the stack set, and therefore from the stacks and resources as
|
914
|
+
* well.</p>
|
861
915
|
* </li>
|
862
916
|
* <li>
|
863
|
-
* <p>If you specify an empty value, CloudFormation removes all currently associated
|
917
|
+
* <p>If you specify an empty value, CloudFormation removes all currently associated
|
918
|
+
* tags.</p>
|
864
919
|
* </li>
|
865
920
|
* </ul>
|
866
|
-
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action, CloudFormation
|
867
|
-
*
|
868
|
-
*
|
869
|
-
*
|
870
|
-
*
|
871
|
-
*
|
921
|
+
* <p>If you specify new tags as part of an <code>UpdateStackSet</code> action, CloudFormation
|
922
|
+
* checks to see if you have the required IAM permission to tag resources. If you omit tags
|
923
|
+
* that are currently associated with the stack set from the list of tags you specify, CloudFormation
|
924
|
+
* assumes that you want to remove those tags from the stack set, and checks to see if you have
|
925
|
+
* permission to untag resources. If you don't have the necessary permission(s), the entire
|
926
|
+
* <code>UpdateStackSet</code> action fails with an <code>access denied</code> error, and the
|
927
|
+
* stack set is not updated.</p>
|
872
928
|
* @public
|
873
929
|
*/
|
874
930
|
Tags?: Tag[];
|
@@ -879,124 +935,140 @@ export interface UpdateStackSetInput {
|
|
879
935
|
OperationPreferences?: StackSetOperationPreferences;
|
880
936
|
/**
|
881
937
|
* <p>The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.</p>
|
882
|
-
* <p>Specify an IAM role only if you are using customized administrator roles to control
|
883
|
-
*
|
884
|
-
*
|
885
|
-
*
|
886
|
-
*
|
938
|
+
* <p>Specify an IAM role only if you are using customized administrator roles to control
|
939
|
+
* which users or groups can manage specific stack sets within the same administrator account.
|
940
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Granting Permissions for
|
941
|
+
* Stack Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>
|
942
|
+
* <p>If you specified a customized administrator role when you created the stack set, you must
|
943
|
+
* specify a customized administrator role, even if it is the same customized administrator role
|
944
|
+
* used with this stack set previously.</p>
|
887
945
|
* @public
|
888
946
|
*/
|
889
947
|
AdministrationRoleARN?: string;
|
890
948
|
/**
|
891
|
-
* <p>The name of the IAM execution role to use to update the stack set. If you do not specify
|
892
|
-
*
|
893
|
-
*
|
894
|
-
*
|
895
|
-
*
|
896
|
-
*
|
897
|
-
*
|
949
|
+
* <p>The name of the IAM execution role to use to update the stack set. If you do not specify
|
950
|
+
* an execution role, CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code>
|
951
|
+
* role for the stack set operation.</p>
|
952
|
+
* <p>Specify an IAM role only if you are using customized execution roles to control which
|
953
|
+
* stack resources users and groups can include in their stack sets.</p>
|
954
|
+
* <p>If you specify a customized execution role, CloudFormation uses that role to update the stack.
|
955
|
+
* If you do not specify a customized execution role, CloudFormation performs the update using the
|
956
|
+
* role previously associated with the stack set, so long as you have permissions to perform
|
957
|
+
* operations on the stack set.</p>
|
898
958
|
* @public
|
899
959
|
*/
|
900
960
|
ExecutionRoleName?: string;
|
901
961
|
/**
|
902
|
-
* <p>[Service-managed permissions] The Organizations accounts in which to update
|
903
|
-
*
|
904
|
-
* <p>To update all the stack instances associated with this stack set, do not specify
|
905
|
-
*
|
906
|
-
* <p>If the stack set update includes changes to the template (that is, if
|
907
|
-
*
|
908
|
-
*
|
909
|
-
*
|
910
|
-
*
|
962
|
+
* <p>[Service-managed permissions] The Organizations accounts in which to update
|
963
|
+
* associated stack instances.</p>
|
964
|
+
* <p>To update all the stack instances associated with this stack set, do not specify
|
965
|
+
* <code>DeploymentTargets</code> or <code>Regions</code>.</p>
|
966
|
+
* <p>If the stack set update includes changes to the template (that is, if
|
967
|
+
* <code>TemplateBody</code> or <code>TemplateURL</code> is specified), or the
|
968
|
+
* <code>Parameters</code>, CloudFormation marks all stack instances with a status of
|
969
|
+
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and
|
970
|
+
* Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters,
|
971
|
+
* CloudFormation updates the stack instances in the specified accounts and Regions, while leaving
|
972
|
+
* all other stack instances with their existing stack instance status.</p>
|
911
973
|
* @public
|
912
974
|
*/
|
913
975
|
DeploymentTargets?: DeploymentTargets;
|
914
976
|
/**
|
915
|
-
* <p>Describes how the IAM roles required for stack set operations are created. You cannot
|
916
|
-
*
|
977
|
+
* <p>Describes how the IAM roles required for stack set operations are created. You cannot
|
978
|
+
* modify <code>PermissionModel</code> if there are stack instances associated with your stack
|
979
|
+
* set.</p>
|
917
980
|
* <ul>
|
918
981
|
* <li>
|
919
|
-
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
920
|
-
*
|
921
|
-
*
|
982
|
+
* <p>With <code>self-managed</code> permissions, you must create the administrator and
|
983
|
+
* execution roles required to deploy to target accounts. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant
|
984
|
+
* Self-Managed Stack Set Permissions</a>.</p>
|
922
985
|
* </li>
|
923
986
|
* <li>
|
924
|
-
* <p>With <code>service-managed</code> permissions, StackSets automatically creates the
|
925
|
-
*
|
926
|
-
*
|
987
|
+
* <p>With <code>service-managed</code> permissions, StackSets automatically creates the
|
988
|
+
* IAM roles required to deploy to accounts managed by Organizations. For more
|
989
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html">Grant
|
990
|
+
* Service-Managed Stack Set Permissions</a>.</p>
|
927
991
|
* </li>
|
928
992
|
* </ul>
|
929
993
|
* @public
|
930
994
|
*/
|
931
995
|
PermissionModel?: PermissionModels;
|
932
996
|
/**
|
933
|
-
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations
|
934
|
-
*
|
935
|
-
* <p>If you specify <code>AutoDeployment</code>, don't specify <code>DeploymentTargets</code>
|
936
|
-
*
|
997
|
+
* <p>[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit
|
998
|
+
* (OU).</p>
|
999
|
+
* <p>If you specify <code>AutoDeployment</code>, don't specify <code>DeploymentTargets</code>
|
1000
|
+
* or <code>Regions</code>.</p>
|
937
1001
|
* @public
|
938
1002
|
*/
|
939
1003
|
AutoDeployment?: AutoDeployment;
|
940
1004
|
/**
|
941
1005
|
* <p>The unique ID for this stack set operation.</p>
|
942
|
-
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation
|
943
|
-
*
|
944
|
-
*
|
945
|
-
*
|
946
|
-
* <p>
|
947
|
-
*
|
1006
|
+
* <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation
|
1007
|
+
* performs the stack set operation only once, even if you retry the request multiple times. You
|
1008
|
+
* might retry stack set operation requests to ensure that CloudFormation successfully received
|
1009
|
+
* them.</p>
|
1010
|
+
* <p>If you don't specify an operation ID, CloudFormation generates one
|
1011
|
+
* automatically.</p>
|
1012
|
+
* <p>Repeating this stack set operation with a new operation ID retries all stack instances
|
1013
|
+
* whose status is <code>OUTDATED</code>.</p>
|
948
1014
|
* @public
|
949
1015
|
*/
|
950
1016
|
OperationId?: string;
|
951
1017
|
/**
|
952
|
-
* <p>[Self-managed permissions] The accounts in which to update associated stack instances. If
|
953
|
-
*
|
954
|
-
*
|
955
|
-
*
|
956
|
-
*
|
957
|
-
*
|
958
|
-
*
|
959
|
-
*
|
960
|
-
*
|
961
|
-
*
|
1018
|
+
* <p>[Self-managed permissions] The accounts in which to update associated stack instances. If
|
1019
|
+
* you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set
|
1020
|
+
* instances.</p>
|
1021
|
+
* <p>To update <i>all</i> the stack instances associated with this stack set,
|
1022
|
+
* don't specify the <code>Accounts</code> or <code>Regions</code> properties.</p>
|
1023
|
+
* <p>If the stack set update includes changes to the template (that is, if the
|
1024
|
+
* <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the
|
1025
|
+
* <code>Parameters</code> property, CloudFormation marks all stack instances with a status of
|
1026
|
+
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and
|
1027
|
+
* Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters,
|
1028
|
+
* CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while
|
1029
|
+
* leaving all other stack instances with their existing stack instance status.</p>
|
962
1030
|
* @public
|
963
1031
|
*/
|
964
1032
|
Accounts?: string[];
|
965
1033
|
/**
|
966
|
-
* <p>The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,
|
967
|
-
*
|
968
|
-
* <p>To update <i>all</i> the stack instances associated with this stack set, do
|
969
|
-
*
|
970
|
-
* <p>If the stack set update includes changes to the template (that is, if the
|
971
|
-
*
|
972
|
-
*
|
973
|
-
*
|
974
|
-
*
|
975
|
-
*
|
1034
|
+
* <p>The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,
|
1035
|
+
* you must also specify accounts in which to update stack set instances.</p>
|
1036
|
+
* <p>To update <i>all</i> the stack instances associated with this stack set, do
|
1037
|
+
* not specify the <code>Accounts</code> or <code>Regions</code> properties.</p>
|
1038
|
+
* <p>If the stack set update includes changes to the template (that is, if the
|
1039
|
+
* <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the
|
1040
|
+
* <code>Parameters</code> property, CloudFormation marks all stack instances with a status of
|
1041
|
+
* <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and
|
1042
|
+
* Regions. If the stack set update does not include changes to the template or parameters,
|
1043
|
+
* CloudFormation updates the stack instances in the specified accounts and Regions, while leaving
|
1044
|
+
* all other stack instances with their existing stack instance status.</p>
|
976
1045
|
* @public
|
977
1046
|
*/
|
978
1047
|
Regions?: string[];
|
979
1048
|
/**
|
980
|
-
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator
|
981
|
-
*
|
982
|
-
*
|
983
|
-
*
|
1049
|
+
* <p>[Service-managed permissions] Specifies whether you are acting as an account administrator
|
1050
|
+
* in the organization's management account or as a delegated administrator in a
|
1051
|
+
* member account.</p>
|
1052
|
+
* <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with
|
1053
|
+
* self-managed permissions.</p>
|
984
1054
|
* <ul>
|
985
1055
|
* <li>
|
986
|
-
* <p>If you are signed in to the management account, specify
|
1056
|
+
* <p>If you are signed in to the management account, specify
|
1057
|
+
* <code>SELF</code>.</p>
|
987
1058
|
* </li>
|
988
1059
|
* <li>
|
989
|
-
* <p>If you are signed in to a delegated administrator account, specify
|
990
|
-
*
|
991
|
-
*
|
1060
|
+
* <p>If you are signed in to a delegated administrator account, specify
|
1061
|
+
* <code>DELEGATED_ADMIN</code>.</p>
|
1062
|
+
* <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
|
1063
|
+
* delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p>
|
992
1064
|
* </li>
|
993
1065
|
* </ul>
|
994
1066
|
* @public
|
995
1067
|
*/
|
996
1068
|
CallAs?: CallAs;
|
997
1069
|
/**
|
998
|
-
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
999
|
-
*
|
1070
|
+
* <p>Describes whether StackSets performs non-conflicting operations concurrently and queues
|
1071
|
+
* conflicting operations.</p>
|
1000
1072
|
* @public
|
1001
1073
|
*/
|
1002
1074
|
ManagedExecution?: ManagedExecution;
|
@@ -1021,7 +1093,8 @@ export interface UpdateTerminationProtectionInput {
|
|
1021
1093
|
*/
|
1022
1094
|
EnableTerminationProtection: boolean | undefined;
|
1023
1095
|
/**
|
1024
|
-
* <p>The name or unique ID of the stack for which you want to set termination
|
1096
|
+
* <p>The name or unique ID of the stack for which you want to set termination
|
1097
|
+
* protection.</p>
|
1025
1098
|
* @public
|
1026
1099
|
*/
|
1027
1100
|
StackName: string | undefined;
|
@@ -1042,19 +1115,19 @@ export interface UpdateTerminationProtectionOutput {
|
|
1042
1115
|
*/
|
1043
1116
|
export interface ValidateTemplateInput {
|
1044
1117
|
/**
|
1045
|
-
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
1046
|
-
*
|
1047
|
-
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both
|
1048
|
-
*
|
1118
|
+
* <p>Structure containing the template body with a minimum length of 1 byte and a maximum
|
1119
|
+
* length of 51,200 bytes.</p>
|
1120
|
+
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both
|
1121
|
+
* are passed, only <code>TemplateBody</code> is used.</p>
|
1049
1122
|
* @public
|
1050
1123
|
*/
|
1051
1124
|
TemplateBody?: string;
|
1052
1125
|
/**
|
1053
|
-
* <p>Location of file containing the template body. The URL must point to a template (max size:
|
1054
|
-
*
|
1055
|
-
*
|
1056
|
-
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both
|
1057
|
-
*
|
1126
|
+
* <p>Location of file containing the template body. The URL must point to a template (max size:
|
1127
|
+
* 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. The location
|
1128
|
+
* for an Amazon S3 bucket must start with <code>https://</code>.</p>
|
1129
|
+
* <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both
|
1130
|
+
* are passed, only <code>TemplateBody</code> is used.</p>
|
1058
1131
|
* @public
|
1059
1132
|
*/
|
1060
1133
|
TemplateURL?: string;
|
@@ -1075,7 +1148,8 @@ export interface TemplateParameter {
|
|
1075
1148
|
*/
|
1076
1149
|
DefaultValue?: string;
|
1077
1150
|
/**
|
1078
|
-
* <p>Flag indicating whether the parameter should be displayed as plain text in logs and
|
1151
|
+
* <p>Flag indicating whether the parameter should be displayed as plain text in logs and
|
1152
|
+
* UIs.</p>
|
1079
1153
|
* @public
|
1080
1154
|
*/
|
1081
1155
|
NoEcho?: boolean;
|
@@ -1101,17 +1175,17 @@ export interface ValidateTemplateOutput {
|
|
1101
1175
|
*/
|
1102
1176
|
Description?: string;
|
1103
1177
|
/**
|
1104
|
-
* <p>The capabilities found within the template. If your template contains IAM resources, you
|
1105
|
-
*
|
1106
|
-
*
|
1107
|
-
*
|
1108
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM
|
1109
|
-
* CloudFormation Templates</a>.</p>
|
1178
|
+
* <p>The capabilities found within the template. If your template contains IAM resources, you
|
1179
|
+
* must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use
|
1180
|
+
* the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template;
|
1181
|
+
* otherwise, those actions return an InsufficientCapabilities error.</p>
|
1182
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>
|
1110
1183
|
* @public
|
1111
1184
|
*/
|
1112
1185
|
Capabilities?: Capability[];
|
1113
1186
|
/**
|
1114
|
-
* <p>The list of resources that generated the values in the <code>Capabilities</code> response
|
1187
|
+
* <p>The list of resources that generated the values in the <code>Capabilities</code> response
|
1188
|
+
* element.</p>
|
1115
1189
|
* @public
|
1116
1190
|
*/
|
1117
1191
|
CapabilitiesReason?: string;
|