aws-sdk-cloudformation 1.44.0 → 1.49.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +330 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-cloudformation.rb +2 -2
- data/lib/aws-sdk-cloudformation/client.rb +569 -173
- data/lib/aws-sdk-cloudformation/client_api.rb +39 -1
- data/lib/aws-sdk-cloudformation/errors.rb +1 -1
- data/lib/aws-sdk-cloudformation/event.rb +1 -1
- data/lib/aws-sdk-cloudformation/resource.rb +6 -7
- data/lib/aws-sdk-cloudformation/stack.rb +12 -13
- data/lib/aws-sdk-cloudformation/stack_resource.rb +9 -1
- data/lib/aws-sdk-cloudformation/stack_resource_summary.rb +9 -1
- data/lib/aws-sdk-cloudformation/types.rb +733 -225
- data/lib/aws-sdk-cloudformation/waiters.rb +1 -1
- metadata +8 -5
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.49.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-cloudformation/customizations'
|
|
53
53
|
# @!group service
|
54
54
|
module Aws::CloudFormation
|
55
55
|
|
56
|
-
GEM_VERSION = '1.
|
56
|
+
GEM_VERSION = '1.49.0'
|
57
57
|
|
58
58
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -505,6 +505,9 @@ module Aws::CloudFormation
|
|
505
505
|
# execute the change set by using the ExecuteChangeSet action. AWS
|
506
506
|
# CloudFormation doesn't make changes until you execute the change set.
|
507
507
|
#
|
508
|
+
# To create a change set for the entire stack hierachy, set
|
509
|
+
# `IncludeNestedStacks` to `True`.
|
510
|
+
#
|
508
511
|
# @option params [required, String] :stack_name
|
509
512
|
# The name or the unique ID of the stack for which you are creating a
|
510
513
|
# change set. AWS CloudFormation generates the change set by comparing
|
@@ -522,8 +525,9 @@ module Aws::CloudFormation
|
|
522
525
|
# @option params [String] :template_url
|
523
526
|
# The location of the file that contains the revised template. The URL
|
524
527
|
# must point to a template (max size: 460,800 bytes) that is located in
|
525
|
-
# an S3 bucket
|
526
|
-
# 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.
|
527
531
|
#
|
528
532
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
529
533
|
#
|
@@ -598,11 +602,10 @@ module Aws::CloudFormation
|
|
598
602
|
# <note markdown="1"> This capacity does not apply to creating change sets, and specifying
|
599
603
|
# it when creating change sets has no effect.
|
600
604
|
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
# specifying this capability.
|
605
|
+
# If you want to create a stack from a stack template that contains
|
606
|
+
# macros *and* nested stacks, you must create or update the stack
|
607
|
+
# directly from the template using the CreateStack or UpdateStack
|
608
|
+
# action, and specifying this capability.
|
606
609
|
#
|
607
610
|
# </note>
|
608
611
|
#
|
@@ -710,6 +713,11 @@ module Aws::CloudFormation
|
|
710
713
|
# @option params [Array<Types::ResourceToImport>] :resources_to_import
|
711
714
|
# The resources to import into your stack.
|
712
715
|
#
|
716
|
+
# @option params [Boolean] :include_nested_stacks
|
717
|
+
# Creates a change set for the all nested stacks specified in the
|
718
|
+
# template. The default behavior of this action is set to `False`. To
|
719
|
+
# include nested sets in a change set, specify `True`.
|
720
|
+
#
|
713
721
|
# @return [Types::CreateChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
714
722
|
#
|
715
723
|
# * {Types::CreateChangeSetOutput#id #id} => String
|
@@ -762,6 +770,7 @@ module Aws::CloudFormation
|
|
762
770
|
# },
|
763
771
|
# },
|
764
772
|
# ],
|
773
|
+
# include_nested_stacks: false,
|
765
774
|
# })
|
766
775
|
#
|
767
776
|
# @example Response structure
|
@@ -807,8 +816,8 @@ module Aws::CloudFormation
|
|
807
816
|
# @option params [String] :template_url
|
808
817
|
# Location of file containing the template body. The URL must point to a
|
809
818
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
810
|
-
# bucket. For more information, go to the
|
811
|
-
# 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.
|
812
821
|
#
|
813
822
|
# Conditional: You must specify either the `TemplateBody` or the
|
814
823
|
# `TemplateURL` parameter, but not both.
|
@@ -907,10 +916,9 @@ module Aws::CloudFormation
|
|
907
916
|
# [AWS::Serverless][10] transforms, which are macros hosted by AWS
|
908
917
|
# CloudFormation.
|
909
918
|
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
# using this capability.
|
919
|
+
# If you want to create a stack from a stack template that contains
|
920
|
+
# macros *and* nested stacks, you must create the stack directly from
|
921
|
+
# the template using this capability.
|
914
922
|
#
|
915
923
|
# You should only create stacks directly from a stack template that
|
916
924
|
# contains macros if you know what processing the macro performs.
|
@@ -1108,14 +1116,14 @@ module Aws::CloudFormation
|
|
1108
1116
|
# instances from.
|
1109
1117
|
#
|
1110
1118
|
# @option params [Array<String>] :accounts
|
1111
|
-
# \[
|
1119
|
+
# \[Self-managed permissions\] The names of one or more AWS accounts
|
1112
1120
|
# that you want to create stack instances in the specified Region(s)
|
1113
1121
|
# for.
|
1114
1122
|
#
|
1115
1123
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1116
1124
|
#
|
1117
1125
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1118
|
-
# \[
|
1126
|
+
# \[Service-managed permissions\] The AWS Organizations accounts for
|
1119
1127
|
# which to create stack instances in the specified Regions.
|
1120
1128
|
#
|
1121
1129
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
@@ -1185,6 +1193,27 @@ module Aws::CloudFormation
|
|
1185
1193
|
# **A suitable default value is auto-generated.** You should normally
|
1186
1194
|
# not need to pass this option.**
|
1187
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
|
+
#
|
1188
1217
|
# @return [Types::CreateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1189
1218
|
#
|
1190
1219
|
# * {Types::CreateStackInstancesOutput#operation_id #operation_id} => String
|
@@ -1215,6 +1244,7 @@ module Aws::CloudFormation
|
|
1215
1244
|
# max_concurrent_percentage: 1,
|
1216
1245
|
# },
|
1217
1246
|
# operation_id: "ClientRequestToken",
|
1247
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1218
1248
|
# })
|
1219
1249
|
#
|
1220
1250
|
# @example Response structure
|
@@ -1261,8 +1291,9 @@ module Aws::CloudFormation
|
|
1261
1291
|
# @option params [String] :template_url
|
1262
1292
|
# The location of the file that contains the template body. The URL must
|
1263
1293
|
# point to a template (maximum size: 460,800 bytes) that's located in
|
1264
|
-
# an Amazon S3 bucket
|
1265
|
-
# 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.
|
1266
1297
|
#
|
1267
1298
|
# Conditional: You must specify either the TemplateBody or the
|
1268
1299
|
# TemplateURL parameter, but not both.
|
@@ -1408,6 +1439,32 @@ module Aws::CloudFormation
|
|
1408
1439
|
# accounts that are added to the target organization or organizational
|
1409
1440
|
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
|
1410
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
|
+
#
|
1411
1468
|
# @option params [String] :client_request_token
|
1412
1469
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
1413
1470
|
# token if you plan to retry requests so that AWS CloudFormation knows
|
@@ -1454,6 +1511,7 @@ module Aws::CloudFormation
|
|
1454
1511
|
# enabled: false,
|
1455
1512
|
# retain_stacks_on_account_removal: false,
|
1456
1513
|
# },
|
1514
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1457
1515
|
# client_request_token: "ClientRequestToken",
|
1458
1516
|
# })
|
1459
1517
|
#
|
@@ -1476,6 +1534,11 @@ module Aws::CloudFormation
|
|
1476
1534
|
# If the call successfully completes, AWS CloudFormation successfully
|
1477
1535
|
# deleted the change set.
|
1478
1536
|
#
|
1537
|
+
# If `IncludeNestedStacks` specifies `True` during the creation of the
|
1538
|
+
# nested change set, then `DeleteChangeSet` will delete all change sets
|
1539
|
+
# that belong to the stacks hierarchy and will also delete all change
|
1540
|
+
# sets for nested stacks with the status of `REVIEW_IN_PROGRESS`.
|
1541
|
+
#
|
1479
1542
|
# @option params [required, String] :change_set_name
|
1480
1543
|
# The name or Amazon Resource Name (ARN) of the change set that you want
|
1481
1544
|
# to delete.
|
@@ -1578,13 +1641,13 @@ module Aws::CloudFormation
|
|
1578
1641
|
# instances for.
|
1579
1642
|
#
|
1580
1643
|
# @option params [Array<String>] :accounts
|
1581
|
-
# \[
|
1644
|
+
# \[Self-managed permissions\] The names of the AWS accounts that you
|
1582
1645
|
# want to delete stack instances for.
|
1583
1646
|
#
|
1584
1647
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1585
1648
|
#
|
1586
1649
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1587
|
-
# \[
|
1650
|
+
# \[Service-managed permissions\] The AWS Organizations accounts from
|
1588
1651
|
# which to delete stack instances.
|
1589
1652
|
#
|
1590
1653
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
@@ -1625,6 +1688,27 @@ module Aws::CloudFormation
|
|
1625
1688
|
# **A suitable default value is auto-generated.** You should normally
|
1626
1689
|
# not need to pass this option.**
|
1627
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
|
+
#
|
1628
1712
|
# @return [Types::DeleteStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1629
1713
|
#
|
1630
1714
|
# * {Types::DeleteStackInstancesOutput#operation_id #operation_id} => String
|
@@ -1648,6 +1732,7 @@ module Aws::CloudFormation
|
|
1648
1732
|
# },
|
1649
1733
|
# retain_stacks: false, # required
|
1650
1734
|
# operation_id: "ClientRequestToken",
|
1735
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1651
1736
|
# })
|
1652
1737
|
#
|
1653
1738
|
# @example Response structure
|
@@ -1671,12 +1756,34 @@ module Aws::CloudFormation
|
|
1671
1756
|
# The name or unique ID of the stack set that you're deleting. You can
|
1672
1757
|
# obtain this value by running ListStackSets.
|
1673
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
|
+
#
|
1674
1780
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1675
1781
|
#
|
1676
1782
|
# @example Request syntax with placeholder values
|
1677
1783
|
#
|
1678
1784
|
# resp = client.delete_stack_set({
|
1679
1785
|
# stack_set_name: "StackSetName", # required
|
1786
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
1680
1787
|
# })
|
1681
1788
|
#
|
1682
1789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet AWS API Documentation
|
@@ -1688,40 +1795,48 @@ module Aws::CloudFormation
|
|
1688
1795
|
req.send_request(options)
|
1689
1796
|
end
|
1690
1797
|
|
1691
|
-
#
|
1692
|
-
# registry
|
1693
|
-
# 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.
|
1694
1802
|
#
|
1695
|
-
# To deregister
|
1696
|
-
# versions of that
|
1697
|
-
# deregistering that version results in the
|
1698
|
-
# 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.
|
1699
1808
|
#
|
1700
|
-
# You cannot deregister the default version of
|
1701
|
-
#
|
1702
|
-
#
|
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
|
1703
1820
|
#
|
1704
1821
|
# @option params [String] :arn
|
1705
|
-
# The Amazon Resource Name (ARN) of the
|
1822
|
+
# The Amazon Resource Name (ARN) of the extension.
|
1706
1823
|
#
|
1707
1824
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
1708
1825
|
#
|
1709
1826
|
# @option params [String] :type
|
1710
|
-
# The kind of
|
1711
|
-
#
|
1712
|
-
# Currently the only valid value is `RESOURCE`.
|
1827
|
+
# The kind of extension.
|
1713
1828
|
#
|
1714
1829
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
1715
1830
|
#
|
1716
1831
|
# @option params [String] :type_name
|
1717
|
-
# The name of the
|
1832
|
+
# The name of the extension.
|
1718
1833
|
#
|
1719
1834
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
1720
1835
|
#
|
1721
1836
|
# @option params [String] :version_id
|
1722
|
-
# The ID of a specific version of the
|
1723
|
-
# at the end of the Amazon Resource Name (ARN) assigned to the
|
1724
|
-
# 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.
|
1725
1840
|
#
|
1726
1841
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1727
1842
|
#
|
@@ -1729,7 +1844,7 @@ module Aws::CloudFormation
|
|
1729
1844
|
#
|
1730
1845
|
# resp = client.deregister_type({
|
1731
1846
|
# arn: "PrivateTypeArn",
|
1732
|
-
# type: "RESOURCE", # accepts RESOURCE
|
1847
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1733
1848
|
# type_name: "TypeName",
|
1734
1849
|
# version_id: "TypeVersionId",
|
1735
1850
|
# })
|
@@ -1824,6 +1939,9 @@ module Aws::CloudFormation
|
|
1824
1939
|
# * {Types::DescribeChangeSetOutput#tags #tags} => Array<Types::Tag>
|
1825
1940
|
# * {Types::DescribeChangeSetOutput#changes #changes} => Array<Types::Change>
|
1826
1941
|
# * {Types::DescribeChangeSetOutput#next_token #next_token} => String
|
1942
|
+
# * {Types::DescribeChangeSetOutput#include_nested_stacks #include_nested_stacks} => Boolean
|
1943
|
+
# * {Types::DescribeChangeSetOutput#parent_change_set_id #parent_change_set_id} => String
|
1944
|
+
# * {Types::DescribeChangeSetOutput#root_change_set_id #root_change_set_id} => String
|
1827
1945
|
#
|
1828
1946
|
# @example Request syntax with placeholder values
|
1829
1947
|
#
|
@@ -1847,7 +1965,7 @@ module Aws::CloudFormation
|
|
1847
1965
|
# resp.parameters[0].resolved_value #=> String
|
1848
1966
|
# resp.creation_time #=> Time
|
1849
1967
|
# resp.execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
|
1850
|
-
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED"
|
1968
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
|
1851
1969
|
# resp.status_reason #=> String
|
1852
1970
|
# resp.notification_arns #=> Array
|
1853
1971
|
# resp.notification_arns[0] #=> String
|
@@ -1862,7 +1980,7 @@ module Aws::CloudFormation
|
|
1862
1980
|
# resp.tags[0].value #=> String
|
1863
1981
|
# resp.changes #=> Array
|
1864
1982
|
# resp.changes[0].type #=> String, one of "Resource"
|
1865
|
-
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import"
|
1983
|
+
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
1866
1984
|
# resp.changes[0].resource_change.logical_resource_id #=> String
|
1867
1985
|
# resp.changes[0].resource_change.physical_resource_id #=> String
|
1868
1986
|
# resp.changes[0].resource_change.resource_type #=> String
|
@@ -1876,7 +1994,13 @@ module Aws::CloudFormation
|
|
1876
1994
|
# resp.changes[0].resource_change.details[0].evaluation #=> String, one of "Static", "Dynamic"
|
1877
1995
|
# resp.changes[0].resource_change.details[0].change_source #=> String, one of "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic"
|
1878
1996
|
# resp.changes[0].resource_change.details[0].causing_entity #=> String
|
1997
|
+
# resp.changes[0].resource_change.change_set_id #=> String
|
1998
|
+
# resp.changes[0].resource_change.module_info.type_hierarchy #=> String
|
1999
|
+
# resp.changes[0].resource_change.module_info.logical_id_hierarchy #=> String
|
1879
2000
|
# resp.next_token #=> String
|
2001
|
+
# resp.include_nested_stacks #=> Boolean
|
2002
|
+
# resp.parent_change_set_id #=> String
|
2003
|
+
# resp.root_change_set_id #=> String
|
1880
2004
|
#
|
1881
2005
|
#
|
1882
2006
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -2038,6 +2162,27 @@ module Aws::CloudFormation
|
|
2038
2162
|
# @option params [required, String] :stack_instance_region
|
2039
2163
|
# The name of a Region that's associated with this stack instance.
|
2040
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
|
+
#
|
2041
2186
|
# @return [Types::DescribeStackInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2042
2187
|
#
|
2043
2188
|
# * {Types::DescribeStackInstanceOutput#stack_instance #stack_instance} => Types::StackInstance
|
@@ -2048,6 +2193,7 @@ module Aws::CloudFormation
|
|
2048
2193
|
# stack_set_name: "StackSetName", # required
|
2049
2194
|
# stack_instance_account: "Account", # required
|
2050
2195
|
# stack_instance_region: "Region", # required
|
2196
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2051
2197
|
# })
|
2052
2198
|
#
|
2053
2199
|
# @example Response structure
|
@@ -2124,6 +2270,8 @@ module Aws::CloudFormation
|
|
2124
2270
|
# resp.stack_resource_detail.metadata #=> String
|
2125
2271
|
# resp.stack_resource_detail.drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
|
2126
2272
|
# resp.stack_resource_detail.drift_information.last_check_timestamp #=> Time
|
2273
|
+
# resp.stack_resource_detail.module_info.type_hierarchy #=> String
|
2274
|
+
# resp.stack_resource_detail.module_info.logical_id_hierarchy #=> String
|
2127
2275
|
#
|
2128
2276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResource AWS API Documentation
|
2129
2277
|
#
|
@@ -2218,6 +2366,8 @@ module Aws::CloudFormation
|
|
2218
2366
|
# resp.stack_resource_drifts[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
|
2219
2367
|
# resp.stack_resource_drifts[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
|
2220
2368
|
# resp.stack_resource_drifts[0].timestamp #=> Time
|
2369
|
+
# resp.stack_resource_drifts[0].module_info.type_hierarchy #=> String
|
2370
|
+
# resp.stack_resource_drifts[0].module_info.logical_id_hierarchy #=> String
|
2221
2371
|
# resp.next_token #=> String
|
2222
2372
|
#
|
2223
2373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResourceDrifts AWS API Documentation
|
@@ -2317,6 +2467,8 @@ module Aws::CloudFormation
|
|
2317
2467
|
# resp.stack_resources[0].description #=> String
|
2318
2468
|
# resp.stack_resources[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
|
2319
2469
|
# resp.stack_resources[0].drift_information.last_check_timestamp #=> Time
|
2470
|
+
# resp.stack_resources[0].module_info.type_hierarchy #=> String
|
2471
|
+
# resp.stack_resources[0].module_info.logical_id_hierarchy #=> String
|
2320
2472
|
#
|
2321
2473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResources AWS API Documentation
|
2322
2474
|
#
|
@@ -2332,6 +2484,27 @@ module Aws::CloudFormation
|
|
2332
2484
|
# @option params [required, String] :stack_set_name
|
2333
2485
|
# The name or unique ID of the stack set whose description you want.
|
2334
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
|
+
#
|
2335
2508
|
# @return [Types::DescribeStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2336
2509
|
#
|
2337
2510
|
# * {Types::DescribeStackSetOutput#stack_set #stack_set} => Types::StackSet
|
@@ -2340,6 +2513,7 @@ module Aws::CloudFormation
|
|
2340
2513
|
#
|
2341
2514
|
# resp = client.describe_stack_set({
|
2342
2515
|
# stack_set_name: "StackSetName", # required
|
2516
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2343
2517
|
# })
|
2344
2518
|
#
|
2345
2519
|
# @example Response structure
|
@@ -2394,6 +2568,27 @@ module Aws::CloudFormation
|
|
2394
2568
|
# @option params [required, String] :operation_id
|
2395
2569
|
# The unique ID of the stack set operation.
|
2396
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
|
+
#
|
2397
2592
|
# @return [Types::DescribeStackSetOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2398
2593
|
#
|
2399
2594
|
# * {Types::DescribeStackSetOperationOutput#stack_set_operation #stack_set_operation} => Types::StackSetOperation
|
@@ -2403,6 +2598,7 @@ module Aws::CloudFormation
|
|
2403
2598
|
# resp = client.describe_stack_set_operation({
|
2404
2599
|
# stack_set_name: "StackSetName", # required
|
2405
2600
|
# operation_id: "ClientRequestToken", # required
|
2601
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2406
2602
|
# })
|
2407
2603
|
#
|
2408
2604
|
# @example Response structure
|
@@ -2543,37 +2739,36 @@ module Aws::CloudFormation
|
|
2543
2739
|
req.send_request(options)
|
2544
2740
|
end
|
2545
2741
|
|
2546
|
-
# Returns detailed information about
|
2742
|
+
# Returns detailed information about an extension that has been
|
2743
|
+
# registered.
|
2547
2744
|
#
|
2548
2745
|
# If you specify a `VersionId`, `DescribeType` returns information about
|
2549
|
-
# that specific
|
2550
|
-
# the default
|
2746
|
+
# that specific extension version. Otherwise, it returns information
|
2747
|
+
# about the default extension version.
|
2551
2748
|
#
|
2552
2749
|
# @option params [String] :type
|
2553
|
-
# The kind of
|
2554
|
-
#
|
2555
|
-
# Currently the only valid value is `RESOURCE`.
|
2750
|
+
# The kind of extension.
|
2556
2751
|
#
|
2557
2752
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
2558
2753
|
#
|
2559
2754
|
# @option params [String] :type_name
|
2560
|
-
# The name of the
|
2755
|
+
# The name of the extension.
|
2561
2756
|
#
|
2562
2757
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
2563
2758
|
#
|
2564
2759
|
# @option params [String] :arn
|
2565
|
-
# The Amazon Resource Name (ARN) of the
|
2760
|
+
# The Amazon Resource Name (ARN) of the extension.
|
2566
2761
|
#
|
2567
2762
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
2568
2763
|
#
|
2569
2764
|
# @option params [String] :version_id
|
2570
|
-
# The ID of a specific version of the
|
2571
|
-
# at the end of the Amazon Resource Name (ARN) assigned to the
|
2572
|
-
# 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.
|
2573
2768
|
#
|
2574
2769
|
# If you specify a `VersionId`, `DescribeType` returns information about
|
2575
|
-
# that specific
|
2576
|
-
# the default
|
2770
|
+
# that specific extension version. Otherwise, it returns information
|
2771
|
+
# about the default extension version.
|
2577
2772
|
#
|
2578
2773
|
# @return [Types::DescribeTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2579
2774
|
#
|
@@ -2597,7 +2792,7 @@ module Aws::CloudFormation
|
|
2597
2792
|
# @example Request syntax with placeholder values
|
2598
2793
|
#
|
2599
2794
|
# resp = client.describe_type({
|
2600
|
-
# type: "RESOURCE", # accepts RESOURCE
|
2795
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
2601
2796
|
# type_name: "TypeName",
|
2602
2797
|
# arn: "TypeArn",
|
2603
2798
|
# version_id: "TypeVersionId",
|
@@ -2606,7 +2801,7 @@ module Aws::CloudFormation
|
|
2606
2801
|
# @example Response structure
|
2607
2802
|
#
|
2608
2803
|
# resp.arn #=> String
|
2609
|
-
# resp.type #=> String, one of "RESOURCE"
|
2804
|
+
# resp.type #=> String, one of "RESOURCE", "MODULE"
|
2610
2805
|
# resp.type_name #=> String
|
2611
2806
|
# resp.default_version_id #=> String
|
2612
2807
|
# resp.is_default_version #=> Boolean
|
@@ -2632,7 +2827,7 @@ module Aws::CloudFormation
|
|
2632
2827
|
req.send_request(options)
|
2633
2828
|
end
|
2634
2829
|
|
2635
|
-
# Returns information about
|
2830
|
+
# Returns information about an extension's registration, including its
|
2636
2831
|
# current status and type and version identifiers.
|
2637
2832
|
#
|
2638
2833
|
# When you initiate a registration request using ` RegisterType `, you
|
@@ -2640,7 +2835,7 @@ module Aws::CloudFormation
|
|
2640
2835
|
# that registration request.
|
2641
2836
|
#
|
2642
2837
|
# Once the registration request has completed, use ` DescribeType ` to
|
2643
|
-
# return detailed
|
2838
|
+
# return detailed information about an extension.
|
2644
2839
|
#
|
2645
2840
|
# @option params [required, String] :registration_token
|
2646
2841
|
# The identifier for this registration request.
|
@@ -2806,6 +3001,8 @@ module Aws::CloudFormation
|
|
2806
3001
|
# resp.stack_resource_drift.property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
|
2807
3002
|
# resp.stack_resource_drift.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
|
2808
3003
|
# resp.stack_resource_drift.timestamp #=> Time
|
3004
|
+
# resp.stack_resource_drift.module_info.type_hierarchy #=> String
|
3005
|
+
# resp.stack_resource_drift.module_info.logical_id_hierarchy #=> String
|
2809
3006
|
#
|
2810
3007
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackResourceDrift AWS API Documentation
|
2811
3008
|
#
|
@@ -2832,7 +3029,7 @@ module Aws::CloudFormation
|
|
2832
3029
|
# Once the operation has completed, use the following actions to return
|
2833
3030
|
# drift information:
|
2834
3031
|
#
|
2835
|
-
# * Use ` DescribeStackSet ` to return detailed
|
3032
|
+
# * Use ` DescribeStackSet ` to return detailed information about the
|
2836
3033
|
# stack set, including detailed information about the last *completed*
|
2837
3034
|
# drift operation performed on the stack set. (Information about drift
|
2838
3035
|
# operations that are in progress is not included.)
|
@@ -2879,6 +3076,27 @@ module Aws::CloudFormation
|
|
2879
3076
|
# **A suitable default value is auto-generated.** You should normally
|
2880
3077
|
# not need to pass this option.**
|
2881
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
|
+
#
|
2882
3100
|
# @return [Types::DetectStackSetDriftOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2883
3101
|
#
|
2884
3102
|
# * {Types::DetectStackSetDriftOutput#operation_id #operation_id} => String
|
@@ -2895,6 +3113,7 @@ module Aws::CloudFormation
|
|
2895
3113
|
# max_concurrent_percentage: 1,
|
2896
3114
|
# },
|
2897
3115
|
# operation_id: "ClientRequestToken",
|
3116
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
2898
3117
|
# })
|
2899
3118
|
#
|
2900
3119
|
# @example Response structure
|
@@ -2928,8 +3147,9 @@ module Aws::CloudFormation
|
|
2928
3147
|
#
|
2929
3148
|
# @option params [String] :template_url
|
2930
3149
|
# Location of file containing the template body. The URL must point to a
|
2931
|
-
# template that is located in an Amazon S3 bucket
|
2932
|
-
# 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.
|
2933
3153
|
#
|
2934
3154
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
2935
3155
|
# are passed, only `TemplateBody` is used.
|
@@ -2986,6 +3206,9 @@ module Aws::CloudFormation
|
|
2986
3206
|
# enforces the policy during the update. You can't specify a temporary
|
2987
3207
|
# stack policy that overrides the current policy.
|
2988
3208
|
#
|
3209
|
+
# To create a change set for the entire stack hierachy,
|
3210
|
+
# `IncludeNestedStacks` must have been set to `True`.
|
3211
|
+
#
|
2989
3212
|
# @option params [required, String] :change_set_name
|
2990
3213
|
# The name or ARN of the change set that you want use to update the
|
2991
3214
|
# specified stack.
|
@@ -3143,8 +3366,9 @@ module Aws::CloudFormation
|
|
3143
3366
|
# @option params [String] :template_url
|
3144
3367
|
# Location of file containing the template body. The URL must point to a
|
3145
3368
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
3146
|
-
# bucket. For more information about
|
3147
|
-
# 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.
|
3148
3372
|
#
|
3149
3373
|
# Conditional: You must specify only one of the following parameters:
|
3150
3374
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3260,10 +3484,13 @@ module Aws::CloudFormation
|
|
3260
3484
|
# resp.summaries[0].change_set_id #=> String
|
3261
3485
|
# resp.summaries[0].change_set_name #=> String
|
3262
3486
|
# resp.summaries[0].execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
|
3263
|
-
# resp.summaries[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED"
|
3487
|
+
# resp.summaries[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
|
3264
3488
|
# resp.summaries[0].status_reason #=> String
|
3265
3489
|
# resp.summaries[0].creation_time #=> Time
|
3266
3490
|
# resp.summaries[0].description #=> String
|
3491
|
+
# resp.summaries[0].include_nested_stacks #=> Boolean
|
3492
|
+
# resp.summaries[0].parent_change_set_id #=> String
|
3493
|
+
# resp.summaries[0].root_change_set_id #=> String
|
3267
3494
|
# resp.next_token #=> String
|
3268
3495
|
#
|
3269
3496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSets AWS API Documentation
|
@@ -3404,6 +3631,27 @@ module Aws::CloudFormation
|
|
3404
3631
|
# @option params [String] :stack_instance_region
|
3405
3632
|
# The name of the Region where you want to list stack instances.
|
3406
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
|
+
#
|
3407
3655
|
# @return [Types::ListStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3408
3656
|
#
|
3409
3657
|
# * {Types::ListStackInstancesOutput#summaries #summaries} => Array<Types::StackInstanceSummary>
|
@@ -3425,6 +3673,7 @@ module Aws::CloudFormation
|
|
3425
3673
|
# ],
|
3426
3674
|
# stack_instance_account: "Account",
|
3427
3675
|
# stack_instance_region: "Region",
|
3676
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3428
3677
|
# })
|
3429
3678
|
#
|
3430
3679
|
# @example Response structure
|
@@ -3496,6 +3745,8 @@ module Aws::CloudFormation
|
|
3496
3745
|
# resp.stack_resource_summaries[0].resource_status_reason #=> String
|
3497
3746
|
# resp.stack_resource_summaries[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
|
3498
3747
|
# resp.stack_resource_summaries[0].drift_information.last_check_timestamp #=> Time
|
3748
|
+
# resp.stack_resource_summaries[0].module_info.type_hierarchy #=> String
|
3749
|
+
# resp.stack_resource_summaries[0].module_info.logical_id_hierarchy #=> String
|
3499
3750
|
# resp.next_token #=> String
|
3500
3751
|
#
|
3501
3752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackResources AWS API Documentation
|
@@ -3532,6 +3783,27 @@ module Aws::CloudFormation
|
|
3532
3783
|
# includes a `NextToken` value that you can assign to the `NextToken`
|
3533
3784
|
# request parameter to get the next set of results.
|
3534
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
|
+
#
|
3535
3807
|
# @return [Types::ListStackSetOperationResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3536
3808
|
#
|
3537
3809
|
# * {Types::ListStackSetOperationResultsOutput#summaries #summaries} => Array<Types::StackSetOperationResultSummary>
|
@@ -3546,6 +3818,7 @@ module Aws::CloudFormation
|
|
3546
3818
|
# operation_id: "ClientRequestToken", # required
|
3547
3819
|
# next_token: "NextToken",
|
3548
3820
|
# max_results: 1,
|
3821
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3549
3822
|
# })
|
3550
3823
|
#
|
3551
3824
|
# @example Response structure
|
@@ -3590,6 +3863,27 @@ module Aws::CloudFormation
|
|
3590
3863
|
# includes a `NextToken` value that you can assign to the `NextToken`
|
3591
3864
|
# request parameter to get the next set of results.
|
3592
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
|
+
#
|
3593
3887
|
# @return [Types::ListStackSetOperationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3594
3888
|
#
|
3595
3889
|
# * {Types::ListStackSetOperationsOutput#summaries #summaries} => Array<Types::StackSetOperationSummary>
|
@@ -3603,6 +3897,7 @@ module Aws::CloudFormation
|
|
3603
3897
|
# stack_set_name: "StackSetName", # required
|
3604
3898
|
# next_token: "NextToken",
|
3605
3899
|
# max_results: 1,
|
3900
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3606
3901
|
# })
|
3607
3902
|
#
|
3608
3903
|
# @example Response structure
|
@@ -3627,6 +3922,19 @@ module Aws::CloudFormation
|
|
3627
3922
|
# Returns summary information about stack sets that are associated with
|
3628
3923
|
# the user.
|
3629
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
|
+
#
|
3630
3938
|
# @option params [String] :next_token
|
3631
3939
|
# If the previous paginated request didn't return all of the remaining
|
3632
3940
|
# results, the response object's `NextToken` parameter value is set to
|
@@ -3645,6 +3953,27 @@ module Aws::CloudFormation
|
|
3645
3953
|
# The status of the stack sets that you want to get summary information
|
3646
3954
|
# about.
|
3647
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
|
+
#
|
3648
3977
|
# @return [Types::ListStackSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3649
3978
|
#
|
3650
3979
|
# * {Types::ListStackSetsOutput#summaries #summaries} => Array<Types::StackSetSummary>
|
@@ -3658,6 +3987,7 @@ module Aws::CloudFormation
|
|
3658
3987
|
# next_token: "NextToken",
|
3659
3988
|
# max_results: 1,
|
3660
3989
|
# status: "ACTIVE", # accepts ACTIVE, DELETED
|
3990
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3661
3991
|
# })
|
3662
3992
|
#
|
3663
3993
|
# @example Response structure
|
@@ -3740,27 +4070,25 @@ module Aws::CloudFormation
|
|
3740
4070
|
req.send_request(options)
|
3741
4071
|
end
|
3742
4072
|
|
3743
|
-
# Returns a list of registration tokens for the specified
|
4073
|
+
# Returns a list of registration tokens for the specified extension(s).
|
3744
4074
|
#
|
3745
4075
|
# @option params [String] :type
|
3746
|
-
# The kind of
|
3747
|
-
#
|
3748
|
-
# Currently the only valid value is `RESOURCE`.
|
4076
|
+
# The kind of extension.
|
3749
4077
|
#
|
3750
4078
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3751
4079
|
#
|
3752
4080
|
# @option params [String] :type_name
|
3753
|
-
# The name of the
|
4081
|
+
# The name of the extension.
|
3754
4082
|
#
|
3755
4083
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3756
4084
|
#
|
3757
4085
|
# @option params [String] :type_arn
|
3758
|
-
# The Amazon Resource Name (ARN) of the
|
4086
|
+
# The Amazon Resource Name (ARN) of the extension.
|
3759
4087
|
#
|
3760
4088
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3761
4089
|
#
|
3762
4090
|
# @option params [String] :registration_status_filter
|
3763
|
-
# The current status of the
|
4091
|
+
# The current status of the extension registration request.
|
3764
4092
|
#
|
3765
4093
|
# The default is `IN_PROGRESS`.
|
3766
4094
|
#
|
@@ -3788,7 +4116,7 @@ module Aws::CloudFormation
|
|
3788
4116
|
# @example Request syntax with placeholder values
|
3789
4117
|
#
|
3790
4118
|
# resp = client.list_type_registrations({
|
3791
|
-
# type: "RESOURCE", # accepts RESOURCE
|
4119
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3792
4120
|
# type_name: "TypeName",
|
3793
4121
|
# type_arn: "TypeArn",
|
3794
4122
|
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
|
@@ -3811,23 +4139,22 @@ module Aws::CloudFormation
|
|
3811
4139
|
req.send_request(options)
|
3812
4140
|
end
|
3813
4141
|
|
3814
|
-
# Returns summary information about the versions of
|
4142
|
+
# Returns summary information about the versions of an extension.
|
3815
4143
|
#
|
3816
4144
|
# @option params [String] :type
|
3817
|
-
# The kind of the
|
3818
|
-
#
|
3819
|
-
# Currently the only valid value is `RESOURCE`.
|
4145
|
+
# The kind of the extension.
|
3820
4146
|
#
|
3821
4147
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3822
4148
|
#
|
3823
4149
|
# @option params [String] :type_name
|
3824
|
-
# The name of the
|
4150
|
+
# The name of the extension for which you want version summary
|
4151
|
+
# information.
|
3825
4152
|
#
|
3826
4153
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3827
4154
|
#
|
3828
4155
|
# @option params [String] :arn
|
3829
|
-
# The Amazon Resource Name (ARN) of the
|
3830
|
-
# summary information.
|
4156
|
+
# The Amazon Resource Name (ARN) of the extension for which you want
|
4157
|
+
# version summary information.
|
3831
4158
|
#
|
3832
4159
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
3833
4160
|
#
|
@@ -3846,17 +4173,17 @@ module Aws::CloudFormation
|
|
3846
4173
|
# `NextToken` parameter is set to `null`.
|
3847
4174
|
#
|
3848
4175
|
# @option params [String] :deprecated_status
|
3849
|
-
# The deprecation status of the
|
4176
|
+
# The deprecation status of the extension versions that you want to get
|
3850
4177
|
# summary information about.
|
3851
4178
|
#
|
3852
4179
|
# Valid values include:
|
3853
4180
|
#
|
3854
|
-
# * `LIVE`\: The
|
4181
|
+
# * `LIVE`\: The extension version is registered and can be used in
|
3855
4182
|
# CloudFormation operations, dependent on its provisioning behavior
|
3856
4183
|
# and visibility scope.
|
3857
4184
|
#
|
3858
|
-
# * `DEPRECATED`\: The
|
3859
|
-
# longer be used in CloudFormation operations.
|
4185
|
+
# * `DEPRECATED`\: The extension version has been deregistered and can
|
4186
|
+
# no longer be used in CloudFormation operations.
|
3860
4187
|
#
|
3861
4188
|
# The default is `LIVE`.
|
3862
4189
|
#
|
@@ -3870,7 +4197,7 @@ module Aws::CloudFormation
|
|
3870
4197
|
# @example Request syntax with placeholder values
|
3871
4198
|
#
|
3872
4199
|
# resp = client.list_type_versions({
|
3873
|
-
# type: "RESOURCE", # accepts RESOURCE
|
4200
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3874
4201
|
# type_name: "TypeName",
|
3875
4202
|
# arn: "PrivateTypeArn",
|
3876
4203
|
# max_results: 1,
|
@@ -3881,7 +4208,7 @@ module Aws::CloudFormation
|
|
3881
4208
|
# @example Response structure
|
3882
4209
|
#
|
3883
4210
|
# resp.type_version_summaries #=> Array
|
3884
|
-
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE"
|
4211
|
+
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
3885
4212
|
# resp.type_version_summaries[0].type_name #=> String
|
3886
4213
|
# resp.type_version_summaries[0].version_id #=> String
|
3887
4214
|
# resp.type_version_summaries[0].is_default_version #=> Boolean
|
@@ -3899,20 +4226,20 @@ module Aws::CloudFormation
|
|
3899
4226
|
req.send_request(options)
|
3900
4227
|
end
|
3901
4228
|
|
3902
|
-
# Returns summary information about
|
3903
|
-
# CloudFormation.
|
4229
|
+
# Returns summary information about extension that have been registered
|
4230
|
+
# with CloudFormation.
|
3904
4231
|
#
|
3905
4232
|
# @option params [String] :visibility
|
3906
|
-
# The scope at which the
|
3907
|
-
# operations.
|
4233
|
+
# The scope at which the extension is visible and usable in
|
4234
|
+
# CloudFormation operations.
|
3908
4235
|
#
|
3909
4236
|
# Valid values include:
|
3910
4237
|
#
|
3911
|
-
# * `PRIVATE`\: The
|
3912
|
-
# in which it is registered. Currently, AWS CloudFormation
|
3913
|
-
#
|
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`.
|
3914
4241
|
#
|
3915
|
-
# * `PUBLIC`\: The
|
4242
|
+
# * `PUBLIC`\: The extension is publically visible and usable within any
|
3916
4243
|
# Amazon account.
|
3917
4244
|
#
|
3918
4245
|
# The default is `PRIVATE`.
|
@@ -3924,27 +4251,30 @@ module Aws::CloudFormation
|
|
3924
4251
|
#
|
3925
4252
|
# Valid values include:
|
3926
4253
|
#
|
3927
|
-
# * `FULLY_MUTABLE`\: The
|
3928
|
-
# updates to the
|
4254
|
+
# * `FULLY_MUTABLE`\: The extension includes an update handler to
|
4255
|
+
# process updates to the extension during stack update operations.
|
3929
4256
|
#
|
3930
|
-
# * `IMMUTABLE`\: The
|
3931
|
-
#
|
3932
|
-
# 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.
|
3933
4260
|
#
|
3934
|
-
# * `NON_PROVISIONABLE`\: The
|
3935
|
-
# 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.
|
3936
4263
|
#
|
3937
4264
|
# @option params [String] :deprecated_status
|
3938
|
-
# The deprecation status of the
|
4265
|
+
# The deprecation status of the extension that you want to get summary
|
3939
4266
|
# information about.
|
3940
4267
|
#
|
3941
4268
|
# Valid values include:
|
3942
4269
|
#
|
3943
|
-
# * `LIVE`\: The
|
4270
|
+
# * `LIVE`\: The extension is registered for use in CloudFormation
|
3944
4271
|
# operations.
|
3945
4272
|
#
|
3946
|
-
# * `DEPRECATED`\: The
|
3947
|
-
# used in CloudFormation operations.
|
4273
|
+
# * `DEPRECATED`\: The extension has been deregistered and can no longer
|
4274
|
+
# be used in CloudFormation operations.
|
4275
|
+
#
|
4276
|
+
# @option params [String] :type
|
4277
|
+
# The type of extension.
|
3948
4278
|
#
|
3949
4279
|
# @option params [Integer] :max_results
|
3950
4280
|
# The maximum number of results to be returned with a single call. If
|
@@ -3973,6 +4303,7 @@ module Aws::CloudFormation
|
|
3973
4303
|
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
3974
4304
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
3975
4305
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4306
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3976
4307
|
# max_results: 1,
|
3977
4308
|
# next_token: "NextToken",
|
3978
4309
|
# })
|
@@ -3980,7 +4311,7 @@ module Aws::CloudFormation
|
|
3980
4311
|
# @example Response structure
|
3981
4312
|
#
|
3982
4313
|
# resp.type_summaries #=> Array
|
3983
|
-
# resp.type_summaries[0].type #=> String, one of "RESOURCE"
|
4314
|
+
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
3984
4315
|
# resp.type_summaries[0].type_name #=> String
|
3985
4316
|
# resp.type_summaries[0].default_version_id #=> String
|
3986
4317
|
# resp.type_summaries[0].type_arn #=> String
|
@@ -4078,24 +4409,25 @@ module Aws::CloudFormation
|
|
4078
4409
|
req.send_request(options)
|
4079
4410
|
end
|
4080
4411
|
|
4081
|
-
# Registers
|
4082
|
-
# makes it available for use in CloudFormation templates in
|
4083
|
-
# 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:
|
4084
4415
|
#
|
4085
|
-
# * Validating the
|
4416
|
+
# * Validating the extension schema
|
4086
4417
|
#
|
4087
|
-
# * Determining which handlers have been specified for the
|
4418
|
+
# * Determining which handlers, if any, have been specified for the
|
4419
|
+
# extension
|
4088
4420
|
#
|
4089
|
-
# * Making the
|
4421
|
+
# * Making the extension available for use in your account
|
4090
4422
|
#
|
4091
|
-
# For more information on how to develop
|
4423
|
+
# For more information on how to develop extensions and ready them for
|
4092
4424
|
# registeration, see [Creating Resource Providers][1] in the
|
4093
4425
|
# *CloudFormation CLI User Guide*.
|
4094
4426
|
#
|
4095
|
-
# You can have a maximum of 50 resource
|
4096
|
-
# 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
|
4097
4429
|
# [DeregisterType](AWSCloudFormation/latest/APIReference/API_DeregisterType.html)
|
4098
|
-
# to deregister specific
|
4430
|
+
# to deregister specific extension versions if necessary.
|
4099
4431
|
#
|
4100
4432
|
# Once you have initiated a registration request using ` RegisterType `,
|
4101
4433
|
# you can use ` DescribeTypeRegistration ` to monitor the progress of
|
@@ -4106,18 +4438,16 @@ module Aws::CloudFormation
|
|
4106
4438
|
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
|
4107
4439
|
#
|
4108
4440
|
# @option params [String] :type
|
4109
|
-
# The kind of
|
4110
|
-
#
|
4111
|
-
# Currently, the only valid value is `RESOURCE`.
|
4441
|
+
# The kind of extension.
|
4112
4442
|
#
|
4113
4443
|
# @option params [required, String] :type_name
|
4114
|
-
# The name of the
|
4444
|
+
# The name of the extension being registered.
|
4115
4445
|
#
|
4116
|
-
# We recommend that
|
4446
|
+
# We recommend that extension names adhere to the following pattern:
|
4117
4447
|
# *company\_or\_organization*\::*service*\::*type*.
|
4118
4448
|
#
|
4119
4449
|
# <note markdown="1"> The following organization namespaces are reserved and cannot be used
|
4120
|
-
# in your
|
4450
|
+
# in your extension names:
|
4121
4451
|
#
|
4122
4452
|
# * `Alexa`
|
4123
4453
|
#
|
@@ -4134,48 +4464,47 @@ module Aws::CloudFormation
|
|
4134
4464
|
# </note>
|
4135
4465
|
#
|
4136
4466
|
# @option params [required, String] :schema_handler_package
|
4137
|
-
# A url to the S3 bucket containing the
|
4138
|
-
# contains the
|
4139
|
-
#
|
4140
|
-
#
|
4141
|
-
#
|
4142
|
-
#
|
4143
|
-
#
|
4144
|
-
#
|
4145
|
-
#
|
4146
|
-
#
|
4147
|
-
#
|
4148
|
-
#
|
4149
|
-
# CloudFormation User Guide*.
|
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.
|
4469
|
+
#
|
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*.
|
4473
|
+
#
|
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*.
|
4150
4479
|
#
|
4151
4480
|
# </note>
|
4152
4481
|
#
|
4153
4482
|
#
|
4154
4483
|
#
|
4155
4484
|
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html
|
4156
|
-
# [2]: https://docs.aws.amazon.com/
|
4485
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
4486
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html
|
4157
4487
|
#
|
4158
4488
|
# @option params [Types::LoggingConfig] :logging_config
|
4159
|
-
# Specifies logging configuration information for
|
4489
|
+
# Specifies logging configuration information for an extension.
|
4160
4490
|
#
|
4161
4491
|
# @option params [String] :execution_role_arn
|
4162
4492
|
# The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
|
4163
|
-
# assume when invoking the
|
4164
|
-
#
|
4493
|
+
# assume when invoking the extension. If your extension calls AWS APIs
|
4494
|
+
# in any of its handlers, you must create an <i> <a
|
4165
4495
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
4166
4496
|
# execution role</a> </i> that includes the necessary permissions to
|
4167
4497
|
# call those AWS APIs, and provision that execution role in your
|
4168
|
-
# account. When CloudFormation needs to invoke the
|
4169
|
-
#
|
4170
|
-
#
|
4171
|
-
#
|
4172
|
-
# 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.
|
4173
4502
|
#
|
4174
4503
|
# @option params [String] :client_request_token
|
4175
4504
|
# A unique identifier that acts as an idempotency key for this
|
4176
4505
|
# registration request. Specifying a client request token prevents
|
4177
|
-
# CloudFormation from generating more than one version of
|
4178
|
-
# 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
|
4179
4508
|
# multiple times.
|
4180
4509
|
#
|
4181
4510
|
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4185,7 +4514,7 @@ module Aws::CloudFormation
|
|
4185
4514
|
# @example Request syntax with placeholder values
|
4186
4515
|
#
|
4187
4516
|
# resp = client.register_type({
|
4188
|
-
# type: "RESOURCE", # accepts RESOURCE
|
4517
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4189
4518
|
# type_name: "TypeName", # required
|
4190
4519
|
# schema_handler_package: "S3Url", # required
|
4191
4520
|
# logging_config: {
|
@@ -4249,29 +4578,29 @@ module Aws::CloudFormation
|
|
4249
4578
|
req.send_request(options)
|
4250
4579
|
end
|
4251
4580
|
|
4252
|
-
# Specify the default version of
|
4253
|
-
# 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.
|
4254
4583
|
#
|
4255
4584
|
# @option params [String] :arn
|
4256
|
-
# The Amazon Resource Name (ARN) of the
|
4257
|
-
# summary information.
|
4585
|
+
# The Amazon Resource Name (ARN) of the extension for which you want
|
4586
|
+
# version summary information.
|
4258
4587
|
#
|
4259
4588
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
4260
4589
|
#
|
4261
4590
|
# @option params [String] :type
|
4262
|
-
# The kind of
|
4591
|
+
# The kind of extension.
|
4263
4592
|
#
|
4264
4593
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
4265
4594
|
#
|
4266
4595
|
# @option params [String] :type_name
|
4267
|
-
# The name of the
|
4596
|
+
# The name of the extension.
|
4268
4597
|
#
|
4269
4598
|
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
|
4270
4599
|
#
|
4271
4600
|
# @option params [String] :version_id
|
4272
|
-
# The ID of a specific version of the
|
4273
|
-
# at the end of the Amazon Resource Name (ARN) assigned to the
|
4274
|
-
# 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.
|
4275
4604
|
#
|
4276
4605
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4277
4606
|
#
|
@@ -4279,7 +4608,7 @@ module Aws::CloudFormation
|
|
4279
4608
|
#
|
4280
4609
|
# resp = client.set_type_default_version({
|
4281
4610
|
# arn: "PrivateTypeArn",
|
4282
|
-
# type: "RESOURCE", # accepts RESOURCE
|
4611
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4283
4612
|
# type_name: "TypeName",
|
4284
4613
|
# version_id: "TypeVersionId",
|
4285
4614
|
# })
|
@@ -4351,6 +4680,27 @@ module Aws::CloudFormation
|
|
4351
4680
|
# @option params [required, String] :operation_id
|
4352
4681
|
# The ID of the stack operation.
|
4353
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
|
+
#
|
4354
4704
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4355
4705
|
#
|
4356
4706
|
# @example Request syntax with placeholder values
|
@@ -4358,6 +4708,7 @@ module Aws::CloudFormation
|
|
4358
4708
|
# resp = client.stop_stack_set_operation({
|
4359
4709
|
# stack_set_name: "StackSetName", # required
|
4360
4710
|
# operation_id: "ClientRequestToken", # required
|
4711
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
4361
4712
|
# })
|
4362
4713
|
#
|
4363
4714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation AWS API Documentation
|
@@ -4402,8 +4753,9 @@ module Aws::CloudFormation
|
|
4402
4753
|
#
|
4403
4754
|
# @option params [String] :template_url
|
4404
4755
|
# Location of file containing the template body. The URL must point to a
|
4405
|
-
# template that is located in an Amazon S3 bucket
|
4406
|
-
# 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.
|
4407
4759
|
#
|
4408
4760
|
# Conditional: You must specify only one of the following parameters:
|
4409
4761
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -4511,10 +4863,9 @@ module Aws::CloudFormation
|
|
4511
4863
|
# [AWS::Serverless][10] transforms, which are macros hosted by AWS
|
4512
4864
|
# CloudFormation.
|
4513
4865
|
#
|
4514
|
-
#
|
4515
|
-
#
|
4516
|
-
#
|
4517
|
-
# using this capability.
|
4866
|
+
# If you want to update a stack from a stack template that contains
|
4867
|
+
# macros *and* nested stacks, you must update the stack directly from
|
4868
|
+
# the template using this capability.
|
4518
4869
|
#
|
4519
4870
|
# You should only update stacks directly from a stack template that
|
4520
4871
|
# contains macros if you know what processing the macro performs.
|
@@ -4721,15 +5072,15 @@ module Aws::CloudFormation
|
|
4721
5072
|
# instances.
|
4722
5073
|
#
|
4723
5074
|
# @option params [Array<String>] :accounts
|
4724
|
-
# \[
|
4725
|
-
#
|
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
|
4726
5077
|
# overridden parameter values will be applied to all stack instances in
|
4727
5078
|
# the specified accounts and Regions.
|
4728
5079
|
#
|
4729
5080
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
4730
5081
|
#
|
4731
5082
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
4732
|
-
# \[
|
5083
|
+
# \[Service-managed permissions\] The AWS Organizations accounts for
|
4733
5084
|
# which you want to update parameter values for stack instances. If your
|
4734
5085
|
# update targets OUs, the overridden parameter values only apply to the
|
4735
5086
|
# accounts that are currently in the target OUs and their child OUs.
|
@@ -4807,6 +5158,27 @@ module Aws::CloudFormation
|
|
4807
5158
|
# **A suitable default value is auto-generated.** You should normally
|
4808
5159
|
# not need to pass this option.**
|
4809
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
|
+
#
|
4810
5182
|
# @return [Types::UpdateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4811
5183
|
#
|
4812
5184
|
# * {Types::UpdateStackInstancesOutput#operation_id #operation_id} => String
|
@@ -4837,6 +5209,7 @@ module Aws::CloudFormation
|
|
4837
5209
|
# max_concurrent_percentage: 1,
|
4838
5210
|
# },
|
4839
5211
|
# operation_id: "ClientRequestToken",
|
5212
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
4840
5213
|
# })
|
4841
5214
|
#
|
4842
5215
|
# @example Response structure
|
@@ -4882,8 +5255,9 @@ module Aws::CloudFormation
|
|
4882
5255
|
# @option params [String] :template_url
|
4883
5256
|
# The location of the file that contains the template body. The URL must
|
4884
5257
|
# point to a template (maximum size: 460,800 bytes) that is located in
|
4885
|
-
# an Amazon S3 bucket
|
4886
|
-
# 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.
|
4887
5261
|
#
|
4888
5262
|
# Conditional: You must specify only one of the following parameters:
|
4889
5263
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
@@ -5047,7 +5421,7 @@ module Aws::CloudFormation
|
|
5047
5421
|
# permissions to perform operations on the stack set.
|
5048
5422
|
#
|
5049
5423
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
5050
|
-
# \[
|
5424
|
+
# \[Service-managed permissions\] The AWS Organizations accounts in
|
5051
5425
|
# which to update associated stack instances.
|
5052
5426
|
#
|
5053
5427
|
# To update all the stack instances associated with this stack set, do
|
@@ -5082,7 +5456,7 @@ module Aws::CloudFormation
|
|
5082
5456
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
|
5083
5457
|
#
|
5084
5458
|
# @option params [Types::AutoDeployment] :auto_deployment
|
5085
|
-
# \[
|
5459
|
+
# \[Service-managed permissions\] Describes whether StackSets
|
5086
5460
|
# automatically deploys to AWS Organizations accounts that are added to
|
5087
5461
|
# a target organization or organizational unit (OU).
|
5088
5462
|
#
|
@@ -5108,7 +5482,7 @@ module Aws::CloudFormation
|
|
5108
5482
|
# not need to pass this option.**
|
5109
5483
|
#
|
5110
5484
|
# @option params [Array<String>] :accounts
|
5111
|
-
# \[
|
5485
|
+
# \[Self-managed permissions\] The accounts in which to update
|
5112
5486
|
# associated stack instances. If you specify accounts, you must also
|
5113
5487
|
# specify the Regions in which to update stack set instances.
|
5114
5488
|
#
|
@@ -5143,6 +5517,27 @@ module Aws::CloudFormation
|
|
5143
5517
|
# while leaving all other stack instances with their existing stack
|
5144
5518
|
# instance status.
|
5145
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
|
+
#
|
5146
5541
|
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5147
5542
|
#
|
5148
5543
|
# * {Types::UpdateStackSetOutput#operation_id #operation_id} => String
|
@@ -5191,6 +5586,7 @@ module Aws::CloudFormation
|
|
5191
5586
|
# operation_id: "ClientRequestToken",
|
5192
5587
|
# accounts: ["Account"],
|
5193
5588
|
# regions: ["Region"],
|
5589
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
5194
5590
|
# })
|
5195
5591
|
#
|
5196
5592
|
# @example Response structure
|
@@ -5271,8 +5667,8 @@ module Aws::CloudFormation
|
|
5271
5667
|
# @option params [String] :template_url
|
5272
5668
|
# Location of file containing the template body. The URL must point to a
|
5273
5669
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
5274
|
-
# bucket. For more information, go to
|
5275
|
-
# 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.
|
5276
5672
|
#
|
5277
5673
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
5278
5674
|
# are passed, only `TemplateBody` is used.
|
@@ -5332,7 +5728,7 @@ module Aws::CloudFormation
|
|
5332
5728
|
params: params,
|
5333
5729
|
config: config)
|
5334
5730
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
5335
|
-
context[:gem_version] = '1.
|
5731
|
+
context[:gem_version] = '1.49.0'
|
5336
5732
|
Seahorse::Client::Request.new(handlers, context)
|
5337
5733
|
end
|
5338
5734
|
|