aws-sdk-cloudformation 1.78.0 → 1.80.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.
@@ -373,21 +373,36 @@ module Aws::CloudFormation
373
373
 
374
374
  # @!group API Operations
375
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
+
376
391
  # Activates a public third-party extension, making it available for use
377
392
  # in stack templates. For more information, see [Using public
378
393
  # extensions][1] in the *CloudFormation User Guide*.
379
394
  #
380
395
  # Once you have activated a public third-party extension in your account
381
- # and region, use
382
- # [SetTypeConfiguration](AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)
383
- # to specify configuration properties for the extension. For more
384
- # information, see [Configuring extensions at the account level][2] in
385
- # 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*.
386
400
  #
387
401
  #
388
402
  #
389
403
  # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html
390
- # [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
391
406
  #
392
407
  # @option params [String] :type
393
408
  # The extension type.
@@ -415,18 +430,18 @@ module Aws::CloudFormation
415
430
  #
416
431
  # @option params [String] :type_name_alias
417
432
  # An alias to assign to the public extension, in this account and
418
- # region. If you specify an alias for the extension, CloudFormation
433
+ # Region. If you specify an alias for the extension, CloudFormation
419
434
  # treats the alias as the extension type name within this account and
420
- # 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
421
436
  # templates, API calls, and CloudFormation console.
422
437
  #
423
- # 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.
424
439
  # You can activate the same public resource multiple times in the same
425
- # account and region, using different type name aliases.
440
+ # account and Region, using different type name aliases.
426
441
  #
427
442
  # @option params [Boolean] :auto_update
428
443
  # Whether to automatically update the extension in this account and
429
- # region when a new *minor* version is published by the extension
444
+ # Region when a new *minor* version is published by the extension
430
445
  # publisher. Major versions released by the publisher must be manually
431
446
  # updated.
432
447
  #
@@ -494,7 +509,7 @@ module Aws::CloudFormation
494
509
 
495
510
  # Returns configuration data for the specified CloudFormation
496
511
  # extensions, from the CloudFormation registry for the account and
497
- # region.
512
+ # Region.
498
513
  #
499
514
  # For more information, see [Configuring extensions at the account
500
515
  # level][1] in the *CloudFormation User Guide*.
@@ -569,6 +584,19 @@ module Aws::CloudFormation
569
584
  # </note>
570
585
  #
571
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
+ #
572
600
  # The name or the unique stack ID that's associated with the stack.
573
601
  #
574
602
  # @option params [String] :client_request_token
@@ -687,7 +715,7 @@ module Aws::CloudFormation
687
715
  #
688
716
  # @option params [String] :client_request_token
689
717
  # A unique identifier for this `ContinueUpdateRollback` request. Specify
690
- # this token if you plan to retry requests so that CloudFormationknows
718
+ # this token if you plan to retry requests so that CloudFormation knows
691
719
  # that you're not attempting to continue the rollback to a stack with
692
720
  # the same name. You might retry `ContinueUpdateRollback` requests to
693
721
  # ensure that CloudFormation successfully received them.
@@ -930,7 +958,7 @@ module Aws::CloudFormation
930
958
  #
931
959
  # If you create a change set for a new stack, CloudFormation creates a
932
960
  # stack with a unique stack ID, but no template or resources. The stack
933
- # 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
934
962
  # change set.
935
963
  #
936
964
  # By default, CloudFormation specifies `UPDATE`. You can't use the
@@ -1020,7 +1048,7 @@ module Aws::CloudFormation
1020
1048
 
1021
1049
  # Creates a stack as specified in the template. After the call completes
1022
1050
  # successfully, the stack creation starts. You can check the status of
1023
- # the stack through the DescribeStacksoperation.
1051
+ # the stack through the DescribeStacks operation.
1024
1052
  #
1025
1053
  # @option params [required, String] :stack_name
1026
1054
  # The name that's associated with the stack. The name must be unique in
@@ -1772,8 +1800,23 @@ module Aws::CloudFormation
1772
1800
  req.send_request(options)
1773
1801
  end
1774
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
+
1775
1818
  # Deactivates a public extension that was previously activated in this
1776
- # account and region.
1819
+ # account and Region.
1777
1820
  #
1778
1821
  # Once deactivated, an extension can't be used in any CloudFormation
1779
1822
  # operation. This includes stack update operations where the stack
@@ -1782,7 +1825,7 @@ module Aws::CloudFormation
1782
1825
  # automatically updated if a new version of the extension is released.
1783
1826
  #
1784
1827
  # @option params [String] :type_name
1785
- # 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
1786
1829
  # specified a type name alias when enabling the extension, use the type
1787
1830
  # name alias.
1788
1831
  #
@@ -1795,7 +1838,7 @@ module Aws::CloudFormation
1795
1838
  #
1796
1839
  # @option params [String] :arn
1797
1840
  # The Amazon Resource Name (ARN) for the extension, in this account and
1798
- # region.
1841
+ # Region.
1799
1842
  #
1800
1843
  # Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
1801
1844
  #
@@ -2379,6 +2422,56 @@ module Aws::CloudFormation
2379
2422
  req.send_request(options)
2380
2423
  end
2381
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
+
2382
2475
  # Returns information about a CloudFormation extension publisher.
2383
2476
  #
2384
2477
  # If you don't supply a `PublisherId`, and you have registered as an
@@ -2435,7 +2528,7 @@ module Aws::CloudFormation
2435
2528
 
2436
2529
  # Returns information about a stack drift detection operation. A stack
2437
2530
  # drift detection operation detects whether a stack's actual
2438
- # configuration differs, or has *drifted*, from it's expected
2531
+ # configuration differs, or has *drifted*, from its expected
2439
2532
  # configuration, as defined in the stack template and any values
2440
2533
  # specified as template parameters. A stack is considered to have
2441
2534
  # drifted if one or more of its resources have drifted. For more
@@ -2568,11 +2661,11 @@ module Aws::CloudFormation
2568
2661
  req.send_request(options)
2569
2662
  end
2570
2663
 
2571
- # Returns the stack instance that's associated with the specified stack
2572
- # 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.
2573
2666
  #
2574
2667
  # For a list of stack instances that are associated with a specific
2575
- # stack set, use ListStackInstances.
2668
+ # StackSet, use ListStackInstances.
2576
2669
  #
2577
2670
  # @option params [required, String] :stack_set_name
2578
2671
  # The name or the unique stack ID of the stack set that you want to get
@@ -2632,7 +2725,7 @@ module Aws::CloudFormation
2632
2725
  # resp.stack_instance.parameter_overrides[0].use_previous_value #=> Boolean
2633
2726
  # resp.stack_instance.parameter_overrides[0].resolved_value #=> String
2634
2727
  # resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
2635
- # 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"
2636
2729
  # resp.stack_instance.status_reason #=> String
2637
2730
  # resp.stack_instance.organizational_unit_id #=> String
2638
2731
  # resp.stack_instance.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
@@ -2903,7 +2996,7 @@ module Aws::CloudFormation
2903
2996
  req.send_request(options)
2904
2997
  end
2905
2998
 
2906
- # Returns the description of the specified stack set.
2999
+ # Returns the description of the specified StackSet.
2907
3000
  #
2908
3001
  # @option params [required, String] :stack_set_name
2909
3002
  # The name or unique ID of the stack set whose description you want.
@@ -2987,7 +3080,7 @@ module Aws::CloudFormation
2987
3080
  req.send_request(options)
2988
3081
  end
2989
3082
 
2990
- # Returns the description of the specified stack set operation.
3083
+ # Returns the description of the specified StackSet operation.
2991
3084
  #
2992
3085
  # @option params [required, String] :stack_set_name
2993
3086
  # The name or the unique stack ID of the stack set for the stack
@@ -3082,6 +3175,21 @@ module Aws::CloudFormation
3082
3175
  # </note>
3083
3176
  #
3084
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
+ #
3085
3193
  # The name or the unique stack ID that's associated with the stack,
3086
3194
  # which aren't always interchangeable:
3087
3195
  #
@@ -3301,18 +3409,18 @@ module Aws::CloudFormation
3301
3409
  # Returns information about an extension's registration, including its
3302
3410
  # current status and type and version identifiers.
3303
3411
  #
3304
- # When you initiate a registration request using ` RegisterType `, you
3305
- # can then use ` DescribeTypeRegistration ` to monitor the progress of
3306
- # 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.
3307
3415
  #
3308
- # Once the registration request has completed, use ` DescribeType ` to
3416
+ # Once the registration request has completed, use DescribeType to
3309
3417
  # return detailed information about an extension.
3310
3418
  #
3311
3419
  # @option params [required, String] :registration_token
3312
3420
  # The identifier for this registration request.
3313
3421
  #
3314
3422
  # This registration token is generated by CloudFormation when you
3315
- # initiate a registration request using ` RegisterType `.
3423
+ # initiate a registration request using RegisterType.
3316
3424
  #
3317
3425
  # @return [Types::DescribeTypeRegistrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3318
3426
  #
@@ -3349,7 +3457,7 @@ module Aws::CloudFormation
3349
3457
  end
3350
3458
 
3351
3459
  # Detects whether a stack's actual configuration differs, or has
3352
- # *drifted*, from it's expected configuration, as defined in the stack
3460
+ # *drifted*, from its expected configuration, as defined in the stack
3353
3461
  # template and any values specified as template parameters. For each
3354
3462
  # resource in the stack that supports drift detection, CloudFormation
3355
3463
  # compares the actual configuration of the resource with its expected
@@ -3413,13 +3521,13 @@ module Aws::CloudFormation
3413
3521
  end
3414
3522
 
3415
3523
  # Returns information about whether a resource's actual configuration
3416
- # differs, or has *drifted*, from it's expected configuration, as
3417
- # defined in the stack template and any values specified as template
3418
- # parameters. This information includes actual and expected property
3419
- # values for resources in which CloudFormation detects drift. Only
3420
- # resource properties explicitly defined in the stack template are
3421
- # checked for drift. For more information about stack and resource
3422
- # 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
3423
3531
  # Resources][1].
3424
3532
  #
3425
3533
  # Use `DetectStackResourceDrift` to detect drift on individual
@@ -3490,8 +3598,8 @@ module Aws::CloudFormation
3490
3598
  # stack set][1].
3491
3599
  #
3492
3600
  # `DetectStackSetDrift` returns the `OperationId` of the stack set drift
3493
- # detection operation. Use this operation id with `
3494
- # 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
3495
3603
  # detection operation. The drift detection operation may take some time,
3496
3604
  # depending on the number of stack instances included in the stack set,
3497
3605
  # in addition to the number of resources included in each stack.
@@ -3499,16 +3607,16 @@ module Aws::CloudFormation
3499
3607
  # Once the operation has completed, use the following actions to return
3500
3608
  # drift information:
3501
3609
  #
3502
- # * Use ` DescribeStackSet ` to return detailed information about the
3503
- # stack set, including detailed information about the last *completed*
3504
- # 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
3505
3613
  # operations that are in progress isn't included.)
3506
3614
  #
3507
- # * Use ` ListStackInstances ` to return a list of stack instances
3508
- # belonging to the stack set, including the drift status and last
3509
- # 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.
3510
3618
  #
3511
- # * Use ` DescribeStackInstance ` to return detailed information about a
3619
+ # * Use DescribeStackInstance to return detailed information about a
3512
3620
  # specific stack instance, including its drift status and last drift
3513
3621
  # time checked.
3514
3622
  #
@@ -3518,8 +3626,8 @@ module Aws::CloudFormation
3518
3626
  # You can only run a single drift detection operation on a given stack
3519
3627
  # set at one time.
3520
3628
  #
3521
- # To stop a drift detection stack set operation, use `
3522
- # StopStackSetOperation `.
3629
+ # To stop a drift detection stack set operation, use
3630
+ # StopStackSetOperation.
3523
3631
  #
3524
3632
  #
3525
3633
  #
@@ -3957,11 +4065,6 @@ module Aws::CloudFormation
3957
4065
  # and Region, by specifying the stack ID of the stack you intend to
3958
4066
  # import.
3959
4067
  #
3960
- # <note markdown="1"> `ImportStacksToStackSet` is only supported by self-managed
3961
- # permissions.
3962
- #
3963
- # </note>
3964
- #
3965
4068
  # @option params [required, String] :stack_set_name
3966
4069
  # The name of the stack set. The name must be unique in the Region where
3967
4070
  # you create your stack set.
@@ -4097,7 +4200,7 @@ module Aws::CloudFormation
4097
4200
  # Lists all exported output values in the account and Region in which
4098
4201
  # you call this action. Use this action to see the exported output
4099
4202
  # values that you can import into other stacks. To import values, use
4100
- # the [ `Fn::ImportValue` ][1] function.
4203
+ # the [ Fn::ImportValue][1] function.
4101
4204
  #
4102
4205
  # For more information, see [ CloudFormation export stack output
4103
4206
  # values][2].
@@ -4147,7 +4250,7 @@ module Aws::CloudFormation
4147
4250
  # your account, see ListExports.
4148
4251
  #
4149
4252
  # For more information about importing an exported output value, see the
4150
- # [ `Fn::ImportValue` ][1] function.
4253
+ # [Fn::ImportValue][1] function.
4151
4254
  #
4152
4255
  #
4153
4256
  #
@@ -4279,7 +4382,7 @@ module Aws::CloudFormation
4279
4382
  # resp.summaries[0].stack_id #=> String
4280
4383
  # resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
4281
4384
  # resp.summaries[0].status_reason #=> String
4282
- # 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"
4283
4386
  # resp.summaries[0].organizational_unit_id #=> String
4284
4387
  # resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
4285
4388
  # resp.summaries[0].last_drift_check_timestamp #=> Time
@@ -4860,12 +4963,12 @@ module Aws::CloudFormation
4860
4963
  # Valid values include:
4861
4964
  #
4862
4965
  # * `PRIVATE`: Extensions that are visible and usable within this
4863
- # account and region. This includes:
4966
+ # account and Region. This includes:
4864
4967
  #
4865
- # * Private extensions you have registered in this account and region.
4968
+ # * Private extensions you have registered in this account and Region.
4866
4969
  #
4867
4970
  # * Public extensions that you have activated in this account and
4868
- # region.
4971
+ # Region.
4869
4972
  #
4870
4973
  # * `PUBLIC`: Extensions that are publicly visible and available to be
4871
4974
  # activated within any Amazon Web Services account. This includes
@@ -4983,7 +5086,7 @@ module Aws::CloudFormation
4983
5086
  end
4984
5087
 
4985
5088
  # Publishes the specified extension to the CloudFormation registry as a
4986
- # public extension in this region. Public extensions are available for
5089
+ # public extension in this Region. Public extensions are available for
4987
5090
  # use by all CloudFormation users. For more information about publishing
4988
5091
  # extensions, see [Publishing extensions to make them available for
4989
5092
  # public use][1] in the *CloudFormation CLI User Guide*.
@@ -5218,25 +5321,26 @@ module Aws::CloudFormation
5218
5321
  # *CloudFormation CLI User Guide*.
5219
5322
  #
5220
5323
  # You can have a maximum of 50 resource extension versions registered at
5221
- # a time. This maximum is per account and per region. Use
5222
- # [DeregisterType](AWSCloudFormation/latest/APIReference/API_DeregisterType.html)
5223
- # 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.
5224
5327
  #
5225
- # Once you have initiated a registration request using ` RegisterType `,
5226
- # you can use ` DescribeTypeRegistration ` to monitor the progress of
5227
- # 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.
5228
5331
  #
5229
5332
  # Once you have registered a private extension in your account and
5230
- # region, use
5231
- # [SetTypeConfiguration](AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)
5232
- # to specify configuration properties for the extension. For more
5233
- # information, see [Configuring extensions at the account level][2] in
5234
- # 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*.
5235
5337
  #
5236
5338
  #
5237
5339
  #
5238
5340
  # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
5239
- # [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
5240
5344
  #
5241
5345
  # @option params [String] :type
5242
5346
  # The kind of extension.
@@ -5302,9 +5406,7 @@ module Aws::CloudFormation
5302
5406
  # must contain a trust relationship with the CloudFormation service
5303
5407
  # principle (`resources.cloudformation.amazonaws.com`). For more
5304
5408
  # information about adding trust relationships, see [Modifying a role
5305
- # trust
5306
- # policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
5307
- # in the *Identity and Access Management User Guide*.
5409
+ # trust policy][1] in the *Identity and Access Management User Guide*.
5308
5410
  #
5309
5411
  # If your extension calls Amazon Web Services APIs in any of its
5310
5412
  # handlers, you must create an <i> <a
@@ -5317,6 +5419,10 @@ module Aws::CloudFormation
5317
5419
  # handler, thereby supplying your resource type with the appropriate
5318
5420
  # credentials.
5319
5421
  #
5422
+ #
5423
+ #
5424
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy
5425
+ #
5320
5426
  # @option params [String] :client_request_token
5321
5427
  # A unique identifier that acts as an idempotency key for this
5322
5428
  # registration request. Specifying a client request token prevents
@@ -5452,32 +5558,32 @@ module Aws::CloudFormation
5452
5558
  end
5453
5559
 
5454
5560
  # Specifies the configuration data for a registered CloudFormation
5455
- # extension, in the given account and region.
5561
+ # extension, in the given account and Region.
5456
5562
  #
5457
5563
  # To view the current configuration data for an extension, refer to the
5458
- # `ConfigurationSchema` element of
5459
- # [DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
5460
- # For more information, see [Configuring extensions at the account
5461
- # 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*.
5462
5567
  #
5463
5568
  # It's strongly recommended that you use dynamic references to restrict
5464
5569
  # sensitive configuration definitions, such as third-party credentials.
5465
5570
  # For more details on dynamic references, see [Using dynamic references
5466
- # to specify template values][2] in the *CloudFormation User Guide*.
5571
+ # to specify template values][3] in the *CloudFormation User Guide*.
5467
5572
  #
5468
5573
  #
5469
5574
  #
5470
- # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
5471
- # [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/
5472
5578
  #
5473
5579
  # @option params [String] :type_arn
5474
5580
  # The Amazon Resource Name (ARN) for the extension, in this account and
5475
- # region.
5581
+ # Region.
5476
5582
  #
5477
5583
  # For public extensions, this will be the ARN assigned when you
5478
- # [activate the type][1] in this account and region. For private
5584
+ # [activate the type][1] in this account and Region. For private
5479
5585
  # extensions, this will be the ARN assigned when you [register the
5480
- # type][2] in this account and region.
5586
+ # type][2] in this account and Region.
5481
5587
  #
5482
5588
  # Do not include the extension versions suffix at the end of the ARN.
5483
5589
  # You can set the configuration for an extension, but not for a specific
@@ -5489,17 +5595,18 @@ module Aws::CloudFormation
5489
5595
  # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
5490
5596
  #
5491
5597
  # @option params [required, String] :configuration
5492
- # The configuration data for the extension, in this account and region.
5598
+ # The configuration data for the extension, in this account and Region.
5493
5599
  #
5494
5600
  # The configuration data must be formatted as JSON, and validate against
5495
5601
  # the schema returned in the `ConfigurationSchema` response element of
5496
- # [API\_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
5497
- # For more information, see [Defining account-level configuration data
5498
- # 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*.
5499
5605
  #
5500
5606
  #
5501
5607
  #
5502
- # [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
5503
5610
  #
5504
5611
  # @option params [String] :configuration_alias
5505
5612
  # An alias by which to refer to this extension configuration data.
@@ -5703,27 +5810,28 @@ module Aws::CloudFormation
5703
5810
  # publishing][1] in the *CloudFormation CLI User Guide*.
5704
5811
  #
5705
5812
  # If you don't specify a version, CloudFormation uses the default
5706
- # version of the extension in your account and region for testing.
5813
+ # version of the extension in your account and Region for testing.
5707
5814
  #
5708
5815
  # To perform testing, CloudFormation assumes the execution role
5709
5816
  # specified when the type was registered. For more information, see
5710
- # [RegisterType](AWSCloudFormation/latest/APIReference/API_RegisterType.html).
5817
+ # [RegisterType][2].
5711
5818
  #
5712
5819
  # Once you've initiated testing on an extension using `TestType`, you
5713
- # can pass the returned `TypeVersionArn` into [DescribeType][2] to
5820
+ # can pass the returned `TypeVersionArn` into [DescribeType][3] to
5714
5821
  # monitor the current test status and test status description for the
5715
5822
  # extension.
5716
5823
  #
5717
5824
  # An extension must have a test status of `PASSED` before it can be
5718
5825
  # published. For more information, see [Publishing extensions to make
5719
- # them available for public use][3] in the *CloudFormation CLI User
5826
+ # them available for public use][4] in the *CloudFormation CLI User
5720
5827
  # Guide*.
5721
5828
  #
5722
5829
  #
5723
5830
  #
5724
5831
  # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing
5725
- # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
5726
- # [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
5727
5835
  #
5728
5836
  # @option params [String] :arn
5729
5837
  # The Amazon Resource Name (ARN) of the extension.
@@ -5747,7 +5855,7 @@ module Aws::CloudFormation
5747
5855
  # and `Type`.
5748
5856
  #
5749
5857
  # If you don't specify a version, CloudFormation uses the default
5750
- # version of the extension in this account and region for testing.
5858
+ # version of the extension in this account and Region for testing.
5751
5859
  #
5752
5860
  # @option params [String] :log_delivery_bucket
5753
5861
  # The S3 bucket to which CloudFormation delivers the contract test
@@ -6828,7 +6936,7 @@ module Aws::CloudFormation
6828
6936
  params: params,
6829
6937
  config: config)
6830
6938
  context[:gem_name] = 'aws-sdk-cloudformation'
6831
- context[:gem_version] = '1.78.0'
6939
+ context[:gem_version] = '1.80.0'
6832
6940
  Seahorse::Client::Request.new(handlers, context)
6833
6941
  end
6834
6942