aws-sdk-cloudformation 1.65.0 → 1.68.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +317 -232
- data/lib/aws-sdk-cloudformation/client_api.rb +67 -0
- data/lib/aws-sdk-cloudformation/event.rb +36 -0
- data/lib/aws-sdk-cloudformation/resource.rb +20 -20
- data/lib/aws-sdk-cloudformation/stack.rb +31 -30
- data/lib/aws-sdk-cloudformation/stack_resource.rb +2 -2
- data/lib/aws-sdk-cloudformation/types.rb +559 -318
- data/lib/aws-sdk-cloudformation.rb +1 -1
- metadata +4 -4
@@ -47,6 +47,11 @@ module Aws::CloudFormation
|
|
47
47
|
CausingEntity = Shapes::StringShape.new(name: 'CausingEntity')
|
48
48
|
Change = Shapes::StructureShape.new(name: 'Change')
|
49
49
|
ChangeAction = Shapes::StringShape.new(name: 'ChangeAction')
|
50
|
+
ChangeSetHook = Shapes::StructureShape.new(name: 'ChangeSetHook')
|
51
|
+
ChangeSetHookResourceTargetDetails = Shapes::StructureShape.new(name: 'ChangeSetHookResourceTargetDetails')
|
52
|
+
ChangeSetHookTargetDetails = Shapes::StructureShape.new(name: 'ChangeSetHookTargetDetails')
|
53
|
+
ChangeSetHooks = Shapes::ListShape.new(name: 'ChangeSetHooks')
|
54
|
+
ChangeSetHooksStatus = Shapes::StringShape.new(name: 'ChangeSetHooksStatus')
|
50
55
|
ChangeSetId = Shapes::StringShape.new(name: 'ChangeSetId')
|
51
56
|
ChangeSetName = Shapes::StringShape.new(name: 'ChangeSetName')
|
52
57
|
ChangeSetNameOrId = Shapes::StringShape.new(name: 'ChangeSetNameOrId')
|
@@ -91,6 +96,8 @@ module Aws::CloudFormation
|
|
91
96
|
DeregisterTypeOutput = Shapes::StructureShape.new(name: 'DeregisterTypeOutput')
|
92
97
|
DescribeAccountLimitsInput = Shapes::StructureShape.new(name: 'DescribeAccountLimitsInput')
|
93
98
|
DescribeAccountLimitsOutput = Shapes::StructureShape.new(name: 'DescribeAccountLimitsOutput')
|
99
|
+
DescribeChangeSetHooksInput = Shapes::StructureShape.new(name: 'DescribeChangeSetHooksInput')
|
100
|
+
DescribeChangeSetHooksOutput = Shapes::StructureShape.new(name: 'DescribeChangeSetHooksOutput')
|
94
101
|
DescribeChangeSetInput = Shapes::StructureShape.new(name: 'DescribeChangeSetInput')
|
95
102
|
DescribeChangeSetOutput = Shapes::StructureShape.new(name: 'DescribeChangeSetOutput')
|
96
103
|
DescribePublisherInput = Shapes::StructureShape.new(name: 'DescribePublisherInput')
|
@@ -152,6 +159,17 @@ module Aws::CloudFormation
|
|
152
159
|
GetTemplateSummaryInput = Shapes::StructureShape.new(name: 'GetTemplateSummaryInput')
|
153
160
|
GetTemplateSummaryOutput = Shapes::StructureShape.new(name: 'GetTemplateSummaryOutput')
|
154
161
|
HandlerErrorCode = Shapes::StringShape.new(name: 'HandlerErrorCode')
|
162
|
+
HookFailureMode = Shapes::StringShape.new(name: 'HookFailureMode')
|
163
|
+
HookInvocationCount = Shapes::IntegerShape.new(name: 'HookInvocationCount')
|
164
|
+
HookInvocationPoint = Shapes::StringShape.new(name: 'HookInvocationPoint')
|
165
|
+
HookStatus = Shapes::StringShape.new(name: 'HookStatus')
|
166
|
+
HookStatusReason = Shapes::StringShape.new(name: 'HookStatusReason')
|
167
|
+
HookTargetType = Shapes::StringShape.new(name: 'HookTargetType')
|
168
|
+
HookTargetTypeName = Shapes::StringShape.new(name: 'HookTargetTypeName')
|
169
|
+
HookType = Shapes::StringShape.new(name: 'HookType')
|
170
|
+
HookTypeConfigurationVersionId = Shapes::StringShape.new(name: 'HookTypeConfigurationVersionId')
|
171
|
+
HookTypeName = Shapes::StringShape.new(name: 'HookTypeName')
|
172
|
+
HookTypeVersionId = Shapes::StringShape.new(name: 'HookTypeVersionId')
|
155
173
|
IdentityProvider = Shapes::StringShape.new(name: 'IdentityProvider')
|
156
174
|
ImportStacksToStackSetInput = Shapes::StructureShape.new(name: 'ImportStacksToStackSetInput')
|
157
175
|
ImportStacksToStackSetOutput = Shapes::StructureShape.new(name: 'ImportStacksToStackSetOutput')
|
@@ -514,9 +532,29 @@ module Aws::CloudFormation
|
|
514
532
|
Capabilities.member = Shapes::ShapeRef.new(shape: Capability)
|
515
533
|
|
516
534
|
Change.add_member(:type, Shapes::ShapeRef.new(shape: ChangeType, location_name: "Type"))
|
535
|
+
Change.add_member(:hook_invocation_count, Shapes::ShapeRef.new(shape: HookInvocationCount, location_name: "HookInvocationCount"))
|
517
536
|
Change.add_member(:resource_change, Shapes::ShapeRef.new(shape: ResourceChange, location_name: "ResourceChange"))
|
518
537
|
Change.struct_class = Types::Change
|
519
538
|
|
539
|
+
ChangeSetHook.add_member(:invocation_point, Shapes::ShapeRef.new(shape: HookInvocationPoint, location_name: "InvocationPoint"))
|
540
|
+
ChangeSetHook.add_member(:failure_mode, Shapes::ShapeRef.new(shape: HookFailureMode, location_name: "FailureMode"))
|
541
|
+
ChangeSetHook.add_member(:type_name, Shapes::ShapeRef.new(shape: HookTypeName, location_name: "TypeName"))
|
542
|
+
ChangeSetHook.add_member(:type_version_id, Shapes::ShapeRef.new(shape: HookTypeVersionId, location_name: "TypeVersionId"))
|
543
|
+
ChangeSetHook.add_member(:type_configuration_version_id, Shapes::ShapeRef.new(shape: HookTypeConfigurationVersionId, location_name: "TypeConfigurationVersionId"))
|
544
|
+
ChangeSetHook.add_member(:target_details, Shapes::ShapeRef.new(shape: ChangeSetHookTargetDetails, location_name: "TargetDetails"))
|
545
|
+
ChangeSetHook.struct_class = Types::ChangeSetHook
|
546
|
+
|
547
|
+
ChangeSetHookResourceTargetDetails.add_member(:logical_resource_id, Shapes::ShapeRef.new(shape: LogicalResourceId, location_name: "LogicalResourceId"))
|
548
|
+
ChangeSetHookResourceTargetDetails.add_member(:resource_type, Shapes::ShapeRef.new(shape: HookTargetTypeName, location_name: "ResourceType"))
|
549
|
+
ChangeSetHookResourceTargetDetails.add_member(:resource_action, Shapes::ShapeRef.new(shape: ChangeAction, location_name: "ResourceAction"))
|
550
|
+
ChangeSetHookResourceTargetDetails.struct_class = Types::ChangeSetHookResourceTargetDetails
|
551
|
+
|
552
|
+
ChangeSetHookTargetDetails.add_member(:target_type, Shapes::ShapeRef.new(shape: HookTargetType, location_name: "TargetType"))
|
553
|
+
ChangeSetHookTargetDetails.add_member(:resource_target_details, Shapes::ShapeRef.new(shape: ChangeSetHookResourceTargetDetails, location_name: "ResourceTargetDetails"))
|
554
|
+
ChangeSetHookTargetDetails.struct_class = Types::ChangeSetHookTargetDetails
|
555
|
+
|
556
|
+
ChangeSetHooks.member = Shapes::ShapeRef.new(shape: ChangeSetHook)
|
557
|
+
|
520
558
|
ChangeSetNotFoundException.struct_class = Types::ChangeSetNotFoundException
|
521
559
|
|
522
560
|
ChangeSetSummaries.member = Shapes::ShapeRef.new(shape: ChangeSetSummary)
|
@@ -683,6 +721,21 @@ module Aws::CloudFormation
|
|
683
721
|
DescribeAccountLimitsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
684
722
|
DescribeAccountLimitsOutput.struct_class = Types::DescribeAccountLimitsOutput
|
685
723
|
|
724
|
+
DescribeChangeSetHooksInput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetNameOrId, required: true, location_name: "ChangeSetName"))
|
725
|
+
DescribeChangeSetHooksInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
|
726
|
+
DescribeChangeSetHooksInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
727
|
+
DescribeChangeSetHooksInput.add_member(:logical_resource_id, Shapes::ShapeRef.new(shape: LogicalResourceId, location_name: "LogicalResourceId"))
|
728
|
+
DescribeChangeSetHooksInput.struct_class = Types::DescribeChangeSetHooksInput
|
729
|
+
|
730
|
+
DescribeChangeSetHooksOutput.add_member(:change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "ChangeSetId"))
|
731
|
+
DescribeChangeSetHooksOutput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetName, location_name: "ChangeSetName"))
|
732
|
+
DescribeChangeSetHooksOutput.add_member(:hooks, Shapes::ShapeRef.new(shape: ChangeSetHooks, location_name: "Hooks"))
|
733
|
+
DescribeChangeSetHooksOutput.add_member(:status, Shapes::ShapeRef.new(shape: ChangeSetHooksStatus, location_name: "Status"))
|
734
|
+
DescribeChangeSetHooksOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
735
|
+
DescribeChangeSetHooksOutput.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, location_name: "StackId"))
|
736
|
+
DescribeChangeSetHooksOutput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackName, location_name: "StackName"))
|
737
|
+
DescribeChangeSetHooksOutput.struct_class = Types::DescribeChangeSetHooksOutput
|
738
|
+
|
686
739
|
DescribeChangeSetInput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetNameOrId, required: true, location_name: "ChangeSetName"))
|
687
740
|
DescribeChangeSetInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
|
688
741
|
DescribeChangeSetInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
@@ -1326,6 +1379,11 @@ module Aws::CloudFormation
|
|
1326
1379
|
StackEvent.add_member(:resource_status_reason, Shapes::ShapeRef.new(shape: ResourceStatusReason, location_name: "ResourceStatusReason"))
|
1327
1380
|
StackEvent.add_member(:resource_properties, Shapes::ShapeRef.new(shape: ResourceProperties, location_name: "ResourceProperties"))
|
1328
1381
|
StackEvent.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
1382
|
+
StackEvent.add_member(:hook_type, Shapes::ShapeRef.new(shape: HookType, location_name: "HookType"))
|
1383
|
+
StackEvent.add_member(:hook_status, Shapes::ShapeRef.new(shape: HookStatus, location_name: "HookStatus"))
|
1384
|
+
StackEvent.add_member(:hook_status_reason, Shapes::ShapeRef.new(shape: HookStatusReason, location_name: "HookStatusReason"))
|
1385
|
+
StackEvent.add_member(:hook_invocation_point, Shapes::ShapeRef.new(shape: HookInvocationPoint, location_name: "HookInvocationPoint"))
|
1386
|
+
StackEvent.add_member(:hook_failure_mode, Shapes::ShapeRef.new(shape: HookFailureMode, location_name: "HookFailureMode"))
|
1329
1387
|
StackEvent.struct_class = Types::StackEvent
|
1330
1388
|
|
1331
1389
|
StackEvents.member = Shapes::ShapeRef.new(shape: StackEvent)
|
@@ -1907,6 +1965,15 @@ module Aws::CloudFormation
|
|
1907
1965
|
o.errors << Shapes::ShapeRef.new(shape: ChangeSetNotFoundException)
|
1908
1966
|
end)
|
1909
1967
|
|
1968
|
+
api.add_operation(:describe_change_set_hooks, Seahorse::Model::Operation.new.tap do |o|
|
1969
|
+
o.name = "DescribeChangeSetHooks"
|
1970
|
+
o.http_method = "POST"
|
1971
|
+
o.http_request_uri = "/"
|
1972
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeChangeSetHooksInput)
|
1973
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeChangeSetHooksOutput)
|
1974
|
+
o.errors << Shapes::ShapeRef.new(shape: ChangeSetNotFoundException)
|
1975
|
+
end)
|
1976
|
+
|
1910
1977
|
api.add_operation(:describe_publisher, Seahorse::Model::Operation.new.tap do |o|
|
1911
1978
|
o.name = "DescribePublisher"
|
1912
1979
|
o.http_method = "POST"
|
@@ -115,6 +115,42 @@ module Aws::CloudFormation
|
|
115
115
|
data[:client_request_token]
|
116
116
|
end
|
117
117
|
|
118
|
+
# The name of the hook.
|
119
|
+
# @return [String]
|
120
|
+
def hook_type
|
121
|
+
data[:hook_type]
|
122
|
+
end
|
123
|
+
|
124
|
+
# Provides the status of the change set hook.
|
125
|
+
# @return [String]
|
126
|
+
def hook_status
|
127
|
+
data[:hook_status]
|
128
|
+
end
|
129
|
+
|
130
|
+
# Provides the reason for the hook status.
|
131
|
+
# @return [String]
|
132
|
+
def hook_status_reason
|
133
|
+
data[:hook_status_reason]
|
134
|
+
end
|
135
|
+
|
136
|
+
# Invocation points are points in provisioning logic where hooks are
|
137
|
+
# initiated.
|
138
|
+
# @return [String]
|
139
|
+
def hook_invocation_point
|
140
|
+
data[:hook_invocation_point]
|
141
|
+
end
|
142
|
+
|
143
|
+
# Specify the hook failure mode for non-compliant resources in the
|
144
|
+
# followings ways.
|
145
|
+
#
|
146
|
+
# * `FAIL` Stops provisioning resources.
|
147
|
+
#
|
148
|
+
# * `WARN` Allows provisioning to continue with a warning message.
|
149
|
+
# @return [String]
|
150
|
+
def hook_failure_mode
|
151
|
+
data[:hook_failure_mode]
|
152
|
+
end
|
153
|
+
|
118
154
|
# @!endgroup
|
119
155
|
|
120
156
|
# @return [Client]
|
@@ -78,18 +78,18 @@ module Aws::CloudFormation
|
|
78
78
|
# })
|
79
79
|
# @param [Hash] options ({})
|
80
80
|
# @option options [required, String] :stack_name
|
81
|
-
# The name that
|
81
|
+
# The name that's associated with the stack. The name must be unique in
|
82
82
|
# the Region in which you are creating the stack.
|
83
83
|
#
|
84
84
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
|
85
|
-
# and hyphens. It must start with an alphabetical character and
|
85
|
+
# and hyphens. It must start with an alphabetical character and can't
|
86
86
|
# be longer than 128 characters.
|
87
87
|
#
|
88
88
|
# </note>
|
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
|
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.
|
@@ -99,9 +99,9 @@ module Aws::CloudFormation
|
|
99
99
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
100
100
|
# @option options [String] :template_url
|
101
101
|
# Location of file containing the template body. The URL must point to a
|
102
|
-
# template (max size: 460,800 bytes) that
|
102
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
103
103
|
# bucket or a Systems Manager document. For more information, go to the
|
104
|
-
# [Template
|
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.
|
@@ -131,9 +131,9 @@ module Aws::CloudFormation
|
|
131
131
|
# CREATE\_FAILED; if `DisableRollback` is not set or is set to `false`,
|
132
132
|
# the stack will be rolled back.
|
133
133
|
# @option options [Array<String>] :notification_arns
|
134
|
-
# The Simple Notification Service (SNS) topic ARNs to
|
135
|
-
# related events. You can find your SNS topic ARNs
|
136
|
-
# or your Command Line Interface (CLI).
|
134
|
+
# The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
|
135
|
+
# publish stack related events. You can find your Amazon SNS topic ARNs
|
136
|
+
# using the Amazon SNS console 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
139
|
# template contains certain capabilities in order for CloudFormation to
|
@@ -166,7 +166,7 @@ module Aws::CloudFormation
|
|
166
166
|
#
|
167
167
|
# * [ AWS::IAM::Group][2]
|
168
168
|
#
|
169
|
-
# * [
|
169
|
+
# * [AWS::IAM::InstanceProfile][3]
|
170
170
|
#
|
171
171
|
# * [ AWS::IAM::Policy][4]
|
172
172
|
#
|
@@ -174,7 +174,7 @@ module Aws::CloudFormation
|
|
174
174
|
#
|
175
175
|
# * [ AWS::IAM::User][6]
|
176
176
|
#
|
177
|
-
# * [
|
177
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
178
178
|
#
|
179
179
|
# For more information, see [Acknowledging IAM Resources in
|
180
180
|
# CloudFormation Templates][8].
|
@@ -206,8 +206,8 @@ module Aws::CloudFormation
|
|
206
206
|
# can update the function operation without CloudFormation being
|
207
207
|
# notified.
|
208
208
|
#
|
209
|
-
# For more information, see [Using CloudFormation
|
210
|
-
#
|
209
|
+
# For more information, see [Using CloudFormation macros to perform
|
210
|
+
# custom processing on templates][11].
|
211
211
|
#
|
212
212
|
#
|
213
213
|
#
|
@@ -248,17 +248,17 @@ module Aws::CloudFormation
|
|
248
248
|
# (IAM) role that CloudFormation assumes to create the stack.
|
249
249
|
# CloudFormation uses the role's credentials to make calls on your
|
250
250
|
# behalf. CloudFormation always uses this role for all future operations
|
251
|
-
# on the stack.
|
251
|
+
# on the stack. Provided that users have permission to operate on the
|
252
252
|
# stack, CloudFormation uses this role even if the users don't have
|
253
253
|
# permission to pass it. Ensure that the role grants least privilege.
|
254
254
|
#
|
255
255
|
# If you don't specify a value, CloudFormation uses the role that was
|
256
256
|
# previously associated with the stack. If no role is available,
|
257
|
-
# CloudFormation uses a temporary session that
|
257
|
+
# CloudFormation uses a temporary session that's generated from your
|
258
258
|
# user credentials.
|
259
259
|
# @option options [String] :on_failure
|
260
260
|
# Determines what action will be taken if stack creation fails. This
|
261
|
-
# must be one of:
|
261
|
+
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
262
262
|
# either `OnFailure` or `DisableRollback`, but not both.
|
263
263
|
#
|
264
264
|
# Default: `ROLLBACK`
|
@@ -287,7 +287,7 @@ module Aws::CloudFormation
|
|
287
287
|
# retry `CreateStack` requests to ensure that CloudFormation
|
288
288
|
# successfully received them.
|
289
289
|
#
|
290
|
-
# All events
|
290
|
+
# All events initiated by a given stack operation are assigned the same
|
291
291
|
# client request token, which you can use to track operations. For
|
292
292
|
# example, if you execute a `CreateStack` operation with the token
|
293
293
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -305,11 +305,11 @@ module Aws::CloudFormation
|
|
305
305
|
# user attempts to delete a stack with termination protection enabled,
|
306
306
|
# the operation fails and the stack remains unchanged. For more
|
307
307
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
308
|
-
# *CloudFormation User Guide*. Termination protection is
|
308
|
+
# *CloudFormation User Guide*. Termination protection is deactivated on
|
309
309
|
# stacks by default.
|
310
310
|
#
|
311
311
|
# For [nested stacks][2], termination protection is set on the root
|
312
|
-
# stack and
|
312
|
+
# stack and can't be changed directly on the nested stack.
|
313
313
|
#
|
314
314
|
#
|
315
315
|
#
|
@@ -351,8 +351,8 @@ module Aws::CloudFormation
|
|
351
351
|
# })
|
352
352
|
# @param [Hash] options ({})
|
353
353
|
# @option options [String] :stack_name
|
354
|
-
# The name or the unique stack ID that
|
355
|
-
# which
|
354
|
+
# The name or the unique stack ID that's associated with the stack,
|
355
|
+
# which aren't always interchangeable:
|
356
356
|
#
|
357
357
|
# * Running stacks: You can specify either the stack's name or its
|
358
358
|
# unique stack ID.
|
@@ -100,15 +100,16 @@ module Aws::CloudFormation
|
|
100
100
|
|
101
101
|
# Boolean to enable or disable rollback on stack creation failures:
|
102
102
|
#
|
103
|
-
# * `true`\: disable rollback
|
103
|
+
# * `true`\: disable rollback.
|
104
104
|
#
|
105
|
-
# * `false`\: enable rollback
|
105
|
+
# * `false`\: enable rollback.
|
106
106
|
# @return [Boolean]
|
107
107
|
def disable_rollback
|
108
108
|
data[:disable_rollback]
|
109
109
|
end
|
110
110
|
|
111
|
-
# SNS topic ARNs to which stack related
|
111
|
+
# Amazon SNS topic Amazon Resource Names (ARNs) to which stack related
|
112
|
+
# events are published.
|
112
113
|
# @return [Array<String>]
|
113
114
|
def notification_arns
|
114
115
|
data[:notification_arns]
|
@@ -133,7 +134,7 @@ module Aws::CloudFormation
|
|
133
134
|
end
|
134
135
|
|
135
136
|
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
136
|
-
# (IAM) role that
|
137
|
+
# (IAM) role that's associated with the stack. During a stack
|
137
138
|
# operation, CloudFormation uses this role's credentials to make calls
|
138
139
|
# on your behalf.
|
139
140
|
# @return [String]
|
@@ -435,7 +436,7 @@ module Aws::CloudFormation
|
|
435
436
|
# @option options [String] :template_body
|
436
437
|
# Structure containing the template body with a minimum length of 1 byte
|
437
438
|
# and a maximum length of 51,200 bytes. For more information, go to
|
438
|
-
# [Template
|
439
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
439
440
|
#
|
440
441
|
# Conditional: You must specify either the `TemplateBody` or the
|
441
442
|
# `TemplateURL` parameter, but not both.
|
@@ -445,9 +446,9 @@ module Aws::CloudFormation
|
|
445
446
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
446
447
|
# @option options [String] :template_url
|
447
448
|
# Location of file containing the template body. The URL must point to a
|
448
|
-
# template (max size: 460,800 bytes) that
|
449
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
449
450
|
# bucket or a Systems Manager document. For more information, go to the
|
450
|
-
# [Template
|
451
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
451
452
|
#
|
452
453
|
# Conditional: You must specify either the `TemplateBody` or the
|
453
454
|
# `TemplateURL` parameter, but not both.
|
@@ -477,9 +478,9 @@ module Aws::CloudFormation
|
|
477
478
|
# CREATE\_FAILED; if `DisableRollback` is not set or is set to `false`,
|
478
479
|
# the stack will be rolled back.
|
479
480
|
# @option options [Array<String>] :notification_arns
|
480
|
-
# The Simple Notification Service (SNS) topic ARNs to
|
481
|
-
# related events. You can find your SNS topic ARNs
|
482
|
-
# or your Command Line Interface (CLI).
|
481
|
+
# The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
|
482
|
+
# publish stack related events. You can find your Amazon SNS topic ARNs
|
483
|
+
# using the Amazon SNS console or your Command Line Interface (CLI).
|
483
484
|
# @option options [Array<String>] :capabilities
|
484
485
|
# In some cases, you must explicitly acknowledge that your stack
|
485
486
|
# template contains certain capabilities in order for CloudFormation to
|
@@ -512,7 +513,7 @@ module Aws::CloudFormation
|
|
512
513
|
#
|
513
514
|
# * [ AWS::IAM::Group][2]
|
514
515
|
#
|
515
|
-
# * [
|
516
|
+
# * [AWS::IAM::InstanceProfile][3]
|
516
517
|
#
|
517
518
|
# * [ AWS::IAM::Policy][4]
|
518
519
|
#
|
@@ -520,7 +521,7 @@ module Aws::CloudFormation
|
|
520
521
|
#
|
521
522
|
# * [ AWS::IAM::User][6]
|
522
523
|
#
|
523
|
-
# * [
|
524
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
524
525
|
#
|
525
526
|
# For more information, see [Acknowledging IAM Resources in
|
526
527
|
# CloudFormation Templates][8].
|
@@ -552,8 +553,8 @@ module Aws::CloudFormation
|
|
552
553
|
# can update the function operation without CloudFormation being
|
553
554
|
# notified.
|
554
555
|
#
|
555
|
-
# For more information, see [Using CloudFormation
|
556
|
-
#
|
556
|
+
# For more information, see [Using CloudFormation macros to perform
|
557
|
+
# custom processing on templates][11].
|
557
558
|
#
|
558
559
|
#
|
559
560
|
#
|
@@ -594,17 +595,17 @@ module Aws::CloudFormation
|
|
594
595
|
# (IAM) role that CloudFormation assumes to create the stack.
|
595
596
|
# CloudFormation uses the role's credentials to make calls on your
|
596
597
|
# behalf. CloudFormation always uses this role for all future operations
|
597
|
-
# on the stack.
|
598
|
+
# on the stack. Provided that users have permission to operate on the
|
598
599
|
# stack, CloudFormation uses this role even if the users don't have
|
599
600
|
# permission to pass it. Ensure that the role grants least privilege.
|
600
601
|
#
|
601
602
|
# If you don't specify a value, CloudFormation uses the role that was
|
602
603
|
# previously associated with the stack. If no role is available,
|
603
|
-
# CloudFormation uses a temporary session that
|
604
|
+
# CloudFormation uses a temporary session that's generated from your
|
604
605
|
# user credentials.
|
605
606
|
# @option options [String] :on_failure
|
606
607
|
# Determines what action will be taken if stack creation fails. This
|
607
|
-
# must be one of:
|
608
|
+
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
608
609
|
# either `OnFailure` or `DisableRollback`, but not both.
|
609
610
|
#
|
610
611
|
# Default: `ROLLBACK`
|
@@ -633,7 +634,7 @@ module Aws::CloudFormation
|
|
633
634
|
# retry `CreateStack` requests to ensure that CloudFormation
|
634
635
|
# successfully received them.
|
635
636
|
#
|
636
|
-
# All events
|
637
|
+
# All events initiated by a given stack operation are assigned the same
|
637
638
|
# client request token, which you can use to track operations. For
|
638
639
|
# example, if you execute a `CreateStack` operation with the token
|
639
640
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -651,11 +652,11 @@ module Aws::CloudFormation
|
|
651
652
|
# user attempts to delete a stack with termination protection enabled,
|
652
653
|
# the operation fails and the stack remains unchanged. For more
|
653
654
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
654
|
-
# *CloudFormation User Guide*. Termination protection is
|
655
|
+
# *CloudFormation User Guide*. Termination protection is deactivated on
|
655
656
|
# stacks by default.
|
656
657
|
#
|
657
658
|
# For [nested stacks][2], termination protection is set on the root
|
658
|
-
# stack and
|
659
|
+
# stack and can't be changed directly on the nested stack.
|
659
660
|
#
|
660
661
|
#
|
661
662
|
#
|
@@ -679,10 +680,10 @@ module Aws::CloudFormation
|
|
679
680
|
# @option options [Array<String>] :retain_resources
|
680
681
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
681
682
|
# IDs that are associated with the resources you want to retain. During
|
682
|
-
# deletion, CloudFormation deletes the stack but
|
683
|
+
# deletion, CloudFormation deletes the stack but doesn't delete the
|
683
684
|
# retained resources.
|
684
685
|
#
|
685
|
-
# Retaining resources is useful when you
|
686
|
+
# Retaining resources is useful when you can't delete a resource, such
|
686
687
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
687
688
|
# @option options [String] :role_arn
|
688
689
|
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
@@ -692,7 +693,7 @@ module Aws::CloudFormation
|
|
692
693
|
#
|
693
694
|
# If you don't specify a value, CloudFormation uses the role that was
|
694
695
|
# previously associated with the stack. If no role is available,
|
695
|
-
# CloudFormation uses a temporary session that
|
696
|
+
# CloudFormation uses a temporary session that's generated from your
|
696
697
|
# user credentials.
|
697
698
|
# @option options [String] :client_request_token
|
698
699
|
# A unique identifier for this `DeleteStack` request. Specify this token
|
@@ -701,7 +702,7 @@ module Aws::CloudFormation
|
|
701
702
|
# retry `DeleteStack` requests to ensure that CloudFormation
|
702
703
|
# successfully received them.
|
703
704
|
#
|
704
|
-
# All events
|
705
|
+
# All events initiated by a given stack operation are assigned the same
|
705
706
|
# client request token, which you can use to track operations. For
|
706
707
|
# example, if you execute a `CreateStack` operation with the token
|
707
708
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -776,7 +777,7 @@ module Aws::CloudFormation
|
|
776
777
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
777
778
|
# @option options [String] :template_url
|
778
779
|
# Location of file containing the template body. The URL must point to a
|
779
|
-
# template that
|
780
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
780
781
|
# document. For more information, go to [Template Anatomy][1] in the
|
781
782
|
# CloudFormation User Guide.
|
782
783
|
#
|
@@ -853,7 +854,7 @@ module Aws::CloudFormation
|
|
853
854
|
#
|
854
855
|
# * [ AWS::IAM::Group][2]
|
855
856
|
#
|
856
|
-
# * [
|
857
|
+
# * [AWS::IAM::InstanceProfile][3]
|
857
858
|
#
|
858
859
|
# * [ AWS::IAM::Policy][4]
|
859
860
|
#
|
@@ -861,7 +862,7 @@ module Aws::CloudFormation
|
|
861
862
|
#
|
862
863
|
# * [ AWS::IAM::User][6]
|
863
864
|
#
|
864
|
-
# * [
|
865
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
865
866
|
#
|
866
867
|
# For more information, see [Acknowledging IAM Resources in
|
867
868
|
# CloudFormation Templates][8].
|
@@ -929,7 +930,7 @@ module Aws::CloudFormation
|
|
929
930
|
# (IAM) role that CloudFormation assumes to update the stack.
|
930
931
|
# CloudFormation uses the role's credentials to make calls on your
|
931
932
|
# behalf. CloudFormation always uses this role for all future operations
|
932
|
-
# on the stack.
|
933
|
+
# on the stack. Provided that users have permission to operate on the
|
933
934
|
# stack, CloudFormation uses this role even if the users don't have
|
934
935
|
# permission to pass it. Ensure that the role grants least privilege.
|
935
936
|
#
|
@@ -946,7 +947,7 @@ module Aws::CloudFormation
|
|
946
947
|
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
947
948
|
#
|
948
949
|
# You might update the stack policy, for example, in order to protect a
|
949
|
-
# new resource that you created during a stack update. If you
|
950
|
+
# new resource that you created during a stack update. If you don't
|
950
951
|
# specify a stack policy, the current policy that is associated with the
|
951
952
|
# stack is unchanged.
|
952
953
|
# @option options [String] :stack_policy_url
|
@@ -956,7 +957,7 @@ module Aws::CloudFormation
|
|
956
957
|
# the `StackPolicyURL` parameter, but not both.
|
957
958
|
#
|
958
959
|
# You might update the stack policy, for example, in order to protect a
|
959
|
-
# new resource that you created during a stack update. If you
|
960
|
+
# new resource that you created during a stack update. If you don't
|
960
961
|
# specify a stack policy, the current policy that is associated with the
|
961
962
|
# stack is unchanged.
|
962
963
|
# @option options [Array<String>] :notification_arns
|
@@ -56,8 +56,8 @@ module Aws::CloudFormation
|
|
56
56
|
data[:physical_resource_id]
|
57
57
|
end
|
58
58
|
|
59
|
-
# Type of resource.
|
60
|
-
# Resource Types Reference][1] in the CloudFormation User Guide.
|
59
|
+
# Type of resource. For more information, go to [Amazon Web Services
|
60
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.
|
61
61
|
#
|
62
62
|
#
|
63
63
|
#
|