aws-sdk-cloudformation 1.139.0 → 1.140.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +361 -278
- data/lib/aws-sdk-cloudformation/client_api.rb +13 -2
- data/lib/aws-sdk-cloudformation/event.rb +12 -6
- data/lib/aws-sdk-cloudformation/resource.rb +8 -0
- data/lib/aws-sdk-cloudformation/stack.rb +9 -1
- data/lib/aws-sdk-cloudformation/types.rb +594 -514
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/client.rbs +5 -3
- data/sig/event.rbs +3 -0
- data/sig/types.rbs +9 -0
- metadata +1 -1
@@ -491,17 +491,30 @@ module Aws::CloudFormation
|
|
491
491
|
req.send_request(options)
|
492
492
|
end
|
493
493
|
|
494
|
-
# Activates a public third-party extension,
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
494
|
+
# Activates a public third-party extension, such as a resource or
|
495
|
+
# module, to make it available for use in stack templates in your
|
496
|
+
# current account and Region. It can also create CloudFormation Hooks,
|
497
|
+
# which allow you to evaluate resource configurations before
|
498
|
+
# CloudFormation provisions them. Hooks integrate with both
|
499
|
+
# CloudFormation and Cloud Control API operations.
|
500
|
+
#
|
501
|
+
# After you activate an extension, you can use [SetTypeConfiguration][1]
|
502
|
+
# to set specific properties for the extension.
|
503
|
+
#
|
504
|
+
# To see which extensions have been activated, use [ListTypes][2]. To
|
505
|
+
# see configuration details for an extension, use [DescribeType][3].
|
506
|
+
#
|
507
|
+
# For more information, see [Activate a third-party public extension in
|
508
|
+
# your account][4] in the *CloudFormation User Guide*. For information
|
509
|
+
# about creating Hooks, see the [CloudFormation Hooks User Guide][5].
|
500
510
|
#
|
501
511
|
#
|
502
512
|
#
|
503
513
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
|
504
|
-
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/
|
514
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html
|
515
|
+
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
516
|
+
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public-activate-extension.html
|
517
|
+
# [5]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html
|
505
518
|
#
|
506
519
|
# @option params [String] :type
|
507
520
|
# The extension type.
|
@@ -607,8 +620,8 @@ module Aws::CloudFormation
|
|
607
620
|
end
|
608
621
|
|
609
622
|
# Returns configuration data for the specified CloudFormation
|
610
|
-
# extensions, from the CloudFormation registry
|
611
|
-
# Region.
|
623
|
+
# extensions, from the CloudFormation registry in your current account
|
624
|
+
# and Region.
|
612
625
|
#
|
613
626
|
# For more information, see [Edit configuration data for extensions in
|
614
627
|
# your account][1] in the *CloudFormation User Guide*.
|
@@ -723,25 +736,29 @@ module Aws::CloudFormation
|
|
723
736
|
req.send_request(options)
|
724
737
|
end
|
725
738
|
|
726
|
-
#
|
727
|
-
#
|
728
|
-
#
|
729
|
-
#
|
730
|
-
#
|
731
|
-
#
|
732
|
-
# again.
|
739
|
+
# Continues rolling back a stack from `UPDATE_ROLLBACK_FAILED` to
|
740
|
+
# `UPDATE_ROLLBACK_COMPLETE` state. Depending on the cause of the
|
741
|
+
# failure, you can manually fix the error and continue the rollback. By
|
742
|
+
# continuing the rollback, you can return your stack to a working state
|
743
|
+
# (the `UPDATE_ROLLBACK_COMPLETE` state) and then try to update the
|
744
|
+
# stack again.
|
733
745
|
#
|
734
|
-
# A stack
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
746
|
+
# A stack enters the `UPDATE_ROLLBACK_FAILED` state when CloudFormation
|
747
|
+
# can't roll back all changes after a failed stack update. For example,
|
748
|
+
# this might occur when a stack attempts to roll back to an old database
|
749
|
+
# that was deleted outside of CloudFormation. Because CloudFormation
|
750
|
+
# doesn't know the instance was deleted, it assumes the instance still
|
751
|
+
# exists and attempts to roll back to it, causing the update rollback to
|
752
|
+
# fail.
|
741
753
|
#
|
754
|
+
# For more information, see [Continue rolling back an update][1] in the
|
755
|
+
# *CloudFormation User Guide*. For information for troubleshooting a
|
756
|
+
# failed update rollback, see [Update rollback failed][2].
|
742
757
|
#
|
743
758
|
#
|
744
|
-
#
|
759
|
+
#
|
760
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html
|
761
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed
|
745
762
|
#
|
746
763
|
# @option params [required, String] :stack_name
|
747
764
|
# The name or the unique ID of the stack that you want to continue
|
@@ -1497,6 +1514,14 @@ module Aws::CloudFormation
|
|
1497
1514
|
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
1498
1515
|
# either `OnFailure` or `DisableRollback`, but not both.
|
1499
1516
|
#
|
1517
|
+
# <note markdown="1"> Although the default setting is `ROLLBACK`, there is one exception.
|
1518
|
+
# This exception occurs when a StackSet attempts to deploy a stack
|
1519
|
+
# instance and the stack instance fails to create successfully. In this
|
1520
|
+
# case, the `CreateStack` call overrides the default setting and sets
|
1521
|
+
# the value of `OnFailure` to `DELETE`.
|
1522
|
+
#
|
1523
|
+
# </note>
|
1524
|
+
#
|
1500
1525
|
# Default: `ROLLBACK`
|
1501
1526
|
#
|
1502
1527
|
# @option params [String] :stack_policy_body
|
@@ -1648,7 +1673,7 @@ module Aws::CloudFormation
|
|
1648
1673
|
# </note>
|
1649
1674
|
#
|
1650
1675
|
# @option params [required, String] :stack_set_name
|
1651
|
-
# The name or unique ID of the
|
1676
|
+
# The name or unique ID of the StackSet that you want to create stack
|
1652
1677
|
# instances from.
|
1653
1678
|
#
|
1654
1679
|
# @option params [Array<String>] :accounts
|
@@ -1659,9 +1684,8 @@ module Aws::CloudFormation
|
|
1659
1684
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1660
1685
|
#
|
1661
1686
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1662
|
-
# \[Service-managed permissions\] The Organizations accounts
|
1663
|
-
#
|
1664
|
-
# Regions.
|
1687
|
+
# \[Service-managed permissions\] The Organizations accounts in which to
|
1688
|
+
# create stack instances in the specified Amazon Web Services Regions.
|
1665
1689
|
#
|
1666
1690
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1667
1691
|
#
|
@@ -1671,8 +1695,8 @@ module Aws::CloudFormation
|
|
1671
1695
|
# accounts.
|
1672
1696
|
#
|
1673
1697
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
1674
|
-
# A list of
|
1675
|
-
#
|
1698
|
+
# A list of StackSet parameters whose values you want to override in the
|
1699
|
+
# selected stack instances.
|
1676
1700
|
#
|
1677
1701
|
# Any overridden parameter values will be applied to all stack instances
|
1678
1702
|
# in the specified accounts and Amazon Web Services Regions. When
|
@@ -1687,39 +1711,39 @@ module Aws::CloudFormation
|
|
1687
1711
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
1688
1712
|
#
|
1689
1713
|
# * To set an overridden parameter back to the value specified in the
|
1690
|
-
#
|
1714
|
+
# StackSet, specify a parameter list but don't include the parameter
|
1691
1715
|
# in the list.
|
1692
1716
|
#
|
1693
1717
|
# * To leave all parameters set to their present values, don't specify
|
1694
1718
|
# this property at all.
|
1695
1719
|
#
|
1696
|
-
# During
|
1720
|
+
# During StackSet updates, any parameter values overridden for a stack
|
1697
1721
|
# instance aren't updated, but retain their overridden value.
|
1698
1722
|
#
|
1699
1723
|
# You can only override the parameter *values* that are specified in the
|
1700
|
-
#
|
1701
|
-
#
|
1724
|
+
# StackSet; to add or delete a parameter itself, use [UpdateStackSet][1]
|
1725
|
+
# to update the StackSet template.
|
1702
1726
|
#
|
1703
1727
|
#
|
1704
1728
|
#
|
1705
1729
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
1706
1730
|
#
|
1707
1731
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1708
|
-
# Preferences for how CloudFormation performs this
|
1732
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
1709
1733
|
#
|
1710
1734
|
# @option params [String] :operation_id
|
1711
|
-
# The unique identifier for this
|
1735
|
+
# The unique identifier for this StackSet operation.
|
1712
1736
|
#
|
1713
1737
|
# The operation ID also functions as an idempotency token, to ensure
|
1714
|
-
# that CloudFormation performs the
|
1715
|
-
#
|
1738
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
1739
|
+
# you retry the request multiple times. You might retry StackSet
|
1716
1740
|
# operation requests to ensure that CloudFormation successfully received
|
1717
1741
|
# them.
|
1718
1742
|
#
|
1719
1743
|
# If you don't specify an operation ID, the SDK generates one
|
1720
1744
|
# automatically.
|
1721
1745
|
#
|
1722
|
-
# Repeating this
|
1746
|
+
# Repeating this StackSet operation with a new operation ID retries all
|
1723
1747
|
# stack instances whose status is `OUTDATED`.
|
1724
1748
|
#
|
1725
1749
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1730,7 +1754,7 @@ module Aws::CloudFormation
|
|
1730
1754
|
# account administrator in the organization's management account or as
|
1731
1755
|
# a delegated administrator in a member account.
|
1732
1756
|
#
|
1733
|
-
# By default, `SELF` is specified. Use `SELF` for
|
1757
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
1734
1758
|
# self-managed permissions.
|
1735
1759
|
#
|
1736
1760
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -1856,11 +1880,11 @@ module Aws::CloudFormation
|
|
1856
1880
|
req.send_request(options)
|
1857
1881
|
end
|
1858
1882
|
|
1859
|
-
# Creates a
|
1883
|
+
# Creates a StackSet.
|
1860
1884
|
#
|
1861
1885
|
# @option params [required, String] :stack_set_name
|
1862
|
-
# The name to associate with the
|
1863
|
-
# the Region where you create your
|
1886
|
+
# The name to associate with the StackSet. The name must be unique in
|
1887
|
+
# the Region where you create your StackSet.
|
1864
1888
|
#
|
1865
1889
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case-sensitive)
|
1866
1890
|
# and hyphens. It must start with an alphabetic character and can't be
|
@@ -1869,8 +1893,8 @@ module Aws::CloudFormation
|
|
1869
1893
|
# </note>
|
1870
1894
|
#
|
1871
1895
|
# @option params [String] :description
|
1872
|
-
# A description of the
|
1873
|
-
#
|
1896
|
+
# A description of the StackSet. You can use the description to identify
|
1897
|
+
# the StackSet's purpose or other important information.
|
1874
1898
|
#
|
1875
1899
|
# @option params [String] :template_body
|
1876
1900
|
# The structure that contains the template body, with a minimum length
|
@@ -1890,22 +1914,22 @@ module Aws::CloudFormation
|
|
1890
1914
|
# `TemplateURL` parameter, but not both.
|
1891
1915
|
#
|
1892
1916
|
# @option params [String] :stack_id
|
1893
|
-
# The stack ID you are importing into a new
|
1894
|
-
#
|
1917
|
+
# The stack ID you are importing into a new StackSet. Specify the Amazon
|
1918
|
+
# Resource Name (ARN) of the stack.
|
1895
1919
|
#
|
1896
1920
|
# @option params [Array<Types::Parameter>] :parameters
|
1897
|
-
# The input parameters for the
|
1921
|
+
# The input parameters for the StackSet template.
|
1898
1922
|
#
|
1899
1923
|
# @option params [Array<String>] :capabilities
|
1900
|
-
# In some cases, you must explicitly acknowledge that your
|
1924
|
+
# In some cases, you must explicitly acknowledge that your StackSet
|
1901
1925
|
# template contains certain capabilities in order for CloudFormation to
|
1902
|
-
# create the
|
1926
|
+
# create the StackSet and related stack instances.
|
1903
1927
|
#
|
1904
1928
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
1905
1929
|
#
|
1906
1930
|
# Some stack templates might include resources that can affect
|
1907
1931
|
# permissions in your Amazon Web Services account; for example, by
|
1908
|
-
# creating new IAM users. For those
|
1932
|
+
# creating new IAM users. For those StackSets, you must explicitly
|
1909
1933
|
# acknowledge this by specifying one of these capabilities.
|
1910
1934
|
#
|
1911
1935
|
# The following IAM resources require you to specify either the
|
@@ -1940,21 +1964,20 @@ module Aws::CloudFormation
|
|
1940
1964
|
#
|
1941
1965
|
# * `CAPABILITY_AUTO_EXPAND`
|
1942
1966
|
#
|
1943
|
-
# Some templates reference macros. If your
|
1944
|
-
# references one or more macros, you must create the
|
1945
|
-
#
|
1946
|
-
#
|
1947
|
-
#
|
1948
|
-
#
|
1967
|
+
# Some templates reference macros. If your StackSet template
|
1968
|
+
# references one or more macros, you must create the StackSet directly
|
1969
|
+
# from the processed template, without first reviewing the resulting
|
1970
|
+
# changes in a change set. To create the StackSet directly, you must
|
1971
|
+
# acknowledge this capability. For more information, see [Perform
|
1972
|
+
# custom processing on CloudFormation templates with template
|
1949
1973
|
# macros][9].
|
1950
1974
|
#
|
1951
|
-
#
|
1975
|
+
# StackSets with service-managed permissions don't currently support
|
1952
1976
|
# the use of macros in templates. (This includes the
|
1953
1977
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1954
1978
|
# macros hosted by CloudFormation.) Even if you specify this
|
1955
|
-
# capability for a
|
1956
|
-
# reference a macro in your template the
|
1957
|
-
# fail.
|
1979
|
+
# capability for a StackSet with service-managed permissions, if you
|
1980
|
+
# reference a macro in your template the StackSet operation will fail.
|
1958
1981
|
#
|
1959
1982
|
#
|
1960
1983
|
#
|
@@ -1971,7 +1994,7 @@ module Aws::CloudFormation
|
|
1971
1994
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
1972
1995
|
#
|
1973
1996
|
# @option params [Array<Types::Tag>] :tags
|
1974
|
-
# The key-value pairs to associate with this
|
1997
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
1975
1998
|
# created from it. CloudFormation also propagates these tags to
|
1976
1999
|
# supported resources that are created in the stacks. A maximum number
|
1977
2000
|
# of 50 tags can be specified.
|
@@ -1979,14 +2002,14 @@ module Aws::CloudFormation
|
|
1979
2002
|
# If you specify tags as part of a `CreateStackSet` action,
|
1980
2003
|
# CloudFormation checks to see if you have the required IAM permission
|
1981
2004
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
1982
|
-
# fails with an `access denied` error, and the
|
2005
|
+
# fails with an `access denied` error, and the StackSet is not created.
|
1983
2006
|
#
|
1984
2007
|
# @option params [String] :administration_role_arn
|
1985
2008
|
# The Amazon Resource Name (ARN) of the IAM role to use to create this
|
1986
|
-
#
|
2009
|
+
# StackSet.
|
1987
2010
|
#
|
1988
2011
|
# Specify an IAM role only if you are using customized administrator
|
1989
|
-
# roles to control which users or groups can manage specific
|
2012
|
+
# roles to control which users or groups can manage specific StackSets
|
1990
2013
|
# within the same administrator account. For more information, see
|
1991
2014
|
# [Grant self-managed permissions][1] in the *CloudFormation User
|
1992
2015
|
# Guide*.
|
@@ -1998,19 +2021,19 @@ module Aws::CloudFormation
|
|
1998
2021
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
|
1999
2022
|
#
|
2000
2023
|
# @option params [String] :execution_role_name
|
2001
|
-
# The name of the IAM execution role to use to create the
|
2024
|
+
# The name of the IAM execution role to use to create the StackSet. If
|
2002
2025
|
# you do not specify an execution role, CloudFormation uses the
|
2003
|
-
# `AWSCloudFormationStackSetExecutionRole` role for the
|
2026
|
+
# `AWSCloudFormationStackSetExecutionRole` role for the StackSet
|
2004
2027
|
# operation.
|
2005
2028
|
#
|
2006
2029
|
# Specify an IAM role only if you are using customized execution roles
|
2007
2030
|
# to control which stack resources users and groups can include in their
|
2008
|
-
#
|
2031
|
+
# StackSets.
|
2009
2032
|
#
|
2010
2033
|
# Valid only if the permissions model is `SELF_MANAGED`.
|
2011
2034
|
#
|
2012
2035
|
# @option params [String] :permission_model
|
2013
|
-
# Describes how the IAM roles required for
|
2036
|
+
# Describes how the IAM roles required for StackSet operations are
|
2014
2037
|
# created. By default, `SELF-MANAGED` is specified.
|
2015
2038
|
#
|
2016
2039
|
# * With `self-managed` permissions, you must create the administrator
|
@@ -2020,7 +2043,7 @@ module Aws::CloudFormation
|
|
2020
2043
|
# * With `service-managed` permissions, StackSets automatically creates
|
2021
2044
|
# the IAM roles required to deploy to accounts managed by
|
2022
2045
|
# Organizations. For more information, see [Activate trusted access
|
2023
|
-
# for
|
2046
|
+
# for StackSets with Organizations][2].
|
2024
2047
|
#
|
2025
2048
|
#
|
2026
2049
|
#
|
@@ -2030,9 +2053,9 @@ module Aws::CloudFormation
|
|
2030
2053
|
# @option params [Types::AutoDeployment] :auto_deployment
|
2031
2054
|
# Describes whether StackSets automatically deploys to Organizations
|
2032
2055
|
# accounts that are added to the target organization or organizational
|
2033
|
-
# unit (OU). For more information, see [
|
2034
|
-
#
|
2035
|
-
#
|
2056
|
+
# unit (OU). For more information, see [Enable or disable automatic
|
2057
|
+
# deployments for StackSets in Organizations][1] in the *CloudFormation
|
2058
|
+
# User Guide*.
|
2036
2059
|
#
|
2037
2060
|
# Required if the permissions model is `SERVICE_MANAGED`. (Not used with
|
2038
2061
|
# self-managed permissions.)
|
@@ -2046,21 +2069,21 @@ module Aws::CloudFormation
|
|
2046
2069
|
# organization's management account or as a delegated administrator in
|
2047
2070
|
# a member account.
|
2048
2071
|
#
|
2049
|
-
# By default, `SELF` is specified. Use `SELF` for
|
2072
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
2050
2073
|
# self-managed permissions.
|
2051
2074
|
#
|
2052
|
-
# * To create a
|
2075
|
+
# * To create a StackSet with service-managed permissions while signed
|
2053
2076
|
# in to the management account, specify `SELF`.
|
2054
2077
|
#
|
2055
|
-
# * To create a
|
2078
|
+
# * To create a StackSet with service-managed permissions while signed
|
2056
2079
|
# in to a delegated administrator account, specify `DELEGATED_ADMIN`.
|
2057
2080
|
#
|
2058
2081
|
# Your Amazon Web Services account must be registered as a delegated
|
2059
2082
|
# admin in the management account. For more information, see [Register
|
2060
2083
|
# a delegated administrator][1] in the *CloudFormation User Guide*.
|
2061
2084
|
#
|
2062
|
-
#
|
2063
|
-
# management account, including
|
2085
|
+
# StackSets with service-managed permissions are created in the
|
2086
|
+
# management account, including StackSets that are created by delegated
|
2064
2087
|
# administrators.
|
2065
2088
|
#
|
2066
2089
|
# Valid only if the permissions model is `SERVICE_MANAGED`.
|
@@ -2072,7 +2095,7 @@ module Aws::CloudFormation
|
|
2072
2095
|
# @option params [String] :client_request_token
|
2073
2096
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
2074
2097
|
# token if you plan to retry requests so that CloudFormation knows that
|
2075
|
-
# you're not attempting to create another
|
2098
|
+
# you're not attempting to create another StackSet with the same name.
|
2076
2099
|
# You might retry `CreateStackSet` requests to ensure that
|
2077
2100
|
# CloudFormation successfully received them.
|
2078
2101
|
#
|
@@ -2083,7 +2106,7 @@ module Aws::CloudFormation
|
|
2083
2106
|
# not need to pass this option.**
|
2084
2107
|
#
|
2085
2108
|
# @option params [Types::ManagedExecution] :managed_execution
|
2086
|
-
# Describes whether
|
2109
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
2087
2110
|
# concurrently and queues conflicting operations.
|
2088
2111
|
#
|
2089
2112
|
# @return [Types::CreateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2155,8 +2178,12 @@ module Aws::CloudFormation
|
|
2155
2178
|
req.send_request(options)
|
2156
2179
|
end
|
2157
2180
|
|
2158
|
-
# Deactivates a public extension
|
2159
|
-
#
|
2181
|
+
# Deactivates a public third-party extension, such as a resource or
|
2182
|
+
# module, or a CloudFormation Hook when you no longer use it.
|
2183
|
+
#
|
2184
|
+
# Deactivating an extension deletes the configuration details that are
|
2185
|
+
# associated with it. To temporary disable a CloudFormation Hook
|
2186
|
+
# instead, you can use [SetTypeConfiguration][1].
|
2160
2187
|
#
|
2161
2188
|
# Once deactivated, an extension can't be used in any CloudFormation
|
2162
2189
|
# operation. This includes stack update operations where the stack
|
@@ -2164,6 +2191,13 @@ module Aws::CloudFormation
|
|
2164
2191
|
# the extension. In addition, deactivated extensions aren't
|
2165
2192
|
# automatically updated if a new version of the extension is released.
|
2166
2193
|
#
|
2194
|
+
# To see which extensions are currently activated, use [ListTypes][2].
|
2195
|
+
#
|
2196
|
+
#
|
2197
|
+
#
|
2198
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
|
2199
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html
|
2200
|
+
#
|
2167
2201
|
# @option params [String] :type_name
|
2168
2202
|
# The type name of the extension, in this account and Region. If you
|
2169
2203
|
# specified a type name alias when enabling the extension, use the type
|
@@ -2371,7 +2405,7 @@ module Aws::CloudFormation
|
|
2371
2405
|
# </note>
|
2372
2406
|
#
|
2373
2407
|
# @option params [required, String] :stack_set_name
|
2374
|
-
# The name or unique ID of the
|
2408
|
+
# The name or unique ID of the StackSet that you want to delete stack
|
2375
2409
|
# instances for.
|
2376
2410
|
#
|
2377
2411
|
# @option params [Array<String>] :accounts
|
@@ -2387,36 +2421,35 @@ module Aws::CloudFormation
|
|
2387
2421
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
2388
2422
|
#
|
2389
2423
|
# @option params [required, Array<String>] :regions
|
2390
|
-
# The Amazon Web Services Regions where you want to delete
|
2424
|
+
# The Amazon Web Services Regions where you want to delete StackSet
|
2391
2425
|
# instances.
|
2392
2426
|
#
|
2393
2427
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
2394
|
-
# Preferences for how CloudFormation performs this
|
2428
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
2395
2429
|
#
|
2396
2430
|
# @option params [required, Boolean] :retain_stacks
|
2397
|
-
# Removes the stack instances from the specified
|
2431
|
+
# Removes the stack instances from the specified StackSet, but doesn't
|
2398
2432
|
# delete the stacks. You can't reassociate a retained stack or add an
|
2399
2433
|
# existing, saved stack to a new stack set.
|
2400
2434
|
#
|
2401
|
-
# For more information, see [
|
2435
|
+
# For more information, see [StackSet operation options][1].
|
2402
2436
|
#
|
2403
2437
|
#
|
2404
2438
|
#
|
2405
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
2439
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
2406
2440
|
#
|
2407
2441
|
# @option params [String] :operation_id
|
2408
|
-
# The unique identifier for this
|
2442
|
+
# The unique identifier for this StackSet operation.
|
2409
2443
|
#
|
2410
2444
|
# If you don't specify an operation ID, the SDK generates one
|
2411
2445
|
# automatically.
|
2412
2446
|
#
|
2413
2447
|
# The operation ID also functions as an idempotency token, to ensure
|
2414
|
-
# that CloudFormation performs the
|
2415
|
-
#
|
2416
|
-
#
|
2417
|
-
# them.
|
2448
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
2449
|
+
# you retry the request multiple times. You can retry StackSet operation
|
2450
|
+
# requests to ensure that CloudFormation successfully received them.
|
2418
2451
|
#
|
2419
|
-
# Repeating this
|
2452
|
+
# Repeating this StackSet operation with a new operation ID retries all
|
2420
2453
|
# stack instances whose status is `OUTDATED`.
|
2421
2454
|
#
|
2422
2455
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2427,7 +2460,7 @@ module Aws::CloudFormation
|
|
2427
2460
|
# account administrator in the organization's management account or as
|
2428
2461
|
# a delegated administrator in a member account.
|
2429
2462
|
#
|
2430
|
-
# By default, `SELF` is specified. Use `SELF` for
|
2463
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
2431
2464
|
# self-managed permissions.
|
2432
2465
|
#
|
2433
2466
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -2487,12 +2520,12 @@ module Aws::CloudFormation
|
|
2487
2520
|
req.send_request(options)
|
2488
2521
|
end
|
2489
2522
|
|
2490
|
-
# Deletes a
|
2523
|
+
# Deletes a StackSet. Before you can delete a StackSet, all its member
|
2491
2524
|
# stack instances must be deleted. For more information about how to
|
2492
2525
|
# complete this, see DeleteStackInstances.
|
2493
2526
|
#
|
2494
2527
|
# @option params [required, String] :stack_set_name
|
2495
|
-
# The name or unique ID of the
|
2528
|
+
# The name or unique ID of the StackSet that you're deleting. You can
|
2496
2529
|
# obtain this value by running ListStackSets.
|
2497
2530
|
#
|
2498
2531
|
# @option params [String] :call_as
|
@@ -2500,7 +2533,7 @@ module Aws::CloudFormation
|
|
2500
2533
|
# account administrator in the organization's management account or as
|
2501
2534
|
# a delegated administrator in a member account.
|
2502
2535
|
#
|
2503
|
-
# By default, `SELF` is specified. Use `SELF` for
|
2536
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
2504
2537
|
# self-managed permissions.
|
2505
2538
|
#
|
2506
2539
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -2554,9 +2587,13 @@ module Aws::CloudFormation
|
|
2554
2587
|
# To view the deprecation status of an extension or extension version,
|
2555
2588
|
# use [DescribeType][1].
|
2556
2589
|
#
|
2590
|
+
# For more information, see [Remove third-party private extensions from
|
2591
|
+
# your account][2] in the *CloudFormation User Guide*.
|
2592
|
+
#
|
2557
2593
|
#
|
2558
2594
|
#
|
2559
2595
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
2596
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.html
|
2560
2597
|
#
|
2561
2598
|
# @option params [String] :arn
|
2562
2599
|
# The Amazon Resource Name (ARN) of the extension.
|
@@ -3308,6 +3345,7 @@ module Aws::CloudFormation
|
|
3308
3345
|
# resp.stack_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
3309
3346
|
# resp.stack_events[0].hook_status_reason #=> String
|
3310
3347
|
# resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
|
3348
|
+
# resp.stack_events[0].hook_invocation_id #=> String
|
3311
3349
|
# resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
|
3312
3350
|
# resp.stack_events[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
|
3313
3351
|
# resp.next_token #=> String
|
@@ -3328,7 +3366,7 @@ module Aws::CloudFormation
|
|
3328
3366
|
# StackSet, use ListStackInstances.
|
3329
3367
|
#
|
3330
3368
|
# @option params [required, String] :stack_set_name
|
3331
|
-
# The name or the unique stack ID of the
|
3369
|
+
# The name or the unique stack ID of the StackSet that you want to get
|
3332
3370
|
# stack instance information for.
|
3333
3371
|
#
|
3334
3372
|
# @option params [required, String] :stack_instance_account
|
@@ -3343,7 +3381,7 @@ module Aws::CloudFormation
|
|
3343
3381
|
# account administrator in the organization's management account or as
|
3344
3382
|
# a delegated administrator in a member account.
|
3345
3383
|
#
|
3346
|
-
# By default, `SELF` is specified. Use `SELF` for
|
3384
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
3347
3385
|
# self-managed permissions.
|
3348
3386
|
#
|
3349
3387
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -3706,14 +3744,14 @@ module Aws::CloudFormation
|
|
3706
3744
|
# </note>
|
3707
3745
|
#
|
3708
3746
|
# @option params [required, String] :stack_set_name
|
3709
|
-
# The name or unique ID of the
|
3747
|
+
# The name or unique ID of the StackSet whose description you want.
|
3710
3748
|
#
|
3711
3749
|
# @option params [String] :call_as
|
3712
3750
|
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3713
3751
|
# account administrator in the organization's management account or as
|
3714
3752
|
# a delegated administrator in a member account.
|
3715
3753
|
#
|
3716
|
-
# By default, `SELF` is specified. Use `SELF` for
|
3754
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
3717
3755
|
# self-managed permissions.
|
3718
3756
|
#
|
3719
3757
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -3795,18 +3833,18 @@ module Aws::CloudFormation
|
|
3795
3833
|
# </note>
|
3796
3834
|
#
|
3797
3835
|
# @option params [required, String] :stack_set_name
|
3798
|
-
# The name or the unique stack ID of the
|
3836
|
+
# The name or the unique stack ID of the StackSet for the stack
|
3799
3837
|
# operation.
|
3800
3838
|
#
|
3801
3839
|
# @option params [required, String] :operation_id
|
3802
|
-
# The unique ID of the
|
3840
|
+
# The unique ID of the StackSet operation.
|
3803
3841
|
#
|
3804
3842
|
# @option params [String] :call_as
|
3805
3843
|
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3806
3844
|
# account administrator in the organization's management account or as
|
3807
3845
|
# a delegated administrator in a member account.
|
3808
3846
|
#
|
3809
|
-
# By default, `SELF` is specified. Use `SELF` for
|
3847
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
3810
3848
|
# self-managed permissions.
|
3811
3849
|
#
|
3812
3850
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4004,8 +4042,8 @@ module Aws::CloudFormation
|
|
4004
4042
|
req.send_request(options)
|
4005
4043
|
end
|
4006
4044
|
|
4007
|
-
# Returns detailed information about an extension
|
4008
|
-
#
|
4045
|
+
# Returns detailed information about an extension from the
|
4046
|
+
# CloudFormation registry in your current account and Region.
|
4009
4047
|
#
|
4010
4048
|
# If you specify a `VersionId`, `DescribeType` returns information about
|
4011
4049
|
# that specific extension version. Otherwise, it returns information
|
@@ -4317,17 +4355,17 @@ module Aws::CloudFormation
|
|
4317
4355
|
req.send_request(options)
|
4318
4356
|
end
|
4319
4357
|
|
4320
|
-
# Detect drift on a
|
4321
|
-
# detection on a
|
4322
|
-
# associated with each stack instance in the
|
4358
|
+
# Detect drift on a StackSet. When CloudFormation performs drift
|
4359
|
+
# detection on a StackSet, it performs drift detection on the stack
|
4360
|
+
# associated with each stack instance in the StackSet. For more
|
4323
4361
|
# information, see [Performing drift detection on CloudFormation
|
4324
4362
|
# StackSets][1].
|
4325
4363
|
#
|
4326
|
-
# `DetectStackSetDrift` returns the `OperationId` of the
|
4364
|
+
# `DetectStackSetDrift` returns the `OperationId` of the StackSet drift
|
4327
4365
|
# detection operation. Use this operation id with
|
4328
4366
|
# DescribeStackSetOperation to monitor the progress of the drift
|
4329
4367
|
# detection operation. The drift detection operation may take some time,
|
4330
|
-
# depending on the number of stack instances included in the
|
4368
|
+
# depending on the number of stack instances included in the StackSet,
|
4331
4369
|
# in addition to the number of resources included in each stack.
|
4332
4370
|
#
|
4333
4371
|
# Once the operation has completed, use the following actions to return
|
@@ -4335,21 +4373,21 @@ module Aws::CloudFormation
|
|
4335
4373
|
#
|
4336
4374
|
# * Use DescribeStackSet to return detailed information about the stack
|
4337
4375
|
# set, including detailed information about the last *completed* drift
|
4338
|
-
# operation performed on the
|
4376
|
+
# operation performed on the StackSet. (Information about drift
|
4339
4377
|
# operations that are in progress isn't included.)
|
4340
4378
|
#
|
4341
4379
|
# * Use ListStackInstances to return a list of stack instances belonging
|
4342
|
-
# to the
|
4380
|
+
# to the StackSet, including the drift status and last drift time
|
4343
4381
|
# checked of each instance.
|
4344
4382
|
#
|
4345
4383
|
# * Use DescribeStackInstance to return detailed information about a
|
4346
4384
|
# specific stack instance, including its drift status and last drift
|
4347
4385
|
# time checked.
|
4348
4386
|
#
|
4349
|
-
# You can only run a single drift detection operation on a given
|
4350
|
-
#
|
4387
|
+
# You can only run a single drift detection operation on a given
|
4388
|
+
# StackSet at one time.
|
4351
4389
|
#
|
4352
|
-
# To stop a drift detection
|
4390
|
+
# To stop a drift detection StackSet operation, use
|
4353
4391
|
# StopStackSetOperation.
|
4354
4392
|
#
|
4355
4393
|
#
|
@@ -4357,22 +4395,22 @@ module Aws::CloudFormation
|
|
4357
4395
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
|
4358
4396
|
#
|
4359
4397
|
# @option params [required, String] :stack_set_name
|
4360
|
-
# The name of the
|
4398
|
+
# The name of the StackSet on which to perform the drift detection
|
4361
4399
|
# operation.
|
4362
4400
|
#
|
4363
4401
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
4364
|
-
# The user-specified preferences for how CloudFormation performs a
|
4365
|
-
#
|
4402
|
+
# The user-specified preferences for how CloudFormation performs a
|
4403
|
+
# StackSet operation.
|
4366
4404
|
#
|
4367
4405
|
# For more information about maximum concurrent accounts and failure
|
4368
|
-
# tolerance, see [
|
4406
|
+
# tolerance, see [StackSet operation options][1].
|
4369
4407
|
#
|
4370
4408
|
#
|
4371
4409
|
#
|
4372
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
4410
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4373
4411
|
#
|
4374
4412
|
# @option params [String] :operation_id
|
4375
|
-
# *The ID of the
|
4413
|
+
# *The ID of the StackSet operation.*
|
4376
4414
|
#
|
4377
4415
|
# **A suitable default value is auto-generated.** You should normally
|
4378
4416
|
# not need to pass this option.**
|
@@ -4382,7 +4420,7 @@ module Aws::CloudFormation
|
|
4382
4420
|
# account administrator in the organization's management account or as
|
4383
4421
|
# a delegated administrator in a member account.
|
4384
4422
|
#
|
4385
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4423
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4386
4424
|
# self-managed permissions.
|
4387
4425
|
#
|
4388
4426
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4764,10 +4802,10 @@ module Aws::CloudFormation
|
|
4764
4802
|
# Returns information about a new or existing template. The
|
4765
4803
|
# `GetTemplateSummary` action is useful for viewing parameter
|
4766
4804
|
# information, such as default parameter values and parameter types,
|
4767
|
-
# before you create or update a stack or
|
4805
|
+
# before you create or update a stack or StackSet.
|
4768
4806
|
#
|
4769
4807
|
# You can use the `GetTemplateSummary` action when you submit a
|
4770
|
-
# template, or you can get template information for a
|
4808
|
+
# template, or you can get template information for a StackSet, or a
|
4771
4809
|
# running or deleted stack.
|
4772
4810
|
#
|
4773
4811
|
# For deleted stacks, `GetTemplateSummary` returns the template
|
@@ -4800,7 +4838,7 @@ module Aws::CloudFormation
|
|
4800
4838
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
4801
4839
|
#
|
4802
4840
|
# @option params [String] :stack_set_name
|
4803
|
-
# The name or unique ID of the
|
4841
|
+
# The name or unique ID of the StackSet from which the stack was
|
4804
4842
|
# created.
|
4805
4843
|
#
|
4806
4844
|
# Conditional: You must specify only one of the following parameters:
|
@@ -4811,7 +4849,7 @@ module Aws::CloudFormation
|
|
4811
4849
|
# account administrator in the organization's management account or as
|
4812
4850
|
# a delegated administrator in a member account.
|
4813
4851
|
#
|
4814
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4852
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4815
4853
|
# self-managed permissions.
|
4816
4854
|
#
|
4817
4855
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4895,19 +4933,19 @@ module Aws::CloudFormation
|
|
4895
4933
|
req.send_request(options)
|
4896
4934
|
end
|
4897
4935
|
|
4898
|
-
# Import existing stacks into a new
|
4899
|
-
# operation to import up to 10 stacks into a new
|
4936
|
+
# Import existing stacks into a new StackSets. Use the stack import
|
4937
|
+
# operation to import up to 10 stacks into a new StackSet in the same
|
4900
4938
|
# account as the source stack or in a different administrator account
|
4901
4939
|
# and Region, by specifying the stack ID of the stack you intend to
|
4902
4940
|
# import.
|
4903
4941
|
#
|
4904
4942
|
# @option params [required, String] :stack_set_name
|
4905
|
-
# The name of the
|
4906
|
-
# you create your
|
4943
|
+
# The name of the StackSet. The name must be unique in the Region where
|
4944
|
+
# you create your StackSet.
|
4907
4945
|
#
|
4908
4946
|
# @option params [Array<String>] :stack_ids
|
4909
|
-
# The IDs of the stacks you are importing into a
|
4910
|
-
#
|
4947
|
+
# The IDs of the stacks you are importing into a StackSet. You import up
|
4948
|
+
# to 10 stacks per StackSet at a time.
|
4911
4949
|
#
|
4912
4950
|
# Specify either `StackIds` or `StackIdsUrl`.
|
4913
4951
|
#
|
@@ -4917,33 +4955,33 @@ module Aws::CloudFormation
|
|
4917
4955
|
# Specify either `StackIds` or `StackIdsUrl`.
|
4918
4956
|
#
|
4919
4957
|
# @option params [Array<String>] :organizational_unit_ids
|
4920
|
-
# The list of OU ID's to which the stacks
|
4921
|
-
#
|
4958
|
+
# The list of OU ID's to which the imported stacks must be mapped as
|
4959
|
+
# deployment targets.
|
4922
4960
|
#
|
4923
4961
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
4924
|
-
# The user-specified preferences for how CloudFormation performs a
|
4925
|
-
#
|
4962
|
+
# The user-specified preferences for how CloudFormation performs a
|
4963
|
+
# StackSet operation.
|
4926
4964
|
#
|
4927
4965
|
# For more information about maximum concurrent accounts and failure
|
4928
|
-
# tolerance, see [
|
4966
|
+
# tolerance, see [StackSet operation options][1].
|
4929
4967
|
#
|
4930
4968
|
#
|
4931
4969
|
#
|
4932
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
4970
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4933
4971
|
#
|
4934
4972
|
# @option params [String] :operation_id
|
4935
|
-
# A unique, user defined, identifier for the
|
4973
|
+
# A unique, user defined, identifier for the StackSet operation.
|
4936
4974
|
#
|
4937
4975
|
# **A suitable default value is auto-generated.** You should normally
|
4938
4976
|
# not need to pass this option.**
|
4939
4977
|
#
|
4940
4978
|
# @option params [String] :call_as
|
4941
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4979
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4942
4980
|
# self-managed permissions.
|
4943
4981
|
#
|
4944
4982
|
# * If you are signed in to the management account, specify `SELF`.
|
4945
4983
|
#
|
4946
|
-
# * For service managed
|
4984
|
+
# * For service managed StackSets, specify `DELEGATED_ADMIN`.
|
4947
4985
|
#
|
4948
4986
|
# @return [Types::ImportStacksToStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4949
4987
|
#
|
@@ -5045,7 +5083,7 @@ module Aws::CloudFormation
|
|
5045
5083
|
#
|
5046
5084
|
#
|
5047
5085
|
#
|
5048
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/
|
5086
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html
|
5049
5087
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html
|
5050
5088
|
#
|
5051
5089
|
# @option params [String] :next_token
|
@@ -5170,25 +5208,63 @@ module Aws::CloudFormation
|
|
5170
5208
|
req.send_request(options)
|
5171
5209
|
end
|
5172
5210
|
|
5173
|
-
# Returns summaries of invoked Hooks
|
5174
|
-
#
|
5211
|
+
# Returns summaries of invoked Hooks. For more information, see [View
|
5212
|
+
# CloudFormation Hooks invocations][1] in the *CloudFormation Hooks User
|
5213
|
+
# Guide*.
|
5214
|
+
#
|
5215
|
+
# This operation supports the following parameter combinations:
|
5216
|
+
#
|
5217
|
+
# * No parameters: Returns all Hook invocation summaries.
|
5175
5218
|
#
|
5176
|
-
#
|
5177
|
-
# The type of operation being targeted by the Hook.
|
5219
|
+
# * `TypeArn` only: Returns summaries for a specific Hook.
|
5178
5220
|
#
|
5179
|
-
#
|
5180
|
-
#
|
5181
|
-
# If the target is a change set, it's the ARN of the change set.
|
5221
|
+
# * `TypeArn` and `Status`: Returns summaries for a specific Hook
|
5222
|
+
# filtered by status.
|
5182
5223
|
#
|
5183
|
-
#
|
5184
|
-
#
|
5185
|
-
#
|
5186
|
-
#
|
5224
|
+
# * `TargetId` and `TargetType`: Returns summaries for a specific Hook
|
5225
|
+
# invocation target.
|
5226
|
+
#
|
5227
|
+
#
|
5228
|
+
#
|
5229
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-view-invocations.html
|
5230
|
+
#
|
5231
|
+
# @option params [String] :target_type
|
5232
|
+
# Filters results by target type. Currently, only `CHANGE_SET` and
|
5233
|
+
# `CLOUD_CONTROL` are supported filter options.
|
5234
|
+
#
|
5235
|
+
# Required when `TargetId` is specified and cannot be used otherwise.
|
5236
|
+
#
|
5237
|
+
# @option params [String] :target_id
|
5238
|
+
# Filters results by the unique identifier of the target the Hook was
|
5239
|
+
# invoked against.
|
5240
|
+
#
|
5241
|
+
# For change sets, this is the change set ARN. When the target is a
|
5242
|
+
# Cloud Control API operation, this value must be the `HookRequestToken`
|
5243
|
+
# returned by the Cloud Control API request. For more information on the
|
5244
|
+
# `HookRequestToken`, see [ProgressEvent][1].
|
5245
|
+
#
|
5246
|
+
# Required when `TargetType` is specified and cannot be used otherwise.
|
5187
5247
|
#
|
5188
5248
|
#
|
5189
5249
|
#
|
5190
5250
|
# [1]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html
|
5191
5251
|
#
|
5252
|
+
# @option params [String] :type_arn
|
5253
|
+
# Filters results by the ARN of the Hook. Can be used alone or in
|
5254
|
+
# combination with `Status`.
|
5255
|
+
#
|
5256
|
+
# @option params [String] :status
|
5257
|
+
# Filters results by the status of Hook invocations. Can only be used in
|
5258
|
+
# combination with `TypeArn`. Valid values are:
|
5259
|
+
#
|
5260
|
+
# * `HOOK_IN_PROGRESS`: The Hook is currently running.
|
5261
|
+
#
|
5262
|
+
# * `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
|
5263
|
+
#
|
5264
|
+
# * `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
|
5265
|
+
#
|
5266
|
+
# * `HOOK_FAILED`: The Hook encountered an error during execution.
|
5267
|
+
#
|
5192
5268
|
# @option params [String] :next_token
|
5193
5269
|
# A string that identifies the next page of events that you want to
|
5194
5270
|
# retrieve.
|
@@ -5203,8 +5279,10 @@ module Aws::CloudFormation
|
|
5203
5279
|
# @example Request syntax with placeholder values
|
5204
5280
|
#
|
5205
5281
|
# resp = client.list_hook_results({
|
5206
|
-
# target_type: "CHANGE_SET", #
|
5207
|
-
# target_id: "HookResultId",
|
5282
|
+
# target_type: "CHANGE_SET", # accepts CHANGE_SET, STACK, RESOURCE, CLOUD_CONTROL
|
5283
|
+
# target_id: "HookResultId",
|
5284
|
+
# type_arn: "HookTypeArn",
|
5285
|
+
# status: "HOOK_IN_PROGRESS", # accepts HOOK_IN_PROGRESS, HOOK_COMPLETE_SUCCEEDED, HOOK_COMPLETE_FAILED, HOOK_FAILED
|
5208
5286
|
# next_token: "NextToken",
|
5209
5287
|
# })
|
5210
5288
|
#
|
@@ -5213,6 +5291,7 @@ module Aws::CloudFormation
|
|
5213
5291
|
# resp.target_type #=> String, one of "CHANGE_SET", "STACK", "RESOURCE", "CLOUD_CONTROL"
|
5214
5292
|
# resp.target_id #=> String
|
5215
5293
|
# resp.hook_results #=> Array
|
5294
|
+
# resp.hook_results[0].hook_result_id #=> String
|
5216
5295
|
# resp.hook_results[0].invocation_point #=> String, one of "PRE_PROVISION"
|
5217
5296
|
# resp.hook_results[0].failure_mode #=> String, one of "FAIL", "WARN"
|
5218
5297
|
# resp.hook_results[0].type_name #=> String
|
@@ -5220,6 +5299,11 @@ module Aws::CloudFormation
|
|
5220
5299
|
# resp.hook_results[0].type_configuration_version_id #=> String
|
5221
5300
|
# resp.hook_results[0].status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
5222
5301
|
# resp.hook_results[0].hook_status_reason #=> String
|
5302
|
+
# resp.hook_results[0].invoked_at #=> Time
|
5303
|
+
# resp.hook_results[0].target_type #=> String, one of "CHANGE_SET", "STACK", "RESOURCE", "CLOUD_CONTROL"
|
5304
|
+
# resp.hook_results[0].target_id #=> String
|
5305
|
+
# resp.hook_results[0].type_arn #=> String
|
5306
|
+
# resp.hook_results[0].hook_execution_target #=> String
|
5223
5307
|
# resp.next_token #=> String
|
5224
5308
|
#
|
5225
5309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListHookResults AWS API Documentation
|
@@ -5241,7 +5325,7 @@ module Aws::CloudFormation
|
|
5241
5325
|
#
|
5242
5326
|
#
|
5243
5327
|
#
|
5244
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/
|
5328
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html
|
5245
5329
|
#
|
5246
5330
|
# @option params [required, String] :export_name
|
5247
5331
|
# The name of the exported output value. CloudFormation returns the
|
@@ -5622,7 +5706,7 @@ module Aws::CloudFormation
|
|
5622
5706
|
# </note>
|
5623
5707
|
#
|
5624
5708
|
# @option params [required, String] :stack_set_name
|
5625
|
-
# The name or unique ID of the
|
5709
|
+
# The name or unique ID of the StackSet that you want to list drifted
|
5626
5710
|
# resources for.
|
5627
5711
|
#
|
5628
5712
|
# @option params [String] :next_token
|
@@ -5668,7 +5752,7 @@ module Aws::CloudFormation
|
|
5668
5752
|
# account administrator in the organization's management account or as
|
5669
5753
|
# a delegated administrator in a member account.
|
5670
5754
|
#
|
5671
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5755
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5672
5756
|
# self-managed permissions.
|
5673
5757
|
#
|
5674
5758
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5732,12 +5816,12 @@ module Aws::CloudFormation
|
|
5732
5816
|
end
|
5733
5817
|
|
5734
5818
|
# Returns summary information about stack instances that are associated
|
5735
|
-
# with the specified
|
5819
|
+
# with the specified StackSet. You can filter for stack instances that
|
5736
5820
|
# are associated with a specific Amazon Web Services account name or
|
5737
5821
|
# Region, or that have a specific status.
|
5738
5822
|
#
|
5739
5823
|
# @option params [required, String] :stack_set_name
|
5740
|
-
# The name or unique ID of the
|
5824
|
+
# The name or unique ID of the StackSet that you want to list stack
|
5741
5825
|
# instances for.
|
5742
5826
|
#
|
5743
5827
|
# @option params [String] :next_token
|
@@ -5769,7 +5853,7 @@ module Aws::CloudFormation
|
|
5769
5853
|
# account administrator in the organization's management account or as
|
5770
5854
|
# a delegated administrator in a member account.
|
5771
5855
|
#
|
5772
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5856
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5773
5857
|
# self-managed permissions.
|
5774
5858
|
#
|
5775
5859
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -6011,15 +6095,15 @@ module Aws::CloudFormation
|
|
6011
6095
|
req.send_request(options)
|
6012
6096
|
end
|
6013
6097
|
|
6014
|
-
# Returns summary information about deployment targets for a
|
6098
|
+
# Returns summary information about deployment targets for a StackSet.
|
6015
6099
|
#
|
6016
6100
|
# @option params [required, String] :stack_set_name
|
6017
|
-
# The name or unique ID of the
|
6101
|
+
# The name or unique ID of the StackSet that you want to get automatic
|
6018
6102
|
# deployment targets for.
|
6019
6103
|
#
|
6020
6104
|
# @option params [String] :next_token
|
6021
|
-
# A string that identifies the next page of
|
6022
|
-
#
|
6105
|
+
# A string that identifies the next page of deployment targets that you
|
6106
|
+
# want to retrieve.
|
6023
6107
|
#
|
6024
6108
|
# @option params [Integer] :max_results
|
6025
6109
|
# The maximum number of results to be returned with a single call. If
|
@@ -6080,8 +6164,7 @@ module Aws::CloudFormation
|
|
6080
6164
|
req.send_request(options)
|
6081
6165
|
end
|
6082
6166
|
|
6083
|
-
# Returns summary information about the results of a
|
6084
|
-
# operation.
|
6167
|
+
# Returns summary information about the results of a StackSet operation.
|
6085
6168
|
#
|
6086
6169
|
# <note markdown="1"> This API provides *eventually consistent* reads meaning it may take
|
6087
6170
|
# some time but will eventually return the most up-to-date data.
|
@@ -6089,11 +6172,11 @@ module Aws::CloudFormation
|
|
6089
6172
|
# </note>
|
6090
6173
|
#
|
6091
6174
|
# @option params [required, String] :stack_set_name
|
6092
|
-
# The name or unique ID of the
|
6175
|
+
# The name or unique ID of the StackSet that you want to get operation
|
6093
6176
|
# results for.
|
6094
6177
|
#
|
6095
6178
|
# @option params [required, String] :operation_id
|
6096
|
-
# The ID of the
|
6179
|
+
# The ID of the StackSet operation.
|
6097
6180
|
#
|
6098
6181
|
# @option params [String] :next_token
|
6099
6182
|
# If the previous request didn't return all the remaining results, the
|
@@ -6114,7 +6197,7 @@ module Aws::CloudFormation
|
|
6114
6197
|
# account administrator in the organization's management account or as
|
6115
6198
|
# a delegated administrator in a member account.
|
6116
6199
|
#
|
6117
|
-
# By default, `SELF` is specified. Use `SELF` for
|
6200
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
6118
6201
|
# self-managed permissions.
|
6119
6202
|
#
|
6120
6203
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -6178,7 +6261,7 @@ module Aws::CloudFormation
|
|
6178
6261
|
req.send_request(options)
|
6179
6262
|
end
|
6180
6263
|
|
6181
|
-
# Returns summary information about operations performed on a
|
6264
|
+
# Returns summary information about operations performed on a StackSet.
|
6182
6265
|
#
|
6183
6266
|
# <note markdown="1"> This API provides *eventually consistent* reads meaning it may take
|
6184
6267
|
# some time but will eventually return the most up-to-date data.
|
@@ -6186,7 +6269,7 @@ module Aws::CloudFormation
|
|
6186
6269
|
# </note>
|
6187
6270
|
#
|
6188
6271
|
# @option params [required, String] :stack_set_name
|
6189
|
-
# The name or unique ID of the
|
6272
|
+
# The name or unique ID of the StackSet that you want to get operation
|
6190
6273
|
# summaries for.
|
6191
6274
|
#
|
6192
6275
|
# @option params [String] :next_token
|
@@ -6209,7 +6292,7 @@ module Aws::CloudFormation
|
|
6209
6292
|
# account administrator in the organization's management account or as
|
6210
6293
|
# a delegated administrator in a member account.
|
6211
6294
|
#
|
6212
|
-
# By default, `SELF` is specified. Use `SELF` for
|
6295
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
6213
6296
|
# self-managed permissions.
|
6214
6297
|
#
|
6215
6298
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -6271,7 +6354,7 @@ module Aws::CloudFormation
|
|
6271
6354
|
req.send_request(options)
|
6272
6355
|
end
|
6273
6356
|
|
6274
|
-
# Returns summary information about
|
6357
|
+
# Returns summary information about StackSets that are associated with
|
6275
6358
|
# the user.
|
6276
6359
|
#
|
6277
6360
|
# <note markdown="1"> This API provides *strongly consistent* reads meaning it will always
|
@@ -6281,16 +6364,16 @@ module Aws::CloudFormation
|
|
6281
6364
|
#
|
6282
6365
|
# * \[Self-managed permissions\] If you set the `CallAs` parameter to
|
6283
6366
|
# `SELF` while signed in to your Amazon Web Services account,
|
6284
|
-
# `ListStackSets` returns all self-managed
|
6367
|
+
# `ListStackSets` returns all self-managed StackSets in your Amazon
|
6285
6368
|
# Web Services account.
|
6286
6369
|
#
|
6287
6370
|
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
6288
6371
|
# `SELF` while signed in to the organization's management account,
|
6289
|
-
# `ListStackSets` returns all
|
6372
|
+
# `ListStackSets` returns all StackSets in the management account.
|
6290
6373
|
#
|
6291
6374
|
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
6292
6375
|
# `DELEGATED_ADMIN` while signed in to your member account,
|
6293
|
-
# `ListStackSets` returns all
|
6376
|
+
# `ListStackSets` returns all StackSets with service-managed
|
6294
6377
|
# permissions in the management account.
|
6295
6378
|
#
|
6296
6379
|
# @option params [String] :next_token
|
@@ -6308,7 +6391,7 @@ module Aws::CloudFormation
|
|
6308
6391
|
# request parameter to get the next set of results.
|
6309
6392
|
#
|
6310
6393
|
# @option params [String] :status
|
6311
|
-
# The status of the
|
6394
|
+
# The status of the StackSets that you want to get summary information
|
6312
6395
|
# about.
|
6313
6396
|
#
|
6314
6397
|
# @option params [String] :call_as
|
@@ -6316,7 +6399,7 @@ module Aws::CloudFormation
|
|
6316
6399
|
# account administrator in the management account or as a delegated
|
6317
6400
|
# administrator in a member account.
|
6318
6401
|
#
|
6319
|
-
# By default, `SELF` is specified. Use `SELF` for
|
6402
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
6320
6403
|
# self-managed permissions.
|
6321
6404
|
#
|
6322
6405
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -6593,8 +6676,9 @@ module Aws::CloudFormation
|
|
6593
6676
|
req.send_request(options)
|
6594
6677
|
end
|
6595
6678
|
|
6596
|
-
# Returns summary information about
|
6597
|
-
#
|
6679
|
+
# Returns summary information about all extensions, including your
|
6680
|
+
# private resource types, modules, and Hooks as well as all public
|
6681
|
+
# extensions from Amazon Web Services and third-party publishers.
|
6598
6682
|
#
|
6599
6683
|
# @option params [String] :visibility
|
6600
6684
|
# The scope at which the extensions are visible and usable in
|
@@ -7454,23 +7538,24 @@ module Aws::CloudFormation
|
|
7454
7538
|
req.send_request(options)
|
7455
7539
|
end
|
7456
7540
|
|
7457
|
-
# Stops an in-progress operation on a
|
7541
|
+
# Stops an in-progress operation on a StackSet and its associated stack
|
7458
7542
|
# instances. StackSets will cancel all the unstarted stack instance
|
7459
7543
|
# deployments and wait for those are in-progress to complete.
|
7460
7544
|
#
|
7461
7545
|
# @option params [required, String] :stack_set_name
|
7462
|
-
# The name or unique ID of the
|
7546
|
+
# The name or unique ID of the StackSet that you want to stop the
|
7463
7547
|
# operation for.
|
7464
7548
|
#
|
7465
7549
|
# @option params [required, String] :operation_id
|
7466
7550
|
# The ID of the stack operation.
|
7467
7551
|
#
|
7468
7552
|
# @option params [String] :call_as
|
7469
|
-
#
|
7470
|
-
#
|
7471
|
-
# a
|
7553
|
+
# Specifies whether you are acting as an account administrator in the
|
7554
|
+
# organization's management account or as a delegated administrator in
|
7555
|
+
# a member account. Valid only if the StackSet uses service-managed
|
7556
|
+
# permissions.
|
7472
7557
|
#
|
7473
|
-
# By default, `SELF` is specified. Use `SELF` for
|
7558
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
7474
7559
|
# self-managed permissions.
|
7475
7560
|
#
|
7476
7561
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -8097,18 +8182,18 @@ module Aws::CloudFormation
|
|
8097
8182
|
# accounts where they already exist; to create additional stack
|
8098
8183
|
# instances, use [CreateStackInstances][1].
|
8099
8184
|
#
|
8100
|
-
# During
|
8185
|
+
# During StackSet updates, any parameters overridden for a stack
|
8101
8186
|
# instance aren't updated, but retain their overridden value.
|
8102
8187
|
#
|
8103
8188
|
# You can only update the parameter *values* that are specified in the
|
8104
|
-
#
|
8105
|
-
#
|
8106
|
-
#
|
8107
|
-
#
|
8108
|
-
#
|
8109
|
-
#
|
8110
|
-
#
|
8111
|
-
#
|
8189
|
+
# StackSet. To add or delete a parameter itself, use [UpdateStackSet][2]
|
8190
|
+
# to update the StackSet template. If you add a parameter to a template,
|
8191
|
+
# before you can override the parameter value specified in the StackSet
|
8192
|
+
# you must first use [UpdateStackSet][2] to update all stack instances
|
8193
|
+
# with the updated template and parameter value specified in the
|
8194
|
+
# StackSet. Once a stack instance has been updated with the new
|
8195
|
+
# parameter, you can then override the parameter value using
|
8196
|
+
# `UpdateStackInstances`.
|
8112
8197
|
#
|
8113
8198
|
# <note markdown="1"> The maximum number of organizational unit (OUs) supported by a
|
8114
8199
|
# `UpdateStackInstances` operation is 50.
|
@@ -8130,12 +8215,12 @@ module Aws::CloudFormation
|
|
8130
8215
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
8131
8216
|
#
|
8132
8217
|
# @option params [required, String] :stack_set_name
|
8133
|
-
# The name or unique ID of the
|
8218
|
+
# The name or unique ID of the StackSet associated with the stack
|
8134
8219
|
# instances.
|
8135
8220
|
#
|
8136
8221
|
# @option params [Array<String>] :accounts
|
8137
8222
|
# \[Self-managed permissions\] The account IDs of one or more Amazon Web
|
8138
|
-
# Services accounts
|
8223
|
+
# Services accounts in which you want to update parameter values for
|
8139
8224
|
# stack instances. The overridden parameter values will be applied to
|
8140
8225
|
# all stack instances in the specified accounts and Amazon Web Services
|
8141
8226
|
# Regions.
|
@@ -8143,7 +8228,7 @@ module Aws::CloudFormation
|
|
8143
8228
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
8144
8229
|
#
|
8145
8230
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
8146
|
-
# \[Service-managed permissions\] The Organizations accounts
|
8231
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
8147
8232
|
# you want to update parameter values for stack instances. If your
|
8148
8233
|
# update targets OUs, the overridden parameter values only apply to the
|
8149
8234
|
# accounts that are currently in the target OUs and their child OUs.
|
@@ -8175,22 +8260,22 @@ module Aws::CloudFormation
|
|
8175
8260
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
8176
8261
|
#
|
8177
8262
|
# * To set an overridden parameter back to the value specified in the
|
8178
|
-
#
|
8263
|
+
# StackSet, specify a parameter list but don't include the parameter
|
8179
8264
|
# in the list.
|
8180
8265
|
#
|
8181
8266
|
# * To leave all parameters set to their present values, don't specify
|
8182
8267
|
# this property at all.
|
8183
8268
|
#
|
8184
|
-
# During
|
8269
|
+
# During StackSet updates, any parameter values overridden for a stack
|
8185
8270
|
# instance aren't updated, but retain their overridden value.
|
8186
8271
|
#
|
8187
8272
|
# You can only override the parameter *values* that are specified in the
|
8188
|
-
#
|
8189
|
-
#
|
8190
|
-
#
|
8191
|
-
#
|
8192
|
-
#
|
8193
|
-
#
|
8273
|
+
# StackSet. To add or delete a parameter itself, use `UpdateStackSet` to
|
8274
|
+
# update the StackSet template. If you add a parameter to a template,
|
8275
|
+
# before you can override the parameter value specified in the StackSet
|
8276
|
+
# you must first use [UpdateStackSet][1] to update all stack instances
|
8277
|
+
# with the updated template and parameter value specified in the
|
8278
|
+
# StackSet. Once a stack instance has been updated with the new
|
8194
8279
|
# parameter, you can then override the parameter value using
|
8195
8280
|
# `UpdateStackInstances`.
|
8196
8281
|
#
|
@@ -8199,14 +8284,14 @@ module Aws::CloudFormation
|
|
8199
8284
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
8200
8285
|
#
|
8201
8286
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
8202
|
-
# Preferences for how CloudFormation performs this
|
8287
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
8203
8288
|
#
|
8204
8289
|
# @option params [String] :operation_id
|
8205
|
-
# The unique identifier for this
|
8290
|
+
# The unique identifier for this StackSet operation.
|
8206
8291
|
#
|
8207
8292
|
# The operation ID also functions as an idempotency token, to ensure
|
8208
|
-
# that CloudFormation performs the
|
8209
|
-
#
|
8293
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
8294
|
+
# you retry the request multiple times. You might retry StackSet
|
8210
8295
|
# operation requests to ensure that CloudFormation successfully received
|
8211
8296
|
# them.
|
8212
8297
|
#
|
@@ -8221,7 +8306,7 @@ module Aws::CloudFormation
|
|
8221
8306
|
# account administrator in the organization's management account or as
|
8222
8307
|
# a delegated administrator in a member account.
|
8223
8308
|
#
|
8224
|
-
# By default, `SELF` is specified. Use `SELF` for
|
8309
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
8225
8310
|
# self-managed permissions.
|
8226
8311
|
#
|
8227
8312
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -8288,14 +8373,14 @@ module Aws::CloudFormation
|
|
8288
8373
|
req.send_request(options)
|
8289
8374
|
end
|
8290
8375
|
|
8291
|
-
# Updates the
|
8376
|
+
# Updates the StackSet and associated stack instances in the specified
|
8292
8377
|
# accounts and Amazon Web Services Regions.
|
8293
8378
|
#
|
8294
|
-
# Even if the
|
8295
|
-
#
|
8296
|
-
# tolerance), the
|
8297
|
-
# CreateStackInstances calls on the specified
|
8298
|
-
#
|
8379
|
+
# Even if the StackSet operation created by updating the StackSet fails
|
8380
|
+
# (completely or partially, below or above a specified failure
|
8381
|
+
# tolerance), the StackSet is updated with your changes. Subsequent
|
8382
|
+
# CreateStackInstances calls on the specified StackSet use the updated
|
8383
|
+
# StackSet.
|
8299
8384
|
#
|
8300
8385
|
# <note markdown="1"> The maximum number of organizational unit (OUs) supported by a
|
8301
8386
|
# `UpdateStackSet` operation is 50.
|
@@ -8312,7 +8397,7 @@ module Aws::CloudFormation
|
|
8312
8397
|
# </note>
|
8313
8398
|
#
|
8314
8399
|
# @option params [required, String] :stack_set_name
|
8315
|
-
# The name or unique ID of the
|
8400
|
+
# The name or unique ID of the StackSet that you want to update.
|
8316
8401
|
#
|
8317
8402
|
# @option params [String] :description
|
8318
8403
|
# A brief description of updates that you are making.
|
@@ -8335,19 +8420,19 @@ module Aws::CloudFormation
|
|
8335
8420
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
8336
8421
|
#
|
8337
8422
|
# @option params [Boolean] :use_previous_template
|
8338
|
-
# Use the existing template that's associated with the
|
8423
|
+
# Use the existing template that's associated with the StackSet that
|
8339
8424
|
# you're updating.
|
8340
8425
|
#
|
8341
8426
|
# Conditional: You must specify only one of the following parameters:
|
8342
8427
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
8343
8428
|
#
|
8344
8429
|
# @option params [Array<Types::Parameter>] :parameters
|
8345
|
-
# A list of input parameters for the
|
8430
|
+
# A list of input parameters for the StackSet template.
|
8346
8431
|
#
|
8347
8432
|
# @option params [Array<String>] :capabilities
|
8348
8433
|
# In some cases, you must explicitly acknowledge that your stack
|
8349
8434
|
# template contains certain capabilities in order for CloudFormation to
|
8350
|
-
# update the
|
8435
|
+
# update the StackSet and its associated stack instances.
|
8351
8436
|
#
|
8352
8437
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
8353
8438
|
#
|
@@ -8388,21 +8473,20 @@ module Aws::CloudFormation
|
|
8388
8473
|
#
|
8389
8474
|
# * `CAPABILITY_AUTO_EXPAND`
|
8390
8475
|
#
|
8391
|
-
# Some templates reference macros. If your
|
8392
|
-
# references one or more macros, you must update the
|
8393
|
-
#
|
8394
|
-
#
|
8395
|
-
#
|
8396
|
-
#
|
8476
|
+
# Some templates reference macros. If your StackSet template
|
8477
|
+
# references one or more macros, you must update the StackSet directly
|
8478
|
+
# from the processed template, without first reviewing the resulting
|
8479
|
+
# changes in a change set. To update the StackSet directly, you must
|
8480
|
+
# acknowledge this capability. For more information, see [Perform
|
8481
|
+
# custom processing on CloudFormation templates with template
|
8397
8482
|
# macros][9].
|
8398
8483
|
#
|
8399
|
-
#
|
8484
|
+
# StackSets with service-managed permissions do not currently support
|
8400
8485
|
# the use of macros in templates. (This includes the
|
8401
8486
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
8402
8487
|
# macros hosted by CloudFormation.) Even if you specify this
|
8403
|
-
# capability for a
|
8404
|
-
# reference a macro in your template the
|
8405
|
-
# fail.
|
8488
|
+
# capability for a StackSet with service-managed permissions, if you
|
8489
|
+
# reference a macro in your template the StackSet operation will fail.
|
8406
8490
|
#
|
8407
8491
|
#
|
8408
8492
|
#
|
@@ -8419,23 +8503,23 @@ module Aws::CloudFormation
|
|
8419
8503
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
8420
8504
|
#
|
8421
8505
|
# @option params [Array<Types::Tag>] :tags
|
8422
|
-
# The key-value pairs to associate with this
|
8506
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
8423
8507
|
# created from it. CloudFormation also propagates these tags to
|
8424
8508
|
# supported resources that are created in the stacks. You can specify a
|
8425
8509
|
# maximum number of 50 tags.
|
8426
8510
|
#
|
8427
8511
|
# If you specify tags for this parameter, those tags replace any list of
|
8428
|
-
# tags that are currently associated with this
|
8512
|
+
# tags that are currently associated with this StackSet. This means:
|
8429
8513
|
#
|
8430
8514
|
# * If you don't specify this parameter, CloudFormation doesn't modify
|
8431
8515
|
# the stack's tags.
|
8432
8516
|
#
|
8433
8517
|
# * If you specify *any* tags using this parameter, you must specify
|
8434
|
-
# *all* the tags that you want associated with this
|
8435
|
-
# tags you've specified before (for example, when creating the
|
8436
|
-
#
|
8437
|
-
# you don't include in the updated list of tags are removed from
|
8438
|
-
#
|
8518
|
+
# *all* the tags that you want associated with this StackSet, even
|
8519
|
+
# tags you've specified before (for example, when creating the
|
8520
|
+
# StackSet or during a previous update of the StackSet.). Any tags
|
8521
|
+
# that you don't include in the updated list of tags are removed from
|
8522
|
+
# the StackSet, and therefore from the stacks and resources as well.
|
8439
8523
|
#
|
8440
8524
|
# * If you specify an empty value, CloudFormation removes all currently
|
8441
8525
|
# associated tags.
|
@@ -8443,28 +8527,28 @@ module Aws::CloudFormation
|
|
8443
8527
|
# If you specify new tags as part of an `UpdateStackSet` action,
|
8444
8528
|
# CloudFormation checks to see if you have the required IAM permission
|
8445
8529
|
# to tag resources. If you omit tags that are currently associated with
|
8446
|
-
# the
|
8447
|
-
#
|
8448
|
-
#
|
8449
|
-
#
|
8450
|
-
#
|
8530
|
+
# the StackSet from the list of tags you specify, CloudFormation assumes
|
8531
|
+
# that you want to remove those tags from the StackSet, and checks to
|
8532
|
+
# see if you have permission to untag resources. If you don't have the
|
8533
|
+
# necessary permission(s), the entire `UpdateStackSet` action fails with
|
8534
|
+
# an `access denied` error, and the StackSet is not updated.
|
8451
8535
|
#
|
8452
8536
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
8453
|
-
# Preferences for how CloudFormation performs this
|
8537
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
8454
8538
|
#
|
8455
8539
|
# @option params [String] :administration_role_arn
|
8456
8540
|
# \[Self-managed permissions\] The Amazon Resource Name (ARN) of the IAM
|
8457
|
-
# role to use to update this
|
8541
|
+
# role to use to update this StackSet.
|
8458
8542
|
#
|
8459
8543
|
# Specify an IAM role only if you are using customized administrator
|
8460
|
-
# roles to control which users or groups can manage specific
|
8544
|
+
# roles to control which users or groups can manage specific StackSets
|
8461
8545
|
# within the same administrator account. For more information, see
|
8462
8546
|
# [Grant self-managed permissions][1] in the *CloudFormation User
|
8463
8547
|
# Guide*.
|
8464
8548
|
#
|
8465
8549
|
# If you specified a customized administrator role when you created the
|
8466
|
-
#
|
8467
|
-
#
|
8550
|
+
# StackSet, you must specify a customized administrator role, even if it
|
8551
|
+
# is the same customized administrator role used with this StackSet
|
8468
8552
|
# previously.
|
8469
8553
|
#
|
8470
8554
|
#
|
@@ -8475,36 +8559,36 @@ module Aws::CloudFormation
|
|
8475
8559
|
# \[Self-managed permissions\] The name of the IAM execution role to use
|
8476
8560
|
# to update the stack set. If you do not specify an execution role,
|
8477
8561
|
# CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role
|
8478
|
-
# for the
|
8562
|
+
# for the StackSet operation.
|
8479
8563
|
#
|
8480
8564
|
# Specify an IAM role only if you are using customized execution roles
|
8481
8565
|
# to control which stack resources users and groups can include in their
|
8482
|
-
#
|
8566
|
+
# StackSets.
|
8483
8567
|
#
|
8484
8568
|
# If you specify a customized execution role, CloudFormation uses that
|
8485
8569
|
# role to update the stack. If you do not specify a customized execution
|
8486
8570
|
# role, CloudFormation performs the update using the role previously
|
8487
|
-
# associated with the
|
8488
|
-
# perform operations on the
|
8571
|
+
# associated with the StackSet, so long as you have permissions to
|
8572
|
+
# perform operations on the StackSet.
|
8489
8573
|
#
|
8490
8574
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
8491
8575
|
# \[Service-managed permissions\] The Organizations accounts in which to
|
8492
8576
|
# update associated stack instances.
|
8493
8577
|
#
|
8494
|
-
# To update all the stack instances associated with this
|
8578
|
+
# To update all the stack instances associated with this StackSet, do
|
8495
8579
|
# not specify `DeploymentTargets` or `Regions`.
|
8496
8580
|
#
|
8497
|
-
# If the
|
8581
|
+
# If the StackSet update includes changes to the template (that is, if
|
8498
8582
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
8499
8583
|
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
8500
8584
|
# prior to updating the stack instances in the specified accounts and
|
8501
|
-
# Amazon Web Services Regions. If the
|
8585
|
+
# Amazon Web Services Regions. If the StackSet update doesn't include
|
8502
8586
|
# changes to the template or parameters, CloudFormation updates the
|
8503
8587
|
# stack instances in the specified accounts and Regions, while leaving
|
8504
8588
|
# all other stack instances with their existing stack instance status.
|
8505
8589
|
#
|
8506
8590
|
# @option params [String] :permission_model
|
8507
|
-
# Describes how the IAM roles required for
|
8591
|
+
# Describes how the IAM roles required for StackSet operations are
|
8508
8592
|
# created. You cannot modify `PermissionModel` if there are stack
|
8509
8593
|
# instances associated with your stack set.
|
8510
8594
|
#
|
@@ -8515,7 +8599,7 @@ module Aws::CloudFormation
|
|
8515
8599
|
# * With `service-managed` permissions, StackSets automatically creates
|
8516
8600
|
# the IAM roles required to deploy to accounts managed by
|
8517
8601
|
# Organizations. For more information, see [Activate trusted access
|
8518
|
-
# for
|
8602
|
+
# for StackSets with Organizations][2].
|
8519
8603
|
#
|
8520
8604
|
#
|
8521
8605
|
#
|
@@ -8526,9 +8610,8 @@ module Aws::CloudFormation
|
|
8526
8610
|
# \[Service-managed permissions\] Describes whether StackSets
|
8527
8611
|
# automatically deploys to Organizations accounts that are added to a
|
8528
8612
|
# target organization or organizational unit (OU). For more information,
|
8529
|
-
# see [
|
8530
|
-
#
|
8531
|
-
# Guide*.
|
8613
|
+
# see [Enable or disable automatic deployments for StackSets in
|
8614
|
+
# Organizations][1] in the *CloudFormation User Guide*.
|
8532
8615
|
#
|
8533
8616
|
# If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
|
8534
8617
|
# `Regions`.
|
@@ -8538,18 +8621,18 @@ module Aws::CloudFormation
|
|
8538
8621
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html
|
8539
8622
|
#
|
8540
8623
|
# @option params [String] :operation_id
|
8541
|
-
# The unique ID for this
|
8624
|
+
# The unique ID for this StackSet operation.
|
8542
8625
|
#
|
8543
8626
|
# The operation ID also functions as an idempotency token, to ensure
|
8544
|
-
# that CloudFormation performs the
|
8545
|
-
#
|
8627
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
8628
|
+
# you retry the request multiple times. You might retry StackSet
|
8546
8629
|
# operation requests to ensure that CloudFormation successfully received
|
8547
8630
|
# them.
|
8548
8631
|
#
|
8549
8632
|
# If you don't specify an operation ID, CloudFormation generates one
|
8550
8633
|
# automatically.
|
8551
8634
|
#
|
8552
|
-
# Repeating this
|
8635
|
+
# Repeating this StackSet operation with a new operation ID retries all
|
8553
8636
|
# stack instances whose status is `OUTDATED`.
|
8554
8637
|
#
|
8555
8638
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -8558,17 +8641,17 @@ module Aws::CloudFormation
|
|
8558
8641
|
# @option params [Array<String>] :accounts
|
8559
8642
|
# \[Self-managed permissions\] The accounts in which to update
|
8560
8643
|
# associated stack instances. If you specify accounts, you must also
|
8561
|
-
# specify the Amazon Web Services Regions in which to update
|
8644
|
+
# specify the Amazon Web Services Regions in which to update StackSet
|
8562
8645
|
# instances.
|
8563
8646
|
#
|
8564
|
-
# To update *all* the stack instances associated with this
|
8647
|
+
# To update *all* the stack instances associated with this StackSet,
|
8565
8648
|
# don't specify the `Accounts` or `Regions` properties.
|
8566
8649
|
#
|
8567
|
-
# If the
|
8650
|
+
# If the StackSet update includes changes to the template (that is, if
|
8568
8651
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
8569
8652
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
8570
8653
|
# status of `OUTDATED` prior to updating the stack instances in the
|
8571
|
-
# specified accounts and Amazon Web Services Regions. If the
|
8654
|
+
# specified accounts and Amazon Web Services Regions. If the StackSet
|
8572
8655
|
# update does not include changes to the template or parameters,
|
8573
8656
|
# CloudFormation updates the stack instances in the specified accounts
|
8574
8657
|
# and Amazon Web Services Regions, while leaving all other stack
|
@@ -8577,16 +8660,16 @@ module Aws::CloudFormation
|
|
8577
8660
|
# @option params [Array<String>] :regions
|
8578
8661
|
# The Amazon Web Services Regions in which to update associated stack
|
8579
8662
|
# instances. If you specify Regions, you must also specify accounts in
|
8580
|
-
# which to update
|
8663
|
+
# which to update StackSet instances.
|
8581
8664
|
#
|
8582
|
-
# To update *all* the stack instances associated with this
|
8665
|
+
# To update *all* the stack instances associated with this StackSet, do
|
8583
8666
|
# not specify the `Accounts` or `Regions` properties.
|
8584
8667
|
#
|
8585
|
-
# If the
|
8668
|
+
# If the StackSet update includes changes to the template (that is, if
|
8586
8669
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
8587
8670
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
8588
8671
|
# status of `OUTDATED` prior to updating the stack instances in the
|
8589
|
-
# specified accounts and Regions. If the
|
8672
|
+
# specified accounts and Regions. If the StackSet update does not
|
8590
8673
|
# include changes to the template or parameters, CloudFormation updates
|
8591
8674
|
# the stack instances in the specified accounts and Regions, while
|
8592
8675
|
# leaving all other stack instances with their existing stack instance
|
@@ -8597,7 +8680,7 @@ module Aws::CloudFormation
|
|
8597
8680
|
# account administrator in the organization's management account or as
|
8598
8681
|
# a delegated administrator in a member account.
|
8599
8682
|
#
|
8600
|
-
# By default, `SELF` is specified. Use `SELF` for
|
8683
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
8601
8684
|
# self-managed permissions.
|
8602
8685
|
#
|
8603
8686
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -8615,7 +8698,7 @@ module Aws::CloudFormation
|
|
8615
8698
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
8616
8699
|
#
|
8617
8700
|
# @option params [Types::ManagedExecution] :managed_execution
|
8618
|
-
# Describes whether
|
8701
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
8619
8702
|
# concurrently and queues conflicting operations.
|
8620
8703
|
#
|
8621
8704
|
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -8811,7 +8894,7 @@ module Aws::CloudFormation
|
|
8811
8894
|
tracer: tracer
|
8812
8895
|
)
|
8813
8896
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
8814
|
-
context[:gem_version] = '1.
|
8897
|
+
context[:gem_version] = '1.140.0'
|
8815
8898
|
Seahorse::Client::Request.new(handlers, context)
|
8816
8899
|
end
|
8817
8900
|
|