aws-sdk-cloudformation 1.99.0 → 1.101.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 +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
@@ -141,6 +141,7 @@ module Aws::CloudFormation
|
|
141
141
|
DescribeTypeRegistrationInput = Shapes::StructureShape.new(name: 'DescribeTypeRegistrationInput')
|
142
142
|
DescribeTypeRegistrationOutput = Shapes::StructureShape.new(name: 'DescribeTypeRegistrationOutput')
|
143
143
|
Description = Shapes::StringShape.new(name: 'Description')
|
144
|
+
DetailedStatus = Shapes::StringShape.new(name: 'DetailedStatus')
|
144
145
|
DetectStackDriftInput = Shapes::StructureShape.new(name: 'DetectStackDriftInput')
|
145
146
|
DetectStackDriftOutput = Shapes::StructureShape.new(name: 'DetectStackDriftOutput')
|
146
147
|
DetectStackResourceDriftInput = Shapes::StructureShape.new(name: 'DetectStackResourceDriftInput')
|
@@ -1653,6 +1654,7 @@ module Aws::CloudFormation
|
|
1653
1654
|
Stack.add_member(:root_id, Shapes::ShapeRef.new(shape: StackId, location_name: "RootId"))
|
1654
1655
|
Stack.add_member(:drift_information, Shapes::ShapeRef.new(shape: StackDriftInformation, location_name: "DriftInformation"))
|
1655
1656
|
Stack.add_member(:retain_except_on_create, Shapes::ShapeRef.new(shape: RetainExceptOnCreate, location_name: "RetainExceptOnCreate"))
|
1657
|
+
Stack.add_member(:detailed_status, Shapes::ShapeRef.new(shape: DetailedStatus, location_name: "DetailedStatus"))
|
1656
1658
|
Stack.struct_class = Types::Stack
|
1657
1659
|
|
1658
1660
|
StackDriftInformation.add_member(:stack_drift_status, Shapes::ShapeRef.new(shape: StackDriftStatus, required: true, location_name: "StackDriftStatus"))
|
@@ -1679,6 +1681,7 @@ module Aws::CloudFormation
|
|
1679
1681
|
StackEvent.add_member(:hook_status_reason, Shapes::ShapeRef.new(shape: HookStatusReason, location_name: "HookStatusReason"))
|
1680
1682
|
StackEvent.add_member(:hook_invocation_point, Shapes::ShapeRef.new(shape: HookInvocationPoint, location_name: "HookInvocationPoint"))
|
1681
1683
|
StackEvent.add_member(:hook_failure_mode, Shapes::ShapeRef.new(shape: HookFailureMode, location_name: "HookFailureMode"))
|
1684
|
+
StackEvent.add_member(:detailed_status, Shapes::ShapeRef.new(shape: DetailedStatus, location_name: "DetailedStatus"))
|
1682
1685
|
StackEvent.struct_class = Types::StackEvent
|
1683
1686
|
|
1684
1687
|
StackEvents.member = Shapes::ShapeRef.new(shape: StackEvent)
|
@@ -61,7 +61,7 @@ module Aws::CloudFormation
|
|
61
61
|
end
|
62
62
|
|
63
63
|
# Type of resource. (For more information, go to [Amazon Web Services
|
64
|
-
# Resource Types Reference][1] in the CloudFormation User Guide
|
64
|
+
# Resource Types Reference][1] in the *CloudFormation User Guide*.)
|
65
65
|
#
|
66
66
|
#
|
67
67
|
#
|
@@ -151,6 +151,30 @@ module Aws::CloudFormation
|
|
151
151
|
data[:hook_failure_mode]
|
152
152
|
end
|
153
153
|
|
154
|
+
# An optional field containing information about the detailed status of
|
155
|
+
# the stack event.
|
156
|
+
#
|
157
|
+
# * `CONFIGURATION_COMPLETE` - all of the resources in the stack have
|
158
|
+
# reached that event. For more information, see [CloudFormation stack
|
159
|
+
# deployment][1] in the *CloudFormation User Guide*.
|
160
|
+
#
|
161
|
+
# ^
|
162
|
+
# ^
|
163
|
+
#
|
164
|
+
# * `VALIDATION_FAILED` - template validation failed because of invalid
|
165
|
+
# properties in the template. The `ResourceStatusReason` field shows
|
166
|
+
# what properties are defined incorrectly.
|
167
|
+
#
|
168
|
+
# ^
|
169
|
+
#
|
170
|
+
#
|
171
|
+
#
|
172
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
173
|
+
# @return [String]
|
174
|
+
def detailed_status
|
175
|
+
data[:detailed_status]
|
176
|
+
end
|
177
|
+
|
154
178
|
# @!endgroup
|
155
179
|
|
156
180
|
# @return [Client]
|
@@ -102,7 +102,8 @@ module Aws::CloudFormation
|
|
102
102
|
# Location of file containing the template body. The URL must point to a
|
103
103
|
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
104
104
|
# bucket or a Systems Manager document. For more information, go to the
|
105
|
-
# [Template anatomy][1] in the *CloudFormation User Guide*.
|
105
|
+
# [Template anatomy][1] in the *CloudFormation User Guide*. The location
|
106
|
+
# for an Amazon S3 bucket must start with `https://`.
|
106
107
|
#
|
107
108
|
# Conditional: You must specify either the `TemplateBody` or the
|
108
109
|
# `TemplateURL` parameter, but not both.
|
@@ -112,7 +113,7 @@ module Aws::CloudFormation
|
|
112
113
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
113
114
|
# @option options [Array<Types::Parameter>] :parameters
|
114
115
|
# A list of `Parameter` structures that specify input parameters for the
|
115
|
-
# stack. For more information, see the [Parameter][1] data type.
|
116
|
+
# stack. For more information, see the [ `Parameter` ][1] data type.
|
116
117
|
#
|
117
118
|
#
|
118
119
|
#
|
@@ -163,19 +164,19 @@ module Aws::CloudFormation
|
|
163
164
|
# you review all permissions associated with them and edit their
|
164
165
|
# permissions if necessary.
|
165
166
|
#
|
166
|
-
# * [ AWS::IAM::AccessKey][1]
|
167
|
+
# * [ `AWS::IAM::AccessKey` AWS::IAM::AccessKey][1]
|
167
168
|
#
|
168
|
-
# * [ AWS::IAM::Group][2]
|
169
|
+
# * [ `AWS::IAM::Group` ][2]
|
169
170
|
#
|
170
|
-
# * [AWS::IAM::InstanceProfile][3]
|
171
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
171
172
|
#
|
172
|
-
# * [ AWS::IAM::Policy][4]
|
173
|
+
# * [ `AWS::IAM::Policy` ][4]
|
173
174
|
#
|
174
|
-
# * [ AWS::IAM::Role][5]
|
175
|
+
# * [ `AWS::IAM::Role` ][5]
|
175
176
|
#
|
176
|
-
# * [ AWS::IAM::User][6]
|
177
|
+
# * [ `AWS::IAM::User` ][6]
|
177
178
|
#
|
178
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
179
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
179
180
|
#
|
180
181
|
# For more information, see [Acknowledging IAM Resources in
|
181
182
|
# CloudFormation Templates][8].
|
@@ -191,8 +192,8 @@ module Aws::CloudFormation
|
|
191
192
|
# your stack template contains one or more macros, and you choose to
|
192
193
|
# create a stack directly from the processed template, without first
|
193
194
|
# reviewing the resulting changes in a change set, you must
|
194
|
-
# acknowledge this capability. This includes the [AWS::Include][9]
|
195
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
195
|
+
# acknowledge this capability. This includes the [ `AWS::Include` ][9]
|
196
|
+
# and [ `AWS::Serverless` ][10] transforms, which are macros hosted by
|
196
197
|
# CloudFormation.
|
197
198
|
#
|
198
199
|
# If you want to create a stack from a stack template that contains
|
@@ -285,8 +286,9 @@ module Aws::CloudFormation
|
|
285
286
|
# @option options [String] :stack_policy_url
|
286
287
|
# Location of a file containing the stack policy. The URL must point to
|
287
288
|
# a policy (maximum size: 16 KB) located in an S3 bucket in the same
|
288
|
-
# Region as the stack.
|
289
|
-
# the `
|
289
|
+
# Region as the stack. The location for an Amazon S3 bucket must start
|
290
|
+
# with `https://`. You can specify either the `StackPolicyBody` or the
|
291
|
+
# `StackPolicyURL` parameter, but not both.
|
290
292
|
# @option options [Array<Types::Tag>] :tags
|
291
293
|
# Key-value pairs to associate with this stack. CloudFormation also
|
292
294
|
# propagates these tags to the resources created in the stack. A maximum
|
@@ -218,6 +218,22 @@ module Aws::CloudFormation
|
|
218
218
|
data[:retain_except_on_create]
|
219
219
|
end
|
220
220
|
|
221
|
+
# The detailed status of the resource or stack. If
|
222
|
+
# `CONFIGURATION_COMPLETE` is present, the resource or resource
|
223
|
+
# configuration phase has completed and the stabilization of the
|
224
|
+
# resources is in progress. The stack sets `CONFIGURATION_COMPLETE` when
|
225
|
+
# all of the resources in the stack have reached that event. For more
|
226
|
+
# information, see [CloudFormation stack deployment][1] in the
|
227
|
+
# *CloudFormation User Guide*.
|
228
|
+
#
|
229
|
+
#
|
230
|
+
#
|
231
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
232
|
+
# @return [String]
|
233
|
+
def detailed_status
|
234
|
+
data[:detailed_status]
|
235
|
+
end
|
236
|
+
|
221
237
|
# @!endgroup
|
222
238
|
|
223
239
|
# @return [Client]
|
@@ -467,7 +483,8 @@ module Aws::CloudFormation
|
|
467
483
|
# Location of file containing the template body. The URL must point to a
|
468
484
|
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
469
485
|
# bucket or a Systems Manager document. For more information, go to the
|
470
|
-
# [Template anatomy][1] in the *CloudFormation User Guide*.
|
486
|
+
# [Template anatomy][1] in the *CloudFormation User Guide*. The location
|
487
|
+
# for an Amazon S3 bucket must start with `https://`.
|
471
488
|
#
|
472
489
|
# Conditional: You must specify either the `TemplateBody` or the
|
473
490
|
# `TemplateURL` parameter, but not both.
|
@@ -477,7 +494,7 @@ module Aws::CloudFormation
|
|
477
494
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
478
495
|
# @option options [Array<Types::Parameter>] :parameters
|
479
496
|
# A list of `Parameter` structures that specify input parameters for the
|
480
|
-
# stack. For more information, see the [Parameter][1] data type.
|
497
|
+
# stack. For more information, see the [ `Parameter` ][1] data type.
|
481
498
|
#
|
482
499
|
#
|
483
500
|
#
|
@@ -528,19 +545,19 @@ module Aws::CloudFormation
|
|
528
545
|
# you review all permissions associated with them and edit their
|
529
546
|
# permissions if necessary.
|
530
547
|
#
|
531
|
-
# * [ AWS::IAM::AccessKey][1]
|
548
|
+
# * [ `AWS::IAM::AccessKey` AWS::IAM::AccessKey][1]
|
532
549
|
#
|
533
|
-
# * [ AWS::IAM::Group][2]
|
550
|
+
# * [ `AWS::IAM::Group` ][2]
|
534
551
|
#
|
535
|
-
# * [AWS::IAM::InstanceProfile][3]
|
552
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
536
553
|
#
|
537
|
-
# * [ AWS::IAM::Policy][4]
|
554
|
+
# * [ `AWS::IAM::Policy` ][4]
|
538
555
|
#
|
539
|
-
# * [ AWS::IAM::Role][5]
|
556
|
+
# * [ `AWS::IAM::Role` ][5]
|
540
557
|
#
|
541
|
-
# * [ AWS::IAM::User][6]
|
558
|
+
# * [ `AWS::IAM::User` ][6]
|
542
559
|
#
|
543
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
560
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
544
561
|
#
|
545
562
|
# For more information, see [Acknowledging IAM Resources in
|
546
563
|
# CloudFormation Templates][8].
|
@@ -556,8 +573,8 @@ module Aws::CloudFormation
|
|
556
573
|
# your stack template contains one or more macros, and you choose to
|
557
574
|
# create a stack directly from the processed template, without first
|
558
575
|
# reviewing the resulting changes in a change set, you must
|
559
|
-
# acknowledge this capability. This includes the [AWS::Include][9]
|
560
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
576
|
+
# acknowledge this capability. This includes the [ `AWS::Include` ][9]
|
577
|
+
# and [ `AWS::Serverless` ][10] transforms, which are macros hosted by
|
561
578
|
# CloudFormation.
|
562
579
|
#
|
563
580
|
# If you want to create a stack from a stack template that contains
|
@@ -650,8 +667,9 @@ module Aws::CloudFormation
|
|
650
667
|
# @option options [String] :stack_policy_url
|
651
668
|
# Location of a file containing the stack policy. The URL must point to
|
652
669
|
# a policy (maximum size: 16 KB) located in an S3 bucket in the same
|
653
|
-
# Region as the stack.
|
654
|
-
# the `
|
670
|
+
# Region as the stack. The location for an Amazon S3 bucket must start
|
671
|
+
# with `https://`. You can specify either the `StackPolicyBody` or the
|
672
|
+
# `StackPolicyURL` parameter, but not both.
|
655
673
|
# @option options [Array<Types::Tag>] :tags
|
656
674
|
# Key-value pairs to associate with this stack. CloudFormation also
|
657
675
|
# propagates these tags to the resources created in the stack. A maximum
|
@@ -819,7 +837,8 @@ module Aws::CloudFormation
|
|
819
837
|
# Location of file containing the template body. The URL must point to a
|
820
838
|
# template that's located in an Amazon S3 bucket or a Systems Manager
|
821
839
|
# document. For more information, go to [Template Anatomy][1] in the
|
822
|
-
# *CloudFormation User Guide*.
|
840
|
+
# *CloudFormation User Guide*. The location for an Amazon S3 bucket must
|
841
|
+
# start with `https://`.
|
823
842
|
#
|
824
843
|
# Conditional: You must specify only one of the following parameters:
|
825
844
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -847,7 +866,8 @@ module Aws::CloudFormation
|
|
847
866
|
# @option options [String] :stack_policy_during_update_url
|
848
867
|
# Location of a file containing the temporary overriding stack policy.
|
849
868
|
# The URL must point to a policy (max size: 16KB) located in an S3
|
850
|
-
# bucket in the same Region as the stack.
|
869
|
+
# bucket in the same Region as the stack. The location for an Amazon S3
|
870
|
+
# bucket must start with `https://`. You can specify either the
|
851
871
|
# `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL`
|
852
872
|
# parameter, but not both.
|
853
873
|
#
|
@@ -857,7 +877,7 @@ module Aws::CloudFormation
|
|
857
877
|
# will be used.
|
858
878
|
# @option options [Array<Types::Parameter>] :parameters
|
859
879
|
# A list of `Parameter` structures that specify input parameters for the
|
860
|
-
# stack. For more information, see the [Parameter][1] data type.
|
880
|
+
# stack. For more information, see the [ `Parameter` ][1] data type.
|
861
881
|
#
|
862
882
|
#
|
863
883
|
#
|
@@ -890,19 +910,19 @@ module Aws::CloudFormation
|
|
890
910
|
# review all permissions associated with them and edit their
|
891
911
|
# permissions if necessary.
|
892
912
|
#
|
893
|
-
# * [ AWS::IAM::AccessKey][1]
|
913
|
+
# * [ `AWS::IAM::AccessKey` ][1]
|
894
914
|
#
|
895
|
-
# * [ AWS::IAM::Group][2]
|
915
|
+
# * [ `AWS::IAM::Group` ][2]
|
896
916
|
#
|
897
|
-
# * [AWS::IAM::InstanceProfile][3]
|
917
|
+
# * [ `AWS::IAM::InstanceProfile` ][3]
|
898
918
|
#
|
899
|
-
# * [ AWS::IAM::Policy][4]
|
919
|
+
# * [ ` AWS::IAM::Policy` ][4]
|
900
920
|
#
|
901
|
-
# * [ AWS::IAM::Role][5]
|
921
|
+
# * [ `AWS::IAM::Role` ][5]
|
902
922
|
#
|
903
|
-
# * [ AWS::IAM::User][6]
|
923
|
+
# * [ `AWS::IAM::User` ][6]
|
904
924
|
#
|
905
|
-
# * [AWS::IAM::UserToGroupAddition][7]
|
925
|
+
# * [ `AWS::IAM::UserToGroupAddition` ][7]
|
906
926
|
#
|
907
927
|
# For more information, see [Acknowledging IAM Resources in
|
908
928
|
# CloudFormation Templates][8].
|
@@ -918,8 +938,8 @@ module Aws::CloudFormation
|
|
918
938
|
# your stack template contains one or more macros, and you choose to
|
919
939
|
# update a stack directly from the processed template, without first
|
920
940
|
# reviewing the resulting changes in a change set, you must
|
921
|
-
# acknowledge this capability. This includes the [AWS::Include][9]
|
922
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
941
|
+
# acknowledge this capability. This includes the [ `AWS::Include` ][9]
|
942
|
+
# and [ `AWS::Serverless` ][10] transforms, which are macros hosted by
|
923
943
|
# CloudFormation.
|
924
944
|
#
|
925
945
|
# If you want to update a stack from a stack template that contains
|
@@ -1003,8 +1023,9 @@ module Aws::CloudFormation
|
|
1003
1023
|
# @option options [String] :stack_policy_url
|
1004
1024
|
# Location of a file containing the updated stack policy. The URL must
|
1005
1025
|
# point to a policy (max size: 16KB) located in an S3 bucket in the same
|
1006
|
-
# Region as the stack.
|
1007
|
-
# the `
|
1026
|
+
# Region as the stack. The location for an Amazon S3 bucket must start
|
1027
|
+
# with `https://`. You can specify either the `StackPolicyBody` or the
|
1028
|
+
# `StackPolicyURL` parameter, but not both.
|
1008
1029
|
#
|
1009
1030
|
# You might update the stack policy, for example, in order to protect a
|
1010
1031
|
# new resource that you created during a stack update. If you don't
|
@@ -57,7 +57,7 @@ module Aws::CloudFormation
|
|
57
57
|
end
|
58
58
|
|
59
59
|
# Type of resource. For more information, go to [Amazon Web Services
|
60
|
-
# Resource Types Reference][1] in the CloudFormation User Guide
|
60
|
+
# Resource Types Reference][1] in the *CloudFormation User Guide*.
|
61
61
|
#
|
62
62
|
#
|
63
63
|
#
|
@@ -92,8 +92,8 @@ module Aws::CloudFormation
|
|
92
92
|
end
|
93
93
|
|
94
94
|
# The content of the `Metadata` attribute declared for the resource. For
|
95
|
-
# more information, see [Metadata Attribute][1] in the CloudFormation
|
96
|
-
# User Guide
|
95
|
+
# more information, see [Metadata Attribute][1] in the *CloudFormation
|
96
|
+
# User Guide*.
|
97
97
|
#
|
98
98
|
#
|
99
99
|
#
|
@@ -51,7 +51,7 @@ module Aws::CloudFormation
|
|
51
51
|
end
|
52
52
|
|
53
53
|
# Type of resource. (For more information, go to [Amazon Web Services
|
54
|
-
# Resource Types Reference][1] in the CloudFormation User Guide
|
54
|
+
# Resource Types Reference][1] in the *CloudFormation User Guide*.)
|
55
55
|
#
|
56
56
|
#
|
57
57
|
#
|