aws-sdk-cloudformation 1.50.0 → 1.54.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation.rb +2 -2
- data/lib/aws-sdk-cloudformation/client.rb +1303 -498
- data/lib/aws-sdk-cloudformation/client_api.rb +312 -1
- data/lib/aws-sdk-cloudformation/errors.rb +22 -0
- data/lib/aws-sdk-cloudformation/event.rb +2 -2
- data/lib/aws-sdk-cloudformation/resource.rb +41 -42
- data/lib/aws-sdk-cloudformation/stack.rb +102 -105
- data/lib/aws-sdk-cloudformation/stack_resource.rb +5 -5
- data/lib/aws-sdk-cloudformation/stack_resource_summary.rb +2 -2
- data/lib/aws-sdk-cloudformation/types.rb +2109 -761
- metadata +5 -6
@@ -50,14 +50,14 @@ module Aws::CloudFormation
|
|
50
50
|
end
|
51
51
|
|
52
52
|
# The name or unique identifier that corresponds to a physical instance
|
53
|
-
# ID of a resource supported by
|
53
|
+
# ID of a resource supported by CloudFormation.
|
54
54
|
# @return [String]
|
55
55
|
def physical_resource_id
|
56
56
|
data[:physical_resource_id]
|
57
57
|
end
|
58
58
|
|
59
|
-
# Type of resource. ((For more information, go to [
|
60
|
-
# Reference][1] in the
|
59
|
+
# Type of resource. ((For more information, go to [Amazon Web Services
|
60
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
61
61
|
#
|
62
62
|
#
|
63
63
|
#
|
@@ -92,8 +92,8 @@ module Aws::CloudFormation
|
|
92
92
|
end
|
93
93
|
|
94
94
|
# The content of the `Metadata` attribute declared for the resource. For
|
95
|
-
# more information, see [Metadata Attribute][1] in the
|
96
|
-
#
|
95
|
+
# more information, see [Metadata Attribute][1] in the CloudFormation
|
96
|
+
# User Guide.
|
97
97
|
#
|
98
98
|
#
|
99
99
|
#
|
@@ -50,8 +50,8 @@ module Aws::CloudFormation
|
|
50
50
|
data[:physical_resource_id]
|
51
51
|
end
|
52
52
|
|
53
|
-
# Type of resource. (For more information, go to [
|
54
|
-
# Reference][1] in the
|
53
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
54
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
55
55
|
#
|
56
56
|
#
|
57
57
|
#
|
@@ -11,17 +11,17 @@ module Aws::CloudFormation
|
|
11
11
|
module Types
|
12
12
|
|
13
13
|
# Structure that contains the results of the account gate function which
|
14
|
-
#
|
15
|
-
#
|
16
|
-
#
|
17
|
-
# For each account and Region,
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
23
|
-
#
|
24
|
-
#
|
14
|
+
# CloudFormation invokes, if present, before proceeding with a stack set
|
15
|
+
# operation in an account and Region.
|
16
|
+
#
|
17
|
+
# For each account and Region, CloudFormation lets you specify a Lamdba
|
18
|
+
# function that encapsulates any requirements that must be met before
|
19
|
+
# CloudFormation can proceed with a stack set operation in that account
|
20
|
+
# and Region. CloudFormation invokes the function each time a stack set
|
21
|
+
# operation is requested for that account and Region; if the function
|
22
|
+
# returns `FAILED`, CloudFormation cancels the operation in that account
|
23
|
+
# and Region, and sets the stack set operation result status for that
|
24
|
+
# account and Region to `FAILED`.
|
25
25
|
#
|
26
26
|
# For more information, see [Configuring a target account gate][1].
|
27
27
|
#
|
@@ -34,7 +34,7 @@ module Aws::CloudFormation
|
|
34
34
|
#
|
35
35
|
# * `SUCCEEDED`\: The account gate function has determined that the
|
36
36
|
# account and Region passes any requirements for a stack set
|
37
|
-
# operation to occur.
|
37
|
+
# operation to occur. CloudFormation proceeds with the stack
|
38
38
|
# operation in that account and Region.
|
39
39
|
#
|
40
40
|
# * `FAILED`\: The account gate function has determined that the
|
@@ -43,21 +43,21 @@ module Aws::CloudFormation
|
|
43
43
|
# operation in that account and Region, and sets the stack set
|
44
44
|
# operation result status for that account and Region to `FAILED`.
|
45
45
|
#
|
46
|
-
# * `SKIPPED`\:
|
47
|
-
#
|
48
|
-
#
|
46
|
+
# * `SKIPPED`\: CloudFormation has skipped calling the account gate
|
47
|
+
# function for this account and Region, for one of the following
|
48
|
+
# reasons:
|
49
49
|
#
|
50
50
|
# * An account gate function has not been specified for the account
|
51
|
-
# and Region.
|
52
|
-
#
|
51
|
+
# and Region. CloudFormation proceeds with the stack set operation
|
52
|
+
# in this account and Region.
|
53
53
|
#
|
54
54
|
# * The `AWSCloudFormationStackSetExecutionRole` of the stack set
|
55
55
|
# adminstration account lacks permissions to invoke the function.
|
56
|
-
#
|
56
|
+
# CloudFormation proceeds with the stack set operation in this
|
57
57
|
# account and Region.
|
58
58
|
#
|
59
59
|
# * Either no action is necessary, or no action is possible, on the
|
60
|
-
# stack.
|
60
|
+
# stack. CloudFormation skips the stack set operation in this
|
61
61
|
# account and Region.
|
62
62
|
# @return [String]
|
63
63
|
#
|
@@ -86,8 +86,8 @@ module Aws::CloudFormation
|
|
86
86
|
# * Number of stack outputs
|
87
87
|
#
|
88
88
|
# For more information about these account limits, and other
|
89
|
-
# CloudFormation limits, see [
|
90
|
-
# CloudFormation User Guide*.
|
89
|
+
# CloudFormation limits, see [CloudFormation Limits][1] in the
|
90
|
+
# *CloudFormation User Guide*.
|
91
91
|
#
|
92
92
|
#
|
93
93
|
#
|
@@ -113,6 +113,133 @@ module Aws::CloudFormation
|
|
113
113
|
include Aws::Structure
|
114
114
|
end
|
115
115
|
|
116
|
+
# @note When making an API call, you may pass ActivateTypeInput
|
117
|
+
# data as a hash:
|
118
|
+
#
|
119
|
+
# {
|
120
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
121
|
+
# public_type_arn: "ThirdPartyTypeArn",
|
122
|
+
# publisher_id: "PublisherId",
|
123
|
+
# type_name: "TypeName",
|
124
|
+
# type_name_alias: "TypeName",
|
125
|
+
# auto_update: false,
|
126
|
+
# logging_config: {
|
127
|
+
# log_role_arn: "RoleArn", # required
|
128
|
+
# log_group_name: "LogGroupName", # required
|
129
|
+
# },
|
130
|
+
# execution_role_arn: "RoleArn",
|
131
|
+
# version_bump: "MAJOR", # accepts MAJOR, MINOR
|
132
|
+
# major_version: 1,
|
133
|
+
# }
|
134
|
+
#
|
135
|
+
# @!attribute [rw] type
|
136
|
+
# The extension type.
|
137
|
+
#
|
138
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`,
|
139
|
+
# `Type`, and `PublisherId`.
|
140
|
+
# @return [String]
|
141
|
+
#
|
142
|
+
# @!attribute [rw] public_type_arn
|
143
|
+
# The Amazon Resource Number (ARN) of the public extension.
|
144
|
+
#
|
145
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`,
|
146
|
+
# `Type`, and `PublisherId`.
|
147
|
+
# @return [String]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] publisher_id
|
150
|
+
# The ID of the extension publisher.
|
151
|
+
#
|
152
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`,
|
153
|
+
# `Type`, and `PublisherId`.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] type_name
|
157
|
+
# The name of the extension.
|
158
|
+
#
|
159
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`,
|
160
|
+
# `Type`, and `PublisherId`.
|
161
|
+
# @return [String]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] type_name_alias
|
164
|
+
# An alias to assign to the public extension, in this account and
|
165
|
+
# region. If you specify an alias for the extension, CloudFormation
|
166
|
+
# treats the alias as the extension type name within this account and
|
167
|
+
# region. You must use the alias to refer to the extension in your
|
168
|
+
# templates, API calls, and CloudFormation console.
|
169
|
+
#
|
170
|
+
# An extension alias must be unique within a given account and region.
|
171
|
+
# You can activate the same public resource multiple times in the same
|
172
|
+
# account and region, using different type name aliases.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] auto_update
|
176
|
+
# Whether to automatically update the extension in this account and
|
177
|
+
# region when a new *minor* version is published by the extension
|
178
|
+
# publisher. Major versions released by the publisher must be manually
|
179
|
+
# updated.
|
180
|
+
#
|
181
|
+
# The default is `true`.
|
182
|
+
# @return [Boolean]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] logging_config
|
185
|
+
# Contains logging configuration information for an extension.
|
186
|
+
# @return [Types::LoggingConfig]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] execution_role_arn
|
189
|
+
# The name of the IAM execution role to use to activate the extension.
|
190
|
+
# @return [String]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] version_bump
|
193
|
+
# Manually updates a previously-activated type to a new major or minor
|
194
|
+
# version, if available. You can also use this parameter to update the
|
195
|
+
# value of `AutoUpdate`.
|
196
|
+
#
|
197
|
+
# * `MAJOR`\: CloudFormation updates the extension to the newest major
|
198
|
+
# version, if one is available.
|
199
|
+
#
|
200
|
+
# * `MINOR`\: CloudFormation updates the extension to the newest minor
|
201
|
+
# version, if one is available.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] major_version
|
205
|
+
# The major version of this extension you want to activate, if
|
206
|
+
# multiple major versions are available. The default is the latest
|
207
|
+
# major version. CloudFormation uses the latest available *minor*
|
208
|
+
# version of the major version selected.
|
209
|
+
#
|
210
|
+
# You can specify `MajorVersion` or `VersionBump`, but not both.
|
211
|
+
# @return [Integer]
|
212
|
+
#
|
213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeInput AWS API Documentation
|
214
|
+
#
|
215
|
+
class ActivateTypeInput < Struct.new(
|
216
|
+
:type,
|
217
|
+
:public_type_arn,
|
218
|
+
:publisher_id,
|
219
|
+
:type_name,
|
220
|
+
:type_name_alias,
|
221
|
+
:auto_update,
|
222
|
+
:logging_config,
|
223
|
+
:execution_role_arn,
|
224
|
+
:version_bump,
|
225
|
+
:major_version)
|
226
|
+
SENSITIVE = []
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# @!attribute [rw] arn
|
231
|
+
# The Amazon Resource Number (ARN) of the activated extension, in this
|
232
|
+
# account and region.
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeOutput AWS API Documentation
|
236
|
+
#
|
237
|
+
class ActivateTypeOutput < Struct.new(
|
238
|
+
:arn)
|
239
|
+
SENSITIVE = []
|
240
|
+
include Aws::Structure
|
241
|
+
end
|
242
|
+
|
116
243
|
# The resource with the name requested already exists.
|
117
244
|
#
|
118
245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/AlreadyExistsException AWS API Documentation
|
@@ -120,8 +247,8 @@ module Aws::CloudFormation
|
|
120
247
|
class AlreadyExistsException < Aws::EmptyStructure; end
|
121
248
|
|
122
249
|
# \[Service-managed permissions\] Describes whether StackSets
|
123
|
-
# automatically deploys to
|
124
|
-
#
|
250
|
+
# automatically deploys to Organizations accounts that are added to a
|
251
|
+
# target organization or organizational unit (OU).
|
125
252
|
#
|
126
253
|
# @note When making an API call, you may pass AutoDeployment
|
127
254
|
# data as a hash:
|
@@ -133,7 +260,7 @@ module Aws::CloudFormation
|
|
133
260
|
#
|
134
261
|
# @!attribute [rw] enabled
|
135
262
|
# If set to `true`, StackSets automatically deploys additional stack
|
136
|
-
# instances to
|
263
|
+
# instances to Organizations accounts that are added to a target
|
137
264
|
# organization or organizational unit (OU) in the specified Regions.
|
138
265
|
# If an account is removed from a target organization or OU, StackSets
|
139
266
|
# deletes stack instances from the account in the specified Regions.
|
@@ -154,6 +281,84 @@ module Aws::CloudFormation
|
|
154
281
|
include Aws::Structure
|
155
282
|
end
|
156
283
|
|
284
|
+
# Detailed information concerning an error generated during the setting
|
285
|
+
# of configuration data for a CloudFormation extension.
|
286
|
+
#
|
287
|
+
# @!attribute [rw] error_code
|
288
|
+
# The error code.
|
289
|
+
# @return [String]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] error_message
|
292
|
+
# The error message.
|
293
|
+
# @return [String]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] type_configuration_identifier
|
296
|
+
# Identifying information for the configuration of a CloudFormation
|
297
|
+
# extension.
|
298
|
+
# @return [Types::TypeConfigurationIdentifier]
|
299
|
+
#
|
300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsError AWS API Documentation
|
301
|
+
#
|
302
|
+
class BatchDescribeTypeConfigurationsError < Struct.new(
|
303
|
+
:error_code,
|
304
|
+
:error_message,
|
305
|
+
:type_configuration_identifier)
|
306
|
+
SENSITIVE = []
|
307
|
+
include Aws::Structure
|
308
|
+
end
|
309
|
+
|
310
|
+
# @note When making an API call, you may pass BatchDescribeTypeConfigurationsInput
|
311
|
+
# data as a hash:
|
312
|
+
#
|
313
|
+
# {
|
314
|
+
# type_configuration_identifiers: [ # required
|
315
|
+
# {
|
316
|
+
# type_arn: "TypeArn",
|
317
|
+
# type_configuration_alias: "TypeConfigurationAlias",
|
318
|
+
# type_configuration_arn: "TypeConfigurationArn",
|
319
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
320
|
+
# type_name: "TypeName",
|
321
|
+
# },
|
322
|
+
# ],
|
323
|
+
# }
|
324
|
+
#
|
325
|
+
# @!attribute [rw] type_configuration_identifiers
|
326
|
+
# The list of identifiers for the desired extension configurations.
|
327
|
+
# @return [Array<Types::TypeConfigurationIdentifier>]
|
328
|
+
#
|
329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsInput AWS API Documentation
|
330
|
+
#
|
331
|
+
class BatchDescribeTypeConfigurationsInput < Struct.new(
|
332
|
+
:type_configuration_identifiers)
|
333
|
+
SENSITIVE = []
|
334
|
+
include Aws::Structure
|
335
|
+
end
|
336
|
+
|
337
|
+
# @!attribute [rw] errors
|
338
|
+
# A list of information concerning any errors generated during the
|
339
|
+
# setting of the specified configurations.
|
340
|
+
# @return [Array<Types::BatchDescribeTypeConfigurationsError>]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] unprocessed_type_configurations
|
343
|
+
# A list of any of the specified extension configurations that
|
344
|
+
# CloudFormation could not process for any reason.
|
345
|
+
# @return [Array<Types::TypeConfigurationIdentifier>]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] type_configurations
|
348
|
+
# A list of any of the specified extension configurations from the
|
349
|
+
# CloudFormation registry.
|
350
|
+
# @return [Array<Types::TypeConfigurationDetails>]
|
351
|
+
#
|
352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsOutput AWS API Documentation
|
353
|
+
#
|
354
|
+
class BatchDescribeTypeConfigurationsOutput < Struct.new(
|
355
|
+
:errors,
|
356
|
+
:unprocessed_type_configurations,
|
357
|
+
:type_configurations)
|
358
|
+
SENSITIVE = []
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
157
362
|
# An error occurred during a CloudFormation registry operation.
|
158
363
|
#
|
159
364
|
# @!attribute [rw] message
|
@@ -183,10 +388,10 @@ module Aws::CloudFormation
|
|
183
388
|
#
|
184
389
|
# @!attribute [rw] client_request_token
|
185
390
|
# A unique identifier for this `CancelUpdateStack` request. Specify
|
186
|
-
# this token if you plan to retry requests so that
|
391
|
+
# this token if you plan to retry requests so that CloudFormation
|
187
392
|
# knows that you're not attempting to cancel an update on a stack
|
188
393
|
# with the same name. You might retry `CancelUpdateStack` requests to
|
189
|
-
# ensure that
|
394
|
+
# ensure that CloudFormation successfully received them.
|
190
395
|
# @return [String]
|
191
396
|
#
|
192
397
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStackInput AWS API Documentation
|
@@ -198,17 +403,17 @@ module Aws::CloudFormation
|
|
198
403
|
include Aws::Structure
|
199
404
|
end
|
200
405
|
|
201
|
-
# The `Change` structure describes the changes
|
406
|
+
# The `Change` structure describes the changes CloudFormation will
|
202
407
|
# perform if you execute the change set.
|
203
408
|
#
|
204
409
|
# @!attribute [rw] type
|
205
|
-
# The type of entity that
|
206
|
-
#
|
410
|
+
# The type of entity that CloudFormation changes. Currently, the only
|
411
|
+
# entity type is `Resource`.
|
207
412
|
# @return [String]
|
208
413
|
#
|
209
414
|
# @!attribute [rw] resource_change
|
210
415
|
# A `ResourceChange` structure that describes the resource and action
|
211
|
-
# that
|
416
|
+
# that CloudFormation will perform.
|
212
417
|
# @return [Types::ResourceChange]
|
213
418
|
#
|
214
419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Change AWS API Documentation
|
@@ -250,8 +455,8 @@ module Aws::CloudFormation
|
|
250
455
|
# If the change set execution status is `AVAILABLE`, you can execute
|
251
456
|
# the change set. If you can’t execute the change set, the status
|
252
457
|
# indicates why. For example, a change set might be in an
|
253
|
-
# `UNAVAILABLE` state because
|
254
|
-
#
|
458
|
+
# `UNAVAILABLE` state because CloudFormation is still creating it or
|
459
|
+
# in an `OBSOLETE` state because the stack was already updated.
|
255
460
|
# @return [String]
|
256
461
|
#
|
257
462
|
# @!attribute [rw] status
|
@@ -261,8 +466,8 @@ module Aws::CloudFormation
|
|
261
466
|
#
|
262
467
|
# @!attribute [rw] status_reason
|
263
468
|
# A description of the change set's status. For example, if your
|
264
|
-
# change set is in the `FAILED` state,
|
265
|
-
#
|
469
|
+
# change set is in the `FAILED` state, CloudFormation shows the error
|
470
|
+
# message.
|
266
471
|
# @return [String]
|
267
472
|
#
|
268
473
|
# @!attribute [rw] creation_time
|
@@ -330,41 +535,40 @@ module Aws::CloudFormation
|
|
330
535
|
# @return [String]
|
331
536
|
#
|
332
537
|
# @!attribute [rw] role_arn
|
333
|
-
# The Amazon Resource Name (ARN) of an
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
538
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
539
|
+
# (IAM) role that CloudFormation assumes to roll back the stack.
|
540
|
+
# CloudFormation uses the role's credentials to make calls on your
|
541
|
+
# behalf. CloudFormation always uses this role for all future
|
542
|
+
# operations on the stack. As long as users have permission to operate
|
543
|
+
# on the stack, CloudFormation uses this role even if the users don't
|
544
|
+
# have permission to pass it. Ensure that the role grants least
|
545
|
+
# privilege.
|
341
546
|
#
|
342
|
-
# If you don't specify a value,
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
547
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
548
|
+
# previously associated with the stack. If no role is available,
|
549
|
+
# CloudFormation uses a temporary session that is generated from your
|
550
|
+
# user credentials.
|
346
551
|
# @return [String]
|
347
552
|
#
|
348
553
|
# @!attribute [rw] resources_to_skip
|
349
|
-
# A list of the logical IDs of the resources that
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
554
|
+
# A list of the logical IDs of the resources that CloudFormation skips
|
555
|
+
# during the continue update rollback operation. You can specify only
|
556
|
+
# resources that are in the `UPDATE_FAILED` state because a rollback
|
557
|
+
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
558
|
+
# state for other reasons, for example, because an update was
|
559
|
+
# cancelled. To check why a resource update failed, use the
|
355
560
|
# DescribeStackResources action, and view the resource status reason.
|
356
561
|
#
|
357
|
-
# Specify this property to skip rolling back resources that
|
562
|
+
# Specify this property to skip rolling back resources that
|
358
563
|
# CloudFormation can't successfully roll back. We recommend that you
|
359
|
-
# [ troubleshoot][1] resources before skipping them.
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
# unrecoverable.
|
564
|
+
# [ troubleshoot][1] resources before skipping them. CloudFormation
|
565
|
+
# sets the status of the specified resources to `UPDATE_COMPLETE` and
|
566
|
+
# continues to roll back the stack. After the rollback is complete,
|
567
|
+
# the state of the skipped resources will be inconsistent with the
|
568
|
+
# state of the resources in the stack template. Before performing
|
569
|
+
# another stack update, you must update the stack or resources to be
|
570
|
+
# consistent with each other. If you don't, subsequent stack updates
|
571
|
+
# might fail, and the stack will become unrecoverable.
|
368
572
|
#
|
369
573
|
# Specify the minimum number of resources required to successfully
|
370
574
|
# roll back your stack. For example, a failed resource update might
|
@@ -393,10 +597,10 @@ module Aws::CloudFormation
|
|
393
597
|
#
|
394
598
|
# @!attribute [rw] client_request_token
|
395
599
|
# A unique identifier for this `ContinueUpdateRollback` request.
|
396
|
-
# Specify this token if you plan to retry requests so that
|
397
|
-
#
|
600
|
+
# Specify this token if you plan to retry requests so that
|
601
|
+
# CloudFormationknows that you're not attempting to continue the
|
398
602
|
# rollback to a stack with the same name. You might retry
|
399
|
-
# `ContinueUpdateRollback` requests to ensure that
|
603
|
+
# `ContinueUpdateRollback` requests to ensure that CloudFormation
|
400
604
|
# successfully received them.
|
401
605
|
# @return [String]
|
402
606
|
#
|
@@ -472,14 +676,14 @@ module Aws::CloudFormation
|
|
472
676
|
#
|
473
677
|
# @!attribute [rw] stack_name
|
474
678
|
# The name or the unique ID of the stack for which you are creating a
|
475
|
-
# change set.
|
679
|
+
# change set. CloudFormation generates the change set by comparing
|
476
680
|
# this stack's information with the information that you submit, such
|
477
681
|
# as a modified template or different parameter input values.
|
478
682
|
# @return [String]
|
479
683
|
#
|
480
684
|
# @!attribute [rw] template_body
|
481
685
|
# A structure that contains the body of the revised template, with a
|
482
|
-
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
686
|
+
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
483
687
|
# CloudFormation generates the change set by comparing this template
|
484
688
|
# with the template of the stack that you specified.
|
485
689
|
#
|
@@ -489,7 +693,7 @@ module Aws::CloudFormation
|
|
489
693
|
# @!attribute [rw] template_url
|
490
694
|
# The location of the file that contains the revised template. The URL
|
491
695
|
# must point to a template (max size: 460,800 bytes) that is located
|
492
|
-
# in an S3 bucket or a Systems Manager document.
|
696
|
+
# in an S3 bucket or a Systems Manager document. CloudFormation
|
493
697
|
# generates the change set by comparing this template with the stack
|
494
698
|
# that you specified.
|
495
699
|
#
|
@@ -508,15 +712,15 @@ module Aws::CloudFormation
|
|
508
712
|
#
|
509
713
|
# @!attribute [rw] capabilities
|
510
714
|
# In some cases, you must explicitly acknowledge that your stack
|
511
|
-
# template contains certain capabilities in order for
|
512
|
-
#
|
715
|
+
# template contains certain capabilities in order for CloudFormation
|
716
|
+
# to create the stack.
|
513
717
|
#
|
514
718
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
515
719
|
#
|
516
720
|
# Some stack templates might include resources that can affect
|
517
|
-
# permissions in your
|
518
|
-
#
|
519
|
-
#
|
721
|
+
# permissions in your account; for example, by creating new Identity
|
722
|
+
# and Access Management (IAM) users. For those stacks, you must
|
723
|
+
# explicitly acknowledge this by specifying one of these
|
520
724
|
# capabilities.
|
521
725
|
#
|
522
726
|
# The following IAM resources require you to specify either the
|
@@ -527,7 +731,7 @@ module Aws::CloudFormation
|
|
527
731
|
# * If you have IAM resources with custom names, you *must* specify
|
528
732
|
# `CAPABILITY_NAMED_IAM`.
|
529
733
|
#
|
530
|
-
# * If you don't specify either of these capabilities,
|
734
|
+
# * If you don't specify either of these capabilities,
|
531
735
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
532
736
|
#
|
533
737
|
# If your stack template contains these resources, we recommend that
|
@@ -548,7 +752,7 @@ module Aws::CloudFormation
|
|
548
752
|
#
|
549
753
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
550
754
|
#
|
551
|
-
# For more information, see [Acknowledging IAM Resources in
|
755
|
+
# For more information, see [Acknowledging IAM Resources in
|
552
756
|
# CloudFormation Templates][8].
|
553
757
|
#
|
554
758
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -564,7 +768,7 @@ module Aws::CloudFormation
|
|
564
768
|
# reviewing the resulting changes in a change set, you must
|
565
769
|
# acknowledge this capability. This includes the [AWS::Include][9]
|
566
770
|
# and [AWS::Serverless][10] transforms, which are macros hosted by
|
567
|
-
#
|
771
|
+
# CloudFormation.
|
568
772
|
#
|
569
773
|
# <note markdown="1"> This capacity does not apply to creating change sets, and
|
570
774
|
# specifying it when creating change sets has no effect.
|
@@ -576,8 +780,8 @@ module Aws::CloudFormation
|
|
576
780
|
#
|
577
781
|
# </note>
|
578
782
|
#
|
579
|
-
# For more information on macros, see [Using
|
580
|
-
#
|
783
|
+
# For more information on macros, see [Using CloudFormation Macros
|
784
|
+
# to Perform Custom Processing on Templates][11].
|
581
785
|
#
|
582
786
|
#
|
583
787
|
#
|
@@ -600,12 +804,12 @@ module Aws::CloudFormation
|
|
600
804
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
601
805
|
#
|
602
806
|
# If the list of resource types doesn't include a resource type that
|
603
|
-
# you're updating, the stack update fails. By default,
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
807
|
+
# you're updating, the stack update fails. By default, CloudFormation
|
808
|
+
# grants permissions to all resource types. Identity and Access
|
809
|
+
# Management (IAM) uses this parameter for condition keys in IAM
|
810
|
+
# policies for CloudFormation. For more information, see [Controlling
|
811
|
+
# Access with Identity and Access Management][1] in the CloudFormation
|
812
|
+
# User Guide.
|
609
813
|
#
|
610
814
|
#
|
611
815
|
#
|
@@ -613,38 +817,37 @@ module Aws::CloudFormation
|
|
613
817
|
# @return [Array<String>]
|
614
818
|
#
|
615
819
|
# @!attribute [rw] role_arn
|
616
|
-
# The Amazon Resource Name (ARN) of an
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
623
|
-
# least privilege.
|
820
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
821
|
+
# (IAM) role that CloudFormation assumes when executing the change
|
822
|
+
# set. CloudFormation uses the role's credentials to make calls on
|
823
|
+
# your behalf. CloudFormation uses this role for all future operations
|
824
|
+
# on the stack. As long as users have permission to operate on the
|
825
|
+
# stack, CloudFormation uses this role even if the users don't have
|
826
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
624
827
|
#
|
625
|
-
# If you don't specify a value,
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
828
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
829
|
+
# previously associated with the stack. If no role is available,
|
830
|
+
# CloudFormation uses a temporary session that is generated from your
|
831
|
+
# user credentials.
|
629
832
|
# @return [String]
|
630
833
|
#
|
631
834
|
# @!attribute [rw] rollback_configuration
|
632
|
-
# The rollback triggers for
|
835
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
633
836
|
# creation and updating operations, and for the specified monitoring
|
634
837
|
# period afterwards.
|
635
838
|
# @return [Types::RollbackConfiguration]
|
636
839
|
#
|
637
840
|
# @!attribute [rw] notification_arns
|
638
841
|
# The Amazon Resource Names (ARNs) of Amazon Simple Notification
|
639
|
-
# Service (Amazon SNS) topics that
|
640
|
-
#
|
842
|
+
# Service (Amazon SNS) topics that CloudFormation associates with the
|
843
|
+
# stack. To remove all associated notification topics, specify an
|
641
844
|
# empty list.
|
642
845
|
# @return [Array<String>]
|
643
846
|
#
|
644
847
|
# @!attribute [rw] tags
|
645
|
-
# Key-value pairs to associate with this stack.
|
646
|
-
#
|
647
|
-
#
|
848
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
849
|
+
# propagates these tags to resources in the stack. You can specify a
|
850
|
+
# maximum of 50 tags.
|
648
851
|
# @return [Array<Types::Tag>]
|
649
852
|
#
|
650
853
|
# @!attribute [rw] change_set_name
|
@@ -658,10 +861,10 @@ module Aws::CloudFormation
|
|
658
861
|
#
|
659
862
|
# @!attribute [rw] client_token
|
660
863
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
661
|
-
# token if you plan to retry requests so that
|
864
|
+
# token if you plan to retry requests so that CloudFormation knows
|
662
865
|
# that you're not attempting to create another change set with the
|
663
866
|
# same name. You might retry `CreateChangeSet` requests to ensure that
|
664
|
-
#
|
867
|
+
# CloudFormation successfully received them.
|
665
868
|
# @return [String]
|
666
869
|
#
|
667
870
|
# @!attribute [rw] description
|
@@ -674,14 +877,14 @@ module Aws::CloudFormation
|
|
674
877
|
# stack, specify `UPDATE`. To create a change set for an import
|
675
878
|
# operation, specify `IMPORT`.
|
676
879
|
#
|
677
|
-
# If you create a change set for a new stack,
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
880
|
+
# If you create a change set for a new stack, CloudFormation creates a
|
881
|
+
# stack with a unique stack ID, but no template or resources. The
|
882
|
+
# stack will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you
|
883
|
+
# execute the change set.
|
681
884
|
#
|
682
|
-
# By default,
|
683
|
-
#
|
684
|
-
#
|
885
|
+
# By default, CloudFormation specifies `UPDATE`. You can't use the
|
886
|
+
# `UPDATE` type to create a change set for a new stack or the `CREATE`
|
887
|
+
# type to create a change set for an existing stack.
|
685
888
|
#
|
686
889
|
#
|
687
890
|
#
|
@@ -800,7 +1003,7 @@ module Aws::CloudFormation
|
|
800
1003
|
# @!attribute [rw] template_body
|
801
1004
|
# Structure containing the template body with a minimum length of 1
|
802
1005
|
# byte and a maximum length of 51,200 bytes. For more information, go
|
803
|
-
# to [Template Anatomy][1] in the
|
1006
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.
|
804
1007
|
#
|
805
1008
|
# Conditional: You must specify either the `TemplateBody` or the
|
806
1009
|
# `TemplateURL` parameter, but not both.
|
@@ -814,7 +1017,7 @@ module Aws::CloudFormation
|
|
814
1017
|
# Location of file containing the template body. The URL must point to
|
815
1018
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
816
1019
|
# bucket or a Systems Manager document. For more information, go to
|
817
|
-
# the [Template Anatomy][1] in the
|
1020
|
+
# the [Template Anatomy][1] in the CloudFormation User Guide.
|
818
1021
|
#
|
819
1022
|
# Conditional: You must specify either the `TemplateBody` or the
|
820
1023
|
# `TemplateURL` parameter, but not both.
|
@@ -842,7 +1045,7 @@ module Aws::CloudFormation
|
|
842
1045
|
# @return [Boolean]
|
843
1046
|
#
|
844
1047
|
# @!attribute [rw] rollback_configuration
|
845
|
-
# The rollback triggers for
|
1048
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
846
1049
|
# creation and updating operations, and for the specified monitoring
|
847
1050
|
# period afterwards.
|
848
1051
|
# @return [Types::RollbackConfiguration]
|
@@ -861,15 +1064,15 @@ module Aws::CloudFormation
|
|
861
1064
|
#
|
862
1065
|
# @!attribute [rw] capabilities
|
863
1066
|
# In some cases, you must explicitly acknowledge that your stack
|
864
|
-
# template contains certain capabilities in order for
|
865
|
-
#
|
1067
|
+
# template contains certain capabilities in order for CloudFormation
|
1068
|
+
# to create the stack.
|
866
1069
|
#
|
867
1070
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
868
1071
|
#
|
869
1072
|
# Some stack templates might include resources that can affect
|
870
|
-
# permissions in your
|
871
|
-
#
|
872
|
-
#
|
1073
|
+
# permissions in your account; for example, by creating new Identity
|
1074
|
+
# and Access Management (IAM) users. For those stacks, you must
|
1075
|
+
# explicitly acknowledge this by specifying one of these
|
873
1076
|
# capabilities.
|
874
1077
|
#
|
875
1078
|
# The following IAM resources require you to specify either the
|
@@ -880,7 +1083,7 @@ module Aws::CloudFormation
|
|
880
1083
|
# * If you have IAM resources with custom names, you *must* specify
|
881
1084
|
# `CAPABILITY_NAMED_IAM`.
|
882
1085
|
#
|
883
|
-
# * If you don't specify either of these capabilities,
|
1086
|
+
# * If you don't specify either of these capabilities,
|
884
1087
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
885
1088
|
#
|
886
1089
|
# If your stack template contains these resources, we recommend that
|
@@ -901,7 +1104,7 @@ module Aws::CloudFormation
|
|
901
1104
|
#
|
902
1105
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
903
1106
|
#
|
904
|
-
# For more information, see [Acknowledging IAM Resources in
|
1107
|
+
# For more information, see [Acknowledging IAM Resources in
|
905
1108
|
# CloudFormation Templates][8].
|
906
1109
|
#
|
907
1110
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -917,7 +1120,7 @@ module Aws::CloudFormation
|
|
917
1120
|
# reviewing the resulting changes in a change set, you must
|
918
1121
|
# acknowledge this capability. This includes the [AWS::Include][9]
|
919
1122
|
# and [AWS::Serverless][10] transforms, which are macros hosted by
|
920
|
-
#
|
1123
|
+
# CloudFormation.
|
921
1124
|
#
|
922
1125
|
# If you want to create a stack from a stack template that contains
|
923
1126
|
# macros *and* nested stacks, you must create the stack directly
|
@@ -928,11 +1131,11 @@ module Aws::CloudFormation
|
|
928
1131
|
#
|
929
1132
|
# Each macro relies on an underlying Lambda service function for
|
930
1133
|
# processing stack templates. Be aware that the Lambda function
|
931
|
-
# owner can update the function operation without
|
1134
|
+
# owner can update the function operation without CloudFormation
|
932
1135
|
# being notified.
|
933
1136
|
#
|
934
|
-
# For more information, see [Using
|
935
|
-
#
|
1137
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
1138
|
+
# Custom Processing on Templates][11].
|
936
1139
|
#
|
937
1140
|
#
|
938
1141
|
#
|
@@ -953,19 +1156,19 @@ module Aws::CloudFormation
|
|
953
1156
|
# The template resource types that you have permissions to work with
|
954
1157
|
# for this create stack action, such as `AWS::EC2::Instance`,
|
955
1158
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`. Use the following
|
956
|
-
# syntax to describe template resource types: `AWS::*` (for all
|
957
|
-
#
|
1159
|
+
# syntax to describe template resource types: `AWS::*` (for all Amazon
|
1160
|
+
# Web Services resources), `Custom::*` (for all custom resources),
|
958
1161
|
# `Custom::logical_ID ` (for a specific custom resource),
|
959
|
-
# `AWS::service_name::*` (for all resources of a particular
|
960
|
-
# service), and `AWS::service_name::resource_logical_ID `
|
961
|
-
# specific
|
1162
|
+
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
1163
|
+
# Services service), and `AWS::service_name::resource_logical_ID `
|
1164
|
+
# (for a specific Amazon Web Services resource).
|
962
1165
|
#
|
963
1166
|
# If the list of resource types doesn't include a resource that
|
964
|
-
# you're creating, the stack creation fails. By default,
|
965
|
-
# CloudFormation grants permissions to all resource types.
|
966
|
-
#
|
1167
|
+
# you're creating, the stack creation fails. By default,
|
1168
|
+
# CloudFormation grants permissions to all resource types. Identity
|
1169
|
+
# and Access Management (IAM) uses this parameter for
|
967
1170
|
# CloudFormation-specific condition keys in IAM policies. For more
|
968
|
-
# information, see [Controlling Access with
|
1171
|
+
# information, see [Controlling Access with Identity and Access
|
969
1172
|
# Management][1].
|
970
1173
|
#
|
971
1174
|
#
|
@@ -974,19 +1177,19 @@ module Aws::CloudFormation
|
|
974
1177
|
# @return [Array<String>]
|
975
1178
|
#
|
976
1179
|
# @!attribute [rw] role_arn
|
977
|
-
# The Amazon Resource Name (ARN) of an
|
978
|
-
#
|
979
|
-
#
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
984
|
-
#
|
1180
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
1181
|
+
# (IAM) role that CloudFormation assumes to create the stack.
|
1182
|
+
# CloudFormation uses the role's credentials to make calls on your
|
1183
|
+
# behalf. CloudFormation always uses this role for all future
|
1184
|
+
# operations on the stack. As long as users have permission to operate
|
1185
|
+
# on the stack, CloudFormation uses this role even if the users don't
|
1186
|
+
# have permission to pass it. Ensure that the role grants least
|
1187
|
+
# privilege.
|
985
1188
|
#
|
986
|
-
# If you don't specify a value,
|
987
|
-
#
|
988
|
-
#
|
989
|
-
#
|
1189
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
1190
|
+
# previously associated with the stack. If no role is available,
|
1191
|
+
# CloudFormation uses a temporary session that is generated from your
|
1192
|
+
# user credentials.
|
990
1193
|
# @return [String]
|
991
1194
|
#
|
992
1195
|
# @!attribute [rw] on_failure
|
@@ -999,9 +1202,9 @@ module Aws::CloudFormation
|
|
999
1202
|
#
|
1000
1203
|
# @!attribute [rw] stack_policy_body
|
1001
1204
|
# Structure containing the stack policy body. For more information, go
|
1002
|
-
# to [ Prevent Updates to Stack Resources][1] in the *
|
1003
|
-
#
|
1004
|
-
# `
|
1205
|
+
# to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
|
1206
|
+
# User Guide*. You can specify either the `StackPolicyBody` or the
|
1207
|
+
# `StackPolicyURL` parameter, but not both.
|
1005
1208
|
#
|
1006
1209
|
#
|
1007
1210
|
#
|
@@ -1016,17 +1219,17 @@ module Aws::CloudFormation
|
|
1016
1219
|
# @return [String]
|
1017
1220
|
#
|
1018
1221
|
# @!attribute [rw] tags
|
1019
|
-
# Key-value pairs to associate with this stack.
|
1020
|
-
#
|
1222
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
1223
|
+
# propagates these tags to the resources created in the stack. A
|
1021
1224
|
# maximum number of 50 tags can be specified.
|
1022
1225
|
# @return [Array<Types::Tag>]
|
1023
1226
|
#
|
1024
1227
|
# @!attribute [rw] client_request_token
|
1025
1228
|
# A unique identifier for this `CreateStack` request. Specify this
|
1026
|
-
# token if you plan to retry requests so that
|
1229
|
+
# token if you plan to retry requests so that CloudFormation knows
|
1027
1230
|
# that you're not attempting to create a stack with the same name.
|
1028
|
-
# You might retry `CreateStack` requests to ensure that
|
1029
|
-
#
|
1231
|
+
# You might retry `CreateStack` requests to ensure that CloudFormation
|
1232
|
+
# successfully received them.
|
1030
1233
|
#
|
1031
1234
|
# All events triggered by a given stack operation are assigned the
|
1032
1235
|
# same client request token, which you can use to track operations.
|
@@ -1048,8 +1251,8 @@ module Aws::CloudFormation
|
|
1048
1251
|
# a user attempts to delete a stack with termination protection
|
1049
1252
|
# enabled, the operation fails and the stack remains unchanged. For
|
1050
1253
|
# more information, see [Protecting a Stack From Being Deleted][1] in
|
1051
|
-
# the *
|
1052
|
-
#
|
1254
|
+
# the *CloudFormation User Guide*. Termination protection is disabled
|
1255
|
+
# on stacks by default.
|
1053
1256
|
#
|
1054
1257
|
# For [nested stacks][2], termination protection is set on the root
|
1055
1258
|
# stack and cannot be changed directly on the nested stack.
|
@@ -1122,23 +1325,22 @@ module Aws::CloudFormation
|
|
1122
1325
|
# @return [String]
|
1123
1326
|
#
|
1124
1327
|
# @!attribute [rw] accounts
|
1125
|
-
# \[Self-managed permissions\] The names of one or more
|
1126
|
-
#
|
1127
|
-
# for.
|
1328
|
+
# \[Self-managed permissions\] The names of one or more accounts that
|
1329
|
+
# you want to create stack instances in the specified Region(s) for.
|
1128
1330
|
#
|
1129
1331
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1130
1332
|
# @return [Array<String>]
|
1131
1333
|
#
|
1132
1334
|
# @!attribute [rw] deployment_targets
|
1133
|
-
# \[Service-managed permissions\] The
|
1134
|
-
#
|
1335
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
1336
|
+
# to create stack instances in the specified Regions.
|
1135
1337
|
#
|
1136
1338
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1137
1339
|
# @return [Types::DeploymentTargets]
|
1138
1340
|
#
|
1139
1341
|
# @!attribute [rw] regions
|
1140
1342
|
# The names of one or more Regions where you want to create stack
|
1141
|
-
# instances using the specified
|
1343
|
+
# instances using the specified accounts.
|
1142
1344
|
# @return [Array<String>]
|
1143
1345
|
#
|
1144
1346
|
# @!attribute [rw] parameter_overrides
|
@@ -1147,24 +1349,19 @@ module Aws::CloudFormation
|
|
1147
1349
|
#
|
1148
1350
|
# Any overridden parameter values will be applied to all stack
|
1149
1351
|
# instances in the specified accounts and Regions. When specifying
|
1150
|
-
# parameters and their values, be aware of how
|
1352
|
+
# parameters and their values, be aware of how CloudFormation sets
|
1151
1353
|
# parameter values during stack instance operations:
|
1152
1354
|
#
|
1153
1355
|
# * To override the current value for a parameter, include the
|
1154
1356
|
# parameter and specify its value.
|
1155
1357
|
#
|
1156
|
-
# * To leave
|
1157
|
-
# the
|
1158
|
-
#
|
1159
|
-
# * Do not include the parameter in the list.
|
1160
|
-
#
|
1161
|
-
# * Include the parameter and specify `UsePreviousValue` as `true`.
|
1162
|
-
# (You cannot specify both a value and set `UsePreviousValue` to
|
1163
|
-
# `true`.)
|
1358
|
+
# * To leave an overridden parameter set to its present value, include
|
1359
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You
|
1360
|
+
# cannot specify both a value and set `UsePreviousValue` to `true`.)
|
1164
1361
|
#
|
1165
|
-
# * To set
|
1166
|
-
#
|
1167
|
-
#
|
1362
|
+
# * To set an overridden parameter back to the value specified in the
|
1363
|
+
# stack set, specify a parameter list but do not include the
|
1364
|
+
# parameter in the list.
|
1168
1365
|
#
|
1169
1366
|
# * To leave all parameters set to their present values, do not
|
1170
1367
|
# specify this property at all.
|
@@ -1182,7 +1379,7 @@ module Aws::CloudFormation
|
|
1182
1379
|
# @return [Array<Types::Parameter>]
|
1183
1380
|
#
|
1184
1381
|
# @!attribute [rw] operation_preferences
|
1185
|
-
# Preferences for how
|
1382
|
+
# Preferences for how CloudFormation performs this stack set
|
1186
1383
|
# operation.
|
1187
1384
|
# @return [Types::StackSetOperationPreferences]
|
1188
1385
|
#
|
@@ -1190,10 +1387,10 @@ module Aws::CloudFormation
|
|
1190
1387
|
# The unique identifier for this stack set operation.
|
1191
1388
|
#
|
1192
1389
|
# The operation ID also functions as an idempotency token, to ensure
|
1193
|
-
# that
|
1194
|
-
#
|
1195
|
-
#
|
1196
|
-
#
|
1390
|
+
# that CloudFormation performs the stack set operation only once, even
|
1391
|
+
# if you retry the request multiple times. You might retry stack set
|
1392
|
+
# operation requests to ensure that CloudFormation successfully
|
1393
|
+
# received them.
|
1197
1394
|
#
|
1198
1395
|
# If you don't specify an operation ID, the SDK generates one
|
1199
1396
|
# automatically.
|
@@ -1218,10 +1415,9 @@ module Aws::CloudFormation
|
|
1218
1415
|
# * If you are signed in to a delegated administrator account, specify
|
1219
1416
|
# `DELEGATED_ADMIN`.
|
1220
1417
|
#
|
1221
|
-
# Your
|
1222
|
-
#
|
1223
|
-
# delegated administrator][1] in the *
|
1224
|
-
# Guide*.
|
1418
|
+
# Your account must be registered as a delegated administrator in
|
1419
|
+
# the management account. For more information, see [Register a
|
1420
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
1225
1421
|
#
|
1226
1422
|
#
|
1227
1423
|
#
|
@@ -1277,6 +1473,7 @@ module Aws::CloudFormation
|
|
1277
1473
|
# description: "Description",
|
1278
1474
|
# template_body: "TemplateBody",
|
1279
1475
|
# template_url: "TemplateURL",
|
1476
|
+
# stack_id: "StackId",
|
1280
1477
|
# parameters: [
|
1281
1478
|
# {
|
1282
1479
|
# parameter_key: "ParameterKey",
|
@@ -1322,8 +1519,8 @@ module Aws::CloudFormation
|
|
1322
1519
|
# @!attribute [rw] template_body
|
1323
1520
|
# The structure that contains the template body, with a minimum length
|
1324
1521
|
# of 1 byte and a maximum length of 51,200 bytes. For more
|
1325
|
-
# information, see [Template Anatomy][1] in the
|
1326
|
-
#
|
1522
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
1523
|
+
# Guide.
|
1327
1524
|
#
|
1328
1525
|
# Conditional: You must specify either the TemplateBody or the
|
1329
1526
|
# TemplateURL parameter, but not both.
|
@@ -1337,8 +1534,8 @@ module Aws::CloudFormation
|
|
1337
1534
|
# The location of the file that contains the template body. The URL
|
1338
1535
|
# must point to a template (maximum size: 460,800 bytes) that's
|
1339
1536
|
# located in an Amazon S3 bucket or a Systems Manager document. For
|
1340
|
-
# more information, see [Template Anatomy][1] in the
|
1341
|
-
#
|
1537
|
+
# more information, see [Template Anatomy][1] in the CloudFormation
|
1538
|
+
# User Guide.
|
1342
1539
|
#
|
1343
1540
|
# Conditional: You must specify either the TemplateBody or the
|
1344
1541
|
# TemplateURL parameter, but not both.
|
@@ -1348,21 +1545,26 @@ module Aws::CloudFormation
|
|
1348
1545
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
1349
1546
|
# @return [String]
|
1350
1547
|
#
|
1548
|
+
# @!attribute [rw] stack_id
|
1549
|
+
# The stack ID you are importing into a new stack set. Specify the
|
1550
|
+
# Amazon Resource Number (ARN) of the stack.
|
1551
|
+
# @return [String]
|
1552
|
+
#
|
1351
1553
|
# @!attribute [rw] parameters
|
1352
1554
|
# The input parameters for the stack set template.
|
1353
1555
|
# @return [Array<Types::Parameter>]
|
1354
1556
|
#
|
1355
1557
|
# @!attribute [rw] capabilities
|
1356
1558
|
# In some cases, you must explicitly acknowledge that your stack set
|
1357
|
-
# template contains certain capabilities in order for
|
1358
|
-
#
|
1559
|
+
# template contains certain capabilities in order for CloudFormation
|
1560
|
+
# to create the stack set and related stack instances.
|
1359
1561
|
#
|
1360
1562
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
1361
1563
|
#
|
1362
1564
|
# Some stack templates might include resources that can affect
|
1363
|
-
# permissions in your
|
1364
|
-
#
|
1365
|
-
#
|
1565
|
+
# permissions in your account; for example, by creating new Identity
|
1566
|
+
# and Access Management (IAM) users. For those stack sets, you must
|
1567
|
+
# explicitly acknowledge this by specifying one of these
|
1366
1568
|
# capabilities.
|
1367
1569
|
#
|
1368
1570
|
# The following IAM resources require you to specify either the
|
@@ -1373,7 +1575,7 @@ module Aws::CloudFormation
|
|
1373
1575
|
# * If you have IAM resources with custom names, you *must* specify
|
1374
1576
|
# `CAPABILITY_NAMED_IAM`.
|
1375
1577
|
#
|
1376
|
-
# * If you don't specify either of these capabilities,
|
1578
|
+
# * If you don't specify either of these capabilities,
|
1377
1579
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
1378
1580
|
#
|
1379
1581
|
# If your stack template contains these resources, we recommend that
|
@@ -1394,25 +1596,26 @@ module Aws::CloudFormation
|
|
1394
1596
|
#
|
1395
1597
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
1396
1598
|
#
|
1397
|
-
# For more information, see [Acknowledging IAM Resources in
|
1599
|
+
# For more information, see [Acknowledging IAM Resources in
|
1398
1600
|
# CloudFormation Templates][8].
|
1399
1601
|
#
|
1400
1602
|
# * `CAPABILITY_AUTO_EXPAND`
|
1401
1603
|
#
|
1402
|
-
# Some templates
|
1403
|
-
# or more macros,
|
1404
|
-
# processed template, without first reviewing the
|
1405
|
-
# in a change set
|
1406
|
-
#
|
1407
|
-
#
|
1604
|
+
# Some templates reference macros. If your stack set template
|
1605
|
+
# references one or more macros, you must create the stack set
|
1606
|
+
# directly from the processed template, without first reviewing the
|
1607
|
+
# resulting changes in a change set. To create the stack set
|
1608
|
+
# directly, you must acknowledge this capability. For more
|
1609
|
+
# information, see [Using CloudFormation Macros to Perform Custom
|
1610
|
+
# Processing on Templates][9].
|
1408
1611
|
#
|
1409
|
-
#
|
1410
|
-
# (This includes the
|
1411
|
-
# transforms, which are
|
1412
|
-
#
|
1413
|
-
#
|
1414
|
-
#
|
1415
|
-
#
|
1612
|
+
# Stack sets with service-managed permissions do not currently
|
1613
|
+
# support the use of macros in templates. (This includes the
|
1614
|
+
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1615
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
1616
|
+
# capability for a stack set with service-managed permissions, if
|
1617
|
+
# you reference a macro in your template the stack set operation
|
1618
|
+
# will fail.
|
1416
1619
|
#
|
1417
1620
|
#
|
1418
1621
|
#
|
@@ -1431,11 +1634,11 @@ module Aws::CloudFormation
|
|
1431
1634
|
#
|
1432
1635
|
# @!attribute [rw] tags
|
1433
1636
|
# The key-value pairs to associate with this stack set and the stacks
|
1434
|
-
# created from it.
|
1637
|
+
# created from it. CloudFormation also propagates these tags to
|
1435
1638
|
# supported resources that are created in the stacks. A maximum number
|
1436
1639
|
# of 50 tags can be specified.
|
1437
1640
|
#
|
1438
|
-
# If you specify tags as part of a `CreateStackSet` action,
|
1641
|
+
# If you specify tags as part of a `CreateStackSet` action,
|
1439
1642
|
# CloudFormation checks to see if you have the required IAM permission
|
1440
1643
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
1441
1644
|
# fails with an `access denied` error, and the stack set is not
|
@@ -1450,7 +1653,7 @@ module Aws::CloudFormation
|
|
1450
1653
|
# roles to control which users or groups can manage specific stack
|
1451
1654
|
# sets within the same administrator account. For more information,
|
1452
1655
|
# see [Prerequisites: Granting Permissions for Stack Set
|
1453
|
-
# Operations][1] in the *
|
1656
|
+
# Operations][1] in the *CloudFormation User Guide*.
|
1454
1657
|
#
|
1455
1658
|
#
|
1456
1659
|
#
|
@@ -1459,7 +1662,7 @@ module Aws::CloudFormation
|
|
1459
1662
|
#
|
1460
1663
|
# @!attribute [rw] execution_role_name
|
1461
1664
|
# The name of the IAM execution role to use to create the stack set.
|
1462
|
-
# If you do not specify an execution role,
|
1665
|
+
# If you do not specify an execution role, CloudFormation uses the
|
1463
1666
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
1464
1667
|
# operation.
|
1465
1668
|
#
|
@@ -1479,8 +1682,8 @@ module Aws::CloudFormation
|
|
1479
1682
|
#
|
1480
1683
|
# * With `service-managed` permissions, StackSets automatically
|
1481
1684
|
# creates the IAM roles required to deploy to accounts managed by
|
1482
|
-
#
|
1483
|
-
#
|
1685
|
+
# Organizations. For more information, see [Grant Service-Managed
|
1686
|
+
# Stack Set Permissions][2].
|
1484
1687
|
#
|
1485
1688
|
#
|
1486
1689
|
#
|
@@ -1489,10 +1692,9 @@ module Aws::CloudFormation
|
|
1489
1692
|
# @return [String]
|
1490
1693
|
#
|
1491
1694
|
# @!attribute [rw] auto_deployment
|
1492
|
-
# Describes whether StackSets automatically deploys to
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
# `SERVICE_MANAGED`.
|
1695
|
+
# Describes whether StackSets automatically deploys to Organizations
|
1696
|
+
# accounts that are added to the target organization or organizational
|
1697
|
+
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
|
1496
1698
|
# @return [Types::AutoDeployment]
|
1497
1699
|
#
|
1498
1700
|
# @!attribute [rw] call_as
|
@@ -1510,10 +1712,9 @@ module Aws::CloudFormation
|
|
1510
1712
|
# signed in to a delegated administrator account, specify
|
1511
1713
|
# `DELEGATED_ADMIN`.
|
1512
1714
|
#
|
1513
|
-
# Your
|
1715
|
+
# Your account must be registered as a delegated admin in the
|
1514
1716
|
# management account. For more information, see [Register a
|
1515
|
-
# delegated administrator][1] in the *
|
1516
|
-
# Guide*.
|
1717
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
1517
1718
|
#
|
1518
1719
|
# Stack sets with service-managed permissions are created in the
|
1519
1720
|
# management account, including stack sets that are created by
|
@@ -1526,10 +1727,10 @@ module Aws::CloudFormation
|
|
1526
1727
|
#
|
1527
1728
|
# @!attribute [rw] client_request_token
|
1528
1729
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
1529
|
-
# token if you plan to retry requests so that
|
1730
|
+
# token if you plan to retry requests so that CloudFormation knows
|
1530
1731
|
# that you're not attempting to create another stack set with the
|
1531
1732
|
# same name. You might retry `CreateStackSet` requests to ensure that
|
1532
|
-
#
|
1733
|
+
# CloudFormation successfully received them.
|
1533
1734
|
#
|
1534
1735
|
# If you don't specify an operation ID, the SDK generates one
|
1535
1736
|
# automatically.
|
@@ -1545,6 +1746,7 @@ module Aws::CloudFormation
|
|
1545
1746
|
:description,
|
1546
1747
|
:template_body,
|
1547
1748
|
:template_url,
|
1749
|
+
:stack_id,
|
1548
1750
|
:parameters,
|
1549
1751
|
:capabilities,
|
1550
1752
|
:tags,
|
@@ -1576,6 +1778,53 @@ module Aws::CloudFormation
|
|
1576
1778
|
#
|
1577
1779
|
class CreatedButModifiedException < Aws::EmptyStructure; end
|
1578
1780
|
|
1781
|
+
# @note When making an API call, you may pass DeactivateTypeInput
|
1782
|
+
# data as a hash:
|
1783
|
+
#
|
1784
|
+
# {
|
1785
|
+
# type_name: "TypeName",
|
1786
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1787
|
+
# arn: "PrivateTypeArn",
|
1788
|
+
# }
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] type_name
|
1791
|
+
# The type name of the extension, in this account and region. If you
|
1792
|
+
# specified a type name alias when enabling the extension, use the
|
1793
|
+
# type name alias.
|
1794
|
+
#
|
1795
|
+
# Conditional: You must specify either `Arn`, or `TypeName` and
|
1796
|
+
# `Type`.
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] type
|
1800
|
+
# The extension type.
|
1801
|
+
#
|
1802
|
+
# Conditional: You must specify either `Arn`, or `TypeName` and
|
1803
|
+
# `Type`.
|
1804
|
+
# @return [String]
|
1805
|
+
#
|
1806
|
+
# @!attribute [rw] arn
|
1807
|
+
# The Amazon Resource Name (ARN) for the extension, in this account
|
1808
|
+
# and region.
|
1809
|
+
#
|
1810
|
+
# Conditional: You must specify either `Arn`, or `TypeName` and
|
1811
|
+
# `Type`.
|
1812
|
+
# @return [String]
|
1813
|
+
#
|
1814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateTypeInput AWS API Documentation
|
1815
|
+
#
|
1816
|
+
class DeactivateTypeInput < Struct.new(
|
1817
|
+
:type_name,
|
1818
|
+
:type,
|
1819
|
+
:arn)
|
1820
|
+
SENSITIVE = []
|
1821
|
+
include Aws::Structure
|
1822
|
+
end
|
1823
|
+
|
1824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateTypeOutput AWS API Documentation
|
1825
|
+
#
|
1826
|
+
class DeactivateTypeOutput < Aws::EmptyStructure; end
|
1827
|
+
|
1579
1828
|
# The input for the DeleteChangeSet action.
|
1580
1829
|
#
|
1581
1830
|
# @note When making an API call, you may pass DeleteChangeSetInput
|
@@ -1630,7 +1879,7 @@ module Aws::CloudFormation
|
|
1630
1879
|
# @!attribute [rw] retain_resources
|
1631
1880
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1632
1881
|
# IDs that are associated with the resources you want to retain.
|
1633
|
-
# During deletion,
|
1882
|
+
# During deletion, CloudFormation deletes the stack but does not
|
1634
1883
|
# delete the retained resources.
|
1635
1884
|
#
|
1636
1885
|
# Retaining resources is useful when you cannot delete a resource,
|
@@ -1638,23 +1887,23 @@ module Aws::CloudFormation
|
|
1638
1887
|
# @return [Array<String>]
|
1639
1888
|
#
|
1640
1889
|
# @!attribute [rw] role_arn
|
1641
|
-
# The Amazon Resource Name (ARN) of an
|
1642
|
-
#
|
1643
|
-
#
|
1644
|
-
#
|
1890
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
1891
|
+
# (IAM) role that CloudFormation assumes to delete the stack.
|
1892
|
+
# CloudFormation uses the role's credentials to make calls on your
|
1893
|
+
# behalf.
|
1645
1894
|
#
|
1646
|
-
# If you don't specify a value,
|
1647
|
-
#
|
1648
|
-
#
|
1649
|
-
#
|
1895
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
1896
|
+
# previously associated with the stack. If no role is available,
|
1897
|
+
# CloudFormation uses a temporary session that is generated from your
|
1898
|
+
# user credentials.
|
1650
1899
|
# @return [String]
|
1651
1900
|
#
|
1652
1901
|
# @!attribute [rw] client_request_token
|
1653
1902
|
# A unique identifier for this `DeleteStack` request. Specify this
|
1654
|
-
# token if you plan to retry requests so that
|
1903
|
+
# token if you plan to retry requests so that CloudFormation knows
|
1655
1904
|
# that you're not attempting to delete a stack with the same name.
|
1656
|
-
# You might retry `DeleteStack` requests to ensure that
|
1657
|
-
#
|
1905
|
+
# You might retry `DeleteStack` requests to ensure that CloudFormation
|
1906
|
+
# successfully received them.
|
1658
1907
|
#
|
1659
1908
|
# All events triggered by a given stack operation are assigned the
|
1660
1909
|
# same client request token, which you can use to track operations.
|
@@ -1713,14 +1962,14 @@ module Aws::CloudFormation
|
|
1713
1962
|
# @return [String]
|
1714
1963
|
#
|
1715
1964
|
# @!attribute [rw] accounts
|
1716
|
-
# \[Self-managed permissions\] The names of the
|
1717
|
-
#
|
1965
|
+
# \[Self-managed permissions\] The names of the accounts that you want
|
1966
|
+
# to delete stack instances for.
|
1718
1967
|
#
|
1719
1968
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1720
1969
|
# @return [Array<String>]
|
1721
1970
|
#
|
1722
1971
|
# @!attribute [rw] deployment_targets
|
1723
|
-
# \[Service-managed permissions\] The
|
1972
|
+
# \[Service-managed permissions\] The Organizations accounts from
|
1724
1973
|
# which to delete stack instances.
|
1725
1974
|
#
|
1726
1975
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
@@ -1731,7 +1980,7 @@ module Aws::CloudFormation
|
|
1731
1980
|
# @return [Array<String>]
|
1732
1981
|
#
|
1733
1982
|
# @!attribute [rw] operation_preferences
|
1734
|
-
# Preferences for how
|
1983
|
+
# Preferences for how CloudFormation performs this stack set
|
1735
1984
|
# operation.
|
1736
1985
|
# @return [Types::StackSetOperationPreferences]
|
1737
1986
|
#
|
@@ -1754,10 +2003,10 @@ module Aws::CloudFormation
|
|
1754
2003
|
# automatically.
|
1755
2004
|
#
|
1756
2005
|
# The operation ID also functions as an idempotency token, to ensure
|
1757
|
-
# that
|
1758
|
-
#
|
1759
|
-
#
|
1760
|
-
#
|
2006
|
+
# that CloudFormation performs the stack set operation only once, even
|
2007
|
+
# if you retry the request multiple times. You can retry stack set
|
2008
|
+
# operation requests to ensure that CloudFormation successfully
|
2009
|
+
# received them.
|
1761
2010
|
#
|
1762
2011
|
# Repeating this stack set operation with a new operation ID retries
|
1763
2012
|
# all stack instances whose status is `OUTDATED`.
|
@@ -1779,10 +2028,9 @@ module Aws::CloudFormation
|
|
1779
2028
|
# * If you are signed in to a delegated administrator account, specify
|
1780
2029
|
# `DELEGATED_ADMIN`.
|
1781
2030
|
#
|
1782
|
-
# Your
|
1783
|
-
#
|
1784
|
-
# delegated administrator][1] in the *
|
1785
|
-
# Guide*.
|
2031
|
+
# Your account must be registered as a delegated administrator in
|
2032
|
+
# the management account. For more information, see [Register a
|
2033
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
1786
2034
|
#
|
1787
2035
|
#
|
1788
2036
|
#
|
@@ -1842,10 +2090,9 @@ module Aws::CloudFormation
|
|
1842
2090
|
# * If you are signed in to a delegated administrator account, specify
|
1843
2091
|
# `DELEGATED_ADMIN`.
|
1844
2092
|
#
|
1845
|
-
# Your
|
1846
|
-
#
|
1847
|
-
# delegated administrator][1] in the *
|
1848
|
-
# Guide*.
|
2093
|
+
# Your account must be registered as a delegated administrator in
|
2094
|
+
# the management account. For more information, see [Register a
|
2095
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
1849
2096
|
#
|
1850
2097
|
#
|
1851
2098
|
#
|
@@ -1865,11 +2112,10 @@ module Aws::CloudFormation
|
|
1865
2112
|
#
|
1866
2113
|
class DeleteStackSetOutput < Aws::EmptyStructure; end
|
1867
2114
|
|
1868
|
-
# \[Service-managed permissions\] The
|
1869
|
-
#
|
1870
|
-
#
|
1871
|
-
#
|
1872
|
-
# organization.
|
2115
|
+
# \[Service-managed permissions\] The Organizations accounts to which
|
2116
|
+
# StackSets deploys. StackSets does not deploy stack instances to the
|
2117
|
+
# organization management account, even if the organization management
|
2118
|
+
# account is in your organization or in an OU in your organization.
|
1873
2119
|
#
|
1874
2120
|
# For update operations, you can specify either `Accounts` or
|
1875
2121
|
# `OrganizationalUnitIds`. For create and delete operations, specify
|
@@ -1885,11 +2131,12 @@ module Aws::CloudFormation
|
|
1885
2131
|
# }
|
1886
2132
|
#
|
1887
2133
|
# @!attribute [rw] accounts
|
1888
|
-
# The names of one or more
|
1889
|
-
#
|
2134
|
+
# The names of one or more accounts for which you want to deploy stack
|
2135
|
+
# set updates.
|
1890
2136
|
# @return [Array<String>]
|
1891
2137
|
#
|
1892
2138
|
# @!attribute [rw] accounts_url
|
2139
|
+
# Returns the value of the `AccountsUrl` property.
|
1893
2140
|
# @return [String]
|
1894
2141
|
#
|
1895
2142
|
# @!attribute [rw] organizational_unit_ids
|
@@ -1984,7 +2231,7 @@ module Aws::CloudFormation
|
|
1984
2231
|
# The output for the DescribeAccountLimits action.
|
1985
2232
|
#
|
1986
2233
|
# @!attribute [rw] account_limits
|
1987
|
-
# An account limit structure that contain a list of
|
2234
|
+
# An account limit structure that contain a list of CloudFormation
|
1988
2235
|
# account limits and their values.
|
1989
2236
|
# @return [Array<Types::AccountLimit>]
|
1990
2237
|
#
|
@@ -2079,8 +2326,8 @@ module Aws::CloudFormation
|
|
2079
2326
|
# If the change set execution status is `AVAILABLE`, you can execute
|
2080
2327
|
# the change set. If you can’t execute the change set, the status
|
2081
2328
|
# indicates why. For example, a change set might be in an
|
2082
|
-
# `UNAVAILABLE` state because
|
2083
|
-
#
|
2329
|
+
# `UNAVAILABLE` state because CloudFormation is still creating it or
|
2330
|
+
# in an `OBSOLETE` state because the stack was already updated.
|
2084
2331
|
# @return [String]
|
2085
2332
|
#
|
2086
2333
|
# @!attribute [rw] status
|
@@ -2090,7 +2337,7 @@ module Aws::CloudFormation
|
|
2090
2337
|
#
|
2091
2338
|
# @!attribute [rw] status_reason
|
2092
2339
|
# A description of the change set's status. For example, if your
|
2093
|
-
# attempt to create a change set failed,
|
2340
|
+
# attempt to create a change set failed, CloudFormation shows the
|
2094
2341
|
# error message.
|
2095
2342
|
# @return [String]
|
2096
2343
|
#
|
@@ -2101,7 +2348,7 @@ module Aws::CloudFormation
|
|
2101
2348
|
# @return [Array<String>]
|
2102
2349
|
#
|
2103
2350
|
# @!attribute [rw] rollback_configuration
|
2104
|
-
# The rollback triggers for
|
2351
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
2105
2352
|
# creation and updating operations, and for the specified monitoring
|
2106
2353
|
# period afterwards.
|
2107
2354
|
# @return [Types::RollbackConfiguration]
|
@@ -2117,7 +2364,7 @@ module Aws::CloudFormation
|
|
2117
2364
|
# @return [Array<Types::Tag>]
|
2118
2365
|
#
|
2119
2366
|
# @!attribute [rw] changes
|
2120
|
-
# A list of `Change` structures that describes the resources
|
2367
|
+
# A list of `Change` structures that describes the resources
|
2121
2368
|
# CloudFormation changes if you execute the change set.
|
2122
2369
|
# @return [Array<Types::Change>]
|
2123
2370
|
#
|
@@ -2166,6 +2413,58 @@ module Aws::CloudFormation
|
|
2166
2413
|
include Aws::Structure
|
2167
2414
|
end
|
2168
2415
|
|
2416
|
+
# @note When making an API call, you may pass DescribePublisherInput
|
2417
|
+
# data as a hash:
|
2418
|
+
#
|
2419
|
+
# {
|
2420
|
+
# publisher_id: "PublisherId",
|
2421
|
+
# }
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] publisher_id
|
2424
|
+
# The ID of the extension publisher.
|
2425
|
+
#
|
2426
|
+
# If you do not supply a `PublisherId`, and you have registered as an
|
2427
|
+
# extension publisher, `DescribePublisher` returns information about
|
2428
|
+
# your own publisher account.
|
2429
|
+
# @return [String]
|
2430
|
+
#
|
2431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisherInput AWS API Documentation
|
2432
|
+
#
|
2433
|
+
class DescribePublisherInput < Struct.new(
|
2434
|
+
:publisher_id)
|
2435
|
+
SENSITIVE = []
|
2436
|
+
include Aws::Structure
|
2437
|
+
end
|
2438
|
+
|
2439
|
+
# @!attribute [rw] publisher_id
|
2440
|
+
# The ID of the extension publisher.
|
2441
|
+
# @return [String]
|
2442
|
+
#
|
2443
|
+
# @!attribute [rw] publisher_status
|
2444
|
+
# Whether the publisher is verified. Currently, all registered
|
2445
|
+
# publishers are verified.
|
2446
|
+
# @return [String]
|
2447
|
+
#
|
2448
|
+
# @!attribute [rw] identity_provider
|
2449
|
+
# The type of account used as the identity provider when registering
|
2450
|
+
# this publisher with CloudFormation.
|
2451
|
+
# @return [String]
|
2452
|
+
#
|
2453
|
+
# @!attribute [rw] publisher_profile
|
2454
|
+
# The URL to the publisher's profile with the identity provider.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisherOutput AWS API Documentation
|
2458
|
+
#
|
2459
|
+
class DescribePublisherOutput < Struct.new(
|
2460
|
+
:publisher_id,
|
2461
|
+
:publisher_status,
|
2462
|
+
:identity_provider,
|
2463
|
+
:publisher_profile)
|
2464
|
+
SENSITIVE = []
|
2465
|
+
include Aws::Structure
|
2466
|
+
end
|
2467
|
+
|
2169
2468
|
# @note When making an API call, you may pass DescribeStackDriftDetectionStatusInput
|
2170
2469
|
# data as a hash:
|
2171
2470
|
#
|
@@ -2176,9 +2475,9 @@ module Aws::CloudFormation
|
|
2176
2475
|
# @!attribute [rw] stack_drift_detection_id
|
2177
2476
|
# The ID of the drift detection results of this operation.
|
2178
2477
|
#
|
2179
|
-
#
|
2180
|
-
#
|
2181
|
-
# results
|
2478
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
2479
|
+
# each time this operation is run. However, the number of drift
|
2480
|
+
# results CloudFormation retains for any given stack, and for how
|
2182
2481
|
# long, may vary.
|
2183
2482
|
# @return [String]
|
2184
2483
|
#
|
@@ -2197,10 +2496,10 @@ module Aws::CloudFormation
|
|
2197
2496
|
# @!attribute [rw] stack_drift_detection_id
|
2198
2497
|
# The ID of the drift detection results of this operation.
|
2199
2498
|
#
|
2200
|
-
#
|
2201
|
-
#
|
2202
|
-
#
|
2203
|
-
#
|
2499
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
2500
|
+
# each time this operation is run. However, the number of reports
|
2501
|
+
# CloudFormation retains for any given stack, and for how long, may
|
2502
|
+
# vary.
|
2204
2503
|
# @return [String]
|
2205
2504
|
#
|
2206
2505
|
# @!attribute [rw] stack_drift_status
|
@@ -2211,7 +2510,7 @@ module Aws::CloudFormation
|
|
2211
2510
|
# configuration. A stack is considered to have drifted if one or
|
2212
2511
|
# more of its resources have drifted.
|
2213
2512
|
#
|
2214
|
-
# * `NOT_CHECKED`\:
|
2513
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
2215
2514
|
# differs from its expected template configuration.
|
2216
2515
|
#
|
2217
2516
|
# * `IN_SYNC`\: The stack's actual configuration matches its expected
|
@@ -2228,13 +2527,13 @@ module Aws::CloudFormation
|
|
2228
2527
|
# drift detection. (Resources that do not currently support stack
|
2229
2528
|
# detection remain unchecked.)
|
2230
2529
|
#
|
2231
|
-
# If you specified logical resource IDs for
|
2232
|
-
#
|
2530
|
+
# If you specified logical resource IDs for CloudFormation to use as
|
2531
|
+
# a filter for the stack drift detection operation, only the
|
2233
2532
|
# resources with those logical IDs are checked for drift.
|
2234
2533
|
#
|
2235
2534
|
# * `DETECTION_FAILED`\: The stack drift detection operation has
|
2236
2535
|
# failed for at least one resource in the stack. Results will be
|
2237
|
-
# available for resources on which
|
2536
|
+
# available for resources on which CloudFormation successfully
|
2238
2537
|
# completed drift detection.
|
2239
2538
|
#
|
2240
2539
|
# * `DETECTION_IN_PROGRESS`\: The stack drift detection operation is
|
@@ -2344,8 +2643,7 @@ module Aws::CloudFormation
|
|
2344
2643
|
# @return [String]
|
2345
2644
|
#
|
2346
2645
|
# @!attribute [rw] stack_instance_account
|
2347
|
-
# The ID of an
|
2348
|
-
# instance.
|
2646
|
+
# The ID of an account that's associated with this stack instance.
|
2349
2647
|
# @return [String]
|
2350
2648
|
#
|
2351
2649
|
# @!attribute [rw] stack_instance_region
|
@@ -2365,10 +2663,9 @@ module Aws::CloudFormation
|
|
2365
2663
|
# * If you are signed in to a delegated administrator account, specify
|
2366
2664
|
# `DELEGATED_ADMIN`.
|
2367
2665
|
#
|
2368
|
-
# Your
|
2369
|
-
#
|
2370
|
-
# delegated administrator][1] in the *
|
2371
|
-
# Guide*.
|
2666
|
+
# Your account must be registered as a delegated administrator in
|
2667
|
+
# the management account. For more information, see [Register a
|
2668
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2372
2669
|
#
|
2373
2670
|
#
|
2374
2671
|
#
|
@@ -2425,7 +2722,7 @@ module Aws::CloudFormation
|
|
2425
2722
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
2426
2723
|
# expected template configuration.
|
2427
2724
|
#
|
2428
|
-
# * `NOT_CHECKED`\:
|
2725
|
+
# * `NOT_CHECKED`\: CloudFormation does not currently return this
|
2429
2726
|
# value.
|
2430
2727
|
# @return [Array<String>]
|
2431
2728
|
#
|
@@ -2455,7 +2752,7 @@ module Aws::CloudFormation
|
|
2455
2752
|
# @!attribute [rw] stack_resource_drifts
|
2456
2753
|
# Drift information for the resources that have been checked for drift
|
2457
2754
|
# in the specified stack. This includes actual and expected
|
2458
|
-
# configuration values for resources where
|
2755
|
+
# configuration values for resources where CloudFormation detects
|
2459
2756
|
# drift.
|
2460
2757
|
#
|
2461
2758
|
# For a given stack, there will be one `StackResourceDrift` for each
|
@@ -2573,7 +2870,7 @@ module Aws::CloudFormation
|
|
2573
2870
|
#
|
2574
2871
|
# @!attribute [rw] physical_resource_id
|
2575
2872
|
# The name or unique identifier that corresponds to a physical
|
2576
|
-
# instance ID of a resource supported by
|
2873
|
+
# instance ID of a resource supported by CloudFormation.
|
2577
2874
|
#
|
2578
2875
|
# For example, for an Amazon Elastic Compute Cloud (EC2) instance,
|
2579
2876
|
# `PhysicalResourceId` corresponds to the `InstanceId`. You can pass
|
@@ -2636,10 +2933,9 @@ module Aws::CloudFormation
|
|
2636
2933
|
# * If you are signed in to a delegated administrator account, specify
|
2637
2934
|
# `DELEGATED_ADMIN`.
|
2638
2935
|
#
|
2639
|
-
# Your
|
2640
|
-
#
|
2641
|
-
# delegated administrator][1] in the *
|
2642
|
-
# Guide*.
|
2936
|
+
# Your account must be registered as a delegated administrator in
|
2937
|
+
# the management account. For more information, see [Register a
|
2938
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2643
2939
|
#
|
2644
2940
|
#
|
2645
2941
|
#
|
@@ -2686,10 +2982,9 @@ module Aws::CloudFormation
|
|
2686
2982
|
# * If you are signed in to a delegated administrator account, specify
|
2687
2983
|
# `DELEGATED_ADMIN`.
|
2688
2984
|
#
|
2689
|
-
# Your
|
2690
|
-
#
|
2691
|
-
# delegated administrator][1] in the *
|
2692
|
-
# Guide*.
|
2985
|
+
# Your account must be registered as a delegated administrator in
|
2986
|
+
# the management account. For more information, see [Register a
|
2987
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2693
2988
|
#
|
2694
2989
|
#
|
2695
2990
|
#
|
@@ -2795,6 +3090,8 @@ module Aws::CloudFormation
|
|
2795
3090
|
# type_name: "TypeName",
|
2796
3091
|
# arn: "TypeArn",
|
2797
3092
|
# version_id: "TypeVersionId",
|
3093
|
+
# publisher_id: "PublisherId",
|
3094
|
+
# public_version_number: "PublicVersionNumber",
|
2798
3095
|
# }
|
2799
3096
|
#
|
2800
3097
|
# @!attribute [rw] type
|
@@ -2828,13 +3125,25 @@ module Aws::CloudFormation
|
|
2828
3125
|
# information about the default extension version.
|
2829
3126
|
# @return [String]
|
2830
3127
|
#
|
3128
|
+
# @!attribute [rw] publisher_id
|
3129
|
+
# The publisher ID of the extension publisher.
|
3130
|
+
#
|
3131
|
+
# Extensions provided by Amazon are not assigned a publisher ID.
|
3132
|
+
# @return [String]
|
3133
|
+
#
|
3134
|
+
# @!attribute [rw] public_version_number
|
3135
|
+
# The version number of a public third-party extension.
|
3136
|
+
# @return [String]
|
3137
|
+
#
|
2831
3138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeInput AWS API Documentation
|
2832
3139
|
#
|
2833
3140
|
class DescribeTypeInput < Struct.new(
|
2834
3141
|
:type,
|
2835
3142
|
:type_name,
|
2836
3143
|
:arn,
|
2837
|
-
:version_id
|
3144
|
+
:version_id,
|
3145
|
+
:publisher_id,
|
3146
|
+
:public_version_number)
|
2838
3147
|
SENSITIVE = []
|
2839
3148
|
include Aws::Structure
|
2840
3149
|
end
|
@@ -2848,24 +3157,84 @@ module Aws::CloudFormation
|
|
2848
3157
|
# @return [String]
|
2849
3158
|
#
|
2850
3159
|
# @!attribute [rw] type_name
|
2851
|
-
# The name of the
|
3160
|
+
# The name of the extension.
|
3161
|
+
#
|
3162
|
+
# If the extension is a public third-party type you have activated
|
3163
|
+
# with a type name alias, CloudFormation returns the type name alias.
|
3164
|
+
# For more information, see [ActivateType][1].
|
3165
|
+
#
|
3166
|
+
#
|
3167
|
+
#
|
3168
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
2852
3169
|
# @return [String]
|
2853
3170
|
#
|
2854
3171
|
# @!attribute [rw] default_version_id
|
2855
3172
|
# The ID of the default version of the extension. The default version
|
2856
3173
|
# is used when the extension version is not specified.
|
2857
3174
|
#
|
3175
|
+
# This applies only to private extensions you have registered in your
|
3176
|
+
# account. For public extensions, both those provided by Amazon and
|
3177
|
+
# published by third parties, CloudFormation returns `null`. For more
|
3178
|
+
# information, see [RegisterType][1].
|
3179
|
+
#
|
2858
3180
|
# To set the default version of an extension, use `
|
2859
3181
|
# SetTypeDefaultVersion `.
|
3182
|
+
#
|
3183
|
+
#
|
3184
|
+
#
|
3185
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
2860
3186
|
# @return [String]
|
2861
3187
|
#
|
2862
3188
|
# @!attribute [rw] is_default_version
|
2863
3189
|
# Whether the specified extension version is set as the default
|
2864
3190
|
# version.
|
3191
|
+
#
|
3192
|
+
# This applies only to private extensions you have registered in your
|
3193
|
+
# account, and extensions published by Amazon. For public third-party
|
3194
|
+
# extensions, whether or not they are activated in your account,
|
3195
|
+
# CloudFormation returns `null`.
|
2865
3196
|
# @return [Boolean]
|
2866
3197
|
#
|
3198
|
+
# @!attribute [rw] type_tests_status
|
3199
|
+
# The contract test status of the registered extension version. To
|
3200
|
+
# return the extension test status of a specifc extension version, you
|
3201
|
+
# must specify `VersionId`.
|
3202
|
+
#
|
3203
|
+
# This applies only to registered private extension versions.
|
3204
|
+
# CloudFormation does not return this information for public
|
3205
|
+
# extensions, whether or not they are activated in your account.
|
3206
|
+
#
|
3207
|
+
# * `PASSED`\: The extension has passed all its contract tests.
|
3208
|
+
#
|
3209
|
+
# An extension must have a test status of `PASSED` before it can be
|
3210
|
+
# published. For more information, see [Publishing extensions to
|
3211
|
+
# make them available for public use][1] in the *CloudFormation
|
3212
|
+
# Command Line Interface User Guide*.
|
3213
|
+
#
|
3214
|
+
# * `FAILED`\: The extension has failed one or more contract tests.
|
3215
|
+
#
|
3216
|
+
# * `IN_PROGRESS`\: Contract tests are currently being performed on
|
3217
|
+
# the extension.
|
3218
|
+
#
|
3219
|
+
# * `NOT_TESTED`\: Contract tests have not been performed on the
|
3220
|
+
# extension.
|
3221
|
+
#
|
3222
|
+
#
|
3223
|
+
#
|
3224
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
|
3225
|
+
# @return [String]
|
3226
|
+
#
|
3227
|
+
# @!attribute [rw] type_tests_status_description
|
3228
|
+
# The description of the test status. To return the extension test
|
3229
|
+
# status of a specifc extension version, you must specify `VersionId`.
|
3230
|
+
#
|
3231
|
+
# This applies only to registered private extension versions.
|
3232
|
+
# CloudFormation does not return this information for public
|
3233
|
+
# extensions, whether or not they are activated in your account.
|
3234
|
+
# @return [String]
|
3235
|
+
#
|
2867
3236
|
# @!attribute [rw] description
|
2868
|
-
# The description of the
|
3237
|
+
# The description of the extension.
|
2869
3238
|
# @return [String]
|
2870
3239
|
#
|
2871
3240
|
# @!attribute [rw] schema
|
@@ -2880,21 +3249,23 @@ module Aws::CloudFormation
|
|
2880
3249
|
# @return [String]
|
2881
3250
|
#
|
2882
3251
|
# @!attribute [rw] provisioning_type
|
2883
|
-
#
|
2884
|
-
# determines the provisioning type
|
2885
|
-
# types of handlers in the schema
|
3252
|
+
# For resource type extensions, the provisioning behavior of the
|
3253
|
+
# resource type. CloudFormation determines the provisioning type
|
3254
|
+
# during registration, based on the types of handlers in the schema
|
3255
|
+
# handler package submitted.
|
2886
3256
|
#
|
2887
3257
|
# Valid values include:
|
2888
3258
|
#
|
2889
|
-
# * `FULLY_MUTABLE`\: The
|
2890
|
-
# process updates to the
|
3259
|
+
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
3260
|
+
# process updates to the type during stack update operations.
|
2891
3261
|
#
|
2892
|
-
# * `IMMUTABLE`\: The
|
2893
|
-
# the
|
2894
|
-
# during stack update operations.
|
3262
|
+
# * `IMMUTABLE`\: The resource type does not include an update
|
3263
|
+
# handler, so the type cannot be updated and must instead be
|
3264
|
+
# replaced during stack update operations.
|
2895
3265
|
#
|
2896
|
-
# * `NON_PROVISIONABLE`\: The
|
2897
|
-
# following handlers, and therefore cannot actually be
|
3266
|
+
# * `NON_PROVISIONABLE`\: The resource type does not include all of
|
3267
|
+
# the following handlers, and therefore cannot actually be
|
3268
|
+
# provisioned.
|
2898
3269
|
#
|
2899
3270
|
# * create
|
2900
3271
|
#
|
@@ -2908,27 +3279,53 @@ module Aws::CloudFormation
|
|
2908
3279
|
#
|
2909
3280
|
# Valid values include:
|
2910
3281
|
#
|
2911
|
-
# * `LIVE`\: The extension is registered and can be used
|
2912
|
-
# CloudFormation operations, dependent on its provisioning
|
2913
|
-
# and visibility scope.
|
3282
|
+
# * `LIVE`\: The extension is activated or registered and can be used
|
3283
|
+
# in CloudFormation operations, dependent on its provisioning
|
3284
|
+
# behavior and visibility scope.
|
2914
3285
|
#
|
2915
|
-
# * `DEPRECATED`\: The extension has been
|
2916
|
-
# longer be used in CloudFormation operations.
|
3286
|
+
# * `DEPRECATED`\: The extension has been deactivated or deregistered
|
3287
|
+
# and can no longer be used in CloudFormation operations.
|
3288
|
+
#
|
3289
|
+
# For public third-party extensions, CloudFormation returns `null`.
|
2917
3290
|
# @return [String]
|
2918
3291
|
#
|
2919
3292
|
# @!attribute [rw] logging_config
|
2920
|
-
# Contains logging configuration information for
|
3293
|
+
# Contains logging configuration information for private extensions.
|
3294
|
+
# This applies only to private extensions you have registered in your
|
3295
|
+
# account. For public extensions, both those provided by Amazon and
|
3296
|
+
# published by third parties, CloudFormation returns `null`. For more
|
3297
|
+
# information, see [RegisterType][1].
|
3298
|
+
#
|
3299
|
+
#
|
3300
|
+
#
|
3301
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
2921
3302
|
# @return [Types::LoggingConfig]
|
2922
3303
|
#
|
3304
|
+
# @!attribute [rw] required_activated_types
|
3305
|
+
# For extensions that are modules, the public third-party extensions
|
3306
|
+
# that must be activated in your account in order for the module
|
3307
|
+
# itself to be activated.
|
3308
|
+
# @return [Array<Types::RequiredActivatedType>]
|
3309
|
+
#
|
2923
3310
|
# @!attribute [rw] execution_role_arn
|
2924
3311
|
# The Amazon Resource Name (ARN) of the IAM execution role used to
|
2925
|
-
# register the extension.
|
2926
|
-
#
|
3312
|
+
# register the extension. This applies only to private extensions you
|
3313
|
+
# have registered in your account. For more information, see
|
3314
|
+
# [RegisterType][1].
|
3315
|
+
#
|
3316
|
+
#
|
3317
|
+
#
|
3318
|
+
# If the registered extension calls any Amazon Web Services APIs, you
|
3319
|
+
# must create an <i> <a
|
2927
3320
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
2928
3321
|
# execution role</a> </i> that includes the necessary permissions to
|
2929
|
-
# call those
|
2930
|
-
# account. CloudFormation then assumes that execution
|
2931
|
-
# your extension with the appropriate credentials.
|
3322
|
+
# call those Amazon Web Services APIs, and provision that execution
|
3323
|
+
# role in your account. CloudFormation then assumes that execution
|
3324
|
+
# role to provide your extension with the appropriate credentials.
|
3325
|
+
#
|
3326
|
+
#
|
3327
|
+
#
|
3328
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
2932
3329
|
# @return [String]
|
2933
3330
|
#
|
2934
3331
|
# @!attribute [rw] visibility
|
@@ -2938,8 +3335,8 @@ module Aws::CloudFormation
|
|
2938
3335
|
# Valid values include:
|
2939
3336
|
#
|
2940
3337
|
# * `PRIVATE`\: The extension is only visible and usable within the
|
2941
|
-
# account in which it is registered.
|
2942
|
-
#
|
3338
|
+
# account in which it is registered. CloudFormation marks any
|
3339
|
+
# extensions you register as `PRIVATE`.
|
2943
3340
|
#
|
2944
3341
|
# * `PUBLIC`\: The extension is publically visible and usable within
|
2945
3342
|
# any Amazon account.
|
@@ -2955,41 +3352,145 @@ module Aws::CloudFormation
|
|
2955
3352
|
# @return [String]
|
2956
3353
|
#
|
2957
3354
|
# @!attribute [rw] last_updated
|
2958
|
-
# When the specified extension version was registered.
|
3355
|
+
# When the specified extension version was registered. This applies
|
3356
|
+
# only to:
|
3357
|
+
#
|
3358
|
+
# * Private extensions you have registered in your account. For more
|
3359
|
+
# information, see [RegisterType][1].
|
3360
|
+
#
|
3361
|
+
# * Public extensions you have activated in your account with
|
3362
|
+
# auto-update specified. For more information, see
|
3363
|
+
# [ActivateType][2].
|
3364
|
+
#
|
3365
|
+
#
|
3366
|
+
#
|
3367
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
3368
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
2959
3369
|
# @return [Time]
|
2960
3370
|
#
|
2961
3371
|
# @!attribute [rw] time_created
|
2962
|
-
# When the specified extension version was registered
|
3372
|
+
# When the specified private extension version was registered or
|
3373
|
+
# activated in your account.
|
2963
3374
|
# @return [Time]
|
2964
3375
|
#
|
2965
|
-
#
|
3376
|
+
# @!attribute [rw] configuration_schema
|
3377
|
+
# A JSON string that represent the current configuration data for the
|
3378
|
+
# extension in this account and region.
|
2966
3379
|
#
|
2967
|
-
|
2968
|
-
|
2969
|
-
|
2970
|
-
|
2971
|
-
:default_version_id,
|
2972
|
-
:is_default_version,
|
2973
|
-
:description,
|
2974
|
-
:schema,
|
2975
|
-
:provisioning_type,
|
2976
|
-
:deprecated_status,
|
2977
|
-
:logging_config,
|
2978
|
-
:execution_role_arn,
|
2979
|
-
:visibility,
|
2980
|
-
:source_url,
|
2981
|
-
:documentation_url,
|
2982
|
-
:last_updated,
|
2983
|
-
:time_created)
|
2984
|
-
SENSITIVE = []
|
2985
|
-
include Aws::Structure
|
2986
|
-
end
|
2987
|
-
|
2988
|
-
# @note When making an API call, you may pass DescribeTypeRegistrationInput
|
2989
|
-
# data as a hash:
|
3380
|
+
# To set the configuration data for an extension, use
|
3381
|
+
# [SetTypeConfiguration][1]. For more information, see [Configuring
|
3382
|
+
# extensions at the account level][2] in the *CloudFormation User
|
3383
|
+
# Guide*.
|
2990
3384
|
#
|
2991
|
-
#
|
2992
|
-
#
|
3385
|
+
#
|
3386
|
+
#
|
3387
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
|
3388
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
|
3389
|
+
# @return [String]
|
3390
|
+
#
|
3391
|
+
# @!attribute [rw] publisher_id
|
3392
|
+
# The publisher ID of the extension publisher.
|
3393
|
+
#
|
3394
|
+
# This applies only to public third-party extensions. For private
|
3395
|
+
# registered extensions, and extensions provided by Amazon,
|
3396
|
+
# CloudFormation returns `null`.
|
3397
|
+
# @return [String]
|
3398
|
+
#
|
3399
|
+
# @!attribute [rw] original_type_name
|
3400
|
+
# For public extensions that have been activated for this account and
|
3401
|
+
# region, the type name of the public extension.
|
3402
|
+
#
|
3403
|
+
# If you specified a `TypeNameAlias` when enabling the extension in
|
3404
|
+
# this account and region, CloudFormation treats that alias as the
|
3405
|
+
# extension's type name within the account and region, not the type
|
3406
|
+
# name of the public extension. For more information, see [Specifying
|
3407
|
+
# aliases to refer to extensions][1] in the *CloudFormation User
|
3408
|
+
# Guide*.
|
3409
|
+
#
|
3410
|
+
#
|
3411
|
+
#
|
3412
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
|
3413
|
+
# @return [String]
|
3414
|
+
#
|
3415
|
+
# @!attribute [rw] original_type_arn
|
3416
|
+
# For public extensions that have been activated for this account and
|
3417
|
+
# region, the Amazon Resource Name (ARN) of the public extension.
|
3418
|
+
# @return [String]
|
3419
|
+
#
|
3420
|
+
# @!attribute [rw] public_version_number
|
3421
|
+
# The version number of a public third-party extension.
|
3422
|
+
#
|
3423
|
+
# This applies only if you specify a public extension you have
|
3424
|
+
# activated in your account, or specify a public extension without
|
3425
|
+
# specifying a version. For all other extensions, CloudFormation
|
3426
|
+
# returns `null`.
|
3427
|
+
# @return [String]
|
3428
|
+
#
|
3429
|
+
# @!attribute [rw] latest_public_version
|
3430
|
+
# The latest version of a public extension *that is available* for
|
3431
|
+
# use.
|
3432
|
+
#
|
3433
|
+
# This only applies if you specify a public extension, and you do not
|
3434
|
+
# specify a version. For all other requests, CloudFormation returns
|
3435
|
+
# `null`.
|
3436
|
+
# @return [String]
|
3437
|
+
#
|
3438
|
+
# @!attribute [rw] is_activated
|
3439
|
+
# Whether or not the extension is activated in the account and region.
|
3440
|
+
#
|
3441
|
+
# This only applies to public third-party extensions. For all other
|
3442
|
+
# extensions, CloudFormation returns `null`.
|
3443
|
+
# @return [Boolean]
|
3444
|
+
#
|
3445
|
+
# @!attribute [rw] auto_update
|
3446
|
+
# Whether CloudFormation automatically updates the extension in this
|
3447
|
+
# account and region when a new *minor* version is published by the
|
3448
|
+
# extension publisher. Major versions released by the publisher must
|
3449
|
+
# be manually updated. For more information, see [Activating public
|
3450
|
+
# extensions for use in your
|
3451
|
+
# account](AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable)
|
3452
|
+
# in the *CloudFormation User Guide*.
|
3453
|
+
# @return [Boolean]
|
3454
|
+
#
|
3455
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation
|
3456
|
+
#
|
3457
|
+
class DescribeTypeOutput < Struct.new(
|
3458
|
+
:arn,
|
3459
|
+
:type,
|
3460
|
+
:type_name,
|
3461
|
+
:default_version_id,
|
3462
|
+
:is_default_version,
|
3463
|
+
:type_tests_status,
|
3464
|
+
:type_tests_status_description,
|
3465
|
+
:description,
|
3466
|
+
:schema,
|
3467
|
+
:provisioning_type,
|
3468
|
+
:deprecated_status,
|
3469
|
+
:logging_config,
|
3470
|
+
:required_activated_types,
|
3471
|
+
:execution_role_arn,
|
3472
|
+
:visibility,
|
3473
|
+
:source_url,
|
3474
|
+
:documentation_url,
|
3475
|
+
:last_updated,
|
3476
|
+
:time_created,
|
3477
|
+
:configuration_schema,
|
3478
|
+
:publisher_id,
|
3479
|
+
:original_type_name,
|
3480
|
+
:original_type_arn,
|
3481
|
+
:public_version_number,
|
3482
|
+
:latest_public_version,
|
3483
|
+
:is_activated,
|
3484
|
+
:auto_update)
|
3485
|
+
SENSITIVE = []
|
3486
|
+
include Aws::Structure
|
3487
|
+
end
|
3488
|
+
|
3489
|
+
# @note When making an API call, you may pass DescribeTypeRegistrationInput
|
3490
|
+
# data as a hash:
|
3491
|
+
#
|
3492
|
+
# {
|
3493
|
+
# registration_token: "RegistrationToken", # required
|
2993
3494
|
# }
|
2994
3495
|
#
|
2995
3496
|
# @!attribute [rw] registration_token
|
@@ -3069,9 +3570,9 @@ module Aws::CloudFormation
|
|
3069
3570
|
# @!attribute [rw] stack_drift_detection_id
|
3070
3571
|
# The ID of the drift detection results of this operation.
|
3071
3572
|
#
|
3072
|
-
#
|
3073
|
-
#
|
3074
|
-
# results
|
3573
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
3574
|
+
# each time this operation is run. However, the number of drift
|
3575
|
+
# results CloudFormation retains for any given stack, and for how
|
3075
3576
|
# long, may vary.
|
3076
3577
|
# @return [String]
|
3077
3578
|
#
|
@@ -3146,7 +3647,7 @@ module Aws::CloudFormation
|
|
3146
3647
|
# @return [String]
|
3147
3648
|
#
|
3148
3649
|
# @!attribute [rw] operation_preferences
|
3149
|
-
# The user-specified preferences for how
|
3650
|
+
# The user-specified preferences for how CloudFormation performs a
|
3150
3651
|
# stack set operation.
|
3151
3652
|
#
|
3152
3653
|
# For more information on maximum concurrent accounts and failure
|
@@ -3177,10 +3678,9 @@ module Aws::CloudFormation
|
|
3177
3678
|
# * If you are signed in to a delegated administrator account, specify
|
3178
3679
|
# `DELEGATED_ADMIN`.
|
3179
3680
|
#
|
3180
|
-
# Your
|
3181
|
-
#
|
3182
|
-
# delegated administrator][1] in the *
|
3183
|
-
# Guide*.
|
3681
|
+
# Your account must be registered as a delegated administrator in
|
3682
|
+
# the management account. For more information, see [Register a
|
3683
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
3184
3684
|
#
|
3185
3685
|
#
|
3186
3686
|
#
|
@@ -3234,7 +3734,7 @@ module Aws::CloudFormation
|
|
3234
3734
|
# @!attribute [rw] template_body
|
3235
3735
|
# Structure containing the template body with a minimum length of 1
|
3236
3736
|
# byte and a maximum length of 51,200 bytes. (For more information, go
|
3237
|
-
# to [Template Anatomy][1] in the
|
3737
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.)
|
3238
3738
|
#
|
3239
3739
|
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
|
3240
3740
|
# are passed, only `TemplateBody` is used.
|
@@ -3248,7 +3748,7 @@ module Aws::CloudFormation
|
|
3248
3748
|
# Location of file containing the template body. The URL must point to
|
3249
3749
|
# a template that is located in an Amazon S3 bucket or a Systems
|
3250
3750
|
# Manager document. For more information, go to [Template Anatomy][1]
|
3251
|
-
# in the
|
3751
|
+
# in the CloudFormation User Guide.
|
3252
3752
|
#
|
3253
3753
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
3254
3754
|
# are passed, only `TemplateBody` is used.
|
@@ -3275,8 +3775,8 @@ module Aws::CloudFormation
|
|
3275
3775
|
# The output for a EstimateTemplateCost action.
|
3276
3776
|
#
|
3277
3777
|
# @!attribute [rw] url
|
3278
|
-
# An
|
3279
|
-
# describes the resources required to run the template.
|
3778
|
+
# An Amazon Web Services Simple Monthly Calculator URL with a query
|
3779
|
+
# string that describes the resources required to run the template.
|
3280
3780
|
# @return [String]
|
3281
3781
|
#
|
3282
3782
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCostOutput AWS API Documentation
|
@@ -3310,11 +3810,10 @@ module Aws::CloudFormation
|
|
3310
3810
|
#
|
3311
3811
|
# @!attribute [rw] client_request_token
|
3312
3812
|
# A unique identifier for this `ExecuteChangeSet` request. Specify
|
3313
|
-
# this token if you plan to retry requests so that
|
3813
|
+
# this token if you plan to retry requests so that CloudFormation
|
3314
3814
|
# knows that you're not attempting to execute a change set to update
|
3315
3815
|
# a stack with the same name. You might retry `ExecuteChangeSet`
|
3316
|
-
# requests to ensure that
|
3317
|
-
# them.
|
3816
|
+
# requests to ensure that CloudFormation successfully received them.
|
3318
3817
|
# @return [String]
|
3319
3818
|
#
|
3320
3819
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSetInput AWS API Documentation
|
@@ -3389,8 +3888,8 @@ module Aws::CloudFormation
|
|
3389
3888
|
#
|
3390
3889
|
# @!attribute [rw] stack_policy_body
|
3391
3890
|
# Structure containing the stack policy body. (For more information,
|
3392
|
-
# go to [ Prevent Updates to Stack Resources][1] in the
|
3393
|
-
#
|
3891
|
+
# go to [ Prevent Updates to Stack Resources][1] in the CloudFormation
|
3892
|
+
# User Guide.)
|
3394
3893
|
#
|
3395
3894
|
#
|
3396
3895
|
#
|
@@ -3429,20 +3928,20 @@ module Aws::CloudFormation
|
|
3429
3928
|
# @return [String]
|
3430
3929
|
#
|
3431
3930
|
# @!attribute [rw] change_set_name
|
3432
|
-
# The name or Amazon Resource Name (ARN) of a change set for which
|
3931
|
+
# The name or Amazon Resource Name (ARN) of a change set for which
|
3433
3932
|
# CloudFormation returns the associated template. If you specify a
|
3434
3933
|
# name, you must also specify the `StackName`.
|
3435
3934
|
# @return [String]
|
3436
3935
|
#
|
3437
3936
|
# @!attribute [rw] template_stage
|
3438
3937
|
# For templates that include transforms, the stage of the template
|
3439
|
-
# that
|
3440
|
-
# specify `Original`. To get the template after
|
3938
|
+
# that CloudFormation returns. To get the user-submitted template,
|
3939
|
+
# specify `Original`. To get the template after CloudFormation has
|
3441
3940
|
# processed all transforms, specify `Processed`.
|
3442
3941
|
#
|
3443
3942
|
# If the template doesn't include transforms, `Original` and
|
3444
|
-
# `Processed` return the same template. By default,
|
3445
|
-
# specifies `
|
3943
|
+
# `Processed` return the same template. By default, CloudFormation
|
3944
|
+
# specifies `Processed`.
|
3446
3945
|
# @return [String]
|
3447
3946
|
#
|
3448
3947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateInput AWS API Documentation
|
@@ -3459,9 +3958,9 @@ module Aws::CloudFormation
|
|
3459
3958
|
#
|
3460
3959
|
# @!attribute [rw] template_body
|
3461
3960
|
# Structure containing the template body. (For more information, go to
|
3462
|
-
# [Template Anatomy][1] in the
|
3961
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
3463
3962
|
#
|
3464
|
-
#
|
3963
|
+
# CloudFormation returns the same template that was used when the
|
3465
3964
|
# stack was created.
|
3466
3965
|
#
|
3467
3966
|
#
|
@@ -3472,7 +3971,7 @@ module Aws::CloudFormation
|
|
3472
3971
|
# @!attribute [rw] stages_available
|
3473
3972
|
# The stage of the template that you can retrieve. For stacks, the
|
3474
3973
|
# `Original` and `Processed` templates are always available. For
|
3475
|
-
# change sets, the `Original` template is always available. After
|
3974
|
+
# change sets, the `Original` template is always available. After
|
3476
3975
|
# CloudFormation finishes creating the change set, the `Processed`
|
3477
3976
|
# template becomes available.
|
3478
3977
|
# @return [Array<String>]
|
@@ -3496,12 +3995,13 @@ module Aws::CloudFormation
|
|
3496
3995
|
# template_url: "TemplateURL",
|
3497
3996
|
# stack_name: "StackNameOrId",
|
3498
3997
|
# stack_set_name: "StackSetNameOrId",
|
3998
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3499
3999
|
# }
|
3500
4000
|
#
|
3501
4001
|
# @!attribute [rw] template_body
|
3502
4002
|
# Structure containing the template body with a minimum length of 1
|
3503
4003
|
# byte and a maximum length of 51,200 bytes. For more information
|
3504
|
-
# about templates, see [Template Anatomy][1] in the
|
4004
|
+
# about templates, see [Template Anatomy][1] in the CloudFormation
|
3505
4005
|
# User Guide.
|
3506
4006
|
#
|
3507
4007
|
# Conditional: You must specify only one of the following parameters:
|
@@ -3516,7 +4016,7 @@ module Aws::CloudFormation
|
|
3516
4016
|
# Location of file containing the template body. The URL must point to
|
3517
4017
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
3518
4018
|
# bucket or a Systems Manager document. For more information about
|
3519
|
-
# templates, see [Template Anatomy][1] in the
|
4019
|
+
# templates, see [Template Anatomy][1] in the CloudFormation User
|
3520
4020
|
# Guide.
|
3521
4021
|
#
|
3522
4022
|
# Conditional: You must specify only one of the following parameters:
|
@@ -3545,13 +4045,36 @@ module Aws::CloudFormation
|
|
3545
4045
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
3546
4046
|
# @return [String]
|
3547
4047
|
#
|
4048
|
+
# @!attribute [rw] call_as
|
4049
|
+
# \[Service-managed permissions\] Specifies whether you are acting as
|
4050
|
+
# an account administrator in the organization's management account
|
4051
|
+
# or as a delegated administrator in a member account.
|
4052
|
+
#
|
4053
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
4054
|
+
# self-managed permissions.
|
4055
|
+
#
|
4056
|
+
# * If you are signed in to the management account, specify `SELF`.
|
4057
|
+
#
|
4058
|
+
# * If you are signed in to a delegated administrator account, specify
|
4059
|
+
# `DELEGATED_ADMIN`.
|
4060
|
+
#
|
4061
|
+
# Your account must be registered as a delegated administrator in
|
4062
|
+
# the management account. For more information, see [Register a
|
4063
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4064
|
+
#
|
4065
|
+
#
|
4066
|
+
#
|
4067
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
4068
|
+
# @return [String]
|
4069
|
+
#
|
3548
4070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateSummaryInput AWS API Documentation
|
3549
4071
|
#
|
3550
4072
|
class GetTemplateSummaryInput < Struct.new(
|
3551
4073
|
:template_body,
|
3552
4074
|
:template_url,
|
3553
4075
|
:stack_name,
|
3554
|
-
:stack_set_name
|
4076
|
+
:stack_set_name,
|
4077
|
+
:call_as)
|
3555
4078
|
SENSITIVE = []
|
3556
4079
|
include Aws::Structure
|
3557
4080
|
end
|
@@ -3575,7 +4098,7 @@ module Aws::CloudFormation
|
|
3575
4098
|
# CreateStack or UpdateStack actions with your template; otherwise,
|
3576
4099
|
# those actions return an InsufficientCapabilities error.
|
3577
4100
|
#
|
3578
|
-
# For more information, see [Acknowledging IAM Resources in
|
4101
|
+
# For more information, see [Acknowledging IAM Resources in
|
3579
4102
|
# CloudFormation Templates][1].
|
3580
4103
|
#
|
3581
4104
|
#
|
@@ -3595,8 +4118,8 @@ module Aws::CloudFormation
|
|
3595
4118
|
# @return [Array<String>]
|
3596
4119
|
#
|
3597
4120
|
# @!attribute [rw] version
|
3598
|
-
# The
|
3599
|
-
# of the template.
|
4121
|
+
# The Amazon Web Services template format version, which identifies
|
4122
|
+
# the capabilities of the template.
|
3600
4123
|
# @return [String]
|
3601
4124
|
#
|
3602
4125
|
# @!attribute [rw] metadata
|
@@ -3632,6 +4155,86 @@ module Aws::CloudFormation
|
|
3632
4155
|
include Aws::Structure
|
3633
4156
|
end
|
3634
4157
|
|
4158
|
+
# @note When making an API call, you may pass ImportStacksToStackSetInput
|
4159
|
+
# data as a hash:
|
4160
|
+
#
|
4161
|
+
# {
|
4162
|
+
# stack_set_name: "StackSetNameOrId", # required
|
4163
|
+
# stack_ids: ["StackId"], # required
|
4164
|
+
# operation_preferences: {
|
4165
|
+
# region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
|
4166
|
+
# region_order: ["Region"],
|
4167
|
+
# failure_tolerance_count: 1,
|
4168
|
+
# failure_tolerance_percentage: 1,
|
4169
|
+
# max_concurrent_count: 1,
|
4170
|
+
# max_concurrent_percentage: 1,
|
4171
|
+
# },
|
4172
|
+
# operation_id: "ClientRequestToken",
|
4173
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
4174
|
+
# }
|
4175
|
+
#
|
4176
|
+
# @!attribute [rw] stack_set_name
|
4177
|
+
# The name of the stack set. The name must be unique in the Region
|
4178
|
+
# where you create your stack set.
|
4179
|
+
# @return [String]
|
4180
|
+
#
|
4181
|
+
# @!attribute [rw] stack_ids
|
4182
|
+
# The IDs of the stacks you are importing into a stack set. You import
|
4183
|
+
# up to 10 stacks per stack set at a time.
|
4184
|
+
# @return [Array<String>]
|
4185
|
+
#
|
4186
|
+
# @!attribute [rw] operation_preferences
|
4187
|
+
# The user-specified preferences for how CloudFormation performs a
|
4188
|
+
# stack set operation.
|
4189
|
+
#
|
4190
|
+
# For more information on maximum concurrent accounts and failure
|
4191
|
+
# tolerance, see [Stack set operation options][1].
|
4192
|
+
#
|
4193
|
+
#
|
4194
|
+
#
|
4195
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4196
|
+
# @return [Types::StackSetOperationPreferences]
|
4197
|
+
#
|
4198
|
+
# @!attribute [rw] operation_id
|
4199
|
+
# A unique, user defined, identifier for the stack set operation.
|
4200
|
+
#
|
4201
|
+
# **A suitable default value is auto-generated.** You should normally
|
4202
|
+
# not need to pass this option.
|
4203
|
+
# @return [String]
|
4204
|
+
#
|
4205
|
+
# @!attribute [rw] call_as
|
4206
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
4207
|
+
# self-managed permissions.
|
4208
|
+
#
|
4209
|
+
# * If you are signed in to the management account, specify `SELF`.
|
4210
|
+
#
|
4211
|
+
# * For service managed stack sets, specify `DELEGATED_ADMIN`.
|
4212
|
+
# @return [String]
|
4213
|
+
#
|
4214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetInput AWS API Documentation
|
4215
|
+
#
|
4216
|
+
class ImportStacksToStackSetInput < Struct.new(
|
4217
|
+
:stack_set_name,
|
4218
|
+
:stack_ids,
|
4219
|
+
:operation_preferences,
|
4220
|
+
:operation_id,
|
4221
|
+
:call_as)
|
4222
|
+
SENSITIVE = []
|
4223
|
+
include Aws::Structure
|
4224
|
+
end
|
4225
|
+
|
4226
|
+
# @!attribute [rw] operation_id
|
4227
|
+
# The unique identifier for the stack set operation.
|
4228
|
+
# @return [String]
|
4229
|
+
#
|
4230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetOutput AWS API Documentation
|
4231
|
+
#
|
4232
|
+
class ImportStacksToStackSetOutput < Struct.new(
|
4233
|
+
:operation_id)
|
4234
|
+
SENSITIVE = []
|
4235
|
+
include Aws::Structure
|
4236
|
+
end
|
4237
|
+
|
3635
4238
|
# The template contains resources with capabilities that weren't
|
3636
4239
|
# specified in the Capabilities parameter.
|
3637
4240
|
#
|
@@ -3667,7 +4270,7 @@ module Aws::CloudFormation
|
|
3667
4270
|
# The quota for the resource has already been reached.
|
3668
4271
|
#
|
3669
4272
|
# For information on resource and stack limitations, see [Limits][1] in
|
3670
|
-
# the *
|
4273
|
+
# the *CloudFormation User Guide*.
|
3671
4274
|
#
|
3672
4275
|
#
|
3673
4276
|
#
|
@@ -3776,8 +4379,8 @@ module Aws::CloudFormation
|
|
3776
4379
|
# }
|
3777
4380
|
#
|
3778
4381
|
# @!attribute [rw] export_name
|
3779
|
-
# The name of the exported output value.
|
3780
|
-
#
|
4382
|
+
# The name of the exported output value. CloudFormation returns the
|
4383
|
+
# stack names that are importing this value.
|
3781
4384
|
# @return [String]
|
3782
4385
|
#
|
3783
4386
|
# @!attribute [rw] next_token
|
@@ -3858,8 +4461,7 @@ module Aws::CloudFormation
|
|
3858
4461
|
# @return [Array<Types::StackInstanceFilter>]
|
3859
4462
|
#
|
3860
4463
|
# @!attribute [rw] stack_instance_account
|
3861
|
-
# The name of the
|
3862
|
-
# for.
|
4464
|
+
# The name of the account that you want to list stack instances for.
|
3863
4465
|
# @return [String]
|
3864
4466
|
#
|
3865
4467
|
# @!attribute [rw] stack_instance_region
|
@@ -3879,10 +4481,9 @@ module Aws::CloudFormation
|
|
3879
4481
|
# * If you are signed in to a delegated administrator account, specify
|
3880
4482
|
# `DELEGATED_ADMIN`.
|
3881
4483
|
#
|
3882
|
-
# Your
|
3883
|
-
#
|
3884
|
-
# delegated administrator][1] in the *
|
3885
|
-
# Guide*.
|
4484
|
+
# Your account must be registered as a delegated administrator in
|
4485
|
+
# the management account. For more information, see [Register a
|
4486
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
3886
4487
|
#
|
3887
4488
|
#
|
3888
4489
|
#
|
@@ -4032,10 +4633,9 @@ module Aws::CloudFormation
|
|
4032
4633
|
# * If you are signed in to a delegated administrator account, specify
|
4033
4634
|
# `DELEGATED_ADMIN`.
|
4034
4635
|
#
|
4035
|
-
# Your
|
4036
|
-
#
|
4037
|
-
# delegated administrator][1] in the *
|
4038
|
-
# Guide*.
|
4636
|
+
# Your account must be registered as a delegated administrator in
|
4637
|
+
# the management account. For more information, see [Register a
|
4638
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4039
4639
|
#
|
4040
4640
|
#
|
4041
4641
|
#
|
@@ -4122,10 +4722,9 @@ module Aws::CloudFormation
|
|
4122
4722
|
# * If you are signed in to a delegated administrator account, specify
|
4123
4723
|
# `DELEGATED_ADMIN`.
|
4124
4724
|
#
|
4125
|
-
# Your
|
4126
|
-
#
|
4127
|
-
# delegated administrator][1] in the *
|
4128
|
-
# Guide*.
|
4725
|
+
# Your account must be registered as a delegated administrator in
|
4726
|
+
# the management account. For more information, see [Register a
|
4727
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4129
4728
|
#
|
4130
4729
|
#
|
4131
4730
|
#
|
@@ -4209,10 +4808,9 @@ module Aws::CloudFormation
|
|
4209
4808
|
# * If you are signed in to a delegated administrator account, specify
|
4210
4809
|
# `DELEGATED_ADMIN`.
|
4211
4810
|
#
|
4212
|
-
# Your
|
4213
|
-
#
|
4214
|
-
# delegated administrator][1] in the *
|
4215
|
-
# Guide*.
|
4811
|
+
# Your account must be registered as a delegated administrator in
|
4812
|
+
# the management account. For more information, see [Register a
|
4813
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4216
4814
|
#
|
4217
4815
|
#
|
4218
4816
|
#
|
@@ -4403,10 +5001,11 @@ module Aws::CloudFormation
|
|
4403
5001
|
# {
|
4404
5002
|
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4405
5003
|
# type_name: "TypeName",
|
4406
|
-
# arn: "
|
5004
|
+
# arn: "TypeArn",
|
4407
5005
|
# max_results: 1,
|
4408
5006
|
# next_token: "NextToken",
|
4409
5007
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
5008
|
+
# publisher_id: "PublisherId",
|
4410
5009
|
# }
|
4411
5010
|
#
|
4412
5011
|
# @!attribute [rw] type
|
@@ -4464,6 +5063,12 @@ module Aws::CloudFormation
|
|
4464
5063
|
# The default is `LIVE`.
|
4465
5064
|
# @return [String]
|
4466
5065
|
#
|
5066
|
+
# @!attribute [rw] publisher_id
|
5067
|
+
# The publisher ID of the extension publisher.
|
5068
|
+
#
|
5069
|
+
# Extensions published by Amazon are not assigned a publisher ID.
|
5070
|
+
# @return [String]
|
5071
|
+
#
|
4467
5072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersionsInput AWS API Documentation
|
4468
5073
|
#
|
4469
5074
|
class ListTypeVersionsInput < Struct.new(
|
@@ -4472,7 +5077,8 @@ module Aws::CloudFormation
|
|
4472
5077
|
:arn,
|
4473
5078
|
:max_results,
|
4474
5079
|
:next_token,
|
4475
|
-
:deprecated_status
|
5080
|
+
:deprecated_status,
|
5081
|
+
:publisher_id)
|
4476
5082
|
SENSITIVE = []
|
4477
5083
|
include Aws::Structure
|
4478
5084
|
end
|
@@ -4507,42 +5113,57 @@ module Aws::CloudFormation
|
|
4507
5113
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
4508
5114
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4509
5115
|
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5116
|
+
# filters: {
|
5117
|
+
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
5118
|
+
# publisher_id: "PublisherId",
|
5119
|
+
# type_name_prefix: "TypeNamePrefix",
|
5120
|
+
# },
|
4510
5121
|
# max_results: 1,
|
4511
5122
|
# next_token: "NextToken",
|
4512
5123
|
# }
|
4513
5124
|
#
|
4514
5125
|
# @!attribute [rw] visibility
|
4515
|
-
# The scope at which the
|
5126
|
+
# The scope at which the extensions are visible and usable in
|
4516
5127
|
# CloudFormation operations.
|
4517
5128
|
#
|
4518
5129
|
# Valid values include:
|
4519
5130
|
#
|
4520
|
-
# * `PRIVATE`\:
|
4521
|
-
# account
|
4522
|
-
# marks any extension you create as `PRIVATE`.
|
5131
|
+
# * `PRIVATE`\: Extensions that are visible and usable within this
|
5132
|
+
# account and region. This includes:
|
4523
5133
|
#
|
4524
|
-
#
|
4525
|
-
#
|
5134
|
+
# * Private extensions you have registered in this account and
|
5135
|
+
# region.
|
5136
|
+
#
|
5137
|
+
# * Public extensions that you have activated in this account and
|
5138
|
+
# region.
|
5139
|
+
#
|
5140
|
+
# * `PUBLIC`\: Extensions that are publicly visible and available to
|
5141
|
+
# be activated within any Amazon account. This includes extensions
|
5142
|
+
# from Amazon, as well as third-party publishers.
|
4526
5143
|
#
|
4527
5144
|
# The default is `PRIVATE`.
|
4528
5145
|
# @return [String]
|
4529
5146
|
#
|
4530
5147
|
# @!attribute [rw] provisioning_type
|
4531
|
-
#
|
4532
|
-
# the provisioning type during registration,
|
4533
|
-
# handlers in the schema handler package
|
5148
|
+
# For resource types, the provisioning behavior of the resource type.
|
5149
|
+
# CloudFormation determines the provisioning type during registration,
|
5150
|
+
# based on the types of handlers in the schema handler package
|
5151
|
+
# submitted.
|
4534
5152
|
#
|
4535
5153
|
# Valid values include:
|
4536
5154
|
#
|
4537
|
-
# * `FULLY_MUTABLE`\: The
|
4538
|
-
# process updates to the
|
5155
|
+
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
5156
|
+
# process updates to the type during stack update operations.
|
5157
|
+
#
|
5158
|
+
# * `IMMUTABLE`\: The resource type does not include an update
|
5159
|
+
# handler, so the type cannot be updated and must instead be
|
5160
|
+
# replaced during stack update operations.
|
4539
5161
|
#
|
4540
|
-
# * `
|
4541
|
-
#
|
4542
|
-
#
|
5162
|
+
# * `NON_PROVISIONABLE`\: The resource type does not include create,
|
5163
|
+
# read, and delete handlers, and therefore cannot actually be
|
5164
|
+
# provisioned.
|
4543
5165
|
#
|
4544
|
-
#
|
4545
|
-
# and delete handlers, and therefore cannot actually be provisioned.
|
5166
|
+
# The default is `FULLY_MUTABLE`.
|
4546
5167
|
# @return [String]
|
4547
5168
|
#
|
4548
5169
|
# @!attribute [rw] deprecated_status
|
@@ -4562,6 +5183,13 @@ module Aws::CloudFormation
|
|
4562
5183
|
# The type of extension.
|
4563
5184
|
# @return [String]
|
4564
5185
|
#
|
5186
|
+
# @!attribute [rw] filters
|
5187
|
+
# Filter criteria to use in determining which extensions to return.
|
5188
|
+
#
|
5189
|
+
# If you specify a filter, CloudFormation ignores any specified
|
5190
|
+
# `Visibility` value when returning the list of types.
|
5191
|
+
# @return [Types::TypeFilters]
|
5192
|
+
#
|
4565
5193
|
# @!attribute [rw] max_results
|
4566
5194
|
# The maximum number of results to be returned with a single call. If
|
4567
5195
|
# the number of available results exceeds this maximum, the response
|
@@ -4585,6 +5213,7 @@ module Aws::CloudFormation
|
|
4585
5213
|
:provisioning_type,
|
4586
5214
|
:deprecated_status,
|
4587
5215
|
:type,
|
5216
|
+
:filters,
|
4588
5217
|
:max_results,
|
4589
5218
|
:next_token)
|
4590
5219
|
SENSITIVE = []
|
@@ -4613,7 +5242,7 @@ module Aws::CloudFormation
|
|
4613
5242
|
include Aws::Structure
|
4614
5243
|
end
|
4615
5244
|
|
4616
|
-
# Contains logging configuration information for
|
5245
|
+
# Contains logging configuration information for an extension.
|
4617
5246
|
#
|
4618
5247
|
# @note When making an API call, you may pass LoggingConfig
|
4619
5248
|
# data as a hash:
|
@@ -4630,7 +5259,7 @@ module Aws::CloudFormation
|
|
4630
5259
|
#
|
4631
5260
|
# @!attribute [rw] log_group_name
|
4632
5261
|
# The Amazon CloudWatch log group to which CloudFormation sends error
|
4633
|
-
# logging information when invoking the
|
5262
|
+
# logging information when invoking the extension's handlers.
|
4634
5263
|
# @return [String]
|
4635
5264
|
#
|
4636
5265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/LoggingConfig AWS API Documentation
|
@@ -4766,7 +5395,7 @@ module Aws::CloudFormation
|
|
4766
5395
|
#
|
4767
5396
|
# @!attribute [rw] parameter_key
|
4768
5397
|
# The key associated with the parameter. If you don't specify a key
|
4769
|
-
# and value for a particular parameter,
|
5398
|
+
# and value for a particular parameter, CloudFormation uses the
|
4770
5399
|
# default value that is specified in your template.
|
4771
5400
|
# @return [String]
|
4772
5401
|
#
|
@@ -4801,10 +5430,9 @@ module Aws::CloudFormation
|
|
4801
5430
|
include Aws::Structure
|
4802
5431
|
end
|
4803
5432
|
|
4804
|
-
# A set of criteria that
|
5433
|
+
# A set of criteria that CloudFormation uses to validate parameter
|
4805
5434
|
# values. Although other constraints might be defined in the stack
|
4806
|
-
# template,
|
4807
|
-
# property.
|
5435
|
+
# template, CloudFormation returns only the `AllowedValues` property.
|
4808
5436
|
#
|
4809
5437
|
# @!attribute [rw] allowed_values
|
4810
5438
|
# A list of values that are permitted for a parameter.
|
@@ -4834,7 +5462,7 @@ module Aws::CloudFormation
|
|
4834
5462
|
#
|
4835
5463
|
# @!attribute [rw] no_echo
|
4836
5464
|
# Flag that indicates whether the parameter value is shown as plain
|
4837
|
-
# text in logs and in the
|
5465
|
+
# text in logs and in the Management Console.
|
4838
5466
|
# @return [Boolean]
|
4839
5467
|
#
|
4840
5468
|
# @!attribute [rw] description
|
@@ -4842,8 +5470,7 @@ module Aws::CloudFormation
|
|
4842
5470
|
# @return [String]
|
4843
5471
|
#
|
4844
5472
|
# @!attribute [rw] parameter_constraints
|
4845
|
-
# The criteria that
|
4846
|
-
# values.
|
5473
|
+
# The criteria that CloudFormation uses to validate parameter values.
|
4847
5474
|
# @return [Types::ParameterConstraints]
|
4848
5475
|
#
|
4849
5476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ParameterDeclaration AWS API Documentation
|
@@ -4859,11 +5486,11 @@ module Aws::CloudFormation
|
|
4859
5486
|
include Aws::Structure
|
4860
5487
|
end
|
4861
5488
|
|
4862
|
-
# Context information that enables
|
4863
|
-
#
|
4864
|
-
#
|
4865
|
-
#
|
4866
|
-
#
|
5489
|
+
# Context information that enables CloudFormation to uniquely identify a
|
5490
|
+
# resource. CloudFormation uses context key-value pairs in cases where a
|
5491
|
+
# resource's logical and physical IDs are not enough to uniquely
|
5492
|
+
# identify that resource. Each context key-value pair specifies a
|
5493
|
+
# resource that contains the targeted resource.
|
4867
5494
|
#
|
4868
5495
|
# @!attribute [rw] key
|
4869
5496
|
# The resource context key.
|
@@ -4931,6 +5558,79 @@ module Aws::CloudFormation
|
|
4931
5558
|
include Aws::Structure
|
4932
5559
|
end
|
4933
5560
|
|
5561
|
+
# @note When making an API call, you may pass PublishTypeInput
|
5562
|
+
# data as a hash:
|
5563
|
+
#
|
5564
|
+
# {
|
5565
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5566
|
+
# arn: "PrivateTypeArn",
|
5567
|
+
# type_name: "TypeName",
|
5568
|
+
# public_version_number: "PublicVersionNumber",
|
5569
|
+
# }
|
5570
|
+
#
|
5571
|
+
# @!attribute [rw] type
|
5572
|
+
# The type of the extension.
|
5573
|
+
#
|
5574
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5575
|
+
# @return [String]
|
5576
|
+
#
|
5577
|
+
# @!attribute [rw] arn
|
5578
|
+
# The Amazon Resource Number (ARN) of the extension.
|
5579
|
+
#
|
5580
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5581
|
+
# @return [String]
|
5582
|
+
#
|
5583
|
+
# @!attribute [rw] type_name
|
5584
|
+
# The name of the extension.
|
5585
|
+
#
|
5586
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5587
|
+
# @return [String]
|
5588
|
+
#
|
5589
|
+
# @!attribute [rw] public_version_number
|
5590
|
+
# The version number to assign to this version of the extension.
|
5591
|
+
#
|
5592
|
+
# Use the following format, and adhere to semantic versioning when
|
5593
|
+
# assigning a version number to your extension:
|
5594
|
+
#
|
5595
|
+
# `MAJOR.MINOR.PATCH`
|
5596
|
+
#
|
5597
|
+
# For more information, see [Semantic Versioning 2.0.0][1].
|
5598
|
+
#
|
5599
|
+
# If you do not specify a version number, CloudFormation increments
|
5600
|
+
# the version number by one minor version release.
|
5601
|
+
#
|
5602
|
+
# The first time you publish a type, CloudFormation sets the version
|
5603
|
+
# number to `1.0.0`, regardless of the value you specify.
|
5604
|
+
#
|
5605
|
+
#
|
5606
|
+
#
|
5607
|
+
# [1]: https://semver.org/
|
5608
|
+
# @return [String]
|
5609
|
+
#
|
5610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishTypeInput AWS API Documentation
|
5611
|
+
#
|
5612
|
+
class PublishTypeInput < Struct.new(
|
5613
|
+
:type,
|
5614
|
+
:arn,
|
5615
|
+
:type_name,
|
5616
|
+
:public_version_number)
|
5617
|
+
SENSITIVE = []
|
5618
|
+
include Aws::Structure
|
5619
|
+
end
|
5620
|
+
|
5621
|
+
# @!attribute [rw] public_type_arn
|
5622
|
+
# The Amazon Resource Number (ARN) assigned to the public extension
|
5623
|
+
# upon publication.
|
5624
|
+
# @return [String]
|
5625
|
+
#
|
5626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishTypeOutput AWS API Documentation
|
5627
|
+
#
|
5628
|
+
class PublishTypeOutput < Struct.new(
|
5629
|
+
:public_type_arn)
|
5630
|
+
SENSITIVE = []
|
5631
|
+
include Aws::Structure
|
5632
|
+
end
|
5633
|
+
|
4934
5634
|
# @note When making an API call, you may pass RecordHandlerProgressInput
|
4935
5635
|
# data as a hash:
|
4936
5636
|
#
|
@@ -4939,7 +5639,7 @@ module Aws::CloudFormation
|
|
4939
5639
|
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4940
5640
|
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4941
5641
|
# status_message: "StatusMessage",
|
4942
|
-
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
|
5642
|
+
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration
|
4943
5643
|
# resource_model: "ResourceModel",
|
4944
5644
|
# client_request_token: "ClientRequestToken",
|
4945
5645
|
# }
|
@@ -5018,6 +5718,63 @@ module Aws::CloudFormation
|
|
5018
5718
|
#
|
5019
5719
|
class RecordHandlerProgressOutput < Aws::EmptyStructure; end
|
5020
5720
|
|
5721
|
+
# @note When making an API call, you may pass RegisterPublisherInput
|
5722
|
+
# data as a hash:
|
5723
|
+
#
|
5724
|
+
# {
|
5725
|
+
# accept_terms_and_conditions: false,
|
5726
|
+
# connection_arn: "ConnectionArn",
|
5727
|
+
# }
|
5728
|
+
#
|
5729
|
+
# @!attribute [rw] accept_terms_and_conditions
|
5730
|
+
# Whether you accept the [Terms and Conditions][1] for publishing
|
5731
|
+
# extensions in the CloudFormation registry. You must accept the terms
|
5732
|
+
# and conditions in order to register to publish public extensions to
|
5733
|
+
# the CloudFormation registry.
|
5734
|
+
#
|
5735
|
+
# The default is `false`.
|
5736
|
+
#
|
5737
|
+
#
|
5738
|
+
#
|
5739
|
+
# [1]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
|
5740
|
+
# @return [Boolean]
|
5741
|
+
#
|
5742
|
+
# @!attribute [rw] connection_arn
|
5743
|
+
# If you are using a Bitbucket or GitHub account for identity
|
5744
|
+
# verification, the Amazon Resource Name (ARN) for your connection to
|
5745
|
+
# that account.
|
5746
|
+
#
|
5747
|
+
# For more information, see [Registering your account to publish
|
5748
|
+
# CloudFormation extensions][1] in the *CloudFormation CLI User
|
5749
|
+
# Guide*.
|
5750
|
+
#
|
5751
|
+
#
|
5752
|
+
#
|
5753
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
|
5754
|
+
# @return [String]
|
5755
|
+
#
|
5756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisherInput AWS API Documentation
|
5757
|
+
#
|
5758
|
+
class RegisterPublisherInput < Struct.new(
|
5759
|
+
:accept_terms_and_conditions,
|
5760
|
+
:connection_arn)
|
5761
|
+
SENSITIVE = []
|
5762
|
+
include Aws::Structure
|
5763
|
+
end
|
5764
|
+
|
5765
|
+
# @!attribute [rw] publisher_id
|
5766
|
+
# The ID assigned this account by CloudFormation for publishing
|
5767
|
+
# extensions.
|
5768
|
+
# @return [String]
|
5769
|
+
#
|
5770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisherOutput AWS API Documentation
|
5771
|
+
#
|
5772
|
+
class RegisterPublisherOutput < Struct.new(
|
5773
|
+
:publisher_id)
|
5774
|
+
SENSITIVE = []
|
5775
|
+
include Aws::Structure
|
5776
|
+
end
|
5777
|
+
|
5021
5778
|
# @note When making an API call, you may pass RegisterTypeInput
|
5022
5779
|
# data as a hash:
|
5023
5780
|
#
|
@@ -5040,8 +5797,13 @@ module Aws::CloudFormation
|
|
5040
5797
|
# @!attribute [rw] type_name
|
5041
5798
|
# The name of the extension being registered.
|
5042
5799
|
#
|
5043
|
-
# We recommend that extension names adhere to the following
|
5044
|
-
#
|
5800
|
+
# We recommend that extension names adhere to the following patterns:
|
5801
|
+
#
|
5802
|
+
# * For resource types,
|
5803
|
+
# *company\_or\_organization*\::*service*\::*type*.
|
5804
|
+
#
|
5805
|
+
# * For modules,
|
5806
|
+
# *company\_or\_organization*\::*service*\::*type*\::MODULE.
|
5045
5807
|
#
|
5046
5808
|
# <note markdown="1"> The following organization namespaces are reserved and cannot be
|
5047
5809
|
# used in your extension names:
|
@@ -5074,7 +5836,7 @@ module Aws::CloudFormation
|
|
5074
5836
|
# package in the S3 bucket. That is, the user needs to have
|
5075
5837
|
# [GetObject][2] permissions for the schema handler package. For more
|
5076
5838
|
# information, see [Actions, Resources, and Condition Keys for Amazon
|
5077
|
-
# S3][3] in the *
|
5839
|
+
# S3][3] in the *Identity and Access Management User Guide*.
|
5078
5840
|
#
|
5079
5841
|
# </note>
|
5080
5842
|
#
|
@@ -5091,15 +5853,26 @@ module Aws::CloudFormation
|
|
5091
5853
|
#
|
5092
5854
|
# @!attribute [rw] execution_role_arn
|
5093
5855
|
# The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
|
5094
|
-
# assume when invoking the extension.
|
5095
|
-
#
|
5856
|
+
# assume when invoking the extension.
|
5857
|
+
#
|
5858
|
+
# For CloudFormation to assume the specified execution role, the role
|
5859
|
+
# must contain a trust relationship with the CloudFormation service
|
5860
|
+
# principle (`resources.cloudformation.amazonaws.com`). For more
|
5861
|
+
# information on adding trust relationships, see [Modifying a role
|
5862
|
+
# trust
|
5863
|
+
# policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
|
5864
|
+
# in the *Identity and Access Management User Guide*.
|
5865
|
+
#
|
5866
|
+
# If your extension calls Amazon Web Services APIs in any of its
|
5867
|
+
# handlers, you must create an <i> <a
|
5096
5868
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
5097
5869
|
# execution role</a> </i> that includes the necessary permissions to
|
5098
|
-
# call those
|
5099
|
-
# account. When CloudFormation needs to invoke the
|
5100
|
-
# CloudFormation assumes this execution role to
|
5101
|
-
# session token, which it then passes to the
|
5102
|
-
# thereby supplying your
|
5870
|
+
# call those Amazon Web Services APIs, and provision that execution
|
5871
|
+
# role in your account. When CloudFormation needs to invoke the
|
5872
|
+
# resource type handler, CloudFormation assumes this execution role to
|
5873
|
+
# create a temporary session token, which it then passes to the
|
5874
|
+
# resource type handler, thereby supplying your resource type with the
|
5875
|
+
# appropriate credentials.
|
5103
5876
|
# @return [String]
|
5104
5877
|
#
|
5105
5878
|
# @!attribute [rw] client_request_token
|
@@ -5139,13 +5912,66 @@ module Aws::CloudFormation
|
|
5139
5912
|
include Aws::Structure
|
5140
5913
|
end
|
5141
5914
|
|
5915
|
+
# For extensions that are modules, a public third-party extension that
|
5916
|
+
# must be activated in your account in order for the module itself to be
|
5917
|
+
# activated.
|
5918
|
+
#
|
5919
|
+
# For more information, see [Activating public modules for use in your
|
5920
|
+
# account][1] in the *CloudFormation User Guide*.
|
5921
|
+
#
|
5922
|
+
#
|
5923
|
+
#
|
5924
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling
|
5925
|
+
#
|
5926
|
+
# @!attribute [rw] type_name_alias
|
5927
|
+
# An alias assigned to the public extension, in this account and
|
5928
|
+
# region. If you specify an alias for the extension, CloudFormation
|
5929
|
+
# treats the alias as the extension type name within this account and
|
5930
|
+
# region. You must use the alias to refer to the extension in your
|
5931
|
+
# templates, API calls, and CloudFormation console.
|
5932
|
+
# @return [String]
|
5933
|
+
#
|
5934
|
+
# @!attribute [rw] original_type_name
|
5935
|
+
# The type name of the public extension.
|
5936
|
+
#
|
5937
|
+
# If you specified a `TypeNameAlias` when enabling the extension in
|
5938
|
+
# this account and region, CloudFormation treats that alias as the
|
5939
|
+
# extension's type name within the account and region, not the type
|
5940
|
+
# name of the public extension. For more information, see [Specifying
|
5941
|
+
# aliases to refer to extensions][1] in the *CloudFormation User
|
5942
|
+
# Guide*.
|
5943
|
+
#
|
5944
|
+
#
|
5945
|
+
#
|
5946
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
|
5947
|
+
# @return [String]
|
5948
|
+
#
|
5949
|
+
# @!attribute [rw] publisher_id
|
5950
|
+
# The publisher ID of the extension publisher.
|
5951
|
+
# @return [String]
|
5952
|
+
#
|
5953
|
+
# @!attribute [rw] supported_major_versions
|
5954
|
+
# A list of the major versions of the extension type that the macro
|
5955
|
+
# supports.
|
5956
|
+
# @return [Array<Integer>]
|
5957
|
+
#
|
5958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RequiredActivatedType AWS API Documentation
|
5959
|
+
#
|
5960
|
+
class RequiredActivatedType < Struct.new(
|
5961
|
+
:type_name_alias,
|
5962
|
+
:original_type_name,
|
5963
|
+
:publisher_id,
|
5964
|
+
:supported_major_versions)
|
5965
|
+
SENSITIVE = []
|
5966
|
+
include Aws::Structure
|
5967
|
+
end
|
5968
|
+
|
5142
5969
|
# The `ResourceChange` structure describes the resource and the action
|
5143
|
-
# that
|
5144
|
-
# set.
|
5970
|
+
# that CloudFormation will perform on it if you execute this change set.
|
5145
5971
|
#
|
5146
5972
|
# @!attribute [rw] action
|
5147
|
-
# The action that
|
5148
|
-
#
|
5973
|
+
# The action that CloudFormation takes on the resource, such as `Add`
|
5974
|
+
# (adds a new resource), `Modify` (changes a resource), `Remove`
|
5149
5975
|
# (deletes a resource), `Import` (imports a resource), or `Dynamic`
|
5150
5976
|
# (exact action for the resource cannot be determined).
|
5151
5977
|
# @return [String]
|
@@ -5161,11 +5987,11 @@ module Aws::CloudFormation
|
|
5161
5987
|
# @return [String]
|
5162
5988
|
#
|
5163
5989
|
# @!attribute [rw] resource_type
|
5164
|
-
# The type of
|
5990
|
+
# The type of CloudFormation resource, such as `AWS::S3::Bucket`.
|
5165
5991
|
# @return [String]
|
5166
5992
|
#
|
5167
5993
|
# @!attribute [rw] replacement
|
5168
|
-
# For the `Modify` action, indicates whether
|
5994
|
+
# For the `Modify` action, indicates whether CloudFormation will
|
5169
5995
|
# replace the resource by creating a new one and deleting the old one.
|
5170
5996
|
# This value depends on the value of the `RequiresRecreation` property
|
5171
5997
|
# in the `ResourceTargetDefinition` structure. For example, if the
|
@@ -5188,7 +6014,7 @@ module Aws::CloudFormation
|
|
5188
6014
|
#
|
5189
6015
|
# @!attribute [rw] details
|
5190
6016
|
# For the `Modify` action, a list of `ResourceChangeDetail` structures
|
5191
|
-
# that describes the changes that
|
6017
|
+
# that describes the changes that CloudFormation will make to the
|
5192
6018
|
# resource.
|
5193
6019
|
# @return [Array<Types::ResourceChangeDetail>]
|
5194
6020
|
#
|
@@ -5219,23 +6045,23 @@ module Aws::CloudFormation
|
|
5219
6045
|
end
|
5220
6046
|
|
5221
6047
|
# For a resource with `Modify` as the action, the `ResourceChange`
|
5222
|
-
# structure describes the changes
|
6048
|
+
# structure describes the changes CloudFormation will make to that
|
5223
6049
|
# resource.
|
5224
6050
|
#
|
5225
6051
|
# @!attribute [rw] target
|
5226
6052
|
# A `ResourceTargetDefinition` structure that describes the field that
|
5227
|
-
#
|
6053
|
+
# CloudFormation will change and whether the resource will be
|
5228
6054
|
# recreated.
|
5229
6055
|
# @return [Types::ResourceTargetDefinition]
|
5230
6056
|
#
|
5231
6057
|
# @!attribute [rw] evaluation
|
5232
|
-
# Indicates whether
|
5233
|
-
#
|
6058
|
+
# Indicates whether CloudFormation can determine the target value, and
|
6059
|
+
# whether the target value will change before you execute a change
|
5234
6060
|
# set.
|
5235
6061
|
#
|
5236
|
-
# For `Static` evaluations,
|
6062
|
+
# For `Static` evaluations, CloudFormation can determine that the
|
5237
6063
|
# target value will change, and its value. For example, if you
|
5238
|
-
# directly modify the `InstanceType` property of an EC2 instance,
|
6064
|
+
# directly modify the `InstanceType` property of an EC2 instance,
|
5239
6065
|
# CloudFormation knows that this property value will change, and its
|
5240
6066
|
# value, so this is a `Static` evaluation.
|
5241
6067
|
#
|
@@ -5270,11 +6096,11 @@ module Aws::CloudFormation
|
|
5270
6096
|
#
|
5271
6097
|
# * `Automatic` entities are `AWS::CloudFormation::Stack` resource
|
5272
6098
|
# types, which are also known as nested stacks. If you made no
|
5273
|
-
# changes to the `AWS::CloudFormation::Stack` resource,
|
6099
|
+
# changes to the `AWS::CloudFormation::Stack` resource,
|
5274
6100
|
# CloudFormation sets the `ChangeSource` to `Automatic` because the
|
5275
6101
|
# nested stack's template might have changed. Changes to a nested
|
5276
|
-
# stack's template aren't visible to
|
5277
|
-
#
|
6102
|
+
# stack's template aren't visible to CloudFormation until you run
|
6103
|
+
# an update on the parent stack.
|
5278
6104
|
# @return [String]
|
5279
6105
|
#
|
5280
6106
|
# @!attribute [rw] causing_entity
|
@@ -5330,7 +6156,7 @@ module Aws::CloudFormation
|
|
5330
6156
|
include Aws::Structure
|
5331
6157
|
end
|
5332
6158
|
|
5333
|
-
# The field that
|
6159
|
+
# The field that CloudFormation will change, such as the name of a
|
5334
6160
|
# resource's property, and whether the resource will be recreated.
|
5335
6161
|
#
|
5336
6162
|
# @!attribute [rw] attribute
|
@@ -5349,7 +6175,7 @@ module Aws::CloudFormation
|
|
5349
6175
|
# to this property causes the resource to be recreated. The value can
|
5350
6176
|
# be `Never`, `Always`, or `Conditionally`. To determine the
|
5351
6177
|
# conditions for a `Conditionally` recreation, see the update behavior
|
5352
|
-
# for that [property][1] in the
|
6178
|
+
# for that [property][1] in the CloudFormation User Guide.
|
5353
6179
|
#
|
5354
6180
|
#
|
5355
6181
|
#
|
@@ -5382,8 +6208,8 @@ module Aws::CloudFormation
|
|
5382
6208
|
# @!attribute [rw] resource_type
|
5383
6209
|
# The type of resource to import into your stack, such as
|
5384
6210
|
# `AWS::S3::Bucket`. For a list of supported resource types, see
|
5385
|
-
# [Resources that support import operations][1] in the
|
5386
|
-
#
|
6211
|
+
# [Resources that support import operations][1] in the CloudFormation
|
6212
|
+
# User Guide.
|
5387
6213
|
#
|
5388
6214
|
#
|
5389
6215
|
#
|
@@ -5411,15 +6237,15 @@ module Aws::CloudFormation
|
|
5411
6237
|
include Aws::Structure
|
5412
6238
|
end
|
5413
6239
|
|
5414
|
-
# Structure containing the rollback triggers for
|
6240
|
+
# Structure containing the rollback triggers for CloudFormation to
|
5415
6241
|
# monitor during stack creation and updating operations, and for the
|
5416
6242
|
# specified monitoring period afterwards.
|
5417
6243
|
#
|
5418
|
-
# Rollback triggers enable you to have
|
5419
|
-
#
|
5420
|
-
#
|
5421
|
-
#
|
5422
|
-
#
|
6244
|
+
# Rollback triggers enable you to have CloudFormation monitor the state
|
6245
|
+
# of your application during stack creation and updating, and to roll
|
6246
|
+
# back that operation if the application breaches the threshold of any
|
6247
|
+
# of the alarms you've specified. For more information, see [Monitor
|
6248
|
+
# and Roll Back Stack Operations][1].
|
5423
6249
|
#
|
5424
6250
|
#
|
5425
6251
|
#
|
@@ -5441,9 +6267,9 @@ module Aws::CloudFormation
|
|
5441
6267
|
# @!attribute [rw] rollback_triggers
|
5442
6268
|
# The triggers to monitor during stack creation or update actions.
|
5443
6269
|
#
|
5444
|
-
# By default,
|
5445
|
-
#
|
5446
|
-
#
|
6270
|
+
# By default, CloudFormation saves the rollback triggers specified for
|
6271
|
+
# a stack and applies them to any subsequent update operations for the
|
6272
|
+
# stack, unless you specify otherwise. If you do specify rollback
|
5447
6273
|
# triggers for this parameter, those triggers replace any list of
|
5448
6274
|
# triggers previously specified for the stack. This means:
|
5449
6275
|
#
|
@@ -5497,7 +6323,7 @@ module Aws::CloudFormation
|
|
5497
6323
|
include Aws::Structure
|
5498
6324
|
end
|
5499
6325
|
|
5500
|
-
# A rollback trigger
|
6326
|
+
# A rollback trigger CloudFormation monitors during creation and
|
5501
6327
|
# updating of stacks. If any of the alarms you specify goes to ALARM
|
5502
6328
|
# state during the stack operation or within the specified monitoring
|
5503
6329
|
# period afterwards, CloudFormation rolls back the entire stack
|
@@ -5554,9 +6380,9 @@ module Aws::CloudFormation
|
|
5554
6380
|
#
|
5555
6381
|
# @!attribute [rw] stack_policy_body
|
5556
6382
|
# Structure containing the stack policy body. For more information, go
|
5557
|
-
# to [ Prevent Updates to Stack Resources][1] in the
|
5558
|
-
#
|
5559
|
-
# `
|
6383
|
+
# to [ Prevent Updates to Stack Resources][1] in the CloudFormation
|
6384
|
+
# User Guide. You can specify either the `StackPolicyBody` or the
|
6385
|
+
# `StackPolicyURL` parameter, but not both.
|
5560
6386
|
#
|
5561
6387
|
#
|
5562
6388
|
#
|
@@ -5580,6 +6406,101 @@ module Aws::CloudFormation
|
|
5580
6406
|
include Aws::Structure
|
5581
6407
|
end
|
5582
6408
|
|
6409
|
+
# @note When making an API call, you may pass SetTypeConfigurationInput
|
6410
|
+
# data as a hash:
|
6411
|
+
#
|
6412
|
+
# {
|
6413
|
+
# type_arn: "TypeArn",
|
6414
|
+
# configuration: "TypeConfiguration", # required
|
6415
|
+
# configuration_alias: "TypeConfigurationAlias",
|
6416
|
+
# type_name: "TypeName",
|
6417
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
6418
|
+
# }
|
6419
|
+
#
|
6420
|
+
# @!attribute [rw] type_arn
|
6421
|
+
# The Amazon Resource Name (ARN) for the extension, in this account
|
6422
|
+
# and region.
|
6423
|
+
#
|
6424
|
+
# For public extensions, this will be the ARN assigned when you
|
6425
|
+
# [activate the type][1] in this account and region. For private
|
6426
|
+
# extensions, this will be the ARN assigned when you [register the
|
6427
|
+
# type][2] in this account and region.
|
6428
|
+
#
|
6429
|
+
# Do not include the extension versions suffix at the end of the ARN.
|
6430
|
+
# You can set the configuration for an extension, but not for a
|
6431
|
+
# specific extension version.
|
6432
|
+
#
|
6433
|
+
#
|
6434
|
+
#
|
6435
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
6436
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
6437
|
+
# @return [String]
|
6438
|
+
#
|
6439
|
+
# @!attribute [rw] configuration
|
6440
|
+
# The configuration data for the extension, in this account and
|
6441
|
+
# region.
|
6442
|
+
#
|
6443
|
+
# The configuration data must be formatted as JSON, and validate
|
6444
|
+
# against the schema returned in the `ConfigurationSchema` response
|
6445
|
+
# element of
|
6446
|
+
# [API\_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
|
6447
|
+
# For more information, see [Defining account-level configuration data
|
6448
|
+
# for an extension][1] in the *CloudFormation CLI User Guide*.
|
6449
|
+
#
|
6450
|
+
#
|
6451
|
+
#
|
6452
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
|
6453
|
+
# @return [String]
|
6454
|
+
#
|
6455
|
+
# @!attribute [rw] configuration_alias
|
6456
|
+
# An alias by which to refer to this extension configuration data.
|
6457
|
+
#
|
6458
|
+
# Conditional: Specifying a configuration alias is required when
|
6459
|
+
# setting a configuration for a resource type extension.
|
6460
|
+
# @return [String]
|
6461
|
+
#
|
6462
|
+
# @!attribute [rw] type_name
|
6463
|
+
# The name of the extension.
|
6464
|
+
#
|
6465
|
+
# Conditional: You must specify `ConfigurationArn`, or `Type` and
|
6466
|
+
# `TypeName`.
|
6467
|
+
# @return [String]
|
6468
|
+
#
|
6469
|
+
# @!attribute [rw] type
|
6470
|
+
# The type of extension.
|
6471
|
+
#
|
6472
|
+
# Conditional: You must specify `ConfigurationArn`, or `Type` and
|
6473
|
+
# `TypeName`.
|
6474
|
+
# @return [String]
|
6475
|
+
#
|
6476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfigurationInput AWS API Documentation
|
6477
|
+
#
|
6478
|
+
class SetTypeConfigurationInput < Struct.new(
|
6479
|
+
:type_arn,
|
6480
|
+
:configuration,
|
6481
|
+
:configuration_alias,
|
6482
|
+
:type_name,
|
6483
|
+
:type)
|
6484
|
+
SENSITIVE = []
|
6485
|
+
include Aws::Structure
|
6486
|
+
end
|
6487
|
+
|
6488
|
+
# @!attribute [rw] configuration_arn
|
6489
|
+
# The Amazon Resource Name (ARN) for the configuration data, in this
|
6490
|
+
# account and region.
|
6491
|
+
#
|
6492
|
+
# Conditional: You must specify `ConfigurationArn`, or `Type` and
|
6493
|
+
# `TypeName`.
|
6494
|
+
# @return [String]
|
6495
|
+
#
|
6496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfigurationOutput AWS API Documentation
|
6497
|
+
#
|
6498
|
+
class SetTypeConfigurationOutput < Struct.new(
|
6499
|
+
:configuration_arn)
|
6500
|
+
SENSITIVE = []
|
6501
|
+
include Aws::Structure
|
6502
|
+
end
|
6503
|
+
|
5583
6504
|
# @note When making an API call, you may pass SetTypeDefaultVersionInput
|
5584
6505
|
# data as a hash:
|
5585
6506
|
#
|
@@ -5665,8 +6586,8 @@ module Aws::CloudFormation
|
|
5665
6586
|
#
|
5666
6587
|
# @!attribute [rw] status
|
5667
6588
|
# The status of the signal, which is either success or failure. A
|
5668
|
-
# failure signal causes
|
5669
|
-
#
|
6589
|
+
# failure signal causes CloudFormation to immediately fail the stack
|
6590
|
+
# creation or update.
|
5670
6591
|
# @return [String]
|
5671
6592
|
#
|
5672
6593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResourceInput AWS API Documentation
|
@@ -5716,7 +6637,7 @@ module Aws::CloudFormation
|
|
5716
6637
|
# @return [Time]
|
5717
6638
|
#
|
5718
6639
|
# @!attribute [rw] rollback_configuration
|
5719
|
-
# The rollback triggers for
|
6640
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
5720
6641
|
# creation and updating operations, and for the specified monitoring
|
5721
6642
|
# period afterwards.
|
5722
6643
|
# @return [Types::RollbackConfiguration]
|
@@ -5754,10 +6675,10 @@ module Aws::CloudFormation
|
|
5754
6675
|
# @return [Array<Types::Output>]
|
5755
6676
|
#
|
5756
6677
|
# @!attribute [rw] role_arn
|
5757
|
-
# The Amazon Resource Name (ARN) of an
|
5758
|
-
#
|
5759
|
-
#
|
5760
|
-
#
|
6678
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
6679
|
+
# (IAM) role that is associated with the stack. During a stack
|
6680
|
+
# operation, CloudFormation uses this role's credentials to make
|
6681
|
+
# calls on your behalf.
|
5761
6682
|
# @return [String]
|
5762
6683
|
#
|
5763
6684
|
# @!attribute [rw] tags
|
@@ -5770,7 +6691,7 @@ module Aws::CloudFormation
|
|
5770
6691
|
# For [nested stacks][1], termination protection is set on the root
|
5771
6692
|
# stack and cannot be changed directly on the nested stack. For more
|
5772
6693
|
# information, see [Protecting a Stack From Being Deleted][2] in the
|
5773
|
-
# *
|
6694
|
+
# *CloudFormation User Guide*.
|
5774
6695
|
#
|
5775
6696
|
#
|
5776
6697
|
#
|
@@ -5785,7 +6706,7 @@ module Aws::CloudFormation
|
|
5785
6706
|
# stack.
|
5786
6707
|
#
|
5787
6708
|
# For more information, see [Working with Nested Stacks][1] in the
|
5788
|
-
# *
|
6709
|
+
# *CloudFormation User Guide*.
|
5789
6710
|
#
|
5790
6711
|
#
|
5791
6712
|
#
|
@@ -5798,7 +6719,7 @@ module Aws::CloudFormation
|
|
5798
6719
|
# ultimately belongs.
|
5799
6720
|
#
|
5800
6721
|
# For more information, see [Working with Nested Stacks][1] in the
|
5801
|
-
# *
|
6722
|
+
# *CloudFormation User Guide*.
|
5802
6723
|
#
|
5803
6724
|
#
|
5804
6725
|
#
|
@@ -5860,7 +6781,7 @@ module Aws::CloudFormation
|
|
5860
6781
|
# configuration. A stack is considered to have drifted if one or
|
5861
6782
|
# more of its resources have drifted.
|
5862
6783
|
#
|
5863
|
-
# * `NOT_CHECKED`\:
|
6784
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
5864
6785
|
# differs from its expected template configuration.
|
5865
6786
|
#
|
5866
6787
|
# * `IN_SYNC`\: The stack's actual configuration matches its expected
|
@@ -5898,7 +6819,7 @@ module Aws::CloudFormation
|
|
5898
6819
|
# configuration. A stack is considered to have drifted if one or
|
5899
6820
|
# more of its resources have drifted.
|
5900
6821
|
#
|
5901
|
-
# * `NOT_CHECKED`\:
|
6822
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
5902
6823
|
# differs from its expected template configuration.
|
5903
6824
|
#
|
5904
6825
|
# * `IN_SYNC`\: The stack's actual configuration matches its expected
|
@@ -5946,8 +6867,8 @@ module Aws::CloudFormation
|
|
5946
6867
|
# @return [String]
|
5947
6868
|
#
|
5948
6869
|
# @!attribute [rw] resource_type
|
5949
|
-
# Type of resource. (For more information, go to [
|
5950
|
-
# Reference][1] in the
|
6870
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
6871
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
5951
6872
|
#
|
5952
6873
|
#
|
5953
6874
|
#
|
@@ -6006,7 +6927,7 @@ module Aws::CloudFormation
|
|
6006
6927
|
include Aws::Structure
|
6007
6928
|
end
|
6008
6929
|
|
6009
|
-
# An
|
6930
|
+
# An CloudFormation stack, in a specific account and Region, that's
|
6010
6931
|
# part of a stack set operation. A stack instance is a reference to an
|
6011
6932
|
# attempted or actual stack in a given account within a given Region. A
|
6012
6933
|
# stack instance can exist without a stack—for example, if the stack
|
@@ -6021,13 +6942,12 @@ module Aws::CloudFormation
|
|
6021
6942
|
# @return [String]
|
6022
6943
|
#
|
6023
6944
|
# @!attribute [rw] region
|
6024
|
-
# The name of the
|
6025
|
-
# with.
|
6945
|
+
# The name of the Region that the stack instance is associated with.
|
6026
6946
|
# @return [String]
|
6027
6947
|
#
|
6028
6948
|
# @!attribute [rw] account
|
6029
|
-
# \[Self-managed permissions\] The name of the
|
6030
|
-
#
|
6949
|
+
# \[Self-managed permissions\] The name of the account that the stack
|
6950
|
+
# instance is associated with.
|
6031
6951
|
# @return [String]
|
6032
6952
|
#
|
6033
6953
|
# @!attribute [rw] stack_id
|
@@ -6092,7 +7012,7 @@ module Aws::CloudFormation
|
|
6092
7012
|
# stack instance is considered to have drifted if one or more of the
|
6093
7013
|
# resources in the associated stack have drifted.
|
6094
7014
|
#
|
6095
|
-
# * `NOT_CHECKED`\:
|
7015
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
6096
7016
|
# instance differs from its expected stack set configuration.
|
6097
7017
|
#
|
6098
7018
|
# * `IN_SYNC`\: The stack instance's actual configuration matches its
|
@@ -6205,13 +7125,12 @@ module Aws::CloudFormation
|
|
6205
7125
|
# @return [String]
|
6206
7126
|
#
|
6207
7127
|
# @!attribute [rw] region
|
6208
|
-
# The name of the
|
6209
|
-
# with.
|
7128
|
+
# The name of the Region that the stack instance is associated with.
|
6210
7129
|
# @return [String]
|
6211
7130
|
#
|
6212
7131
|
# @!attribute [rw] account
|
6213
|
-
# \[Self-managed permissions\] The name of the
|
6214
|
-
#
|
7132
|
+
# \[Self-managed permissions\] The name of the account that the stack
|
7133
|
+
# instance is associated with.
|
6215
7134
|
# @return [String]
|
6216
7135
|
#
|
6217
7136
|
# @!attribute [rw] stack_id
|
@@ -6271,7 +7190,7 @@ module Aws::CloudFormation
|
|
6271
7190
|
# stack instance is considered to have drifted if one or more of the
|
6272
7191
|
# resources in the associated stack have drifted.
|
6273
7192
|
#
|
6274
|
-
# * `NOT_CHECKED`\:
|
7193
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
6275
7194
|
# instance differs from its expected stack set configuration.
|
6276
7195
|
#
|
6277
7196
|
# * `IN_SYNC`\: The stack instance's actual configuration matches its
|
@@ -6303,6 +7222,13 @@ module Aws::CloudFormation
|
|
6303
7222
|
include Aws::Structure
|
6304
7223
|
end
|
6305
7224
|
|
7225
|
+
# The specified stack ARN doesn’t exist or stack doesn’t exist
|
7226
|
+
# corresponding to the ARN in input.
|
7227
|
+
#
|
7228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackNotFoundException AWS API Documentation
|
7229
|
+
#
|
7230
|
+
class StackNotFoundException < Aws::EmptyStructure; end
|
7231
|
+
|
6306
7232
|
# The StackResource data type.
|
6307
7233
|
#
|
6308
7234
|
# @!attribute [rw] stack_name
|
@@ -6319,12 +7245,12 @@ module Aws::CloudFormation
|
|
6319
7245
|
#
|
6320
7246
|
# @!attribute [rw] physical_resource_id
|
6321
7247
|
# The name or unique identifier that corresponds to a physical
|
6322
|
-
# instance ID of a resource supported by
|
7248
|
+
# instance ID of a resource supported by CloudFormation.
|
6323
7249
|
# @return [String]
|
6324
7250
|
#
|
6325
7251
|
# @!attribute [rw] resource_type
|
6326
|
-
# Type of resource. (For more information, go to [
|
6327
|
-
# Reference][1] in the
|
7252
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
7253
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
6328
7254
|
#
|
6329
7255
|
#
|
6330
7256
|
#
|
@@ -6399,12 +7325,12 @@ module Aws::CloudFormation
|
|
6399
7325
|
#
|
6400
7326
|
# @!attribute [rw] physical_resource_id
|
6401
7327
|
# The name or unique identifier that corresponds to a physical
|
6402
|
-
# instance ID of a resource supported by
|
7328
|
+
# instance ID of a resource supported by CloudFormation.
|
6403
7329
|
# @return [String]
|
6404
7330
|
#
|
6405
7331
|
# @!attribute [rw] resource_type
|
6406
|
-
# Type of resource. ((For more information, go to [
|
6407
|
-
# Reference][1] in the
|
7332
|
+
# Type of resource. ((For more information, go to [Amazon Web Services
|
7333
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
6408
7334
|
#
|
6409
7335
|
#
|
6410
7336
|
#
|
@@ -6429,7 +7355,7 @@ module Aws::CloudFormation
|
|
6429
7355
|
#
|
6430
7356
|
# @!attribute [rw] metadata
|
6431
7357
|
# The content of the `Metadata` attribute declared for the resource.
|
6432
|
-
# For more information, see [Metadata Attribute][1] in the
|
7358
|
+
# For more information, see [Metadata Attribute][1] in the
|
6433
7359
|
# CloudFormation User Guide.
|
6434
7360
|
#
|
6435
7361
|
#
|
@@ -6476,10 +7402,10 @@ module Aws::CloudFormation
|
|
6476
7402
|
|
6477
7403
|
# Contains the drift information for a resource that has been checked
|
6478
7404
|
# for drift. This includes actual and expected property values for
|
6479
|
-
# resources in which
|
6480
|
-
#
|
6481
|
-
#
|
6482
|
-
#
|
7405
|
+
# resources in which CloudFormation has detected drift. Only resource
|
7406
|
+
# properties explicitly defined in the stack template are checked for
|
7407
|
+
# drift. For more information, see [Detecting Unregulated Configuration
|
7408
|
+
# Changes to Stacks and Resources][1].
|
6483
7409
|
#
|
6484
7410
|
# Resources that do not currently support drift detection cannot be
|
6485
7411
|
# checked. For a list of resources that support drift detection, see
|
@@ -6504,14 +7430,14 @@ module Aws::CloudFormation
|
|
6504
7430
|
#
|
6505
7431
|
# @!attribute [rw] physical_resource_id
|
6506
7432
|
# The name or unique identifier that corresponds to a physical
|
6507
|
-
# instance ID of a resource supported by
|
7433
|
+
# instance ID of a resource supported by CloudFormation.
|
6508
7434
|
# @return [String]
|
6509
7435
|
#
|
6510
7436
|
# @!attribute [rw] physical_resource_id_context
|
6511
|
-
# Context information that enables
|
6512
|
-
#
|
6513
|
-
#
|
6514
|
-
#
|
7437
|
+
# Context information that enables CloudFormation to uniquely identify
|
7438
|
+
# a resource. CloudFormation uses context key-value pairs in cases
|
7439
|
+
# where a resource's logical and physical IDs are not enough to
|
7440
|
+
# uniquely identify that resource. Each context key-value pair
|
6515
7441
|
# specifies a unique resource that contains the targeted resource.
|
6516
7442
|
# @return [Array<Types::PhysicalResourceIdContextKeyValuePair>]
|
6517
7443
|
#
|
@@ -6556,13 +7482,13 @@ module Aws::CloudFormation
|
|
6556
7482
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
6557
7483
|
# expected template configuration.
|
6558
7484
|
#
|
6559
|
-
# * `NOT_CHECKED`\:
|
7485
|
+
# * `NOT_CHECKED`\: CloudFormation does not currently return this
|
6560
7486
|
# value.
|
6561
7487
|
# @return [String]
|
6562
7488
|
#
|
6563
7489
|
# @!attribute [rw] timestamp
|
6564
|
-
# Time at which
|
6565
|
-
#
|
7490
|
+
# Time at which CloudFormation performed drift detection on the stack
|
7491
|
+
# resource.
|
6566
7492
|
# @return [Time]
|
6567
7493
|
#
|
6568
7494
|
# @!attribute [rw] module_info
|
@@ -6602,7 +7528,7 @@ module Aws::CloudFormation
|
|
6602
7528
|
#
|
6603
7529
|
# * `MODIFIED`\: The resource differs from its expected configuration.
|
6604
7530
|
#
|
6605
|
-
# * `NOT_CHECKED`\:
|
7531
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the resource
|
6606
7532
|
# differs from its expected configuration.
|
6607
7533
|
#
|
6608
7534
|
# Any resources that do not currently support drift detection have a
|
@@ -6618,8 +7544,8 @@ module Aws::CloudFormation
|
|
6618
7544
|
# @return [String]
|
6619
7545
|
#
|
6620
7546
|
# @!attribute [rw] last_check_timestamp
|
6621
|
-
# When
|
6622
|
-
#
|
7547
|
+
# When CloudFormation last checked if the resource had drifted from
|
7548
|
+
# its expected configuration.
|
6623
7549
|
# @return [Time]
|
6624
7550
|
#
|
6625
7551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDriftInformation AWS API Documentation
|
@@ -6644,7 +7570,7 @@ module Aws::CloudFormation
|
|
6644
7570
|
#
|
6645
7571
|
# * `MODIFIED`\: The resource differs from its expected configuration.
|
6646
7572
|
#
|
6647
|
-
# * `NOT_CHECKED`\:
|
7573
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the resource
|
6648
7574
|
# differs from its expected configuration.
|
6649
7575
|
#
|
6650
7576
|
# Any resources that do not currently support drift detection have a
|
@@ -6654,7 +7580,7 @@ module Aws::CloudFormation
|
|
6654
7580
|
# included in `ResourcesToSkip` will also have a status of
|
6655
7581
|
# `NOT_CHECKED`. For more information on skipping resources during
|
6656
7582
|
# rollback operations, see [Continue Rolling Back an Update][2] in
|
6657
|
-
# the
|
7583
|
+
# the CloudFormation User Guide.
|
6658
7584
|
#
|
6659
7585
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
6660
7586
|
# expected configuration.
|
@@ -6666,8 +7592,8 @@ module Aws::CloudFormation
|
|
6666
7592
|
# @return [String]
|
6667
7593
|
#
|
6668
7594
|
# @!attribute [rw] last_check_timestamp
|
6669
|
-
# When
|
6670
|
-
#
|
7595
|
+
# When CloudFormation last checked if the resource had drifted from
|
7596
|
+
# its expected configuration.
|
6671
7597
|
# @return [Time]
|
6672
7598
|
#
|
6673
7599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDriftInformationSummary AWS API Documentation
|
@@ -6691,8 +7617,8 @@ module Aws::CloudFormation
|
|
6691
7617
|
# @return [String]
|
6692
7618
|
#
|
6693
7619
|
# @!attribute [rw] resource_type
|
6694
|
-
# Type of resource. (For more information, go to [
|
6695
|
-
# Reference][1] in the
|
7620
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
7621
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
6696
7622
|
#
|
6697
7623
|
#
|
6698
7624
|
#
|
@@ -6745,10 +7671,10 @@ module Aws::CloudFormation
|
|
6745
7671
|
end
|
6746
7672
|
|
6747
7673
|
# A structure that contains information about a stack set. A stack set
|
6748
|
-
# enables you to provision stacks into
|
6749
|
-
#
|
6750
|
-
#
|
6751
|
-
#
|
7674
|
+
# enables you to provision stacks into accounts and across Regions by
|
7675
|
+
# using a single CloudFormation template. In the stack set, you specify
|
7676
|
+
# the template to use, as well as any parameters and capabilities that
|
7677
|
+
# the template requires.
|
6752
7678
|
#
|
6753
7679
|
# @!attribute [rw] stack_set_name
|
6754
7680
|
# The name that's associated with the stack set.
|
@@ -6779,9 +7705,9 @@ module Aws::CloudFormation
|
|
6779
7705
|
# @!attribute [rw] capabilities
|
6780
7706
|
# The capabilities that are allowed in the stack set. Some stack set
|
6781
7707
|
# templates might include resources that can affect permissions in
|
6782
|
-
# your
|
6783
|
-
#
|
6784
|
-
#
|
7708
|
+
# your account—for example, by creating new Identity and Access
|
7709
|
+
# Management (IAM) users. For more information, see [Acknowledging IAM
|
7710
|
+
# Resources in CloudFormation Templates.][1]
|
6785
7711
|
#
|
6786
7712
|
#
|
6787
7713
|
#
|
@@ -6804,8 +7730,8 @@ module Aws::CloudFormation
|
|
6804
7730
|
# Use customized administrator roles to control which users or groups
|
6805
7731
|
# can manage specific stack sets within the same administrator
|
6806
7732
|
# account. For more information, see [Prerequisites: Granting
|
6807
|
-
# Permissions for Stack Set Operations][1] in the *
|
6808
|
-
#
|
7733
|
+
# Permissions for Stack Set Operations][1] in the *CloudFormation User
|
7734
|
+
# Guide*.
|
6809
7735
|
#
|
6810
7736
|
#
|
6811
7737
|
#
|
@@ -6830,8 +7756,8 @@ module Aws::CloudFormation
|
|
6830
7756
|
#
|
6831
7757
|
# @!attribute [rw] auto_deployment
|
6832
7758
|
# \[Service-managed permissions\] Describes whether StackSets
|
6833
|
-
# automatically deploys to
|
6834
|
-
#
|
7759
|
+
# automatically deploys to Organizations accounts that are added to a
|
7760
|
+
# target organization or organizational unit (OU).
|
6835
7761
|
# @return [Types::AutoDeployment]
|
6836
7762
|
#
|
6837
7763
|
# @!attribute [rw] permission_model
|
@@ -6845,8 +7771,8 @@ module Aws::CloudFormation
|
|
6845
7771
|
#
|
6846
7772
|
# * With `service-managed` permissions, StackSets automatically
|
6847
7773
|
# creates the IAM roles required to deploy to accounts managed by
|
6848
|
-
#
|
6849
|
-
#
|
7774
|
+
# Organizations. For more information, see [Grant Service-Managed
|
7775
|
+
# Stack Set Permissions][2].
|
6850
7776
|
#
|
6851
7777
|
#
|
6852
7778
|
#
|
@@ -6896,7 +7822,7 @@ module Aws::CloudFormation
|
|
6896
7822
|
# currently being performed on the stack set.
|
6897
7823
|
#
|
6898
7824
|
# For more information, see [Detecting Unmanaged Changes in Stack
|
6899
|
-
# Sets][1] in the *
|
7825
|
+
# Sets][1] in the *CloudFormation User Guide*.
|
6900
7826
|
#
|
6901
7827
|
#
|
6902
7828
|
#
|
@@ -6914,8 +7840,8 @@ module Aws::CloudFormation
|
|
6914
7840
|
# configuration. A stack instance is considered to have drifted if
|
6915
7841
|
# one or more of the resources in the associated stack have drifted.
|
6916
7842
|
#
|
6917
|
-
# * `NOT_CHECKED`\:
|
6918
|
-
#
|
7843
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked the stack set for
|
7844
|
+
# drift.
|
6919
7845
|
#
|
6920
7846
|
# * `IN_SYNC`\: All of the stack instances belonging to the stack set
|
6921
7847
|
# stack match from the expected template and parameter
|
@@ -7040,14 +7966,13 @@ module Aws::CloudFormation
|
|
7040
7966
|
# If the number of failed stacks within a Region exceeds the failure
|
7041
7967
|
# tolerance, the status of the operation in the Region is set to
|
7042
7968
|
# `FAILED`. This in turn sets the status of the operation as a whole
|
7043
|
-
# to `FAILED`, and
|
7969
|
+
# to `FAILED`, and CloudFormation cancels the operation in any
|
7044
7970
|
# remaining Regions.
|
7045
7971
|
#
|
7046
7972
|
# * `QUEUED`\: \[Service-managed permissions\] For automatic
|
7047
7973
|
# deployments that require a sequence of operations, the operation
|
7048
7974
|
# is queued to be performed. For more information, see the [stack
|
7049
|
-
# set operation status codes][1] in the
|
7050
|
-
# Guide.
|
7975
|
+
# set operation status codes][1] in the CloudFormation User Guide.
|
7051
7976
|
#
|
7052
7977
|
# * `RUNNING`\: The operation is currently being performed.
|
7053
7978
|
#
|
@@ -7066,7 +7991,7 @@ module Aws::CloudFormation
|
|
7066
7991
|
# @return [String]
|
7067
7992
|
#
|
7068
7993
|
# @!attribute [rw] operation_preferences
|
7069
|
-
# The preferences for how
|
7994
|
+
# The preferences for how CloudFormation performs this stack set
|
7070
7995
|
# operation.
|
7071
7996
|
# @return [Types::StackSetOperationPreferences]
|
7072
7997
|
#
|
@@ -7084,7 +8009,7 @@ module Aws::CloudFormation
|
|
7084
8009
|
# Use customized administrator roles to control which users or groups
|
7085
8010
|
# can manage specific stack sets within the same administrator
|
7086
8011
|
# account. For more information, see [Define Permissions for Multiple
|
7087
|
-
# Administrators][1] in the *
|
8012
|
+
# Administrators][1] in the *CloudFormation User Guide*.
|
7088
8013
|
#
|
7089
8014
|
#
|
7090
8015
|
#
|
@@ -7103,9 +8028,9 @@ module Aws::CloudFormation
|
|
7103
8028
|
# The time at which the operation was initiated. Note that the
|
7104
8029
|
# creation times for the stack set operation might differ from the
|
7105
8030
|
# creation time of the individual stacks themselves. This is because
|
7106
|
-
#
|
7107
|
-
#
|
7108
|
-
#
|
8031
|
+
# CloudFormation needs to perform preparatory work for the operation,
|
8032
|
+
# such as dispatching the work to the requested Regions, before
|
8033
|
+
# actually creating the first stacks.
|
7109
8034
|
# @return [Time]
|
7110
8035
|
#
|
7111
8036
|
# @!attribute [rw] end_timestamp
|
@@ -7116,8 +8041,8 @@ module Aws::CloudFormation
|
|
7116
8041
|
# @return [Time]
|
7117
8042
|
#
|
7118
8043
|
# @!attribute [rw] deployment_targets
|
7119
|
-
# \[Service-managed permissions\] The
|
7120
|
-
#
|
8044
|
+
# \[Service-managed permissions\] The Organizations accounts affected
|
8045
|
+
# by the stack operation.
|
7121
8046
|
# @return [Types::DeploymentTargets]
|
7122
8047
|
#
|
7123
8048
|
# @!attribute [rw] stack_set_drift_detection_details
|
@@ -7129,7 +8054,7 @@ module Aws::CloudFormation
|
|
7129
8054
|
# `Action` type is `DETECT_DRIFT`.
|
7130
8055
|
#
|
7131
8056
|
# For more information, see [Detecting Unmanaged Changes in Stack
|
7132
|
-
# Sets][1] in the
|
8057
|
+
# Sets][1] in the CloudFormation User Guide.
|
7133
8058
|
#
|
7134
8059
|
#
|
7135
8060
|
#
|
@@ -7155,8 +8080,8 @@ module Aws::CloudFormation
|
|
7155
8080
|
include Aws::Structure
|
7156
8081
|
end
|
7157
8082
|
|
7158
|
-
# The user-specified preferences for how
|
7159
|
-
#
|
8083
|
+
# The user-specified preferences for how CloudFormation performs a stack
|
8084
|
+
# set operation.
|
7160
8085
|
#
|
7161
8086
|
# For more information on maximum concurrent accounts and failure
|
7162
8087
|
# tolerance, see [Stack set operation options][1].
|
@@ -7178,6 +8103,8 @@ module Aws::CloudFormation
|
|
7178
8103
|
# }
|
7179
8104
|
#
|
7180
8105
|
# @!attribute [rw] region_concurrency_type
|
8106
|
+
# The concurrency type of deploying StackSets operations in Regions,
|
8107
|
+
# could be in parallel or one Region at a time.
|
7181
8108
|
# @return [String]
|
7182
8109
|
#
|
7183
8110
|
# @!attribute [rw] region_order
|
@@ -7187,27 +8114,29 @@ module Aws::CloudFormation
|
|
7187
8114
|
#
|
7188
8115
|
# @!attribute [rw] failure_tolerance_count
|
7189
8116
|
# The number of accounts, per Region, for which this operation can
|
7190
|
-
# fail before
|
7191
|
-
#
|
8117
|
+
# fail before CloudFormation stops the operation in that Region. If
|
8118
|
+
# the operation is stopped in a Region, CloudFormation doesn't
|
7192
8119
|
# attempt the operation in any subsequent Regions.
|
7193
8120
|
#
|
7194
8121
|
# Conditional: You must specify either `FailureToleranceCount` or
|
7195
8122
|
# `FailureTolerancePercentage` (but not both).
|
8123
|
+
#
|
8124
|
+
# By default, `0` is specified.
|
7196
8125
|
# @return [Integer]
|
7197
8126
|
#
|
7198
8127
|
# @!attribute [rw] failure_tolerance_percentage
|
7199
8128
|
# The percentage of accounts, per Region, for which this stack
|
7200
|
-
# operation can fail before
|
7201
|
-
#
|
7202
|
-
#
|
7203
|
-
# Regions.
|
8129
|
+
# operation can fail before CloudFormation stops the operation in that
|
8130
|
+
# Region. If the operation is stopped in a Region, CloudFormation
|
8131
|
+
# doesn't attempt the operation in any subsequent Regions.
|
7204
8132
|
#
|
7205
8133
|
# When calculating the number of accounts based on the specified
|
7206
|
-
# percentage,
|
7207
|
-
# number.
|
8134
|
+
# percentage, CloudFormation rounds *down* to the next whole number.
|
7208
8135
|
#
|
7209
8136
|
# Conditional: You must specify either `FailureToleranceCount` or
|
7210
8137
|
# `FailureTolerancePercentage`, but not both.
|
8138
|
+
#
|
8139
|
+
# By default, `0` is specified.
|
7211
8140
|
# @return [Integer]
|
7212
8141
|
#
|
7213
8142
|
# @!attribute [rw] max_concurrent_count
|
@@ -7223,6 +8152,8 @@ module Aws::CloudFormation
|
|
7223
8152
|
#
|
7224
8153
|
# Conditional: You must specify either `MaxConcurrentCount` or
|
7225
8154
|
# `MaxConcurrentPercentage`, but not both.
|
8155
|
+
#
|
8156
|
+
# By default, `1` is specified.
|
7226
8157
|
# @return [Integer]
|
7227
8158
|
#
|
7228
8159
|
# @!attribute [rw] max_concurrent_percentage
|
@@ -7230,7 +8161,7 @@ module Aws::CloudFormation
|
|
7230
8161
|
# operation at one time.
|
7231
8162
|
#
|
7232
8163
|
# When calculating the number of accounts based on the specified
|
7233
|
-
# percentage,
|
8164
|
+
# percentage, CloudFormation rounds down to the next whole number.
|
7234
8165
|
# This is true except in cases where rounding down would result is
|
7235
8166
|
# zero. In this case, CloudFormation sets the number as one instead.
|
7236
8167
|
#
|
@@ -7241,6 +8172,8 @@ module Aws::CloudFormation
|
|
7241
8172
|
#
|
7242
8173
|
# Conditional: You must specify either `MaxConcurrentCount` or
|
7243
8174
|
# `MaxConcurrentPercentage`, but not both.
|
8175
|
+
#
|
8176
|
+
# By default, `1` is specified.
|
7244
8177
|
# @return [Integer]
|
7245
8178
|
#
|
7246
8179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationPreferences AWS API Documentation
|
@@ -7260,12 +8193,12 @@ module Aws::CloudFormation
|
|
7260
8193
|
# results for a given account in a given Region.
|
7261
8194
|
#
|
7262
8195
|
# @!attribute [rw] account
|
7263
|
-
# \[Self-managed permissions\] The name of the
|
8196
|
+
# \[Self-managed permissions\] The name of the account for this
|
7264
8197
|
# operation result.
|
7265
8198
|
# @return [String]
|
7266
8199
|
#
|
7267
8200
|
# @!attribute [rw] region
|
7268
|
-
# The name of the
|
8201
|
+
# The name of the Region for this operation result.
|
7269
8202
|
# @return [String]
|
7270
8203
|
#
|
7271
8204
|
# @!attribute [rw] status
|
@@ -7299,9 +8232,8 @@ module Aws::CloudFormation
|
|
7299
8232
|
# @return [String]
|
7300
8233
|
#
|
7301
8234
|
# @!attribute [rw] account_gate_result
|
7302
|
-
# The results of the account gate function
|
7303
|
-
#
|
7304
|
-
# account
|
8235
|
+
# The results of the account gate function CloudFormation invokes, if
|
8236
|
+
# present, before proceeding with stack set operations in an account
|
7305
8237
|
# @return [Types::AccountGateResult]
|
7306
8238
|
#
|
7307
8239
|
# @!attribute [rw] organizational_unit_id
|
@@ -7351,14 +8283,13 @@ module Aws::CloudFormation
|
|
7351
8283
|
# If the number of failed stacks within a Region exceeds the failure
|
7352
8284
|
# tolerance, the status of the operation in the Region is set to
|
7353
8285
|
# `FAILED`. This in turn sets the status of the operation as a whole
|
7354
|
-
# to `FAILED`, and
|
8286
|
+
# to `FAILED`, and CloudFormation cancels the operation in any
|
7355
8287
|
# remaining Regions.
|
7356
8288
|
#
|
7357
8289
|
# * `QUEUED`\: \[Service-managed permissions\] For automatic
|
7358
8290
|
# deployments that require a sequence of operations, the operation
|
7359
8291
|
# is queued to be performed. For more information, see the [stack
|
7360
|
-
# set operation status codes][1] in the
|
7361
|
-
# Guide.
|
8292
|
+
# set operation status codes][1] in the CloudFormation User Guide.
|
7362
8293
|
#
|
7363
8294
|
# * `RUNNING`\: The operation is currently being performed.
|
7364
8295
|
#
|
@@ -7380,9 +8311,9 @@ module Aws::CloudFormation
|
|
7380
8311
|
# The time at which the operation was initiated. Note that the
|
7381
8312
|
# creation times for the stack set operation might differ from the
|
7382
8313
|
# creation time of the individual stacks themselves. This is because
|
7383
|
-
#
|
7384
|
-
#
|
7385
|
-
#
|
8314
|
+
# CloudFormation needs to perform preparatory work for the operation,
|
8315
|
+
# such as dispatching the work to the requested Regions, before
|
8316
|
+
# actually creating the first stacks.
|
7386
8317
|
# @return [Time]
|
7387
8318
|
#
|
7388
8319
|
# @!attribute [rw] end_timestamp
|
@@ -7426,8 +8357,8 @@ module Aws::CloudFormation
|
|
7426
8357
|
#
|
7427
8358
|
# @!attribute [rw] auto_deployment
|
7428
8359
|
# \[Service-managed permissions\] Describes whether StackSets
|
7429
|
-
# automatically deploys to
|
7430
|
-
#
|
8360
|
+
# automatically deploys to Organizations accounts that are added to a
|
8361
|
+
# target organizational unit (OU).
|
7431
8362
|
# @return [Types::AutoDeployment]
|
7432
8363
|
#
|
7433
8364
|
# @!attribute [rw] permission_model
|
@@ -7441,8 +8372,8 @@ module Aws::CloudFormation
|
|
7441
8372
|
#
|
7442
8373
|
# * With `service-managed` permissions, StackSets automatically
|
7443
8374
|
# creates the IAM roles required to deploy to accounts managed by
|
7444
|
-
#
|
7445
|
-
#
|
8375
|
+
# Organizations. For more information, see [Grant Service-Managed
|
8376
|
+
# Stack Set Permissions][2].
|
7446
8377
|
#
|
7447
8378
|
#
|
7448
8379
|
#
|
@@ -7462,8 +8393,8 @@ module Aws::CloudFormation
|
|
7462
8393
|
# configuration. A stack instance is considered to have drifted if
|
7463
8394
|
# one or more of the resources in the associated stack have drifted.
|
7464
8395
|
#
|
7465
|
-
# * `NOT_CHECKED`\:
|
7466
|
-
#
|
8396
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked the stack set for
|
8397
|
+
# drift.
|
7467
8398
|
#
|
7468
8399
|
# * `IN_SYNC`\: All of the stack instances belonging to the stack set
|
7469
8400
|
# stack match from the expected template and parameter
|
@@ -7535,7 +8466,7 @@ module Aws::CloudFormation
|
|
7535
8466
|
# stack.
|
7536
8467
|
#
|
7537
8468
|
# For more information, see [Working with Nested Stacks][1] in the
|
7538
|
-
# *
|
8469
|
+
# *CloudFormation User Guide*.
|
7539
8470
|
#
|
7540
8471
|
#
|
7541
8472
|
#
|
@@ -7548,7 +8479,7 @@ module Aws::CloudFormation
|
|
7548
8479
|
# ultimately belongs.
|
7549
8480
|
#
|
7550
8481
|
# For more information, see [Working with Nested Stacks][1] in the
|
7551
|
-
# *
|
8482
|
+
# *CloudFormation User Guide*.
|
7552
8483
|
#
|
7553
8484
|
#
|
7554
8485
|
#
|
@@ -7623,10 +8554,9 @@ module Aws::CloudFormation
|
|
7623
8554
|
# * If you are signed in to a delegated administrator account, specify
|
7624
8555
|
# `DELEGATED_ADMIN`.
|
7625
8556
|
#
|
7626
|
-
# Your
|
7627
|
-
#
|
7628
|
-
# delegated administrator][1] in the *
|
7629
|
-
# Guide*.
|
8557
|
+
# Your account must be registered as a delegated administrator in
|
8558
|
+
# the management account. For more information, see [Register a
|
8559
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
7630
8560
|
#
|
7631
8561
|
#
|
7632
8562
|
#
|
@@ -7648,7 +8578,7 @@ module Aws::CloudFormation
|
|
7648
8578
|
class StopStackSetOperationOutput < Aws::EmptyStructure; end
|
7649
8579
|
|
7650
8580
|
# The Tag type enables you to specify a key-value pair that can be used
|
7651
|
-
# to store information about an
|
8581
|
+
# to store information about an CloudFormation stack.
|
7652
8582
|
#
|
7653
8583
|
# @note When making an API call, you may pass Tag
|
7654
8584
|
# data as a hash:
|
@@ -7661,7 +8591,7 @@ module Aws::CloudFormation
|
|
7661
8591
|
# @!attribute [rw] key
|
7662
8592
|
# *Required*. A string used to identify this tag. You can specify a
|
7663
8593
|
# maximum of 128 characters for a tag key. Tags owned by Amazon Web
|
7664
|
-
# Services (
|
8594
|
+
# Services (Amazon Web Services) have the reserved prefix: `aws:`.
|
7665
8595
|
# @return [String]
|
7666
8596
|
#
|
7667
8597
|
# @!attribute [rw] value
|
@@ -7708,47 +8638,440 @@ module Aws::CloudFormation
|
|
7708
8638
|
include Aws::Structure
|
7709
8639
|
end
|
7710
8640
|
|
8641
|
+
# @note When making an API call, you may pass TestTypeInput
|
8642
|
+
# data as a hash:
|
8643
|
+
#
|
8644
|
+
# {
|
8645
|
+
# arn: "TypeArn",
|
8646
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
8647
|
+
# type_name: "TypeName",
|
8648
|
+
# version_id: "TypeVersionId",
|
8649
|
+
# log_delivery_bucket: "S3Bucket",
|
8650
|
+
# }
|
8651
|
+
#
|
8652
|
+
# @!attribute [rw] arn
|
8653
|
+
# The Amazon Resource Number (ARN) of the extension.
|
8654
|
+
#
|
8655
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
8656
|
+
# @return [String]
|
8657
|
+
#
|
8658
|
+
# @!attribute [rw] type
|
8659
|
+
# The type of the extension to test.
|
8660
|
+
#
|
8661
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
8662
|
+
# @return [String]
|
8663
|
+
#
|
8664
|
+
# @!attribute [rw] type_name
|
8665
|
+
# The name of the extension to test.
|
8666
|
+
#
|
8667
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
8668
|
+
# @return [String]
|
8669
|
+
#
|
8670
|
+
# @!attribute [rw] version_id
|
8671
|
+
# The version of the extension to test.
|
8672
|
+
#
|
8673
|
+
# You can specify the version id with either `Arn`, or with `TypeName`
|
8674
|
+
# and `Type`.
|
8675
|
+
#
|
8676
|
+
# If you do not specify a version, CloudFormation uses the default
|
8677
|
+
# version of the extension in this account and region for testing.
|
8678
|
+
# @return [String]
|
8679
|
+
#
|
8680
|
+
# @!attribute [rw] log_delivery_bucket
|
8681
|
+
# The S3 bucket to which CloudFormation delivers the contract test
|
8682
|
+
# execution logs.
|
8683
|
+
#
|
8684
|
+
# CloudFormation delivers the logs by the time contract testing has
|
8685
|
+
# completed and the extension has been assigned a test type status of
|
8686
|
+
# `PASSED` or `FAILED`.
|
8687
|
+
#
|
8688
|
+
# The user calling `TestType` must be able to access items in the
|
8689
|
+
# specified S3 bucket. Specifically, the user needs the following
|
8690
|
+
# permissions:
|
8691
|
+
#
|
8692
|
+
# * GetObject
|
8693
|
+
#
|
8694
|
+
# * PutObject
|
8695
|
+
#
|
8696
|
+
# For more information, see [Actions, Resources, and Condition Keys
|
8697
|
+
# for Amazon S3][1] in the *Amazon Web Services Identity and Access
|
8698
|
+
# Management User Guide*.
|
8699
|
+
#
|
8700
|
+
#
|
8701
|
+
#
|
8702
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html
|
8703
|
+
# @return [String]
|
8704
|
+
#
|
8705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestTypeInput AWS API Documentation
|
8706
|
+
#
|
8707
|
+
class TestTypeInput < Struct.new(
|
8708
|
+
:arn,
|
8709
|
+
:type,
|
8710
|
+
:type_name,
|
8711
|
+
:version_id,
|
8712
|
+
:log_delivery_bucket)
|
8713
|
+
SENSITIVE = []
|
8714
|
+
include Aws::Structure
|
8715
|
+
end
|
8716
|
+
|
8717
|
+
# @!attribute [rw] type_version_arn
|
8718
|
+
# The Amazon Resource Number (ARN) of the extension.
|
8719
|
+
# @return [String]
|
8720
|
+
#
|
8721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestTypeOutput AWS API Documentation
|
8722
|
+
#
|
8723
|
+
class TestTypeOutput < Struct.new(
|
8724
|
+
:type_version_arn)
|
8725
|
+
SENSITIVE = []
|
8726
|
+
include Aws::Structure
|
8727
|
+
end
|
8728
|
+
|
7711
8729
|
# A client request token already exists.
|
7712
8730
|
#
|
7713
8731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TokenAlreadyExistsException AWS API Documentation
|
7714
8732
|
#
|
7715
8733
|
class TokenAlreadyExistsException < Aws::EmptyStructure; end
|
7716
8734
|
|
7717
|
-
#
|
8735
|
+
# Detailed information concerning the specification of a CloudFormation
|
8736
|
+
# extension in a given account and region.
|
8737
|
+
#
|
8738
|
+
# For more information, see [Configuring extensions at the account
|
8739
|
+
# level][1] in the *CloudFormation User Guide*.
|
8740
|
+
#
|
8741
|
+
#
|
8742
|
+
#
|
8743
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
|
8744
|
+
#
|
8745
|
+
# @!attribute [rw] arn
|
8746
|
+
# The Amazon Resource Name (ARN) for the configuration data, in this
|
8747
|
+
# account and region.
|
8748
|
+
# @return [String]
|
8749
|
+
#
|
8750
|
+
# @!attribute [rw] alias
|
8751
|
+
# The alias specified for this configuration, if one was specified
|
8752
|
+
# when the configuration was set.
|
8753
|
+
# @return [String]
|
8754
|
+
#
|
8755
|
+
# @!attribute [rw] configuration
|
8756
|
+
# A JSON string specifying the configuration data for the extension,
|
8757
|
+
# in this account and region.
|
8758
|
+
#
|
8759
|
+
# If a configuration has not been set for a specified extension,
|
8760
|
+
# CloudFormation returns `\{\}`.
|
8761
|
+
# @return [String]
|
8762
|
+
#
|
8763
|
+
# @!attribute [rw] last_updated
|
8764
|
+
# When the configuration data was last updated for this extension.
|
8765
|
+
#
|
8766
|
+
# If a configuration has not been set for a specified extension,
|
8767
|
+
# CloudFormation returns `null`.
|
8768
|
+
# @return [Time]
|
8769
|
+
#
|
8770
|
+
# @!attribute [rw] type_arn
|
8771
|
+
# The Amazon Resource Name (ARN) for the extension, in this account
|
8772
|
+
# and region.
|
8773
|
+
#
|
8774
|
+
# For public extensions, this will be the ARN assigned when you
|
8775
|
+
# [activate the type][1] in this account and region. For private
|
8776
|
+
# extensions, this will be the ARN assigned when you [register the
|
8777
|
+
# type][2] in this account and region.
|
8778
|
+
#
|
8779
|
+
#
|
8780
|
+
#
|
8781
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
8782
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
8783
|
+
# @return [String]
|
8784
|
+
#
|
8785
|
+
# @!attribute [rw] type_name
|
8786
|
+
# The name of the extension.
|
8787
|
+
# @return [String]
|
8788
|
+
#
|
8789
|
+
# @!attribute [rw] is_default_configuration
|
8790
|
+
# Whether or not this configuration data is the default configuration
|
8791
|
+
# for the extension.
|
8792
|
+
# @return [Boolean]
|
8793
|
+
#
|
8794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationDetails AWS API Documentation
|
8795
|
+
#
|
8796
|
+
class TypeConfigurationDetails < Struct.new(
|
8797
|
+
:arn,
|
8798
|
+
:alias,
|
8799
|
+
:configuration,
|
8800
|
+
:last_updated,
|
8801
|
+
:type_arn,
|
8802
|
+
:type_name,
|
8803
|
+
:is_default_configuration)
|
8804
|
+
SENSITIVE = []
|
8805
|
+
include Aws::Structure
|
8806
|
+
end
|
8807
|
+
|
8808
|
+
# Identifying information for the configuration of a CloudFormation
|
8809
|
+
# extension.
|
8810
|
+
#
|
8811
|
+
# @note When making an API call, you may pass TypeConfigurationIdentifier
|
8812
|
+
# data as a hash:
|
8813
|
+
#
|
8814
|
+
# {
|
8815
|
+
# type_arn: "TypeArn",
|
8816
|
+
# type_configuration_alias: "TypeConfigurationAlias",
|
8817
|
+
# type_configuration_arn: "TypeConfigurationArn",
|
8818
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
8819
|
+
# type_name: "TypeName",
|
8820
|
+
# }
|
8821
|
+
#
|
8822
|
+
# @!attribute [rw] type_arn
|
8823
|
+
# The Amazon Resource Name (ARN) for the extension, in this account
|
8824
|
+
# and region.
|
8825
|
+
#
|
8826
|
+
# For public extensions, this will be the ARN assigned when you
|
8827
|
+
# [activate the type][1] in this account and region. For private
|
8828
|
+
# extensions, this will be the ARN assigned when you [register the
|
8829
|
+
# type][2] in this account and region.
|
8830
|
+
#
|
8831
|
+
#
|
8832
|
+
#
|
8833
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
8834
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
8835
|
+
# @return [String]
|
8836
|
+
#
|
8837
|
+
# @!attribute [rw] type_configuration_alias
|
8838
|
+
# The alias specified for this configuration, if one was specified
|
8839
|
+
# when the configuration was set.
|
8840
|
+
# @return [String]
|
8841
|
+
#
|
8842
|
+
# @!attribute [rw] type_configuration_arn
|
8843
|
+
# The Amazon Resource Name (ARN) for the configuration, in this
|
8844
|
+
# account and region.
|
8845
|
+
# @return [String]
|
8846
|
+
#
|
8847
|
+
# @!attribute [rw] type
|
8848
|
+
# The type of extension.
|
8849
|
+
# @return [String]
|
8850
|
+
#
|
8851
|
+
# @!attribute [rw] type_name
|
8852
|
+
# The name of the extension type to which this configuration applies.
|
8853
|
+
# @return [String]
|
8854
|
+
#
|
8855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationIdentifier AWS API Documentation
|
8856
|
+
#
|
8857
|
+
class TypeConfigurationIdentifier < Struct.new(
|
8858
|
+
:type_arn,
|
8859
|
+
:type_configuration_alias,
|
8860
|
+
:type_configuration_arn,
|
8861
|
+
:type,
|
8862
|
+
:type_name)
|
8863
|
+
SENSITIVE = []
|
8864
|
+
include Aws::Structure
|
8865
|
+
end
|
8866
|
+
|
8867
|
+
# The specified extension configuration cannot be found.
|
8868
|
+
#
|
8869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationNotFoundException AWS API Documentation
|
8870
|
+
#
|
8871
|
+
class TypeConfigurationNotFoundException < Aws::EmptyStructure; end
|
8872
|
+
|
8873
|
+
# Filter criteria to use in determining which extensions to return.
|
8874
|
+
#
|
8875
|
+
# @note When making an API call, you may pass TypeFilters
|
8876
|
+
# data as a hash:
|
8877
|
+
#
|
8878
|
+
# {
|
8879
|
+
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
8880
|
+
# publisher_id: "PublisherId",
|
8881
|
+
# type_name_prefix: "TypeNamePrefix",
|
8882
|
+
# }
|
8883
|
+
#
|
8884
|
+
# @!attribute [rw] category
|
8885
|
+
# The category of extensions to return.
|
8886
|
+
#
|
8887
|
+
# * `REGISTERED`\: Private extensions that have been registered for
|
8888
|
+
# this account and region.
|
8889
|
+
#
|
8890
|
+
# * `ACTIVATED`\: Public extensions that have been activated for this
|
8891
|
+
# account and region.
|
8892
|
+
#
|
8893
|
+
# * `THIRD-PARTY`\: Extensions available for use from publishers other
|
8894
|
+
# than Amazon. This includes:
|
8895
|
+
#
|
8896
|
+
# * Private extensions registered in the account.
|
8897
|
+
#
|
8898
|
+
# * Public extensions from publishers other than Amazon, whether
|
8899
|
+
# activated or not.
|
8900
|
+
#
|
8901
|
+
# * `AWS-TYPES`\: Extensions available for use from Amazon.
|
8902
|
+
# @return [String]
|
8903
|
+
#
|
8904
|
+
# @!attribute [rw] publisher_id
|
8905
|
+
# The id of the publisher of the extension.
|
8906
|
+
#
|
8907
|
+
# Extensions published by Amazon are not assigned a publisher ID. Use
|
8908
|
+
# the `AWS-TYPES` category to specify a list of types published by
|
8909
|
+
# Amazon.
|
8910
|
+
# @return [String]
|
8911
|
+
#
|
8912
|
+
# @!attribute [rw] type_name_prefix
|
8913
|
+
# A prefix to use as a filter for results.
|
8914
|
+
# @return [String]
|
8915
|
+
#
|
8916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeFilters AWS API Documentation
|
8917
|
+
#
|
8918
|
+
class TypeFilters < Struct.new(
|
8919
|
+
:category,
|
8920
|
+
:publisher_id,
|
8921
|
+
:type_name_prefix)
|
8922
|
+
SENSITIVE = []
|
8923
|
+
include Aws::Structure
|
8924
|
+
end
|
8925
|
+
|
8926
|
+
# The specified extension does not exist in the CloudFormation registry.
|
7718
8927
|
#
|
7719
8928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeNotFoundException AWS API Documentation
|
7720
8929
|
#
|
7721
8930
|
class TypeNotFoundException < Aws::EmptyStructure; end
|
7722
8931
|
|
7723
|
-
# Contains summary information about the specified CloudFormation
|
8932
|
+
# Contains summary information about the specified CloudFormation
|
8933
|
+
# extension.
|
7724
8934
|
#
|
7725
8935
|
# @!attribute [rw] type
|
7726
|
-
# The kind of
|
8936
|
+
# The kind of extension.
|
7727
8937
|
# @return [String]
|
7728
8938
|
#
|
7729
8939
|
# @!attribute [rw] type_name
|
7730
|
-
# The name of the
|
8940
|
+
# The name of the extension.
|
8941
|
+
#
|
8942
|
+
# If you specified a `TypeNameAlias` when you [activate this
|
8943
|
+
# extension][1] in your account and region, CloudFormation considers
|
8944
|
+
# that alias as the type name.
|
8945
|
+
#
|
8946
|
+
#
|
8947
|
+
#
|
8948
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
7731
8949
|
# @return [String]
|
7732
8950
|
#
|
7733
8951
|
# @!attribute [rw] default_version_id
|
7734
|
-
# The ID of the default version of the
|
7735
|
-
# used when the
|
8952
|
+
# The ID of the default version of the extension. The default version
|
8953
|
+
# is used when the extension version is not specified.
|
8954
|
+
#
|
8955
|
+
# This applies only to private extensions you have registered in your
|
8956
|
+
# account. For public extensions, both those provided by Amazon and
|
8957
|
+
# published by third parties, CloudFormation returns `null`. For more
|
8958
|
+
# information, see [RegisterType][1].
|
8959
|
+
#
|
8960
|
+
# To set the default version of an extension, use `
|
8961
|
+
# SetTypeDefaultVersion `.
|
7736
8962
|
#
|
7737
|
-
#
|
8963
|
+
#
|
8964
|
+
#
|
8965
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
7738
8966
|
# @return [String]
|
7739
8967
|
#
|
7740
8968
|
# @!attribute [rw] type_arn
|
7741
|
-
# The Amazon Resource Name (ARN) of the
|
8969
|
+
# The Amazon Resource Name (ARN) of the extension.
|
7742
8970
|
# @return [String]
|
7743
8971
|
#
|
7744
8972
|
# @!attribute [rw] last_updated
|
7745
|
-
# When the
|
8973
|
+
# When the specified extension version was registered. This applies
|
8974
|
+
# only to:
|
8975
|
+
#
|
8976
|
+
# * Private extensions you have registered in your account. For more
|
8977
|
+
# information, see [RegisterType][1].
|
8978
|
+
#
|
8979
|
+
# * Public extensions you have activated in your account with
|
8980
|
+
# auto-update specified. For more information, see
|
8981
|
+
# [ActivateType][2].
|
8982
|
+
#
|
8983
|
+
# For all other extension types, CloudFormation returns `null`.
|
8984
|
+
#
|
8985
|
+
#
|
8986
|
+
#
|
8987
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
8988
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
7746
8989
|
# @return [Time]
|
7747
8990
|
#
|
7748
8991
|
# @!attribute [rw] description
|
7749
|
-
# The description of the
|
8992
|
+
# The description of the extension.
|
8993
|
+
# @return [String]
|
8994
|
+
#
|
8995
|
+
# @!attribute [rw] publisher_id
|
8996
|
+
# The ID of the extension publisher, if the extension is published by
|
8997
|
+
# a third party. Extensions published by Amazon do not return a
|
8998
|
+
# publisher ID.
|
8999
|
+
# @return [String]
|
9000
|
+
#
|
9001
|
+
# @!attribute [rw] original_type_name
|
9002
|
+
# For public extensions that have been activated for this account and
|
9003
|
+
# region, the type name of the public extension.
|
9004
|
+
#
|
9005
|
+
# If you specified a `TypeNameAlias` when enabling the extension in
|
9006
|
+
# this account and region, CloudFormation treats that alias as the
|
9007
|
+
# extension's type name within the account and region, not the type
|
9008
|
+
# name of the public extension. For more information, see [Specifying
|
9009
|
+
# aliases to refer to extensions][1] in the *CloudFormation User
|
9010
|
+
# Guide*.
|
9011
|
+
#
|
9012
|
+
#
|
9013
|
+
#
|
9014
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
|
9015
|
+
# @return [String]
|
9016
|
+
#
|
9017
|
+
# @!attribute [rw] public_version_number
|
9018
|
+
# For public extensions that have been activated for this account and
|
9019
|
+
# region, the version of the public extension to be used for
|
9020
|
+
# CloudFormation operations in this account and region.
|
9021
|
+
#
|
9022
|
+
# How you specified `AutoUpdate` when enabling the extension affects
|
9023
|
+
# whether CloudFormation automatically updates the extention in this
|
9024
|
+
# account and region when a new version is released. For more
|
9025
|
+
# information, see [Setting CloudFormation to automatically use new
|
9026
|
+
# versions of extensions][1] in the *CloudFormation User Guide*.
|
9027
|
+
#
|
9028
|
+
#
|
9029
|
+
#
|
9030
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
|
9031
|
+
# @return [String]
|
9032
|
+
#
|
9033
|
+
# @!attribute [rw] latest_public_version
|
9034
|
+
# For public extensions that have been activated for this account and
|
9035
|
+
# region, the latest version of the public extension *that is
|
9036
|
+
# available*. For any extensions other than activated third-arty
|
9037
|
+
# extensions, CloudFormation returns `null`.
|
9038
|
+
#
|
9039
|
+
# How you specified `AutoUpdate` when enabling the extension affects
|
9040
|
+
# whether CloudFormation automatically updates the extention in this
|
9041
|
+
# account and region when a new version is released. For more
|
9042
|
+
# information, see [Setting CloudFormation to automatically use new
|
9043
|
+
# versions of extensions][1] in the *CloudFormation User Guide*.
|
9044
|
+
#
|
9045
|
+
#
|
9046
|
+
#
|
9047
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
|
9048
|
+
# @return [String]
|
9049
|
+
#
|
9050
|
+
# @!attribute [rw] publisher_identity
|
9051
|
+
# The service used to verify the publisher identity.
|
9052
|
+
#
|
9053
|
+
# For more information, see [Registering your account to publish
|
9054
|
+
# CloudFormation extensions][1] in the <i> CFN-CLI User Guide for
|
9055
|
+
# Extension Development</i>.
|
9056
|
+
#
|
9057
|
+
#
|
9058
|
+
#
|
9059
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
|
9060
|
+
# @return [String]
|
9061
|
+
#
|
9062
|
+
# @!attribute [rw] publisher_name
|
9063
|
+
# The publisher name, as defined in the public profile for that
|
9064
|
+
# publisher in the service used to verify the publisher identity.
|
7750
9065
|
# @return [String]
|
7751
9066
|
#
|
9067
|
+
# @!attribute [rw] is_activated
|
9068
|
+
# Whether or not the extension is activated for this account and
|
9069
|
+
# region.
|
9070
|
+
#
|
9071
|
+
# This applies only to third-party public extensions. Extensions
|
9072
|
+
# published by Amazon are activated by default.
|
9073
|
+
# @return [Boolean]
|
9074
|
+
#
|
7752
9075
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeSummary AWS API Documentation
|
7753
9076
|
#
|
7754
9077
|
class TypeSummary < Struct.new(
|
@@ -7757,34 +9080,47 @@ module Aws::CloudFormation
|
|
7757
9080
|
:default_version_id,
|
7758
9081
|
:type_arn,
|
7759
9082
|
:last_updated,
|
7760
|
-
:description
|
9083
|
+
:description,
|
9084
|
+
:publisher_id,
|
9085
|
+
:original_type_name,
|
9086
|
+
:public_version_number,
|
9087
|
+
:latest_public_version,
|
9088
|
+
:publisher_identity,
|
9089
|
+
:publisher_name,
|
9090
|
+
:is_activated)
|
7761
9091
|
SENSITIVE = []
|
7762
9092
|
include Aws::Structure
|
7763
9093
|
end
|
7764
9094
|
|
7765
9095
|
# Contains summary information about a specific version of a
|
7766
|
-
# CloudFormation
|
9096
|
+
# CloudFormation extension.
|
7767
9097
|
#
|
7768
9098
|
# @!attribute [rw] type
|
7769
|
-
# The kind of
|
9099
|
+
# The kind of extension.
|
7770
9100
|
# @return [String]
|
7771
9101
|
#
|
7772
9102
|
# @!attribute [rw] type_name
|
7773
|
-
# The name of the
|
9103
|
+
# The name of the extension.
|
7774
9104
|
# @return [String]
|
7775
9105
|
#
|
7776
9106
|
# @!attribute [rw] version_id
|
7777
|
-
# The ID of a specific version of the
|
9107
|
+
# The ID of a specific version of the extension. The version ID is the
|
7778
9108
|
# value at the end of the Amazon Resource Name (ARN) assigned to the
|
7779
|
-
#
|
9109
|
+
# extension version when it is registered.
|
7780
9110
|
# @return [String]
|
7781
9111
|
#
|
7782
9112
|
# @!attribute [rw] is_default_version
|
7783
|
-
# Whether the specified
|
9113
|
+
# Whether the specified extension version is set as the default
|
9114
|
+
# version.
|
9115
|
+
#
|
9116
|
+
# This applies only to private extensions you have registered in your
|
9117
|
+
# account, and extensions published by Amazon. For public third-party
|
9118
|
+
# extensions, whether or not they are activated in your account,
|
9119
|
+
# CloudFormation returns `null`.
|
7784
9120
|
# @return [Boolean]
|
7785
9121
|
#
|
7786
9122
|
# @!attribute [rw] arn
|
7787
|
-
# The Amazon Resource Name (ARN) of the
|
9123
|
+
# The Amazon Resource Name (ARN) of the extension version.
|
7788
9124
|
# @return [String]
|
7789
9125
|
#
|
7790
9126
|
# @!attribute [rw] time_created
|
@@ -7792,7 +9128,25 @@ module Aws::CloudFormation
|
|
7792
9128
|
# @return [Time]
|
7793
9129
|
#
|
7794
9130
|
# @!attribute [rw] description
|
7795
|
-
# The description of the
|
9131
|
+
# The description of the extension version.
|
9132
|
+
# @return [String]
|
9133
|
+
#
|
9134
|
+
# @!attribute [rw] public_version_number
|
9135
|
+
# For public extensions that have been activated for this account and
|
9136
|
+
# region, the version of the public extension to be used for
|
9137
|
+
# CloudFormation operations in this account and region. For any
|
9138
|
+
# extensions other than activated third-arty extensions,
|
9139
|
+
# CloudFormation returns `null`.
|
9140
|
+
#
|
9141
|
+
# How you specified `AutoUpdate` when enabling the extension affects
|
9142
|
+
# whether CloudFormation automatically updates the extention in this
|
9143
|
+
# account and region when a new version is released. For more
|
9144
|
+
# information, see [Setting CloudFormation to automatically use new
|
9145
|
+
# versions of extensions][1] in the *CloudFormation User Guide*.
|
9146
|
+
#
|
9147
|
+
#
|
9148
|
+
#
|
9149
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
|
7796
9150
|
# @return [String]
|
7797
9151
|
#
|
7798
9152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeVersionSummary AWS API Documentation
|
@@ -7804,7 +9158,8 @@ module Aws::CloudFormation
|
|
7804
9158
|
:is_default_version,
|
7805
9159
|
:arn,
|
7806
9160
|
:time_created,
|
7807
|
-
:description
|
9161
|
+
:description,
|
9162
|
+
:public_version_number)
|
7808
9163
|
SENSITIVE = []
|
7809
9164
|
include Aws::Structure
|
7810
9165
|
end
|
@@ -7860,7 +9215,7 @@ module Aws::CloudFormation
|
|
7860
9215
|
# @!attribute [rw] template_body
|
7861
9216
|
# Structure containing the template body with a minimum length of 1
|
7862
9217
|
# byte and a maximum length of 51,200 bytes. (For more information, go
|
7863
|
-
# to [Template Anatomy][1] in the
|
9218
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.)
|
7864
9219
|
#
|
7865
9220
|
# Conditional: You must specify only one of the following parameters:
|
7866
9221
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -7875,7 +9230,7 @@ module Aws::CloudFormation
|
|
7875
9230
|
# Location of file containing the template body. The URL must point to
|
7876
9231
|
# a template that is located in an Amazon S3 bucket or a Systems
|
7877
9232
|
# Manager document. For more information, go to [Template Anatomy][1]
|
7878
|
-
# in the
|
9233
|
+
# in the CloudFormation User Guide.
|
7879
9234
|
#
|
7880
9235
|
# Conditional: You must specify only one of the following parameters:
|
7881
9236
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -7930,15 +9285,15 @@ module Aws::CloudFormation
|
|
7930
9285
|
#
|
7931
9286
|
# @!attribute [rw] capabilities
|
7932
9287
|
# In some cases, you must explicitly acknowledge that your stack
|
7933
|
-
# template contains certain capabilities in order for
|
7934
|
-
#
|
9288
|
+
# template contains certain capabilities in order for CloudFormation
|
9289
|
+
# to update the stack.
|
7935
9290
|
#
|
7936
9291
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
7937
9292
|
#
|
7938
9293
|
# Some stack templates might include resources that can affect
|
7939
|
-
# permissions in your
|
7940
|
-
#
|
7941
|
-
#
|
9294
|
+
# permissions in your account; for example, by creating new Identity
|
9295
|
+
# and Access Management (IAM) users. For those stacks, you must
|
9296
|
+
# explicitly acknowledge this by specifying one of these
|
7942
9297
|
# capabilities.
|
7943
9298
|
#
|
7944
9299
|
# The following IAM resources require you to specify either the
|
@@ -7949,7 +9304,7 @@ module Aws::CloudFormation
|
|
7949
9304
|
# * If you have IAM resources with custom names, you *must* specify
|
7950
9305
|
# `CAPABILITY_NAMED_IAM`.
|
7951
9306
|
#
|
7952
|
-
# * If you don't specify either of these capabilities,
|
9307
|
+
# * If you don't specify either of these capabilities,
|
7953
9308
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
7954
9309
|
#
|
7955
9310
|
# If your stack template contains these resources, we recommend that
|
@@ -7970,7 +9325,7 @@ module Aws::CloudFormation
|
|
7970
9325
|
#
|
7971
9326
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
7972
9327
|
#
|
7973
|
-
# For more information, see [Acknowledging IAM Resources in
|
9328
|
+
# For more information, see [Acknowledging IAM Resources in
|
7974
9329
|
# CloudFormation Templates][8].
|
7975
9330
|
#
|
7976
9331
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -7986,7 +9341,7 @@ module Aws::CloudFormation
|
|
7986
9341
|
# reviewing the resulting changes in a change set, you must
|
7987
9342
|
# acknowledge this capability. This includes the [AWS::Include][9]
|
7988
9343
|
# and [AWS::Serverless][10] transforms, which are macros hosted by
|
7989
|
-
#
|
9344
|
+
# CloudFormation.
|
7990
9345
|
#
|
7991
9346
|
# If you want to update a stack from a stack template that contains
|
7992
9347
|
# macros *and* nested stacks, you must update the stack directly
|
@@ -7997,11 +9352,11 @@ module Aws::CloudFormation
|
|
7997
9352
|
#
|
7998
9353
|
# Each macro relies on an underlying Lambda service function for
|
7999
9354
|
# processing stack templates. Be aware that the Lambda function
|
8000
|
-
# owner can update the function operation without
|
9355
|
+
# owner can update the function operation without CloudFormation
|
8001
9356
|
# being notified.
|
8002
9357
|
#
|
8003
|
-
# For more information, see [Using
|
8004
|
-
#
|
9358
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
9359
|
+
# Custom Processing on Templates][11].
|
8005
9360
|
#
|
8006
9361
|
#
|
8007
9362
|
#
|
@@ -8024,12 +9379,11 @@ module Aws::CloudFormation
|
|
8024
9379
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
8025
9380
|
#
|
8026
9381
|
# If the list of resource types doesn't include a resource that
|
8027
|
-
# you're updating, the stack update fails. By default,
|
8028
|
-
#
|
8029
|
-
#
|
8030
|
-
#
|
8031
|
-
#
|
8032
|
-
# Management][1].
|
9382
|
+
# you're updating, the stack update fails. By default, CloudFormation
|
9383
|
+
# grants permissions to all resource types. Identity and Access
|
9384
|
+
# Management (IAM) uses this parameter for CloudFormation-specific
|
9385
|
+
# condition keys in IAM policies. For more information, see
|
9386
|
+
# [Controlling Access with Identity and Access Management][1].
|
8033
9387
|
#
|
8034
9388
|
#
|
8035
9389
|
#
|
@@ -8037,23 +9391,23 @@ module Aws::CloudFormation
|
|
8037
9391
|
# @return [Array<String>]
|
8038
9392
|
#
|
8039
9393
|
# @!attribute [rw] role_arn
|
8040
|
-
# The Amazon Resource Name (ARN) of an
|
8041
|
-
#
|
8042
|
-
#
|
8043
|
-
#
|
8044
|
-
#
|
8045
|
-
#
|
8046
|
-
#
|
8047
|
-
#
|
9394
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
9395
|
+
# (IAM) role that CloudFormation assumes to update the stack.
|
9396
|
+
# CloudFormation uses the role's credentials to make calls on your
|
9397
|
+
# behalf. CloudFormation always uses this role for all future
|
9398
|
+
# operations on the stack. As long as users have permission to operate
|
9399
|
+
# on the stack, CloudFormation uses this role even if the users don't
|
9400
|
+
# have permission to pass it. Ensure that the role grants least
|
9401
|
+
# privilege.
|
8048
9402
|
#
|
8049
|
-
# If you don't specify a value,
|
8050
|
-
#
|
8051
|
-
#
|
8052
|
-
#
|
9403
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
9404
|
+
# previously associated with the stack. If no role is available,
|
9405
|
+
# CloudFormation uses a temporary session that is generated from your
|
9406
|
+
# user credentials.
|
8053
9407
|
# @return [String]
|
8054
9408
|
#
|
8055
9409
|
# @!attribute [rw] rollback_configuration
|
8056
|
-
# The rollback triggers for
|
9410
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
8057
9411
|
# creation and updating operations, and for the specified monitoring
|
8058
9412
|
# period afterwards.
|
8059
9413
|
# @return [Types::RollbackConfiguration]
|
@@ -8083,26 +9437,26 @@ module Aws::CloudFormation
|
|
8083
9437
|
#
|
8084
9438
|
# @!attribute [rw] notification_arns
|
8085
9439
|
# Amazon Simple Notification Service topic Amazon Resource Names
|
8086
|
-
# (ARNs) that
|
9440
|
+
# (ARNs) that CloudFormation associates with the stack. Specify an
|
8087
9441
|
# empty list to remove all notification topics.
|
8088
9442
|
# @return [Array<String>]
|
8089
9443
|
#
|
8090
9444
|
# @!attribute [rw] tags
|
8091
|
-
# Key-value pairs to associate with this stack.
|
8092
|
-
#
|
8093
|
-
#
|
9445
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
9446
|
+
# propagates these tags to supported resources in the stack. You can
|
9447
|
+
# specify a maximum number of 50 tags.
|
8094
9448
|
#
|
8095
|
-
# If you don't specify this parameter,
|
8096
|
-
#
|
8097
|
-
#
|
9449
|
+
# If you don't specify this parameter, CloudFormation doesn't modify
|
9450
|
+
# the stack's tags. If you specify an empty value, CloudFormation
|
9451
|
+
# removes all associated tags.
|
8098
9452
|
# @return [Array<Types::Tag>]
|
8099
9453
|
#
|
8100
9454
|
# @!attribute [rw] client_request_token
|
8101
9455
|
# A unique identifier for this `UpdateStack` request. Specify this
|
8102
|
-
# token if you plan to retry requests so that
|
9456
|
+
# token if you plan to retry requests so that CloudFormation knows
|
8103
9457
|
# that you're not attempting to update a stack with the same name.
|
8104
|
-
# You might retry `UpdateStack` requests to ensure that
|
8105
|
-
#
|
9458
|
+
# You might retry `UpdateStack` requests to ensure that CloudFormation
|
9459
|
+
# successfully received them.
|
8106
9460
|
#
|
8107
9461
|
# All events triggered by a given stack operation are assigned the
|
8108
9462
|
# same client request token, which you can use to track operations.
|
@@ -8180,19 +9534,19 @@ module Aws::CloudFormation
|
|
8180
9534
|
# @return [String]
|
8181
9535
|
#
|
8182
9536
|
# @!attribute [rw] accounts
|
8183
|
-
# \[Self-managed permissions\] The names of one or more
|
8184
|
-
#
|
8185
|
-
#
|
8186
|
-
#
|
9537
|
+
# \[Self-managed permissions\] The names of one or more accounts for
|
9538
|
+
# which you want to update parameter values for stack instances. The
|
9539
|
+
# overridden parameter values will be applied to all stack instances
|
9540
|
+
# in the specified accounts and Regions.
|
8187
9541
|
#
|
8188
9542
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
8189
9543
|
# @return [Array<String>]
|
8190
9544
|
#
|
8191
9545
|
# @!attribute [rw] deployment_targets
|
8192
|
-
# \[Service-managed permissions\] The
|
8193
|
-
#
|
8194
|
-
#
|
8195
|
-
#
|
9546
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
9547
|
+
# you want to update parameter values for stack instances. If your
|
9548
|
+
# update targets OUs, the overridden parameter values only apply to
|
9549
|
+
# the accounts that are currently in the target OUs and their child
|
8196
9550
|
# OUs. Accounts added to the target OUs and their child OUs in the
|
8197
9551
|
# future won't use the overridden values.
|
8198
9552
|
#
|
@@ -8212,24 +9566,19 @@ module Aws::CloudFormation
|
|
8212
9566
|
#
|
8213
9567
|
# Any overridden parameter values will be applied to all stack
|
8214
9568
|
# instances in the specified accounts and Regions. When specifying
|
8215
|
-
# parameters and their values, be aware of how
|
9569
|
+
# parameters and their values, be aware of how CloudFormation sets
|
8216
9570
|
# parameter values during stack instance update operations:
|
8217
9571
|
#
|
8218
9572
|
# * To override the current value for a parameter, include the
|
8219
9573
|
# parameter and specify its value.
|
8220
9574
|
#
|
8221
|
-
# * To leave
|
8222
|
-
# the
|
8223
|
-
#
|
8224
|
-
# * Do not include the parameter in the list.
|
9575
|
+
# * To leave an overridden parameter set to its present value, include
|
9576
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You
|
9577
|
+
# cannot specify both a value and set `UsePreviousValue` to `true`.)
|
8225
9578
|
#
|
8226
|
-
#
|
8227
|
-
#
|
8228
|
-
#
|
8229
|
-
#
|
8230
|
-
# * To set all overridden parameter back to the values specified in
|
8231
|
-
# the stack set, specify a parameter list but do not include any
|
8232
|
-
# parameters.
|
9579
|
+
# * To set an overridden parameter back to the value specified in the
|
9580
|
+
# stack set, specify a parameter list but do not include the
|
9581
|
+
# parameter in the list.
|
8233
9582
|
#
|
8234
9583
|
# * To leave all parameters set to their present values, do not
|
8235
9584
|
# specify this property at all.
|
@@ -8253,7 +9602,7 @@ module Aws::CloudFormation
|
|
8253
9602
|
# @return [Array<Types::Parameter>]
|
8254
9603
|
#
|
8255
9604
|
# @!attribute [rw] operation_preferences
|
8256
|
-
# Preferences for how
|
9605
|
+
# Preferences for how CloudFormation performs this stack set
|
8257
9606
|
# operation.
|
8258
9607
|
# @return [Types::StackSetOperationPreferences]
|
8259
9608
|
#
|
@@ -8261,10 +9610,10 @@ module Aws::CloudFormation
|
|
8261
9610
|
# The unique identifier for this stack set operation.
|
8262
9611
|
#
|
8263
9612
|
# The operation ID also functions as an idempotency token, to ensure
|
8264
|
-
# that
|
8265
|
-
#
|
8266
|
-
#
|
8267
|
-
#
|
9613
|
+
# that CloudFormation performs the stack set operation only once, even
|
9614
|
+
# if you retry the request multiple times. You might retry stack set
|
9615
|
+
# operation requests to ensure that CloudFormation successfully
|
9616
|
+
# received them.
|
8268
9617
|
#
|
8269
9618
|
# If you don't specify an operation ID, the SDK generates one
|
8270
9619
|
# automatically.
|
@@ -8286,10 +9635,9 @@ module Aws::CloudFormation
|
|
8286
9635
|
# * If you are signed in to a delegated administrator account, specify
|
8287
9636
|
# `DELEGATED_ADMIN`.
|
8288
9637
|
#
|
8289
|
-
# Your
|
8290
|
-
#
|
8291
|
-
# delegated administrator][1] in the *
|
8292
|
-
# Guide*.
|
9638
|
+
# Your account must be registered as a delegated administrator in
|
9639
|
+
# the management account. For more information, see [Register a
|
9640
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
8293
9641
|
#
|
8294
9642
|
#
|
8295
9643
|
#
|
@@ -8398,8 +9746,8 @@ module Aws::CloudFormation
|
|
8398
9746
|
# @!attribute [rw] template_body
|
8399
9747
|
# The structure that contains the template body, with a minimum length
|
8400
9748
|
# of 1 byte and a maximum length of 51,200 bytes. For more
|
8401
|
-
# information, see [Template Anatomy][1] in the
|
8402
|
-
#
|
9749
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
9750
|
+
# Guide.
|
8403
9751
|
#
|
8404
9752
|
# Conditional: You must specify only one of the following parameters:
|
8405
9753
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
|
@@ -8414,8 +9762,8 @@ module Aws::CloudFormation
|
|
8414
9762
|
# The location of the file that contains the template body. The URL
|
8415
9763
|
# must point to a template (maximum size: 460,800 bytes) that is
|
8416
9764
|
# located in an Amazon S3 bucket or a Systems Manager document. For
|
8417
|
-
# more information, see [Template Anatomy][1] in the
|
8418
|
-
#
|
9765
|
+
# more information, see [Template Anatomy][1] in the CloudFormation
|
9766
|
+
# User Guide.
|
8419
9767
|
#
|
8420
9768
|
# Conditional: You must specify only one of the following parameters:
|
8421
9769
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
|
@@ -8441,16 +9789,15 @@ module Aws::CloudFormation
|
|
8441
9789
|
#
|
8442
9790
|
# @!attribute [rw] capabilities
|
8443
9791
|
# In some cases, you must explicitly acknowledge that your stack
|
8444
|
-
# template contains certain capabilities in order for
|
8445
|
-
#
|
8446
|
-
# instances.
|
9792
|
+
# template contains certain capabilities in order for CloudFormation
|
9793
|
+
# to update the stack set and its associated stack instances.
|
8447
9794
|
#
|
8448
9795
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
8449
9796
|
#
|
8450
9797
|
# Some stack templates might include resources that can affect
|
8451
|
-
# permissions in your
|
8452
|
-
#
|
8453
|
-
#
|
9798
|
+
# permissions in your account; for example, by creating new Identity
|
9799
|
+
# and Access Management (IAM) users. For those stacks sets, you must
|
9800
|
+
# explicitly acknowledge this by specifying one of these
|
8454
9801
|
# capabilities.
|
8455
9802
|
#
|
8456
9803
|
# The following IAM resources require you to specify either the
|
@@ -8461,7 +9808,7 @@ module Aws::CloudFormation
|
|
8461
9808
|
# * If you have IAM resources with custom names, you *must* specify
|
8462
9809
|
# `CAPABILITY_NAMED_IAM`.
|
8463
9810
|
#
|
8464
|
-
# * If you don't specify either of these capabilities,
|
9811
|
+
# * If you don't specify either of these capabilities,
|
8465
9812
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
8466
9813
|
#
|
8467
9814
|
# If your stack template contains these resources, we recommend that
|
@@ -8482,23 +9829,26 @@ module Aws::CloudFormation
|
|
8482
9829
|
#
|
8483
9830
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
8484
9831
|
#
|
8485
|
-
# For more information, see [Acknowledging IAM Resources in
|
9832
|
+
# For more information, see [Acknowledging IAM Resources in
|
8486
9833
|
# CloudFormation Templates][8].
|
8487
9834
|
#
|
8488
9835
|
# * `CAPABILITY_AUTO_EXPAND`
|
8489
9836
|
#
|
8490
|
-
# Some templates
|
8491
|
-
# or more macros,
|
8492
|
-
# processed template, without first reviewing the
|
8493
|
-
# in a change set
|
8494
|
-
#
|
8495
|
-
#
|
9837
|
+
# Some templates reference macros. If your stack set template
|
9838
|
+
# references one or more macros, you must update the stack set
|
9839
|
+
# directly from the processed template, without first reviewing the
|
9840
|
+
# resulting changes in a change set. To update the stack set
|
9841
|
+
# directly, you must acknowledge this capability. For more
|
9842
|
+
# information, see [Using CloudFormation Macros to Perform Custom
|
9843
|
+
# Processing on Templates][9].
|
8496
9844
|
#
|
8497
|
-
# Stack sets do not currently
|
8498
|
-
# (This includes the
|
8499
|
-
# transforms, which are
|
8500
|
-
#
|
8501
|
-
#
|
9845
|
+
# Stack sets with service-managed permissions do not currently
|
9846
|
+
# support the use of macros in templates. (This includes the
|
9847
|
+
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
9848
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
9849
|
+
# capability for a stack set with service-managed permissions, if
|
9850
|
+
# you reference a macro in your template the stack set operation
|
9851
|
+
# will fail.
|
8502
9852
|
#
|
8503
9853
|
#
|
8504
9854
|
#
|
@@ -8517,7 +9867,7 @@ module Aws::CloudFormation
|
|
8517
9867
|
#
|
8518
9868
|
# @!attribute [rw] tags
|
8519
9869
|
# The key-value pairs to associate with this stack set and the stacks
|
8520
|
-
# created from it.
|
9870
|
+
# created from it. CloudFormation also propagates these tags to
|
8521
9871
|
# supported resources that are created in the stacks. You can specify
|
8522
9872
|
# a maximum number of 50 tags.
|
8523
9873
|
#
|
@@ -8525,7 +9875,7 @@ module Aws::CloudFormation
|
|
8525
9875
|
# of tags that are currently associated with this stack set. This
|
8526
9876
|
# means:
|
8527
9877
|
#
|
8528
|
-
# * If you don't specify this parameter,
|
9878
|
+
# * If you don't specify this parameter, CloudFormation doesn't
|
8529
9879
|
# modify the stack's tags.
|
8530
9880
|
#
|
8531
9881
|
# * If you specify *any* tags using this parameter, you must specify
|
@@ -8536,22 +9886,22 @@ module Aws::CloudFormation
|
|
8536
9886
|
# the stack set, and therefore from the stacks and resources as
|
8537
9887
|
# well.
|
8538
9888
|
#
|
8539
|
-
# * If you specify an empty value,
|
9889
|
+
# * If you specify an empty value, CloudFormation removes all
|
8540
9890
|
# currently associated tags.
|
8541
9891
|
#
|
8542
|
-
# If you specify new tags as part of an `UpdateStackSet` action,
|
9892
|
+
# If you specify new tags as part of an `UpdateStackSet` action,
|
8543
9893
|
# CloudFormation checks to see if you have the required IAM permission
|
8544
9894
|
# to tag resources. If you omit tags that are currently associated
|
8545
|
-
# with the stack set from the list of tags you specify,
|
8546
|
-
#
|
8547
|
-
#
|
8548
|
-
#
|
8549
|
-
#
|
8550
|
-
#
|
9895
|
+
# with the stack set from the list of tags you specify, CloudFormation
|
9896
|
+
# assumes that you want to remove those tags from the stack set, and
|
9897
|
+
# checks to see if you have permission to untag resources. If you
|
9898
|
+
# don't have the necessary permission(s), the entire `UpdateStackSet`
|
9899
|
+
# action fails with an `access denied` error, and the stack set is not
|
9900
|
+
# updated.
|
8551
9901
|
# @return [Array<Types::Tag>]
|
8552
9902
|
#
|
8553
9903
|
# @!attribute [rw] operation_preferences
|
8554
|
-
# Preferences for how
|
9904
|
+
# Preferences for how CloudFormation performs this stack set
|
8555
9905
|
# operation.
|
8556
9906
|
# @return [Types::StackSetOperationPreferences]
|
8557
9907
|
#
|
@@ -8562,8 +9912,8 @@ module Aws::CloudFormation
|
|
8562
9912
|
# Specify an IAM role only if you are using customized administrator
|
8563
9913
|
# roles to control which users or groups can manage specific stack
|
8564
9914
|
# sets within the same administrator account. For more information,
|
8565
|
-
# see [Granting Permissions for Stack Set Operations][1] in the
|
8566
|
-
# CloudFormation User Guide*.
|
9915
|
+
# see [Granting Permissions for Stack Set Operations][1] in the
|
9916
|
+
# *CloudFormation User Guide*.
|
8567
9917
|
#
|
8568
9918
|
# If you specified a customized administrator role when you created
|
8569
9919
|
# the stack set, you must specify a customized administrator role,
|
@@ -8577,7 +9927,7 @@ module Aws::CloudFormation
|
|
8577
9927
|
#
|
8578
9928
|
# @!attribute [rw] execution_role_name
|
8579
9929
|
# The name of the IAM execution role to use to update the stack set.
|
8580
|
-
# If you do not specify an execution role,
|
9930
|
+
# If you do not specify an execution role, CloudFormation uses the
|
8581
9931
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
8582
9932
|
# operation.
|
8583
9933
|
#
|
@@ -8585,29 +9935,28 @@ module Aws::CloudFormation
|
|
8585
9935
|
# to control which stack resources users and groups can include in
|
8586
9936
|
# their stack sets.
|
8587
9937
|
#
|
8588
|
-
# If you specify a customized execution role,
|
8589
|
-
#
|
8590
|
-
# execution role,
|
8591
|
-
#
|
9938
|
+
# If you specify a customized execution role, CloudFormation uses that
|
9939
|
+
# role to update the stack. If you do not specify a customized
|
9940
|
+
# execution role, CloudFormation performs the update using the role
|
9941
|
+
# previously associated with the stack set, so long as you have
|
8592
9942
|
# permissions to perform operations on the stack set.
|
8593
9943
|
# @return [String]
|
8594
9944
|
#
|
8595
9945
|
# @!attribute [rw] deployment_targets
|
8596
|
-
# \[Service-managed permissions\] The
|
8597
|
-
#
|
9946
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
9947
|
+
# to update associated stack instances.
|
8598
9948
|
#
|
8599
9949
|
# To update all the stack instances associated with this stack set, do
|
8600
9950
|
# not specify `DeploymentTargets` or `Regions`.
|
8601
9951
|
#
|
8602
9952
|
# If the stack set update includes changes to the template (that is,
|
8603
9953
|
# if `TemplateBody` or `TemplateURL` is specified), or the
|
8604
|
-
# `Parameters`,
|
8605
|
-
#
|
8606
|
-
#
|
8607
|
-
#
|
8608
|
-
#
|
8609
|
-
#
|
8610
|
-
# instance status.
|
9954
|
+
# `Parameters`, CloudFormation marks all stack instances with a status
|
9955
|
+
# of `OUTDATED` prior to updating the stack instances in the specified
|
9956
|
+
# accounts and Regions. If the stack set update does not include
|
9957
|
+
# changes to the template or parameters, CloudFormation updates the
|
9958
|
+
# stack instances in the specified accounts and Regions, while leaving
|
9959
|
+
# all other stack instances with their existing stack instance status.
|
8611
9960
|
# @return [Types::DeploymentTargets]
|
8612
9961
|
#
|
8613
9962
|
# @!attribute [rw] permission_model
|
@@ -8622,8 +9971,8 @@ module Aws::CloudFormation
|
|
8622
9971
|
#
|
8623
9972
|
# * With `service-managed` permissions, StackSets automatically
|
8624
9973
|
# creates the IAM roles required to deploy to accounts managed by
|
8625
|
-
#
|
8626
|
-
#
|
9974
|
+
# Organizations. For more information, see [Grant Service-Managed
|
9975
|
+
# Stack Set Permissions][2].
|
8627
9976
|
#
|
8628
9977
|
#
|
8629
9978
|
#
|
@@ -8633,8 +9982,8 @@ module Aws::CloudFormation
|
|
8633
9982
|
#
|
8634
9983
|
# @!attribute [rw] auto_deployment
|
8635
9984
|
# \[Service-managed permissions\] Describes whether StackSets
|
8636
|
-
# automatically deploys to
|
8637
|
-
#
|
9985
|
+
# automatically deploys to Organizations accounts that are added to a
|
9986
|
+
# target organization or organizational unit (OU).
|
8638
9987
|
#
|
8639
9988
|
# If you specify `AutoDeployment`, do not specify `DeploymentTargets`
|
8640
9989
|
# or `Regions`.
|
@@ -8644,13 +9993,13 @@ module Aws::CloudFormation
|
|
8644
9993
|
# The unique ID for this stack set operation.
|
8645
9994
|
#
|
8646
9995
|
# The operation ID also functions as an idempotency token, to ensure
|
8647
|
-
# that
|
8648
|
-
#
|
8649
|
-
#
|
8650
|
-
#
|
9996
|
+
# that CloudFormation performs the stack set operation only once, even
|
9997
|
+
# if you retry the request multiple times. You might retry stack set
|
9998
|
+
# operation requests to ensure that CloudFormation successfully
|
9999
|
+
# received them.
|
8651
10000
|
#
|
8652
|
-
# If you don't specify an operation ID,
|
8653
|
-
#
|
10001
|
+
# If you don't specify an operation ID, CloudFormation generates one
|
10002
|
+
# automatically.
|
8654
10003
|
#
|
8655
10004
|
# Repeating this stack set operation with a new operation ID retries
|
8656
10005
|
# all stack instances whose status is `OUTDATED`.
|
@@ -8669,13 +10018,13 @@ module Aws::CloudFormation
|
|
8669
10018
|
#
|
8670
10019
|
# If the stack set update includes changes to the template (that is,
|
8671
10020
|
# if the `TemplateBody` or `TemplateURL` properties are specified), or
|
8672
|
-
# the `Parameters` property,
|
8673
|
-
#
|
8674
|
-
#
|
8675
|
-
#
|
8676
|
-
#
|
8677
|
-
#
|
8678
|
-
#
|
10021
|
+
# the `Parameters` property, CloudFormation marks all stack instances
|
10022
|
+
# with a status of `OUTDATED` prior to updating the stack instances in
|
10023
|
+
# the specified accounts and Regions. If the stack set update does not
|
10024
|
+
# include changes to the template or parameters, CloudFormation
|
10025
|
+
# updates the stack instances in the specified accounts and Regions,
|
10026
|
+
# while leaving all other stack instances with their existing stack
|
10027
|
+
# instance status.
|
8679
10028
|
# @return [Array<String>]
|
8680
10029
|
#
|
8681
10030
|
# @!attribute [rw] regions
|
@@ -8688,13 +10037,13 @@ module Aws::CloudFormation
|
|
8688
10037
|
#
|
8689
10038
|
# If the stack set update includes changes to the template (that is,
|
8690
10039
|
# if the `TemplateBody` or `TemplateURL` properties are specified), or
|
8691
|
-
# the `Parameters` property,
|
8692
|
-
#
|
8693
|
-
#
|
8694
|
-
#
|
8695
|
-
#
|
8696
|
-
#
|
8697
|
-
#
|
10040
|
+
# the `Parameters` property, CloudFormation marks all stack instances
|
10041
|
+
# with a status of `OUTDATED` prior to updating the stack instances in
|
10042
|
+
# the specified accounts and Regions. If the stack set update does not
|
10043
|
+
# include changes to the template or parameters, CloudFormation
|
10044
|
+
# updates the stack instances in the specified accounts and Regions,
|
10045
|
+
# while leaving all other stack instances with their existing stack
|
10046
|
+
# instance status.
|
8698
10047
|
# @return [Array<String>]
|
8699
10048
|
#
|
8700
10049
|
# @!attribute [rw] call_as
|
@@ -8710,10 +10059,9 @@ module Aws::CloudFormation
|
|
8710
10059
|
# * If you are signed in to a delegated administrator account, specify
|
8711
10060
|
# `DELEGATED_ADMIN`.
|
8712
10061
|
#
|
8713
|
-
# Your
|
8714
|
-
#
|
8715
|
-
# delegated administrator][1] in the *
|
8716
|
-
# Guide*.
|
10062
|
+
# Your account must be registered as a delegated administrator in
|
10063
|
+
# the management account. For more information, see [Register a
|
10064
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
8717
10065
|
#
|
8718
10066
|
#
|
8719
10067
|
#
|
@@ -8808,7 +10156,7 @@ module Aws::CloudFormation
|
|
8808
10156
|
# @!attribute [rw] template_body
|
8809
10157
|
# Structure containing the template body with a minimum length of 1
|
8810
10158
|
# byte and a maximum length of 51,200 bytes. For more information, go
|
8811
|
-
# to [Template Anatomy][1] in the
|
10159
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.
|
8812
10160
|
#
|
8813
10161
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
8814
10162
|
# are passed, only `TemplateBody` is used.
|
@@ -8822,7 +10170,7 @@ module Aws::CloudFormation
|
|
8822
10170
|
# Location of file containing the template body. The URL must point to
|
8823
10171
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
8824
10172
|
# bucket or a Systems Manager document. For more information, go to
|
8825
|
-
# [Template Anatomy][1] in the
|
10173
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
8826
10174
|
#
|
8827
10175
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
8828
10176
|
# are passed, only `TemplateBody` is used.
|
@@ -8858,7 +10206,7 @@ module Aws::CloudFormation
|
|
8858
10206
|
# CreateStack or UpdateStack actions with your template; otherwise,
|
8859
10207
|
# those actions return an InsufficientCapabilities error.
|
8860
10208
|
#
|
8861
|
-
# For more information, see [Acknowledging IAM Resources in
|
10209
|
+
# For more information, see [Acknowledging IAM Resources in
|
8862
10210
|
# CloudFormation Templates][1].
|
8863
10211
|
#
|
8864
10212
|
#
|