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
@@ -42,10 +42,12 @@ module Aws::CloudFormation
|
|
42
42
|
# * {OperationNotFoundException}
|
43
43
|
# * {OperationStatusCheckFailedException}
|
44
44
|
# * {StackInstanceNotFoundException}
|
45
|
+
# * {StackNotFoundException}
|
45
46
|
# * {StackSetNotEmptyException}
|
46
47
|
# * {StackSetNotFoundException}
|
47
48
|
# * {StaleRequestException}
|
48
49
|
# * {TokenAlreadyExistsException}
|
50
|
+
# * {TypeConfigurationNotFoundException}
|
49
51
|
# * {TypeNotFoundException}
|
50
52
|
#
|
51
53
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
@@ -209,6 +211,16 @@ module Aws::CloudFormation
|
|
209
211
|
end
|
210
212
|
end
|
211
213
|
|
214
|
+
class StackNotFoundException < ServiceError
|
215
|
+
|
216
|
+
# @param [Seahorse::Client::RequestContext] context
|
217
|
+
# @param [String] message
|
218
|
+
# @param [Aws::CloudFormation::Types::StackNotFoundException] data
|
219
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
220
|
+
super(context, message, data)
|
221
|
+
end
|
222
|
+
end
|
223
|
+
|
212
224
|
class StackSetNotEmptyException < ServiceError
|
213
225
|
|
214
226
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -249,6 +261,16 @@ module Aws::CloudFormation
|
|
249
261
|
end
|
250
262
|
end
|
251
263
|
|
264
|
+
class TypeConfigurationNotFoundException < ServiceError
|
265
|
+
|
266
|
+
# @param [Seahorse::Client::RequestContext] context
|
267
|
+
# @param [String] message
|
268
|
+
# @param [Aws::CloudFormation::Types::TypeConfigurationNotFoundException] data
|
269
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
270
|
+
super(context, message, data)
|
271
|
+
end
|
272
|
+
end
|
273
|
+
|
252
274
|
class TypeNotFoundException < ServiceError
|
253
275
|
|
254
276
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -60,8 +60,8 @@ module Aws::CloudFormation
|
|
60
60
|
data[:physical_resource_id]
|
61
61
|
end
|
62
62
|
|
63
|
-
# Type of resource. (For more information, go to [
|
64
|
-
# Reference][1] in the
|
63
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
64
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
65
65
|
#
|
66
66
|
#
|
67
67
|
#
|
@@ -89,7 +89,7 @@ module Aws::CloudFormation
|
|
89
89
|
# @option options [String] :template_body
|
90
90
|
# Structure containing the template body with a minimum length of 1 byte
|
91
91
|
# and a maximum length of 51,200 bytes. For more information, go to
|
92
|
-
# [Template Anatomy][1] in the
|
92
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
93
93
|
#
|
94
94
|
# Conditional: You must specify either the `TemplateBody` or the
|
95
95
|
# `TemplateURL` parameter, but not both.
|
@@ -101,7 +101,7 @@ module Aws::CloudFormation
|
|
101
101
|
# Location of file containing the template body. The URL must point to a
|
102
102
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
103
103
|
# bucket or a Systems Manager document. For more information, go to the
|
104
|
-
# [Template Anatomy][1] in the
|
104
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
105
105
|
#
|
106
106
|
# Conditional: You must specify either the `TemplateBody` or the
|
107
107
|
# `TemplateURL` parameter, but not both.
|
@@ -123,7 +123,7 @@ module Aws::CloudFormation
|
|
123
123
|
#
|
124
124
|
# Default: `false`
|
125
125
|
# @option options [Types::RollbackConfiguration] :rollback_configuration
|
126
|
-
# The rollback triggers for
|
126
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
127
127
|
# creation and updating operations, and for the specified monitoring
|
128
128
|
# period afterwards.
|
129
129
|
# @option options [Integer] :timeout_in_minutes
|
@@ -136,16 +136,15 @@ module Aws::CloudFormation
|
|
136
136
|
# or your Command Line Interface (CLI).
|
137
137
|
# @option options [Array<String>] :capabilities
|
138
138
|
# In some cases, you must explicitly acknowledge that your stack
|
139
|
-
# template contains certain capabilities in order for
|
140
|
-
#
|
139
|
+
# template contains certain capabilities in order for CloudFormation to
|
140
|
+
# create the stack.
|
141
141
|
#
|
142
142
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
143
143
|
#
|
144
144
|
# Some stack templates might include resources that can affect
|
145
|
-
# permissions in your
|
146
|
-
#
|
147
|
-
#
|
148
|
-
# capabilities.
|
145
|
+
# permissions in your account; for example, by creating new Identity
|
146
|
+
# and Access Management (IAM) users. For those stacks, you must
|
147
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
149
148
|
#
|
150
149
|
# The following IAM resources require you to specify either the
|
151
150
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -155,8 +154,8 @@ module Aws::CloudFormation
|
|
155
154
|
# * If you have IAM resources with custom names, you *must* specify
|
156
155
|
# `CAPABILITY_NAMED_IAM`.
|
157
156
|
#
|
158
|
-
# * If you don't specify either of these capabilities,
|
159
|
-
#
|
157
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
158
|
+
# returns an `InsufficientCapabilities` error.
|
160
159
|
#
|
161
160
|
# If your stack template contains these resources, we recommend that
|
162
161
|
# you review all permissions associated with them and edit their
|
@@ -176,7 +175,7 @@ module Aws::CloudFormation
|
|
176
175
|
#
|
177
176
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
178
177
|
#
|
179
|
-
# For more information, see [Acknowledging IAM Resources in
|
178
|
+
# For more information, see [Acknowledging IAM Resources in
|
180
179
|
# CloudFormation Templates][8].
|
181
180
|
#
|
182
181
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -191,7 +190,7 @@ module Aws::CloudFormation
|
|
191
190
|
# create a stack directly from the processed template, without first
|
192
191
|
# reviewing the resulting changes in a change set, you must
|
193
192
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
194
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
193
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
195
194
|
# CloudFormation.
|
196
195
|
#
|
197
196
|
# If you want to create a stack from a stack template that contains
|
@@ -203,11 +202,11 @@ module Aws::CloudFormation
|
|
203
202
|
#
|
204
203
|
# Each macro relies on an underlying Lambda service function for
|
205
204
|
# processing stack templates. Be aware that the Lambda function owner
|
206
|
-
# can update the function operation without
|
205
|
+
# can update the function operation without CloudFormation being
|
207
206
|
# notified.
|
208
207
|
#
|
209
|
-
# For more information, see [Using
|
210
|
-
#
|
208
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
209
|
+
# Custom Processing on Templates][11].
|
211
210
|
#
|
212
211
|
#
|
213
212
|
#
|
@@ -226,34 +225,34 @@ module Aws::CloudFormation
|
|
226
225
|
# The template resource types that you have permissions to work with for
|
227
226
|
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
|
228
227
|
# or `Custom::MyCustomInstance`. Use the following syntax to describe
|
229
|
-
# template resource types: `AWS::*` (for all
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
228
|
+
# template resource types: `AWS::*` (for all Amazon Web Services
|
229
|
+
# resources), `Custom::*` (for all custom resources),
|
230
|
+
# `Custom::logical_ID ` (for a specific custom resource),
|
231
|
+
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
232
|
+
# Services service), and `AWS::service_name::resource_logical_ID ` (for
|
233
|
+
# a specific Amazon Web Services resource).
|
234
234
|
#
|
235
235
|
# If the list of resource types doesn't include a resource that you're
|
236
|
-
# creating, the stack creation fails. By default,
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
236
|
+
# creating, the stack creation fails. By default, CloudFormation grants
|
237
|
+
# permissions to all resource types. Identity and Access Management
|
238
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
239
|
+
# in IAM policies. For more information, see [Controlling Access with
|
240
|
+
# Identity and Access Management][1].
|
241
241
|
#
|
242
242
|
#
|
243
243
|
#
|
244
244
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
245
245
|
# @option options [String] :role_arn
|
246
|
-
# The Amazon Resource Name (ARN) of an
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
# was previously associated with the stack. If no role is available, AWS
|
246
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
247
|
+
# (IAM) role that CloudFormation assumes to create the stack.
|
248
|
+
# CloudFormation uses the role's credentials to make calls on your
|
249
|
+
# behalf. CloudFormation always uses this role for all future operations
|
250
|
+
# on the stack. As long as users have permission to operate on the
|
251
|
+
# stack, CloudFormation uses this role even if the users don't have
|
252
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
253
|
+
#
|
254
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
255
|
+
# previously associated with the stack. If no role is available,
|
257
256
|
# CloudFormation uses a temporary session that is generated from your
|
258
257
|
# user credentials.
|
259
258
|
# @option options [String] :on_failure
|
@@ -264,7 +263,7 @@ module Aws::CloudFormation
|
|
264
263
|
# Default: `ROLLBACK`
|
265
264
|
# @option options [String] :stack_policy_body
|
266
265
|
# Structure containing the stack policy body. For more information, go
|
267
|
-
# to [ Prevent Updates to Stack Resources][1] in the *
|
266
|
+
# to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
|
268
267
|
# User Guide*. You can specify either the `StackPolicyBody` or the
|
269
268
|
# `StackPolicyURL` parameter, but not both.
|
270
269
|
#
|
@@ -277,14 +276,14 @@ module Aws::CloudFormation
|
|
277
276
|
# Region as the stack. You can specify either the `StackPolicyBody` or
|
278
277
|
# the `StackPolicyURL` parameter, but not both.
|
279
278
|
# @option options [Array<Types::Tag>] :tags
|
280
|
-
# Key-value pairs to associate with this stack.
|
279
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
281
280
|
# propagates these tags to the resources created in the stack. A maximum
|
282
281
|
# number of 50 tags can be specified.
|
283
282
|
# @option options [String] :client_request_token
|
284
283
|
# A unique identifier for this `CreateStack` request. Specify this token
|
285
|
-
# if you plan to retry requests so that
|
284
|
+
# if you plan to retry requests so that CloudFormation knows that
|
286
285
|
# you're not attempting to create a stack with the same name. You might
|
287
|
-
# retry `CreateStack` requests to ensure that
|
286
|
+
# retry `CreateStack` requests to ensure that CloudFormation
|
288
287
|
# successfully received them.
|
289
288
|
#
|
290
289
|
# All events triggered by a given stack operation are assigned the same
|
@@ -305,7 +304,7 @@ module Aws::CloudFormation
|
|
305
304
|
# user attempts to delete a stack with termination protection enabled,
|
306
305
|
# the operation fails and the stack remains unchanged. For more
|
307
306
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
308
|
-
# *
|
307
|
+
# *CloudFormation User Guide*. Termination protection is disabled on
|
309
308
|
# stacks by default.
|
310
309
|
#
|
311
310
|
# For [nested stacks][2], termination protection is set on the root
|
@@ -78,7 +78,7 @@ module Aws::CloudFormation
|
|
78
78
|
data[:last_updated_time]
|
79
79
|
end
|
80
80
|
|
81
|
-
# The rollback triggers for
|
81
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
82
82
|
# creation and updating operations, and for the specified monitoring
|
83
83
|
# period afterwards.
|
84
84
|
# @return [Types::RollbackConfiguration]
|
@@ -132,10 +132,10 @@ module Aws::CloudFormation
|
|
132
132
|
data[:outputs]
|
133
133
|
end
|
134
134
|
|
135
|
-
# The Amazon Resource Name (ARN) of an
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
135
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
136
|
+
# (IAM) role that is associated with the stack. During a stack
|
137
|
+
# operation, CloudFormation uses this role's credentials to make calls
|
138
|
+
# on your behalf.
|
139
139
|
# @return [String]
|
140
140
|
def role_arn
|
141
141
|
data[:role_arn]
|
@@ -152,7 +152,7 @@ module Aws::CloudFormation
|
|
152
152
|
# For [nested stacks][1], termination protection is set on the root
|
153
153
|
# stack and cannot be changed directly on the nested stack. For more
|
154
154
|
# information, see [Protecting a Stack From Being Deleted][2] in the
|
155
|
-
# *
|
155
|
+
# *CloudFormation User Guide*.
|
156
156
|
#
|
157
157
|
#
|
158
158
|
#
|
@@ -167,8 +167,8 @@ module Aws::CloudFormation
|
|
167
167
|
# stack ID of the direct parent of this stack. For the first level of
|
168
168
|
# nested stacks, the root stack is also the parent stack.
|
169
169
|
#
|
170
|
-
# For more information, see [Working with Nested Stacks][1] in the
|
171
|
-
# CloudFormation User Guide*.
|
170
|
+
# For more information, see [Working with Nested Stacks][1] in the
|
171
|
+
# *CloudFormation User Guide*.
|
172
172
|
#
|
173
173
|
#
|
174
174
|
#
|
@@ -182,8 +182,8 @@ module Aws::CloudFormation
|
|
182
182
|
# stack ID of the top-level stack to which the nested stack ultimately
|
183
183
|
# belongs.
|
184
184
|
#
|
185
|
-
# For more information, see [Working with Nested Stacks][1] in the
|
186
|
-
# CloudFormation User Guide*.
|
185
|
+
# For more information, see [Working with Nested Stacks][1] in the
|
186
|
+
# *CloudFormation User Guide*.
|
187
187
|
#
|
188
188
|
#
|
189
189
|
#
|
@@ -380,10 +380,10 @@ module Aws::CloudFormation
|
|
380
380
|
# @param [Hash] options ({})
|
381
381
|
# @option options [String] :client_request_token
|
382
382
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
383
|
-
# token if you plan to retry requests so that
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
383
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
384
|
+
# you're not attempting to cancel an update on a stack with the same
|
385
|
+
# name. You might retry `CancelUpdateStack` requests to ensure that
|
386
|
+
# CloudFormation successfully received them.
|
387
387
|
# @return [EmptyStructure]
|
388
388
|
def cancel_update(options = {})
|
389
389
|
options = options.merge(stack_name: @name)
|
@@ -435,7 +435,7 @@ module Aws::CloudFormation
|
|
435
435
|
# @option options [String] :template_body
|
436
436
|
# Structure containing the template body with a minimum length of 1 byte
|
437
437
|
# and a maximum length of 51,200 bytes. For more information, go to
|
438
|
-
# [Template Anatomy][1] in the
|
438
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
439
439
|
#
|
440
440
|
# Conditional: You must specify either the `TemplateBody` or the
|
441
441
|
# `TemplateURL` parameter, but not both.
|
@@ -447,7 +447,7 @@ module Aws::CloudFormation
|
|
447
447
|
# Location of file containing the template body. The URL must point to a
|
448
448
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
449
449
|
# bucket or a Systems Manager document. For more information, go to the
|
450
|
-
# [Template Anatomy][1] in the
|
450
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
451
451
|
#
|
452
452
|
# Conditional: You must specify either the `TemplateBody` or the
|
453
453
|
# `TemplateURL` parameter, but not both.
|
@@ -469,7 +469,7 @@ module Aws::CloudFormation
|
|
469
469
|
#
|
470
470
|
# Default: `false`
|
471
471
|
# @option options [Types::RollbackConfiguration] :rollback_configuration
|
472
|
-
# The rollback triggers for
|
472
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
473
473
|
# creation and updating operations, and for the specified monitoring
|
474
474
|
# period afterwards.
|
475
475
|
# @option options [Integer] :timeout_in_minutes
|
@@ -482,16 +482,15 @@ module Aws::CloudFormation
|
|
482
482
|
# or your Command Line Interface (CLI).
|
483
483
|
# @option options [Array<String>] :capabilities
|
484
484
|
# In some cases, you must explicitly acknowledge that your stack
|
485
|
-
# template contains certain capabilities in order for
|
486
|
-
#
|
485
|
+
# template contains certain capabilities in order for CloudFormation to
|
486
|
+
# create the stack.
|
487
487
|
#
|
488
488
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
489
489
|
#
|
490
490
|
# Some stack templates might include resources that can affect
|
491
|
-
# permissions in your
|
492
|
-
#
|
493
|
-
#
|
494
|
-
# capabilities.
|
491
|
+
# permissions in your account; for example, by creating new Identity
|
492
|
+
# and Access Management (IAM) users. For those stacks, you must
|
493
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
495
494
|
#
|
496
495
|
# The following IAM resources require you to specify either the
|
497
496
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -501,8 +500,8 @@ module Aws::CloudFormation
|
|
501
500
|
# * If you have IAM resources with custom names, you *must* specify
|
502
501
|
# `CAPABILITY_NAMED_IAM`.
|
503
502
|
#
|
504
|
-
# * If you don't specify either of these capabilities,
|
505
|
-
#
|
503
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
504
|
+
# returns an `InsufficientCapabilities` error.
|
506
505
|
#
|
507
506
|
# If your stack template contains these resources, we recommend that
|
508
507
|
# you review all permissions associated with them and edit their
|
@@ -522,7 +521,7 @@ module Aws::CloudFormation
|
|
522
521
|
#
|
523
522
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
524
523
|
#
|
525
|
-
# For more information, see [Acknowledging IAM Resources in
|
524
|
+
# For more information, see [Acknowledging IAM Resources in
|
526
525
|
# CloudFormation Templates][8].
|
527
526
|
#
|
528
527
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -537,7 +536,7 @@ module Aws::CloudFormation
|
|
537
536
|
# create a stack directly from the processed template, without first
|
538
537
|
# reviewing the resulting changes in a change set, you must
|
539
538
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
540
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
539
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
541
540
|
# CloudFormation.
|
542
541
|
#
|
543
542
|
# If you want to create a stack from a stack template that contains
|
@@ -549,11 +548,11 @@ module Aws::CloudFormation
|
|
549
548
|
#
|
550
549
|
# Each macro relies on an underlying Lambda service function for
|
551
550
|
# processing stack templates. Be aware that the Lambda function owner
|
552
|
-
# can update the function operation without
|
551
|
+
# can update the function operation without CloudFormation being
|
553
552
|
# notified.
|
554
553
|
#
|
555
|
-
# For more information, see [Using
|
556
|
-
#
|
554
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
555
|
+
# Custom Processing on Templates][11].
|
557
556
|
#
|
558
557
|
#
|
559
558
|
#
|
@@ -572,34 +571,34 @@ module Aws::CloudFormation
|
|
572
571
|
# The template resource types that you have permissions to work with for
|
573
572
|
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
|
574
573
|
# or `Custom::MyCustomInstance`. Use the following syntax to describe
|
575
|
-
# template resource types: `AWS::*` (for all
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
574
|
+
# template resource types: `AWS::*` (for all Amazon Web Services
|
575
|
+
# resources), `Custom::*` (for all custom resources),
|
576
|
+
# `Custom::logical_ID ` (for a specific custom resource),
|
577
|
+
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
578
|
+
# Services service), and `AWS::service_name::resource_logical_ID ` (for
|
579
|
+
# a specific Amazon Web Services resource).
|
580
580
|
#
|
581
581
|
# If the list of resource types doesn't include a resource that you're
|
582
|
-
# creating, the stack creation fails. By default,
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
582
|
+
# creating, the stack creation fails. By default, CloudFormation grants
|
583
|
+
# permissions to all resource types. Identity and Access Management
|
584
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
585
|
+
# in IAM policies. For more information, see [Controlling Access with
|
586
|
+
# Identity and Access Management][1].
|
587
587
|
#
|
588
588
|
#
|
589
589
|
#
|
590
590
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
591
591
|
# @option options [String] :role_arn
|
592
|
-
# The Amazon Resource Name (ARN) of an
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
# was previously associated with the stack. If no role is available, AWS
|
592
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
593
|
+
# (IAM) role that CloudFormation assumes to create the stack.
|
594
|
+
# CloudFormation uses the role's credentials to make calls on your
|
595
|
+
# behalf. CloudFormation always uses this role for all future operations
|
596
|
+
# on the stack. As long as users have permission to operate on the
|
597
|
+
# stack, CloudFormation uses this role even if the users don't have
|
598
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
599
|
+
#
|
600
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
601
|
+
# previously associated with the stack. If no role is available,
|
603
602
|
# CloudFormation uses a temporary session that is generated from your
|
604
603
|
# user credentials.
|
605
604
|
# @option options [String] :on_failure
|
@@ -610,7 +609,7 @@ module Aws::CloudFormation
|
|
610
609
|
# Default: `ROLLBACK`
|
611
610
|
# @option options [String] :stack_policy_body
|
612
611
|
# Structure containing the stack policy body. For more information, go
|
613
|
-
# to [ Prevent Updates to Stack Resources][1] in the *
|
612
|
+
# to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
|
614
613
|
# User Guide*. You can specify either the `StackPolicyBody` or the
|
615
614
|
# `StackPolicyURL` parameter, but not both.
|
616
615
|
#
|
@@ -623,14 +622,14 @@ module Aws::CloudFormation
|
|
623
622
|
# Region as the stack. You can specify either the `StackPolicyBody` or
|
624
623
|
# the `StackPolicyURL` parameter, but not both.
|
625
624
|
# @option options [Array<Types::Tag>] :tags
|
626
|
-
# Key-value pairs to associate with this stack.
|
625
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
627
626
|
# propagates these tags to the resources created in the stack. A maximum
|
628
627
|
# number of 50 tags can be specified.
|
629
628
|
# @option options [String] :client_request_token
|
630
629
|
# A unique identifier for this `CreateStack` request. Specify this token
|
631
|
-
# if you plan to retry requests so that
|
630
|
+
# if you plan to retry requests so that CloudFormation knows that
|
632
631
|
# you're not attempting to create a stack with the same name. You might
|
633
|
-
# retry `CreateStack` requests to ensure that
|
632
|
+
# retry `CreateStack` requests to ensure that CloudFormation
|
634
633
|
# successfully received them.
|
635
634
|
#
|
636
635
|
# All events triggered by a given stack operation are assigned the same
|
@@ -651,7 +650,7 @@ module Aws::CloudFormation
|
|
651
650
|
# user attempts to delete a stack with termination protection enabled,
|
652
651
|
# the operation fails and the stack remains unchanged. For more
|
653
652
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
654
|
-
# *
|
653
|
+
# *CloudFormation User Guide*. Termination protection is disabled on
|
655
654
|
# stacks by default.
|
656
655
|
#
|
657
656
|
# For [nested stacks][2], termination protection is set on the root
|
@@ -679,26 +678,26 @@ module Aws::CloudFormation
|
|
679
678
|
# @option options [Array<String>] :retain_resources
|
680
679
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
681
680
|
# IDs that are associated with the resources you want to retain. During
|
682
|
-
# deletion,
|
681
|
+
# deletion, CloudFormation deletes the stack but does not delete the
|
683
682
|
# retained resources.
|
684
683
|
#
|
685
684
|
# Retaining resources is useful when you cannot delete a resource, such
|
686
685
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
687
686
|
# @option options [String] :role_arn
|
688
|
-
# The Amazon Resource Name (ARN) of an
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
687
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
688
|
+
# (IAM) role that CloudFormation assumes to delete the stack.
|
689
|
+
# CloudFormation uses the role's credentials to make calls on your
|
690
|
+
# behalf.
|
692
691
|
#
|
693
|
-
# If you don't specify a value,
|
694
|
-
#
|
692
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
693
|
+
# previously associated with the stack. If no role is available,
|
695
694
|
# CloudFormation uses a temporary session that is generated from your
|
696
695
|
# user credentials.
|
697
696
|
# @option options [String] :client_request_token
|
698
697
|
# A unique identifier for this `DeleteStack` request. Specify this token
|
699
|
-
# if you plan to retry requests so that
|
698
|
+
# if you plan to retry requests so that CloudFormation knows that
|
700
699
|
# you're not attempting to delete a stack with the same name. You might
|
701
|
-
# retry `DeleteStack` requests to ensure that
|
700
|
+
# retry `DeleteStack` requests to ensure that CloudFormation
|
702
701
|
# successfully received them.
|
703
702
|
#
|
704
703
|
# All events triggered by a given stack operation are assigned the same
|
@@ -764,7 +763,7 @@ module Aws::CloudFormation
|
|
764
763
|
# @option options [String] :template_body
|
765
764
|
# Structure containing the template body with a minimum length of 1 byte
|
766
765
|
# and a maximum length of 51,200 bytes. (For more information, go to
|
767
|
-
# [Template Anatomy][1] in the
|
766
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
768
767
|
#
|
769
768
|
# Conditional: You must specify only one of the following parameters:
|
770
769
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -776,7 +775,7 @@ module Aws::CloudFormation
|
|
776
775
|
# @option options [String] :template_url
|
777
776
|
# Location of file containing the template body. The URL must point to a
|
778
777
|
# template that is located in an Amazon S3 bucket or a Systems Manager
|
779
|
-
# document. For more information, go to [Template Anatomy][1] in the
|
778
|
+
# document. For more information, go to [Template Anatomy][1] in the
|
780
779
|
# CloudFormation User Guide.
|
781
780
|
#
|
782
781
|
# Conditional: You must specify only one of the following parameters:
|
@@ -822,16 +821,15 @@ module Aws::CloudFormation
|
|
822
821
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html
|
823
822
|
# @option options [Array<String>] :capabilities
|
824
823
|
# In some cases, you must explicitly acknowledge that your stack
|
825
|
-
# template contains certain capabilities in order for
|
826
|
-
#
|
824
|
+
# template contains certain capabilities in order for CloudFormation to
|
825
|
+
# update the stack.
|
827
826
|
#
|
828
827
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
829
828
|
#
|
830
829
|
# Some stack templates might include resources that can affect
|
831
|
-
# permissions in your
|
832
|
-
#
|
833
|
-
#
|
834
|
-
# capabilities.
|
830
|
+
# permissions in your account; for example, by creating new Identity
|
831
|
+
# and Access Management (IAM) users. For those stacks, you must
|
832
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
835
833
|
#
|
836
834
|
# The following IAM resources require you to specify either the
|
837
835
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -841,8 +839,8 @@ module Aws::CloudFormation
|
|
841
839
|
# * If you have IAM resources with custom names, you *must* specify
|
842
840
|
# `CAPABILITY_NAMED_IAM`.
|
843
841
|
#
|
844
|
-
# * If you don't specify either of these capabilities,
|
845
|
-
#
|
842
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
843
|
+
# returns an `InsufficientCapabilities` error.
|
846
844
|
#
|
847
845
|
# If your stack template contains these resources, we recommend that
|
848
846
|
# you review all permissions associated with them and edit their
|
@@ -862,7 +860,7 @@ module Aws::CloudFormation
|
|
862
860
|
#
|
863
861
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
864
862
|
#
|
865
|
-
# For more information, see [Acknowledging IAM Resources in
|
863
|
+
# For more information, see [Acknowledging IAM Resources in
|
866
864
|
# CloudFormation Templates][8].
|
867
865
|
#
|
868
866
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -877,7 +875,7 @@ module Aws::CloudFormation
|
|
877
875
|
# update a stack directly from the processed template, without first
|
878
876
|
# reviewing the resulting changes in a change set, you must
|
879
877
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
880
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
878
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
881
879
|
# CloudFormation.
|
882
880
|
#
|
883
881
|
# If you want to update a stack from a stack template that contains
|
@@ -889,11 +887,11 @@ module Aws::CloudFormation
|
|
889
887
|
#
|
890
888
|
# Each macro relies on an underlying Lambda service function for
|
891
889
|
# processing stack templates. Be aware that the Lambda function owner
|
892
|
-
# can update the function operation without
|
890
|
+
# can update the function operation without CloudFormation being
|
893
891
|
# notified.
|
894
892
|
#
|
895
|
-
# For more information, see [Using
|
896
|
-
#
|
893
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
894
|
+
# Custom Processing on Templates][11].
|
897
895
|
#
|
898
896
|
#
|
899
897
|
#
|
@@ -914,31 +912,30 @@ module Aws::CloudFormation
|
|
914
912
|
# or `Custom::MyCustomInstance`.
|
915
913
|
#
|
916
914
|
# If the list of resource types doesn't include a resource that you're
|
917
|
-
# updating, the stack update fails. By default,
|
918
|
-
#
|
919
|
-
#
|
920
|
-
#
|
921
|
-
#
|
915
|
+
# updating, the stack update fails. By default, CloudFormation grants
|
916
|
+
# permissions to all resource types. Identity and Access Management
|
917
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
918
|
+
# in IAM policies. For more information, see [Controlling Access with
|
919
|
+
# Identity and Access Management][1].
|
922
920
|
#
|
923
921
|
#
|
924
922
|
#
|
925
923
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
926
924
|
# @option options [String] :role_arn
|
927
|
-
# The Amazon Resource Name (ARN) of an
|
928
|
-
#
|
929
|
-
#
|
930
|
-
#
|
931
|
-
#
|
932
|
-
#
|
933
|
-
#
|
934
|
-
#
|
935
|
-
#
|
936
|
-
#
|
937
|
-
# was previously associated with the stack. If no role is available, AWS
|
925
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
926
|
+
# (IAM) role that CloudFormation assumes to update the stack.
|
927
|
+
# CloudFormation uses the role's credentials to make calls on your
|
928
|
+
# behalf. CloudFormation always uses this role for all future operations
|
929
|
+
# on the stack. As long as users have permission to operate on the
|
930
|
+
# stack, CloudFormation uses this role even if the users don't have
|
931
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
932
|
+
#
|
933
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
934
|
+
# previously associated with the stack. If no role is available,
|
938
935
|
# CloudFormation uses a temporary session that is generated from your
|
939
936
|
# user credentials.
|
940
937
|
# @option options [Types::RollbackConfiguration] :rollback_configuration
|
941
|
-
# The rollback triggers for
|
938
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
942
939
|
# creation and updating operations, and for the specified monitoring
|
943
940
|
# period afterwards.
|
944
941
|
# @option options [String] :stack_policy_body
|
@@ -961,21 +958,21 @@ module Aws::CloudFormation
|
|
961
958
|
# stack is unchanged.
|
962
959
|
# @option options [Array<String>] :notification_arns
|
963
960
|
# Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
|
964
|
-
# that
|
965
|
-
#
|
961
|
+
# that CloudFormation associates with the stack. Specify an empty list
|
962
|
+
# to remove all notification topics.
|
966
963
|
# @option options [Array<Types::Tag>] :tags
|
967
|
-
# Key-value pairs to associate with this stack.
|
964
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
968
965
|
# propagates these tags to supported resources in the stack. You can
|
969
966
|
# specify a maximum number of 50 tags.
|
970
967
|
#
|
971
|
-
# If you don't specify this parameter,
|
972
|
-
#
|
973
|
-
#
|
968
|
+
# If you don't specify this parameter, CloudFormation doesn't modify
|
969
|
+
# the stack's tags. If you specify an empty value, CloudFormation
|
970
|
+
# removes all associated tags.
|
974
971
|
# @option options [String] :client_request_token
|
975
972
|
# A unique identifier for this `UpdateStack` request. Specify this token
|
976
|
-
# if you plan to retry requests so that
|
973
|
+
# if you plan to retry requests so that CloudFormation knows that
|
977
974
|
# you're not attempting to update a stack with the same name. You might
|
978
|
-
# retry `UpdateStack` requests to ensure that
|
975
|
+
# retry `UpdateStack` requests to ensure that CloudFormation
|
979
976
|
# successfully received them.
|
980
977
|
#
|
981
978
|
# All events triggered by a given stack operation are assigned the same
|