aws-sdk-cloudformation 1.120.0 → 1.121.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +241 -306
- data/lib/aws-sdk-cloudformation/event.rb +6 -4
- data/lib/aws-sdk-cloudformation/resource.rb +35 -46
- data/lib/aws-sdk-cloudformation/stack.rb +78 -102
- data/lib/aws-sdk-cloudformation/stack_resource.rb +6 -5
- data/lib/aws-sdk-cloudformation/stack_resource_summary.rb +5 -4
- data/lib/aws-sdk-cloudformation/types.rb +312 -407
- data/lib/aws-sdk-cloudformation.rb +1 -1
- metadata +2 -2
@@ -60,8 +60,9 @@ module Aws::CloudFormation
|
|
60
60
|
data[:physical_resource_id]
|
61
61
|
end
|
62
62
|
|
63
|
-
# Type of resource.
|
64
|
-
#
|
63
|
+
# Type of resource. For more information, see [Amazon Web Services
|
64
|
+
# resource and property types reference][1] in the *CloudFormation User
|
65
|
+
# Guide*.
|
65
66
|
#
|
66
67
|
#
|
67
68
|
#
|
@@ -155,8 +156,9 @@ module Aws::CloudFormation
|
|
155
156
|
# the stack event.
|
156
157
|
#
|
157
158
|
# * `CONFIGURATION_COMPLETE` - all of the resources in the stack have
|
158
|
-
# reached that event. For more information, see [
|
159
|
-
#
|
159
|
+
# reached that event. For more information, see [Understand
|
160
|
+
# CloudFormation stack creation events][1] in the *CloudFormation User
|
161
|
+
# Guide*.
|
160
162
|
#
|
161
163
|
# ^
|
162
164
|
# ^
|
@@ -89,28 +89,18 @@ module Aws::CloudFormation
|
|
89
89
|
# </note>
|
90
90
|
# @option options [String] :template_body
|
91
91
|
# Structure containing the template body with a minimum length of 1 byte
|
92
|
-
# and a maximum length of 51,200 bytes.
|
93
|
-
# [Template anatomy][1] in the *CloudFormation User Guide*.
|
92
|
+
# and a maximum length of 51,200 bytes.
|
94
93
|
#
|
95
94
|
# Conditional: You must specify either the `TemplateBody` or the
|
96
95
|
# `TemplateURL` parameter, but not both.
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
101
96
|
# @option options [String] :template_url
|
102
97
|
# Location of file containing the template body. The URL must point to a
|
103
98
|
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
104
|
-
# bucket or a Systems Manager document.
|
105
|
-
#
|
106
|
-
# for an Amazon S3 bucket must start with `https://`.
|
99
|
+
# bucket or a Systems Manager document. The location for an Amazon S3
|
100
|
+
# bucket must start with `https://`.
|
107
101
|
#
|
108
102
|
# Conditional: You must specify either the `TemplateBody` or the
|
109
103
|
# `TemplateURL` parameter, but not both.
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
114
104
|
# @option options [Array<Types::Parameter>] :parameters
|
115
105
|
# A list of `Parameter` structures that specify input parameters for the
|
116
106
|
# stack. For more information, see the [Parameter][1] data type.
|
@@ -133,9 +123,9 @@ module Aws::CloudFormation
|
|
133
123
|
# `CREATE_FAILED`; if `DisableRollback` is not set or is set to `false`,
|
134
124
|
# the stack will be rolled back.
|
135
125
|
# @option options [Array<String>] :notification_arns
|
136
|
-
# The Amazon
|
137
|
-
#
|
138
|
-
#
|
126
|
+
# The Amazon SNS topic ARNs to publish stack related events. You can
|
127
|
+
# find your Amazon SNS topic ARNs using the Amazon SNS console or your
|
128
|
+
# Command Line Interface (CLI).
|
139
129
|
# @option options [Array<String>] :capabilities
|
140
130
|
# In some cases, you must explicitly acknowledge that your stack
|
141
131
|
# template contains certain capabilities in order for CloudFormation to
|
@@ -145,9 +135,8 @@ module Aws::CloudFormation
|
|
145
135
|
#
|
146
136
|
# Some stack templates might include resources that can affect
|
147
137
|
# permissions in your Amazon Web Services account; for example, by
|
148
|
-
# creating new
|
149
|
-
#
|
150
|
-
# these capabilities.
|
138
|
+
# creating new IAM users. For those stacks, you must explicitly
|
139
|
+
# acknowledge this by specifying one of these capabilities.
|
151
140
|
#
|
152
141
|
# The following IAM resources require you to specify either the
|
153
142
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -178,8 +167,8 @@ module Aws::CloudFormation
|
|
178
167
|
#
|
179
168
|
# * [AWS::IAM::UserToGroupAddition][7]
|
180
169
|
#
|
181
|
-
# For more information, see [Acknowledging IAM
|
182
|
-
# CloudFormation
|
170
|
+
# For more information, see [Acknowledging IAM resources in
|
171
|
+
# CloudFormation templates][8].
|
183
172
|
#
|
184
173
|
# * `CAPABILITY_AUTO_EXPAND`
|
185
174
|
#
|
@@ -208,8 +197,8 @@ module Aws::CloudFormation
|
|
208
197
|
# can update the function operation without CloudFormation being
|
209
198
|
# notified.
|
210
199
|
#
|
211
|
-
# For more information, see [
|
212
|
-
#
|
200
|
+
# For more information, see [Perform custom processing on
|
201
|
+
# CloudFormation templates with template macros][11].
|
213
202
|
#
|
214
203
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
215
204
|
# specified.
|
@@ -218,14 +207,14 @@ module Aws::CloudFormation
|
|
218
207
|
#
|
219
208
|
#
|
220
209
|
#
|
221
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
222
|
-
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
210
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html
|
211
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html
|
223
212
|
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
|
224
|
-
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
213
|
+
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html
|
225
214
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
226
|
-
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
227
|
-
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
228
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
215
|
+
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html
|
216
|
+
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html
|
217
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities
|
229
218
|
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
230
219
|
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
231
220
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
@@ -242,10 +231,10 @@ module Aws::CloudFormation
|
|
242
231
|
#
|
243
232
|
# If the list of resource types doesn't include a resource that you're
|
244
233
|
# creating, the stack creation fails. By default, CloudFormation grants
|
245
|
-
# permissions to all resource types.
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
234
|
+
# permissions to all resource types. IAM uses this parameter for
|
235
|
+
# CloudFormation-specific condition keys in IAM policies. For more
|
236
|
+
# information, see [Control access with Identity and Access
|
237
|
+
# Management][1].
|
249
238
|
#
|
250
239
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
251
240
|
# specified.
|
@@ -256,13 +245,13 @@ module Aws::CloudFormation
|
|
256
245
|
#
|
257
246
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
258
247
|
# @option options [String] :role_arn
|
259
|
-
# The Amazon Resource Name (ARN) of an
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
248
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudFormation
|
249
|
+
# assumes to create the stack. CloudFormation uses the role's
|
250
|
+
# credentials to make calls on your behalf. CloudFormation always uses
|
251
|
+
# this role for all future operations on the stack. Provided that users
|
252
|
+
# have permission to operate on the stack, CloudFormation uses this role
|
253
|
+
# even if the users don't have permission to pass it. Ensure that the
|
254
|
+
# role grants least privilege.
|
266
255
|
#
|
267
256
|
# If you don't specify a value, CloudFormation uses the role that was
|
268
257
|
# previously associated with the stack. If no role is available,
|
@@ -275,9 +264,9 @@ module Aws::CloudFormation
|
|
275
264
|
#
|
276
265
|
# Default: `ROLLBACK`
|
277
266
|
# @option options [String] :stack_policy_body
|
278
|
-
# Structure containing the stack policy body. For more information,
|
279
|
-
#
|
280
|
-
#
|
267
|
+
# Structure containing the stack policy body. For more information, see
|
268
|
+
# [Prevent updates to stack resources][1] in the *CloudFormation User
|
269
|
+
# Guide*. You can specify either the `StackPolicyBody` or the
|
281
270
|
# `StackPolicyURL` parameter, but not both.
|
282
271
|
#
|
283
272
|
#
|
@@ -317,9 +306,9 @@ module Aws::CloudFormation
|
|
317
306
|
# Whether to enable termination protection on the specified stack. If a
|
318
307
|
# user attempts to delete a stack with termination protection enabled,
|
319
308
|
# the operation fails and the stack remains unchanged. For more
|
320
|
-
# information, see [
|
321
|
-
# *CloudFormation User Guide*. Termination protection is
|
322
|
-
# stacks by default.
|
309
|
+
# information, see [Protect CloudFormation stacks from being deleted][1]
|
310
|
+
# in the *CloudFormation User Guide*. Termination protection is
|
311
|
+
# deactivated on stacks by default.
|
323
312
|
#
|
324
313
|
# For [nested stacks][2], termination protection is set on the root
|
325
314
|
# stack and can't be changed directly on the nested stack.
|
@@ -133,10 +133,9 @@ module Aws::CloudFormation
|
|
133
133
|
data[:outputs]
|
134
134
|
end
|
135
135
|
|
136
|
-
# The Amazon Resource Name (ARN) of an
|
137
|
-
#
|
138
|
-
#
|
139
|
-
# on your behalf.
|
136
|
+
# The Amazon Resource Name (ARN) of an IAM role that's associated with
|
137
|
+
# the stack. During a stack operation, CloudFormation uses this role's
|
138
|
+
# credentials to make calls on your behalf.
|
140
139
|
# @return [String]
|
141
140
|
def role_arn
|
142
141
|
data[:role_arn]
|
@@ -152,8 +151,8 @@ module Aws::CloudFormation
|
|
152
151
|
#
|
153
152
|
# For [nested stacks][1], termination protection is set on the root
|
154
153
|
# stack and can't be changed directly on the nested stack. For more
|
155
|
-
# information, see [
|
156
|
-
# *CloudFormation User Guide*.
|
154
|
+
# information, see [Protect a CloudFormation stack from being
|
155
|
+
# deleted][2] in the *CloudFormation User Guide*.
|
157
156
|
#
|
158
157
|
#
|
159
158
|
#
|
@@ -168,8 +167,8 @@ module Aws::CloudFormation
|
|
168
167
|
# stack ID of the direct parent of this stack. For the first level of
|
169
168
|
# nested stacks, the root stack is also the parent stack.
|
170
169
|
#
|
171
|
-
# For more information, see [
|
172
|
-
# *CloudFormation User Guide*.
|
170
|
+
# For more information, see [Embed stacks within other stacks using
|
171
|
+
# nested stacks][1] in the *CloudFormation User Guide*.
|
173
172
|
#
|
174
173
|
#
|
175
174
|
#
|
@@ -183,8 +182,8 @@ module Aws::CloudFormation
|
|
183
182
|
# stack ID of the top-level stack to which the nested stack ultimately
|
184
183
|
# belongs.
|
185
184
|
#
|
186
|
-
# For more information, see [
|
187
|
-
# *CloudFormation User Guide*.
|
185
|
+
# For more information, see [Embed stacks within other stacks using
|
186
|
+
# nested stacks][1] in the *CloudFormation User Guide*.
|
188
187
|
#
|
189
188
|
#
|
190
189
|
#
|
@@ -197,8 +196,8 @@ module Aws::CloudFormation
|
|
197
196
|
# Information about whether a stack's actual configuration differs, or
|
198
197
|
# has *drifted*, from its expected configuration, as defined in the
|
199
198
|
# stack template and any values specified as template parameters. For
|
200
|
-
# more information, see [
|
201
|
-
#
|
199
|
+
# more information, see [Detect unmanaged configuration changes to
|
200
|
+
# stacks and resources with drift detection][1].
|
202
201
|
#
|
203
202
|
#
|
204
203
|
#
|
@@ -235,8 +234,8 @@ module Aws::CloudFormation
|
|
235
234
|
# configuration phase has completed and the stabilization of the
|
236
235
|
# resources is in progress. The stack sets `CONFIGURATION_COMPLETE` when
|
237
236
|
# all of the resources in the stack have reached that event. For more
|
238
|
-
# information, see [CloudFormation stack
|
239
|
-
# *CloudFormation User Guide*.
|
237
|
+
# information, see [Understand CloudFormation stack creation events][1]
|
238
|
+
# in the *CloudFormation User Guide*.
|
240
239
|
#
|
241
240
|
#
|
242
241
|
#
|
@@ -482,28 +481,18 @@ module Aws::CloudFormation
|
|
482
481
|
# @param [Hash] options ({})
|
483
482
|
# @option options [String] :template_body
|
484
483
|
# Structure containing the template body with a minimum length of 1 byte
|
485
|
-
# and a maximum length of 51,200 bytes.
|
486
|
-
# [Template anatomy][1] in the *CloudFormation User Guide*.
|
484
|
+
# and a maximum length of 51,200 bytes.
|
487
485
|
#
|
488
486
|
# Conditional: You must specify either the `TemplateBody` or the
|
489
487
|
# `TemplateURL` parameter, but not both.
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
494
488
|
# @option options [String] :template_url
|
495
489
|
# Location of file containing the template body. The URL must point to a
|
496
490
|
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
497
|
-
# bucket or a Systems Manager document.
|
498
|
-
#
|
499
|
-
# for an Amazon S3 bucket must start with `https://`.
|
491
|
+
# bucket or a Systems Manager document. The location for an Amazon S3
|
492
|
+
# bucket must start with `https://`.
|
500
493
|
#
|
501
494
|
# Conditional: You must specify either the `TemplateBody` or the
|
502
495
|
# `TemplateURL` parameter, but not both.
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
507
496
|
# @option options [Array<Types::Parameter>] :parameters
|
508
497
|
# A list of `Parameter` structures that specify input parameters for the
|
509
498
|
# stack. For more information, see the [Parameter][1] data type.
|
@@ -526,9 +515,9 @@ module Aws::CloudFormation
|
|
526
515
|
# `CREATE_FAILED`; if `DisableRollback` is not set or is set to `false`,
|
527
516
|
# the stack will be rolled back.
|
528
517
|
# @option options [Array<String>] :notification_arns
|
529
|
-
# The Amazon
|
530
|
-
#
|
531
|
-
#
|
518
|
+
# The Amazon SNS topic ARNs to publish stack related events. You can
|
519
|
+
# find your Amazon SNS topic ARNs using the Amazon SNS console or your
|
520
|
+
# Command Line Interface (CLI).
|
532
521
|
# @option options [Array<String>] :capabilities
|
533
522
|
# In some cases, you must explicitly acknowledge that your stack
|
534
523
|
# template contains certain capabilities in order for CloudFormation to
|
@@ -538,9 +527,8 @@ module Aws::CloudFormation
|
|
538
527
|
#
|
539
528
|
# Some stack templates might include resources that can affect
|
540
529
|
# permissions in your Amazon Web Services account; for example, by
|
541
|
-
# creating new
|
542
|
-
#
|
543
|
-
# these capabilities.
|
530
|
+
# creating new IAM users. For those stacks, you must explicitly
|
531
|
+
# acknowledge this by specifying one of these capabilities.
|
544
532
|
#
|
545
533
|
# The following IAM resources require you to specify either the
|
546
534
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -571,8 +559,8 @@ module Aws::CloudFormation
|
|
571
559
|
#
|
572
560
|
# * [AWS::IAM::UserToGroupAddition][7]
|
573
561
|
#
|
574
|
-
# For more information, see [Acknowledging IAM
|
575
|
-
# CloudFormation
|
562
|
+
# For more information, see [Acknowledging IAM resources in
|
563
|
+
# CloudFormation templates][8].
|
576
564
|
#
|
577
565
|
# * `CAPABILITY_AUTO_EXPAND`
|
578
566
|
#
|
@@ -601,8 +589,8 @@ module Aws::CloudFormation
|
|
601
589
|
# can update the function operation without CloudFormation being
|
602
590
|
# notified.
|
603
591
|
#
|
604
|
-
# For more information, see [
|
605
|
-
#
|
592
|
+
# For more information, see [Perform custom processing on
|
593
|
+
# CloudFormation templates with template macros][11].
|
606
594
|
#
|
607
595
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
608
596
|
# specified.
|
@@ -611,14 +599,14 @@ module Aws::CloudFormation
|
|
611
599
|
#
|
612
600
|
#
|
613
601
|
#
|
614
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
615
|
-
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
602
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html
|
603
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html
|
616
604
|
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
|
617
|
-
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
605
|
+
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html
|
618
606
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
619
|
-
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
620
|
-
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
621
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
607
|
+
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html
|
608
|
+
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html
|
609
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities
|
622
610
|
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
623
611
|
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
624
612
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
@@ -635,10 +623,10 @@ module Aws::CloudFormation
|
|
635
623
|
#
|
636
624
|
# If the list of resource types doesn't include a resource that you're
|
637
625
|
# creating, the stack creation fails. By default, CloudFormation grants
|
638
|
-
# permissions to all resource types.
|
639
|
-
#
|
640
|
-
#
|
641
|
-
#
|
626
|
+
# permissions to all resource types. IAM uses this parameter for
|
627
|
+
# CloudFormation-specific condition keys in IAM policies. For more
|
628
|
+
# information, see [Control access with Identity and Access
|
629
|
+
# Management][1].
|
642
630
|
#
|
643
631
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
644
632
|
# specified.
|
@@ -649,13 +637,13 @@ module Aws::CloudFormation
|
|
649
637
|
#
|
650
638
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
651
639
|
# @option options [String] :role_arn
|
652
|
-
# The Amazon Resource Name (ARN) of an
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
640
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudFormation
|
641
|
+
# assumes to create the stack. CloudFormation uses the role's
|
642
|
+
# credentials to make calls on your behalf. CloudFormation always uses
|
643
|
+
# this role for all future operations on the stack. Provided that users
|
644
|
+
# have permission to operate on the stack, CloudFormation uses this role
|
645
|
+
# even if the users don't have permission to pass it. Ensure that the
|
646
|
+
# role grants least privilege.
|
659
647
|
#
|
660
648
|
# If you don't specify a value, CloudFormation uses the role that was
|
661
649
|
# previously associated with the stack. If no role is available,
|
@@ -668,9 +656,9 @@ module Aws::CloudFormation
|
|
668
656
|
#
|
669
657
|
# Default: `ROLLBACK`
|
670
658
|
# @option options [String] :stack_policy_body
|
671
|
-
# Structure containing the stack policy body. For more information,
|
672
|
-
#
|
673
|
-
#
|
659
|
+
# Structure containing the stack policy body. For more information, see
|
660
|
+
# [Prevent updates to stack resources][1] in the *CloudFormation User
|
661
|
+
# Guide*. You can specify either the `StackPolicyBody` or the
|
674
662
|
# `StackPolicyURL` parameter, but not both.
|
675
663
|
#
|
676
664
|
#
|
@@ -710,9 +698,9 @@ module Aws::CloudFormation
|
|
710
698
|
# Whether to enable termination protection on the specified stack. If a
|
711
699
|
# user attempts to delete a stack with termination protection enabled,
|
712
700
|
# the operation fails and the stack remains unchanged. For more
|
713
|
-
# information, see [
|
714
|
-
# *CloudFormation User Guide*. Termination protection is
|
715
|
-
# stacks by default.
|
701
|
+
# information, see [Protect CloudFormation stacks from being deleted][1]
|
702
|
+
# in the *CloudFormation User Guide*. Termination protection is
|
703
|
+
# deactivated on stacks by default.
|
716
704
|
#
|
717
705
|
# For [nested stacks][2], termination protection is set on the root
|
718
706
|
# stack and can't be changed directly on the nested stack.
|
@@ -754,10 +742,9 @@ module Aws::CloudFormation
|
|
754
742
|
# Retaining resources is useful when you can't delete a resource, such
|
755
743
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
756
744
|
# @option options [String] :role_arn
|
757
|
-
# The Amazon Resource Name (ARN) of an
|
758
|
-
#
|
759
|
-
#
|
760
|
-
# behalf.
|
745
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudFormation
|
746
|
+
# assumes to delete the stack. CloudFormation uses the role's
|
747
|
+
# credentials to make calls on your behalf.
|
761
748
|
#
|
762
749
|
# If you don't specify a value, CloudFormation uses the role that was
|
763
750
|
# previously associated with the stack. If no role is available,
|
@@ -844,30 +831,20 @@ module Aws::CloudFormation
|
|
844
831
|
# @param [Hash] options ({})
|
845
832
|
# @option options [String] :template_body
|
846
833
|
# Structure containing the template body with a minimum length of 1 byte
|
847
|
-
# and a maximum length of 51,200 bytes.
|
848
|
-
# [Template Anatomy][1] in the *CloudFormation User Guide*.)
|
834
|
+
# and a maximum length of 51,200 bytes.
|
849
835
|
#
|
850
836
|
# Conditional: You must specify only one of the following parameters:
|
851
837
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
852
838
|
# `true`.
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
857
839
|
# @option options [String] :template_url
|
858
840
|
# Location of file containing the template body. The URL must point to a
|
859
841
|
# template that's located in an Amazon S3 bucket or a Systems Manager
|
860
|
-
# document.
|
861
|
-
#
|
862
|
-
# start with `https://`.
|
842
|
+
# document. The location for an Amazon S3 bucket must start with
|
843
|
+
# `https://`.
|
863
844
|
#
|
864
845
|
# Conditional: You must specify only one of the following parameters:
|
865
846
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
866
847
|
# `true`.
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
871
848
|
# @option options [Boolean] :use_previous_template
|
872
849
|
# Reuse the existing template that is associated with the stack that you
|
873
850
|
# are updating.
|
@@ -911,10 +888,9 @@ module Aws::CloudFormation
|
|
911
888
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
912
889
|
#
|
913
890
|
# Some stack templates might include resources that can affect
|
914
|
-
# permissions in your Amazon Web Services account
|
915
|
-
# creating new
|
916
|
-
#
|
917
|
-
# these capabilities.
|
891
|
+
# permissions in your Amazon Web Services account, for example, by
|
892
|
+
# creating new IAM users. For those stacks, you must explicitly
|
893
|
+
# acknowledge this by specifying one of these capabilities.
|
918
894
|
#
|
919
895
|
# The following IAM resources require you to specify either the
|
920
896
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -945,8 +921,8 @@ module Aws::CloudFormation
|
|
945
921
|
#
|
946
922
|
# * [AWS::IAM::UserToGroupAddition][7]
|
947
923
|
#
|
948
|
-
# For more information, see [Acknowledging IAM
|
949
|
-
# CloudFormation
|
924
|
+
# For more information, see [Acknowledging IAM resources in
|
925
|
+
# CloudFormation templates][8].
|
950
926
|
#
|
951
927
|
# * `CAPABILITY_AUTO_EXPAND`
|
952
928
|
#
|
@@ -975,8 +951,8 @@ module Aws::CloudFormation
|
|
975
951
|
# can update the function operation without CloudFormation being
|
976
952
|
# notified.
|
977
953
|
#
|
978
|
-
# For more information, see [
|
979
|
-
#
|
954
|
+
# For more information, see [Perform custom processing on
|
955
|
+
# CloudFormation templates with template macros][11].
|
980
956
|
#
|
981
957
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
982
958
|
# specified.
|
@@ -985,14 +961,14 @@ module Aws::CloudFormation
|
|
985
961
|
#
|
986
962
|
#
|
987
963
|
#
|
988
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
989
|
-
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
964
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html
|
965
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html
|
990
966
|
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
|
991
|
-
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
967
|
+
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html
|
992
968
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
993
|
-
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
994
|
-
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-
|
995
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
969
|
+
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html
|
970
|
+
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html
|
971
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities
|
996
972
|
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
997
973
|
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
998
974
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
@@ -1003,10 +979,10 @@ module Aws::CloudFormation
|
|
1003
979
|
#
|
1004
980
|
# If the list of resource types doesn't include a resource that you're
|
1005
981
|
# updating, the stack update fails. By default, CloudFormation grants
|
1006
|
-
# permissions to all resource types.
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
#
|
982
|
+
# permissions to all resource types. IAM uses this parameter for
|
983
|
+
# CloudFormation-specific condition keys in IAM policies. For more
|
984
|
+
# information, see [Control access with Identity and Access
|
985
|
+
# Management][1].
|
1010
986
|
#
|
1011
987
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
1012
988
|
# specified.
|
@@ -1017,13 +993,13 @@ module Aws::CloudFormation
|
|
1017
993
|
#
|
1018
994
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
1019
995
|
# @option options [String] :role_arn
|
1020
|
-
# The Amazon Resource Name (ARN) of an
|
1021
|
-
#
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
#
|
996
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudFormation
|
997
|
+
# assumes to update the stack. CloudFormation uses the role's
|
998
|
+
# credentials to make calls on your behalf. CloudFormation always uses
|
999
|
+
# this role for all future operations on the stack. Provided that users
|
1000
|
+
# have permission to operate on the stack, CloudFormation uses this role
|
1001
|
+
# even if the users don't have permission to pass it. Ensure that the
|
1002
|
+
# role grants least privilege.
|
1027
1003
|
#
|
1028
1004
|
# If you don't specify a value, CloudFormation uses the role that was
|
1029
1005
|
# previously associated with the stack. If no role is available,
|
@@ -56,8 +56,9 @@ module Aws::CloudFormation
|
|
56
56
|
data[:physical_resource_id]
|
57
57
|
end
|
58
58
|
|
59
|
-
# Type of resource. For more information,
|
60
|
-
#
|
59
|
+
# Type of resource. For more information, see [Amazon Web Services
|
60
|
+
# resource and property types reference][1] in the *CloudFormation User
|
61
|
+
# Guide*.
|
61
62
|
#
|
62
63
|
#
|
63
64
|
#
|
@@ -92,7 +93,7 @@ module Aws::CloudFormation
|
|
92
93
|
end
|
93
94
|
|
94
95
|
# The content of the `Metadata` attribute declared for the resource. For
|
95
|
-
# more information, see [Metadata
|
96
|
+
# more information, see [Metadata attribute][1] in the *CloudFormation
|
96
97
|
# User Guide*.
|
97
98
|
#
|
98
99
|
#
|
@@ -106,8 +107,8 @@ module Aws::CloudFormation
|
|
106
107
|
# Information about whether the resource's actual configuration
|
107
108
|
# differs, or has *drifted*, from its expected configuration, as defined
|
108
109
|
# in the stack template and any values specified as template parameters.
|
109
|
-
# For more information, see [
|
110
|
-
#
|
110
|
+
# For more information, see [Detect unmanaged configuration changes to
|
111
|
+
# stacks and resources with drift detection][1].
|
111
112
|
#
|
112
113
|
#
|
113
114
|
#
|
@@ -50,8 +50,9 @@ module Aws::CloudFormation
|
|
50
50
|
data[:physical_resource_id]
|
51
51
|
end
|
52
52
|
|
53
|
-
# Type of resource. (For more information,
|
54
|
-
#
|
53
|
+
# Type of resource. (For more information, see [Amazon Web Services
|
54
|
+
# resource and property types reference][1] in the *CloudFormation User
|
55
|
+
# Guide*.)
|
55
56
|
#
|
56
57
|
#
|
57
58
|
#
|
@@ -82,8 +83,8 @@ module Aws::CloudFormation
|
|
82
83
|
# Information about whether the resource's actual configuration
|
83
84
|
# differs, or has *drifted*, from its expected configuration, as defined
|
84
85
|
# in the stack template and any values specified as template parameters.
|
85
|
-
# For more information, see [
|
86
|
-
#
|
86
|
+
# For more information, see [Detect unmanaged configuration changes to
|
87
|
+
# stacks and resources with drift detection][1].
|
87
88
|
#
|
88
89
|
#
|
89
90
|
#
|