aws-sdk-cloudformation 1.99.0 → 1.101.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +137 -119
- data/lib/aws-sdk-cloudformation/client_api.rb +3 -0
- data/lib/aws-sdk-cloudformation/event.rb +25 -1
- data/lib/aws-sdk-cloudformation/resource.rb +15 -13
- data/lib/aws-sdk-cloudformation/stack.rb +48 -27
- data/lib/aws-sdk-cloudformation/stack_resource.rb +3 -3
- data/lib/aws-sdk-cloudformation/stack_resource_summary.rb +1 -1
- data/lib/aws-sdk-cloudformation/types.rb +224 -164
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/event.rbs +3 -0
- data/sig/stack.rbs +3 -0
- data/sig/types.rbs +3 -1
- metadata +2 -2
@@ -408,7 +408,7 @@ module Aws::CloudFormation
|
|
408
408
|
# extensions][1] in the *CloudFormation User Guide*.
|
409
409
|
#
|
410
410
|
# Once you have activated a public third-party extension in your account
|
411
|
-
# and Region, use [SetTypeConfiguration][2] to specify configuration
|
411
|
+
# and Region, use [ `SetTypeConfiguration` ][2] to specify configuration
|
412
412
|
# properties for the extension. For more information, see [Configuring
|
413
413
|
# extensions at the account level][3] in the *CloudFormation User
|
414
414
|
# Guide*.
|
@@ -802,7 +802,8 @@ module Aws::CloudFormation
|
|
802
802
|
# must point to a template (max size: 460,800 bytes) that's located in
|
803
803
|
# an Amazon S3 bucket or a Systems Manager document. CloudFormation
|
804
804
|
# generates the change set by comparing this template with the stack
|
805
|
-
# that you specified.
|
805
|
+
# that you specified. The location for an Amazon S3 bucket must start
|
806
|
+
# with `https://`.
|
806
807
|
#
|
807
808
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
808
809
|
#
|
@@ -842,19 +843,19 @@ module Aws::CloudFormation
|
|
842
843
|
# review all permissions associated with them and edit their
|
843
844
|
# permissions if necessary.
|
844
845
|
#
|
845
|
-
# * [ AWS::IAM::AccessKey][1]
|
846
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
846
847
|
#
|
847
|
-
# * [ AWS::IAM::Group][2]
|
848
|
+
# * [ `AWS::IAM::Group` ][2]
|
848
849
|
#
|
849
|
-
# * [AWS::IAM::InstanceProfile][3]
|
850
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
850
851
|
#
|
851
|
-
# * [ AWS::IAM::Policy][4]
|
852
|
+
# * [ `AWS::IAM::Policy` ][4]
|
852
853
|
#
|
853
|
-
# * [ AWS::IAM::Role][5]
|
854
|
+
# * [ `AWS::IAM::Role` ][5]
|
854
855
|
#
|
855
|
-
# * [ AWS::IAM::User][6]
|
856
|
+
# * [ `AWS::IAM::User` ][6]
|
856
857
|
#
|
857
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
858
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
858
859
|
#
|
859
860
|
# For more information, see [Acknowledging IAM resources in
|
860
861
|
# CloudFormation templates][8].
|
@@ -870,8 +871,8 @@ module Aws::CloudFormation
|
|
870
871
|
# your stack template contains one or more macros, and you choose to
|
871
872
|
# create a stack directly from the processed template, without first
|
872
873
|
# reviewing the resulting changes in a change set, you must
|
873
|
-
# acknowledge this capability. This includes the [AWS::Include][9]
|
874
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
874
|
+
# acknowledge this capability. This includes the [ `AWS::Include` ][9]
|
875
|
+
# and [ `AWS::Serverless` ][10] transforms, which are macros hosted by
|
875
876
|
# CloudFormation.
|
876
877
|
#
|
877
878
|
# <note markdown="1"> This capacity doesn't apply to creating change sets, and specifying
|
@@ -1004,8 +1005,8 @@ module Aws::CloudFormation
|
|
1004
1005
|
#
|
1005
1006
|
# @option params [String] :on_stack_failure
|
1006
1007
|
# Determines what action will be taken if stack creation fails. If this
|
1007
|
-
# parameter is specified, the `DisableRollback` parameter to the
|
1008
|
-
#
|
1008
|
+
# parameter is specified, the `DisableRollback` parameter to the [
|
1009
|
+
# `ExecuteChangeSet` ][1] API operation must not be specified. This must
|
1009
1010
|
# be one of these values:
|
1010
1011
|
#
|
1011
1012
|
# * `DELETE` - Deletes the change set if the stack creation fails. This
|
@@ -1015,11 +1016,11 @@ module Aws::CloudFormation
|
|
1015
1016
|
#
|
1016
1017
|
# * `DO_NOTHING` - if the stack creation fails, do nothing. This is
|
1017
1018
|
# equivalent to specifying `true` for the `DisableRollback` parameter
|
1018
|
-
# to the [ExecuteChangeSet][1] API operation.
|
1019
|
+
# to the [ `ExecuteChangeSet` ][1] API operation.
|
1019
1020
|
#
|
1020
1021
|
# * `ROLLBACK` - if the stack creation fails, roll back the stack. This
|
1021
1022
|
# is equivalent to specifying `false` for the `DisableRollback`
|
1022
|
-
# parameter to the [ExecuteChangeSet][1] API operation.
|
1023
|
+
# parameter to the [ `ExecuteChangeSet` ][1] API operation.
|
1023
1024
|
#
|
1024
1025
|
# For nested stacks, when the `OnStackFailure` parameter is set to
|
1025
1026
|
# `DELETE` for the change set for the parent stack, any failure in a
|
@@ -1236,7 +1237,8 @@ module Aws::CloudFormation
|
|
1236
1237
|
# Location of file containing the template body. The URL must point to a
|
1237
1238
|
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
1238
1239
|
# bucket or a Systems Manager document. For more information, go to the
|
1239
|
-
# [Template anatomy][1] in the *CloudFormation User Guide*.
|
1240
|
+
# [Template anatomy][1] in the *CloudFormation User Guide*. The location
|
1241
|
+
# for an Amazon S3 bucket must start with `https://`.
|
1240
1242
|
#
|
1241
1243
|
# Conditional: You must specify either the `TemplateBody` or the
|
1242
1244
|
# `TemplateURL` parameter, but not both.
|
@@ -1247,7 +1249,7 @@ module Aws::CloudFormation
|
|
1247
1249
|
#
|
1248
1250
|
# @option params [Array<Types::Parameter>] :parameters
|
1249
1251
|
# A list of `Parameter` structures that specify input parameters for the
|
1250
|
-
# stack. For more information, see the [Parameter][1] data type.
|
1252
|
+
# stack. For more information, see the [ `Parameter` ][1] data type.
|
1251
1253
|
#
|
1252
1254
|
#
|
1253
1255
|
#
|
@@ -1303,19 +1305,19 @@ module Aws::CloudFormation
|
|
1303
1305
|
# you review all permissions associated with them and edit their
|
1304
1306
|
# permissions if necessary.
|
1305
1307
|
#
|
1306
|
-
# * [ AWS::IAM::AccessKey][1]
|
1308
|
+
# * [ `AWS::IAM::AccessKey` AWS::IAM::AccessKey][1]
|
1307
1309
|
#
|
1308
|
-
# * [ AWS::IAM::Group][2]
|
1310
|
+
# * [ `AWS::IAM::Group` ][2]
|
1309
1311
|
#
|
1310
|
-
# * [AWS::IAM::InstanceProfile][3]
|
1312
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
1311
1313
|
#
|
1312
|
-
# * [ AWS::IAM::Policy][4]
|
1314
|
+
# * [ `AWS::IAM::Policy` ][4]
|
1313
1315
|
#
|
1314
|
-
# * [ AWS::IAM::Role][5]
|
1316
|
+
# * [ `AWS::IAM::Role` ][5]
|
1315
1317
|
#
|
1316
|
-
# * [ AWS::IAM::User][6]
|
1318
|
+
# * [ `AWS::IAM::User` ][6]
|
1317
1319
|
#
|
1318
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
1320
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
1319
1321
|
#
|
1320
1322
|
# For more information, see [Acknowledging IAM Resources in
|
1321
1323
|
# CloudFormation Templates][8].
|
@@ -1331,8 +1333,8 @@ module Aws::CloudFormation
|
|
1331
1333
|
# your stack template contains one or more macros, and you choose to
|
1332
1334
|
# create a stack directly from the processed template, without first
|
1333
1335
|
# reviewing the resulting changes in a change set, you must
|
1334
|
-
# acknowledge this capability. This includes the [AWS::Include][9]
|
1335
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
1336
|
+
# acknowledge this capability. This includes the [ `AWS::Include` ][9]
|
1337
|
+
# and [ `AWS::Serverless` ][10] transforms, which are macros hosted by
|
1336
1338
|
# CloudFormation.
|
1337
1339
|
#
|
1338
1340
|
# If you want to create a stack from a stack template that contains
|
@@ -1430,8 +1432,9 @@ module Aws::CloudFormation
|
|
1430
1432
|
# @option params [String] :stack_policy_url
|
1431
1433
|
# Location of a file containing the stack policy. The URL must point to
|
1432
1434
|
# a policy (maximum size: 16 KB) located in an S3 bucket in the same
|
1433
|
-
# Region as the stack.
|
1434
|
-
# the `
|
1435
|
+
# Region as the stack. The location for an Amazon S3 bucket must start
|
1436
|
+
# with `https://`. You can specify either the `StackPolicyBody` or the
|
1437
|
+
# `StackPolicyURL` parameter, but not both.
|
1435
1438
|
#
|
1436
1439
|
# @option params [Array<Types::Tag>] :tags
|
1437
1440
|
# Key-value pairs to associate with this stack. CloudFormation also
|
@@ -1598,8 +1601,8 @@ module Aws::CloudFormation
|
|
1598
1601
|
# instance aren't updated, but retain their overridden value.
|
1599
1602
|
#
|
1600
1603
|
# You can only override the parameter *values* that are specified in the
|
1601
|
-
# stack set; to add or delete a parameter itself, use
|
1602
|
-
#
|
1604
|
+
# stack set; to add or delete a parameter itself, use [ `UpdateStackSet`
|
1605
|
+
# ][1] to update the stack set template.
|
1603
1606
|
#
|
1604
1607
|
#
|
1605
1608
|
#
|
@@ -1717,7 +1720,7 @@ module Aws::CloudFormation
|
|
1717
1720
|
# @option params [String] :template_body
|
1718
1721
|
# The structure that contains the template body, with a minimum length
|
1719
1722
|
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
1720
|
-
# see [Template Anatomy][1] in the CloudFormation User Guide
|
1723
|
+
# see [Template Anatomy][1] in the *CloudFormation User Guide*.
|
1721
1724
|
#
|
1722
1725
|
# Conditional: You must specify either the TemplateBody or the
|
1723
1726
|
# TemplateURL parameter, but not both.
|
@@ -1730,8 +1733,8 @@ module Aws::CloudFormation
|
|
1730
1733
|
# The location of the file that contains the template body. The URL must
|
1731
1734
|
# point to a template (maximum size: 460,800 bytes) that's located in
|
1732
1735
|
# an Amazon S3 bucket or a Systems Manager document. For more
|
1733
|
-
# information, see [Template Anatomy][1] in the CloudFormation User
|
1734
|
-
# Guide
|
1736
|
+
# information, see [Template Anatomy][1] in the *CloudFormation User
|
1737
|
+
# Guide*.
|
1735
1738
|
#
|
1736
1739
|
# Conditional: You must specify either the TemplateBody or the
|
1737
1740
|
# TemplateURL parameter, but not both.
|
@@ -1775,19 +1778,19 @@ module Aws::CloudFormation
|
|
1775
1778
|
# you review all permissions associated with them and edit their
|
1776
1779
|
# permissions if necessary.
|
1777
1780
|
#
|
1778
|
-
# * [ AWS::IAM::AccessKey][1]
|
1781
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
1779
1782
|
#
|
1780
|
-
# * [ AWS::IAM::Group][2]
|
1783
|
+
# * [ `AWS::IAM::Group` ][2]
|
1781
1784
|
#
|
1782
|
-
# * [AWS::IAM::InstanceProfile][3]
|
1785
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
1783
1786
|
#
|
1784
|
-
# * [ AWS::IAM::Policy][4]
|
1787
|
+
# * [ `AWS::IAM::Policy` ][4]
|
1785
1788
|
#
|
1786
|
-
# * [ AWS::IAM::Role][5]
|
1789
|
+
# * [ `AWS::IAM::Role` ][5]
|
1787
1790
|
#
|
1788
|
-
# * [ AWS::IAM::User][6]
|
1791
|
+
# * [ `AWS::IAM::User` ][6]
|
1789
1792
|
#
|
1790
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
1793
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
1791
1794
|
#
|
1792
1795
|
# For more information, see [Acknowledging IAM Resources in
|
1793
1796
|
# CloudFormation Templates][8].
|
@@ -1803,12 +1806,11 @@ module Aws::CloudFormation
|
|
1803
1806
|
# Templates][9].
|
1804
1807
|
#
|
1805
1808
|
# Stack sets with service-managed permissions don't currently support
|
1806
|
-
# the use of macros in templates. (This includes the
|
1807
|
-
#
|
1808
|
-
#
|
1809
|
-
#
|
1810
|
-
#
|
1811
|
-
# fail.
|
1809
|
+
# the use of macros in templates. (This includes the [ `AWS::Include`
|
1810
|
+
# ][10] and [ `AWS::Serverless` ][11] transforms, which are macros
|
1811
|
+
# hosted by CloudFormation.) Even if you specify this capability for a
|
1812
|
+
# stack set with service-managed permissions, if you reference a macro
|
1813
|
+
# in your template the stack set operation will fail.
|
1812
1814
|
#
|
1813
1815
|
#
|
1814
1816
|
#
|
@@ -2361,7 +2363,7 @@ module Aws::CloudFormation
|
|
2361
2363
|
# deregistered as well and marked as deprecated.
|
2362
2364
|
#
|
2363
2365
|
# To view the deprecation status of an extension or extension version,
|
2364
|
-
# use [DescribeType][1].
|
2366
|
+
# use [ `DescribeType` ][1].
|
2365
2367
|
#
|
2366
2368
|
#
|
2367
2369
|
#
|
@@ -2792,7 +2794,7 @@ module Aws::CloudFormation
|
|
2792
2794
|
#
|
2793
2795
|
# For more information about registering as a publisher, see:
|
2794
2796
|
#
|
2795
|
-
# * [RegisterPublisher][1]
|
2797
|
+
# * [ `RegisterPublisher` ][1]
|
2796
2798
|
#
|
2797
2799
|
# * [Publishing extensions to make them available for public use][2] in
|
2798
2800
|
# the *CloudFormation CLI User Guide*
|
@@ -3043,7 +3045,8 @@ module Aws::CloudFormation
|
|
3043
3045
|
|
3044
3046
|
# Returns all stack related events for a specified stack in reverse
|
3045
3047
|
# chronological order. For more information about a stack's event
|
3046
|
-
# history,
|
3048
|
+
# history, see [CloudFormation stack creation events][1] in the
|
3049
|
+
# *CloudFormation User Guide*.
|
3047
3050
|
#
|
3048
3051
|
# <note markdown="1"> You can list events for stacks that have failed to create or have been
|
3049
3052
|
# deleted by specifying the unique stack identifier (stack ID).
|
@@ -3052,7 +3055,7 @@ module Aws::CloudFormation
|
|
3052
3055
|
#
|
3053
3056
|
#
|
3054
3057
|
#
|
3055
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
3058
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
3056
3059
|
#
|
3057
3060
|
# @option params [String] :stack_name
|
3058
3061
|
# The name or the unique stack ID that's associated with the stack,
|
@@ -3102,6 +3105,7 @@ module Aws::CloudFormation
|
|
3102
3105
|
# resp.stack_events[0].hook_status_reason #=> String
|
3103
3106
|
# resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
|
3104
3107
|
# resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
|
3108
|
+
# resp.stack_events[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
|
3105
3109
|
# resp.next_token #=> String
|
3106
3110
|
#
|
3107
3111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
|
@@ -3177,7 +3181,7 @@ module Aws::CloudFormation
|
|
3177
3181
|
# resp.stack_instance.parameter_overrides[0].use_previous_value #=> Boolean
|
3178
3182
|
# resp.stack_instance.parameter_overrides[0].resolved_value #=> String
|
3179
3183
|
# resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
|
3180
|
-
# resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT"
|
3184
|
+
# resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT", "FAILED_IMPORT"
|
3181
3185
|
# resp.stack_instance.status_reason #=> String
|
3182
3186
|
# resp.stack_instance.organizational_unit_id #=> String
|
3183
3187
|
# resp.stack_instance.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
@@ -3622,11 +3626,18 @@ module Aws::CloudFormation
|
|
3622
3626
|
|
3623
3627
|
# Returns the description for the specified stack; if no stack name was
|
3624
3628
|
# specified, then it returns the description for all the stacks created.
|
3629
|
+
# For more information about a stack's event history, see
|
3630
|
+
# [CloudFormation stack creation events][1] in the *CloudFormation User
|
3631
|
+
# Guide*.
|
3625
3632
|
#
|
3626
3633
|
# <note markdown="1"> If the stack doesn't exist, a `ValidationError` is returned.
|
3627
3634
|
#
|
3628
3635
|
# </note>
|
3629
3636
|
#
|
3637
|
+
#
|
3638
|
+
#
|
3639
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
3640
|
+
#
|
3630
3641
|
# @option params [String] :stack_name
|
3631
3642
|
# <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
|
3632
3643
|
# response that describes all resources in the account, which can impact
|
@@ -3717,6 +3728,7 @@ module Aws::CloudFormation
|
|
3717
3728
|
# resp.stacks[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
3718
3729
|
# resp.stacks[0].drift_information.last_check_timestamp #=> Time
|
3719
3730
|
# resp.stacks[0].retain_except_on_create #=> Boolean
|
3731
|
+
# resp.stacks[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
|
3720
3732
|
# resp.next_token #=> String
|
3721
3733
|
#
|
3722
3734
|
#
|
@@ -4188,7 +4200,8 @@ module Aws::CloudFormation
|
|
4188
4200
|
# Location of file containing the template body. The URL must point to a
|
4189
4201
|
# template that's located in an Amazon S3 bucket or a Systems Manager
|
4190
4202
|
# document. For more information, go to [Template Anatomy][1] in the
|
4191
|
-
# *CloudFormation User Guide*.
|
4203
|
+
# *CloudFormation User Guide*. The location for an Amazon S3 bucket must
|
4204
|
+
# start with `https://`.
|
4192
4205
|
#
|
4193
4206
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
4194
4207
|
# are passed, only `TemplateBody` is used.
|
@@ -4267,16 +4280,16 @@ module Aws::CloudFormation
|
|
4267
4280
|
# @option params [Boolean] :disable_rollback
|
4268
4281
|
# Preserves the state of previously provisioned resources when an
|
4269
4282
|
# operation fails. This parameter can't be specified when the
|
4270
|
-
# `OnStackFailure` parameter to the [CreateChangeSet][1] API
|
4271
|
-
# was specified.
|
4283
|
+
# `OnStackFailure` parameter to the [ `CreateChangeSet` ][1] API
|
4284
|
+
# operation was specified.
|
4272
4285
|
#
|
4273
4286
|
# * `True` - if the stack creation fails, do nothing. This is equivalent
|
4274
4287
|
# to specifying `DO_NOTHING` for the `OnStackFailure` parameter to the
|
4275
|
-
# [CreateChangeSet][1] API operation.
|
4288
|
+
# [ `CreateChangeSet` ][1] API operation.
|
4276
4289
|
#
|
4277
4290
|
# * `False` - if the stack creation fails, roll back the stack. This is
|
4278
4291
|
# equivalent to specifying `ROLLBACK` for the `OnStackFailure`
|
4279
|
-
# parameter to the [CreateChangeSet][1] API operation.
|
4292
|
+
# parameter to the [ `CreateChangeSet` ][1] API operation.
|
4280
4293
|
#
|
4281
4294
|
# Default: `True`
|
4282
4295
|
#
|
@@ -4515,7 +4528,8 @@ module Aws::CloudFormation
|
|
4515
4528
|
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
4516
4529
|
# bucket or a Systems Manager document. For more information about
|
4517
4530
|
# templates, see [Template anatomy][1] in the *CloudFormation User
|
4518
|
-
# Guide*.
|
4531
|
+
# Guide*. The location for an Amazon S3 bucket must start with
|
4532
|
+
# `https://`.
|
4519
4533
|
#
|
4520
4534
|
# Conditional: You must specify only one of the following parameters:
|
4521
4535
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -5486,7 +5500,7 @@ module Aws::CloudFormation
|
|
5486
5500
|
# resp.summaries[0].stack_id #=> String
|
5487
5501
|
# resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
|
5488
5502
|
# resp.summaries[0].status_reason #=> String
|
5489
|
-
# resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT"
|
5503
|
+
# resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT", "FAILED_IMPORT"
|
5490
5504
|
# resp.summaries[0].organizational_unit_id #=> String
|
5491
5505
|
# resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
5492
5506
|
# resp.summaries[0].last_drift_check_timestamp #=> Time
|
@@ -6197,7 +6211,7 @@ module Aws::CloudFormation
|
|
6197
6211
|
# public use][1] in the *CloudFormation CLI User Guide*.
|
6198
6212
|
#
|
6199
6213
|
# To publish an extension, you must be registered as a publisher with
|
6200
|
-
# CloudFormation. For more information, see [RegisterPublisher][2].
|
6214
|
+
# CloudFormation. For more information, see [ `RegisterPublisher` ][2].
|
6201
6215
|
#
|
6202
6216
|
#
|
6203
6217
|
#
|
@@ -6426,8 +6440,8 @@ module Aws::CloudFormation
|
|
6426
6440
|
# *CloudFormation CLI User Guide*.
|
6427
6441
|
#
|
6428
6442
|
# You can have a maximum of 50 resource extension versions registered at
|
6429
|
-
# a time. This maximum is per account and per Region. Use
|
6430
|
-
#
|
6443
|
+
# a time. This maximum is per account and per Region. Use [
|
6444
|
+
# `DeregisterType` ][2] to deregister specific extension versions if
|
6431
6445
|
# necessary.
|
6432
6446
|
#
|
6433
6447
|
# Once you have initiated a registration request using RegisterType, you
|
@@ -6435,7 +6449,7 @@ module Aws::CloudFormation
|
|
6435
6449
|
# registration request.
|
6436
6450
|
#
|
6437
6451
|
# Once you have registered a private extension in your account and
|
6438
|
-
# Region, use [SetTypeConfiguration][3] to specify configuration
|
6452
|
+
# Region, use [ `SetTypeConfiguration` ][3] to specify configuration
|
6439
6453
|
# properties for the extension. For more information, see [Configuring
|
6440
6454
|
# extensions at the account level][4] in the *CloudFormation User
|
6441
6455
|
# Guide*.
|
@@ -6648,7 +6662,8 @@ module Aws::CloudFormation
|
|
6648
6662
|
# @option params [String] :stack_policy_url
|
6649
6663
|
# Location of a file containing the stack policy. The URL must point to
|
6650
6664
|
# a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the
|
6651
|
-
# same Amazon Web Services Region as the stack.
|
6665
|
+
# same Amazon Web Services Region as the stack. The location for an
|
6666
|
+
# Amazon S3 bucket must start with `https://`. You can specify either
|
6652
6667
|
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
6653
6668
|
#
|
6654
6669
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -6674,7 +6689,7 @@ module Aws::CloudFormation
|
|
6674
6689
|
# extension, in the given account and Region.
|
6675
6690
|
#
|
6676
6691
|
# To view the current configuration data for an extension, refer to the
|
6677
|
-
# `ConfigurationSchema` element of [DescribeType][1]. For more
|
6692
|
+
# `ConfigurationSchema` element of [ `DescribeType` ][1]. For more
|
6678
6693
|
# information, see [Configuring extensions at the account level][2] in
|
6679
6694
|
# the *CloudFormation User Guide*.
|
6680
6695
|
#
|
@@ -6693,10 +6708,10 @@ module Aws::CloudFormation
|
|
6693
6708
|
# The Amazon Resource Name (ARN) for the extension, in this account and
|
6694
6709
|
# Region.
|
6695
6710
|
#
|
6696
|
-
# For public extensions, this will be the ARN assigned when you
|
6697
|
-
# [
|
6698
|
-
# extensions, this will be the ARN assigned when you
|
6699
|
-
#
|
6711
|
+
# For public extensions, this will be the ARN assigned when you call the
|
6712
|
+
# [ `ActivateType` ][1] API operation in this account and Region. For
|
6713
|
+
# private extensions, this will be the ARN assigned when you call the [
|
6714
|
+
# `RegisterType` ][2] API operation in this account and Region.
|
6700
6715
|
#
|
6701
6716
|
# Do not include the extension versions suffix at the end of the ARN.
|
6702
6717
|
# You can set the configuration for an extension, but not for a specific
|
@@ -6711,8 +6726,8 @@ module Aws::CloudFormation
|
|
6711
6726
|
# The configuration data for the extension, in this account and Region.
|
6712
6727
|
#
|
6713
6728
|
# The configuration data must be formatted as JSON, and validate against
|
6714
|
-
# the schema returned in the `ConfigurationSchema` response element of
|
6715
|
-
#
|
6729
|
+
# the schema returned in the `ConfigurationSchema` response element of [
|
6730
|
+
# `DescribeType` ][1]. For more information, see [Defining account-level
|
6716
6731
|
# configuration data for an extension][2] in the *CloudFormation CLI
|
6717
6732
|
# User Guide*.
|
6718
6733
|
#
|
@@ -6970,11 +6985,11 @@ module Aws::CloudFormation
|
|
6970
6985
|
# version of the extension in your account and Region for testing.
|
6971
6986
|
#
|
6972
6987
|
# To perform testing, CloudFormation assumes the execution role
|
6973
|
-
# specified when the type was registered. For more information, see
|
6974
|
-
#
|
6988
|
+
# specified when the type was registered. For more information, see [
|
6989
|
+
# `RegisterType` ][2].
|
6975
6990
|
#
|
6976
6991
|
# Once you've initiated testing on an extension using `TestType`, you
|
6977
|
-
# can pass the returned `TypeVersionArn` into [DescribeType][3] to
|
6992
|
+
# can pass the returned `TypeVersionArn` into [ `DescribeType` ][3] to
|
6978
6993
|
# monitor the current test status and test status description for the
|
6979
6994
|
# extension.
|
6980
6995
|
#
|
@@ -7228,7 +7243,8 @@ module Aws::CloudFormation
|
|
7228
7243
|
# Location of file containing the template body. The URL must point to a
|
7229
7244
|
# template that's located in an Amazon S3 bucket or a Systems Manager
|
7230
7245
|
# document. For more information, go to [Template Anatomy][1] in the
|
7231
|
-
# *CloudFormation User Guide*.
|
7246
|
+
# *CloudFormation User Guide*. The location for an Amazon S3 bucket must
|
7247
|
+
# start with `https://`.
|
7232
7248
|
#
|
7233
7249
|
# Conditional: You must specify only one of the following parameters:
|
7234
7250
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -7259,7 +7275,8 @@ module Aws::CloudFormation
|
|
7259
7275
|
# @option params [String] :stack_policy_during_update_url
|
7260
7276
|
# Location of a file containing the temporary overriding stack policy.
|
7261
7277
|
# The URL must point to a policy (max size: 16KB) located in an S3
|
7262
|
-
# bucket in the same Region as the stack.
|
7278
|
+
# bucket in the same Region as the stack. The location for an Amazon S3
|
7279
|
+
# bucket must start with `https://`. You can specify either the
|
7263
7280
|
# `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL`
|
7264
7281
|
# parameter, but not both.
|
7265
7282
|
#
|
@@ -7270,7 +7287,7 @@ module Aws::CloudFormation
|
|
7270
7287
|
#
|
7271
7288
|
# @option params [Array<Types::Parameter>] :parameters
|
7272
7289
|
# A list of `Parameter` structures that specify input parameters for the
|
7273
|
-
# stack. For more information, see the [Parameter][1] data type.
|
7290
|
+
# stack. For more information, see the [ `Parameter` ][1] data type.
|
7274
7291
|
#
|
7275
7292
|
#
|
7276
7293
|
#
|
@@ -7304,19 +7321,19 @@ module Aws::CloudFormation
|
|
7304
7321
|
# review all permissions associated with them and edit their
|
7305
7322
|
# permissions if necessary.
|
7306
7323
|
#
|
7307
|
-
# * [ AWS::IAM::AccessKey][1]
|
7324
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
7308
7325
|
#
|
7309
|
-
# * [ AWS::IAM::Group][2]
|
7326
|
+
# * [ `AWS::IAM::Group` ][2]
|
7310
7327
|
#
|
7311
|
-
# * [AWS::IAM::InstanceProfile][3]
|
7328
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
7312
7329
|
#
|
7313
|
-
# * [ AWS::IAM::Policy][4]
|
7330
|
+
# * [ ` AWS::IAM::Policy` ][4]
|
7314
7331
|
#
|
7315
|
-
# * [ AWS::IAM::Role][5]
|
7332
|
+
# * [ `AWS::IAM::Role` ][5]
|
7316
7333
|
#
|
7317
|
-
# * [ AWS::IAM::User][6]
|
7334
|
+
# * [ `AWS::IAM::User` ][6]
|
7318
7335
|
#
|
7319
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
7336
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
7320
7337
|
#
|
7321
7338
|
# For more information, see [Acknowledging IAM Resources in
|
7322
7339
|
# CloudFormation Templates][8].
|
@@ -7332,8 +7349,8 @@ module Aws::CloudFormation
|
|
7332
7349
|
# your stack template contains one or more macros, and you choose to
|
7333
7350
|
# update a stack directly from the processed template, without first
|
7334
7351
|
# reviewing the resulting changes in a change set, you must
|
7335
|
-
# acknowledge this capability. This includes the [AWS::Include][9]
|
7336
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
7352
|
+
# acknowledge this capability. This includes the [ `AWS::Include` ][9]
|
7353
|
+
# and [ `AWS::Serverless` ][10] transforms, which are macros hosted by
|
7337
7354
|
# CloudFormation.
|
7338
7355
|
#
|
7339
7356
|
# If you want to update a stack from a stack template that contains
|
@@ -7422,8 +7439,9 @@ module Aws::CloudFormation
|
|
7422
7439
|
# @option params [String] :stack_policy_url
|
7423
7440
|
# Location of a file containing the updated stack policy. The URL must
|
7424
7441
|
# point to a policy (max size: 16KB) located in an S3 bucket in the same
|
7425
|
-
# Region as the stack.
|
7426
|
-
# the `
|
7442
|
+
# Region as the stack. The location for an Amazon S3 bucket must start
|
7443
|
+
# with `https://`. You can specify either the `StackPolicyBody` or the
|
7444
|
+
# `StackPolicyURL` parameter, but not both.
|
7427
7445
|
#
|
7428
7446
|
# You might update the stack policy, for example, in order to protect a
|
7429
7447
|
# new resource that you created during a stack update. If you don't
|
@@ -7544,20 +7562,20 @@ module Aws::CloudFormation
|
|
7544
7562
|
#
|
7545
7563
|
# You can only update stack instances in Amazon Web Services Regions and
|
7546
7564
|
# accounts where they already exist; to create additional stack
|
7547
|
-
# instances, use [CreateStackInstances][1].
|
7565
|
+
# instances, use [ `CreateStackInstances` ][1].
|
7548
7566
|
#
|
7549
7567
|
# During stack set updates, any parameters overridden for a stack
|
7550
7568
|
# instance aren't updated, but retain their overridden value.
|
7551
7569
|
#
|
7552
7570
|
# You can only update the parameter *values* that are specified in the
|
7553
|
-
# stack set; to add or delete a parameter itself, use
|
7554
|
-
#
|
7555
|
-
#
|
7556
|
-
#
|
7557
|
-
#
|
7558
|
-
#
|
7559
|
-
#
|
7560
|
-
#
|
7571
|
+
# stack set; to add or delete a parameter itself, use [ `UpdateStackSet`
|
7572
|
+
# ][2] to update the stack set template. If you add a parameter to a
|
7573
|
+
# template, before you can override the parameter value specified in the
|
7574
|
+
# stack set you must first use [ `UpdateStackSet` ][2] to update all
|
7575
|
+
# stack instances with the updated template and parameter value
|
7576
|
+
# specified in the stack set. Once a stack instance has been updated
|
7577
|
+
# with the new parameter, you can then override the parameter value
|
7578
|
+
# using `UpdateStackInstances`.
|
7561
7579
|
#
|
7562
7580
|
#
|
7563
7581
|
#
|
@@ -7623,11 +7641,11 @@ module Aws::CloudFormation
|
|
7623
7641
|
# stack set; to add or delete a parameter itself, use `UpdateStackSet`
|
7624
7642
|
# to update the stack set template. If you add a parameter to a
|
7625
7643
|
# template, before you can override the parameter value specified in the
|
7626
|
-
# stack set you must first use [UpdateStackSet][1] to update all
|
7627
|
-
# instances with the updated template and parameter value
|
7628
|
-
# the stack set. Once a stack instance has been updated
|
7629
|
-
# parameter, you can then override the parameter value
|
7630
|
-
# `UpdateStackInstances`.
|
7644
|
+
# stack set you must first use [ `UpdateStackSet` ][1] to update all
|
7645
|
+
# stack instances with the updated template and parameter value
|
7646
|
+
# specified in the stack set. Once a stack instance has been updated
|
7647
|
+
# with the new parameter, you can then override the parameter value
|
7648
|
+
# using `UpdateStackInstances`.
|
7631
7649
|
#
|
7632
7650
|
#
|
7633
7651
|
#
|
@@ -7741,7 +7759,7 @@ module Aws::CloudFormation
|
|
7741
7759
|
# @option params [String] :template_body
|
7742
7760
|
# The structure that contains the template body, with a minimum length
|
7743
7761
|
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
7744
|
-
# see [Template Anatomy][1] in the CloudFormation User Guide
|
7762
|
+
# see [Template Anatomy][1] in the *CloudFormation User Guide*.
|
7745
7763
|
#
|
7746
7764
|
# Conditional: You must specify only one of the following parameters:
|
7747
7765
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
@@ -7754,8 +7772,8 @@ module Aws::CloudFormation
|
|
7754
7772
|
# The location of the file that contains the template body. The URL must
|
7755
7773
|
# point to a template (maximum size: 460,800 bytes) that is located in
|
7756
7774
|
# an Amazon S3 bucket or a Systems Manager document. For more
|
7757
|
-
# information, see [Template Anatomy][1] in the CloudFormation User
|
7758
|
-
# Guide
|
7775
|
+
# information, see [Template Anatomy][1] in the *CloudFormation User
|
7776
|
+
# Guide*.
|
7759
7777
|
#
|
7760
7778
|
# Conditional: You must specify only one of the following parameters:
|
7761
7779
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
@@ -7802,19 +7820,19 @@ module Aws::CloudFormation
|
|
7802
7820
|
# you review all permissions associated with them and edit their
|
7803
7821
|
# permissions if necessary.
|
7804
7822
|
#
|
7805
|
-
# * [ AWS::IAM::AccessKey][1]
|
7823
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
7806
7824
|
#
|
7807
|
-
# * [ AWS::IAM::Group][2]
|
7825
|
+
# * [ `AWS::IAM::Group` ][2]
|
7808
7826
|
#
|
7809
|
-
# * [ AWS::IAM::InstanceProfile][3]
|
7827
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
7810
7828
|
#
|
7811
|
-
# * [ AWS::IAM::Policy][4]
|
7829
|
+
# * [ `AWS::IAM::Policy` ][4]
|
7812
7830
|
#
|
7813
|
-
# * [ AWS::IAM::Role][5]
|
7831
|
+
# * [ `AWS::IAM::Role` ][5]
|
7814
7832
|
#
|
7815
|
-
# * [ AWS::IAM::User][6]
|
7833
|
+
# * [ `AWS::IAM::User` ][6]
|
7816
7834
|
#
|
7817
|
-
# * [ AWS::IAM::UserToGroupAddition][7]
|
7835
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
7818
7836
|
#
|
7819
7837
|
# For more information, see [Acknowledging IAM Resources in
|
7820
7838
|
# CloudFormation Templates][8].
|
@@ -7830,12 +7848,11 @@ module Aws::CloudFormation
|
|
7830
7848
|
# Templates][9].
|
7831
7849
|
#
|
7832
7850
|
# Stack sets with service-managed permissions do not currently support
|
7833
|
-
# the use of macros in templates. (This includes the
|
7834
|
-
#
|
7835
|
-
#
|
7836
|
-
#
|
7837
|
-
#
|
7838
|
-
# fail.
|
7851
|
+
# the use of macros in templates. (This includes the [ `AWS::Include`
|
7852
|
+
# ][10] and [ `AWS::Serverless` ][11] transforms, which are macros
|
7853
|
+
# hosted by CloudFormation.) Even if you specify this capability for a
|
7854
|
+
# stack set with service-managed permissions, if you reference a macro
|
7855
|
+
# in your template the stack set operation will fail.
|
7839
7856
|
#
|
7840
7857
|
#
|
7841
7858
|
#
|
@@ -8181,7 +8198,8 @@ module Aws::CloudFormation
|
|
8181
8198
|
# Location of file containing the template body. The URL must point to a
|
8182
8199
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
8183
8200
|
# bucket or a Systems Manager document. For more information, go to
|
8184
|
-
# [Template Anatomy][1] in the *CloudFormation User Guide*.
|
8201
|
+
# [Template Anatomy][1] in the *CloudFormation User Guide*. The location
|
8202
|
+
# for an Amazon S3 bucket must start with `https://`.
|
8185
8203
|
#
|
8186
8204
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
8187
8205
|
# are passed, only `TemplateBody` is used.
|
@@ -8241,7 +8259,7 @@ module Aws::CloudFormation
|
|
8241
8259
|
params: params,
|
8242
8260
|
config: config)
|
8243
8261
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
8244
|
-
context[:gem_version] = '1.
|
8262
|
+
context[:gem_version] = '1.101.0'
|
8245
8263
|
Seahorse::Client::Request.new(handlers, context)
|
8246
8264
|
end
|
8247
8265
|
|