aws-sdk-cloudformation 1.76.0 → 1.81.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.
@@ -32,18 +32,18 @@ module Aws::CloudFormation
32
32
  # @!attribute [rw] status
33
33
  # The status of the account gate function.
34
34
  #
35
- # * `SUCCEEDED`\: The account gate function has determined that the
35
+ # * `SUCCEEDED`: The account gate function has determined that the
36
36
  # account and Region passes any requirements for a stack set
37
37
  # operation to occur. CloudFormation proceeds with the stack
38
38
  # operation in that account and Region.
39
39
  #
40
- # * `FAILED`\: The account gate function has determined that the
40
+ # * `FAILED`: The account gate function has determined that the
41
41
  # account and Region doesn't meet the requirements for a stack set
42
42
  # operation to occur. CloudFormation cancels the stack set operation
43
43
  # in that account and Region, and sets the stack set operation
44
44
  # result status for that account and Region to `FAILED`.
45
45
  #
46
- # * `SKIPPED`\: CloudFormation has skipped calling the account gate
46
+ # * `SKIPPED`: CloudFormation has skipped calling the account gate
47
47
  # function for this account and Region, for one of the following
48
48
  # reasons:
49
49
  #
@@ -113,6 +113,16 @@ module Aws::CloudFormation
113
113
  include Aws::Structure
114
114
  end
115
115
 
116
+ # @api private
117
+ #
118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccessInput AWS API Documentation
119
+ #
120
+ class ActivateOrganizationsAccessInput < Aws::EmptyStructure; end
121
+
122
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccessOutput AWS API Documentation
123
+ #
124
+ class ActivateOrganizationsAccessOutput < Aws::EmptyStructure; end
125
+
116
126
  # @!attribute [rw] type
117
127
  # The extension type.
118
128
  #
@@ -143,19 +153,19 @@ module Aws::CloudFormation
143
153
  #
144
154
  # @!attribute [rw] type_name_alias
145
155
  # An alias to assign to the public extension, in this account and
146
- # region. If you specify an alias for the extension, CloudFormation
156
+ # Region. If you specify an alias for the extension, CloudFormation
147
157
  # treats the alias as the extension type name within this account and
148
- # region. You must use the alias to refer to the extension in your
158
+ # Region. You must use the alias to refer to the extension in your
149
159
  # templates, API calls, and CloudFormation console.
150
160
  #
151
- # An extension alias must be unique within a given account and region.
161
+ # An extension alias must be unique within a given account and Region.
152
162
  # You can activate the same public resource multiple times in the same
153
- # account and region, using different type name aliases.
163
+ # account and Region, using different type name aliases.
154
164
  # @return [String]
155
165
  #
156
166
  # @!attribute [rw] auto_update
157
167
  # Whether to automatically update the extension in this account and
158
- # region when a new *minor* version is published by the extension
168
+ # Region when a new *minor* version is published by the extension
159
169
  # publisher. Major versions released by the publisher must be manually
160
170
  # updated.
161
171
  #
@@ -175,10 +185,10 @@ module Aws::CloudFormation
175
185
  # version, if available. You can also use this parameter to update the
176
186
  # value of `AutoUpdate`.
177
187
  #
178
- # * `MAJOR`\: CloudFormation updates the extension to the newest major
188
+ # * `MAJOR`: CloudFormation updates the extension to the newest major
179
189
  # version, if one is available.
180
190
  #
181
- # * `MINOR`\: CloudFormation updates the extension to the newest minor
191
+ # * `MINOR`: CloudFormation updates the extension to the newest minor
182
192
  # version, if one is available.
183
193
  # @return [String]
184
194
  #
@@ -210,7 +220,7 @@ module Aws::CloudFormation
210
220
 
211
221
  # @!attribute [rw] arn
212
222
  # The Amazon Resource Name (ARN) of the activated extension, in this
213
- # account and region.
223
+ # account and Region.
214
224
  # @return [String]
215
225
  #
216
226
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeOutput AWS API Documentation
@@ -333,6 +343,19 @@ module Aws::CloudFormation
333
343
  # The input for the CancelUpdateStack action.
334
344
  #
335
345
  # @!attribute [rw] stack_name
346
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
347
+ # response that describes all resources in the account.
348
+ #
349
+ # The IAM policy below can be added to IAM policies when you want to
350
+ # limit resource-level permissions and avoid returning a response when
351
+ # no parameter is sent in the request:
352
+ #
353
+ # `\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny",
354
+ # "Action": "cloudformation:DescribeStacks", "NotResource":
355
+ # "arn:aws:cloudformation:*:*:stack/*/*" \}] \}`
356
+ #
357
+ # </note>
358
+ #
336
359
  # The name or the unique stack ID that's associated with the stack.
337
360
  # @return [String]
338
361
  #
@@ -653,7 +676,7 @@ module Aws::CloudFormation
653
676
  # @!attribute [rw] client_request_token
654
677
  # A unique identifier for this `ContinueUpdateRollback` request.
655
678
  # Specify this token if you plan to retry requests so that
656
- # CloudFormationknows that you're not attempting to continue the
679
+ # CloudFormation knows that you're not attempting to continue the
657
680
  # rollback to a stack with the same name. You might retry
658
681
  # `ContinueUpdateRollback` requests to ensure that CloudFormation
659
682
  # successfully received them.
@@ -883,7 +906,7 @@ module Aws::CloudFormation
883
906
  #
884
907
  # If you create a change set for a new stack, CloudFormation creates a
885
908
  # stack with a unique stack ID, but no template or resources. The
886
- # stack will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you
909
+ # stack will be in the [REVIEW\_IN\_PROGRESS][1] state until you
887
910
  # execute the change set.
888
911
  #
889
912
  # By default, CloudFormation specifies `UPDATE`. You can't use the
@@ -1685,8 +1708,18 @@ module Aws::CloudFormation
1685
1708
  #
1686
1709
  class CreatedButModifiedException < Aws::EmptyStructure; end
1687
1710
 
1711
+ # @api private
1712
+ #
1713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccessInput AWS API Documentation
1714
+ #
1715
+ class DeactivateOrganizationsAccessInput < Aws::EmptyStructure; end
1716
+
1717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccessOutput AWS API Documentation
1718
+ #
1719
+ class DeactivateOrganizationsAccessOutput < Aws::EmptyStructure; end
1720
+
1688
1721
  # @!attribute [rw] type_name
1689
- # The type name of the extension, in this account and region. If you
1722
+ # The type name of the extension, in this account and Region. If you
1690
1723
  # specified a type name alias when enabling the extension, use the
1691
1724
  # type name alias.
1692
1725
  #
@@ -1703,7 +1736,7 @@ module Aws::CloudFormation
1703
1736
  #
1704
1737
  # @!attribute [rw] arn
1705
1738
  # The Amazon Resource Name (ARN) for the extension, in this account
1706
- # and region.
1739
+ # and Region.
1707
1740
  #
1708
1741
  # Conditional: You must specify either `Arn`, or `TypeName` and
1709
1742
  # `Type`.
@@ -1992,14 +2025,14 @@ module Aws::CloudFormation
1992
2025
  # The following is a list of possible values for the
1993
2026
  # `AccountFilterType` operation.
1994
2027
  #
1995
- # * `INTERSECTION`\: StackSets deploys to the accounts specified in
2028
+ # * `INTERSECTION`: StackSets deploys to the accounts specified in
1996
2029
  # `Accounts` parameter.
1997
2030
  #
1998
- # * `DIFFERENCE`\: StackSets excludes the accounts specified in
2031
+ # * `DIFFERENCE`: StackSets excludes the accounts specified in
1999
2032
  # `Accounts` parameter. This enables user to avoid certain accounts
2000
2033
  # within an OU such as suspended accounts.
2001
2034
  #
2002
- # * `UNION`\: StackSets includes additional accounts deployment
2035
+ # * `UNION`: StackSets includes additional accounts deployment
2003
2036
  # targets.
2004
2037
  #
2005
2038
  # This is the default value if `AccountFilterType` is not provided.
@@ -2007,7 +2040,7 @@ module Aws::CloudFormation
2007
2040
  # from a different OU in one request, which used to be two separate
2008
2041
  # requests.
2009
2042
  #
2010
- # * `NONE`\: Deploys to all the accounts in specified organizational
2043
+ # * `NONE`: Deploys to all the accounts in specified organizational
2011
2044
  # units (OU).
2012
2045
  # @return [String]
2013
2046
  #
@@ -2330,6 +2363,48 @@ module Aws::CloudFormation
2330
2363
  include Aws::Structure
2331
2364
  end
2332
2365
 
2366
+ # @!attribute [rw] call_as
2367
+ # \[Service-managed permissions\] Specifies whether you are acting as
2368
+ # an account administrator in the organization's management account
2369
+ # or as a delegated administrator in a member account.
2370
+ #
2371
+ # By default, `SELF` is specified.
2372
+ #
2373
+ # * If you are signed in to the management account, specify `SELF`.
2374
+ #
2375
+ # * If you are signed in to a delegated administrator account, specify
2376
+ # `DELEGATED_ADMIN`.
2377
+ #
2378
+ # Your Amazon Web Services account must be registered as a delegated
2379
+ # administrator in the management account. For more information, see
2380
+ # [Register a delegated administrator][1] in the *CloudFormation
2381
+ # User Guide*.
2382
+ #
2383
+ #
2384
+ #
2385
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
2386
+ # @return [String]
2387
+ #
2388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccessInput AWS API Documentation
2389
+ #
2390
+ class DescribeOrganizationsAccessInput < Struct.new(
2391
+ :call_as)
2392
+ SENSITIVE = []
2393
+ include Aws::Structure
2394
+ end
2395
+
2396
+ # @!attribute [rw] status
2397
+ # Presents the status of the `OrganizationAccess`.
2398
+ # @return [String]
2399
+ #
2400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccessOutput AWS API Documentation
2401
+ #
2402
+ class DescribeOrganizationsAccessOutput < Struct.new(
2403
+ :status)
2404
+ SENSITIVE = []
2405
+ include Aws::Structure
2406
+ end
2407
+
2333
2408
  # @!attribute [rw] publisher_id
2334
2409
  # The ID of the extension publisher.
2335
2410
  #
@@ -2409,23 +2484,23 @@ module Aws::CloudFormation
2409
2484
  # Status of the stack's actual configuration compared to its expected
2410
2485
  # configuration.
2411
2486
  #
2412
- # * `DRIFTED`\: The stack differs from its expected template
2487
+ # * `DRIFTED`: The stack differs from its expected template
2413
2488
  # configuration. A stack is considered to have drifted if one or
2414
2489
  # more of its resources have drifted.
2415
2490
  #
2416
- # * `NOT_CHECKED`\: CloudFormation hasn't checked if the stack
2417
- # differs from its expected template configuration.
2491
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs
2492
+ # from its expected template configuration.
2418
2493
  #
2419
- # * `IN_SYNC`\: The stack's actual configuration matches its expected
2494
+ # * `IN_SYNC`: The stack's actual configuration matches its expected
2420
2495
  # template configuration.
2421
2496
  #
2422
- # * `UNKNOWN`\: This value is reserved for future use.
2497
+ # * `UNKNOWN`: This value is reserved for future use.
2423
2498
  # @return [String]
2424
2499
  #
2425
2500
  # @!attribute [rw] detection_status
2426
2501
  # The status of the stack drift detection operation.
2427
2502
  #
2428
- # * `DETECTION_COMPLETE`\: The stack drift detection operation has
2503
+ # * `DETECTION_COMPLETE`: The stack drift detection operation has
2429
2504
  # successfully completed for all resources in the stack that support
2430
2505
  # drift detection. (Resources that don't currently support stack
2431
2506
  # detection remain unchecked.)
@@ -2434,12 +2509,12 @@ module Aws::CloudFormation
2434
2509
  # a filter for the stack drift detection operation, only the
2435
2510
  # resources with those logical IDs are checked for drift.
2436
2511
  #
2437
- # * `DETECTION_FAILED`\: The stack drift detection operation has
2438
- # failed for at least one resource in the stack. Results will be
2439
- # available for resources on which CloudFormation successfully
2440
- # completed drift detection.
2512
+ # * `DETECTION_FAILED`: The stack drift detection operation has failed
2513
+ # for at least one resource in the stack. Results will be available
2514
+ # for resources on which CloudFormation successfully completed drift
2515
+ # detection.
2441
2516
  #
2442
- # * `DETECTION_IN_PROGRESS`\: The stack drift detection operation is
2517
+ # * `DETECTION_IN_PROGRESS`: The stack drift detection operation is
2443
2518
  # currently in progress.
2444
2519
  # @return [String]
2445
2520
  #
@@ -2590,16 +2665,16 @@ module Aws::CloudFormation
2590
2665
  # The resource drift status values to use as filters for the resource
2591
2666
  # drift results returned.
2592
2667
  #
2593
- # * `DELETED`\: The resource differs from its expected template
2668
+ # * `DELETED`: The resource differs from its expected template
2594
2669
  # configuration in that the resource has been deleted.
2595
2670
  #
2596
- # * `MODIFIED`\: One or more resource properties differ from their
2671
+ # * `MODIFIED`: One or more resource properties differ from their
2597
2672
  # expected template values.
2598
2673
  #
2599
- # * `IN_SYNC`\: The resource's actual configuration matches its
2674
+ # * `IN_SYNC`: The resource's actual configuration matches its
2600
2675
  # expected template configuration.
2601
2676
  #
2602
- # * `NOT_CHECKED`\: CloudFormation doesn't currently return this
2677
+ # * `NOT_CHECKED`: CloudFormation doesn't currently return this
2603
2678
  # value.
2604
2679
  # @return [Array<String>]
2605
2680
  #
@@ -2873,6 +2948,21 @@ module Aws::CloudFormation
2873
2948
  # The input for DescribeStacks action.
2874
2949
  #
2875
2950
  # @!attribute [rw] stack_name
2951
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
2952
+ # response that describes all resources in the account. This requires
2953
+ # `ListStacks` and `DescribeStacks` permissions.
2954
+ #
2955
+ # The IAM policy below can be added to IAM policies when you want to
2956
+ # limit resource-level permissions and avoid returning a response when
2957
+ # no parameter is sent in the request:
2958
+ #
2959
+ # \\\{ "Version": "2012-10-17", "Statement": \[\\\{ "Effect":
2960
+ # "Deny", "Action": "cloudformation:DescribeStacks",
2961
+ # "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" \\}\]
2962
+ # \\}
2963
+ #
2964
+ # </note>
2965
+ #
2876
2966
  # The name or the unique stack ID that's associated with the stack,
2877
2967
  # which aren't always interchangeable:
2878
2968
  #
@@ -3003,8 +3093,8 @@ module Aws::CloudFormation
3003
3093
  # Services and published by third parties, CloudFormation returns
3004
3094
  # `null`. For more information, see [RegisterType][1].
3005
3095
  #
3006
- # To set the default version of an extension, use `
3007
- # SetTypeDefaultVersion `.
3096
+ # To set the default version of an extension, use
3097
+ # SetTypeDefaultVersion.
3008
3098
  #
3009
3099
  #
3010
3100
  #
@@ -3030,19 +3120,19 @@ module Aws::CloudFormation
3030
3120
  # CloudFormation doesn't return this information for public
3031
3121
  # extensions, whether they are activated in your account.
3032
3122
  #
3033
- # * `PASSED`\: The extension has passed all its contract tests.
3123
+ # * `PASSED`: The extension has passed all its contract tests.
3034
3124
  #
3035
3125
  # An extension must have a test status of `PASSED` before it can be
3036
3126
  # published. For more information, see [Publishing extensions to
3037
3127
  # make them available for public use][1] in the *CloudFormation
3038
3128
  # Command Line Interface User Guide*.
3039
3129
  #
3040
- # * `FAILED`\: The extension has failed one or more contract tests.
3130
+ # * `FAILED`: The extension has failed one or more contract tests.
3041
3131
  #
3042
- # * `IN_PROGRESS`\: Contract tests are currently being performed on
3043
- # the extension.
3132
+ # * `IN_PROGRESS`: Contract tests are currently being performed on the
3133
+ # extension.
3044
3134
  #
3045
- # * `NOT_TESTED`\: Contract tests haven't been performed on the
3135
+ # * `NOT_TESTED`: Contract tests haven't been performed on the
3046
3136
  # extension.
3047
3137
  #
3048
3138
  #
@@ -3083,14 +3173,14 @@ module Aws::CloudFormation
3083
3173
  #
3084
3174
  # Valid values include:
3085
3175
  #
3086
- # * `FULLY_MUTABLE`\: The resource type includes an update handler to
3176
+ # * `FULLY_MUTABLE`: The resource type includes an update handler to
3087
3177
  # process updates to the type during stack update operations.
3088
3178
  #
3089
- # * `IMMUTABLE`\: The resource type doesn't include an update
3090
- # handler, so the type can't be updated and must instead be
3091
- # replaced during stack update operations.
3179
+ # * `IMMUTABLE`: The resource type doesn't include an update handler,
3180
+ # so the type can't be updated and must instead be replaced during
3181
+ # stack update operations.
3092
3182
  #
3093
- # * `NON_PROVISIONABLE`\: The resource type doesn't include all the
3183
+ # * `NON_PROVISIONABLE`: The resource type doesn't include all the
3094
3184
  # following handlers, and therefore can't actually be provisioned.
3095
3185
  #
3096
3186
  # * create
@@ -3105,11 +3195,11 @@ module Aws::CloudFormation
3105
3195
  #
3106
3196
  # Valid values include:
3107
3197
  #
3108
- # * `LIVE`\: The extension is activated or registered and can be used
3198
+ # * `LIVE`: The extension is activated or registered and can be used
3109
3199
  # in CloudFormation operations, dependent on its provisioning
3110
3200
  # behavior and visibility scope.
3111
3201
  #
3112
- # * `DEPRECATED`\: The extension has been deactivated or deregistered
3202
+ # * `DEPRECATED`: The extension has been deactivated or deregistered
3113
3203
  # and can no longer be used in CloudFormation operations.
3114
3204
  #
3115
3205
  # For public third-party extensions, CloudFormation returns `null`.
@@ -3158,11 +3248,11 @@ module Aws::CloudFormation
3158
3248
  #
3159
3249
  # Valid values include:
3160
3250
  #
3161
- # * `PRIVATE`\: The extension is only visible and usable within the
3251
+ # * `PRIVATE`: The extension is only visible and usable within the
3162
3252
  # account in which it is registered. CloudFormation marks any
3163
3253
  # extensions you register as `PRIVATE`.
3164
3254
  #
3165
- # * `PUBLIC`\: The extension is publicly visible and usable within any
3255
+ # * `PUBLIC`: The extension is publicly visible and usable within any
3166
3256
  # Amazon Web Services account.
3167
3257
  # @return [String]
3168
3258
  #
@@ -3199,7 +3289,7 @@ module Aws::CloudFormation
3199
3289
  #
3200
3290
  # @!attribute [rw] configuration_schema
3201
3291
  # A JSON string that represent the current configuration data for the
3202
- # extension in this account and region.
3292
+ # extension in this account and Region.
3203
3293
  #
3204
3294
  # To set the configuration data for an extension, use
3205
3295
  # [SetTypeConfiguration][1]. For more information, see [Configuring
@@ -3222,11 +3312,11 @@ module Aws::CloudFormation
3222
3312
  #
3223
3313
  # @!attribute [rw] original_type_name
3224
3314
  # For public extensions that have been activated for this account and
3225
- # region, the type name of the public extension.
3315
+ # Region, the type name of the public extension.
3226
3316
  #
3227
3317
  # If you specified a `TypeNameAlias` when enabling the extension in
3228
- # this account and region, CloudFormation treats that alias as the
3229
- # extension's type name within the account and region, not the type
3318
+ # this account and Region, CloudFormation treats that alias as the
3319
+ # extension's type name within the account and Region, not the type
3230
3320
  # name of the public extension. For more information, see [Specifying
3231
3321
  # aliases to refer to extensions][1] in the *CloudFormation User
3232
3322
  # Guide*.
@@ -3238,7 +3328,7 @@ module Aws::CloudFormation
3238
3328
  #
3239
3329
  # @!attribute [rw] original_type_arn
3240
3330
  # For public extensions that have been activated for this account and
3241
- # region, the Amazon Resource Name (ARN) of the public extension.
3331
+ # Region, the Amazon Resource Name (ARN) of the public extension.
3242
3332
  # @return [String]
3243
3333
  #
3244
3334
  # @!attribute [rw] public_version_number
@@ -3260,7 +3350,7 @@ module Aws::CloudFormation
3260
3350
  # @return [String]
3261
3351
  #
3262
3352
  # @!attribute [rw] is_activated
3263
- # Whether the extension is activated in the account and region.
3353
+ # Whether the extension is activated in the account and Region.
3264
3354
  #
3265
3355
  # This only applies to public third-party extensions. For all other
3266
3356
  # extensions, CloudFormation returns `null`.
@@ -3268,12 +3358,15 @@ module Aws::CloudFormation
3268
3358
  #
3269
3359
  # @!attribute [rw] auto_update
3270
3360
  # Whether CloudFormation automatically updates the extension in this
3271
- # account and region when a new *minor* version is published by the
3361
+ # account and Region when a new *minor* version is published by the
3272
3362
  # extension publisher. Major versions released by the publisher must
3273
3363
  # be manually updated. For more information, see [Activating public
3274
- # extensions for use in your
3275
- # account](AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable)
3276
- # in the *CloudFormation User Guide*.
3364
+ # extensions for use in your account][1] in the *CloudFormation User
3365
+ # Guide*.
3366
+ #
3367
+ #
3368
+ #
3369
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable
3277
3370
  # @return [Boolean]
3278
3371
  #
3279
3372
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation
@@ -3314,7 +3407,7 @@ module Aws::CloudFormation
3314
3407
  # The identifier for this registration request.
3315
3408
  #
3316
3409
  # This registration token is generated by CloudFormation when you
3317
- # initiate a registration request using ` RegisterType `.
3410
+ # initiate a registration request using RegisterType.
3318
3411
  # @return [String]
3319
3412
  #
3320
3413
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeRegistrationInput AWS API Documentation
@@ -3486,7 +3579,7 @@ module Aws::CloudFormation
3486
3579
  # @!attribute [rw] operation_id
3487
3580
  # The ID of the drift detection stack set operation.
3488
3581
  #
3489
- # You can use this operation ID with ` DescribeStackSetOperation ` to
3582
+ # You can use this operation ID with DescribeStackSetOperation to
3490
3583
  # monitor the progress of the drift detection operation.
3491
3584
  # @return [String]
3492
3585
  #
@@ -4625,8 +4718,8 @@ module Aws::CloudFormation
4625
4718
  # @!attribute [rw] registration_token_list
4626
4719
  # A list of extension registration tokens.
4627
4720
  #
4628
- # Use ` DescribeTypeRegistration ` to return detailed information
4629
- # about a type registration request.
4721
+ # Use DescribeTypeRegistration to return detailed information about a
4722
+ # type registration request.
4630
4723
  # @return [Array<String>]
4631
4724
  #
4632
4725
  # @!attribute [rw] next_token
@@ -4691,11 +4784,11 @@ module Aws::CloudFormation
4691
4784
  #
4692
4785
  # Valid values include:
4693
4786
  #
4694
- # * `LIVE`\: The extension version is registered and can be used in
4787
+ # * `LIVE`: The extension version is registered and can be used in
4695
4788
  # CloudFormation operations, dependent on its provisioning behavior
4696
4789
  # and visibility scope.
4697
4790
  #
4698
- # * `DEPRECATED`\: The extension version has been deregistered and can
4791
+ # * `DEPRECATED`: The extension version has been deregistered and can
4699
4792
  # no longer be used in CloudFormation operations.
4700
4793
  #
4701
4794
  # The default is `LIVE`.
@@ -4749,17 +4842,17 @@ module Aws::CloudFormation
4749
4842
  #
4750
4843
  # Valid values include:
4751
4844
  #
4752
- # * `PRIVATE`\: Extensions that are visible and usable within this
4753
- # account and region. This includes:
4845
+ # * `PRIVATE`: Extensions that are visible and usable within this
4846
+ # account and Region. This includes:
4754
4847
  #
4755
4848
  # * Private extensions you have registered in this account and
4756
- # region.
4849
+ # Region.
4757
4850
  #
4758
4851
  # * Public extensions that you have activated in this account and
4759
- # region.
4852
+ # Region.
4760
4853
  #
4761
- # * `PUBLIC`\: Extensions that are publicly visible and available to
4762
- # be activated within any Amazon Web Services account. This includes
4854
+ # * `PUBLIC`: Extensions that are publicly visible and available to be
4855
+ # activated within any Amazon Web Services account. This includes
4763
4856
  # extensions from Amazon Web Services, in addition to third-party
4764
4857
  # publishers.
4765
4858
  #
@@ -4774,14 +4867,14 @@ module Aws::CloudFormation
4774
4867
  #
4775
4868
  # Valid values include:
4776
4869
  #
4777
- # * `FULLY_MUTABLE`\: The resource type includes an update handler to
4870
+ # * `FULLY_MUTABLE`: The resource type includes an update handler to
4778
4871
  # process updates to the type during stack update operations.
4779
4872
  #
4780
- # * `IMMUTABLE`\: The resource type doesn't include an update
4781
- # handler, so the type can't be updated and must instead be
4782
- # replaced during stack update operations.
4873
+ # * `IMMUTABLE`: The resource type doesn't include an update handler,
4874
+ # so the type can't be updated and must instead be replaced during
4875
+ # stack update operations.
4783
4876
  #
4784
- # * `NON_PROVISIONABLE`\: The resource type doesn't include create,
4877
+ # * `NON_PROVISIONABLE`: The resource type doesn't include create,
4785
4878
  # read, and delete handlers, and therefore can't actually be
4786
4879
  # provisioned.
4787
4880
  #
@@ -4794,10 +4887,10 @@ module Aws::CloudFormation
4794
4887
  #
4795
4888
  # Valid values include:
4796
4889
  #
4797
- # * `LIVE`\: The extension is registered for use in CloudFormation
4890
+ # * `LIVE`: The extension is registered for use in CloudFormation
4798
4891
  # operations.
4799
4892
  #
4800
- # * `DEPRECATED`\: The extension has been deregistered and can no
4893
+ # * `DEPRECATED`: The extension has been deregistered and can no
4801
4894
  # longer be used in CloudFormation operations.
4802
4895
  # @return [String]
4803
4896
  #
@@ -4921,9 +5014,12 @@ module Aws::CloudFormation
4921
5014
  # stack template.
4922
5015
  #
4923
5016
  # For more information about modules, see [Using modules to encapsulate
4924
- # and reuse resource
4925
- # configurations](AWSCloudFormation/latest/UserGuide/modules.html) in
4926
- # the *CloudFormation User Guide*.
5017
+ # and reuse resource configurations][1] in the *CloudFormation User
5018
+ # Guide*.
5019
+ #
5020
+ #
5021
+ #
5022
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html
4927
5023
  #
4928
5024
  # @!attribute [rw] type_hierarchy
4929
5025
  # A concatenated list of the module type or types containing the
@@ -4947,9 +5043,12 @@ module Aws::CloudFormation
4947
5043
  #
4948
5044
  # `moduleA/moduleB`
4949
5045
  #
4950
- # For more information, see [Referencing resources in a
4951
- # module](AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources)
4952
- # in the *CloudFormation User Guide*.
5046
+ # For more information, see [Referencing resources in a module][1] in
5047
+ # the *CloudFormation User Guide*.
5048
+ #
5049
+ #
5050
+ #
5051
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources
4953
5052
  # @return [String]
4954
5053
  #
4955
5054
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ModuleInfo AWS API Documentation
@@ -5065,7 +5164,7 @@ module Aws::CloudFormation
5065
5164
  #
5066
5165
  # @!attribute [rw] resolved_value
5067
5166
  # Read-only. The value that corresponds to a SSM parameter key. This
5068
- # field is returned only for [ `SSM` ][1] parameter types in the
5167
+ # field is returned only for [ SSM][1] parameter types in the
5069
5168
  # template.
5070
5169
  #
5071
5170
  #
@@ -5190,13 +5289,13 @@ module Aws::CloudFormation
5190
5289
  # @!attribute [rw] difference_type
5191
5290
  # The type of property difference.
5192
5291
  #
5193
- # * `ADD`\: A value has been added to a resource property that's an
5292
+ # * `ADD`: A value has been added to a resource property that's an
5194
5293
  # array or list data type.
5195
5294
  #
5196
- # * `REMOVE`\: The property has been removed from the current resource
5295
+ # * `REMOVE`: The property has been removed from the current resource
5197
5296
  # configuration.
5198
5297
  #
5199
- # * `NOT_EQUAL`\: The current property value differs from its expected
5298
+ # * `NOT_EQUAL`: The current property value differs from its expected
5200
5299
  # value (as defined in the stack template and any values specified
5201
5300
  # as template parameters).
5202
5301
  # @return [String]
@@ -5409,12 +5508,12 @@ module Aws::CloudFormation
5409
5508
  # We suggest that extension names adhere to the following patterns:
5410
5509
  #
5411
5510
  # * For resource types,
5412
- # *company\_or\_organization*\::*service*\::*type*.
5511
+ # *company\_or\_organization*::*service*::*type*.
5413
5512
  #
5414
5513
  # * For modules,
5415
- # *company\_or\_organization*\::*service*\::*type*\::MODULE.
5514
+ # *company\_or\_organization*::*service*::*type*::MODULE.
5416
5515
  #
5417
- # * For hooks, *MyCompany*\::*Testing*\::*MyTestHook*.
5516
+ # * For hooks, *MyCompany*::*Testing*::*MyTestHook*.
5418
5517
  #
5419
5518
  # <note markdown="1"> The following organization namespaces are reserved and can't be
5420
5519
  # used in your extension names:
@@ -5469,9 +5568,7 @@ module Aws::CloudFormation
5469
5568
  # must contain a trust relationship with the CloudFormation service
5470
5569
  # principle (`resources.cloudformation.amazonaws.com`). For more
5471
5570
  # information about adding trust relationships, see [Modifying a role
5472
- # trust
5473
- # policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
5474
- # in the *Identity and Access Management User Guide*.
5571
+ # trust policy][1] in the *Identity and Access Management User Guide*.
5475
5572
  #
5476
5573
  # If your extension calls Amazon Web Services APIs in any of its
5477
5574
  # handlers, you must create an <i> <a
@@ -5483,6 +5580,10 @@ module Aws::CloudFormation
5483
5580
  # create a temporary session token, which it then passes to the
5484
5581
  # resource type handler, thereby supplying your resource type with the
5485
5582
  # appropriate credentials.
5583
+ #
5584
+ #
5585
+ #
5586
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy
5486
5587
  # @return [String]
5487
5588
  #
5488
5589
  # @!attribute [rw] client_request_token
@@ -5509,9 +5610,9 @@ module Aws::CloudFormation
5509
5610
  # @!attribute [rw] registration_token
5510
5611
  # The identifier for this registration request.
5511
5612
  #
5512
- # Use this registration token when calling ` DescribeTypeRegistration
5513
- # `, which returns information about the status and IDs of the
5514
- # extension registration.
5613
+ # Use this registration token when calling DescribeTypeRegistration,
5614
+ # which returns information about the status and IDs of the extension
5615
+ # registration.
5515
5616
  # @return [String]
5516
5617
  #
5517
5618
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterTypeOutput AWS API Documentation
@@ -5535,9 +5636,9 @@ module Aws::CloudFormation
5535
5636
  #
5536
5637
  # @!attribute [rw] type_name_alias
5537
5638
  # An alias assigned to the public extension, in this account and
5538
- # region. If you specify an alias for the extension, CloudFormation
5639
+ # Region. If you specify an alias for the extension, CloudFormation
5539
5640
  # treats the alias as the extension type name within this account and
5540
- # region. You must use the alias to refer to the extension in your
5641
+ # Region. You must use the alias to refer to the extension in your
5541
5642
  # templates, API calls, and CloudFormation console.
5542
5643
  # @return [String]
5543
5644
  #
@@ -5545,8 +5646,8 @@ module Aws::CloudFormation
5545
5646
  # The type name of the public extension.
5546
5647
  #
5547
5648
  # If you specified a `TypeNameAlias` when enabling the extension in
5548
- # this account and region, CloudFormation treats that alias as the
5549
- # extension's type name within the account and region, not the type
5649
+ # this account and Region, CloudFormation treats that alias as the
5650
+ # extension's type name within the account and Region, not the type
5550
5651
  # name of the public extension. For more information, see [Specifying
5551
5652
  # aliases to refer to extensions][1] in the *CloudFormation User
5552
5653
  # Guide*.
@@ -6015,12 +6116,12 @@ module Aws::CloudFormation
6015
6116
 
6016
6117
  # @!attribute [rw] type_arn
6017
6118
  # The Amazon Resource Name (ARN) for the extension, in this account
6018
- # and region.
6119
+ # and Region.
6019
6120
  #
6020
6121
  # For public extensions, this will be the ARN assigned when you
6021
- # [activate the type][1] in this account and region. For private
6122
+ # [activate the type][1] in this account and Region. For private
6022
6123
  # extensions, this will be the ARN assigned when you [register the
6023
- # type][2] in this account and region.
6124
+ # type][2] in this account and Region.
6024
6125
  #
6025
6126
  # Do not include the extension versions suffix at the end of the ARN.
6026
6127
  # You can set the configuration for an extension, but not for a
@@ -6034,18 +6135,18 @@ module Aws::CloudFormation
6034
6135
  #
6035
6136
  # @!attribute [rw] configuration
6036
6137
  # The configuration data for the extension, in this account and
6037
- # region.
6138
+ # Region.
6038
6139
  #
6039
6140
  # The configuration data must be formatted as JSON, and validate
6040
6141
  # against the schema returned in the `ConfigurationSchema` response
6041
- # element of
6042
- # [API\_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
6043
- # For more information, see [Defining account-level configuration data
6044
- # for an extension][1] in the *CloudFormation CLI User Guide*.
6142
+ # element of [DescribeType][1]. For more information, see [Defining
6143
+ # account-level configuration data for an extension][2] in the
6144
+ # *CloudFormation CLI User Guide*.
6045
6145
  #
6046
6146
  #
6047
6147
  #
6048
- # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
6148
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
6149
+ # [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
6049
6150
  # @return [String]
6050
6151
  #
6051
6152
  # @!attribute [rw] configuration_alias
@@ -6083,7 +6184,7 @@ module Aws::CloudFormation
6083
6184
 
6084
6185
  # @!attribute [rw] configuration_arn
6085
6186
  # The Amazon Resource Name (ARN) for the configuration data, in this
6086
- # account and region.
6187
+ # account and Region.
6087
6188
  #
6088
6189
  # Conditional: You must specify `ConfigurationArn`, or `Type` and
6089
6190
  # `TypeName`.
@@ -6229,9 +6330,9 @@ module Aws::CloudFormation
6229
6330
  # @!attribute [rw] disable_rollback
6230
6331
  # Boolean to enable or disable rollback on stack creation failures:
6231
6332
  #
6232
- # * `true`\: disable rollback.
6333
+ # * `true`: disable rollback.
6233
6334
  #
6234
- # * `false`\: enable rollback.
6335
+ # * `false`: enable rollback.
6235
6336
  # @return [Boolean]
6236
6337
  #
6237
6338
  # @!attribute [rw] notification_arns
@@ -6305,10 +6406,10 @@ module Aws::CloudFormation
6305
6406
  #
6306
6407
  # @!attribute [rw] drift_information
6307
6408
  # Information about whether a stack's actual configuration differs,
6308
- # or has *drifted*, from it's expected configuration, as defined in
6309
- # the stack template and any values specified as template parameters.
6310
- # For more information, see [Detecting Unregulated Configuration
6311
- # Changes to Stacks and Resources][1].
6409
+ # or has *drifted*, from its expected configuration, as defined in the
6410
+ # stack template and any values specified as template parameters. For
6411
+ # more information, see [Detecting Unregulated Configuration Changes
6412
+ # to Stacks and Resources][1].
6312
6413
  #
6313
6414
  #
6314
6415
  #
@@ -6354,17 +6455,17 @@ module Aws::CloudFormation
6354
6455
  # Status of the stack's actual configuration compared to its expected
6355
6456
  # template configuration.
6356
6457
  #
6357
- # * `DRIFTED`\: The stack differs from its expected template
6458
+ # * `DRIFTED`: The stack differs from its expected template
6358
6459
  # configuration. A stack is considered to have drifted if one or
6359
6460
  # more of its resources have drifted.
6360
6461
  #
6361
- # * `NOT_CHECKED`\: CloudFormation hasn't checked if the stack
6362
- # differs from its expected template configuration.
6462
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs
6463
+ # from its expected template configuration.
6363
6464
  #
6364
- # * `IN_SYNC`\: The stack's actual configuration matches its expected
6465
+ # * `IN_SYNC`: The stack's actual configuration matches its expected
6365
6466
  # template configuration.
6366
6467
  #
6367
- # * `UNKNOWN`\: This value is reserved for future use.
6468
+ # * `UNKNOWN`: This value is reserved for future use.
6368
6469
  # @return [String]
6369
6470
  #
6370
6471
  # @!attribute [rw] last_check_timestamp
@@ -6392,17 +6493,17 @@ module Aws::CloudFormation
6392
6493
  # Status of the stack's actual configuration compared to its expected
6393
6494
  # template configuration.
6394
6495
  #
6395
- # * `DRIFTED`\: The stack differs from its expected template
6496
+ # * `DRIFTED`: The stack differs from its expected template
6396
6497
  # configuration. A stack is considered to have drifted if one or
6397
6498
  # more of its resources have drifted.
6398
6499
  #
6399
- # * `NOT_CHECKED`\: CloudFormation hasn't checked if the stack
6400
- # differs from its expected template configuration.
6500
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs
6501
+ # from its expected template configuration.
6401
6502
  #
6402
- # * `IN_SYNC`\: The stack's actual configuration matches its expected
6503
+ # * `IN_SYNC`: The stack's actual configuration matches its expected
6403
6504
  # template configuration.
6404
6505
  #
6405
- # * `UNKNOWN`\: This value is reserved for future use.
6506
+ # * `UNKNOWN`: This value is reserved for future use.
6406
6507
  # @return [String]
6407
6508
  #
6408
6509
  # @!attribute [rw] last_check_timestamp
@@ -6572,14 +6673,14 @@ module Aws::CloudFormation
6572
6673
  # The status of the stack instance, in terms of its synchronization
6573
6674
  # with its associated stack set.
6574
6675
  #
6575
- # * `INOPERABLE`\: A `DeleteStackInstances` operation has failed and
6676
+ # * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
6576
6677
  # left the stack in an unstable state. Stacks in this state are
6577
6678
  # excluded from further `UpdateStackSet` operations. You might need
6578
6679
  # to perform a `DeleteStackInstances` operation, with `RetainStacks`
6579
6680
  # set to `true`, to delete the stack instance, and then delete the
6580
6681
  # stack manually.
6581
6682
  #
6582
- # * `OUTDATED`\: The stack isn't currently up to date with the stack
6683
+ # * `OUTDATED`: The stack isn't currently up to date with the stack
6583
6684
  # set because:
6584
6685
  #
6585
6686
  # * The associated stack failed during a `CreateStackSet` or
@@ -6589,7 +6690,7 @@ module Aws::CloudFormation
6589
6690
  # operation that failed or was stopped before the stack was
6590
6691
  # created or updated.
6591
6692
  #
6592
- # * `CURRENT`\: The stack is currently up to date with the stack set.
6693
+ # * `CURRENT`: The stack is currently up to date with the stack set.
6593
6694
  # @return [String]
6594
6695
  #
6595
6696
  # @!attribute [rw] stack_instance_status
@@ -6616,18 +6717,18 @@ module Aws::CloudFormation
6616
6717
  # expected template and parameter configuration of the stack set to
6617
6718
  # which it belongs.
6618
6719
  #
6619
- # * `DRIFTED`\: The stack differs from the expected template and
6720
+ # * `DRIFTED`: The stack differs from the expected template and
6620
6721
  # parameter configuration of the stack set to which it belongs. A
6621
6722
  # stack instance is considered to have drifted if one or more of the
6622
6723
  # resources in the associated stack have drifted.
6623
6724
  #
6624
- # * `NOT_CHECKED`\: CloudFormation hasn't checked if the stack
6725
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
6625
6726
  # instance differs from its expected stack set configuration.
6626
6727
  #
6627
- # * `IN_SYNC`\: The stack instance's actual configuration matches its
6728
+ # * `IN_SYNC`: The stack instance's actual configuration matches its
6628
6729
  # expected stack set configuration.
6629
6730
  #
6630
- # * `UNKNOWN`\: This value is reserved for future use.
6731
+ # * `UNKNOWN`: This value is reserved for future use.
6631
6732
  # @return [String]
6632
6733
  #
6633
6734
  # @!attribute [rw] last_drift_check_timestamp
@@ -6663,30 +6764,34 @@ module Aws::CloudFormation
6663
6764
  # The detailed status of the stack instance.
6664
6765
  #
6665
6766
  # @!attribute [rw] detailed_status
6666
- # * `CANCELLED`\: The operation in the specified account and Region
6667
- # has been canceled. This is either because a user has stopped the
6668
- # stack set operation, or because the failure tolerance of the stack
6669
- # set operation has been exceeded.
6767
+ # * `CANCELLED`: The operation in the specified account and Region has
6768
+ # been canceled. This is either because a user has stopped the stack
6769
+ # set operation, or because the failure tolerance of the stack set
6770
+ # operation has been exceeded.
6670
6771
  #
6671
- # * `FAILED`\: The operation in the specified account and Region
6772
+ # * `FAILED`: The operation in the specified account and Region
6672
6773
  # failed. If the stack set operation fails in enough accounts within
6673
6774
  # a Region, the failure tolerance for the stack set operation as a
6674
6775
  # whole might be exceeded.
6675
6776
  #
6676
- # * `INOPERABLE`\: A `DeleteStackInstances` operation has failed and
6777
+ # * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
6677
6778
  # left the stack in an unstable state. Stacks in this state are
6678
6779
  # excluded from further `UpdateStackSet` operations. You might need
6679
6780
  # to perform a `DeleteStackInstances` operation, with `RetainStacks`
6680
6781
  # set to `true`, to delete the stack instance, and then delete the
6681
6782
  # stack manually.
6682
6783
  #
6683
- # * `PENDING`\: The operation in the specified account and Region has
6784
+ # * `PENDING`: The operation in the specified account and Region has
6684
6785
  # yet to start.
6685
6786
  #
6686
- # * `RUNNING`\: The operation in the specified account and Region is
6787
+ # * `RUNNING`: The operation in the specified account and Region is
6687
6788
  # currently in progress.
6688
6789
  #
6689
- # * `SUCCEEDED`\: The operation in the specified account and Region
6790
+ # * `SKIPPED_SUSPENDED_ACCOUNT`: The operation in the specified
6791
+ # account and Region has been skipped because the account was
6792
+ # suspended at the time of the operation.
6793
+ #
6794
+ # * `SUCCEEDED`: The operation in the specified account and Region
6690
6795
  # completed successfully.
6691
6796
  # @return [String]
6692
6797
  #
@@ -6749,14 +6854,14 @@ module Aws::CloudFormation
6749
6854
  # The status of the stack instance, in terms of its synchronization
6750
6855
  # with its associated stack set.
6751
6856
  #
6752
- # * `INOPERABLE`\: A `DeleteStackInstances` operation has failed and
6857
+ # * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
6753
6858
  # left the stack in an unstable state. Stacks in this state are
6754
6859
  # excluded from further `UpdateStackSet` operations. You might need
6755
6860
  # to perform a `DeleteStackInstances` operation, with `RetainStacks`
6756
6861
  # set to `true`, to delete the stack instance, and then delete the
6757
6862
  # stack manually.
6758
6863
  #
6759
- # * `OUTDATED`\: The stack isn't currently up to date with the stack
6864
+ # * `OUTDATED`: The stack isn't currently up to date with the stack
6760
6865
  # set because:
6761
6866
  #
6762
6867
  # * The associated stack failed during a `CreateStackSet` or
@@ -6766,7 +6871,7 @@ module Aws::CloudFormation
6766
6871
  # operation that failed or was stopped before the stack was
6767
6872
  # created or updated.
6768
6873
  #
6769
- # * `CURRENT`\: The stack is currently up to date with the stack set.
6874
+ # * `CURRENT`: The stack is currently up to date with the stack set.
6770
6875
  # @return [String]
6771
6876
  #
6772
6877
  # @!attribute [rw] status_reason
@@ -6793,18 +6898,18 @@ module Aws::CloudFormation
6793
6898
  # expected template and parameter configuration of the stack set to
6794
6899
  # which it belongs.
6795
6900
  #
6796
- # * `DRIFTED`\: The stack differs from the expected template and
6901
+ # * `DRIFTED`: The stack differs from the expected template and
6797
6902
  # parameter configuration of the stack set to which it belongs. A
6798
6903
  # stack instance is considered to have drifted if one or more of the
6799
6904
  # resources in the associated stack have drifted.
6800
6905
  #
6801
- # * `NOT_CHECKED`\: CloudFormation hasn't checked if the stack
6906
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
6802
6907
  # instance differs from its expected stack set configuration.
6803
6908
  #
6804
- # * `IN_SYNC`\: The stack instance's actual configuration matches its
6909
+ # * `IN_SYNC`: The stack instance's actual configuration matches its
6805
6910
  # expected stack set configuration.
6806
6911
  #
6807
- # * `UNKNOWN`\: This value is reserved for future use.
6912
+ # * `UNKNOWN`: This value is reserved for future use.
6808
6913
  # @return [String]
6809
6914
  #
6810
6915
  # @!attribute [rw] last_drift_check_timestamp
@@ -7086,17 +7191,17 @@ module Aws::CloudFormation
7086
7191
  # Status of the resource's actual configuration compared to its
7087
7192
  # expected configuration.
7088
7193
  #
7089
- # * `DELETED`\: The resource differs from its expected template
7194
+ # * `DELETED`: The resource differs from its expected template
7090
7195
  # configuration because the resource has been deleted.
7091
7196
  #
7092
- # * `MODIFIED`\: One or more resource properties differ from their
7197
+ # * `MODIFIED`: One or more resource properties differ from their
7093
7198
  # expected values (as defined in the stack template and any values
7094
7199
  # specified as template parameters).
7095
7200
  #
7096
- # * `IN_SYNC`\: The resource's actual configuration matches its
7201
+ # * `IN_SYNC`: The resource's actual configuration matches its
7097
7202
  # expected template configuration.
7098
7203
  #
7099
- # * `NOT_CHECKED`\: CloudFormation does not currently return this
7204
+ # * `NOT_CHECKED`: CloudFormation does not currently return this
7100
7205
  # value.
7101
7206
  # @return [String]
7102
7207
  #
@@ -7137,19 +7242,19 @@ module Aws::CloudFormation
7137
7242
  # Status of the resource's actual configuration compared to its
7138
7243
  # expected configuration
7139
7244
  #
7140
- # * `DELETED`\: The resource differs from its expected configuration
7141
- # in that it has been deleted.
7245
+ # * `DELETED`: The resource differs from its expected configuration in
7246
+ # that it has been deleted.
7142
7247
  #
7143
- # * `MODIFIED`\: The resource differs from its expected configuration.
7248
+ # * `MODIFIED`: The resource differs from its expected configuration.
7144
7249
  #
7145
- # * `NOT_CHECKED`\: CloudFormation has not checked if the resource
7250
+ # * `NOT_CHECKED`: CloudFormation has not checked if the resource
7146
7251
  # differs from its expected configuration.
7147
7252
  #
7148
7253
  # Any resources that do not currently support drift detection have a
7149
7254
  # status of `NOT_CHECKED`. For more information, see [Resources that
7150
7255
  # Support Drift Detection][1].
7151
7256
  #
7152
- # * `IN_SYNC`\: The resource's actual configuration matches its
7257
+ # * `IN_SYNC`: The resource's actual configuration matches its
7153
7258
  # expected configuration.
7154
7259
  #
7155
7260
  #
@@ -7179,12 +7284,12 @@ module Aws::CloudFormation
7179
7284
  # Status of the resource's actual configuration compared to its
7180
7285
  # expected configuration.
7181
7286
  #
7182
- # * `DELETED`\: The resource differs from its expected configuration
7183
- # in that it has been deleted.
7287
+ # * `DELETED`: The resource differs from its expected configuration in
7288
+ # that it has been deleted.
7184
7289
  #
7185
- # * `MODIFIED`\: The resource differs from its expected configuration.
7290
+ # * `MODIFIED`: The resource differs from its expected configuration.
7186
7291
  #
7187
- # * `NOT_CHECKED`\: CloudFormation hasn't checked if the resource
7292
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the resource
7188
7293
  # differs from its expected configuration.
7189
7294
  #
7190
7295
  # Any resources that don't currently support drift detection have a
@@ -7196,7 +7301,7 @@ module Aws::CloudFormation
7196
7301
  # during rollback operations, see [Continue Rolling Back an
7197
7302
  # Update][2] in the CloudFormation User Guide.
7198
7303
  #
7199
- # * `IN_SYNC`\: The resource's actual configuration matches its
7304
+ # * `IN_SYNC`: The resource's actual configuration matches its
7200
7305
  # expected configuration.
7201
7306
  #
7202
7307
  #
@@ -7410,6 +7515,9 @@ module Aws::CloudFormation
7410
7515
  # @return [Types::ManagedExecution]
7411
7516
  #
7412
7517
  # @!attribute [rw] regions
7518
+ # Returns a list of all Amazon Web Services Regions the given StackSet
7519
+ # has stack instances deployed in. The Amazon Web Services Regions
7520
+ # list output is in no particular order.
7413
7521
  # @return [Array<String>]
7414
7522
  #
7415
7523
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSet AWS API Documentation
@@ -7459,15 +7567,15 @@ module Aws::CloudFormation
7459
7567
  # have drifted from their expected template and parameter
7460
7568
  # configuration.
7461
7569
  #
7462
- # * `DRIFTED`\: One or more of the stack instances belonging to the
7570
+ # * `DRIFTED`: One or more of the stack instances belonging to the
7463
7571
  # stack set stack differs from the expected template and parameter
7464
7572
  # configuration. A stack instance is considered to have drifted if
7465
7573
  # one or more of the resources in the associated stack have drifted.
7466
7574
  #
7467
- # * `NOT_CHECKED`\: CloudFormation hasn't checked the stack set for
7575
+ # * `NOT_CHECKED`: CloudFormation hasn't checked the stack set for
7468
7576
  # drift.
7469
7577
  #
7470
- # * `IN_SYNC`\: All of the stack instances belonging to the stack set
7578
+ # * `IN_SYNC`: All of the stack instances belonging to the stack set
7471
7579
  # stack match from the expected template and parameter
7472
7580
  # configuration.
7473
7581
  # @return [String]
@@ -7475,19 +7583,19 @@ module Aws::CloudFormation
7475
7583
  # @!attribute [rw] drift_detection_status
7476
7584
  # The status of the stack set drift detection operation.
7477
7585
  #
7478
- # * `COMPLETED`\: The drift detection operation completed without
7586
+ # * `COMPLETED`: The drift detection operation completed without
7479
7587
  # failing on any stack instances.
7480
7588
  #
7481
- # * `FAILED`\: The drift detection operation exceeded the specified
7589
+ # * `FAILED`: The drift detection operation exceeded the specified
7482
7590
  # failure tolerance.
7483
7591
  #
7484
- # * `PARTIAL_SUCCESS`\: The drift detection operation completed
7485
- # without exceeding the failure tolerance for the operation.
7592
+ # * `PARTIAL_SUCCESS`: The drift detection operation completed without
7593
+ # exceeding the failure tolerance for the operation.
7486
7594
  #
7487
- # * `IN_PROGRESS`\: The drift detection operation is currently being
7595
+ # * `IN_PROGRESS`: The drift detection operation is currently being
7488
7596
  # performed.
7489
7597
  #
7490
- # * `STOPPED`\: The user has canceled the drift detection operation.
7598
+ # * `STOPPED`: The user has canceled the drift detection operation.
7491
7599
  # @return [String]
7492
7600
  #
7493
7601
  # @!attribute [rw] last_drift_check_timestamp
@@ -7584,7 +7692,7 @@ module Aws::CloudFormation
7584
7692
  # @!attribute [rw] status
7585
7693
  # The status of the operation.
7586
7694
  #
7587
- # * `FAILED`\: The operation exceeded the specified failure tolerance.
7695
+ # * `FAILED`: The operation exceeded the specified failure tolerance.
7588
7696
  # The failure tolerance value that you've set for an operation is
7589
7697
  # applied for each Region during stack create and update operations.
7590
7698
  # If the number of failed stacks within a Region exceeds the failure
@@ -7593,19 +7701,19 @@ module Aws::CloudFormation
7593
7701
  # to `FAILED`, and CloudFormation cancels the operation in any
7594
7702
  # remaining Regions.
7595
7703
  #
7596
- # * `QUEUED`\: \[Service-managed permissions\] For automatic
7704
+ # * `QUEUED`: \[Service-managed permissions\] For automatic
7597
7705
  # deployments that require a sequence of operations, the operation
7598
7706
  # is queued to be performed. For more information, see the [stack
7599
7707
  # set operation status codes][1] in the CloudFormation User Guide.
7600
7708
  #
7601
- # * `RUNNING`\: The operation is currently being performed.
7709
+ # * `RUNNING`: The operation is currently being performed.
7602
7710
  #
7603
- # * `STOPPED`\: The user has canceled the operation.
7711
+ # * `STOPPED`: The user has canceled the operation.
7604
7712
  #
7605
- # * `STOPPING`\: The operation is in the process of stopping, at user
7713
+ # * `STOPPING`: The operation is in the process of stopping, at user
7606
7714
  # request.
7607
7715
  #
7608
- # * `SUCCEEDED`\: The operation completed creating or updating all the
7716
+ # * `SUCCEEDED`: The operation completed creating or updating all the
7609
7717
  # specified stacks without exceeding the failure tolerance for the
7610
7718
  # operation.
7611
7719
  #
@@ -7730,7 +7838,7 @@ module Aws::CloudFormation
7730
7838
  # @return [String]
7731
7839
  #
7732
7840
  # @!attribute [rw] region_order
7733
- # The order of the Regions in where you want to perform the stack
7841
+ # The order of the Regions where you want to perform the stack
7734
7842
  # operation.
7735
7843
  # @return [Array<String>]
7736
7844
  #
@@ -7828,25 +7936,25 @@ module Aws::CloudFormation
7828
7936
  # The result status of the stack set operation for the given account
7829
7937
  # in the given Region.
7830
7938
  #
7831
- # * `CANCELLED`\: The operation in the specified account and Region
7832
- # has been canceled. This is either because a user has stopped the
7833
- # stack set operation, or because the failure tolerance of the stack
7834
- # set operation has been exceeded.
7939
+ # * `CANCELLED`: The operation in the specified account and Region has
7940
+ # been canceled. This is either because a user has stopped the stack
7941
+ # set operation, or because the failure tolerance of the stack set
7942
+ # operation has been exceeded.
7835
7943
  #
7836
- # * `FAILED`\: The operation in the specified account and Region
7944
+ # * `FAILED`: The operation in the specified account and Region
7837
7945
  # failed.
7838
7946
  #
7839
7947
  # If the stack set operation fails in enough accounts within a
7840
7948
  # Region, the failure tolerance for the stack set operation as a
7841
7949
  # whole might be exceeded.
7842
7950
  #
7843
- # * `RUNNING`\: The operation in the specified account and Region is
7951
+ # * `RUNNING`: The operation in the specified account and Region is
7844
7952
  # currently in progress.
7845
7953
  #
7846
- # * `PENDING`\: The operation in the specified account and Region has
7954
+ # * `PENDING`: The operation in the specified account and Region has
7847
7955
  # yet to start.
7848
7956
  #
7849
- # * `SUCCEEDED`\: The operation in the specified account and Region
7957
+ # * `SUCCEEDED`: The operation in the specified account and Region
7850
7958
  # completed successfully.
7851
7959
  # @return [String]
7852
7960
  #
@@ -7914,7 +8022,7 @@ module Aws::CloudFormation
7914
8022
  # @!attribute [rw] status
7915
8023
  # The overall status of the operation.
7916
8024
  #
7917
- # * `FAILED`\: The operation exceeded the specified failure tolerance.
8025
+ # * `FAILED`: The operation exceeded the specified failure tolerance.
7918
8026
  # The failure tolerance value that you've set for an operation is
7919
8027
  # applied for each Region during stack create and update operations.
7920
8028
  # If the number of failed stacks within a Region exceeds the failure
@@ -7923,19 +8031,19 @@ module Aws::CloudFormation
7923
8031
  # to `FAILED`, and CloudFormation cancels the operation in any
7924
8032
  # remaining Regions.
7925
8033
  #
7926
- # * `QUEUED`\: \[Service-managed permissions\] For automatic
8034
+ # * `QUEUED`: \[Service-managed permissions\] For automatic
7927
8035
  # deployments that require a sequence of operations, the operation
7928
8036
  # is queued to be performed. For more information, see the [stack
7929
8037
  # set operation status codes][1] in the CloudFormation User Guide.
7930
8038
  #
7931
- # * `RUNNING`\: The operation is currently being performed.
8039
+ # * `RUNNING`: The operation is currently being performed.
7932
8040
  #
7933
- # * `STOPPED`\: The user has canceled the operation.
8041
+ # * `STOPPED`: The user has canceled the operation.
7934
8042
  #
7935
- # * `STOPPING`\: The operation is in the process of stopping, at user
8043
+ # * `STOPPING`: The operation is in the process of stopping, at user
7936
8044
  # request.
7937
8045
  #
7938
- # * `SUCCEEDED`\: The operation completed creating or updating all the
8046
+ # * `SUCCEEDED`: The operation completed creating or updating all the
7939
8047
  # specified stacks without exceeding the failure tolerance for the
7940
8048
  # operation.
7941
8049
  #
@@ -8048,19 +8156,19 @@ module Aws::CloudFormation
8048
8156
  # have drifted from their expected template and parameter
8049
8157
  # configuration.
8050
8158
  #
8051
- # * `DRIFTED`\: One or more of the stack instances belonging to the
8159
+ # * `DRIFTED`: One or more of the stack instances belonging to the
8052
8160
  # stack set stack differs from the expected template and parameter
8053
8161
  # configuration. A stack instance is considered to have drifted if
8054
8162
  # one or more of the resources in the associated stack have drifted.
8055
8163
  #
8056
- # * `NOT_CHECKED`\: CloudFormation hasn't checked the stack set for
8164
+ # * `NOT_CHECKED`: CloudFormation hasn't checked the stack set for
8057
8165
  # drift.
8058
8166
  #
8059
- # * `IN_SYNC`\: All the stack instances belonging to the stack set
8167
+ # * `IN_SYNC`: All the stack instances belonging to the stack set
8060
8168
  # stack match from the expected template and parameter
8061
8169
  # configuration.
8062
8170
  #
8063
- # * `UNKNOWN`\: This value is reserved for future use.
8171
+ # * `UNKNOWN`: This value is reserved for future use.
8064
8172
  # @return [String]
8065
8173
  #
8066
8174
  # @!attribute [rw] last_drift_check_timestamp
@@ -8154,7 +8262,7 @@ module Aws::CloudFormation
8154
8262
  #
8155
8263
  # @!attribute [rw] drift_information
8156
8264
  # Summarizes information about whether a stack's actual configuration
8157
- # differs, or has *drifted*, from it's expected configuration, as
8265
+ # differs, or has *drifted*, from its expected configuration, as
8158
8266
  # defined in the stack template and any values specified as template
8159
8267
  # parameters. For more information, see [Detecting Unregulated
8160
8268
  # Configuration Changes to Stacks and Resources][1].
@@ -8313,7 +8421,7 @@ module Aws::CloudFormation
8313
8421
  # and `Type`.
8314
8422
  #
8315
8423
  # If you don't specify a version, CloudFormation uses the default
8316
- # version of the extension in this account and region for testing.
8424
+ # version of the extension in this account and Region for testing.
8317
8425
  # @return [String]
8318
8426
  #
8319
8427
  # @!attribute [rw] log_delivery_bucket
@@ -8372,7 +8480,7 @@ module Aws::CloudFormation
8372
8480
  class TokenAlreadyExistsException < Aws::EmptyStructure; end
8373
8481
 
8374
8482
  # Detailed information concerning the specification of a CloudFormation
8375
- # extension in a given account and region.
8483
+ # extension in a given account and Region.
8376
8484
  #
8377
8485
  # For more information, see [Configuring extensions at the account
8378
8486
  # level][1] in the *CloudFormation User Guide*.
@@ -8383,7 +8491,7 @@ module Aws::CloudFormation
8383
8491
  #
8384
8492
  # @!attribute [rw] arn
8385
8493
  # The Amazon Resource Name (ARN) for the configuration data, in this
8386
- # account and region.
8494
+ # account and Region.
8387
8495
  # @return [String]
8388
8496
  #
8389
8497
  # @!attribute [rw] alias
@@ -8393,7 +8501,7 @@ module Aws::CloudFormation
8393
8501
  #
8394
8502
  # @!attribute [rw] configuration
8395
8503
  # A JSON string specifying the configuration data for the extension,
8396
- # in this account and region.
8504
+ # in this account and Region.
8397
8505
  #
8398
8506
  # If a configuration hasn't been set for a specified extension,
8399
8507
  # CloudFormation returns `\{\}`.
@@ -8408,12 +8516,12 @@ module Aws::CloudFormation
8408
8516
  #
8409
8517
  # @!attribute [rw] type_arn
8410
8518
  # The Amazon Resource Name (ARN) for the extension, in this account
8411
- # and region.
8519
+ # and Region.
8412
8520
  #
8413
8521
  # For public extensions, this will be the ARN assigned when you
8414
- # [activate the type][1] in this account and region. For private
8522
+ # [activate the type][1] in this account and Region. For private
8415
8523
  # extensions, this will be the ARN assigned when you [register the
8416
- # type][2] in this account and region.
8524
+ # type][2] in this account and Region.
8417
8525
  #
8418
8526
  #
8419
8527
  #
@@ -8449,12 +8557,12 @@ module Aws::CloudFormation
8449
8557
  #
8450
8558
  # @!attribute [rw] type_arn
8451
8559
  # The Amazon Resource Name (ARN) for the extension, in this account
8452
- # and region.
8560
+ # and Region.
8453
8561
  #
8454
8562
  # For public extensions, this will be the ARN assigned when you
8455
- # [activate the type][1] in this account and region. For private
8563
+ # [activate the type][1] in this account and Region. For private
8456
8564
  # extensions, this will be the ARN assigned when you [register the
8457
- # type][2] in this account and region.
8565
+ # type][2] in this account and Region.
8458
8566
  #
8459
8567
  #
8460
8568
  #
@@ -8469,7 +8577,7 @@ module Aws::CloudFormation
8469
8577
  #
8470
8578
  # @!attribute [rw] type_configuration_arn
8471
8579
  # The Amazon Resource Name (ARN) for the configuration, in this
8472
- # account and region.
8580
+ # account and Region.
8473
8581
  # @return [String]
8474
8582
  #
8475
8583
  # @!attribute [rw] type
@@ -8503,13 +8611,13 @@ module Aws::CloudFormation
8503
8611
  # @!attribute [rw] category
8504
8612
  # The category of extensions to return.
8505
8613
  #
8506
- # * `REGISTERED`\: Private extensions that have been registered for
8507
- # this account and region.
8614
+ # * `REGISTERED`: Private extensions that have been registered for
8615
+ # this account and Region.
8508
8616
  #
8509
- # * `ACTIVATED`\: Public extensions that have been activated for this
8510
- # account and region.
8617
+ # * `ACTIVATED`: Public extensions that have been activated for this
8618
+ # account and Region.
8511
8619
  #
8512
- # * `THIRD_PARTY`\: Extensions available for use from publishers other
8620
+ # * `THIRD_PARTY`: Extensions available for use from publishers other
8513
8621
  # than Amazon. This includes:
8514
8622
  #
8515
8623
  # * Private extensions registered in the account.
@@ -8517,7 +8625,7 @@ module Aws::CloudFormation
8517
8625
  # * Public extensions from publishers other than Amazon, whether
8518
8626
  # activated or not.
8519
8627
  #
8520
- # * `AWS_TYPES`\: Extensions available for use from Amazon.
8628
+ # * `AWS_TYPES`: Extensions available for use from Amazon.
8521
8629
  # @return [String]
8522
8630
  #
8523
8631
  # @!attribute [rw] publisher_id
@@ -8559,7 +8667,7 @@ module Aws::CloudFormation
8559
8667
  # The name of the extension.
8560
8668
  #
8561
8669
  # If you specified a `TypeNameAlias` when you [activate this
8562
- # extension][1] in your account and region, CloudFormation considers
8670
+ # extension][1] in your account and Region, CloudFormation considers
8563
8671
  # that alias as the type name.
8564
8672
  #
8565
8673
  #
@@ -8576,8 +8684,8 @@ module Aws::CloudFormation
8576
8684
  # published by third parties, CloudFormation returns `null`. For more
8577
8685
  # information, see [RegisterType][1].
8578
8686
  #
8579
- # To set the default version of an extension, use `
8580
- # SetTypeDefaultVersion `.
8687
+ # To set the default version of an extension, use
8688
+ # SetTypeDefaultVersion.
8581
8689
  #
8582
8690
  #
8583
8691
  #
@@ -8619,11 +8727,11 @@ module Aws::CloudFormation
8619
8727
  #
8620
8728
  # @!attribute [rw] original_type_name
8621
8729
  # For public extensions that have been activated for this account and
8622
- # region, the type name of the public extension.
8730
+ # Region, the type name of the public extension.
8623
8731
  #
8624
8732
  # If you specified a `TypeNameAlias` when enabling the extension in
8625
- # this account and region, CloudFormation treats that alias as the
8626
- # extension's type name within the account and region, not the type
8733
+ # this account and Region, CloudFormation treats that alias as the
8734
+ # extension's type name within the account and Region, not the type
8627
8735
  # name of the public extension. For more information, see [Specifying
8628
8736
  # aliases to refer to extensions][1] in the *CloudFormation User
8629
8737
  # Guide*.
@@ -8635,12 +8743,12 @@ module Aws::CloudFormation
8635
8743
  #
8636
8744
  # @!attribute [rw] public_version_number
8637
8745
  # For public extensions that have been activated for this account and
8638
- # region, the version of the public extension to be used for
8746
+ # Region, the version of the public extension to be used for
8639
8747
  # CloudFormation operations in this account and Region.
8640
8748
  #
8641
8749
  # How you specified `AutoUpdate` when enabling the extension affects
8642
8750
  # whether CloudFormation automatically updates the extension in this
8643
- # account and region when a new version is released. For more
8751
+ # account and Region when a new version is released. For more
8644
8752
  # information, see [Setting CloudFormation to automatically use new
8645
8753
  # versions of extensions][1] in the *CloudFormation User Guide*.
8646
8754
  #
@@ -8651,13 +8759,13 @@ module Aws::CloudFormation
8651
8759
  #
8652
8760
  # @!attribute [rw] latest_public_version
8653
8761
  # For public extensions that have been activated for this account and
8654
- # region, the latest version of the public extension *that is
8762
+ # Region, the latest version of the public extension *that is
8655
8763
  # available*. For any extensions other than activated third-arty
8656
8764
  # extensions, CloudFormation returns `null`.
8657
8765
  #
8658
8766
  # How you specified `AutoUpdate` when enabling the extension affects
8659
8767
  # whether CloudFormation automatically updates the extension in this
8660
- # account and region when a new version is released. For more
8768
+ # account and Region when a new version is released. For more
8661
8769
  # information, see [Setting CloudFormation to automatically use new
8662
8770
  # versions of extensions][1] in the *CloudFormation User Guide*.
8663
8771
  #
@@ -8684,7 +8792,7 @@ module Aws::CloudFormation
8684
8792
  # @return [String]
8685
8793
  #
8686
8794
  # @!attribute [rw] is_activated
8687
- # Whether the extension is activated for this account and region.
8795
+ # Whether the extension is activated for this account and Region.
8688
8796
  #
8689
8797
  # This applies only to third-party public extensions. Extensions
8690
8798
  # published by Amazon are activated by default.
@@ -8750,14 +8858,14 @@ module Aws::CloudFormation
8750
8858
  #
8751
8859
  # @!attribute [rw] public_version_number
8752
8860
  # For public extensions that have been activated for this account and
8753
- # region, the version of the public extension to be used for
8754
- # CloudFormation operations in this account and region. For any
8861
+ # Region, the version of the public extension to be used for
8862
+ # CloudFormation operations in this account and Region. For any
8755
8863
  # extensions other than activated third-arty extensions,
8756
8864
  # CloudFormation returns `null`.
8757
8865
  #
8758
8866
  # How you specified `AutoUpdate` when enabling the extension affects
8759
8867
  # whether CloudFormation automatically updates the extension in this
8760
- # account and region when a new version is released. For more
8868
+ # account and Region when a new version is released. For more
8761
8869
  # information, see [Setting CloudFormation to automatically use new
8762
8870
  # versions of extensions][1] in the *CloudFormation User Guide*.
8763
8871
  #