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.
@@ -275,6 +275,11 @@ module Aws::CloudFormation
275
275
  # in the future.
276
276
  #
277
277
  #
278
+ # @option options [String] :sdk_ua_app_id
279
+ # A unique and opaque application ID that is appended to the
280
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
281
+ # maximum length of 50.
282
+ #
278
283
  # @option options [String] :secret_access_key
279
284
  #
280
285
  # @option options [String] :session_token
@@ -368,21 +373,36 @@ module Aws::CloudFormation
368
373
 
369
374
  # @!group API Operations
370
375
 
376
+ # Activate trusted access with Organizations. With trusted access
377
+ # between StackSets and Organizations activated, the management account
378
+ # has permissions to create and manage StackSets for your organization.
379
+ #
380
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
381
+ #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccess AWS API Documentation
383
+ #
384
+ # @overload activate_organizations_access(params = {})
385
+ # @param [Hash] params ({})
386
+ def activate_organizations_access(params = {}, options = {})
387
+ req = build_request(:activate_organizations_access, params)
388
+ req.send_request(options)
389
+ end
390
+
371
391
  # Activates a public third-party extension, making it available for use
372
392
  # in stack templates. For more information, see [Using public
373
393
  # extensions][1] in the *CloudFormation User Guide*.
374
394
  #
375
395
  # Once you have activated a public third-party extension in your account
376
- # and region, use
377
- # [SetTypeConfiguration](AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)
378
- # to specify configuration properties for the extension. For more
379
- # information, see [Configuring extensions at the account level][2] in
380
- # the *CloudFormation User Guide*.
396
+ # and Region, use [SetTypeConfiguration][2] to specify configuration
397
+ # properties for the extension. For more information, see [Configuring
398
+ # extensions at the account level][3] in the *CloudFormation User
399
+ # Guide*.
381
400
  #
382
401
  #
383
402
  #
384
403
  # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html
385
- # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
404
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
405
+ # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
386
406
  #
387
407
  # @option params [String] :type
388
408
  # The extension type.
@@ -410,18 +430,18 @@ module Aws::CloudFormation
410
430
  #
411
431
  # @option params [String] :type_name_alias
412
432
  # An alias to assign to the public extension, in this account and
413
- # region. If you specify an alias for the extension, CloudFormation
433
+ # Region. If you specify an alias for the extension, CloudFormation
414
434
  # treats the alias as the extension type name within this account and
415
- # region. You must use the alias to refer to the extension in your
435
+ # Region. You must use the alias to refer to the extension in your
416
436
  # templates, API calls, and CloudFormation console.
417
437
  #
418
- # An extension alias must be unique within a given account and region.
438
+ # An extension alias must be unique within a given account and Region.
419
439
  # You can activate the same public resource multiple times in the same
420
- # account and region, using different type name aliases.
440
+ # account and Region, using different type name aliases.
421
441
  #
422
442
  # @option params [Boolean] :auto_update
423
443
  # Whether to automatically update the extension in this account and
424
- # region when a new *minor* version is published by the extension
444
+ # Region when a new *minor* version is published by the extension
425
445
  # publisher. Major versions released by the publisher must be manually
426
446
  # updated.
427
447
  #
@@ -438,10 +458,10 @@ module Aws::CloudFormation
438
458
  # version, if available. You can also use this parameter to update the
439
459
  # value of `AutoUpdate`.
440
460
  #
441
- # * `MAJOR`\: CloudFormation updates the extension to the newest major
461
+ # * `MAJOR`: CloudFormation updates the extension to the newest major
442
462
  # version, if one is available.
443
463
  #
444
- # * `MINOR`\: CloudFormation updates the extension to the newest minor
464
+ # * `MINOR`: CloudFormation updates the extension to the newest minor
445
465
  # version, if one is available.
446
466
  #
447
467
  # @option params [Integer] :major_version
@@ -489,7 +509,7 @@ module Aws::CloudFormation
489
509
 
490
510
  # Returns configuration data for the specified CloudFormation
491
511
  # extensions, from the CloudFormation registry for the account and
492
- # region.
512
+ # Region.
493
513
  #
494
514
  # For more information, see [Configuring extensions at the account
495
515
  # level][1] in the *CloudFormation User Guide*.
@@ -564,6 +584,19 @@ module Aws::CloudFormation
564
584
  # </note>
565
585
  #
566
586
  # @option params [required, String] :stack_name
587
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
588
+ # response that describes all resources in the account.
589
+ #
590
+ # The IAM policy below can be added to IAM policies when you want to
591
+ # limit resource-level permissions and avoid returning a response when
592
+ # no parameter is sent in the request:
593
+ #
594
+ # `\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny",
595
+ # "Action": "cloudformation:DescribeStacks", "NotResource":
596
+ # "arn:aws:cloudformation:*:*:stack/*/*" \}] \}`
597
+ #
598
+ # </note>
599
+ #
567
600
  # The name or the unique stack ID that's associated with the stack.
568
601
  #
569
602
  # @option params [String] :client_request_token
@@ -682,7 +715,7 @@ module Aws::CloudFormation
682
715
  #
683
716
  # @option params [String] :client_request_token
684
717
  # A unique identifier for this `ContinueUpdateRollback` request. Specify
685
- # this token if you plan to retry requests so that CloudFormationknows
718
+ # this token if you plan to retry requests so that CloudFormation knows
686
719
  # that you're not attempting to continue the rollback to a stack with
687
720
  # the same name. You might retry `ContinueUpdateRollback` requests to
688
721
  # ensure that CloudFormation successfully received them.
@@ -925,7 +958,7 @@ module Aws::CloudFormation
925
958
  #
926
959
  # If you create a change set for a new stack, CloudFormation creates a
927
960
  # stack with a unique stack ID, but no template or resources. The stack
928
- # will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you execute the
961
+ # will be in the [REVIEW\_IN\_PROGRESS][1] state until you execute the
929
962
  # change set.
930
963
  #
931
964
  # By default, CloudFormation specifies `UPDATE`. You can't use the
@@ -1015,7 +1048,7 @@ module Aws::CloudFormation
1015
1048
 
1016
1049
  # Creates a stack as specified in the template. After the call completes
1017
1050
  # successfully, the stack creation starts. You can check the status of
1018
- # the stack through the DescribeStacksoperation.
1051
+ # the stack through the DescribeStacks operation.
1019
1052
  #
1020
1053
  # @option params [required, String] :stack_name
1021
1054
  # The name that's associated with the stack. The name must be unique in
@@ -1767,8 +1800,23 @@ module Aws::CloudFormation
1767
1800
  req.send_request(options)
1768
1801
  end
1769
1802
 
1803
+ # Deactivates trusted access with Organizations. If trusted access is
1804
+ # deactivated, the management account does not have permissions to
1805
+ # create and manage service-managed StackSets for your organization.
1806
+ #
1807
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1808
+ #
1809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccess AWS API Documentation
1810
+ #
1811
+ # @overload deactivate_organizations_access(params = {})
1812
+ # @param [Hash] params ({})
1813
+ def deactivate_organizations_access(params = {}, options = {})
1814
+ req = build_request(:deactivate_organizations_access, params)
1815
+ req.send_request(options)
1816
+ end
1817
+
1770
1818
  # Deactivates a public extension that was previously activated in this
1771
- # account and region.
1819
+ # account and Region.
1772
1820
  #
1773
1821
  # Once deactivated, an extension can't be used in any CloudFormation
1774
1822
  # operation. This includes stack update operations where the stack
@@ -1777,7 +1825,7 @@ module Aws::CloudFormation
1777
1825
  # automatically updated if a new version of the extension is released.
1778
1826
  #
1779
1827
  # @option params [String] :type_name
1780
- # The type name of the extension, in this account and region. If you
1828
+ # The type name of the extension, in this account and Region. If you
1781
1829
  # specified a type name alias when enabling the extension, use the type
1782
1830
  # name alias.
1783
1831
  #
@@ -1790,7 +1838,7 @@ module Aws::CloudFormation
1790
1838
  #
1791
1839
  # @option params [String] :arn
1792
1840
  # The Amazon Resource Name (ARN) for the extension, in this account and
1793
- # region.
1841
+ # Region.
1794
1842
  #
1795
1843
  # Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
1796
1844
  #
@@ -2374,6 +2422,56 @@ module Aws::CloudFormation
2374
2422
  req.send_request(options)
2375
2423
  end
2376
2424
 
2425
+ # Retrieves information about the account's `OrganizationAccess`
2426
+ # status. This API can be called either by the management account or the
2427
+ # delegated administrator by using the `CallAs` parameter. This API can
2428
+ # also be called without the `CallAs` parameter by the management
2429
+ # account.
2430
+ #
2431
+ # @option params [String] :call_as
2432
+ # \[Service-managed permissions\] Specifies whether you are acting as an
2433
+ # account administrator in the organization's management account or as
2434
+ # a delegated administrator in a member account.
2435
+ #
2436
+ # By default, `SELF` is specified.
2437
+ #
2438
+ # * If you are signed in to the management account, specify `SELF`.
2439
+ #
2440
+ # * If you are signed in to a delegated administrator account, specify
2441
+ # `DELEGATED_ADMIN`.
2442
+ #
2443
+ # Your Amazon Web Services account must be registered as a delegated
2444
+ # administrator in the management account. For more information, see
2445
+ # [Register a delegated administrator][1] in the *CloudFormation User
2446
+ # Guide*.
2447
+ #
2448
+ #
2449
+ #
2450
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
2451
+ #
2452
+ # @return [Types::DescribeOrganizationsAccessOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2453
+ #
2454
+ # * {Types::DescribeOrganizationsAccessOutput#status #status} => String
2455
+ #
2456
+ # @example Request syntax with placeholder values
2457
+ #
2458
+ # resp = client.describe_organizations_access({
2459
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
2460
+ # })
2461
+ #
2462
+ # @example Response structure
2463
+ #
2464
+ # resp.status #=> String, one of "ENABLED", "DISABLED", "DISABLED_PERMANENTLY"
2465
+ #
2466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccess AWS API Documentation
2467
+ #
2468
+ # @overload describe_organizations_access(params = {})
2469
+ # @param [Hash] params ({})
2470
+ def describe_organizations_access(params = {}, options = {})
2471
+ req = build_request(:describe_organizations_access, params)
2472
+ req.send_request(options)
2473
+ end
2474
+
2377
2475
  # Returns information about a CloudFormation extension publisher.
2378
2476
  #
2379
2477
  # If you don't supply a `PublisherId`, and you have registered as an
@@ -2430,7 +2528,7 @@ module Aws::CloudFormation
2430
2528
 
2431
2529
  # Returns information about a stack drift detection operation. A stack
2432
2530
  # drift detection operation detects whether a stack's actual
2433
- # configuration differs, or has *drifted*, from it's expected
2531
+ # configuration differs, or has *drifted*, from its expected
2434
2532
  # configuration, as defined in the stack template and any values
2435
2533
  # specified as template parameters. A stack is considered to have
2436
2534
  # drifted if one or more of its resources have drifted. For more
@@ -2563,11 +2661,11 @@ module Aws::CloudFormation
2563
2661
  req.send_request(options)
2564
2662
  end
2565
2663
 
2566
- # Returns the stack instance that's associated with the specified stack
2567
- # set, Amazon Web Services account, and Region.
2664
+ # Returns the stack instance that's associated with the specified
2665
+ # StackSet, Amazon Web Services account, and Amazon Web Services Region.
2568
2666
  #
2569
2667
  # For a list of stack instances that are associated with a specific
2570
- # stack set, use ListStackInstances.
2668
+ # StackSet, use ListStackInstances.
2571
2669
  #
2572
2670
  # @option params [required, String] :stack_set_name
2573
2671
  # The name or the unique stack ID of the stack set that you want to get
@@ -2627,7 +2725,7 @@ module Aws::CloudFormation
2627
2725
  # resp.stack_instance.parameter_overrides[0].use_previous_value #=> Boolean
2628
2726
  # resp.stack_instance.parameter_overrides[0].resolved_value #=> String
2629
2727
  # resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
2630
- # resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE"
2728
+ # resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT"
2631
2729
  # resp.stack_instance.status_reason #=> String
2632
2730
  # resp.stack_instance.organizational_unit_id #=> String
2633
2731
  # resp.stack_instance.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
@@ -2729,16 +2827,16 @@ module Aws::CloudFormation
2729
2827
  # The resource drift status values to use as filters for the resource
2730
2828
  # drift results returned.
2731
2829
  #
2732
- # * `DELETED`\: The resource differs from its expected template
2830
+ # * `DELETED`: The resource differs from its expected template
2733
2831
  # configuration in that the resource has been deleted.
2734
2832
  #
2735
- # * `MODIFIED`\: One or more resource properties differ from their
2833
+ # * `MODIFIED`: One or more resource properties differ from their
2736
2834
  # expected template values.
2737
2835
  #
2738
- # * `IN_SYNC`\: The resource's actual configuration matches its
2739
- # expected template configuration.
2836
+ # * `IN_SYNC`: The resource's actual configuration matches its expected
2837
+ # template configuration.
2740
2838
  #
2741
- # * `NOT_CHECKED`\: CloudFormation doesn't currently return this value.
2839
+ # * `NOT_CHECKED`: CloudFormation doesn't currently return this value.
2742
2840
  #
2743
2841
  # @option params [String] :next_token
2744
2842
  # A string that identifies the next page of stack resource drift
@@ -2898,7 +2996,7 @@ module Aws::CloudFormation
2898
2996
  req.send_request(options)
2899
2997
  end
2900
2998
 
2901
- # Returns the description of the specified stack set.
2999
+ # Returns the description of the specified StackSet.
2902
3000
  #
2903
3001
  # @option params [required, String] :stack_set_name
2904
3002
  # The name or unique ID of the stack set whose description you want.
@@ -2982,7 +3080,7 @@ module Aws::CloudFormation
2982
3080
  req.send_request(options)
2983
3081
  end
2984
3082
 
2985
- # Returns the description of the specified stack set operation.
3083
+ # Returns the description of the specified StackSet operation.
2986
3084
  #
2987
3085
  # @option params [required, String] :stack_set_name
2988
3086
  # The name or the unique stack ID of the stack set for the stack
@@ -3077,6 +3175,21 @@ module Aws::CloudFormation
3077
3175
  # </note>
3078
3176
  #
3079
3177
  # @option params [String] :stack_name
3178
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
3179
+ # response that describes all resources in the account. This requires
3180
+ # `ListStacks` and `DescribeStacks` permissions.
3181
+ #
3182
+ # The IAM policy below can be added to IAM policies when you want to
3183
+ # limit resource-level permissions and avoid returning a response when
3184
+ # no parameter is sent in the request:
3185
+ #
3186
+ # \\\{ "Version": "2012-10-17", "Statement": \[\\\{ "Effect":
3187
+ # "Deny", "Action": "cloudformation:DescribeStacks",
3188
+ # "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" \\}\]
3189
+ # \\}
3190
+ #
3191
+ # </note>
3192
+ #
3080
3193
  # The name or the unique stack ID that's associated with the stack,
3081
3194
  # which aren't always interchangeable:
3082
3195
  #
@@ -3296,18 +3409,18 @@ module Aws::CloudFormation
3296
3409
  # Returns information about an extension's registration, including its
3297
3410
  # current status and type and version identifiers.
3298
3411
  #
3299
- # When you initiate a registration request using ` RegisterType `, you
3300
- # can then use ` DescribeTypeRegistration ` to monitor the progress of
3301
- # that registration request.
3412
+ # When you initiate a registration request using RegisterType, you can
3413
+ # then use DescribeTypeRegistration to monitor the progress of that
3414
+ # registration request.
3302
3415
  #
3303
- # Once the registration request has completed, use ` DescribeType ` to
3416
+ # Once the registration request has completed, use DescribeType to
3304
3417
  # return detailed information about an extension.
3305
3418
  #
3306
3419
  # @option params [required, String] :registration_token
3307
3420
  # The identifier for this registration request.
3308
3421
  #
3309
3422
  # This registration token is generated by CloudFormation when you
3310
- # initiate a registration request using ` RegisterType `.
3423
+ # initiate a registration request using RegisterType.
3311
3424
  #
3312
3425
  # @return [Types::DescribeTypeRegistrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3313
3426
  #
@@ -3344,7 +3457,7 @@ module Aws::CloudFormation
3344
3457
  end
3345
3458
 
3346
3459
  # Detects whether a stack's actual configuration differs, or has
3347
- # *drifted*, from it's expected configuration, as defined in the stack
3460
+ # *drifted*, from its expected configuration, as defined in the stack
3348
3461
  # template and any values specified as template parameters. For each
3349
3462
  # resource in the stack that supports drift detection, CloudFormation
3350
3463
  # compares the actual configuration of the resource with its expected
@@ -3408,13 +3521,13 @@ module Aws::CloudFormation
3408
3521
  end
3409
3522
 
3410
3523
  # Returns information about whether a resource's actual configuration
3411
- # differs, or has *drifted*, from it's expected configuration, as
3412
- # defined in the stack template and any values specified as template
3413
- # parameters. This information includes actual and expected property
3414
- # values for resources in which CloudFormation detects drift. Only
3415
- # resource properties explicitly defined in the stack template are
3416
- # checked for drift. For more information about stack and resource
3417
- # drift, see [Detecting Unregulated Configuration Changes to Stacks and
3524
+ # differs, or has *drifted*, from its expected configuration, as defined
3525
+ # in the stack template and any values specified as template parameters.
3526
+ # This information includes actual and expected property values for
3527
+ # resources in which CloudFormation detects drift. Only resource
3528
+ # properties explicitly defined in the stack template are checked for
3529
+ # drift. For more information about stack and resource drift, see
3530
+ # [Detecting Unregulated Configuration Changes to Stacks and
3418
3531
  # Resources][1].
3419
3532
  #
3420
3533
  # Use `DetectStackResourceDrift` to detect drift on individual
@@ -3485,8 +3598,8 @@ module Aws::CloudFormation
3485
3598
  # stack set][1].
3486
3599
  #
3487
3600
  # `DetectStackSetDrift` returns the `OperationId` of the stack set drift
3488
- # detection operation. Use this operation id with `
3489
- # DescribeStackSetOperation ` to monitor the progress of the drift
3601
+ # detection operation. Use this operation id with
3602
+ # DescribeStackSetOperation to monitor the progress of the drift
3490
3603
  # detection operation. The drift detection operation may take some time,
3491
3604
  # depending on the number of stack instances included in the stack set,
3492
3605
  # in addition to the number of resources included in each stack.
@@ -3494,16 +3607,16 @@ module Aws::CloudFormation
3494
3607
  # Once the operation has completed, use the following actions to return
3495
3608
  # drift information:
3496
3609
  #
3497
- # * Use ` DescribeStackSet ` to return detailed information about the
3498
- # stack set, including detailed information about the last *completed*
3499
- # drift operation performed on the stack set. (Information about drift
3610
+ # * Use DescribeStackSet to return detailed information about the stack
3611
+ # set, including detailed information about the last *completed* drift
3612
+ # operation performed on the stack set. (Information about drift
3500
3613
  # operations that are in progress isn't included.)
3501
3614
  #
3502
- # * Use ` ListStackInstances ` to return a list of stack instances
3503
- # belonging to the stack set, including the drift status and last
3504
- # drift time checked of each instance.
3615
+ # * Use ListStackInstances to return a list of stack instances belonging
3616
+ # to the stack set, including the drift status and last drift time
3617
+ # checked of each instance.
3505
3618
  #
3506
- # * Use ` DescribeStackInstance ` to return detailed information about a
3619
+ # * Use DescribeStackInstance to return detailed information about a
3507
3620
  # specific stack instance, including its drift status and last drift
3508
3621
  # time checked.
3509
3622
  #
@@ -3513,8 +3626,8 @@ module Aws::CloudFormation
3513
3626
  # You can only run a single drift detection operation on a given stack
3514
3627
  # set at one time.
3515
3628
  #
3516
- # To stop a drift detection stack set operation, use `
3517
- # StopStackSetOperation `.
3629
+ # To stop a drift detection stack set operation, use
3630
+ # StopStackSetOperation.
3518
3631
  #
3519
3632
  #
3520
3633
  #
@@ -3952,11 +4065,6 @@ module Aws::CloudFormation
3952
4065
  # and Region, by specifying the stack ID of the stack you intend to
3953
4066
  # import.
3954
4067
  #
3955
- # <note markdown="1"> `ImportStacksToStackSet` is only supported by self-managed
3956
- # permissions.
3957
- #
3958
- # </note>
3959
- #
3960
4068
  # @option params [required, String] :stack_set_name
3961
4069
  # The name of the stack set. The name must be unique in the Region where
3962
4070
  # you create your stack set.
@@ -4092,7 +4200,7 @@ module Aws::CloudFormation
4092
4200
  # Lists all exported output values in the account and Region in which
4093
4201
  # you call this action. Use this action to see the exported output
4094
4202
  # values that you can import into other stacks. To import values, use
4095
- # the [ `Fn::ImportValue` ][1] function.
4203
+ # the [ Fn::ImportValue][1] function.
4096
4204
  #
4097
4205
  # For more information, see [ CloudFormation export stack output
4098
4206
  # values][2].
@@ -4142,7 +4250,7 @@ module Aws::CloudFormation
4142
4250
  # your account, see ListExports.
4143
4251
  #
4144
4252
  # For more information about importing an exported output value, see the
4145
- # [ `Fn::ImportValue` ][1] function.
4253
+ # [Fn::ImportValue][1] function.
4146
4254
  #
4147
4255
  #
4148
4256
  #
@@ -4274,7 +4382,7 @@ module Aws::CloudFormation
4274
4382
  # resp.summaries[0].stack_id #=> String
4275
4383
  # resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
4276
4384
  # resp.summaries[0].status_reason #=> String
4277
- # resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE"
4385
+ # resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT"
4278
4386
  # resp.summaries[0].organizational_unit_id #=> String
4279
4387
  # resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
4280
4388
  # resp.summaries[0].last_drift_check_timestamp #=> Time
@@ -4790,12 +4898,12 @@ module Aws::CloudFormation
4790
4898
  #
4791
4899
  # Valid values include:
4792
4900
  #
4793
- # * `LIVE`\: The extension version is registered and can be used in
4901
+ # * `LIVE`: The extension version is registered and can be used in
4794
4902
  # CloudFormation operations, dependent on its provisioning behavior
4795
4903
  # and visibility scope.
4796
4904
  #
4797
- # * `DEPRECATED`\: The extension version has been deregistered and can
4798
- # no longer be used in CloudFormation operations.
4905
+ # * `DEPRECATED`: The extension version has been deregistered and can no
4906
+ # longer be used in CloudFormation operations.
4799
4907
  #
4800
4908
  # The default is `LIVE`.
4801
4909
  #
@@ -4854,15 +4962,15 @@ module Aws::CloudFormation
4854
4962
  #
4855
4963
  # Valid values include:
4856
4964
  #
4857
- # * `PRIVATE`\: Extensions that are visible and usable within this
4858
- # account and region. This includes:
4965
+ # * `PRIVATE`: Extensions that are visible and usable within this
4966
+ # account and Region. This includes:
4859
4967
  #
4860
- # * Private extensions you have registered in this account and region.
4968
+ # * Private extensions you have registered in this account and Region.
4861
4969
  #
4862
4970
  # * Public extensions that you have activated in this account and
4863
- # region.
4971
+ # Region.
4864
4972
  #
4865
- # * `PUBLIC`\: Extensions that are publicly visible and available to be
4973
+ # * `PUBLIC`: Extensions that are publicly visible and available to be
4866
4974
  # activated within any Amazon Web Services account. This includes
4867
4975
  # extensions from Amazon Web Services, in addition to third-party
4868
4976
  # publishers.
@@ -4877,14 +4985,14 @@ module Aws::CloudFormation
4877
4985
  #
4878
4986
  # Valid values include:
4879
4987
  #
4880
- # * `FULLY_MUTABLE`\: The resource type includes an update handler to
4988
+ # * `FULLY_MUTABLE`: The resource type includes an update handler to
4881
4989
  # process updates to the type during stack update operations.
4882
4990
  #
4883
- # * `IMMUTABLE`\: The resource type doesn't include an update handler,
4991
+ # * `IMMUTABLE`: The resource type doesn't include an update handler,
4884
4992
  # so the type can't be updated and must instead be replaced during
4885
4993
  # stack update operations.
4886
4994
  #
4887
- # * `NON_PROVISIONABLE`\: The resource type doesn't include create,
4995
+ # * `NON_PROVISIONABLE`: The resource type doesn't include create,
4888
4996
  # read, and delete handlers, and therefore can't actually be
4889
4997
  # provisioned.
4890
4998
  #
@@ -4896,10 +5004,10 @@ module Aws::CloudFormation
4896
5004
  #
4897
5005
  # Valid values include:
4898
5006
  #
4899
- # * `LIVE`\: The extension is registered for use in CloudFormation
5007
+ # * `LIVE`: The extension is registered for use in CloudFormation
4900
5008
  # operations.
4901
5009
  #
4902
- # * `DEPRECATED`\: The extension has been deregistered and can no longer
5010
+ # * `DEPRECATED`: The extension has been deregistered and can no longer
4903
5011
  # be used in CloudFormation operations.
4904
5012
  #
4905
5013
  # @option params [String] :type
@@ -4978,7 +5086,7 @@ module Aws::CloudFormation
4978
5086
  end
4979
5087
 
4980
5088
  # Publishes the specified extension to the CloudFormation registry as a
4981
- # public extension in this region. Public extensions are available for
5089
+ # public extension in this Region. Public extensions are available for
4982
5090
  # use by all CloudFormation users. For more information about publishing
4983
5091
  # extensions, see [Publishing extensions to make them available for
4984
5092
  # public use][1] in the *CloudFormation CLI User Guide*.
@@ -5213,25 +5321,26 @@ module Aws::CloudFormation
5213
5321
  # *CloudFormation CLI User Guide*.
5214
5322
  #
5215
5323
  # You can have a maximum of 50 resource extension versions registered at
5216
- # a time. This maximum is per account and per region. Use
5217
- # [DeregisterType](AWSCloudFormation/latest/APIReference/API_DeregisterType.html)
5218
- # to deregister specific extension versions if necessary.
5324
+ # a time. This maximum is per account and per Region. Use
5325
+ # [DeregisterType][2] to deregister specific extension versions if
5326
+ # necessary.
5219
5327
  #
5220
- # Once you have initiated a registration request using ` RegisterType `,
5221
- # you can use ` DescribeTypeRegistration ` to monitor the progress of
5222
- # the registration request.
5328
+ # Once you have initiated a registration request using RegisterType, you
5329
+ # can use DescribeTypeRegistration to monitor the progress of the
5330
+ # registration request.
5223
5331
  #
5224
5332
  # Once you have registered a private extension in your account and
5225
- # region, use
5226
- # [SetTypeConfiguration](AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)
5227
- # to specify configuration properties for the extension. For more
5228
- # information, see [Configuring extensions at the account level][2] in
5229
- # the *CloudFormation User Guide*.
5333
+ # Region, use [SetTypeConfiguration][3] to specify configuration
5334
+ # properties for the extension. For more information, see [Configuring
5335
+ # extensions at the account level][4] in the *CloudFormation User
5336
+ # Guide*.
5230
5337
  #
5231
5338
  #
5232
5339
  #
5233
5340
  # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
5234
- # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
5341
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html
5342
+ # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
5343
+ # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
5235
5344
  #
5236
5345
  # @option params [String] :type
5237
5346
  # The kind of extension.
@@ -5241,13 +5350,11 @@ module Aws::CloudFormation
5241
5350
  #
5242
5351
  # We suggest that extension names adhere to the following patterns:
5243
5352
  #
5244
- # * For resource types,
5245
- # *company\_or\_organization*\::*service*\::*type*.
5353
+ # * For resource types, *company\_or\_organization*::*service*::*type*.
5246
5354
  #
5247
- # * For modules,
5248
- # *company\_or\_organization*\::*service*\::*type*\::MODULE.
5355
+ # * For modules, *company\_or\_organization*::*service*::*type*::MODULE.
5249
5356
  #
5250
- # * For hooks, *MyCompany*\::*Testing*\::*MyTestHook*.
5357
+ # * For hooks, *MyCompany*::*Testing*::*MyTestHook*.
5251
5358
  #
5252
5359
  # <note markdown="1"> The following organization namespaces are reserved and can't be used
5253
5360
  # in your extension names:
@@ -5299,9 +5406,7 @@ module Aws::CloudFormation
5299
5406
  # must contain a trust relationship with the CloudFormation service
5300
5407
  # principle (`resources.cloudformation.amazonaws.com`). For more
5301
5408
  # information about adding trust relationships, see [Modifying a role
5302
- # trust
5303
- # policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
5304
- # in the *Identity and Access Management User Guide*.
5409
+ # trust policy][1] in the *Identity and Access Management User Guide*.
5305
5410
  #
5306
5411
  # If your extension calls Amazon Web Services APIs in any of its
5307
5412
  # handlers, you must create an <i> <a
@@ -5314,6 +5419,10 @@ module Aws::CloudFormation
5314
5419
  # handler, thereby supplying your resource type with the appropriate
5315
5420
  # credentials.
5316
5421
  #
5422
+ #
5423
+ #
5424
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy
5425
+ #
5317
5426
  # @option params [String] :client_request_token
5318
5427
  # A unique identifier that acts as an idempotency key for this
5319
5428
  # registration request. Specifying a client request token prevents
@@ -5449,32 +5558,32 @@ module Aws::CloudFormation
5449
5558
  end
5450
5559
 
5451
5560
  # Specifies the configuration data for a registered CloudFormation
5452
- # extension, in the given account and region.
5561
+ # extension, in the given account and Region.
5453
5562
  #
5454
5563
  # To view the current configuration data for an extension, refer to the
5455
- # `ConfigurationSchema` element of
5456
- # [DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
5457
- # For more information, see [Configuring extensions at the account
5458
- # level][1] in the *CloudFormation User Guide*.
5564
+ # `ConfigurationSchema` element of [DescribeType][1]. For more
5565
+ # information, see [Configuring extensions at the account level][2] in
5566
+ # the *CloudFormation User Guide*.
5459
5567
  #
5460
5568
  # It's strongly recommended that you use dynamic references to restrict
5461
5569
  # sensitive configuration definitions, such as third-party credentials.
5462
5570
  # For more details on dynamic references, see [Using dynamic references
5463
- # to specify template values][2] in the *CloudFormation User Guide*.
5571
+ # to specify template values][3] in the *CloudFormation User Guide*.
5464
5572
  #
5465
5573
  #
5466
5574
  #
5467
- # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
5468
- # [2]: https://docs.aws.amazon.com/
5575
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
5576
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
5577
+ # [3]: https://docs.aws.amazon.com/
5469
5578
  #
5470
5579
  # @option params [String] :type_arn
5471
5580
  # The Amazon Resource Name (ARN) for the extension, in this account and
5472
- # region.
5581
+ # Region.
5473
5582
  #
5474
5583
  # For public extensions, this will be the ARN assigned when you
5475
- # [activate the type][1] in this account and region. For private
5584
+ # [activate the type][1] in this account and Region. For private
5476
5585
  # extensions, this will be the ARN assigned when you [register the
5477
- # type][2] in this account and region.
5586
+ # type][2] in this account and Region.
5478
5587
  #
5479
5588
  # Do not include the extension versions suffix at the end of the ARN.
5480
5589
  # You can set the configuration for an extension, but not for a specific
@@ -5486,17 +5595,18 @@ module Aws::CloudFormation
5486
5595
  # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
5487
5596
  #
5488
5597
  # @option params [required, String] :configuration
5489
- # The configuration data for the extension, in this account and region.
5598
+ # The configuration data for the extension, in this account and Region.
5490
5599
  #
5491
5600
  # The configuration data must be formatted as JSON, and validate against
5492
5601
  # the schema returned in the `ConfigurationSchema` response element of
5493
- # [API\_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
5494
- # For more information, see [Defining account-level configuration data
5495
- # for an extension][1] in the *CloudFormation CLI User Guide*.
5602
+ # [DescribeType][1]. For more information, see [Defining account-level
5603
+ # configuration data for an extension][2] in the *CloudFormation CLI
5604
+ # User Guide*.
5496
5605
  #
5497
5606
  #
5498
5607
  #
5499
- # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
5608
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
5609
+ # [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
5500
5610
  #
5501
5611
  # @option params [String] :configuration_alias
5502
5612
  # An alias by which to refer to this extension configuration data.
@@ -5700,27 +5810,28 @@ module Aws::CloudFormation
5700
5810
  # publishing][1] in the *CloudFormation CLI User Guide*.
5701
5811
  #
5702
5812
  # If you don't specify a version, CloudFormation uses the default
5703
- # version of the extension in your account and region for testing.
5813
+ # version of the extension in your account and Region for testing.
5704
5814
  #
5705
5815
  # To perform testing, CloudFormation assumes the execution role
5706
5816
  # specified when the type was registered. For more information, see
5707
- # [RegisterType](AWSCloudFormation/latest/APIReference/API_RegisterType.html).
5817
+ # [RegisterType][2].
5708
5818
  #
5709
5819
  # Once you've initiated testing on an extension using `TestType`, you
5710
- # can pass the returned `TypeVersionArn` into [DescribeType][2] to
5820
+ # can pass the returned `TypeVersionArn` into [DescribeType][3] to
5711
5821
  # monitor the current test status and test status description for the
5712
5822
  # extension.
5713
5823
  #
5714
5824
  # An extension must have a test status of `PASSED` before it can be
5715
5825
  # published. For more information, see [Publishing extensions to make
5716
- # them available for public use][3] in the *CloudFormation CLI User
5826
+ # them available for public use][4] in the *CloudFormation CLI User
5717
5827
  # Guide*.
5718
5828
  #
5719
5829
  #
5720
5830
  #
5721
5831
  # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing
5722
- # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
5723
- # [3]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
5832
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
5833
+ # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
5834
+ # [4]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
5724
5835
  #
5725
5836
  # @option params [String] :arn
5726
5837
  # The Amazon Resource Name (ARN) of the extension.
@@ -5744,7 +5855,7 @@ module Aws::CloudFormation
5744
5855
  # and `Type`.
5745
5856
  #
5746
5857
  # If you don't specify a version, CloudFormation uses the default
5747
- # version of the extension in this account and region for testing.
5858
+ # version of the extension in this account and Region for testing.
5748
5859
  #
5749
5860
  # @option params [String] :log_delivery_bucket
5750
5861
  # The S3 bucket to which CloudFormation delivers the contract test
@@ -6825,7 +6936,7 @@ module Aws::CloudFormation
6825
6936
  params: params,
6826
6937
  config: config)
6827
6938
  context[:gem_name] = 'aws-sdk-cloudformation'
6828
- context[:gem_version] = '1.76.0'
6939
+ context[:gem_version] = '1.81.0'
6829
6940
  Seahorse::Client::Request.new(handlers, context)
6830
6941
  end
6831
6942