aws-sdk-cloudformation 1.31.0 → 1.32.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -148,7 +148,8 @@ module Aws::CloudFormation
148
148
  # Waiter polls an API operation until a resource enters a desired
149
149
  # state.
150
150
  #
151
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
151
+ # @note The waiting operation is performed on a copy. The original resource
152
+ # remains unchanged.
152
153
  #
153
154
  # ## Basic Usage
154
155
  #
@@ -161,13 +162,15 @@ module Aws::CloudFormation
161
162
  #
162
163
  # ## Example
163
164
  #
164
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
165
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
166
+ # instance.state.name == 'running'
167
+ # end
165
168
  #
166
169
  # ## Configuration
167
170
  #
168
171
  # You can configure the maximum number of polling attempts, and the
169
- # delay (in seconds) between each polling attempt. The waiting condition is set
170
- # by passing a block to {#wait_until}:
172
+ # delay (in seconds) between each polling attempt. The waiting condition is
173
+ # set by passing a block to {#wait_until}:
171
174
  #
172
175
  # # poll for ~25 seconds
173
176
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -198,17 +201,16 @@ module Aws::CloudFormation
198
201
  # # resource did not enter the desired state in time
199
202
  # end
200
203
  #
204
+ # @yieldparam [Resource] resource to be used in the waiting condition.
201
205
  #
202
- # @yield param [Resource] resource to be used in the waiting condition
203
- #
204
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
205
- # because the waiter has entered a state that it will not transition
206
- # out of, preventing success.
206
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
207
+ # terminates because the waiter has entered a state that it will not
208
+ # transition out of, preventing success.
207
209
  #
208
210
  # yet successful.
209
211
  #
210
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
211
- # while polling for a resource that is not expected.
212
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
213
+ # encountered while polling for a resource that is not expected.
212
214
  #
213
215
  # @raise [NotImplementedError] Raised when the resource does not
214
216
  #
@@ -6,13 +6,18 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CloudFormation
9
+
9
10
  # This class provides a resource oriented interface for CloudFormation.
10
11
  # To create a resource object:
12
+ #
11
13
  # resource = Aws::CloudFormation::Resource.new(region: 'us-west-2')
14
+ #
12
15
  # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
16
+ # If you do not pass `:client`, a default client will be constructed.
17
+ #
14
18
  # client = Aws::CloudFormation::Client.new(region: 'us-west-2')
15
19
  # resource = Aws::CloudFormation::Resource.new(client: client)
20
+ #
16
21
  class Resource
17
22
 
18
23
  # @param options ({})
@@ -72,7 +77,7 @@ module Aws::CloudFormation
72
77
  # @param [Hash] options ({})
73
78
  # @option options [required, String] :stack_name
74
79
  # The name that is associated with the stack. The name must be unique in
75
- # the region in which you are creating the stack.
80
+ # the Region in which you are creating the stack.
76
81
  #
77
82
  # <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
78
83
  # and hyphens. It must start with an alphabetic character and cannot be
@@ -268,7 +273,7 @@ module Aws::CloudFormation
268
273
  # @option options [String] :stack_policy_url
269
274
  # Location of a file containing the stack policy. The URL must point to
270
275
  # a policy (maximum size: 16 KB) located in an S3 bucket in the same
271
- # region as the stack. You can specify either the `StackPolicyBody` or
276
+ # Region as the stack. You can specify either the `StackPolicyBody` or
272
277
  # the `StackPolicyURL` parameter, but not both.
273
278
  # @option options [Array<Types::Tag>] :tags
274
279
  # Key-value pairs to associate with this stack. AWS CloudFormation also
@@ -276,7 +276,8 @@ module Aws::CloudFormation
276
276
  # Waiter polls an API operation until a resource enters a desired
277
277
  # state.
278
278
  #
279
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
279
+ # @note The waiting operation is performed on a copy. The original resource
280
+ # remains unchanged.
280
281
  #
281
282
  # ## Basic Usage
282
283
  #
@@ -289,13 +290,15 @@ module Aws::CloudFormation
289
290
  #
290
291
  # ## Example
291
292
  #
292
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
293
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
294
+ # instance.state.name == 'running'
295
+ # end
293
296
  #
294
297
  # ## Configuration
295
298
  #
296
299
  # You can configure the maximum number of polling attempts, and the
297
- # delay (in seconds) between each polling attempt. The waiting condition is set
298
- # by passing a block to {#wait_until}:
300
+ # delay (in seconds) between each polling attempt. The waiting condition is
301
+ # set by passing a block to {#wait_until}:
299
302
  #
300
303
  # # poll for ~25 seconds
301
304
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -326,17 +329,16 @@ module Aws::CloudFormation
326
329
  # # resource did not enter the desired state in time
327
330
  # end
328
331
  #
332
+ # @yieldparam [Resource] resource to be used in the waiting condition.
329
333
  #
330
- # @yield param [Resource] resource to be used in the waiting condition
331
- #
332
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
333
- # because the waiter has entered a state that it will not transition
334
- # out of, preventing success.
334
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
335
+ # terminates because the waiter has entered a state that it will not
336
+ # transition out of, preventing success.
335
337
  #
336
338
  # yet successful.
337
339
  #
338
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
339
- # while polling for a resource that is not expected.
340
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
341
+ # encountered while polling for a resource that is not expected.
340
342
  #
341
343
  # @raise [NotImplementedError] Raised when the resource does not
342
344
  #
@@ -617,7 +619,7 @@ module Aws::CloudFormation
617
619
  # @option options [String] :stack_policy_url
618
620
  # Location of a file containing the stack policy. The URL must point to
619
621
  # a policy (maximum size: 16 KB) located in an S3 bucket in the same
620
- # region as the stack. You can specify either the `StackPolicyBody` or
622
+ # Region as the stack. You can specify either the `StackPolicyBody` or
621
623
  # the `StackPolicyURL` parameter, but not both.
622
624
  # @option options [Array<Types::Tag>] :tags
623
625
  # Key-value pairs to associate with this stack. AWS CloudFormation also
@@ -801,7 +803,7 @@ module Aws::CloudFormation
801
803
  # @option options [String] :stack_policy_during_update_url
802
804
  # Location of a file containing the temporary overriding stack policy.
803
805
  # The URL must point to a policy (max size: 16KB) located in an S3
804
- # bucket in the same region as the stack. You can specify either the
806
+ # bucket in the same Region as the stack. You can specify either the
805
807
  # `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL`
806
808
  # parameter, but not both.
807
809
  #
@@ -949,7 +951,7 @@ module Aws::CloudFormation
949
951
  # @option options [String] :stack_policy_url
950
952
  # Location of a file containing the updated stack policy. The URL must
951
953
  # point to a policy (max size: 16KB) located in an S3 bucket in the same
952
- # region as the stack. You can specify either the `StackPolicyBody` or
954
+ # Region as the stack. You can specify either the `StackPolicyBody` or
953
955
  # the `StackPolicyURL` parameter, but not both.
954
956
  #
955
957
  # You might update the stack policy, for example, in order to protect a
@@ -1087,7 +1089,9 @@ module Aws::CloudFormation
1087
1089
  end
1088
1090
 
1089
1091
  def separate_params_and_options(options)
1090
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
1092
+ opts = Set.new(
1093
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
1094
+ )
1091
1095
  waiter_opts = {}
1092
1096
  waiter_params = {}
1093
1097
  options.each_pair do |key, value|
@@ -158,7 +158,8 @@ module Aws::CloudFormation
158
158
  # Waiter polls an API operation until a resource enters a desired
159
159
  # state.
160
160
  #
161
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
161
+ # @note The waiting operation is performed on a copy. The original resource
162
+ # remains unchanged.
162
163
  #
163
164
  # ## Basic Usage
164
165
  #
@@ -171,13 +172,15 @@ module Aws::CloudFormation
171
172
  #
172
173
  # ## Example
173
174
  #
174
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
175
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
176
+ # instance.state.name == 'running'
177
+ # end
175
178
  #
176
179
  # ## Configuration
177
180
  #
178
181
  # You can configure the maximum number of polling attempts, and the
179
- # delay (in seconds) between each polling attempt. The waiting condition is set
180
- # by passing a block to {#wait_until}:
182
+ # delay (in seconds) between each polling attempt. The waiting condition is
183
+ # set by passing a block to {#wait_until}:
181
184
  #
182
185
  # # poll for ~25 seconds
183
186
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -208,17 +211,16 @@ module Aws::CloudFormation
208
211
  # # resource did not enter the desired state in time
209
212
  # end
210
213
  #
214
+ # @yieldparam [Resource] resource to be used in the waiting condition.
211
215
  #
212
- # @yield param [Resource] resource to be used in the waiting condition
213
- #
214
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
215
- # because the waiter has entered a state that it will not transition
216
- # out of, preventing success.
216
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
217
+ # terminates because the waiter has entered a state that it will not
218
+ # transition out of, preventing success.
217
219
  #
218
220
  # yet successful.
219
221
  #
220
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
221
- # while polling for a resource that is not expected.
222
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
223
+ # encountered while polling for a resource that is not expected.
222
224
  #
223
225
  # @raise [NotImplementedError] Raised when the resource does not
224
226
  #
@@ -126,7 +126,8 @@ module Aws::CloudFormation
126
126
  # Waiter polls an API operation until a resource enters a desired
127
127
  # state.
128
128
  #
129
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
129
+ # @note The waiting operation is performed on a copy. The original resource
130
+ # remains unchanged.
130
131
  #
131
132
  # ## Basic Usage
132
133
  #
@@ -139,13 +140,15 @@ module Aws::CloudFormation
139
140
  #
140
141
  # ## Example
141
142
  #
142
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
143
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
144
+ # instance.state.name == 'running'
145
+ # end
143
146
  #
144
147
  # ## Configuration
145
148
  #
146
149
  # You can configure the maximum number of polling attempts, and the
147
- # delay (in seconds) between each polling attempt. The waiting condition is set
148
- # by passing a block to {#wait_until}:
150
+ # delay (in seconds) between each polling attempt. The waiting condition is
151
+ # set by passing a block to {#wait_until}:
149
152
  #
150
153
  # # poll for ~25 seconds
151
154
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -176,17 +179,16 @@ module Aws::CloudFormation
176
179
  # # resource did not enter the desired state in time
177
180
  # end
178
181
  #
182
+ # @yieldparam [Resource] resource to be used in the waiting condition.
179
183
  #
180
- # @yield param [Resource] resource to be used in the waiting condition
181
- #
182
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
183
- # because the waiter has entered a state that it will not transition
184
- # out of, preventing success.
184
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
185
+ # terminates because the waiter has entered a state that it will not
186
+ # transition out of, preventing success.
185
187
  #
186
188
  # yet successful.
187
189
  #
188
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
189
- # while polling for a resource that is not expected.
190
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
191
+ # encountered while polling for a resource that is not expected.
190
192
  #
191
193
  # @raise [NotImplementedError] Raised when the resource does not
192
194
  #
@@ -10,16 +10,16 @@ module Aws::CloudFormation
10
10
 
11
11
  # Structure that contains the results of the account gate function which
12
12
  # AWS CloudFormation invokes, if present, before proceeding with a stack
13
- # set operation in an account and region.
13
+ # set operation in an account and Region.
14
14
  #
15
- # For each account and region, AWS CloudFormation lets you specify a
15
+ # For each account and Region, AWS CloudFormation lets you specify a
16
16
  # Lamdba function that encapsulates any requirements that must be met
17
17
  # before CloudFormation can proceed with a stack set operation in that
18
- # account and region. CloudFormation invokes the function each time a
19
- # stack set operation is requested for that account and region; if the
18
+ # account and Region. CloudFormation invokes the function each time a
19
+ # stack set operation is requested for that account and Region; if the
20
20
  # function returns `FAILED`, CloudFormation cancels the operation in
21
- # that account and region, and sets the stack set operation result
22
- # status for that account and region to `FAILED`.
21
+ # that account and Region, and sets the stack set operation result
22
+ # status for that account and Region to `FAILED`.
23
23
  #
24
24
  # For more information, see [Configuring a target account gate][1].
25
25
  #
@@ -31,37 +31,37 @@ module Aws::CloudFormation
31
31
  # The status of the account gate function.
32
32
  #
33
33
  # * `SUCCEEDED`\: The account gate function has determined that the
34
- # account and region passes any requirements for a stack set
34
+ # account and Region passes any requirements for a stack set
35
35
  # operation to occur. AWS CloudFormation proceeds with the stack
36
- # operation in that account and region.
36
+ # operation in that account and Region.
37
37
  #
38
38
  # * `FAILED`\: The account gate function has determined that the
39
- # account and region does not meet the requirements for a stack set
39
+ # account and Region does not meet the requirements for a stack set
40
40
  # operation to occur. AWS CloudFormation cancels the stack set
41
- # operation in that account and region, and sets the stack set
42
- # operation result status for that account and region to `FAILED`.
41
+ # operation in that account and Region, and sets the stack set
42
+ # operation result status for that account and Region to `FAILED`.
43
43
  #
44
44
  # * `SKIPPED`\: AWS CloudFormation has skipped calling the account
45
- # gate function for this account and region, for one of the
45
+ # gate function for this account and Region, for one of the
46
46
  # following reasons:
47
47
  #
48
48
  # * An account gate function has not been specified for the account
49
- # and region. AWS CloudFormation proceeds with the stack set
50
- # operation in this account and region.
49
+ # and Region. AWS CloudFormation proceeds with the stack set
50
+ # operation in this account and Region.
51
51
  #
52
52
  # * The `AWSCloudFormationStackSetExecutionRole` of the stack set
53
53
  # adminstration account lacks permissions to invoke the function.
54
54
  # AWS CloudFormation proceeds with the stack set operation in this
55
- # account and region.
55
+ # account and Region.
56
56
  #
57
57
  # * Either no action is necessary, or no action is possible, on the
58
58
  # stack. AWS CloudFormation skips the stack set operation in this
59
- # account and region.
59
+ # account and Region.
60
60
  # @return [String]
61
61
  #
62
62
  # @!attribute [rw] status_reason
63
63
  # The reason for the account gate status assigned to this account and
64
- # region for the stack set operation.
64
+ # Region for the stack set operation.
65
65
  # @return [String]
66
66
  #
67
67
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/AccountGateResult AWS API Documentation
@@ -752,7 +752,7 @@ module Aws::CloudFormation
752
752
  #
753
753
  # @!attribute [rw] stack_name
754
754
  # The name that is associated with the stack. The name must be unique
755
- # in the region in which you are creating the stack.
755
+ # in the Region in which you are creating the stack.
756
756
  #
757
757
  # <note markdown="1"> A stack name can contain only alphanumeric characters (case
758
758
  # sensitive) and hyphens. It must start with an alphabetic character
@@ -976,7 +976,7 @@ module Aws::CloudFormation
976
976
  # @!attribute [rw] stack_policy_url
977
977
  # Location of a file containing the stack policy. The URL must point
978
978
  # to a policy (maximum size: 16 KB) located in an S3 bucket in the
979
- # same region as the stack. You can specify either the
979
+ # same Region as the stack. You can specify either the
980
980
  # `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
981
981
  # @return [String]
982
982
  #
@@ -1083,8 +1083,8 @@ module Aws::CloudFormation
1083
1083
  # @return [String]
1084
1084
  #
1085
1085
  # @!attribute [rw] accounts
1086
- # \[Self-managed permissions\] The names of one or more AWS accounts
1087
- # that you want to create stack instances in the specified region(s)
1086
+ # \[`Self-managed` permissions\] The names of one or more AWS accounts
1087
+ # that you want to create stack instances in the specified Region(s)
1088
1088
  # for.
1089
1089
  #
1090
1090
  # You can specify `Accounts` or `DeploymentTargets`, but not both.
@@ -1098,7 +1098,7 @@ module Aws::CloudFormation
1098
1098
  # @return [Types::DeploymentTargets]
1099
1099
  #
1100
1100
  # @!attribute [rw] regions
1101
- # The names of one or more regions where you want to create stack
1101
+ # The names of one or more Regions where you want to create stack
1102
1102
  # instances using the specified AWS account(s).
1103
1103
  # @return [Array<String>]
1104
1104
  #
@@ -1107,7 +1107,7 @@ module Aws::CloudFormation
1107
1107
  # the selected stack instances.
1108
1108
  #
1109
1109
  # Any overridden parameter values will be applied to all stack
1110
- # instances in the specified accounts and regions. When specifying
1110
+ # instances in the specified accounts and Regions. When specifying
1111
1111
  # parameters and their values, be aware of how AWS CloudFormation sets
1112
1112
  # parameter values during stack instance operations:
1113
1113
  #
@@ -1238,7 +1238,7 @@ module Aws::CloudFormation
1238
1238
  #
1239
1239
  # @!attribute [rw] stack_set_name
1240
1240
  # The name to associate with the stack set. The name must be unique in
1241
- # the region where you create your stack set.
1241
+ # the Region where you create your stack set.
1242
1242
  #
1243
1243
  # <note markdown="1"> A stack name can contain only alphanumeric characters
1244
1244
  # (case-sensitive) and hyphens. It must start with an alphabetic
@@ -1425,9 +1425,6 @@ module Aws::CloudFormation
1425
1425
  # Organizations accounts that are added to the target organization or
1426
1426
  # organizational unit (OU). Specify only if `PermissionModel` is
1427
1427
  # `SERVICE_MANAGED`.
1428
- #
1429
- # If you specify `AutoDeployment`, do not specify `DeploymentTargets`
1430
- # or `Regions`.
1431
1428
  # @return [Types::AutoDeployment]
1432
1429
  #
1433
1430
  # @!attribute [rw] client_request_token
@@ -1611,8 +1608,8 @@ module Aws::CloudFormation
1611
1608
  # @return [String]
1612
1609
  #
1613
1610
  # @!attribute [rw] accounts
1614
- # \[Self-managed permissions\] The names of the AWS accounts that you
1615
- # want to delete stack instances for.
1611
+ # \[`Self-managed` permissions\] The names of the AWS accounts that
1612
+ # you want to delete stack instances for.
1616
1613
  #
1617
1614
  # You can specify `Accounts` or `DeploymentTargets`, but not both.
1618
1615
  # @return [Array<String>]
@@ -1625,7 +1622,7 @@ module Aws::CloudFormation
1625
1622
  # @return [Types::DeploymentTargets]
1626
1623
  #
1627
1624
  # @!attribute [rw] regions
1628
- # The regions where you want to delete stack set instances.
1625
+ # The Regions where you want to delete stack set instances.
1629
1626
  # @return [Array<String>]
1630
1627
  #
1631
1628
  # @!attribute [rw] operation_preferences
@@ -1712,7 +1709,9 @@ module Aws::CloudFormation
1712
1709
  class DeleteStackSetOutput < Aws::EmptyStructure; end
1713
1710
 
1714
1711
  # \[`Service-managed` permissions\] The AWS Organizations accounts to
1715
- # which StackSets deploys.
1712
+ # which StackSets deploys. StackSets does not deploy stack instances to
1713
+ # the organization master account, even if the master account is in your
1714
+ # organization or in an OU in your organization.
1716
1715
  #
1717
1716
  # For update operations, you can specify either `Accounts` or
1718
1717
  # `OrganizationalUnitIds`. For create and delete operations, specify
@@ -1732,7 +1731,7 @@ module Aws::CloudFormation
1732
1731
  # @return [Array<String>]
1733
1732
  #
1734
1733
  # @!attribute [rw] organizational_unit_ids
1735
- # The organization root ID or organizational unit (OUs) IDs to which
1734
+ # The organization root ID or organizational unit (OU) IDs to which
1736
1735
  # StackSets deploys.
1737
1736
  # @return [Array<String>]
1738
1737
  #
@@ -2161,7 +2160,7 @@ module Aws::CloudFormation
2161
2160
  # @return [String]
2162
2161
  #
2163
2162
  # @!attribute [rw] stack_instance_region
2164
- # The name of a region that's associated with this stack instance.
2163
+ # The name of a Region that's associated with this stack instance.
2165
2164
  # @return [String]
2166
2165
  #
2167
2166
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstanceInput AWS API Documentation
@@ -3519,7 +3518,7 @@ module Aws::CloudFormation
3519
3518
  # @return [String]
3520
3519
  #
3521
3520
  # @!attribute [rw] stack_instance_region
3522
- # The name of the region where you want to list stack instances.
3521
+ # The name of the Region where you want to list stack instances.
3523
3522
  # @return [String]
3524
3523
  #
3525
3524
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstancesInput AWS API Documentation
@@ -3658,7 +3657,7 @@ module Aws::CloudFormation
3658
3657
  # @!attribute [rw] summaries
3659
3658
  # A list of `StackSetOperationResultSummary` structures that contain
3660
3659
  # information about the specified operation results, for accounts and
3661
- # regions that are included in the operation.
3660
+ # Regions that are included in the operation.
3662
3661
  # @return [Array<Types::StackSetOperationResultSummary>]
3663
3662
  #
3664
3663
  # @!attribute [rw] next_token
@@ -5019,7 +5018,7 @@ module Aws::CloudFormation
5019
5018
  # @!attribute [rw] stack_policy_url
5020
5019
  # Location of a file containing the stack policy. The URL must point
5021
5020
  # to a policy (maximum size: 16 KB) located in an S3 bucket in the
5022
- # same region as the stack. You can specify either the
5021
+ # same Region as the stack. You can specify either the
5023
5022
  # `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
5024
5023
  # @return [String]
5025
5024
  #
@@ -5452,9 +5451,9 @@ module Aws::CloudFormation
5452
5451
  include Aws::Structure
5453
5452
  end
5454
5453
 
5455
- # An AWS CloudFormation stack, in a specific account and region, that's
5454
+ # An AWS CloudFormation stack, in a specific account and Region, that's
5456
5455
  # part of a stack set operation. A stack instance is a reference to an
5457
- # attempted or actual stack in a given account within a given region. A
5456
+ # attempted or actual stack in a given account within a given Region. A
5458
5457
  # stack instance can exist without a stack—for example, if the stack
5459
5458
  # couldn't be created for some reason. A stack instance is associated
5460
5459
  # with only one stack set. Each stack instance contains the ID of its
@@ -5467,12 +5466,12 @@ module Aws::CloudFormation
5467
5466
  # @return [String]
5468
5467
  #
5469
5468
  # @!attribute [rw] region
5470
- # The name of the AWS region that the stack instance is associated
5469
+ # The name of the AWS Region that the stack instance is associated
5471
5470
  # with.
5472
5471
  # @return [String]
5473
5472
  #
5474
5473
  # @!attribute [rw] account
5475
- # \[Self-managed permissions\] The name of the AWS account that the
5474
+ # \[`Self-managed` permissions\] The name of the AWS account that the
5476
5475
  # stack instance is associated with.
5477
5476
  # @return [String]
5478
5477
  #
@@ -5515,9 +5514,7 @@ module Aws::CloudFormation
5515
5514
  # @return [String]
5516
5515
  #
5517
5516
  # @!attribute [rw] organizational_unit_id
5518
- # \[`Service-managed` permissions\] The organization root ID or
5519
- # organizational unit (OU) ID that the stack instance is associated
5520
- # with.
5517
+ # Reserved for internal use. No data returned.
5521
5518
  # @return [String]
5522
5519
  #
5523
5520
  # @!attribute [rw] drift_status
@@ -5576,12 +5573,12 @@ module Aws::CloudFormation
5576
5573
  # @return [String]
5577
5574
  #
5578
5575
  # @!attribute [rw] region
5579
- # The name of the AWS region that the stack instance is associated
5576
+ # The name of the AWS Region that the stack instance is associated
5580
5577
  # with.
5581
5578
  # @return [String]
5582
5579
  #
5583
5580
  # @!attribute [rw] account
5584
- # \[Self-managed permissions\] The name of the AWS account that the
5581
+ # \[`Self-managed` permissions\] The name of the AWS account that the
5585
5582
  # stack instance is associated with.
5586
5583
  # @return [String]
5587
5584
  #
@@ -5619,9 +5616,7 @@ module Aws::CloudFormation
5619
5616
  # @return [String]
5620
5617
  #
5621
5618
  # @!attribute [rw] organizational_unit_id
5622
- # \[`Service-managed` permissions\] The organization root ID or
5623
- # organizational unit (OU) ID that the stack instance is associated
5624
- # with.
5619
+ # Reserved for internal use. No data returned.
5625
5620
  # @return [String]
5626
5621
  #
5627
5622
  # @!attribute [rw] drift_status
@@ -6072,7 +6067,7 @@ module Aws::CloudFormation
6072
6067
  end
6073
6068
 
6074
6069
  # A structure that contains information about a stack set. A stack set
6075
- # enables you to provision stacks into AWS accounts and across regions
6070
+ # enables you to provision stacks into AWS accounts and across Regions
6076
6071
  # by using a single CloudFormation template. In the stack set, you
6077
6072
  # specify the template to use, as well as any parameters and
6078
6073
  # capabilities that the template requires.
@@ -6182,9 +6177,7 @@ module Aws::CloudFormation
6182
6177
  # @return [String]
6183
6178
  #
6184
6179
  # @!attribute [rw] organizational_unit_ids
6185
- # \[`Service-managed` permissions\] The organization root ID or
6186
- # organizational unit (OUs) IDs to which stacks in your stack set have
6187
- # been deployed.
6180
+ # Reserved for internal use. No data returned.
6188
6181
  # @return [Array<String>]
6189
6182
  #
6190
6183
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSet AWS API Documentation
@@ -6357,15 +6350,15 @@ module Aws::CloudFormation
6357
6350
  #
6358
6351
  # * `FAILED`\: The operation exceeded the specified failure tolerance.
6359
6352
  # The failure tolerance value that you've set for an operation is
6360
- # applied for each region during stack create and update operations.
6361
- # If the number of failed stacks within a region exceeds the failure
6362
- # tolerance, the status of the operation in the region is set to
6353
+ # applied for each Region during stack create and update operations.
6354
+ # If the number of failed stacks within a Region exceeds the failure
6355
+ # tolerance, the status of the operation in the Region is set to
6363
6356
  # `FAILED`. This in turn sets the status of the operation as a whole
6364
6357
  # to `FAILED`, and AWS CloudFormation cancels the operation in any
6365
- # remaining regions.
6358
+ # remaining Regions.
6366
6359
  #
6367
- # * `QUEUED`\: \[Service-managed permissions\] For automatic
6368
- # deployments that require a sequence of operations. The operation
6360
+ # * `QUEUED`\: \[`Service-managed` permissions\] For automatic
6361
+ # deployments that require a sequence of operations, the operation
6369
6362
  # is queued to be performed. For more information, see the [stack
6370
6363
  # set operation status codes][1] in the AWS CloudFormation User
6371
6364
  # Guide.
@@ -6425,15 +6418,15 @@ module Aws::CloudFormation
6425
6418
  # creation times for the stack set operation might differ from the
6426
6419
  # creation time of the individual stacks themselves. This is because
6427
6420
  # AWS CloudFormation needs to perform preparatory work for the
6428
- # operation, such as dispatching the work to the requested regions,
6421
+ # operation, such as dispatching the work to the requested Regions,
6429
6422
  # before actually creating the first stacks.
6430
6423
  # @return [Time]
6431
6424
  #
6432
6425
  # @!attribute [rw] end_timestamp
6433
6426
  # The time at which the stack set operation ended, across all accounts
6434
- # and regions specified. Note that this doesn't necessarily mean that
6427
+ # and Regions specified. Note that this doesn't necessarily mean that
6435
6428
  # the stack set operation was successful, or even attempted, in each
6436
- # account or region.
6429
+ # account or Region.
6437
6430
  # @return [Time]
6438
6431
  #
6439
6432
  # @!attribute [rw] deployment_targets
@@ -6497,26 +6490,26 @@ module Aws::CloudFormation
6497
6490
  # }
6498
6491
  #
6499
6492
  # @!attribute [rw] region_order
6500
- # The order of the regions in where you want to perform the stack
6493
+ # The order of the Regions in where you want to perform the stack
6501
6494
  # operation.
6502
6495
  # @return [Array<String>]
6503
6496
  #
6504
6497
  # @!attribute [rw] failure_tolerance_count
6505
- # The number of accounts, per region, for which this operation can
6506
- # fail before AWS CloudFormation stops the operation in that region.
6507
- # If the operation is stopped in a region, AWS CloudFormation doesn't
6508
- # attempt the operation in any subsequent regions.
6498
+ # The number of accounts, per Region, for which this operation can
6499
+ # fail before AWS CloudFormation stops the operation in that Region.
6500
+ # If the operation is stopped in a Region, AWS CloudFormation doesn't
6501
+ # attempt the operation in any subsequent Regions.
6509
6502
  #
6510
6503
  # Conditional: You must specify either `FailureToleranceCount` or
6511
6504
  # `FailureTolerancePercentage` (but not both).
6512
6505
  # @return [Integer]
6513
6506
  #
6514
6507
  # @!attribute [rw] failure_tolerance_percentage
6515
- # The percentage of accounts, per region, for which this stack
6508
+ # The percentage of accounts, per Region, for which this stack
6516
6509
  # operation can fail before AWS CloudFormation stops the operation in
6517
- # that region. If the operation is stopped in a region, AWS
6510
+ # that Region. If the operation is stopped in a Region, AWS
6518
6511
  # CloudFormation doesn't attempt the operation in any subsequent
6519
- # regions.
6512
+ # Regions.
6520
6513
  #
6521
6514
  # When calculating the number of accounts based on the specified
6522
6515
  # percentage, AWS CloudFormation rounds *down* to the next whole
@@ -6571,40 +6564,40 @@ module Aws::CloudFormation
6571
6564
  end
6572
6565
 
6573
6566
  # The structure that contains information about a specified operation's
6574
- # results for a given account in a given region.
6567
+ # results for a given account in a given Region.
6575
6568
  #
6576
6569
  # @!attribute [rw] account
6577
- # \[Self-managed permissions\] The name of the AWS account for this
6570
+ # \[`Self-managed` permissions\] The name of the AWS account for this
6578
6571
  # operation result.
6579
6572
  # @return [String]
6580
6573
  #
6581
6574
  # @!attribute [rw] region
6582
- # The name of the AWS region for this operation result.
6575
+ # The name of the AWS Region for this operation result.
6583
6576
  # @return [String]
6584
6577
  #
6585
6578
  # @!attribute [rw] status
6586
6579
  # The result status of the stack set operation for the given account
6587
- # in the given region.
6580
+ # in the given Region.
6588
6581
  #
6589
- # * `CANCELLED`\: The operation in the specified account and region
6582
+ # * `CANCELLED`\: The operation in the specified account and Region
6590
6583
  # has been cancelled. This is either because a user has stopped the
6591
6584
  # stack set operation, or because the failure tolerance of the stack
6592
6585
  # set operation has been exceeded.
6593
6586
  #
6594
- # * `FAILED`\: The operation in the specified account and region
6587
+ # * `FAILED`\: The operation in the specified account and Region
6595
6588
  # failed.
6596
6589
  #
6597
6590
  # If the stack set operation fails in enough accounts within a
6598
- # region, the failure tolerance for the stack set operation as a
6591
+ # Region, the failure tolerance for the stack set operation as a
6599
6592
  # whole might be exceeded.
6600
6593
  #
6601
- # * `RUNNING`\: The operation in the specified account and region is
6594
+ # * `RUNNING`\: The operation in the specified account and Region is
6602
6595
  # currently in progress.
6603
6596
  #
6604
- # * `PENDING`\: The operation in the specified account and region has
6597
+ # * `PENDING`\: The operation in the specified account and Region has
6605
6598
  # yet to start.
6606
6599
  #
6607
- # * `SUCCEEDED`\: The operation in the specified account and region
6600
+ # * `SUCCEEDED`\: The operation in the specified account and Region
6608
6601
  # completed successfully.
6609
6602
  # @return [String]
6610
6603
  #
@@ -6619,8 +6612,7 @@ module Aws::CloudFormation
6619
6612
  # @return [Types::AccountGateResult]
6620
6613
  #
6621
6614
  # @!attribute [rw] organizational_unit_id
6622
- # \[`Service-managed` permissions\] The organization root ID or
6623
- # organizational unit (OU) ID for this operation result.
6615
+ # Reserved for internal use. No data returned.
6624
6616
  # @return [String]
6625
6617
  #
6626
6618
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationResultSummary AWS API Documentation
@@ -6655,15 +6647,15 @@ module Aws::CloudFormation
6655
6647
  #
6656
6648
  # * `FAILED`\: The operation exceeded the specified failure tolerance.
6657
6649
  # The failure tolerance value that you've set for an operation is
6658
- # applied for each region during stack create and update operations.
6659
- # If the number of failed stacks within a region exceeds the failure
6660
- # tolerance, the status of the operation in the region is set to
6650
+ # applied for each Region during stack create and update operations.
6651
+ # If the number of failed stacks within a Region exceeds the failure
6652
+ # tolerance, the status of the operation in the Region is set to
6661
6653
  # `FAILED`. This in turn sets the status of the operation as a whole
6662
6654
  # to `FAILED`, and AWS CloudFormation cancels the operation in any
6663
- # remaining regions.
6655
+ # remaining Regions.
6664
6656
  #
6665
- # * `QUEUED`\: \[Service-managed permissions\] For automatic
6666
- # deployments that require a sequence of operations. The operation
6657
+ # * `QUEUED`\: \[`Service-managed` permissions\] For automatic
6658
+ # deployments that require a sequence of operations, the operation
6667
6659
  # is queued to be performed. For more information, see the [stack
6668
6660
  # set operation status codes][1] in the AWS CloudFormation User
6669
6661
  # Guide.
@@ -6689,15 +6681,15 @@ module Aws::CloudFormation
6689
6681
  # creation times for the stack set operation might differ from the
6690
6682
  # creation time of the individual stacks themselves. This is because
6691
6683
  # AWS CloudFormation needs to perform preparatory work for the
6692
- # operation, such as dispatching the work to the requested regions,
6684
+ # operation, such as dispatching the work to the requested Regions,
6693
6685
  # before actually creating the first stacks.
6694
6686
  # @return [Time]
6695
6687
  #
6696
6688
  # @!attribute [rw] end_timestamp
6697
6689
  # The time at which the stack set operation ended, across all accounts
6698
- # and regions specified. Note that this doesn't necessarily mean that
6690
+ # and Regions specified. Note that this doesn't necessarily mean that
6699
6691
  # the stack set operation was successful, or even attempted, in each
6700
- # account or region.
6692
+ # account or Region.
6701
6693
  # @return [Time]
6702
6694
  #
6703
6695
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationSummary AWS API Documentation
@@ -7179,7 +7171,7 @@ module Aws::CloudFormation
7179
7171
  # @!attribute [rw] stack_policy_during_update_url
7180
7172
  # Location of a file containing the temporary overriding stack policy.
7181
7173
  # The URL must point to a policy (max size: 16KB) located in an S3
7182
- # bucket in the same region as the stack. You can specify either the
7174
+ # bucket in the same Region as the stack. You can specify either the
7183
7175
  # `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL`
7184
7176
  # parameter, but not both.
7185
7177
  #
@@ -7343,7 +7335,7 @@ module Aws::CloudFormation
7343
7335
  # @!attribute [rw] stack_policy_url
7344
7336
  # Location of a file containing the updated stack policy. The URL must
7345
7337
  # point to a policy (max size: 16KB) located in an S3 bucket in the
7346
- # same region as the stack. You can specify either the
7338
+ # same Region as the stack. You can specify either the
7347
7339
  # `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
7348
7340
  #
7349
7341
  # You might update the stack policy, for example, in order to protect
@@ -7447,10 +7439,10 @@ module Aws::CloudFormation
7447
7439
  # @return [String]
7448
7440
  #
7449
7441
  # @!attribute [rw] accounts
7450
- # \[Self-managed permissions\] The names of one or more AWS accounts
7442
+ # \[`Self-managed` permissions\] The names of one or more AWS accounts
7451
7443
  # for which you want to update parameter values for stack instances.
7452
7444
  # The overridden parameter values will be applied to all stack
7453
- # instances in the specified accounts and regions.
7445
+ # instances in the specified accounts and Regions.
7454
7446
  #
7455
7447
  # You can specify `Accounts` or `DeploymentTargets`, but not both.
7456
7448
  # @return [Array<String>]
@@ -7467,10 +7459,10 @@ module Aws::CloudFormation
7467
7459
  # @return [Types::DeploymentTargets]
7468
7460
  #
7469
7461
  # @!attribute [rw] regions
7470
- # The names of one or more regions in which you want to update
7462
+ # The names of one or more Regions in which you want to update
7471
7463
  # parameter values for stack instances. The overridden parameter
7472
7464
  # values will be applied to all stack instances in the specified
7473
- # accounts and regions.
7465
+ # accounts and Regions.
7474
7466
  # @return [Array<String>]
7475
7467
  #
7476
7468
  # @!attribute [rw] parameter_overrides
@@ -7478,7 +7470,7 @@ module Aws::CloudFormation
7478
7470
  # specified stack instances.
7479
7471
  #
7480
7472
  # Any overridden parameter values will be applied to all stack
7481
- # instances in the specified accounts and regions. When specifying
7473
+ # instances in the specified accounts and Regions. When specifying
7482
7474
  # parameters and their values, be aware of how AWS CloudFormation sets
7483
7475
  # parameter values during stack instance update operations:
7484
7476
  #
@@ -7896,9 +7888,9 @@ module Aws::CloudFormation
7896
7888
  # @return [String]
7897
7889
  #
7898
7890
  # @!attribute [rw] accounts
7899
- # \[Self-managed permissions\] The accounts in which to update
7891
+ # \[`Self-managed` permissions\] The accounts in which to update
7900
7892
  # associated stack instances. If you specify accounts, you must also
7901
- # specify the regions in which to update stack set instances.
7893
+ # specify the Regions in which to update stack set instances.
7902
7894
  #
7903
7895
  # To update *all* the stack instances associated with this stack set,
7904
7896
  # do not specify the `Accounts` or `Regions` properties.
@@ -7907,16 +7899,16 @@ module Aws::CloudFormation
7907
7899
  # if the `TemplateBody` or `TemplateURL` properties are specified), or
7908
7900
  # the `Parameters` property, AWS CloudFormation marks all stack
7909
7901
  # instances with a status of `OUTDATED` prior to updating the stack
7910
- # instances in the specified accounts and regions. If the stack set
7902
+ # instances in the specified accounts and Regions. If the stack set
7911
7903
  # update does not include changes to the template or parameters, AWS
7912
7904
  # CloudFormation updates the stack instances in the specified accounts
7913
- # and regions, while leaving all other stack instances with their
7905
+ # and Regions, while leaving all other stack instances with their
7914
7906
  # existing stack instance status.
7915
7907
  # @return [Array<String>]
7916
7908
  #
7917
7909
  # @!attribute [rw] regions
7918
- # The regions in which to update associated stack instances. If you
7919
- # specify regions, you must also specify accounts in which to update
7910
+ # The Regions in which to update associated stack instances. If you
7911
+ # specify Regions, you must also specify accounts in which to update
7920
7912
  # stack set instances.
7921
7913
  #
7922
7914
  # To update *all* the stack instances associated with this stack set,
@@ -7926,10 +7918,10 @@ module Aws::CloudFormation
7926
7918
  # if the `TemplateBody` or `TemplateURL` properties are specified), or
7927
7919
  # the `Parameters` property, AWS CloudFormation marks all stack
7928
7920
  # instances with a status of `OUTDATED` prior to updating the stack
7929
- # instances in the specified accounts and regions. If the stack set
7921
+ # instances in the specified accounts and Regions. If the stack set
7930
7922
  # update does not include changes to the template or parameters, AWS
7931
7923
  # CloudFormation updates the stack instances in the specified accounts
7932
- # and regions, while leaving all other stack instances with their
7924
+ # and Regions, while leaving all other stack instances with their
7933
7925
  # existing stack instance status.
7934
7926
  # @return [Array<String>]
7935
7927
  #