aws-sdk-cloudformation 1.47.0 → 1.48.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +499 -145
- data/lib/aws-sdk-cloudformation/client_api.rb +16 -0
- data/lib/aws-sdk-cloudformation/resource.rb +2 -2
- data/lib/aws-sdk-cloudformation/stack.rb +5 -4
- data/lib/aws-sdk-cloudformation/types.rb +568 -193
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0afe18aa55f90d343de779c304b9b80d1929bf74719e75d7456273dfd841a2b4
|
4
|
+
data.tar.gz: 2445683f644c756887f507a9b715bf437872ea3468a0ee7c1591397982434388
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6751b767b680424aafa1b01daf33ddfa9af4a5ee2d21110ec38a6d1b21d86fca8cb8bba95b3a566b5ca819b5dd96ed1a76905385e3285288b740df8591cc1a17
|
7
|
+
data.tar.gz: d68524a34fbbd74cf64943e79f3eccbcde2dd95521f6e07d4303ca9c60fab68d3a638ecea4595ea2a90e467fc3b16f0d9966c66d596873d86a66be084eb245dc
|
@@ -525,8 +525,9 @@ module Aws::CloudFormation
|
|
525
525
|
# @option params [String] :template_url
|
526
526
|
# The location of the file that contains the revised template. The URL
|
527
527
|
# must point to a template (max size: 460,800 bytes) that is located in
|
528
|
-
# an S3 bucket
|
529
|
-
# this template with the stack
|
528
|
+
# an S3 bucket or a Systems Manager document. AWS CloudFormation
|
529
|
+
# generates the change set by comparing this template with the stack
|
530
|
+
# that you specified.
|
530
531
|
#
|
531
532
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
532
533
|
#
|
@@ -815,8 +816,8 @@ module Aws::CloudFormation
|
|
815
816
|
# @option params [String] :template_url
|
816
817
|
# Location of file containing the template body. The URL must point to a
|
817
818
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
818
|
-
# bucket. For more information, go to the
|
819
|
-
# AWS CloudFormation User Guide.
|
819
|
+
# bucket or a Systems Manager document. For more information, go to the
|
820
|
+
# [Template Anatomy][1] in the AWS CloudFormation User Guide.
|
820
821
|
#
|
821
822
|
# Conditional: You must specify either the `TemplateBody` or the
|
822
823
|
# `TemplateURL` parameter, but not both.
|
@@ -1115,14 +1116,14 @@ module Aws::CloudFormation
|
|
1115
1116
|
# instances from.
|
1116
1117
|
#
|
1117
1118
|
# @option params [Array<String>] :accounts
|
1118
|
-
# \[
|
1119
|
+
# \[Self-managed permissions\] The names of one or more AWS accounts
|
1119
1120
|
# that you want to create stack instances in the specified Region(s)
|
1120
1121
|
# for.
|
1121
1122
|
#
|
1122
1123
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1123
1124
|
#
|
1124
1125
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1125
|
-
# \[
|
1126
|
+
# \[Service-managed permissions\] The AWS Organizations accounts for
|
1126
1127
|
# which to create stack instances in the specified Regions.
|
1127
1128
|
#
|
1128
1129
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
@@ -1192,6 +1193,27 @@ module Aws::CloudFormation
|
|
1192
1193
|
# **A suitable default value is auto-generated.** You should normally
|
1193
1194
|
# not need to pass this option.**
|
1194
1195
|
#
|
1196
|
+
# @option params [String] :call_as
|
1197
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
1198
|
+
# account administrator in the organization's management account or as
|
1199
|
+
# a delegated administrator in a member account.
|
1200
|
+
#
|
1201
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
1202
|
+
# self-managed permissions.
|
1203
|
+
#
|
1204
|
+
# * If you are signed in to the management account, specify `SELF`.
|
1205
|
+
#
|
1206
|
+
# * If you are signed in to a delegated administrator account, specify
|
1207
|
+
# `DELEGATED_ADMIN`.
|
1208
|
+
#
|
1209
|
+
# Your AWS account must be registered as a delegated administrator in
|
1210
|
+
# the management account. For more information, see [Register a
|
1211
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
1212
|
+
#
|
1213
|
+
#
|
1214
|
+
#
|
1215
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
1216
|
+
#
|
1195
1217
|
# @return [Types::CreateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1196
1218
|
#
|
1197
1219
|
# * {Types::CreateStackInstancesOutput#operation_id #operation_id} => String
|
@@ -1222,6 +1244,7 @@ module Aws::CloudFormation
|
|
1222
1244
|
# max_concurrent_percentage: 1,
|
1223
1245
|
# },
|
1224
1246
|
# operation_id: "ClientRequestToken",
|
1247
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1225
1248
|
# })
|
1226
1249
|
#
|
1227
1250
|
# @example Response structure
|
@@ -1268,8 +1291,9 @@ module Aws::CloudFormation
|
|
1268
1291
|
# @option params [String] :template_url
|
1269
1292
|
# The location of the file that contains the template body. The URL must
|
1270
1293
|
# point to a template (maximum size: 460,800 bytes) that's located in
|
1271
|
-
# an Amazon S3 bucket
|
1272
|
-
# in the AWS CloudFormation User
|
1294
|
+
# an Amazon S3 bucket or a Systems Manager document. For more
|
1295
|
+
# information, see [Template Anatomy][1] in the AWS CloudFormation User
|
1296
|
+
# Guide.
|
1273
1297
|
#
|
1274
1298
|
# Conditional: You must specify either the TemplateBody or the
|
1275
1299
|
# TemplateURL parameter, but not both.
|
@@ -1415,6 +1439,32 @@ module Aws::CloudFormation
|
|
1415
1439
|
# accounts that are added to the target organization or organizational
|
1416
1440
|
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
|
1417
1441
|
#
|
1442
|
+
# @option params [String] :call_as
|
1443
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
1444
|
+
# account administrator in the organization's management account or as
|
1445
|
+
# a delegated administrator in a member account.
|
1446
|
+
#
|
1447
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
1448
|
+
# self-managed permissions.
|
1449
|
+
#
|
1450
|
+
# * To create a stack set with service-managed permissions while signed
|
1451
|
+
# in to the management account, specify `SELF`.
|
1452
|
+
#
|
1453
|
+
# * To create a stack set with service-managed permissions while signed
|
1454
|
+
# in to a delegated administrator account, specify `DELEGATED_ADMIN`.
|
1455
|
+
#
|
1456
|
+
# Your AWS account must be registered as a delegated admin in the
|
1457
|
+
# management account. For more information, see [Register a delegated
|
1458
|
+
# administrator][1] in the *AWS CloudFormation User Guide*.
|
1459
|
+
#
|
1460
|
+
# Stack sets with service-managed permissions are created in the
|
1461
|
+
# management account, including stack sets that are created by delegated
|
1462
|
+
# administrators.
|
1463
|
+
#
|
1464
|
+
#
|
1465
|
+
#
|
1466
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
1467
|
+
#
|
1418
1468
|
# @option params [String] :client_request_token
|
1419
1469
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
1420
1470
|
# token if you plan to retry requests so that AWS CloudFormation knows
|
@@ -1461,6 +1511,7 @@ module Aws::CloudFormation
|
|
1461
1511
|
# enabled: false,
|
1462
1512
|
# retain_stacks_on_account_removal: false,
|
1463
1513
|
# },
|
1514
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1464
1515
|
# client_request_token: "ClientRequestToken",
|
1465
1516
|
# })
|
1466
1517
|
#
|
@@ -1590,13 +1641,13 @@ module Aws::CloudFormation
|
|
1590
1641
|
# instances for.
|
1591
1642
|
#
|
1592
1643
|
# @option params [Array<String>] :accounts
|
1593
|
-
# \[
|
1644
|
+
# \[Self-managed permissions\] The names of the AWS accounts that you
|
1594
1645
|
# want to delete stack instances for.
|
1595
1646
|
#
|
1596
1647
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1597
1648
|
#
|
1598
1649
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1599
|
-
# \[
|
1650
|
+
# \[Service-managed permissions\] The AWS Organizations accounts from
|
1600
1651
|
# which to delete stack instances.
|
1601
1652
|
#
|
1602
1653
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
@@ -1637,6 +1688,27 @@ module Aws::CloudFormation
|
|
1637
1688
|
# **A suitable default value is auto-generated.** You should normally
|
1638
1689
|
# not need to pass this option.**
|
1639
1690
|
#
|
1691
|
+
# @option params [String] :call_as
|
1692
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
1693
|
+
# account administrator in the organization's management account or as
|
1694
|
+
# a delegated administrator in a member account.
|
1695
|
+
#
|
1696
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
1697
|
+
# self-managed permissions.
|
1698
|
+
#
|
1699
|
+
# * If you are signed in to the management account, specify `SELF`.
|
1700
|
+
#
|
1701
|
+
# * If you are signed in to a delegated administrator account, specify
|
1702
|
+
# `DELEGATED_ADMIN`.
|
1703
|
+
#
|
1704
|
+
# Your AWS account must be registered as a delegated administrator in
|
1705
|
+
# the management account. For more information, see [Register a
|
1706
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
1707
|
+
#
|
1708
|
+
#
|
1709
|
+
#
|
1710
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
1711
|
+
#
|
1640
1712
|
# @return [Types::DeleteStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1641
1713
|
#
|
1642
1714
|
# * {Types::DeleteStackInstancesOutput#operation_id #operation_id} => String
|
@@ -1660,6 +1732,7 @@ module Aws::CloudFormation
|
|
1660
1732
|
# },
|
1661
1733
|
# retain_stacks: false, # required
|
1662
1734
|
# operation_id: "ClientRequestToken",
|
1735
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1663
1736
|
# })
|
1664
1737
|
#
|
1665
1738
|
# @example Response structure
|
@@ -1683,12 +1756,34 @@ module Aws::CloudFormation
|
|
1683
1756
|
# The name or unique ID of the stack set that you're deleting. You can
|
1684
1757
|
# obtain this value by running ListStackSets.
|
1685
1758
|
#
|
1759
|
+
# @option params [String] :call_as
|
1760
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
1761
|
+
# account administrator in the organization's management account or as
|
1762
|
+
# a delegated administrator in a member account.
|
1763
|
+
#
|
1764
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
1765
|
+
# self-managed permissions.
|
1766
|
+
#
|
1767
|
+
# * If you are signed in to the management account, specify `SELF`.
|
1768
|
+
#
|
1769
|
+
# * If you are signed in to a delegated administrator account, specify
|
1770
|
+
# `DELEGATED_ADMIN`.
|
1771
|
+
#
|
1772
|
+
# Your AWS account must be registered as a delegated administrator in
|
1773
|
+
# the management account. For more information, see [Register a
|
1774
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
1775
|
+
#
|
1776
|
+
#
|
1777
|
+
#
|
1778
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
1779
|
+
#
|
1686
1780
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1687
1781
|
#
|
1688
1782
|
# @example Request syntax with placeholder values
|
1689
1783
|
#
|
1690
1784
|
# resp = client.delete_stack_set({
|
1691
1785
|
# stack_set_name: "StackSetName", # required
|
1786
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1692
1787
|
# })
|
1693
1788
|
#
|
1694
1789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet AWS API Documentation
|
@@ -1700,40 +1795,48 @@ module Aws::CloudFormation
|
|
1700
1795
|
req.send_request(options)
|
1701
1796
|
end
|
1702
1797
|
|
1703
|
-
#
|
1704
|
-
# registry
|
1705
|
-
# in CloudFormation
|
1798
|
+
# Marks an extension or extension version as `DEPRECATED` in the
|
1799
|
+
# CloudFormation registry, removing it from active use. Deprecated
|
1800
|
+
# extensions or extension versions cannot be used in CloudFormation
|
1801
|
+
# operations.
|
1706
1802
|
#
|
1707
|
-
# To deregister
|
1708
|
-
# versions of that
|
1709
|
-
# deregistering that version results in the
|
1710
|
-
# deregistered
|
1803
|
+
# To deregister an entire extension, you must individually deregister
|
1804
|
+
# all active versions of that extension. If an extension has only a
|
1805
|
+
# single active version, deregistering that version results in the
|
1806
|
+
# extension itself being deregistered and marked as deprecated in the
|
1807
|
+
# registry.
|
1711
1808
|
#
|
1712
|
-
# You cannot deregister the default version of
|
1713
|
-
#
|
1714
|
-
#
|
1809
|
+
# You cannot deregister the default version of an extension if there are
|
1810
|
+
# other active version of that extension. If you do deregister the
|
1811
|
+
# default version of an extension, the textensionype itself is
|
1812
|
+
# deregistered as well and marked as deprecated.
|
1813
|
+
#
|
1814
|
+
# To view the deprecation status of an extension or extension version,
|
1815
|
+
# use [DescribeType][1].
|
1816
|
+
#
|
1817
|
+
#
|
1818
|
+
#
|
1819
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
1715
1820
|
#
|
1716
1821
|
# @option params [String] :arn
|
1717
|
-
# The Amazon Resource Name (ARN) of the
|
1822
|
+
# The Amazon Resource Name (ARN) of the extension.
|
1718
1823
|
#
|
1719
1824
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
1720
1825
|
#
|
1721
1826
|
# @option params [String] :type
|
1722
|
-
# The kind of
|
1723
|
-
#
|
1724
|
-
# Currently the only valid value is `RESOURCE`.
|
1827
|
+
# The kind of extension.
|
1725
1828
|
#
|
1726
1829
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
1727
1830
|
#
|
1728
1831
|
# @option params [String] :type_name
|
1729
|
-
# The name of the
|
1832
|
+
# The name of the extension.
|
1730
1833
|
#
|
1731
1834
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
1732
1835
|
#
|
1733
1836
|
# @option params [String] :version_id
|
1734
|
-
# The ID of a specific version of the
|
1735
|
-
# at the end of the Amazon Resource Name (ARN) assigned to the
|
1736
|
-
# version when it is registered.
|
1837
|
+
# The ID of a specific version of the extension. The version ID is the
|
1838
|
+
# value at the end of the Amazon Resource Name (ARN) assigned to the
|
1839
|
+
# extension version when it is registered.
|
1737
1840
|
#
|
1738
1841
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1739
1842
|
#
|
@@ -2059,6 +2162,27 @@ module Aws::CloudFormation
|
|
2059
2162
|
# @option params [required, String] :stack_instance_region
|
2060
2163
|
# The name of a Region that's associated with this stack instance.
|
2061
2164
|
#
|
2165
|
+
# @option params [String] :call_as
|
2166
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
2167
|
+
# account administrator in the organization's management account or as
|
2168
|
+
# a delegated administrator in a member account.
|
2169
|
+
#
|
2170
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
2171
|
+
# self-managed permissions.
|
2172
|
+
#
|
2173
|
+
# * If you are signed in to the management account, specify `SELF`.
|
2174
|
+
#
|
2175
|
+
# * If you are signed in to a delegated administrator account, specify
|
2176
|
+
# `DELEGATED_ADMIN`.
|
2177
|
+
#
|
2178
|
+
# Your AWS account must be registered as a delegated administrator in
|
2179
|
+
# the management account. For more information, see [Register a
|
2180
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
2181
|
+
#
|
2182
|
+
#
|
2183
|
+
#
|
2184
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
2185
|
+
#
|
2062
2186
|
# @return [Types::DescribeStackInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2063
2187
|
#
|
2064
2188
|
# * {Types::DescribeStackInstanceOutput#stack_instance #stack_instance} => Types::StackInstance
|
@@ -2069,6 +2193,7 @@ module Aws::CloudFormation
|
|
2069
2193
|
# stack_set_name: "StackSetName", # required
|
2070
2194
|
# stack_instance_account: "Account", # required
|
2071
2195
|
# stack_instance_region: "Region", # required
|
2196
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2072
2197
|
# })
|
2073
2198
|
#
|
2074
2199
|
# @example Response structure
|
@@ -2359,6 +2484,27 @@ module Aws::CloudFormation
|
|
2359
2484
|
# @option params [required, String] :stack_set_name
|
2360
2485
|
# The name or unique ID of the stack set whose description you want.
|
2361
2486
|
#
|
2487
|
+
# @option params [String] :call_as
|
2488
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
2489
|
+
# account administrator in the organization's management account or as
|
2490
|
+
# a delegated administrator in a member account.
|
2491
|
+
#
|
2492
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
2493
|
+
# self-managed permissions.
|
2494
|
+
#
|
2495
|
+
# * If you are signed in to the management account, specify `SELF`.
|
2496
|
+
#
|
2497
|
+
# * If you are signed in to a delegated administrator account, specify
|
2498
|
+
# `DELEGATED_ADMIN`.
|
2499
|
+
#
|
2500
|
+
# Your AWS account must be registered as a delegated administrator in
|
2501
|
+
# the management account. For more information, see [Register a
|
2502
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
2503
|
+
#
|
2504
|
+
#
|
2505
|
+
#
|
2506
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
2507
|
+
#
|
2362
2508
|
# @return [Types::DescribeStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2363
2509
|
#
|
2364
2510
|
# * {Types::DescribeStackSetOutput#stack_set #stack_set} => Types::StackSet
|
@@ -2367,6 +2513,7 @@ module Aws::CloudFormation
|
|
2367
2513
|
#
|
2368
2514
|
# resp = client.describe_stack_set({
|
2369
2515
|
# stack_set_name: "StackSetName", # required
|
2516
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2370
2517
|
# })
|
2371
2518
|
#
|
2372
2519
|
# @example Response structure
|
@@ -2421,6 +2568,27 @@ module Aws::CloudFormation
|
|
2421
2568
|
# @option params [required, String] :operation_id
|
2422
2569
|
# The unique ID of the stack set operation.
|
2423
2570
|
#
|
2571
|
+
# @option params [String] :call_as
|
2572
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
2573
|
+
# account administrator in the organization's management account or as
|
2574
|
+
# a delegated administrator in a member account.
|
2575
|
+
#
|
2576
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
2577
|
+
# self-managed permissions.
|
2578
|
+
#
|
2579
|
+
# * If you are signed in to the management account, specify `SELF`.
|
2580
|
+
#
|
2581
|
+
# * If you are signed in to a delegated administrator account, specify
|
2582
|
+
# `DELEGATED_ADMIN`.
|
2583
|
+
#
|
2584
|
+
# Your AWS account must be registered as a delegated administrator in
|
2585
|
+
# the management account. For more information, see [Register a
|
2586
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
2587
|
+
#
|
2588
|
+
#
|
2589
|
+
#
|
2590
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
2591
|
+
#
|
2424
2592
|
# @return [Types::DescribeStackSetOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2425
2593
|
#
|
2426
2594
|
# * {Types::DescribeStackSetOperationOutput#stack_set_operation #stack_set_operation} => Types::StackSetOperation
|
@@ -2430,6 +2598,7 @@ module Aws::CloudFormation
|
|
2430
2598
|
# resp = client.describe_stack_set_operation({
|
2431
2599
|
# stack_set_name: "StackSetName", # required
|
2432
2600
|
# operation_id: "ClientRequestToken", # required
|
2601
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2433
2602
|
# })
|
2434
2603
|
#
|
2435
2604
|
# @example Response structure
|
@@ -2570,37 +2739,36 @@ module Aws::CloudFormation
|
|
2570
2739
|
req.send_request(options)
|
2571
2740
|
end
|
2572
2741
|
|
2573
|
-
# Returns detailed information about
|
2742
|
+
# Returns detailed information about an extension that has been
|
2743
|
+
# registered.
|
2574
2744
|
#
|
2575
2745
|
# If you specify a `VersionId`, `DescribeType` returns information about
|
2576
|
-
# that specific
|
2577
|
-
# the default
|
2746
|
+
# that specific extension version. Otherwise, it returns information
|
2747
|
+
# about the default extension version.
|
2578
2748
|
#
|
2579
2749
|
# @option params [String] :type
|
2580
|
-
# The kind of
|
2581
|
-
#
|
2582
|
-
# Currently the only valid value is `RESOURCE`.
|
2750
|
+
# The kind of extension.
|
2583
2751
|
#
|
2584
2752
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
2585
2753
|
#
|
2586
2754
|
# @option params [String] :type_name
|
2587
|
-
# The name of the
|
2755
|
+
# The name of the extension.
|
2588
2756
|
#
|
2589
2757
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
2590
2758
|
#
|
2591
2759
|
# @option params [String] :arn
|
2592
|
-
# The Amazon Resource Name (ARN) of the
|
2760
|
+
# The Amazon Resource Name (ARN) of the extension.
|
2593
2761
|
#
|
2594
2762
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
2595
2763
|
#
|
2596
2764
|
# @option params [String] :version_id
|
2597
|
-
# The ID of a specific version of the
|
2598
|
-
# at the end of the Amazon Resource Name (ARN) assigned to the
|
2599
|
-
# version when it is registered.
|
2765
|
+
# The ID of a specific version of the extension. The version ID is the
|
2766
|
+
# value at the end of the Amazon Resource Name (ARN) assigned to the
|
2767
|
+
# extension version when it is registered.
|
2600
2768
|
#
|
2601
2769
|
# If you specify a `VersionId`, `DescribeType` returns information about
|
2602
|
-
# that specific
|
2603
|
-
# the default
|
2770
|
+
# that specific extension version. Otherwise, it returns information
|
2771
|
+
# about the default extension version.
|
2604
2772
|
#
|
2605
2773
|
# @return [Types::DescribeTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2606
2774
|
#
|
@@ -2659,7 +2827,7 @@ module Aws::CloudFormation
|
|
2659
2827
|
req.send_request(options)
|
2660
2828
|
end
|
2661
2829
|
|
2662
|
-
# Returns information about
|
2830
|
+
# Returns information about an extension's registration, including its
|
2663
2831
|
# current status and type and version identifiers.
|
2664
2832
|
#
|
2665
2833
|
# When you initiate a registration request using ` RegisterType `, you
|
@@ -2667,7 +2835,7 @@ module Aws::CloudFormation
|
|
2667
2835
|
# that registration request.
|
2668
2836
|
#
|
2669
2837
|
# Once the registration request has completed, use ` DescribeType ` to
|
2670
|
-
# return detailed
|
2838
|
+
# return detailed information about an extension.
|
2671
2839
|
#
|
2672
2840
|
# @option params [required, String] :registration_token
|
2673
2841
|
# The identifier for this registration request.
|
@@ -2861,7 +3029,7 @@ module Aws::CloudFormation
|
|
2861
3029
|
# Once the operation has completed, use the following actions to return
|
2862
3030
|
# drift information:
|
2863
3031
|
#
|
2864
|
-
# * Use ` DescribeStackSet ` to return detailed
|
3032
|
+
# * Use ` DescribeStackSet ` to return detailed information about the
|
2865
3033
|
# stack set, including detailed information about the last *completed*
|
2866
3034
|
# drift operation performed on the stack set. (Information about drift
|
2867
3035
|
# operations that are in progress is not included.)
|
@@ -2908,6 +3076,27 @@ module Aws::CloudFormation
|
|
2908
3076
|
# **A suitable default value is auto-generated.** You should normally
|
2909
3077
|
# not need to pass this option.**
|
2910
3078
|
#
|
3079
|
+
# @option params [String] :call_as
|
3080
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3081
|
+
# account administrator in the organization's management account or as
|
3082
|
+
# a delegated administrator in a member account.
|
3083
|
+
#
|
3084
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3085
|
+
# self-managed permissions.
|
3086
|
+
#
|
3087
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3088
|
+
#
|
3089
|
+
# * If you are signed in to a delegated administrator account, specify
|
3090
|
+
# `DELEGATED_ADMIN`.
|
3091
|
+
#
|
3092
|
+
# Your AWS account must be registered as a delegated administrator in
|
3093
|
+
# the management account. For more information, see [Register a
|
3094
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
3095
|
+
#
|
3096
|
+
#
|
3097
|
+
#
|
3098
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
3099
|
+
#
|
2911
3100
|
# @return [Types::DetectStackSetDriftOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2912
3101
|
#
|
2913
3102
|
# * {Types::DetectStackSetDriftOutput#operation_id #operation_id} => String
|
@@ -2924,6 +3113,7 @@ module Aws::CloudFormation
|
|
2924
3113
|
# max_concurrent_percentage: 1,
|
2925
3114
|
# },
|
2926
3115
|
# operation_id: "ClientRequestToken",
|
3116
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2927
3117
|
# })
|
2928
3118
|
#
|
2929
3119
|
# @example Response structure
|
@@ -2957,8 +3147,9 @@ module Aws::CloudFormation
|
|
2957
3147
|
#
|
2958
3148
|
# @option params [String] :template_url
|
2959
3149
|
# Location of file containing the template body. The URL must point to a
|
2960
|
-
# template that is located in an Amazon S3 bucket
|
2961
|
-
# go to [Template Anatomy][1] in the AWS
|
3150
|
+
# template that is located in an Amazon S3 bucket or a Systems Manager
|
3151
|
+
# document. For more information, go to [Template Anatomy][1] in the AWS
|
3152
|
+
# CloudFormation User Guide.
|
2962
3153
|
#
|
2963
3154
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
2964
3155
|
# are passed, only `TemplateBody` is used.
|
@@ -3175,8 +3366,9 @@ module Aws::CloudFormation
|
|
3175
3366
|
# @option params [String] :template_url
|
3176
3367
|
# Location of file containing the template body. The URL must point to a
|
3177
3368
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
3178
|
-
# bucket. For more information about
|
3179
|
-
# Anatomy][1] in the AWS CloudFormation User
|
3369
|
+
# bucket or a Systems Manager document. For more information about
|
3370
|
+
# templates, see [Template Anatomy][1] in the AWS CloudFormation User
|
3371
|
+
# Guide.
|
3180
3372
|
#
|
3181
3373
|
# Conditional: You must specify only one of the following parameters:
|
3182
3374
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3439,6 +3631,27 @@ module Aws::CloudFormation
|
|
3439
3631
|
# @option params [String] :stack_instance_region
|
3440
3632
|
# The name of the Region where you want to list stack instances.
|
3441
3633
|
#
|
3634
|
+
# @option params [String] :call_as
|
3635
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3636
|
+
# account administrator in the organization's management account or as
|
3637
|
+
# a delegated administrator in a member account.
|
3638
|
+
#
|
3639
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3640
|
+
# self-managed permissions.
|
3641
|
+
#
|
3642
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3643
|
+
#
|
3644
|
+
# * If you are signed in to a delegated administrator account, specify
|
3645
|
+
# `DELEGATED_ADMIN`.
|
3646
|
+
#
|
3647
|
+
# Your AWS account must be registered as a delegated administrator in
|
3648
|
+
# the management account. For more information, see [Register a
|
3649
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
3650
|
+
#
|
3651
|
+
#
|
3652
|
+
#
|
3653
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
3654
|
+
#
|
3442
3655
|
# @return [Types::ListStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3443
3656
|
#
|
3444
3657
|
# * {Types::ListStackInstancesOutput#summaries #summaries} => Array<Types::StackInstanceSummary>
|
@@ -3460,6 +3673,7 @@ module Aws::CloudFormation
|
|
3460
3673
|
# ],
|
3461
3674
|
# stack_instance_account: "Account",
|
3462
3675
|
# stack_instance_region: "Region",
|
3676
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3463
3677
|
# })
|
3464
3678
|
#
|
3465
3679
|
# @example Response structure
|
@@ -3569,6 +3783,27 @@ module Aws::CloudFormation
|
|
3569
3783
|
# includes a `NextToken` value that you can assign to the `NextToken`
|
3570
3784
|
# request parameter to get the next set of results.
|
3571
3785
|
#
|
3786
|
+
# @option params [String] :call_as
|
3787
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3788
|
+
# account administrator in the organization's management account or as
|
3789
|
+
# a delegated administrator in a member account.
|
3790
|
+
#
|
3791
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3792
|
+
# self-managed permissions.
|
3793
|
+
#
|
3794
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3795
|
+
#
|
3796
|
+
# * If you are signed in to a delegated administrator account, specify
|
3797
|
+
# `DELEGATED_ADMIN`.
|
3798
|
+
#
|
3799
|
+
# Your AWS account must be registered as a delegated administrator in
|
3800
|
+
# the management account. For more information, see [Register a
|
3801
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
3802
|
+
#
|
3803
|
+
#
|
3804
|
+
#
|
3805
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
3806
|
+
#
|
3572
3807
|
# @return [Types::ListStackSetOperationResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3573
3808
|
#
|
3574
3809
|
# * {Types::ListStackSetOperationResultsOutput#summaries #summaries} => Array<Types::StackSetOperationResultSummary>
|
@@ -3583,6 +3818,7 @@ module Aws::CloudFormation
|
|
3583
3818
|
# operation_id: "ClientRequestToken", # required
|
3584
3819
|
# next_token: "NextToken",
|
3585
3820
|
# max_results: 1,
|
3821
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3586
3822
|
# })
|
3587
3823
|
#
|
3588
3824
|
# @example Response structure
|
@@ -3627,6 +3863,27 @@ module Aws::CloudFormation
|
|
3627
3863
|
# includes a `NextToken` value that you can assign to the `NextToken`
|
3628
3864
|
# request parameter to get the next set of results.
|
3629
3865
|
#
|
3866
|
+
# @option params [String] :call_as
|
3867
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3868
|
+
# account administrator in the organization's management account or as
|
3869
|
+
# a delegated administrator in a member account.
|
3870
|
+
#
|
3871
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3872
|
+
# self-managed permissions.
|
3873
|
+
#
|
3874
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3875
|
+
#
|
3876
|
+
# * If you are signed in to a delegated administrator account, specify
|
3877
|
+
# `DELEGATED_ADMIN`.
|
3878
|
+
#
|
3879
|
+
# Your AWS account must be registered as a delegated administrator in
|
3880
|
+
# the management account. For more information, see [Register a
|
3881
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
3882
|
+
#
|
3883
|
+
#
|
3884
|
+
#
|
3885
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
3886
|
+
#
|
3630
3887
|
# @return [Types::ListStackSetOperationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3631
3888
|
#
|
3632
3889
|
# * {Types::ListStackSetOperationsOutput#summaries #summaries} => Array<Types::StackSetOperationSummary>
|
@@ -3640,6 +3897,7 @@ module Aws::CloudFormation
|
|
3640
3897
|
# stack_set_name: "StackSetName", # required
|
3641
3898
|
# next_token: "NextToken",
|
3642
3899
|
# max_results: 1,
|
3900
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3643
3901
|
# })
|
3644
3902
|
#
|
3645
3903
|
# @example Response structure
|
@@ -3664,6 +3922,19 @@ module Aws::CloudFormation
|
|
3664
3922
|
# Returns summary information about stack sets that are associated with
|
3665
3923
|
# the user.
|
3666
3924
|
#
|
3925
|
+
# * \[Self-managed permissions\] If you set the `CallAs` parameter to
|
3926
|
+
# `SELF` while signed in to your AWS account, `ListStackSets` returns
|
3927
|
+
# all self-managed stack sets in your AWS account.
|
3928
|
+
#
|
3929
|
+
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
3930
|
+
# `SELF` while signed in to the organization's management account,
|
3931
|
+
# `ListStackSets` returns all stack sets in the management account.
|
3932
|
+
#
|
3933
|
+
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
3934
|
+
# `DELEGATED_ADMIN` while signed in to your member account,
|
3935
|
+
# `ListStackSets` returns all stack sets with service-managed
|
3936
|
+
# permissions in the management account.
|
3937
|
+
#
|
3667
3938
|
# @option params [String] :next_token
|
3668
3939
|
# If the previous paginated request didn't return all of the remaining
|
3669
3940
|
# results, the response object's `NextToken` parameter value is set to
|
@@ -3682,6 +3953,27 @@ module Aws::CloudFormation
|
|
3682
3953
|
# The status of the stack sets that you want to get summary information
|
3683
3954
|
# about.
|
3684
3955
|
#
|
3956
|
+
# @option params [String] :call_as
|
3957
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3958
|
+
# account administrator in the management account or as a delegated
|
3959
|
+
# administrator in a member account.
|
3960
|
+
#
|
3961
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3962
|
+
# self-managed permissions.
|
3963
|
+
#
|
3964
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3965
|
+
#
|
3966
|
+
# * If you are signed in to a delegated administrator account, specify
|
3967
|
+
# `DELEGATED_ADMIN`.
|
3968
|
+
#
|
3969
|
+
# Your AWS account must be registered as a delegated administrator in
|
3970
|
+
# the management account. For more information, see [Register a
|
3971
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
3972
|
+
#
|
3973
|
+
#
|
3974
|
+
#
|
3975
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
3976
|
+
#
|
3685
3977
|
# @return [Types::ListStackSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3686
3978
|
#
|
3687
3979
|
# * {Types::ListStackSetsOutput#summaries #summaries} => Array<Types::StackSetSummary>
|
@@ -3695,6 +3987,7 @@ module Aws::CloudFormation
|
|
3695
3987
|
# next_token: "NextToken",
|
3696
3988
|
# max_results: 1,
|
3697
3989
|
# status: "ACTIVE", # accepts ACTIVE, DELETED
|
3990
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3698
3991
|
# })
|
3699
3992
|
#
|
3700
3993
|
# @example Response structure
|
@@ -3777,27 +4070,25 @@ module Aws::CloudFormation
|
|
3777
4070
|
req.send_request(options)
|
3778
4071
|
end
|
3779
4072
|
|
3780
|
-
# Returns a list of registration tokens for the specified
|
4073
|
+
# Returns a list of registration tokens for the specified extension(s).
|
3781
4074
|
#
|
3782
4075
|
# @option params [String] :type
|
3783
|
-
# The kind of
|
3784
|
-
#
|
3785
|
-
# Currently the only valid value is `RESOURCE`.
|
4076
|
+
# The kind of extension.
|
3786
4077
|
#
|
3787
4078
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3788
4079
|
#
|
3789
4080
|
# @option params [String] :type_name
|
3790
|
-
# The name of the
|
4081
|
+
# The name of the extension.
|
3791
4082
|
#
|
3792
4083
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3793
4084
|
#
|
3794
4085
|
# @option params [String] :type_arn
|
3795
|
-
# The Amazon Resource Name (ARN) of the
|
4086
|
+
# The Amazon Resource Name (ARN) of the extension.
|
3796
4087
|
#
|
3797
4088
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3798
4089
|
#
|
3799
4090
|
# @option params [String] :registration_status_filter
|
3800
|
-
# The current status of the
|
4091
|
+
# The current status of the extension registration request.
|
3801
4092
|
#
|
3802
4093
|
# The default is `IN_PROGRESS`.
|
3803
4094
|
#
|
@@ -3848,23 +4139,22 @@ module Aws::CloudFormation
|
|
3848
4139
|
req.send_request(options)
|
3849
4140
|
end
|
3850
4141
|
|
3851
|
-
# Returns summary information about the versions of
|
4142
|
+
# Returns summary information about the versions of an extension.
|
3852
4143
|
#
|
3853
4144
|
# @option params [String] :type
|
3854
|
-
# The kind of the
|
3855
|
-
#
|
3856
|
-
# Currently the only valid value is `RESOURCE`.
|
4145
|
+
# The kind of the extension.
|
3857
4146
|
#
|
3858
4147
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3859
4148
|
#
|
3860
4149
|
# @option params [String] :type_name
|
3861
|
-
# The name of the
|
4150
|
+
# The name of the extension for which you want version summary
|
4151
|
+
# information.
|
3862
4152
|
#
|
3863
4153
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3864
4154
|
#
|
3865
4155
|
# @option params [String] :arn
|
3866
|
-
# The Amazon Resource Name (ARN) of the
|
3867
|
-
# summary information.
|
4156
|
+
# The Amazon Resource Name (ARN) of the extension for which you want
|
4157
|
+
# version summary information.
|
3868
4158
|
#
|
3869
4159
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3870
4160
|
#
|
@@ -3883,17 +4173,17 @@ module Aws::CloudFormation
|
|
3883
4173
|
# `NextToken` parameter is set to `null`.
|
3884
4174
|
#
|
3885
4175
|
# @option params [String] :deprecated_status
|
3886
|
-
# The deprecation status of the
|
4176
|
+
# The deprecation status of the extension versions that you want to get
|
3887
4177
|
# summary information about.
|
3888
4178
|
#
|
3889
4179
|
# Valid values include:
|
3890
4180
|
#
|
3891
|
-
# * `LIVE`\: The
|
4181
|
+
# * `LIVE`\: The extension version is registered and can be used in
|
3892
4182
|
# CloudFormation operations, dependent on its provisioning behavior
|
3893
4183
|
# and visibility scope.
|
3894
4184
|
#
|
3895
|
-
# * `DEPRECATED`\: The
|
3896
|
-
# longer be used in CloudFormation operations.
|
4185
|
+
# * `DEPRECATED`\: The extension version has been deregistered and can
|
4186
|
+
# no longer be used in CloudFormation operations.
|
3897
4187
|
#
|
3898
4188
|
# The default is `LIVE`.
|
3899
4189
|
#
|
@@ -3936,20 +4226,20 @@ module Aws::CloudFormation
|
|
3936
4226
|
req.send_request(options)
|
3937
4227
|
end
|
3938
4228
|
|
3939
|
-
# Returns summary information about
|
3940
|
-
# CloudFormation.
|
4229
|
+
# Returns summary information about extension that have been registered
|
4230
|
+
# with CloudFormation.
|
3941
4231
|
#
|
3942
4232
|
# @option params [String] :visibility
|
3943
|
-
# The scope at which the
|
3944
|
-
# operations.
|
4233
|
+
# The scope at which the extension is visible and usable in
|
4234
|
+
# CloudFormation operations.
|
3945
4235
|
#
|
3946
4236
|
# Valid values include:
|
3947
4237
|
#
|
3948
|
-
# * `PRIVATE`\: The
|
3949
|
-
# in which it is registered. Currently, AWS CloudFormation
|
3950
|
-
#
|
4238
|
+
# * `PRIVATE`\: The extension is only visible and usable within the
|
4239
|
+
# account in which it is registered. Currently, AWS CloudFormation
|
4240
|
+
# marks any extension you create as `PRIVATE`.
|
3951
4241
|
#
|
3952
|
-
# * `PUBLIC`\: The
|
4242
|
+
# * `PUBLIC`\: The extension is publically visible and usable within any
|
3953
4243
|
# Amazon account.
|
3954
4244
|
#
|
3955
4245
|
# The default is `PRIVATE`.
|
@@ -3961,27 +4251,27 @@ module Aws::CloudFormation
|
|
3961
4251
|
#
|
3962
4252
|
# Valid values include:
|
3963
4253
|
#
|
3964
|
-
# * `FULLY_MUTABLE`\: The
|
3965
|
-
# updates to the
|
4254
|
+
# * `FULLY_MUTABLE`\: The extension includes an update handler to
|
4255
|
+
# process updates to the extension during stack update operations.
|
3966
4256
|
#
|
3967
|
-
# * `IMMUTABLE`\: The
|
3968
|
-
#
|
3969
|
-
# update operations.
|
4257
|
+
# * `IMMUTABLE`\: The extension does not include an update handler, so
|
4258
|
+
# the extension cannot be updated and must instead be replaced during
|
4259
|
+
# stack update operations.
|
3970
4260
|
#
|
3971
|
-
# * `NON_PROVISIONABLE`\: The
|
3972
|
-
# delete handlers, and therefore cannot actually be provisioned.
|
4261
|
+
# * `NON_PROVISIONABLE`\: The extension does not include create, read,
|
4262
|
+
# and delete handlers, and therefore cannot actually be provisioned.
|
3973
4263
|
#
|
3974
4264
|
# @option params [String] :deprecated_status
|
3975
|
-
# The deprecation status of the
|
4265
|
+
# The deprecation status of the extension that you want to get summary
|
3976
4266
|
# information about.
|
3977
4267
|
#
|
3978
4268
|
# Valid values include:
|
3979
4269
|
#
|
3980
|
-
# * `LIVE`\: The
|
4270
|
+
# * `LIVE`\: The extension is registered for use in CloudFormation
|
3981
4271
|
# operations.
|
3982
4272
|
#
|
3983
|
-
# * `DEPRECATED`\: The
|
3984
|
-
# used in CloudFormation operations.
|
4273
|
+
# * `DEPRECATED`\: The extension has been deregistered and can no longer
|
4274
|
+
# be used in CloudFormation operations.
|
3985
4275
|
#
|
3986
4276
|
# @option params [String] :type
|
3987
4277
|
# The type of extension.
|
@@ -4119,24 +4409,25 @@ module Aws::CloudFormation
|
|
4119
4409
|
req.send_request(options)
|
4120
4410
|
end
|
4121
4411
|
|
4122
|
-
# Registers
|
4123
|
-
# makes it available for use in CloudFormation templates in
|
4124
|
-
# account, and includes:
|
4412
|
+
# Registers an extension with the CloudFormation service. Registering an
|
4413
|
+
# extension makes it available for use in CloudFormation templates in
|
4414
|
+
# your AWS account, and includes:
|
4125
4415
|
#
|
4126
|
-
# * Validating the
|
4416
|
+
# * Validating the extension schema
|
4127
4417
|
#
|
4128
|
-
# * Determining which handlers have been specified for the
|
4418
|
+
# * Determining which handlers, if any, have been specified for the
|
4419
|
+
# extension
|
4129
4420
|
#
|
4130
|
-
# * Making the
|
4421
|
+
# * Making the extension available for use in your account
|
4131
4422
|
#
|
4132
|
-
# For more information on how to develop
|
4423
|
+
# For more information on how to develop extensions and ready them for
|
4133
4424
|
# registeration, see [Creating Resource Providers][1] in the
|
4134
4425
|
# *CloudFormation CLI User Guide*.
|
4135
4426
|
#
|
4136
|
-
# You can have a maximum of 50 resource
|
4137
|
-
# time. This maximum is per account and per region. Use
|
4427
|
+
# You can have a maximum of 50 resource extension versions registered at
|
4428
|
+
# a time. This maximum is per account and per region. Use
|
4138
4429
|
# [DeregisterType](AWSCloudFormation/latest/APIReference/API_DeregisterType.html)
|
4139
|
-
# to deregister specific
|
4430
|
+
# to deregister specific extension versions if necessary.
|
4140
4431
|
#
|
4141
4432
|
# Once you have initiated a registration request using ` RegisterType `,
|
4142
4433
|
# you can use ` DescribeTypeRegistration ` to monitor the progress of
|
@@ -4147,18 +4438,16 @@ module Aws::CloudFormation
|
|
4147
4438
|
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
|
4148
4439
|
#
|
4149
4440
|
# @option params [String] :type
|
4150
|
-
# The kind of
|
4151
|
-
#
|
4152
|
-
# Currently, the only valid value is `RESOURCE`.
|
4441
|
+
# The kind of extension.
|
4153
4442
|
#
|
4154
4443
|
# @option params [required, String] :type_name
|
4155
|
-
# The name of the
|
4444
|
+
# The name of the extension being registered.
|
4156
4445
|
#
|
4157
|
-
# We recommend that
|
4446
|
+
# We recommend that extension names adhere to the following pattern:
|
4158
4447
|
# *company\_or\_organization*\::*service*\::*type*.
|
4159
4448
|
#
|
4160
4449
|
# <note markdown="1"> The following organization namespaces are reserved and cannot be used
|
4161
|
-
# in your
|
4450
|
+
# in your extension names:
|
4162
4451
|
#
|
4163
4452
|
# * `Alexa`
|
4164
4453
|
#
|
@@ -4175,20 +4464,18 @@ module Aws::CloudFormation
|
|
4175
4464
|
# </note>
|
4176
4465
|
#
|
4177
4466
|
# @option params [required, String] :schema_handler_package
|
4178
|
-
# A url to the S3 bucket containing the
|
4179
|
-
# contains the
|
4180
|
-
# you want to register.
|
4467
|
+
# A url to the S3 bucket containing the extension project package that
|
4468
|
+
# contains the neccessary files for the extension you want to register.
|
4181
4469
|
#
|
4182
|
-
# For information on generating a schema handler package for the
|
4183
|
-
# you want to register, see [submit][1] in the *CloudFormation
|
4184
|
-
# Guide*.
|
4470
|
+
# For information on generating a schema handler package for the
|
4471
|
+
# extension you want to register, see [submit][1] in the *CloudFormation
|
4472
|
+
# CLI User Guide*.
|
4185
4473
|
#
|
4186
|
-
# <note markdown="1"> The user registering the
|
4187
|
-
#
|
4188
|
-
#
|
4189
|
-
#
|
4190
|
-
#
|
4191
|
-
# Guide*.
|
4474
|
+
# <note markdown="1"> The user registering the extension must be able to access the package
|
4475
|
+
# in the S3 bucket. That is, the user needs to have [GetObject][2]
|
4476
|
+
# permissions for the schema handler package. For more information, see
|
4477
|
+
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the *AWS
|
4478
|
+
# Identity and Access Management User Guide*.
|
4192
4479
|
#
|
4193
4480
|
# </note>
|
4194
4481
|
#
|
@@ -4199,26 +4486,25 @@ module Aws::CloudFormation
|
|
4199
4486
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html
|
4200
4487
|
#
|
4201
4488
|
# @option params [Types::LoggingConfig] :logging_config
|
4202
|
-
# Specifies logging configuration information for
|
4489
|
+
# Specifies logging configuration information for an extension.
|
4203
4490
|
#
|
4204
4491
|
# @option params [String] :execution_role_arn
|
4205
4492
|
# The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
|
4206
|
-
# assume when invoking the
|
4207
|
-
#
|
4493
|
+
# assume when invoking the extension. If your extension calls AWS APIs
|
4494
|
+
# in any of its handlers, you must create an <i> <a
|
4208
4495
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
4209
4496
|
# execution role</a> </i> that includes the necessary permissions to
|
4210
4497
|
# call those AWS APIs, and provision that execution role in your
|
4211
|
-
# account. When CloudFormation needs to invoke the
|
4212
|
-
#
|
4213
|
-
#
|
4214
|
-
#
|
4215
|
-
# credentials.
|
4498
|
+
# account. When CloudFormation needs to invoke the extension handler,
|
4499
|
+
# CloudFormation assumes this execution role to create a temporary
|
4500
|
+
# session token, which it then passes to the extension handler, thereby
|
4501
|
+
# supplying your extension with the appropriate credentials.
|
4216
4502
|
#
|
4217
4503
|
# @option params [String] :client_request_token
|
4218
4504
|
# A unique identifier that acts as an idempotency key for this
|
4219
4505
|
# registration request. Specifying a client request token prevents
|
4220
|
-
# CloudFormation from generating more than one version of
|
4221
|
-
# the same registeration request, even if the request is submitted
|
4506
|
+
# CloudFormation from generating more than one version of an extension
|
4507
|
+
# from the same registeration request, even if the request is submitted
|
4222
4508
|
# multiple times.
|
4223
4509
|
#
|
4224
4510
|
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4292,29 +4578,29 @@ module Aws::CloudFormation
|
|
4292
4578
|
req.send_request(options)
|
4293
4579
|
end
|
4294
4580
|
|
4295
|
-
# Specify the default version of
|
4296
|
-
# will be used in CloudFormation operations.
|
4581
|
+
# Specify the default version of an extension. The default version of an
|
4582
|
+
# extension will be used in CloudFormation operations.
|
4297
4583
|
#
|
4298
4584
|
# @option params [String] :arn
|
4299
|
-
# The Amazon Resource Name (ARN) of the
|
4300
|
-
# summary information.
|
4585
|
+
# The Amazon Resource Name (ARN) of the extension for which you want
|
4586
|
+
# version summary information.
|
4301
4587
|
#
|
4302
4588
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
4303
4589
|
#
|
4304
4590
|
# @option params [String] :type
|
4305
|
-
# The kind of
|
4591
|
+
# The kind of extension.
|
4306
4592
|
#
|
4307
4593
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
4308
4594
|
#
|
4309
4595
|
# @option params [String] :type_name
|
4310
|
-
# The name of the
|
4596
|
+
# The name of the extension.
|
4311
4597
|
#
|
4312
4598
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
4313
4599
|
#
|
4314
4600
|
# @option params [String] :version_id
|
4315
|
-
# The ID of a specific version of the
|
4316
|
-
# at the end of the Amazon Resource Name (ARN) assigned to the
|
4317
|
-
# version when it is registered.
|
4601
|
+
# The ID of a specific version of the extension. The version ID is the
|
4602
|
+
# value at the end of the Amazon Resource Name (ARN) assigned to the
|
4603
|
+
# extension version when it is registered.
|
4318
4604
|
#
|
4319
4605
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4320
4606
|
#
|
@@ -4394,6 +4680,27 @@ module Aws::CloudFormation
|
|
4394
4680
|
# @option params [required, String] :operation_id
|
4395
4681
|
# The ID of the stack operation.
|
4396
4682
|
#
|
4683
|
+
# @option params [String] :call_as
|
4684
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
4685
|
+
# account administrator in the organization's management account or as
|
4686
|
+
# a delegated administrator in a member account.
|
4687
|
+
#
|
4688
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
4689
|
+
# self-managed permissions.
|
4690
|
+
#
|
4691
|
+
# * If you are signed in to the management account, specify `SELF`.
|
4692
|
+
#
|
4693
|
+
# * If you are signed in to a delegated administrator account, specify
|
4694
|
+
# `DELEGATED_ADMIN`.
|
4695
|
+
#
|
4696
|
+
# Your AWS account must be registered as a delegated administrator in
|
4697
|
+
# the management account. For more information, see [Register a
|
4698
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
4699
|
+
#
|
4700
|
+
#
|
4701
|
+
#
|
4702
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
4703
|
+
#
|
4397
4704
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4398
4705
|
#
|
4399
4706
|
# @example Request syntax with placeholder values
|
@@ -4401,6 +4708,7 @@ module Aws::CloudFormation
|
|
4401
4708
|
# resp = client.stop_stack_set_operation({
|
4402
4709
|
# stack_set_name: "StackSetName", # required
|
4403
4710
|
# operation_id: "ClientRequestToken", # required
|
4711
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
4404
4712
|
# })
|
4405
4713
|
#
|
4406
4714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation AWS API Documentation
|
@@ -4445,8 +4753,9 @@ module Aws::CloudFormation
|
|
4445
4753
|
#
|
4446
4754
|
# @option params [String] :template_url
|
4447
4755
|
# Location of file containing the template body. The URL must point to a
|
4448
|
-
# template that is located in an Amazon S3 bucket
|
4449
|
-
# go to [Template Anatomy][1] in the AWS
|
4756
|
+
# template that is located in an Amazon S3 bucket or a Systems Manager
|
4757
|
+
# document. For more information, go to [Template Anatomy][1] in the AWS
|
4758
|
+
# CloudFormation User Guide.
|
4450
4759
|
#
|
4451
4760
|
# Conditional: You must specify only one of the following parameters:
|
4452
4761
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -4763,15 +5072,15 @@ module Aws::CloudFormation
|
|
4763
5072
|
# instances.
|
4764
5073
|
#
|
4765
5074
|
# @option params [Array<String>] :accounts
|
4766
|
-
# \[
|
4767
|
-
#
|
5075
|
+
# \[Self-managed permissions\] The names of one or more AWS accounts for
|
5076
|
+
# which you want to update parameter values for stack instances. The
|
4768
5077
|
# overridden parameter values will be applied to all stack instances in
|
4769
5078
|
# the specified accounts and Regions.
|
4770
5079
|
#
|
4771
5080
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
4772
5081
|
#
|
4773
5082
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
4774
|
-
# \[
|
5083
|
+
# \[Service-managed permissions\] The AWS Organizations accounts for
|
4775
5084
|
# which you want to update parameter values for stack instances. If your
|
4776
5085
|
# update targets OUs, the overridden parameter values only apply to the
|
4777
5086
|
# accounts that are currently in the target OUs and their child OUs.
|
@@ -4849,6 +5158,27 @@ module Aws::CloudFormation
|
|
4849
5158
|
# **A suitable default value is auto-generated.** You should normally
|
4850
5159
|
# not need to pass this option.**
|
4851
5160
|
#
|
5161
|
+
# @option params [String] :call_as
|
5162
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
5163
|
+
# account administrator in the organization's management account or as
|
5164
|
+
# a delegated administrator in a member account.
|
5165
|
+
#
|
5166
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
5167
|
+
# self-managed permissions.
|
5168
|
+
#
|
5169
|
+
# * If you are signed in to the management account, specify `SELF`.
|
5170
|
+
#
|
5171
|
+
# * If you are signed in to a delegated administrator account, specify
|
5172
|
+
# `DELEGATED_ADMIN`.
|
5173
|
+
#
|
5174
|
+
# Your AWS account must be registered as a delegated administrator in
|
5175
|
+
# the management account. For more information, see [Register a
|
5176
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
5177
|
+
#
|
5178
|
+
#
|
5179
|
+
#
|
5180
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
5181
|
+
#
|
4852
5182
|
# @return [Types::UpdateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4853
5183
|
#
|
4854
5184
|
# * {Types::UpdateStackInstancesOutput#operation_id #operation_id} => String
|
@@ -4879,6 +5209,7 @@ module Aws::CloudFormation
|
|
4879
5209
|
# max_concurrent_percentage: 1,
|
4880
5210
|
# },
|
4881
5211
|
# operation_id: "ClientRequestToken",
|
5212
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
4882
5213
|
# })
|
4883
5214
|
#
|
4884
5215
|
# @example Response structure
|
@@ -4924,8 +5255,9 @@ module Aws::CloudFormation
|
|
4924
5255
|
# @option params [String] :template_url
|
4925
5256
|
# The location of the file that contains the template body. The URL must
|
4926
5257
|
# point to a template (maximum size: 460,800 bytes) that is located in
|
4927
|
-
# an Amazon S3 bucket
|
4928
|
-
# in the AWS CloudFormation User
|
5258
|
+
# an Amazon S3 bucket or a Systems Manager document. For more
|
5259
|
+
# information, see [Template Anatomy][1] in the AWS CloudFormation User
|
5260
|
+
# Guide.
|
4929
5261
|
#
|
4930
5262
|
# Conditional: You must specify only one of the following parameters:
|
4931
5263
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
@@ -5089,7 +5421,7 @@ module Aws::CloudFormation
|
|
5089
5421
|
# permissions to perform operations on the stack set.
|
5090
5422
|
#
|
5091
5423
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
5092
|
-
# \[
|
5424
|
+
# \[Service-managed permissions\] The AWS Organizations accounts in
|
5093
5425
|
# which to update associated stack instances.
|
5094
5426
|
#
|
5095
5427
|
# To update all the stack instances associated with this stack set, do
|
@@ -5124,7 +5456,7 @@ module Aws::CloudFormation
|
|
5124
5456
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
|
5125
5457
|
#
|
5126
5458
|
# @option params [Types::AutoDeployment] :auto_deployment
|
5127
|
-
# \[
|
5459
|
+
# \[Service-managed permissions\] Describes whether StackSets
|
5128
5460
|
# automatically deploys to AWS Organizations accounts that are added to
|
5129
5461
|
# a target organization or organizational unit (OU).
|
5130
5462
|
#
|
@@ -5150,7 +5482,7 @@ module Aws::CloudFormation
|
|
5150
5482
|
# not need to pass this option.**
|
5151
5483
|
#
|
5152
5484
|
# @option params [Array<String>] :accounts
|
5153
|
-
# \[
|
5485
|
+
# \[Self-managed permissions\] The accounts in which to update
|
5154
5486
|
# associated stack instances. If you specify accounts, you must also
|
5155
5487
|
# specify the Regions in which to update stack set instances.
|
5156
5488
|
#
|
@@ -5185,6 +5517,27 @@ module Aws::CloudFormation
|
|
5185
5517
|
# while leaving all other stack instances with their existing stack
|
5186
5518
|
# instance status.
|
5187
5519
|
#
|
5520
|
+
# @option params [String] :call_as
|
5521
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
5522
|
+
# account administrator in the organization's management account or as
|
5523
|
+
# a delegated administrator in a member account.
|
5524
|
+
#
|
5525
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
5526
|
+
# self-managed permissions.
|
5527
|
+
#
|
5528
|
+
# * If you are signed in to the management account, specify `SELF`.
|
5529
|
+
#
|
5530
|
+
# * If you are signed in to a delegated administrator account, specify
|
5531
|
+
# `DELEGATED_ADMIN`.
|
5532
|
+
#
|
5533
|
+
# Your AWS account must be registered as a delegated administrator in
|
5534
|
+
# the management account. For more information, see [Register a
|
5535
|
+
# delegated administrator][1] in the *AWS CloudFormation User Guide*.
|
5536
|
+
#
|
5537
|
+
#
|
5538
|
+
#
|
5539
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
5540
|
+
#
|
5188
5541
|
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5189
5542
|
#
|
5190
5543
|
# * {Types::UpdateStackSetOutput#operation_id #operation_id} => String
|
@@ -5233,6 +5586,7 @@ module Aws::CloudFormation
|
|
5233
5586
|
# operation_id: "ClientRequestToken",
|
5234
5587
|
# accounts: ["Account"],
|
5235
5588
|
# regions: ["Region"],
|
5589
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
5236
5590
|
# })
|
5237
5591
|
#
|
5238
5592
|
# @example Response structure
|
@@ -5313,8 +5667,8 @@ module Aws::CloudFormation
|
|
5313
5667
|
# @option params [String] :template_url
|
5314
5668
|
# Location of file containing the template body. The URL must point to a
|
5315
5669
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
5316
|
-
# bucket. For more information, go to
|
5317
|
-
# CloudFormation User Guide.
|
5670
|
+
# bucket or a Systems Manager document. For more information, go to
|
5671
|
+
# [Template Anatomy][1] in the AWS CloudFormation User Guide.
|
5318
5672
|
#
|
5319
5673
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
5320
5674
|
# are passed, only `TemplateBody` is used.
|
@@ -5374,7 +5728,7 @@ module Aws::CloudFormation
|
|
5374
5728
|
params: params,
|
5375
5729
|
config: config)
|
5376
5730
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
5377
|
-
context[:gem_version] = '1.
|
5731
|
+
context[:gem_version] = '1.48.0'
|
5378
5732
|
Seahorse::Client::Request.new(handlers, context)
|
5379
5733
|
end
|
5380
5734
|
|