aws-sdk-cloudformation 1.139.0 → 1.141.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +400 -306
- data/lib/aws-sdk-cloudformation/client_api.rb +13 -2
- data/lib/aws-sdk-cloudformation/customizations.rb +0 -8
- 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 +617 -544
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/client.rbs +5 -3
- data/sig/event.rbs +3 -0
- data/sig/types.rbs +10 -1
- metadata +1 -1
@@ -11,20 +11,20 @@ module Aws::CloudFormation
|
|
11
11
|
module Types
|
12
12
|
|
13
13
|
# Structure that contains the results of the account gate function which
|
14
|
-
# CloudFormation invokes, if present, before proceeding with a
|
14
|
+
# CloudFormation invokes, if present, before proceeding with a StackSet
|
15
15
|
# operation in an account and Region.
|
16
16
|
#
|
17
17
|
# For each account and Region, CloudFormation lets you specify a Lambda
|
18
18
|
# function that encapsulates any requirements that must be met before
|
19
|
-
# CloudFormation can proceed with a
|
20
|
-
# and Region. CloudFormation invokes the function each time a
|
19
|
+
# CloudFormation can proceed with a StackSet operation in that account
|
20
|
+
# and Region. CloudFormation invokes the function each time a StackSet
|
21
21
|
# operation is requested for that account and Region; if the function
|
22
22
|
# returns `FAILED`, CloudFormation cancels the operation in that account
|
23
|
-
# and Region, and sets the
|
23
|
+
# and Region, and sets the StackSet operation result status for that
|
24
24
|
# account and Region to `FAILED`.
|
25
25
|
#
|
26
|
-
# For more information, see [
|
27
|
-
#
|
26
|
+
# For more information, see [Prevent failed StackSets deployments using
|
27
|
+
# target account gates][1] in the *CloudFormation User Guide*.
|
28
28
|
#
|
29
29
|
#
|
30
30
|
#
|
@@ -34,37 +34,37 @@ module Aws::CloudFormation
|
|
34
34
|
# The status of the account gate function.
|
35
35
|
#
|
36
36
|
# * `SUCCEEDED`: The account gate function has determined that the
|
37
|
-
# account and Region passes any requirements for a
|
37
|
+
# account and Region passes any requirements for a StackSet
|
38
38
|
# operation to occur. CloudFormation proceeds with the stack
|
39
39
|
# operation in that account and Region.
|
40
40
|
#
|
41
41
|
# * `FAILED`: The account gate function has determined that the
|
42
|
-
# account and Region doesn't meet the requirements for a
|
43
|
-
# operation to occur. CloudFormation cancels the
|
44
|
-
# in that account and Region, and sets the
|
45
|
-
#
|
42
|
+
# account and Region doesn't meet the requirements for a StackSet
|
43
|
+
# operation to occur. CloudFormation cancels the StackSet operation
|
44
|
+
# in that account and Region, and sets the StackSet operation result
|
45
|
+
# status for that account and Region to `FAILED`.
|
46
46
|
#
|
47
47
|
# * `SKIPPED`: CloudFormation has skipped calling the account gate
|
48
48
|
# function for this account and Region, for one of the following
|
49
49
|
# reasons:
|
50
50
|
#
|
51
51
|
# * An account gate function hasn't been specified for the account
|
52
|
-
# and Region. CloudFormation proceeds with the
|
52
|
+
# and Region. CloudFormation proceeds with the StackSet operation
|
53
53
|
# in this account and Region.
|
54
54
|
#
|
55
|
-
# * The `AWSCloudFormationStackSetExecutionRole` of the
|
55
|
+
# * The `AWSCloudFormationStackSetExecutionRole` of the
|
56
56
|
# administration account lacks permissions to invoke the function.
|
57
|
-
# CloudFormation proceeds with the
|
57
|
+
# CloudFormation proceeds with the StackSet operation in this
|
58
58
|
# account and Region.
|
59
59
|
#
|
60
60
|
# * Either no action is necessary, or no action is possible, on the
|
61
|
-
# stack. CloudFormation skips the
|
61
|
+
# stack. CloudFormation skips the StackSet operation in this
|
62
62
|
# account and Region.
|
63
63
|
# @return [String]
|
64
64
|
#
|
65
65
|
# @!attribute [rw] status_reason
|
66
66
|
# The reason for the account gate status assigned to this account and
|
67
|
-
# Region for the
|
67
|
+
# Region for the StackSet operation.
|
68
68
|
# @return [String]
|
69
69
|
#
|
70
70
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/AccountGateResult AWS API Documentation
|
@@ -76,7 +76,7 @@ module Aws::CloudFormation
|
|
76
76
|
include Aws::Structure
|
77
77
|
end
|
78
78
|
|
79
|
-
#
|
79
|
+
# Describes the current CloudFormation limits for your account.
|
80
80
|
#
|
81
81
|
# CloudFormation has the following limits per account:
|
82
82
|
#
|
@@ -86,9 +86,8 @@ module Aws::CloudFormation
|
|
86
86
|
#
|
87
87
|
# * Number of stack outputs
|
88
88
|
#
|
89
|
-
# For more information
|
90
|
-
# CloudFormation
|
91
|
-
# the *CloudFormation User Guide*.
|
89
|
+
# For more information, see [Understand CloudFormation quotas][1] in the
|
90
|
+
# *CloudFormation User Guide*.
|
92
91
|
#
|
93
92
|
#
|
94
93
|
#
|
@@ -153,7 +152,7 @@ module Aws::CloudFormation
|
|
153
152
|
# @return [String]
|
154
153
|
#
|
155
154
|
# @!attribute [rw] type_name_alias
|
156
|
-
# An alias to assign to the public extension
|
155
|
+
# An alias to assign to the public extension in this account and
|
157
156
|
# Region. If you specify an alias for the extension, CloudFormation
|
158
157
|
# treats the alias as the extension type name within this account and
|
159
158
|
# Region. You must use the alias to refer to the extension in your
|
@@ -220,7 +219,7 @@ module Aws::CloudFormation
|
|
220
219
|
end
|
221
220
|
|
222
221
|
# @!attribute [rw] arn
|
223
|
-
# The Amazon Resource Name (ARN) of the activated extension
|
222
|
+
# The Amazon Resource Name (ARN) of the activated extension in this
|
224
223
|
# account and Region.
|
225
224
|
# @return [String]
|
226
225
|
#
|
@@ -238,9 +237,15 @@ module Aws::CloudFormation
|
|
238
237
|
#
|
239
238
|
class AlreadyExistsException < Aws::EmptyStructure; end
|
240
239
|
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
240
|
+
# Describes whether StackSets automatically deploys to Organizations
|
241
|
+
# accounts that are added to a target organization or organizational
|
242
|
+
# unit (OU). For more information, see [Enable or disable automatic
|
243
|
+
# deployments for StackSets in Organizations][1] in the *CloudFormation
|
244
|
+
# User Guide*.
|
245
|
+
#
|
246
|
+
#
|
247
|
+
#
|
248
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html
|
244
249
|
#
|
245
250
|
# @!attribute [rw] enabled
|
246
251
|
# If set to `true`, StackSets automatically deploys additional stack
|
@@ -409,14 +414,15 @@ module Aws::CloudFormation
|
|
409
414
|
include Aws::Structure
|
410
415
|
end
|
411
416
|
|
412
|
-
# Specifies the resource, the
|
417
|
+
# Specifies the resource, the Hook, and the Hook version to be invoked.
|
413
418
|
#
|
414
419
|
# @!attribute [rw] invocation_point
|
415
|
-
#
|
420
|
+
# The specific point in the provisioning process where the Hook is
|
421
|
+
# invoked.
|
416
422
|
# @return [String]
|
417
423
|
#
|
418
424
|
# @!attribute [rw] failure_mode
|
419
|
-
# Specify the
|
425
|
+
# Specify the Hook failure mode for non-compliant resources in the
|
420
426
|
# followings ways.
|
421
427
|
#
|
422
428
|
# * `FAIL` Stops provisioning resources.
|
@@ -425,12 +431,12 @@ module Aws::CloudFormation
|
|
425
431
|
# @return [String]
|
426
432
|
#
|
427
433
|
# @!attribute [rw] type_name
|
428
|
-
# The unique name for your
|
429
|
-
# your
|
434
|
+
# The unique name for your Hook. Specifies a three-part namespace for
|
435
|
+
# your Hook, with a recommended pattern of
|
430
436
|
# `Organization::Service::Hook`.
|
431
437
|
#
|
432
438
|
# <note markdown="1"> The following organization namespaces are reserved and can't be
|
433
|
-
# used in your
|
439
|
+
# used in your Hook type names:
|
434
440
|
#
|
435
441
|
# * `Alexa`
|
436
442
|
#
|
@@ -458,7 +464,7 @@ module Aws::CloudFormation
|
|
458
464
|
# @return [String]
|
459
465
|
#
|
460
466
|
# @!attribute [rw] target_details
|
461
|
-
# Specifies details about the target that the
|
467
|
+
# Specifies details about the target that the Hook will run against.
|
462
468
|
# @return [Types::ChangeSetHookTargetDetails]
|
463
469
|
#
|
464
470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ChangeSetHook AWS API Documentation
|
@@ -499,7 +505,7 @@ module Aws::CloudFormation
|
|
499
505
|
include Aws::Structure
|
500
506
|
end
|
501
507
|
|
502
|
-
# Specifies target details for an activated
|
508
|
+
# Specifies target details for an activated Hook.
|
503
509
|
#
|
504
510
|
# @!attribute [rw] target_type
|
505
511
|
# The name of the type.
|
@@ -1301,6 +1307,14 @@ module Aws::CloudFormation
|
|
1301
1307
|
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can
|
1302
1308
|
# specify either `OnFailure` or `DisableRollback`, but not both.
|
1303
1309
|
#
|
1310
|
+
# <note markdown="1"> Although the default setting is `ROLLBACK`, there is one exception.
|
1311
|
+
# This exception occurs when a StackSet attempts to deploy a stack
|
1312
|
+
# instance and the stack instance fails to create successfully. In
|
1313
|
+
# this case, the `CreateStack` call overrides the default setting and
|
1314
|
+
# sets the value of `OnFailure` to `DELETE`.
|
1315
|
+
#
|
1316
|
+
# </note>
|
1317
|
+
#
|
1304
1318
|
# Default: `ROLLBACK`
|
1305
1319
|
# @return [String]
|
1306
1320
|
#
|
@@ -1405,7 +1419,7 @@ module Aws::CloudFormation
|
|
1405
1419
|
end
|
1406
1420
|
|
1407
1421
|
# @!attribute [rw] stack_set_name
|
1408
|
-
# The name or unique ID of the
|
1422
|
+
# The name or unique ID of the StackSet that you want to create stack
|
1409
1423
|
# instances from.
|
1410
1424
|
# @return [String]
|
1411
1425
|
#
|
@@ -1418,7 +1432,7 @@ module Aws::CloudFormation
|
|
1418
1432
|
# @return [Array<String>]
|
1419
1433
|
#
|
1420
1434
|
# @!attribute [rw] deployment_targets
|
1421
|
-
# \[Service-managed permissions\] The Organizations accounts
|
1435
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
1422
1436
|
# to create stack instances in the specified Amazon Web Services
|
1423
1437
|
# Regions.
|
1424
1438
|
#
|
@@ -1432,7 +1446,7 @@ module Aws::CloudFormation
|
|
1432
1446
|
# @return [Array<String>]
|
1433
1447
|
#
|
1434
1448
|
# @!attribute [rw] parameter_overrides
|
1435
|
-
# A list of
|
1449
|
+
# A list of StackSet parameters whose values you want to override in
|
1436
1450
|
# the selected stack instances.
|
1437
1451
|
#
|
1438
1452
|
# Any overridden parameter values will be applied to all stack
|
@@ -1449,18 +1463,18 @@ module Aws::CloudFormation
|
|
1449
1463
|
# can't specify both a value and set `UsePreviousValue` to `true`.)
|
1450
1464
|
#
|
1451
1465
|
# * To set an overridden parameter back to the value specified in the
|
1452
|
-
#
|
1466
|
+
# StackSet, specify a parameter list but don't include the
|
1453
1467
|
# parameter in the list.
|
1454
1468
|
#
|
1455
1469
|
# * To leave all parameters set to their present values, don't
|
1456
1470
|
# specify this property at all.
|
1457
1471
|
#
|
1458
|
-
# During
|
1459
|
-
#
|
1472
|
+
# During StackSet updates, any parameter values overridden for a stack
|
1473
|
+
# instance aren't updated, but retain their overridden value.
|
1460
1474
|
#
|
1461
1475
|
# You can only override the parameter *values* that are specified in
|
1462
|
-
# the
|
1463
|
-
# [UpdateStackSet][1] to update the
|
1476
|
+
# the StackSet; to add or delete a parameter itself, use
|
1477
|
+
# [UpdateStackSet][1] to update the StackSet template.
|
1464
1478
|
#
|
1465
1479
|
#
|
1466
1480
|
#
|
@@ -1468,23 +1482,22 @@ module Aws::CloudFormation
|
|
1468
1482
|
# @return [Array<Types::Parameter>]
|
1469
1483
|
#
|
1470
1484
|
# @!attribute [rw] operation_preferences
|
1471
|
-
# Preferences for how CloudFormation performs this
|
1472
|
-
# operation.
|
1485
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
1473
1486
|
# @return [Types::StackSetOperationPreferences]
|
1474
1487
|
#
|
1475
1488
|
# @!attribute [rw] operation_id
|
1476
|
-
# The unique identifier for this
|
1489
|
+
# The unique identifier for this StackSet operation.
|
1477
1490
|
#
|
1478
1491
|
# The operation ID also functions as an idempotency token, to ensure
|
1479
|
-
# that CloudFormation performs the
|
1480
|
-
# if you retry the request multiple times. You might retry
|
1492
|
+
# that CloudFormation performs the StackSet operation only once, even
|
1493
|
+
# if you retry the request multiple times. You might retry StackSet
|
1481
1494
|
# operation requests to ensure that CloudFormation successfully
|
1482
1495
|
# received them.
|
1483
1496
|
#
|
1484
1497
|
# If you don't specify an operation ID, the SDK generates one
|
1485
1498
|
# automatically.
|
1486
1499
|
#
|
1487
|
-
# Repeating this
|
1500
|
+
# Repeating this StackSet operation with a new operation ID retries
|
1488
1501
|
# all stack instances whose status is `OUTDATED`.
|
1489
1502
|
#
|
1490
1503
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -1496,7 +1509,7 @@ module Aws::CloudFormation
|
|
1496
1509
|
# an account administrator in the organization's management account
|
1497
1510
|
# or as a delegated administrator in a member account.
|
1498
1511
|
#
|
1499
|
-
# By default, `SELF` is specified. Use `SELF` for
|
1512
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
1500
1513
|
# self-managed permissions.
|
1501
1514
|
#
|
1502
1515
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -1530,7 +1543,7 @@ module Aws::CloudFormation
|
|
1530
1543
|
end
|
1531
1544
|
|
1532
1545
|
# @!attribute [rw] operation_id
|
1533
|
-
# The unique identifier for this
|
1546
|
+
# The unique identifier for this StackSet operation.
|
1534
1547
|
# @return [String]
|
1535
1548
|
#
|
1536
1549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstancesOutput AWS API Documentation
|
@@ -1597,8 +1610,8 @@ module Aws::CloudFormation
|
|
1597
1610
|
end
|
1598
1611
|
|
1599
1612
|
# @!attribute [rw] stack_set_name
|
1600
|
-
# The name to associate with the
|
1601
|
-
# the Region where you create your
|
1613
|
+
# The name to associate with the StackSet. The name must be unique in
|
1614
|
+
# the Region where you create your StackSet.
|
1602
1615
|
#
|
1603
1616
|
# <note markdown="1"> A stack name can contain only alphanumeric characters
|
1604
1617
|
# (case-sensitive) and hyphens. It must start with an alphabetic
|
@@ -1608,8 +1621,8 @@ module Aws::CloudFormation
|
|
1608
1621
|
# @return [String]
|
1609
1622
|
#
|
1610
1623
|
# @!attribute [rw] description
|
1611
|
-
# A description of the
|
1612
|
-
# identify the
|
1624
|
+
# A description of the StackSet. You can use the description to
|
1625
|
+
# identify the StackSet's purpose or other important information.
|
1613
1626
|
# @return [String]
|
1614
1627
|
#
|
1615
1628
|
# @!attribute [rw] template_body
|
@@ -1632,24 +1645,24 @@ module Aws::CloudFormation
|
|
1632
1645
|
# @return [String]
|
1633
1646
|
#
|
1634
1647
|
# @!attribute [rw] stack_id
|
1635
|
-
# The stack ID you are importing into a new
|
1648
|
+
# The stack ID you are importing into a new StackSet. Specify the
|
1636
1649
|
# Amazon Resource Name (ARN) of the stack.
|
1637
1650
|
# @return [String]
|
1638
1651
|
#
|
1639
1652
|
# @!attribute [rw] parameters
|
1640
|
-
# The input parameters for the
|
1653
|
+
# The input parameters for the StackSet template.
|
1641
1654
|
# @return [Array<Types::Parameter>]
|
1642
1655
|
#
|
1643
1656
|
# @!attribute [rw] capabilities
|
1644
|
-
# In some cases, you must explicitly acknowledge that your
|
1657
|
+
# In some cases, you must explicitly acknowledge that your StackSet
|
1645
1658
|
# template contains certain capabilities in order for CloudFormation
|
1646
|
-
# to create the
|
1659
|
+
# to create the StackSet and related stack instances.
|
1647
1660
|
#
|
1648
1661
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
1649
1662
|
#
|
1650
1663
|
# Some stack templates might include resources that can affect
|
1651
1664
|
# permissions in your Amazon Web Services account; for example, by
|
1652
|
-
# creating new IAM users. For those
|
1665
|
+
# creating new IAM users. For those StackSets, you must explicitly
|
1653
1666
|
# acknowledge this by specifying one of these capabilities.
|
1654
1667
|
#
|
1655
1668
|
# The following IAM resources require you to specify either the
|
@@ -1684,21 +1697,21 @@ module Aws::CloudFormation
|
|
1684
1697
|
#
|
1685
1698
|
# * `CAPABILITY_AUTO_EXPAND`
|
1686
1699
|
#
|
1687
|
-
# Some templates reference macros. If your
|
1688
|
-
# references one or more macros, you must create the
|
1700
|
+
# Some templates reference macros. If your StackSet template
|
1701
|
+
# references one or more macros, you must create the StackSet
|
1689
1702
|
# directly from the processed template, without first reviewing the
|
1690
|
-
# resulting changes in a change set. To create the
|
1703
|
+
# resulting changes in a change set. To create the StackSet
|
1691
1704
|
# directly, you must acknowledge this capability. For more
|
1692
1705
|
# information, see [Perform custom processing on CloudFormation
|
1693
1706
|
# templates with template macros][9].
|
1694
1707
|
#
|
1695
|
-
#
|
1708
|
+
# StackSets with service-managed permissions don't currently
|
1696
1709
|
# support the use of macros in templates. (This includes the
|
1697
1710
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1698
1711
|
# macros hosted by CloudFormation.) Even if you specify this
|
1699
|
-
# capability for a
|
1700
|
-
#
|
1701
|
-
#
|
1712
|
+
# capability for a StackSet with service-managed permissions, if you
|
1713
|
+
# reference a macro in your template the StackSet operation will
|
1714
|
+
# fail.
|
1702
1715
|
#
|
1703
1716
|
#
|
1704
1717
|
#
|
@@ -1716,7 +1729,7 @@ module Aws::CloudFormation
|
|
1716
1729
|
# @return [Array<String>]
|
1717
1730
|
#
|
1718
1731
|
# @!attribute [rw] tags
|
1719
|
-
# The key-value pairs to associate with this
|
1732
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
1720
1733
|
# created from it. CloudFormation also propagates these tags to
|
1721
1734
|
# supported resources that are created in the stacks. A maximum number
|
1722
1735
|
# of 50 tags can be specified.
|
@@ -1724,18 +1737,18 @@ module Aws::CloudFormation
|
|
1724
1737
|
# If you specify tags as part of a `CreateStackSet` action,
|
1725
1738
|
# CloudFormation checks to see if you have the required IAM permission
|
1726
1739
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
1727
|
-
# fails with an `access denied` error, and the
|
1740
|
+
# fails with an `access denied` error, and the StackSet is not
|
1728
1741
|
# created.
|
1729
1742
|
# @return [Array<Types::Tag>]
|
1730
1743
|
#
|
1731
1744
|
# @!attribute [rw] administration_role_arn
|
1732
1745
|
# The Amazon Resource Name (ARN) of the IAM role to use to create this
|
1733
|
-
#
|
1746
|
+
# StackSet.
|
1734
1747
|
#
|
1735
1748
|
# Specify an IAM role only if you are using customized administrator
|
1736
|
-
# roles to control which users or groups can manage specific
|
1737
|
-
#
|
1738
|
-
#
|
1749
|
+
# roles to control which users or groups can manage specific StackSets
|
1750
|
+
# within the same administrator account. For more information, see
|
1751
|
+
# [Grant self-managed permissions][1] in the *CloudFormation User
|
1739
1752
|
# Guide*.
|
1740
1753
|
#
|
1741
1754
|
# Valid only if the permissions model is `SELF_MANAGED`.
|
@@ -1746,20 +1759,20 @@ module Aws::CloudFormation
|
|
1746
1759
|
# @return [String]
|
1747
1760
|
#
|
1748
1761
|
# @!attribute [rw] execution_role_name
|
1749
|
-
# The name of the IAM execution role to use to create the
|
1750
|
-
#
|
1751
|
-
# `AWSCloudFormationStackSetExecutionRole` role for the
|
1762
|
+
# The name of the IAM execution role to use to create the StackSet. If
|
1763
|
+
# you do not specify an execution role, CloudFormation uses the
|
1764
|
+
# `AWSCloudFormationStackSetExecutionRole` role for the StackSet
|
1752
1765
|
# operation.
|
1753
1766
|
#
|
1754
1767
|
# Specify an IAM role only if you are using customized execution roles
|
1755
1768
|
# to control which stack resources users and groups can include in
|
1756
|
-
# their
|
1769
|
+
# their StackSets.
|
1757
1770
|
#
|
1758
1771
|
# Valid only if the permissions model is `SELF_MANAGED`.
|
1759
1772
|
# @return [String]
|
1760
1773
|
#
|
1761
1774
|
# @!attribute [rw] permission_model
|
1762
|
-
# Describes how the IAM roles required for
|
1775
|
+
# Describes how the IAM roles required for StackSet operations are
|
1763
1776
|
# created. By default, `SELF-MANAGED` is specified.
|
1764
1777
|
#
|
1765
1778
|
# * With `self-managed` permissions, you must create the administrator
|
@@ -1769,7 +1782,7 @@ module Aws::CloudFormation
|
|
1769
1782
|
# * With `service-managed` permissions, StackSets automatically
|
1770
1783
|
# creates the IAM roles required to deploy to accounts managed by
|
1771
1784
|
# Organizations. For more information, see [Activate trusted access
|
1772
|
-
# for
|
1785
|
+
# for StackSets with Organizations][2].
|
1773
1786
|
#
|
1774
1787
|
#
|
1775
1788
|
#
|
@@ -1780,9 +1793,9 @@ module Aws::CloudFormation
|
|
1780
1793
|
# @!attribute [rw] auto_deployment
|
1781
1794
|
# Describes whether StackSets automatically deploys to Organizations
|
1782
1795
|
# accounts that are added to the target organization or organizational
|
1783
|
-
# unit (OU). For more information, see [
|
1784
|
-
# for
|
1785
|
-
#
|
1796
|
+
# unit (OU). For more information, see [Enable or disable automatic
|
1797
|
+
# deployments for StackSets in Organizations][1] in the
|
1798
|
+
# *CloudFormation User Guide*.
|
1786
1799
|
#
|
1787
1800
|
# Required if the permissions model is `SERVICE_MANAGED`. (Not used
|
1788
1801
|
# with self-managed permissions.)
|
@@ -1797,14 +1810,14 @@ module Aws::CloudFormation
|
|
1797
1810
|
# organization's management account or as a delegated administrator
|
1798
1811
|
# in a member account.
|
1799
1812
|
#
|
1800
|
-
# By default, `SELF` is specified. Use `SELF` for
|
1813
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
1801
1814
|
# self-managed permissions.
|
1802
1815
|
#
|
1803
|
-
# * To create a
|
1804
|
-
#
|
1816
|
+
# * To create a StackSet with service-managed permissions while signed
|
1817
|
+
# in to the management account, specify `SELF`.
|
1805
1818
|
#
|
1806
|
-
# * To create a
|
1807
|
-
#
|
1819
|
+
# * To create a StackSet with service-managed permissions while signed
|
1820
|
+
# in to a delegated administrator account, specify
|
1808
1821
|
# `DELEGATED_ADMIN`.
|
1809
1822
|
#
|
1810
1823
|
# Your Amazon Web Services account must be registered as a delegated
|
@@ -1812,8 +1825,8 @@ module Aws::CloudFormation
|
|
1812
1825
|
# [Register a delegated administrator][1] in the *CloudFormation
|
1813
1826
|
# User Guide*.
|
1814
1827
|
#
|
1815
|
-
#
|
1816
|
-
# management account, including
|
1828
|
+
# StackSets with service-managed permissions are created in the
|
1829
|
+
# management account, including StackSets that are created by
|
1817
1830
|
# delegated administrators.
|
1818
1831
|
#
|
1819
1832
|
# Valid only if the permissions model is `SERVICE_MANAGED`.
|
@@ -1826,8 +1839,8 @@ module Aws::CloudFormation
|
|
1826
1839
|
# @!attribute [rw] client_request_token
|
1827
1840
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
1828
1841
|
# token if you plan to retry requests so that CloudFormation knows
|
1829
|
-
# that you're not attempting to create another
|
1830
|
-
#
|
1842
|
+
# that you're not attempting to create another StackSet with the same
|
1843
|
+
# name. You might retry `CreateStackSet` requests to ensure that
|
1831
1844
|
# CloudFormation successfully received them.
|
1832
1845
|
#
|
1833
1846
|
# If you don't specify an operation ID, the SDK generates one
|
@@ -1838,7 +1851,7 @@ module Aws::CloudFormation
|
|
1838
1851
|
# @return [String]
|
1839
1852
|
#
|
1840
1853
|
# @!attribute [rw] managed_execution
|
1841
|
-
# Describes whether
|
1854
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
1842
1855
|
# concurrently and queues conflicting operations.
|
1843
1856
|
# @return [Types::ManagedExecution]
|
1844
1857
|
#
|
@@ -1865,7 +1878,7 @@ module Aws::CloudFormation
|
|
1865
1878
|
end
|
1866
1879
|
|
1867
1880
|
# @!attribute [rw] stack_set_id
|
1868
|
-
# The ID of the
|
1881
|
+
# The ID of the StackSet that you're creating.
|
1869
1882
|
# @return [String]
|
1870
1883
|
#
|
1871
1884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSetOutput AWS API Documentation
|
@@ -1893,7 +1906,7 @@ module Aws::CloudFormation
|
|
1893
1906
|
class DeactivateOrganizationsAccessOutput < Aws::EmptyStructure; end
|
1894
1907
|
|
1895
1908
|
# @!attribute [rw] type_name
|
1896
|
-
# The type name of the extension
|
1909
|
+
# The type name of the extension in this account and Region. If you
|
1897
1910
|
# specified a type name alias when enabling the extension, use the
|
1898
1911
|
# type name alias.
|
1899
1912
|
#
|
@@ -1909,8 +1922,8 @@ module Aws::CloudFormation
|
|
1909
1922
|
# @return [String]
|
1910
1923
|
#
|
1911
1924
|
# @!attribute [rw] arn
|
1912
|
-
# The Amazon Resource Name (ARN) for the extension
|
1913
|
-
#
|
1925
|
+
# The Amazon Resource Name (ARN) for the extension in this account and
|
1926
|
+
# Region.
|
1914
1927
|
#
|
1915
1928
|
# Conditional: You must specify either `Arn`, or `TypeName` and
|
1916
1929
|
# `Type`.
|
@@ -2041,7 +2054,7 @@ module Aws::CloudFormation
|
|
2041
2054
|
end
|
2042
2055
|
|
2043
2056
|
# @!attribute [rw] stack_set_name
|
2044
|
-
# The name or unique ID of the
|
2057
|
+
# The name or unique ID of the StackSet that you want to delete stack
|
2045
2058
|
# instances for.
|
2046
2059
|
# @return [String]
|
2047
2060
|
#
|
@@ -2060,40 +2073,39 @@ module Aws::CloudFormation
|
|
2060
2073
|
# @return [Types::DeploymentTargets]
|
2061
2074
|
#
|
2062
2075
|
# @!attribute [rw] regions
|
2063
|
-
# The Amazon Web Services Regions where you want to delete
|
2076
|
+
# The Amazon Web Services Regions where you want to delete StackSet
|
2064
2077
|
# instances.
|
2065
2078
|
# @return [Array<String>]
|
2066
2079
|
#
|
2067
2080
|
# @!attribute [rw] operation_preferences
|
2068
|
-
# Preferences for how CloudFormation performs this
|
2069
|
-
# operation.
|
2081
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
2070
2082
|
# @return [Types::StackSetOperationPreferences]
|
2071
2083
|
#
|
2072
2084
|
# @!attribute [rw] retain_stacks
|
2073
|
-
# Removes the stack instances from the specified
|
2085
|
+
# Removes the stack instances from the specified StackSet, but
|
2074
2086
|
# doesn't delete the stacks. You can't reassociate a retained stack
|
2075
2087
|
# or add an existing, saved stack to a new stack set.
|
2076
2088
|
#
|
2077
|
-
# For more information, see [
|
2089
|
+
# For more information, see [StackSet operation options][1].
|
2078
2090
|
#
|
2079
2091
|
#
|
2080
2092
|
#
|
2081
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
2093
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
2082
2094
|
# @return [Boolean]
|
2083
2095
|
#
|
2084
2096
|
# @!attribute [rw] operation_id
|
2085
|
-
# The unique identifier for this
|
2097
|
+
# The unique identifier for this StackSet operation.
|
2086
2098
|
#
|
2087
2099
|
# If you don't specify an operation ID, the SDK generates one
|
2088
2100
|
# automatically.
|
2089
2101
|
#
|
2090
2102
|
# The operation ID also functions as an idempotency token, to ensure
|
2091
|
-
# that CloudFormation performs the
|
2092
|
-
# if you retry the request multiple times. You can retry
|
2103
|
+
# that CloudFormation performs the StackSet operation only once, even
|
2104
|
+
# if you retry the request multiple times. You can retry StackSet
|
2093
2105
|
# operation requests to ensure that CloudFormation successfully
|
2094
2106
|
# received them.
|
2095
2107
|
#
|
2096
|
-
# Repeating this
|
2108
|
+
# Repeating this StackSet operation with a new operation ID retries
|
2097
2109
|
# all stack instances whose status is `OUTDATED`.
|
2098
2110
|
#
|
2099
2111
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2105,7 +2117,7 @@ module Aws::CloudFormation
|
|
2105
2117
|
# an account administrator in the organization's management account
|
2106
2118
|
# or as a delegated administrator in a member account.
|
2107
2119
|
#
|
2108
|
-
# By default, `SELF` is specified. Use `SELF` for
|
2120
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
2109
2121
|
# self-managed permissions.
|
2110
2122
|
#
|
2111
2123
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -2139,7 +2151,7 @@ module Aws::CloudFormation
|
|
2139
2151
|
end
|
2140
2152
|
|
2141
2153
|
# @!attribute [rw] operation_id
|
2142
|
-
# The unique identifier for this
|
2154
|
+
# The unique identifier for this StackSet operation.
|
2143
2155
|
# @return [String]
|
2144
2156
|
#
|
2145
2157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstancesOutput AWS API Documentation
|
@@ -2151,8 +2163,8 @@ module Aws::CloudFormation
|
|
2151
2163
|
end
|
2152
2164
|
|
2153
2165
|
# @!attribute [rw] stack_set_name
|
2154
|
-
# The name or unique ID of the
|
2155
|
-
#
|
2166
|
+
# The name or unique ID of the StackSet that you're deleting. You can
|
2167
|
+
# obtain this value by running ListStackSets.
|
2156
2168
|
# @return [String]
|
2157
2169
|
#
|
2158
2170
|
# @!attribute [rw] call_as
|
@@ -2160,7 +2172,7 @@ module Aws::CloudFormation
|
|
2160
2172
|
# an account administrator in the organization's management account
|
2161
2173
|
# or as a delegated administrator in a member account.
|
2162
2174
|
#
|
2163
|
-
# By default, `SELF` is specified. Use `SELF` for
|
2175
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
2164
2176
|
# self-managed permissions.
|
2165
2177
|
#
|
2166
2178
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -2191,19 +2203,26 @@ module Aws::CloudFormation
|
|
2191
2203
|
#
|
2192
2204
|
class DeleteStackSetOutput < Aws::EmptyStructure; end
|
2193
2205
|
|
2194
|
-
#
|
2195
|
-
#
|
2196
|
-
# organization
|
2197
|
-
# account
|
2206
|
+
# Specifies the Organizations accounts where you want to create, update,
|
2207
|
+
# or delete stack instances. You can target either your entire
|
2208
|
+
# organization or specific accounts using organizational units (OUs) and
|
2209
|
+
# account filter options.
|
2198
2210
|
#
|
2199
|
-
#
|
2200
|
-
#
|
2201
|
-
#
|
2211
|
+
# CloudFormation doesn't deploy stack instances to the organization
|
2212
|
+
# management account, even if the organization management account is in
|
2213
|
+
# your organization or in an OU in your organization.
|
2214
|
+
#
|
2215
|
+
# When performing create operations, if you specify both
|
2216
|
+
# `OrganizationalUnitIds` and `Accounts`, you must also specify the
|
2217
|
+
# `AccountFilterType` property.
|
2202
2218
|
#
|
2203
2219
|
# @!attribute [rw] accounts
|
2204
|
-
# The
|
2205
|
-
#
|
2206
|
-
# `
|
2220
|
+
# The Amazon Web Services account IDs where you want to perform stack
|
2221
|
+
# operations. How these accounts are used depends on the
|
2222
|
+
# `AccountFilterType` property.
|
2223
|
+
#
|
2224
|
+
# If you have many account numbers, you can provide those accounts
|
2225
|
+
# using the `AccountsUrl` property instead.
|
2207
2226
|
# @return [Array<String>]
|
2208
2227
|
#
|
2209
2228
|
# @!attribute [rw] accounts_url
|
@@ -2212,36 +2231,44 @@ module Aws::CloudFormation
|
|
2212
2231
|
# `.txt`, and the data can be comma-separated or new-line-separated.
|
2213
2232
|
# There is currently a 10MB limit for the data (approximately 800,000
|
2214
2233
|
# accounts).
|
2234
|
+
#
|
2235
|
+
# This property serves the same purpose as `Accounts` but allows you
|
2236
|
+
# to specify a large number of accounts.
|
2215
2237
|
# @return [String]
|
2216
2238
|
#
|
2217
2239
|
# @!attribute [rw] organizational_unit_ids
|
2218
|
-
# The organization root ID or organizational unit (OU) IDs
|
2240
|
+
# The organization root ID or organizational unit (OU) IDs where you
|
2241
|
+
# want to perform stack operations. CloudFormation will perform
|
2242
|
+
# operations on accounts within these OUs and their child OUs.
|
2219
2243
|
# @return [Array<String>]
|
2220
2244
|
#
|
2221
2245
|
# @!attribute [rw] account_filter_type
|
2222
|
-
#
|
2223
|
-
#
|
2224
|
-
#
|
2225
|
-
# The following is a list of possible values for the
|
2226
|
-
# `AccountFilterType` operation.
|
2246
|
+
# Refines which accounts will have stack operations performed on them
|
2247
|
+
# by specifying how to use the `Accounts` and `OrganizationalUnitIds`
|
2248
|
+
# properties together.
|
2227
2249
|
#
|
2228
|
-
#
|
2229
|
-
#
|
2250
|
+
# The following values determine how CloudFormation selects target
|
2251
|
+
# accounts:
|
2230
2252
|
#
|
2231
|
-
# * `
|
2232
|
-
#
|
2233
|
-
#
|
2253
|
+
# * `INTERSECTION`: Performs stack operations only on specific
|
2254
|
+
# individual accounts within the selected OUs. Only accounts that
|
2255
|
+
# are both specified in the `Accounts` property and belong to the
|
2256
|
+
# specified OUs will be targeted.
|
2234
2257
|
#
|
2235
|
-
# * `
|
2236
|
-
#
|
2258
|
+
# * `DIFFERENCE`: Performs stack operations on all accounts in the
|
2259
|
+
# selected OUs except for specific accounts listed in the `Accounts`
|
2260
|
+
# property. This enables you to exclude certain accounts within an
|
2261
|
+
# OU, such as suspended accounts.
|
2237
2262
|
#
|
2263
|
+
# * `UNION`: Performs stack operations on the specified OUs plus
|
2264
|
+
# additional individual accounts listed in the `Accounts` property.
|
2238
2265
|
# This is the default value if `AccountFilterType` is not provided.
|
2239
|
-
# This
|
2240
|
-
#
|
2241
|
-
#
|
2266
|
+
# This lets you target an entire OU and individual accounts from a
|
2267
|
+
# different OU in one request. Note that `UNION` is not supported
|
2268
|
+
# for `CreateStackInstances` operations.
|
2242
2269
|
#
|
2243
|
-
# * `NONE`:
|
2244
|
-
# units (
|
2270
|
+
# * `NONE`: Performs stack operations on all accounts in the specified
|
2271
|
+
# organizational units (OUs).
|
2245
2272
|
# @return [String]
|
2246
2273
|
#
|
2247
2274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeploymentTargets AWS API Documentation
|
@@ -2375,7 +2402,7 @@ module Aws::CloudFormation
|
|
2375
2402
|
# @return [String]
|
2376
2403
|
#
|
2377
2404
|
# @!attribute [rw] hooks
|
2378
|
-
# List of
|
2405
|
+
# List of Hook objects.
|
2379
2406
|
# @return [Array<Types::ChangeSetHook>]
|
2380
2407
|
#
|
2381
2408
|
# @!attribute [rw] status
|
@@ -3043,8 +3070,8 @@ module Aws::CloudFormation
|
|
3043
3070
|
end
|
3044
3071
|
|
3045
3072
|
# @!attribute [rw] stack_set_name
|
3046
|
-
# The name or the unique stack ID of the
|
3047
|
-
#
|
3073
|
+
# The name or the unique stack ID of the StackSet that you want to get
|
3074
|
+
# stack instance information for.
|
3048
3075
|
# @return [String]
|
3049
3076
|
#
|
3050
3077
|
# @!attribute [rw] stack_instance_account
|
@@ -3061,7 +3088,7 @@ module Aws::CloudFormation
|
|
3061
3088
|
# an account administrator in the organization's management account
|
3062
3089
|
# or as a delegated administrator in a member account.
|
3063
3090
|
#
|
3064
|
-
# By default, `SELF` is specified. Use `SELF` for
|
3091
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
3065
3092
|
# self-managed permissions.
|
3066
3093
|
#
|
3067
3094
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -3340,7 +3367,7 @@ module Aws::CloudFormation
|
|
3340
3367
|
end
|
3341
3368
|
|
3342
3369
|
# @!attribute [rw] stack_set_name
|
3343
|
-
# The name or unique ID of the
|
3370
|
+
# The name or unique ID of the StackSet whose description you want.
|
3344
3371
|
# @return [String]
|
3345
3372
|
#
|
3346
3373
|
# @!attribute [rw] call_as
|
@@ -3348,7 +3375,7 @@ module Aws::CloudFormation
|
|
3348
3375
|
# an account administrator in the organization's management account
|
3349
3376
|
# or as a delegated administrator in a member account.
|
3350
3377
|
#
|
3351
|
-
# By default, `SELF` is specified. Use `SELF` for
|
3378
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
3352
3379
|
# self-managed permissions.
|
3353
3380
|
#
|
3354
3381
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -3376,12 +3403,12 @@ module Aws::CloudFormation
|
|
3376
3403
|
end
|
3377
3404
|
|
3378
3405
|
# @!attribute [rw] stack_set_name
|
3379
|
-
# The name or the unique stack ID of the
|
3406
|
+
# The name or the unique stack ID of the StackSet for the stack
|
3380
3407
|
# operation.
|
3381
3408
|
# @return [String]
|
3382
3409
|
#
|
3383
3410
|
# @!attribute [rw] operation_id
|
3384
|
-
# The unique ID of the
|
3411
|
+
# The unique ID of the StackSet operation.
|
3385
3412
|
# @return [String]
|
3386
3413
|
#
|
3387
3414
|
# @!attribute [rw] call_as
|
@@ -3389,7 +3416,7 @@ module Aws::CloudFormation
|
|
3389
3416
|
# an account administrator in the organization's management account
|
3390
3417
|
# or as a delegated administrator in a member account.
|
3391
3418
|
#
|
3392
|
-
# By default, `SELF` is specified. Use `SELF` for
|
3419
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
3393
3420
|
# self-managed permissions.
|
3394
3421
|
#
|
3395
3422
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -3418,7 +3445,7 @@ module Aws::CloudFormation
|
|
3418
3445
|
end
|
3419
3446
|
|
3420
3447
|
# @!attribute [rw] stack_set_operation
|
3421
|
-
# The specified
|
3448
|
+
# The specified StackSet operation.
|
3422
3449
|
# @return [Types::StackSetOperation]
|
3423
3450
|
#
|
3424
3451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperationOutput AWS API Documentation
|
@@ -3430,7 +3457,7 @@ module Aws::CloudFormation
|
|
3430
3457
|
end
|
3431
3458
|
|
3432
3459
|
# @!attribute [rw] stack_set
|
3433
|
-
# The specified
|
3460
|
+
# The specified StackSet.
|
3434
3461
|
# @return [Types::StackSet]
|
3435
3462
|
#
|
3436
3463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOutput AWS API Documentation
|
@@ -3654,13 +3681,14 @@ module Aws::CloudFormation
|
|
3654
3681
|
# @!attribute [rw] schema
|
3655
3682
|
# The schema that defines the extension.
|
3656
3683
|
#
|
3657
|
-
# For more information
|
3658
|
-
#
|
3659
|
-
# Guide
|
3684
|
+
# For more information, see [Resource type schema][1] in the
|
3685
|
+
# *CloudFormation Command Line Interface (CLI) User Guide* and the
|
3686
|
+
# [CloudFormation Hooks User Guide][2].
|
3660
3687
|
#
|
3661
3688
|
#
|
3662
3689
|
#
|
3663
3690
|
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html
|
3691
|
+
# [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html
|
3664
3692
|
# @return [String]
|
3665
3693
|
#
|
3666
3694
|
# @!attribute [rw] provisioning_type
|
@@ -3790,14 +3818,11 @@ module Aws::CloudFormation
|
|
3790
3818
|
# extension in this account and Region.
|
3791
3819
|
#
|
3792
3820
|
# To set the configuration data for an extension, use
|
3793
|
-
# [SetTypeConfiguration][1].
|
3794
|
-
# configuration data for extensions in your account][2] in the
|
3795
|
-
# *CloudFormation User Guide*.
|
3821
|
+
# [SetTypeConfiguration][1].
|
3796
3822
|
#
|
3797
3823
|
#
|
3798
3824
|
#
|
3799
3825
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
|
3800
|
-
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html
|
3801
3826
|
# @return [String]
|
3802
3827
|
#
|
3803
3828
|
# @!attribute [rw] publisher_id
|
@@ -4015,24 +4040,24 @@ module Aws::CloudFormation
|
|
4015
4040
|
end
|
4016
4041
|
|
4017
4042
|
# @!attribute [rw] stack_set_name
|
4018
|
-
# The name of the
|
4043
|
+
# The name of the StackSet on which to perform the drift detection
|
4019
4044
|
# operation.
|
4020
4045
|
# @return [String]
|
4021
4046
|
#
|
4022
4047
|
# @!attribute [rw] operation_preferences
|
4023
4048
|
# The user-specified preferences for how CloudFormation performs a
|
4024
|
-
#
|
4049
|
+
# StackSet operation.
|
4025
4050
|
#
|
4026
4051
|
# For more information about maximum concurrent accounts and failure
|
4027
|
-
# tolerance, see [
|
4052
|
+
# tolerance, see [StackSet operation options][1].
|
4028
4053
|
#
|
4029
4054
|
#
|
4030
4055
|
#
|
4031
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
4056
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4032
4057
|
# @return [Types::StackSetOperationPreferences]
|
4033
4058
|
#
|
4034
4059
|
# @!attribute [rw] operation_id
|
4035
|
-
# *The ID of the
|
4060
|
+
# *The ID of the StackSet operation.*
|
4036
4061
|
#
|
4037
4062
|
# **A suitable default value is auto-generated.** You should normally
|
4038
4063
|
# not need to pass this option.
|
@@ -4043,7 +4068,7 @@ module Aws::CloudFormation
|
|
4043
4068
|
# an account administrator in the organization's management account
|
4044
4069
|
# or as a delegated administrator in a member account.
|
4045
4070
|
#
|
4046
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4071
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4047
4072
|
# self-managed permissions.
|
4048
4073
|
#
|
4049
4074
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4073,7 +4098,7 @@ module Aws::CloudFormation
|
|
4073
4098
|
end
|
4074
4099
|
|
4075
4100
|
# @!attribute [rw] operation_id
|
4076
|
-
# The ID of the drift detection
|
4101
|
+
# The ID of the drift detection StackSet operation.
|
4077
4102
|
#
|
4078
4103
|
# You can use this operation ID with DescribeStackSetOperation to
|
4079
4104
|
# monitor the progress of the drift detection operation.
|
@@ -4221,6 +4246,13 @@ module Aws::CloudFormation
|
|
4221
4246
|
# The `Export` structure describes the exported output values for a
|
4222
4247
|
# stack.
|
4223
4248
|
#
|
4249
|
+
# For more information, see [Get exported outputs from a deployed
|
4250
|
+
# CloudFormation stack][1].
|
4251
|
+
#
|
4252
|
+
#
|
4253
|
+
#
|
4254
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html
|
4255
|
+
#
|
4224
4256
|
# @!attribute [rw] exporting_stack_id
|
4225
4257
|
# The stack that contains the exported output name and value.
|
4226
4258
|
# @return [String]
|
@@ -4446,7 +4478,7 @@ module Aws::CloudFormation
|
|
4446
4478
|
# @return [String]
|
4447
4479
|
#
|
4448
4480
|
# @!attribute [rw] stack_set_name
|
4449
|
-
# The name or unique ID of the
|
4481
|
+
# The name or unique ID of the StackSet from which the stack was
|
4450
4482
|
# created.
|
4451
4483
|
#
|
4452
4484
|
# Conditional: You must specify only one of the following parameters:
|
@@ -4458,7 +4490,7 @@ module Aws::CloudFormation
|
|
4458
4490
|
# an account administrator in the organization's management account
|
4459
4491
|
# or as a delegated administrator in a member account.
|
4460
4492
|
#
|
4461
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4493
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4462
4494
|
# self-managed permissions.
|
4463
4495
|
#
|
4464
4496
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4583,65 +4615,105 @@ module Aws::CloudFormation
|
|
4583
4615
|
# Describes a Hook invocation, its status, and the reason for its
|
4584
4616
|
# status.
|
4585
4617
|
#
|
4618
|
+
# @!attribute [rw] hook_result_id
|
4619
|
+
# The unique identifier for this Hook invocation result.
|
4620
|
+
# @return [String]
|
4621
|
+
#
|
4586
4622
|
# @!attribute [rw] invocation_point
|
4587
|
-
# The
|
4623
|
+
# The specific point in the provisioning process where the Hook is
|
4624
|
+
# invoked.
|
4588
4625
|
# @return [String]
|
4589
4626
|
#
|
4590
4627
|
# @!attribute [rw] failure_mode
|
4591
|
-
# The failure mode of the invocation.
|
4592
|
-
# modes:
|
4593
|
-
#
|
4594
|
-
# * `FAIL`: If the hook invocation returns a failure, then the
|
4595
|
-
# requested target operation should fail.
|
4596
|
-
#
|
4597
|
-
# * `WARN`: If the hook invocation returns a failure, then the
|
4598
|
-
# requested target operation should warn.
|
4628
|
+
# The failure mode of the invocation.
|
4599
4629
|
# @return [String]
|
4600
4630
|
#
|
4601
4631
|
# @!attribute [rw] type_name
|
4602
|
-
# The
|
4632
|
+
# The name of the Hook that was invoked.
|
4603
4633
|
# @return [String]
|
4604
4634
|
#
|
4605
4635
|
# @!attribute [rw] type_version_id
|
4606
|
-
# The version of the Hook
|
4636
|
+
# The version of the Hook that was invoked.
|
4607
4637
|
# @return [String]
|
4608
4638
|
#
|
4609
4639
|
# @!attribute [rw] type_configuration_version_id
|
4610
|
-
# The version of the Hook
|
4640
|
+
# The version of the Hook configuration.
|
4611
4641
|
# @return [String]
|
4612
4642
|
#
|
4613
4643
|
# @!attribute [rw] status
|
4614
|
-
# The
|
4644
|
+
# The status of the Hook invocation. The following statuses are
|
4645
|
+
# possible:
|
4646
|
+
#
|
4647
|
+
# * `HOOK_IN_PROGRESS`: The Hook is currently running.
|
4648
|
+
#
|
4649
|
+
# * `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
|
4650
|
+
#
|
4651
|
+
# * `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
|
4652
|
+
#
|
4653
|
+
# * `HOOK_FAILED`: The Hook encountered an error during execution.
|
4615
4654
|
# @return [String]
|
4616
4655
|
#
|
4617
4656
|
# @!attribute [rw] hook_status_reason
|
4618
4657
|
# A description of the Hook results status. For example, if the Hook
|
4619
|
-
# result is in a
|
4620
|
-
#
|
4658
|
+
# result is in a failed state, this may contain additional information
|
4659
|
+
# for the failed state.
|
4660
|
+
# @return [String]
|
4661
|
+
#
|
4662
|
+
# @!attribute [rw] invoked_at
|
4663
|
+
# The timestamp when the Hook was invoked.
|
4664
|
+
#
|
4665
|
+
# Only shown in responses when the request does not specify
|
4666
|
+
# `TargetType` and `TargetId` filters.
|
4667
|
+
# @return [Time]
|
4668
|
+
#
|
4669
|
+
# @!attribute [rw] target_type
|
4670
|
+
# The target type that the Hook was invoked against.
|
4671
|
+
# @return [String]
|
4672
|
+
#
|
4673
|
+
# @!attribute [rw] target_id
|
4674
|
+
# The unique identifier of the Hook invocation target.
|
4675
|
+
# @return [String]
|
4676
|
+
#
|
4677
|
+
# @!attribute [rw] type_arn
|
4678
|
+
# The ARN of the Hook that was invoked.
|
4679
|
+
# @return [String]
|
4680
|
+
#
|
4681
|
+
# @!attribute [rw] hook_execution_target
|
4682
|
+
# The ARN of the target stack or request token of the Cloud Control
|
4683
|
+
# API operation.
|
4684
|
+
#
|
4685
|
+
# Only shown in responses when the request does not specify
|
4686
|
+
# `TargetType` and `TargetId` filters.
|
4621
4687
|
# @return [String]
|
4622
4688
|
#
|
4623
4689
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/HookResultSummary AWS API Documentation
|
4624
4690
|
#
|
4625
4691
|
class HookResultSummary < Struct.new(
|
4692
|
+
:hook_result_id,
|
4626
4693
|
:invocation_point,
|
4627
4694
|
:failure_mode,
|
4628
4695
|
:type_name,
|
4629
4696
|
:type_version_id,
|
4630
4697
|
:type_configuration_version_id,
|
4631
4698
|
:status,
|
4632
|
-
:hook_status_reason
|
4699
|
+
:hook_status_reason,
|
4700
|
+
:invoked_at,
|
4701
|
+
:target_type,
|
4702
|
+
:target_id,
|
4703
|
+
:type_arn,
|
4704
|
+
:hook_execution_target)
|
4633
4705
|
SENSITIVE = []
|
4634
4706
|
include Aws::Structure
|
4635
4707
|
end
|
4636
4708
|
|
4637
4709
|
# @!attribute [rw] stack_set_name
|
4638
|
-
# The name of the
|
4639
|
-
# where you create your
|
4710
|
+
# The name of the StackSet. The name must be unique in the Region
|
4711
|
+
# where you create your StackSet.
|
4640
4712
|
# @return [String]
|
4641
4713
|
#
|
4642
4714
|
# @!attribute [rw] stack_ids
|
4643
|
-
# The IDs of the stacks you are importing into a
|
4644
|
-
# up to 10 stacks per
|
4715
|
+
# The IDs of the stacks you are importing into a StackSet. You import
|
4716
|
+
# up to 10 stacks per StackSet at a time.
|
4645
4717
|
#
|
4646
4718
|
# Specify either `StackIds` or `StackIdsUrl`.
|
4647
4719
|
# @return [Array<String>]
|
@@ -4653,36 +4725,36 @@ module Aws::CloudFormation
|
|
4653
4725
|
# @return [String]
|
4654
4726
|
#
|
4655
4727
|
# @!attribute [rw] organizational_unit_ids
|
4656
|
-
# The list of OU ID's to which the stacks
|
4657
|
-
#
|
4728
|
+
# The list of OU ID's to which the imported stacks must be mapped as
|
4729
|
+
# deployment targets.
|
4658
4730
|
# @return [Array<String>]
|
4659
4731
|
#
|
4660
4732
|
# @!attribute [rw] operation_preferences
|
4661
4733
|
# The user-specified preferences for how CloudFormation performs a
|
4662
|
-
#
|
4734
|
+
# StackSet operation.
|
4663
4735
|
#
|
4664
4736
|
# For more information about maximum concurrent accounts and failure
|
4665
|
-
# tolerance, see [
|
4737
|
+
# tolerance, see [StackSet operation options][1].
|
4666
4738
|
#
|
4667
4739
|
#
|
4668
4740
|
#
|
4669
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
4741
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4670
4742
|
# @return [Types::StackSetOperationPreferences]
|
4671
4743
|
#
|
4672
4744
|
# @!attribute [rw] operation_id
|
4673
|
-
# A unique, user defined, identifier for the
|
4745
|
+
# A unique, user defined, identifier for the StackSet operation.
|
4674
4746
|
#
|
4675
4747
|
# **A suitable default value is auto-generated.** You should normally
|
4676
4748
|
# not need to pass this option.
|
4677
4749
|
# @return [String]
|
4678
4750
|
#
|
4679
4751
|
# @!attribute [rw] call_as
|
4680
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4752
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4681
4753
|
# self-managed permissions.
|
4682
4754
|
#
|
4683
4755
|
# * If you are signed in to the management account, specify `SELF`.
|
4684
4756
|
#
|
4685
|
-
# * For service managed
|
4757
|
+
# * For service managed StackSets, specify `DELEGATED_ADMIN`.
|
4686
4758
|
# @return [String]
|
4687
4759
|
#
|
4688
4760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetInput AWS API Documentation
|
@@ -4700,7 +4772,7 @@ module Aws::CloudFormation
|
|
4700
4772
|
end
|
4701
4773
|
|
4702
4774
|
# @!attribute [rw] operation_id
|
4703
|
-
# The unique identifier for the
|
4775
|
+
# The unique identifier for the StackSet operation.
|
4704
4776
|
# @return [String]
|
4705
4777
|
#
|
4706
4778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetOutput AWS API Documentation
|
@@ -4875,23 +4947,47 @@ module Aws::CloudFormation
|
|
4875
4947
|
end
|
4876
4948
|
|
4877
4949
|
# @!attribute [rw] target_type
|
4878
|
-
#
|
4950
|
+
# Filters results by target type. Currently, only `CHANGE_SET` and
|
4951
|
+
# `CLOUD_CONTROL` are supported filter options.
|
4952
|
+
#
|
4953
|
+
# Required when `TargetId` is specified and cannot be used otherwise.
|
4879
4954
|
# @return [String]
|
4880
4955
|
#
|
4881
4956
|
# @!attribute [rw] target_id
|
4882
|
-
#
|
4883
|
-
#
|
4957
|
+
# Filters results by the unique identifier of the target the Hook was
|
4958
|
+
# invoked against.
|
4959
|
+
#
|
4960
|
+
# For change sets, this is the change set ARN. When the target is a
|
4961
|
+
# Cloud Control API operation, this value must be the
|
4962
|
+
# `HookRequestToken` returned by the Cloud Control API request. For
|
4963
|
+
# more information on the `HookRequestToken`, see [ProgressEvent][1].
|
4884
4964
|
#
|
4885
|
-
#
|
4886
|
-
#
|
4887
|
-
# request. For more information on the `HookRequestToken`, see
|
4888
|
-
# [ProgressEvent][1].
|
4965
|
+
# Required when `TargetType` is specified and cannot be used
|
4966
|
+
# otherwise.
|
4889
4967
|
#
|
4890
4968
|
#
|
4891
4969
|
#
|
4892
4970
|
# [1]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html
|
4893
4971
|
# @return [String]
|
4894
4972
|
#
|
4973
|
+
# @!attribute [rw] type_arn
|
4974
|
+
# Filters results by the ARN of the Hook. Can be used alone or in
|
4975
|
+
# combination with `Status`.
|
4976
|
+
# @return [String]
|
4977
|
+
#
|
4978
|
+
# @!attribute [rw] status
|
4979
|
+
# Filters results by the status of Hook invocations. Can only be used
|
4980
|
+
# in combination with `TypeArn`. Valid values are:
|
4981
|
+
#
|
4982
|
+
# * `HOOK_IN_PROGRESS`: The Hook is currently running.
|
4983
|
+
#
|
4984
|
+
# * `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
|
4985
|
+
#
|
4986
|
+
# * `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
|
4987
|
+
#
|
4988
|
+
# * `HOOK_FAILED`: The Hook encountered an error during execution.
|
4989
|
+
# @return [String]
|
4990
|
+
#
|
4895
4991
|
# @!attribute [rw] next_token
|
4896
4992
|
# A string that identifies the next page of events that you want to
|
4897
4993
|
# retrieve.
|
@@ -4902,27 +4998,19 @@ module Aws::CloudFormation
|
|
4902
4998
|
class ListHookResultsInput < Struct.new(
|
4903
4999
|
:target_type,
|
4904
5000
|
:target_id,
|
5001
|
+
:type_arn,
|
5002
|
+
:status,
|
4905
5003
|
:next_token)
|
4906
5004
|
SENSITIVE = []
|
4907
5005
|
include Aws::Structure
|
4908
5006
|
end
|
4909
5007
|
|
4910
5008
|
# @!attribute [rw] target_type
|
4911
|
-
# The type
|
5009
|
+
# The target type.
|
4912
5010
|
# @return [String]
|
4913
5011
|
#
|
4914
5012
|
# @!attribute [rw] target_id
|
4915
|
-
# The
|
4916
|
-
# If the target is a change set, it's the ARN of the change set.
|
4917
|
-
#
|
4918
|
-
# If the target is a Cloud Control API operation, this will be the
|
4919
|
-
# `HooksRequestToken` returned by the Cloud Control API operation
|
4920
|
-
# request. For more information on the `HooksRequestToken`, see
|
4921
|
-
# [ProgressEvent][1].
|
4922
|
-
#
|
4923
|
-
#
|
4924
|
-
#
|
4925
|
-
# [1]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html
|
5013
|
+
# The unique identifier of the Hook invocation target.
|
4926
5014
|
# @return [String]
|
4927
5015
|
#
|
4928
5016
|
# @!attribute [rw] hook_results
|
@@ -5158,7 +5246,7 @@ module Aws::CloudFormation
|
|
5158
5246
|
end
|
5159
5247
|
|
5160
5248
|
# @!attribute [rw] stack_set_name
|
5161
|
-
# The name or unique ID of the
|
5249
|
+
# The name or unique ID of the StackSet that you want to list drifted
|
5162
5250
|
# resources for.
|
5163
5251
|
# @return [String]
|
5164
5252
|
#
|
@@ -5212,7 +5300,7 @@ module Aws::CloudFormation
|
|
5212
5300
|
# an account administrator in the organization's management account
|
5213
5301
|
# or as a delegated administrator in a member account.
|
5214
5302
|
#
|
5215
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5303
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5216
5304
|
# self-managed permissions.
|
5217
5305
|
#
|
5218
5306
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5269,7 +5357,7 @@ module Aws::CloudFormation
|
|
5269
5357
|
end
|
5270
5358
|
|
5271
5359
|
# @!attribute [rw] stack_set_name
|
5272
|
-
# The name or unique ID of the
|
5360
|
+
# The name or unique ID of the StackSet that you want to list stack
|
5273
5361
|
# instances for.
|
5274
5362
|
# @return [String]
|
5275
5363
|
#
|
@@ -5307,7 +5395,7 @@ module Aws::CloudFormation
|
|
5307
5395
|
# an account administrator in the organization's management account
|
5308
5396
|
# or as a delegated administrator in a member account.
|
5309
5397
|
#
|
5310
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5398
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5311
5399
|
# self-managed permissions.
|
5312
5400
|
#
|
5313
5401
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5524,13 +5612,13 @@ module Aws::CloudFormation
|
|
5524
5612
|
end
|
5525
5613
|
|
5526
5614
|
# @!attribute [rw] stack_set_name
|
5527
|
-
# The name or unique ID of the
|
5528
|
-
#
|
5615
|
+
# The name or unique ID of the StackSet that you want to get automatic
|
5616
|
+
# deployment targets for.
|
5529
5617
|
# @return [String]
|
5530
5618
|
#
|
5531
5619
|
# @!attribute [rw] next_token
|
5532
|
-
# A string that identifies the next page of
|
5533
|
-
#
|
5620
|
+
# A string that identifies the next page of deployment targets that
|
5621
|
+
# you want to retrieve.
|
5534
5622
|
# @return [String]
|
5535
5623
|
#
|
5536
5624
|
# @!attribute [rw] max_results
|
@@ -5575,7 +5663,7 @@ module Aws::CloudFormation
|
|
5575
5663
|
end
|
5576
5664
|
|
5577
5665
|
# @!attribute [rw] summaries
|
5578
|
-
# An array of summaries of the deployment targets for the
|
5666
|
+
# An array of summaries of the deployment targets for the StackSet.
|
5579
5667
|
# @return [Array<Types::StackSetAutoDeploymentTargetSummary>]
|
5580
5668
|
#
|
5581
5669
|
# @!attribute [rw] next_token
|
@@ -5600,12 +5688,12 @@ module Aws::CloudFormation
|
|
5600
5688
|
end
|
5601
5689
|
|
5602
5690
|
# @!attribute [rw] stack_set_name
|
5603
|
-
# The name or unique ID of the
|
5604
|
-
#
|
5691
|
+
# The name or unique ID of the StackSet that you want to get operation
|
5692
|
+
# results for.
|
5605
5693
|
# @return [String]
|
5606
5694
|
#
|
5607
5695
|
# @!attribute [rw] operation_id
|
5608
|
-
# The ID of the
|
5696
|
+
# The ID of the StackSet operation.
|
5609
5697
|
# @return [String]
|
5610
5698
|
#
|
5611
5699
|
# @!attribute [rw] next_token
|
@@ -5630,7 +5718,7 @@ module Aws::CloudFormation
|
|
5630
5718
|
# an account administrator in the organization's management account
|
5631
5719
|
# or as a delegated administrator in a member account.
|
5632
5720
|
#
|
5633
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5721
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5634
5722
|
# self-managed permissions.
|
5635
5723
|
#
|
5636
5724
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5689,8 +5777,8 @@ module Aws::CloudFormation
|
|
5689
5777
|
end
|
5690
5778
|
|
5691
5779
|
# @!attribute [rw] stack_set_name
|
5692
|
-
# The name or unique ID of the
|
5693
|
-
#
|
5780
|
+
# The name or unique ID of the StackSet that you want to get operation
|
5781
|
+
# summaries for.
|
5694
5782
|
# @return [String]
|
5695
5783
|
#
|
5696
5784
|
# @!attribute [rw] next_token
|
@@ -5715,7 +5803,7 @@ module Aws::CloudFormation
|
|
5715
5803
|
# an account administrator in the organization's management account
|
5716
5804
|
# or as a delegated administrator in a member account.
|
5717
5805
|
#
|
5718
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5806
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5719
5807
|
# self-managed permissions.
|
5720
5808
|
#
|
5721
5809
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5746,7 +5834,7 @@ module Aws::CloudFormation
|
|
5746
5834
|
|
5747
5835
|
# @!attribute [rw] summaries
|
5748
5836
|
# A list of `StackSetOperationSummary` structures that contain summary
|
5749
|
-
# information about operations for the specified
|
5837
|
+
# information about operations for the specified StackSet.
|
5750
5838
|
# @return [Array<Types::StackSetOperationSummary>]
|
5751
5839
|
#
|
5752
5840
|
# @!attribute [rw] next_token
|
@@ -5783,8 +5871,8 @@ module Aws::CloudFormation
|
|
5783
5871
|
# @return [Integer]
|
5784
5872
|
#
|
5785
5873
|
# @!attribute [rw] status
|
5786
|
-
# The status of the
|
5787
|
-
#
|
5874
|
+
# The status of the StackSets that you want to get summary information
|
5875
|
+
# about.
|
5788
5876
|
# @return [String]
|
5789
5877
|
#
|
5790
5878
|
# @!attribute [rw] call_as
|
@@ -5792,7 +5880,7 @@ module Aws::CloudFormation
|
|
5792
5880
|
# an account administrator in the management account or as a delegated
|
5793
5881
|
# administrator in a member account.
|
5794
5882
|
#
|
5795
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5883
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5796
5884
|
# self-managed permissions.
|
5797
5885
|
#
|
5798
5886
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5823,7 +5911,7 @@ module Aws::CloudFormation
|
|
5823
5911
|
|
5824
5912
|
# @!attribute [rw] summaries
|
5825
5913
|
# A list of `StackSetSummary` structures that contain information
|
5826
|
-
# about the user's
|
5914
|
+
# about the user's StackSets.
|
5827
5915
|
# @return [Array<Types::StackSetSummary>]
|
5828
5916
|
#
|
5829
5917
|
# @!attribute [rw] next_token
|
@@ -6081,8 +6169,7 @@ module Aws::CloudFormation
|
|
6081
6169
|
# Region.
|
6082
6170
|
# * `PUBLIC`: Extensions that are publicly visible and available to be
|
6083
6171
|
# activated within any Amazon Web Services account. This includes
|
6084
|
-
# extensions from Amazon Web Services
|
6085
|
-
# publishers.
|
6172
|
+
# extensions from Amazon Web Services and third-party publishers.
|
6086
6173
|
#
|
6087
6174
|
# The default is `PRIVATE`.
|
6088
6175
|
# @return [String]
|
@@ -6212,16 +6299,16 @@ module Aws::CloudFormation
|
|
6212
6299
|
# concurrently and queues conflicting operations.
|
6213
6300
|
#
|
6214
6301
|
# @!attribute [rw] active
|
6215
|
-
# When `true`,
|
6302
|
+
# When `true`, CloudFormation performs non-conflicting operations
|
6216
6303
|
# concurrently and queues conflicting operations. After conflicting
|
6217
|
-
# operations finish,
|
6218
|
-
# order.
|
6304
|
+
# operations finish, CloudFormation starts queued operations in
|
6305
|
+
# request order.
|
6219
6306
|
#
|
6220
|
-
# <note markdown="1"> If there are already running or queued operations,
|
6221
|
-
# all incoming operations even if they are non-conflicting.
|
6307
|
+
# <note markdown="1"> If there are already running or queued operations, CloudFormation
|
6308
|
+
# queues all incoming operations even if they are non-conflicting.
|
6222
6309
|
#
|
6223
|
-
# You can't modify your
|
6224
|
-
# there are running or queued operations for that
|
6310
|
+
# You can't modify your StackSet's execution configuration while
|
6311
|
+
# there are running or queued operations for that StackSet.
|
6225
6312
|
#
|
6226
6313
|
# </note>
|
6227
6314
|
#
|
@@ -6300,8 +6387,8 @@ module Aws::CloudFormation
|
|
6300
6387
|
#
|
6301
6388
|
class OperationIdAlreadyExistsException < Aws::EmptyStructure; end
|
6302
6389
|
|
6303
|
-
# Another operation is currently in progress for this
|
6304
|
-
#
|
6390
|
+
# Another operation is currently in progress for this StackSet. Only one
|
6391
|
+
# operation can be performed for a stack set at a given time.
|
6305
6392
|
#
|
6306
6393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/OperationInProgressException AWS API Documentation
|
6307
6394
|
#
|
@@ -7774,8 +7861,8 @@ module Aws::CloudFormation
|
|
7774
7861
|
end
|
7775
7862
|
|
7776
7863
|
# @!attribute [rw] type_arn
|
7777
|
-
# The Amazon Resource Name (ARN) for the extension
|
7778
|
-
#
|
7864
|
+
# The Amazon Resource Name (ARN) for the extension in this account and
|
7865
|
+
# Region.
|
7779
7866
|
#
|
7780
7867
|
# For public extensions, this will be the ARN assigned when you call
|
7781
7868
|
# the [ActivateType][1] API operation in this account and Region. For
|
@@ -7793,19 +7880,15 @@ module Aws::CloudFormation
|
|
7793
7880
|
# @return [String]
|
7794
7881
|
#
|
7795
7882
|
# @!attribute [rw] configuration
|
7796
|
-
# The configuration data for the extension
|
7797
|
-
# Region.
|
7883
|
+
# The configuration data for the extension in this account and Region.
|
7798
7884
|
#
|
7799
|
-
# The configuration data must be formatted as JSON
|
7800
|
-
# against the schema returned in the `
|
7801
|
-
# element of [DescribeType][1].
|
7802
|
-
# the account-level configuration of an extension][2] in the
|
7803
|
-
# *CloudFormation Command Line Interface (CLI) User Guide*.
|
7885
|
+
# The configuration data must be formatted as JSON and validate
|
7886
|
+
# against the extension's schema returned in the `Schema` response
|
7887
|
+
# element of [DescribeType][1].
|
7804
7888
|
#
|
7805
7889
|
#
|
7806
7890
|
#
|
7807
7891
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
7808
|
-
# [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
|
7809
7892
|
# @return [String]
|
7810
7893
|
#
|
7811
7894
|
# @!attribute [rw] configuration_alias
|
@@ -7842,7 +7925,7 @@ module Aws::CloudFormation
|
|
7842
7925
|
end
|
7843
7926
|
|
7844
7927
|
# @!attribute [rw] configuration_arn
|
7845
|
-
# The Amazon Resource Name (ARN) for the configuration data
|
7928
|
+
# The Amazon Resource Name (ARN) for the configuration data in this
|
7846
7929
|
# account and Region.
|
7847
7930
|
#
|
7848
7931
|
# Conditional: You must specify `ConfigurationArn`, or `Type` and
|
@@ -8094,7 +8177,7 @@ module Aws::CloudFormation
|
|
8094
8177
|
# The detailed status of the resource or stack. If
|
8095
8178
|
# `CONFIGURATION_COMPLETE` is present, the resource or resource
|
8096
8179
|
# configuration phase has completed and the stabilization of the
|
8097
|
-
# resources is in progress. The
|
8180
|
+
# resources is in progress. The StackSets `CONFIGURATION_COMPLETE`
|
8098
8181
|
# when all of the resources in the stack have reached that event. For
|
8099
8182
|
# more information, see [Understand CloudFormation stack creation
|
8100
8183
|
# events][1] in the *CloudFormation User Guide*.
|
@@ -8245,7 +8328,7 @@ module Aws::CloudFormation
|
|
8245
8328
|
# @return [String]
|
8246
8329
|
#
|
8247
8330
|
# @!attribute [rw] event_id
|
8248
|
-
# The unique
|
8331
|
+
# The unique identifier of this event.
|
8249
8332
|
# @return [String]
|
8250
8333
|
#
|
8251
8334
|
# @!attribute [rw] stack_name
|
@@ -8306,24 +8389,28 @@ module Aws::CloudFormation
|
|
8306
8389
|
# @return [String]
|
8307
8390
|
#
|
8308
8391
|
# @!attribute [rw] hook_type
|
8309
|
-
# The name of the
|
8392
|
+
# The name of the Hook.
|
8310
8393
|
# @return [String]
|
8311
8394
|
#
|
8312
8395
|
# @!attribute [rw] hook_status
|
8313
|
-
# Provides the status of the change set
|
8396
|
+
# Provides the status of the change set Hook.
|
8314
8397
|
# @return [String]
|
8315
8398
|
#
|
8316
8399
|
# @!attribute [rw] hook_status_reason
|
8317
|
-
# Provides the reason for the
|
8400
|
+
# Provides the reason for the Hook status.
|
8318
8401
|
# @return [String]
|
8319
8402
|
#
|
8320
8403
|
# @!attribute [rw] hook_invocation_point
|
8321
|
-
#
|
8322
|
-
#
|
8404
|
+
# The specific point in the provisioning process where the Hook is
|
8405
|
+
# invoked.
|
8406
|
+
# @return [String]
|
8407
|
+
#
|
8408
|
+
# @!attribute [rw] hook_invocation_id
|
8409
|
+
# The unique identifier of the Hook invocation.
|
8323
8410
|
# @return [String]
|
8324
8411
|
#
|
8325
8412
|
# @!attribute [rw] hook_failure_mode
|
8326
|
-
# Specify the
|
8413
|
+
# Specify the Hook failure mode for non-compliant resources in the
|
8327
8414
|
# followings ways.
|
8328
8415
|
#
|
8329
8416
|
# * `FAIL` Stops provisioning resources.
|
@@ -8372,6 +8459,7 @@ module Aws::CloudFormation
|
|
8372
8459
|
:hook_status,
|
8373
8460
|
:hook_status_reason,
|
8374
8461
|
:hook_invocation_point,
|
8462
|
+
:hook_invocation_id,
|
8375
8463
|
:hook_failure_mode,
|
8376
8464
|
:detailed_status)
|
8377
8465
|
SENSITIVE = []
|
@@ -8379,16 +8467,16 @@ module Aws::CloudFormation
|
|
8379
8467
|
end
|
8380
8468
|
|
8381
8469
|
# A CloudFormation stack, in a specific account and Region, that's part
|
8382
|
-
# of a
|
8470
|
+
# of a StackSet operation. A stack instance is a reference to an
|
8383
8471
|
# attempted or actual stack in a given account within a given Region. A
|
8384
8472
|
# stack instance can exist without a stack—for example, if the stack
|
8385
8473
|
# couldn't be created for some reason. A stack instance is associated
|
8386
|
-
# with only one
|
8387
|
-
# associated
|
8388
|
-
#
|
8474
|
+
# with only one StackSet. Each stack instance contains the ID of its
|
8475
|
+
# associated StackSet, in addition to the ID of the actual stack and the
|
8476
|
+
# stack status.
|
8389
8477
|
#
|
8390
8478
|
# @!attribute [rw] stack_set_id
|
8391
|
-
# The name or unique ID of the
|
8479
|
+
# The name or unique ID of the StackSet that the stack instance is
|
8392
8480
|
# associated with.
|
8393
8481
|
# @return [String]
|
8394
8482
|
#
|
@@ -8407,7 +8495,7 @@ module Aws::CloudFormation
|
|
8407
8495
|
# @return [String]
|
8408
8496
|
#
|
8409
8497
|
# @!attribute [rw] parameter_overrides
|
8410
|
-
# A list of parameters from the
|
8498
|
+
# A list of parameters from the StackSet template whose values have
|
8411
8499
|
# been overridden in this stack instance.
|
8412
8500
|
# @return [Array<Types::Parameter>]
|
8413
8501
|
#
|
@@ -8427,8 +8515,8 @@ module Aws::CloudFormation
|
|
8427
8515
|
# `StackInstanceSummary` member that is a peer to this `Status`
|
8428
8516
|
# member.
|
8429
8517
|
#
|
8430
|
-
# * `OUTDATED`: The stack isn't currently up to date with the
|
8431
|
-
#
|
8518
|
+
# * `OUTDATED`: The stack isn't currently up to date with the
|
8519
|
+
# StackSet because:
|
8432
8520
|
#
|
8433
8521
|
# * The associated stack failed during a `CreateStackSet` or
|
8434
8522
|
# `UpdateStackSet` operation.
|
@@ -8436,7 +8524,7 @@ module Aws::CloudFormation
|
|
8436
8524
|
# * The stack was part of a `CreateStackSet` or `UpdateStackSet`
|
8437
8525
|
# operation that failed or was stopped before the stack was
|
8438
8526
|
# created or updated.
|
8439
|
-
# * `CURRENT`: The stack is currently up to date with the
|
8527
|
+
# * `CURRENT`: The stack is currently up to date with the StackSet.
|
8440
8528
|
# @return [String]
|
8441
8529
|
#
|
8442
8530
|
# @!attribute [rw] stack_instance_status
|
@@ -8460,19 +8548,19 @@ module Aws::CloudFormation
|
|
8460
8548
|
#
|
8461
8549
|
# @!attribute [rw] drift_status
|
8462
8550
|
# Status of the stack instance's actual configuration compared to the
|
8463
|
-
# expected template and parameter configuration of the
|
8464
|
-
#
|
8551
|
+
# expected template and parameter configuration of the StackSet it
|
8552
|
+
# belongs to.
|
8465
8553
|
#
|
8466
8554
|
# * `DRIFTED`: The stack differs from the expected template and
|
8467
|
-
# parameter configuration of the
|
8468
|
-
#
|
8555
|
+
# parameter configuration of the StackSet it belongs to. A stack
|
8556
|
+
# instance is considered to have drifted if one or more of the
|
8469
8557
|
# resources in the associated stack have drifted.
|
8470
8558
|
#
|
8471
8559
|
# * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
|
8472
|
-
# instance differs from its expected
|
8560
|
+
# instance differs from its expected StackSet configuration.
|
8473
8561
|
#
|
8474
8562
|
# * `IN_SYNC`: The stack instance's actual configuration matches its
|
8475
|
-
# expected
|
8563
|
+
# expected StackSset configuration.
|
8476
8564
|
#
|
8477
8565
|
# * `UNKNOWN`: This value is reserved for future use.
|
8478
8566
|
# @return [String]
|
@@ -8480,7 +8568,7 @@ module Aws::CloudFormation
|
|
8480
8568
|
# @!attribute [rw] last_drift_check_timestamp
|
8481
8569
|
# Most recent time when CloudFormation performed a drift detection
|
8482
8570
|
# operation on the stack instance. This value will be `NULL` for any
|
8483
|
-
# stack instance
|
8571
|
+
# stack instance that drift detection hasn't yet been performed on.
|
8484
8572
|
# @return [Time]
|
8485
8573
|
#
|
8486
8574
|
# @!attribute [rw] last_operation_id
|
@@ -8511,21 +8599,21 @@ module Aws::CloudFormation
|
|
8511
8599
|
#
|
8512
8600
|
# @!attribute [rw] detailed_status
|
8513
8601
|
# * `CANCELLED`: The operation in the specified account and Region has
|
8514
|
-
# been canceled. This is either because a user has stopped the
|
8515
|
-
#
|
8516
|
-
# operation has been exceeded.
|
8602
|
+
# been canceled. This is either because a user has stopped the
|
8603
|
+
# StackSet operation, or because the failure tolerance of the
|
8604
|
+
# StackSet operation has been exceeded.
|
8517
8605
|
#
|
8518
8606
|
# * `FAILED`: The operation in the specified account and Region
|
8519
|
-
# failed. If the
|
8520
|
-
# a Region, the failure tolerance for the
|
8607
|
+
# failed. If the StackSet operation fails in enough accounts within
|
8608
|
+
# a Region, the failure tolerance for the StackSet operation as a
|
8521
8609
|
# whole might be exceeded.
|
8522
8610
|
#
|
8523
8611
|
# * `FAILED_IMPORT`: The import of the stack instance in the specified
|
8524
8612
|
# account and Region failed and left the stack in an unstable state.
|
8525
8613
|
# Once the issues causing the failure are fixed, the import
|
8526
|
-
# operation can be retried. If enough
|
8614
|
+
# operation can be retried. If enough StackSet operations fail in
|
8527
8615
|
# enough accounts within a Region, the failure tolerance for the
|
8528
|
-
#
|
8616
|
+
# StackSet operation as a whole might be exceeded.
|
8529
8617
|
#
|
8530
8618
|
# * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
|
8531
8619
|
# left the stack in an unstable state. Stacks in this state are
|
@@ -8661,7 +8749,7 @@ module Aws::CloudFormation
|
|
8661
8749
|
# instance.
|
8662
8750
|
#
|
8663
8751
|
# @!attribute [rw] stack_set_id
|
8664
|
-
# The name or unique ID of the
|
8752
|
+
# The name or unique ID of the StackSet that the stack instance is
|
8665
8753
|
# associated with.
|
8666
8754
|
# @return [String]
|
8667
8755
|
#
|
@@ -8695,8 +8783,8 @@ module Aws::CloudFormation
|
|
8695
8783
|
# look at the `DetailedStatus` member returned in the
|
8696
8784
|
# `StackInstanceSummary` member.
|
8697
8785
|
#
|
8698
|
-
# * `OUTDATED`: The stack isn't currently up to date with the
|
8699
|
-
#
|
8786
|
+
# * `OUTDATED`: The stack isn't currently up to date with the
|
8787
|
+
# StackSet because:
|
8700
8788
|
#
|
8701
8789
|
# * The associated stack failed during a `CreateStackSet` or
|
8702
8790
|
# `UpdateStackSet` operation.
|
@@ -8704,7 +8792,7 @@ module Aws::CloudFormation
|
|
8704
8792
|
# * The stack was part of a `CreateStackSet` or `UpdateStackSet`
|
8705
8793
|
# operation that failed or was stopped before the stack was
|
8706
8794
|
# created or updated.
|
8707
|
-
# * `CURRENT`: The stack is currently up to date with the
|
8795
|
+
# * `CURRENT`: The stack is currently up to date with the StackSet.
|
8708
8796
|
# @return [String]
|
8709
8797
|
#
|
8710
8798
|
# @!attribute [rw] status_reason
|
@@ -8728,19 +8816,19 @@ module Aws::CloudFormation
|
|
8728
8816
|
#
|
8729
8817
|
# @!attribute [rw] drift_status
|
8730
8818
|
# Status of the stack instance's actual configuration compared to the
|
8731
|
-
# expected template and parameter configuration of the
|
8732
|
-
#
|
8819
|
+
# expected template and parameter configuration of the StackSet it
|
8820
|
+
# belongs to.
|
8733
8821
|
#
|
8734
8822
|
# * `DRIFTED`: The stack differs from the expected template and
|
8735
|
-
# parameter configuration of the
|
8736
|
-
#
|
8823
|
+
# parameter configuration of the StackSet it belongs to. A stack
|
8824
|
+
# instance is considered to have drifted if one or more of the
|
8737
8825
|
# resources in the associated stack have drifted.
|
8738
8826
|
#
|
8739
8827
|
# * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
|
8740
|
-
# instance differs from its expected
|
8828
|
+
# instance differs from its expected StackSet configuration.
|
8741
8829
|
#
|
8742
8830
|
# * `IN_SYNC`: The stack instance's actual configuration matches its
|
8743
|
-
# expected
|
8831
|
+
# expected StackSet configuration.
|
8744
8832
|
#
|
8745
8833
|
# * `UNKNOWN`: This value is reserved for future use.
|
8746
8834
|
# @return [String]
|
@@ -8748,7 +8836,7 @@ module Aws::CloudFormation
|
|
8748
8836
|
# @!attribute [rw] last_drift_check_timestamp
|
8749
8837
|
# Most recent time when CloudFormation performed a drift detection
|
8750
8838
|
# operation on the stack instance. This value will be `NULL` for any
|
8751
|
-
# stack instance
|
8839
|
+
# stack instance that drift detection hasn't yet been performed on.
|
8752
8840
|
# @return [Time]
|
8753
8841
|
#
|
8754
8842
|
# @!attribute [rw] last_operation_id
|
@@ -9359,40 +9447,40 @@ module Aws::CloudFormation
|
|
9359
9447
|
include Aws::Structure
|
9360
9448
|
end
|
9361
9449
|
|
9362
|
-
# A structure that contains information about a
|
9363
|
-
#
|
9364
|
-
#
|
9365
|
-
#
|
9366
|
-
#
|
9450
|
+
# A structure that contains information about a StackSet. With
|
9451
|
+
# StackSets, you can provision stacks across Amazon Web Services
|
9452
|
+
# accounts and Regions from a single CloudFormation template. Each stack
|
9453
|
+
# is based on the same CloudFormation template, but you can customize
|
9454
|
+
# individual stacks using parameters.
|
9367
9455
|
#
|
9368
9456
|
# @!attribute [rw] stack_set_name
|
9369
|
-
# The name that's associated with the
|
9457
|
+
# The name that's associated with the StackSet.
|
9370
9458
|
# @return [String]
|
9371
9459
|
#
|
9372
9460
|
# @!attribute [rw] stack_set_id
|
9373
|
-
# The ID of the
|
9461
|
+
# The ID of the StackSet.
|
9374
9462
|
# @return [String]
|
9375
9463
|
#
|
9376
9464
|
# @!attribute [rw] description
|
9377
|
-
# A description of the
|
9378
|
-
#
|
9465
|
+
# A description of the StackSet that you specify when the StackSet is
|
9466
|
+
# created or updated.
|
9379
9467
|
# @return [String]
|
9380
9468
|
#
|
9381
9469
|
# @!attribute [rw] status
|
9382
|
-
# The status of the
|
9470
|
+
# The status of the StackSet.
|
9383
9471
|
# @return [String]
|
9384
9472
|
#
|
9385
9473
|
# @!attribute [rw] template_body
|
9386
9474
|
# The structure that contains the body of the template that was used
|
9387
|
-
# to create or update the
|
9475
|
+
# to create or update the StackSet.
|
9388
9476
|
# @return [String]
|
9389
9477
|
#
|
9390
9478
|
# @!attribute [rw] parameters
|
9391
|
-
# A list of input parameters for a
|
9479
|
+
# A list of input parameters for a StackSet.
|
9392
9480
|
# @return [Array<Types::Parameter>]
|
9393
9481
|
#
|
9394
9482
|
# @!attribute [rw] capabilities
|
9395
|
-
# The capabilities that are allowed in the
|
9483
|
+
# The capabilities that are allowed in the StackSet. Some StackSet
|
9396
9484
|
# templates might include resources that can affect permissions in
|
9397
9485
|
# your Amazon Web Services account—for example, by creating new
|
9398
9486
|
# Identity and Access Management (IAM) users. For more information,
|
@@ -9404,12 +9492,12 @@ module Aws::CloudFormation
|
|
9404
9492
|
# @return [Array<String>]
|
9405
9493
|
#
|
9406
9494
|
# @!attribute [rw] tags
|
9407
|
-
# A list of tags that specify information about the
|
9495
|
+
# A list of tags that specify information about the StackSet. A
|
9408
9496
|
# maximum number of 50 tags can be specified.
|
9409
9497
|
# @return [Array<Types::Tag>]
|
9410
9498
|
#
|
9411
9499
|
# @!attribute [rw] stack_set_arn
|
9412
|
-
# The Amazon Resource Name (ARN) of the
|
9500
|
+
# The Amazon Resource Name (ARN) of the StackSet.
|
9413
9501
|
# @return [String]
|
9414
9502
|
#
|
9415
9503
|
# @!attribute [rw] administration_role_arn
|
@@ -9417,9 +9505,9 @@ module Aws::CloudFormation
|
|
9417
9505
|
# update the stack set.
|
9418
9506
|
#
|
9419
9507
|
# Use customized administrator roles to control which users or groups
|
9420
|
-
# can manage specific
|
9421
|
-
#
|
9422
|
-
#
|
9508
|
+
# can manage specific StackSets within the same administrator account.
|
9509
|
+
# For more information, see [Prerequisites for using CloudFormation
|
9510
|
+
# StackSets][1] in the *CloudFormation User Guide*.
|
9423
9511
|
#
|
9424
9512
|
#
|
9425
9513
|
#
|
@@ -9428,28 +9516,29 @@ module Aws::CloudFormation
|
|
9428
9516
|
#
|
9429
9517
|
# @!attribute [rw] execution_role_name
|
9430
9518
|
# The name of the IAM execution role used to create or update the
|
9431
|
-
#
|
9519
|
+
# StackSet.
|
9432
9520
|
#
|
9433
9521
|
# Use customized execution roles to control which stack resources
|
9434
|
-
# users and groups can include in their
|
9522
|
+
# users and groups can include in their StackSets.
|
9435
9523
|
# @return [String]
|
9436
9524
|
#
|
9437
9525
|
# @!attribute [rw] stack_set_drift_detection_details
|
9438
|
-
# Detailed information about the drift status of the
|
9526
|
+
# Detailed information about the drift status of the StackSet.
|
9439
9527
|
#
|
9440
|
-
# For
|
9441
|
-
#
|
9528
|
+
# For StackSets, contains information about the last *completed* drift
|
9529
|
+
# operation performed on the StackSet. Information about drift
|
9442
9530
|
# operations currently in progress isn't included.
|
9443
9531
|
# @return [Types::StackSetDriftDetectionDetails]
|
9444
9532
|
#
|
9445
9533
|
# @!attribute [rw] auto_deployment
|
9446
|
-
#
|
9447
|
-
#
|
9448
|
-
#
|
9534
|
+
# Describes whether StackSets automatically deploys to Organizations
|
9535
|
+
# accounts that are added to a target organization or organizational
|
9536
|
+
# unit (OU). Valid only if the StackSet uses service-managed
|
9537
|
+
# permissions.
|
9449
9538
|
# @return [Types::AutoDeployment]
|
9450
9539
|
#
|
9451
9540
|
# @!attribute [rw] permission_model
|
9452
|
-
# Describes how the IAM roles required for
|
9541
|
+
# Describes how the IAM roles required for StackSet operations are
|
9453
9542
|
# created.
|
9454
9543
|
#
|
9455
9544
|
# * With `self-managed` permissions, you must create the administrator
|
@@ -9459,7 +9548,7 @@ module Aws::CloudFormation
|
|
9459
9548
|
# * With `service-managed` permissions, StackSets automatically
|
9460
9549
|
# creates the IAM roles required to deploy to accounts managed by
|
9461
9550
|
# Organizations. For more information, see [Activate trusted access
|
9462
|
-
# for
|
9551
|
+
# for StackSets with Organizations][2].
|
9463
9552
|
#
|
9464
9553
|
#
|
9465
9554
|
#
|
@@ -9512,7 +9601,7 @@ module Aws::CloudFormation
|
|
9512
9601
|
include Aws::Structure
|
9513
9602
|
end
|
9514
9603
|
|
9515
|
-
# One of the targets for the
|
9604
|
+
# One of the targets for the StackSet. Returned by the
|
9516
9605
|
# [ListStackSetAutoDeploymentTargets][1] API operation.
|
9517
9606
|
#
|
9518
9607
|
#
|
@@ -9521,7 +9610,7 @@ module Aws::CloudFormation
|
|
9521
9610
|
#
|
9522
9611
|
# @!attribute [rw] organizational_unit_id
|
9523
9612
|
# The organization root ID or organizational unit (OU) IDs where the
|
9524
|
-
#
|
9613
|
+
# StackSet is targeted.
|
9525
9614
|
# @return [String]
|
9526
9615
|
#
|
9527
9616
|
# @!attribute [rw] regions
|
@@ -9537,14 +9626,14 @@ module Aws::CloudFormation
|
|
9537
9626
|
include Aws::Structure
|
9538
9627
|
end
|
9539
9628
|
|
9540
|
-
# Detailed information about the drift status of the
|
9629
|
+
# Detailed information about the drift status of the StackSet.
|
9541
9630
|
#
|
9542
|
-
# For
|
9543
|
-
# operation performed on the
|
9631
|
+
# For StackSets, contains information about the last *completed* drift
|
9632
|
+
# operation performed on the StackSet. Information about drift
|
9544
9633
|
# operations in-progress isn't included.
|
9545
9634
|
#
|
9546
|
-
# For
|
9547
|
-
# currently being performed on the
|
9635
|
+
# For StackSet operations, includes information about drift operations
|
9636
|
+
# currently being performed on the StackSet.
|
9548
9637
|
#
|
9549
9638
|
# For more information, see [Performing drift detection on
|
9550
9639
|
# CloudFormation StackSets][1] in the *CloudFormation User Guide*.
|
@@ -9554,27 +9643,23 @@ module Aws::CloudFormation
|
|
9554
9643
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
|
9555
9644
|
#
|
9556
9645
|
# @!attribute [rw] drift_status
|
9557
|
-
# Status of the
|
9558
|
-
# expected template and parameter configuration.
|
9559
|
-
# considered to have drifted if one or more of its stack instances
|
9560
|
-
# have drifted from their expected template and parameter
|
9561
|
-
# configuration.
|
9646
|
+
# Status of the StackSet's actual configuration compared to its
|
9647
|
+
# expected template and parameter configuration.
|
9562
9648
|
#
|
9563
9649
|
# * `DRIFTED`: One or more of the stack instances belonging to the
|
9564
|
-
#
|
9650
|
+
# StackSet differs from the expected template and parameter
|
9565
9651
|
# configuration. A stack instance is considered to have drifted if
|
9566
9652
|
# one or more of the resources in the associated stack have drifted.
|
9567
9653
|
#
|
9568
|
-
# * `NOT_CHECKED`: CloudFormation hasn't checked the
|
9654
|
+
# * `NOT_CHECKED`: CloudFormation hasn't checked the StackSet for
|
9569
9655
|
# drift.
|
9570
9656
|
#
|
9571
|
-
# * `IN_SYNC`: All of the stack instances belonging to the
|
9572
|
-
# stack match
|
9573
|
-
# configuration.
|
9657
|
+
# * `IN_SYNC`: All of the stack instances belonging to the StackSet
|
9658
|
+
# stack match the expected template and parameter configuration.
|
9574
9659
|
# @return [String]
|
9575
9660
|
#
|
9576
9661
|
# @!attribute [rw] drift_detection_status
|
9577
|
-
# The status of the
|
9662
|
+
# The status of the StackSet drift detection operation.
|
9578
9663
|
#
|
9579
9664
|
# * `COMPLETED`: The drift detection operation completed without
|
9580
9665
|
# failing on any stack instances.
|
@@ -9593,19 +9678,18 @@ module Aws::CloudFormation
|
|
9593
9678
|
#
|
9594
9679
|
# @!attribute [rw] last_drift_check_timestamp
|
9595
9680
|
# Most recent time when CloudFormation performed a drift detection
|
9596
|
-
# operation on the
|
9597
|
-
#
|
9681
|
+
# operation on the StackSet. This value will be `NULL` for any
|
9682
|
+
# StackSet that drift detection hasn't yet been performed on.
|
9598
9683
|
# @return [Time]
|
9599
9684
|
#
|
9600
9685
|
# @!attribute [rw] total_stack_instances_count
|
9601
|
-
# The total number of stack instances belonging to this
|
9686
|
+
# The total number of stack instances belonging to this StackSet.
|
9602
9687
|
#
|
9603
9688
|
# The total number of stack instances is equal to the total of:
|
9604
9689
|
#
|
9605
|
-
# * Stack instances that match the
|
9690
|
+
# * Stack instances that match the StackSet configuration.
|
9606
9691
|
#
|
9607
|
-
# * Stack instances that have drifted from the
|
9608
|
-
# configuration.
|
9692
|
+
# * Stack instances that have drifted from the StackSet configuration.
|
9609
9693
|
#
|
9610
9694
|
# * Stack instances where the drift detection operation has failed.
|
9611
9695
|
#
|
@@ -9614,7 +9698,7 @@ module Aws::CloudFormation
|
|
9614
9698
|
#
|
9615
9699
|
# @!attribute [rw] drifted_stack_instances_count
|
9616
9700
|
# The number of stack instances that have drifted from the expected
|
9617
|
-
# template and parameter configuration of the
|
9701
|
+
# template and parameter configuration of the StackSet. A stack
|
9618
9702
|
# instance is considered to have drifted if one or more of the
|
9619
9703
|
# resources in the associated stack don't match their expected
|
9620
9704
|
# configuration.
|
@@ -9622,7 +9706,7 @@ module Aws::CloudFormation
|
|
9622
9706
|
#
|
9623
9707
|
# @!attribute [rw] in_sync_stack_instances_count
|
9624
9708
|
# The number of stack instances which match the expected template and
|
9625
|
-
# parameter configuration of the
|
9709
|
+
# parameter configuration of the StackSet.
|
9626
9710
|
# @return [Integer]
|
9627
9711
|
#
|
9628
9712
|
# @!attribute [rw] in_progress_stack_instances_count
|
@@ -9650,36 +9734,36 @@ module Aws::CloudFormation
|
|
9650
9734
|
include Aws::Structure
|
9651
9735
|
end
|
9652
9736
|
|
9653
|
-
# You can't yet delete this
|
9654
|
-
# more stack instances. Delete all stack instances from the
|
9655
|
-
# before deleting the
|
9737
|
+
# You can't yet delete this StackSet, because it still contains one or
|
9738
|
+
# more stack instances. Delete all stack instances from the StackSet
|
9739
|
+
# before deleting the StackSet.
|
9656
9740
|
#
|
9657
9741
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetNotEmptyException AWS API Documentation
|
9658
9742
|
#
|
9659
9743
|
class StackSetNotEmptyException < Aws::EmptyStructure; end
|
9660
9744
|
|
9661
|
-
# The specified
|
9745
|
+
# The specified StackSet doesn't exist.
|
9662
9746
|
#
|
9663
9747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetNotFoundException AWS API Documentation
|
9664
9748
|
#
|
9665
9749
|
class StackSetNotFoundException < Aws::EmptyStructure; end
|
9666
9750
|
|
9667
|
-
# The structure that contains information about a
|
9751
|
+
# The structure that contains information about a StackSet operation.
|
9668
9752
|
#
|
9669
9753
|
# @!attribute [rw] operation_id
|
9670
|
-
# The unique ID of a
|
9754
|
+
# The unique ID of a StackSet operation.
|
9671
9755
|
# @return [String]
|
9672
9756
|
#
|
9673
9757
|
# @!attribute [rw] stack_set_id
|
9674
|
-
# The ID of the
|
9758
|
+
# The ID of the StackSet.
|
9675
9759
|
# @return [String]
|
9676
9760
|
#
|
9677
9761
|
# @!attribute [rw] action
|
9678
|
-
# The type of
|
9679
|
-
# Create and delete operations affect only the specified stack
|
9680
|
-
# instances that are associated with the specified
|
9681
|
-
# operations affect both the
|
9682
|
-
# associated stack
|
9762
|
+
# The type of StackSet operation: `CREATE`, `UPDATE`, or `DELETE`.
|
9763
|
+
# Create and delete operations affect only the specified stack
|
9764
|
+
# instances that are associated with the specified StackSet. Update
|
9765
|
+
# operations affect both the StackSet itself, in addition to *all*
|
9766
|
+
# associated stack instances.
|
9683
9767
|
# @return [String]
|
9684
9768
|
#
|
9685
9769
|
# @!attribute [rw] status
|
@@ -9712,29 +9796,29 @@ module Aws::CloudFormation
|
|
9712
9796
|
#
|
9713
9797
|
#
|
9714
9798
|
#
|
9715
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
9799
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes
|
9716
9800
|
# @return [String]
|
9717
9801
|
#
|
9718
9802
|
# @!attribute [rw] operation_preferences
|
9719
|
-
# The preferences for how CloudFormation performs this
|
9803
|
+
# The preferences for how CloudFormation performs this StackSet
|
9720
9804
|
# operation.
|
9721
9805
|
# @return [Types::StackSetOperationPreferences]
|
9722
9806
|
#
|
9723
9807
|
# @!attribute [rw] retain_stacks
|
9724
|
-
# For
|
9725
|
-
# to remove the stack instances from the specified
|
9808
|
+
# For StackSet operations of action type `DELETE`, specifies whether
|
9809
|
+
# to remove the stack instances from the specified StackSet, but
|
9726
9810
|
# doesn't delete the stacks. You can't re-associate a retained
|
9727
|
-
# stack, or add an existing, saved stack to a new
|
9811
|
+
# stack, or add an existing, saved stack to a new StackSet.
|
9728
9812
|
# @return [Boolean]
|
9729
9813
|
#
|
9730
9814
|
# @!attribute [rw] administration_role_arn
|
9731
9815
|
# The Amazon Resource Name (ARN) of the IAM role used to perform this
|
9732
|
-
#
|
9816
|
+
# StackSet operation.
|
9733
9817
|
#
|
9734
9818
|
# Use customized administrator roles to control which users or groups
|
9735
|
-
# can manage specific
|
9736
|
-
#
|
9737
|
-
#
|
9819
|
+
# can manage specific StackSets within the same administrator account.
|
9820
|
+
# For more information, see [Grant self-managed permissions][1] in the
|
9821
|
+
# *CloudFormation User Guide*.
|
9738
9822
|
#
|
9739
9823
|
#
|
9740
9824
|
#
|
@@ -9743,10 +9827,10 @@ module Aws::CloudFormation
|
|
9743
9827
|
#
|
9744
9828
|
# @!attribute [rw] execution_role_name
|
9745
9829
|
# The name of the IAM execution role used to create or update the
|
9746
|
-
#
|
9830
|
+
# StackSet.
|
9747
9831
|
#
|
9748
9832
|
# Use customized execution roles to control which stack resources
|
9749
|
-
# users and groups can include in their
|
9833
|
+
# users and groups can include in their StackSets.
|
9750
9834
|
# @return [String]
|
9751
9835
|
#
|
9752
9836
|
# @!attribute [rw] creation_timestamp
|
@@ -9759,23 +9843,23 @@ module Aws::CloudFormation
|
|
9759
9843
|
# @return [Time]
|
9760
9844
|
#
|
9761
9845
|
# @!attribute [rw] end_timestamp
|
9762
|
-
# The time at which the
|
9846
|
+
# The time at which the StackSet operation ended, across all accounts
|
9763
9847
|
# and Regions specified. Note that this doesn't necessarily mean that
|
9764
|
-
# the
|
9848
|
+
# the StackSet operation was successful, or even attempted, in each
|
9765
9849
|
# account or Region.
|
9766
9850
|
# @return [Time]
|
9767
9851
|
#
|
9768
9852
|
# @!attribute [rw] deployment_targets
|
9769
|
-
#
|
9770
|
-
#
|
9853
|
+
# The Organizations accounts affected by the stack operation. Valid
|
9854
|
+
# only if the StackSet uses service-managed permissions.
|
9771
9855
|
# @return [Types::DeploymentTargets]
|
9772
9856
|
#
|
9773
9857
|
# @!attribute [rw] stack_set_drift_detection_details
|
9774
|
-
# Detailed information about the drift status of the
|
9858
|
+
# Detailed information about the drift status of the StackSet. This
|
9775
9859
|
# includes information about drift operations currently being
|
9776
|
-
# performed on the
|
9860
|
+
# performed on the StackSet.
|
9777
9861
|
#
|
9778
|
-
# This information will only be present for
|
9862
|
+
# This information will only be present for StackSet operations whose
|
9779
9863
|
# `Action` type is `DETECT_DRIFT`.
|
9780
9864
|
#
|
9781
9865
|
# For more information, see [Performing drift detection on
|
@@ -9815,11 +9899,11 @@ module Aws::CloudFormation
|
|
9815
9899
|
include Aws::Structure
|
9816
9900
|
end
|
9817
9901
|
|
9818
|
-
# The user-specified preferences for how CloudFormation performs a
|
9819
|
-
#
|
9902
|
+
# The user-specified preferences for how CloudFormation performs a
|
9903
|
+
# StackSet operation.
|
9820
9904
|
#
|
9821
9905
|
# For more information about maximum concurrent accounts and failure
|
9822
|
-
# tolerance, see [
|
9906
|
+
# tolerance, see [StackSet operation options][1].
|
9823
9907
|
#
|
9824
9908
|
# <note markdown="1"> `StackSetOperationPreferences` don't apply to `AutoDeployment`, even
|
9825
9909
|
# if it's enabled.
|
@@ -9828,7 +9912,7 @@ module Aws::CloudFormation
|
|
9828
9912
|
#
|
9829
9913
|
#
|
9830
9914
|
#
|
9831
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
9915
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
9832
9916
|
#
|
9833
9917
|
# @!attribute [rw] region_concurrency_type
|
9834
9918
|
# The concurrency type of deploying StackSets operations in Regions,
|
@@ -9841,10 +9925,10 @@ module Aws::CloudFormation
|
|
9841
9925
|
# @return [Array<String>]
|
9842
9926
|
#
|
9843
9927
|
# @!attribute [rw] failure_tolerance_count
|
9844
|
-
# The number of accounts
|
9845
|
-
#
|
9846
|
-
#
|
9847
|
-
#
|
9928
|
+
# The number of accounts per Region this operation can fail in before
|
9929
|
+
# CloudFormation stops the operation in that Region. If the operation
|
9930
|
+
# is stopped in a Region, CloudFormation doesn't attempt the
|
9931
|
+
# operation in any subsequent Regions.
|
9848
9932
|
#
|
9849
9933
|
# You can specify either `FailureToleranceCount` or
|
9850
9934
|
# `FailureTolerancePercentage`, but not both.
|
@@ -9853,10 +9937,10 @@ module Aws::CloudFormation
|
|
9853
9937
|
# @return [Integer]
|
9854
9938
|
#
|
9855
9939
|
# @!attribute [rw] failure_tolerance_percentage
|
9856
|
-
# The percentage of accounts
|
9857
|
-
#
|
9858
|
-
#
|
9859
|
-
#
|
9940
|
+
# The percentage of accounts per Region this stack operation can fail
|
9941
|
+
# in before CloudFormation stops the operation in that Region. If the
|
9942
|
+
# operation is stopped in a Region, CloudFormation doesn't attempt
|
9943
|
+
# the operation in any subsequent Regions.
|
9860
9944
|
#
|
9861
9945
|
# When calculating the number of accounts based on the specified
|
9862
9946
|
# percentage, CloudFormation rounds *down* to the next whole number.
|
@@ -9922,7 +10006,7 @@ module Aws::CloudFormation
|
|
9922
10006
|
#
|
9923
10007
|
# * `SOFT_FAILURE_TOLERANCE`: This option decouples
|
9924
10008
|
# `FailureToleranceCount` from the actual concurrency. This allows
|
9925
|
-
#
|
10009
|
+
# StackSet operations to run at the concurrency level set by the
|
9926
10010
|
# `MaxConcurrentCount` value, or `MaxConcurrentPercentage`,
|
9927
10011
|
# regardless of the number of failures.
|
9928
10012
|
# @return [String]
|
@@ -9955,19 +10039,19 @@ module Aws::CloudFormation
|
|
9955
10039
|
# @return [String]
|
9956
10040
|
#
|
9957
10041
|
# @!attribute [rw] status
|
9958
|
-
# The result status of the
|
9959
|
-
#
|
10042
|
+
# The result status of the StackSet operation for the given account in
|
10043
|
+
# the given Region.
|
9960
10044
|
#
|
9961
10045
|
# * `CANCELLED`: The operation in the specified account and Region has
|
9962
|
-
# been canceled. This is either because a user has stopped the
|
9963
|
-
#
|
9964
|
-
# operation has been exceeded.
|
10046
|
+
# been canceled. This is either because a user has stopped the
|
10047
|
+
# StackSet operation, or because the failure tolerance of the
|
10048
|
+
# StackSet operation has been exceeded.
|
9965
10049
|
#
|
9966
10050
|
# * `FAILED`: The operation in the specified account and Region
|
9967
10051
|
# failed.
|
9968
10052
|
#
|
9969
|
-
# If the
|
9970
|
-
# Region, the failure tolerance for the
|
10053
|
+
# If the StackSet operation fails in enough accounts within a
|
10054
|
+
# Region, the failure tolerance for the StackSet operation as a
|
9971
10055
|
# whole might be exceeded.
|
9972
10056
|
#
|
9973
10057
|
# * `RUNNING`: The operation in the specified account and Region is
|
@@ -9986,7 +10070,7 @@ module Aws::CloudFormation
|
|
9986
10070
|
#
|
9987
10071
|
# @!attribute [rw] account_gate_result
|
9988
10072
|
# The results of the account gate function CloudFormation invokes, if
|
9989
|
-
# present, before proceeding with
|
10073
|
+
# present, before proceeding with StackSet operations in an account.
|
9990
10074
|
# @return [Types::AccountGateResult]
|
9991
10075
|
#
|
9992
10076
|
# @!attribute [rw] organizational_unit_id
|
@@ -10031,14 +10115,14 @@ module Aws::CloudFormation
|
|
10031
10115
|
# operation.
|
10032
10116
|
#
|
10033
10117
|
# @!attribute [rw] operation_id
|
10034
|
-
# The unique ID of the
|
10118
|
+
# The unique ID of the StackSet operation.
|
10035
10119
|
# @return [String]
|
10036
10120
|
#
|
10037
10121
|
# @!attribute [rw] action
|
10038
10122
|
# The type of operation: `CREATE`, `UPDATE`, or `DELETE`. Create and
|
10039
10123
|
# delete operations affect only the specified stack instances that are
|
10040
|
-
# associated with the specified
|
10041
|
-
# both the
|
10124
|
+
# associated with the specified StackSet. Update operations affect
|
10125
|
+
# both the StackSet itself and *all* associated StackSet instances.
|
10042
10126
|
# @return [String]
|
10043
10127
|
#
|
10044
10128
|
# @!attribute [rw] status
|
@@ -10055,8 +10139,8 @@ module Aws::CloudFormation
|
|
10055
10139
|
#
|
10056
10140
|
# * `QUEUED`: \[Service-managed permissions\] For automatic
|
10057
10141
|
# deployments that require a sequence of operations, the operation
|
10058
|
-
# is queued to be performed. For more information, see the [
|
10059
|
-
#
|
10142
|
+
# is queued to be performed. For more information, see the [StackSet
|
10143
|
+
# status codes][1] in the *CloudFormation User Guide*.
|
10060
10144
|
#
|
10061
10145
|
# * `RUNNING`: The operation is currently being performed.
|
10062
10146
|
#
|
@@ -10071,12 +10155,12 @@ module Aws::CloudFormation
|
|
10071
10155
|
#
|
10072
10156
|
#
|
10073
10157
|
#
|
10074
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
10158
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes
|
10075
10159
|
# @return [String]
|
10076
10160
|
#
|
10077
10161
|
# @!attribute [rw] creation_timestamp
|
10078
10162
|
# The time at which the operation was initiated. Note that the
|
10079
|
-
# creation times for the
|
10163
|
+
# creation times for the StackSet operation might differ from the
|
10080
10164
|
# creation time of the individual stacks themselves. This is because
|
10081
10165
|
# CloudFormation needs to perform preparatory work for the operation,
|
10082
10166
|
# such as dispatching the work to the requested Regions, before
|
@@ -10084,9 +10168,9 @@ module Aws::CloudFormation
|
|
10084
10168
|
# @return [Time]
|
10085
10169
|
#
|
10086
10170
|
# @!attribute [rw] end_timestamp
|
10087
|
-
# The time at which the
|
10171
|
+
# The time at which the StackSet operation ended, across all accounts
|
10088
10172
|
# and Regions specified. Note that this doesn't necessarily mean that
|
10089
|
-
# the
|
10173
|
+
# the StackSet operation was successful, or even attempted, in each
|
10090
10174
|
# account or Region.
|
10091
10175
|
# @return [Time]
|
10092
10176
|
#
|
@@ -10095,19 +10179,19 @@ module Aws::CloudFormation
|
|
10095
10179
|
# @return [String]
|
10096
10180
|
#
|
10097
10181
|
# @!attribute [rw] status_details
|
10098
|
-
# Detailed information about the
|
10182
|
+
# Detailed information about the StackSet operation.
|
10099
10183
|
# @return [Types::StackSetOperationStatusDetails]
|
10100
10184
|
#
|
10101
10185
|
# @!attribute [rw] operation_preferences
|
10102
10186
|
# The user-specified preferences for how CloudFormation performs a
|
10103
|
-
#
|
10187
|
+
# StackSet operation.
|
10104
10188
|
#
|
10105
10189
|
# For more information about maximum concurrent accounts and failure
|
10106
|
-
# tolerance, see [
|
10190
|
+
# tolerance, see [StackSet operation options][1].
|
10107
10191
|
#
|
10108
10192
|
#
|
10109
10193
|
#
|
10110
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
10194
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
10111
10195
|
# @return [Types::StackSetOperationPreferences]
|
10112
10196
|
#
|
10113
10197
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationSummary AWS API Documentation
|
@@ -10126,23 +10210,23 @@ module Aws::CloudFormation
|
|
10126
10210
|
end
|
10127
10211
|
|
10128
10212
|
# The structures that contain summary information about the specified
|
10129
|
-
#
|
10213
|
+
# StackSet.
|
10130
10214
|
#
|
10131
10215
|
# @!attribute [rw] stack_set_name
|
10132
|
-
# The name of the
|
10216
|
+
# The name of the StackSet.
|
10133
10217
|
# @return [String]
|
10134
10218
|
#
|
10135
10219
|
# @!attribute [rw] stack_set_id
|
10136
|
-
# The ID of the
|
10220
|
+
# The ID of the StackSet.
|
10137
10221
|
# @return [String]
|
10138
10222
|
#
|
10139
10223
|
# @!attribute [rw] description
|
10140
|
-
# A description of the
|
10141
|
-
#
|
10224
|
+
# A description of the StackSet that you specify when the StackSet is
|
10225
|
+
# created or updated.
|
10142
10226
|
# @return [String]
|
10143
10227
|
#
|
10144
10228
|
# @!attribute [rw] status
|
10145
|
-
# The status of the
|
10229
|
+
# The status of the StackSet.
|
10146
10230
|
# @return [String]
|
10147
10231
|
#
|
10148
10232
|
# @!attribute [rw] auto_deployment
|
@@ -10152,7 +10236,7 @@ module Aws::CloudFormation
|
|
10152
10236
|
# @return [Types::AutoDeployment]
|
10153
10237
|
#
|
10154
10238
|
# @!attribute [rw] permission_model
|
10155
|
-
# Describes how the IAM roles required for
|
10239
|
+
# Describes how the IAM roles required for StackSet operations are
|
10156
10240
|
# created.
|
10157
10241
|
#
|
10158
10242
|
# * With `self-managed` permissions, you must create the administrator
|
@@ -10162,7 +10246,7 @@ module Aws::CloudFormation
|
|
10162
10246
|
# * With `service-managed` permissions, StackSets automatically
|
10163
10247
|
# creates the IAM roles required to deploy to accounts managed by
|
10164
10248
|
# Organizations. For more information, see [Activate trusted access
|
10165
|
-
# for
|
10249
|
+
# for StackSets with Organizations][2].
|
10166
10250
|
#
|
10167
10251
|
#
|
10168
10252
|
#
|
@@ -10171,31 +10255,27 @@ module Aws::CloudFormation
|
|
10171
10255
|
# @return [String]
|
10172
10256
|
#
|
10173
10257
|
# @!attribute [rw] drift_status
|
10174
|
-
# Status of the
|
10175
|
-
# expected template and parameter configuration.
|
10176
|
-
# considered to have drifted if one or more of its stack instances
|
10177
|
-
# have drifted from their expected template and parameter
|
10178
|
-
# configuration.
|
10258
|
+
# Status of the StackSet's actual configuration compared to its
|
10259
|
+
# expected template and parameter configuration.
|
10179
10260
|
#
|
10180
10261
|
# * `DRIFTED`: One or more of the stack instances belonging to the
|
10181
|
-
#
|
10262
|
+
# StackSet differs from the expected template and parameter
|
10182
10263
|
# configuration. A stack instance is considered to have drifted if
|
10183
10264
|
# one or more of the resources in the associated stack have drifted.
|
10184
10265
|
#
|
10185
|
-
# * `NOT_CHECKED`: CloudFormation hasn't checked the
|
10266
|
+
# * `NOT_CHECKED`: CloudFormation hasn't checked the StackSet for
|
10186
10267
|
# drift.
|
10187
10268
|
#
|
10188
|
-
# * `IN_SYNC`: All the stack instances belonging to the
|
10189
|
-
#
|
10190
|
-
# configuration.
|
10269
|
+
# * `IN_SYNC`: All the stack instances belonging to the StackSet match
|
10270
|
+
# the expected template and parameter configuration.
|
10191
10271
|
#
|
10192
10272
|
# * `UNKNOWN`: This value is reserved for future use.
|
10193
10273
|
# @return [String]
|
10194
10274
|
#
|
10195
10275
|
# @!attribute [rw] last_drift_check_timestamp
|
10196
10276
|
# Most recent time when CloudFormation performed a drift detection
|
10197
|
-
# operation on the
|
10198
|
-
#
|
10277
|
+
# operation on the StackSet. This value will be `NULL` for any
|
10278
|
+
# StackSet that drift detection hasn't yet been performed on.
|
10199
10279
|
# @return [Time]
|
10200
10280
|
#
|
10201
10281
|
# @!attribute [rw] managed_execution
|
@@ -10310,7 +10390,7 @@ module Aws::CloudFormation
|
|
10310
10390
|
include Aws::Structure
|
10311
10391
|
end
|
10312
10392
|
|
10313
|
-
# Another operation has been performed on this
|
10393
|
+
# Another operation has been performed on this StackSet since the
|
10314
10394
|
# specified operation was performed.
|
10315
10395
|
#
|
10316
10396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StaleRequestException AWS API Documentation
|
@@ -10353,7 +10433,7 @@ module Aws::CloudFormation
|
|
10353
10433
|
end
|
10354
10434
|
|
10355
10435
|
# @!attribute [rw] stack_set_name
|
10356
|
-
# The name or unique ID of the
|
10436
|
+
# The name or unique ID of the StackSet that you want to stop the
|
10357
10437
|
# operation for.
|
10358
10438
|
# @return [String]
|
10359
10439
|
#
|
@@ -10362,11 +10442,12 @@ module Aws::CloudFormation
|
|
10362
10442
|
# @return [String]
|
10363
10443
|
#
|
10364
10444
|
# @!attribute [rw] call_as
|
10365
|
-
#
|
10366
|
-
#
|
10367
|
-
#
|
10445
|
+
# Specifies whether you are acting as an account administrator in the
|
10446
|
+
# organization's management account or as a delegated administrator
|
10447
|
+
# in a member account. Valid only if the StackSet uses service-managed
|
10448
|
+
# permissions.
|
10368
10449
|
#
|
10369
|
-
# By default, `SELF` is specified. Use `SELF` for
|
10450
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
10370
10451
|
# self-managed permissions.
|
10371
10452
|
#
|
10372
10453
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -10402,14 +10483,14 @@ module Aws::CloudFormation
|
|
10402
10483
|
# to store information about an CloudFormation stack.
|
10403
10484
|
#
|
10404
10485
|
# @!attribute [rw] key
|
10405
|
-
#
|
10406
|
-
#
|
10407
|
-
#
|
10486
|
+
# A string used to identify this tag. You can specify a maximum of 128
|
10487
|
+
# characters for a tag key. Tags owned by Amazon Web Services have the
|
10488
|
+
# reserved prefix: `aws:`.
|
10408
10489
|
# @return [String]
|
10409
10490
|
#
|
10410
10491
|
# @!attribute [rw] value
|
10411
|
-
#
|
10412
|
-
#
|
10492
|
+
# A string that contains the value for this tag. You can specify a
|
10493
|
+
# maximum of 256 characters for a tag value.
|
10413
10494
|
# @return [String]
|
10414
10495
|
#
|
10415
10496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag AWS API Documentation
|
@@ -10704,8 +10785,7 @@ module Aws::CloudFormation
|
|
10704
10785
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html
|
10705
10786
|
#
|
10706
10787
|
# @!attribute [rw] arn
|
10707
|
-
# The
|
10708
|
-
# account and Region.
|
10788
|
+
# The ARN for the configuration data, in this account and Region.
|
10709
10789
|
# @return [String]
|
10710
10790
|
#
|
10711
10791
|
# @!attribute [rw] alias
|
@@ -10729,8 +10809,7 @@ module Aws::CloudFormation
|
|
10729
10809
|
# @return [Time]
|
10730
10810
|
#
|
10731
10811
|
# @!attribute [rw] type_arn
|
10732
|
-
# The
|
10733
|
-
# and Region.
|
10812
|
+
# The ARN for the extension, in this account and Region.
|
10734
10813
|
#
|
10735
10814
|
# For public extensions, this will be the ARN assigned when you call
|
10736
10815
|
# the [ActivateType][1] API operation in this account and Region. For
|
@@ -10770,8 +10849,7 @@ module Aws::CloudFormation
|
|
10770
10849
|
# extension.
|
10771
10850
|
#
|
10772
10851
|
# @!attribute [rw] type_arn
|
10773
|
-
# The
|
10774
|
-
# and Region.
|
10852
|
+
# The ARN for the extension, in this account and Region.
|
10775
10853
|
#
|
10776
10854
|
# For public extensions, this will be the ARN assigned when you call
|
10777
10855
|
# the [ActivateType][1] API operation in this account and Region. For
|
@@ -10790,8 +10868,7 @@ module Aws::CloudFormation
|
|
10790
10868
|
# @return [String]
|
10791
10869
|
#
|
10792
10870
|
# @!attribute [rw] type_configuration_arn
|
10793
|
-
# The
|
10794
|
-
# account and Region.
|
10871
|
+
# The ARN for the configuration, in this account and Region.
|
10795
10872
|
# @return [String]
|
10796
10873
|
#
|
10797
10874
|
# @!attribute [rw] type
|
@@ -10906,7 +10983,7 @@ module Aws::CloudFormation
|
|
10906
10983
|
# @return [String]
|
10907
10984
|
#
|
10908
10985
|
# @!attribute [rw] type_arn
|
10909
|
-
# The
|
10986
|
+
# The ARN of the extension.
|
10910
10987
|
# @return [String]
|
10911
10988
|
#
|
10912
10989
|
# @!attribute [rw] last_updated
|
@@ -11043,8 +11120,8 @@ module Aws::CloudFormation
|
|
11043
11120
|
#
|
11044
11121
|
# @!attribute [rw] version_id
|
11045
11122
|
# The ID of a specific version of the extension. The version ID is the
|
11046
|
-
# value at the end of the
|
11047
|
-
#
|
11123
|
+
# value at the end of the ARN assigned to the extension version when
|
11124
|
+
# it's registered.
|
11048
11125
|
# @return [String]
|
11049
11126
|
#
|
11050
11127
|
# @!attribute [rw] is_default_version
|
@@ -11057,7 +11134,7 @@ module Aws::CloudFormation
|
|
11057
11134
|
# @return [Boolean]
|
11058
11135
|
#
|
11059
11136
|
# @!attribute [rw] arn
|
11060
|
-
# The
|
11137
|
+
# The ARN of the extension version.
|
11061
11138
|
# @return [String]
|
11062
11139
|
#
|
11063
11140
|
# @!attribute [rw] time_created
|
@@ -11476,13 +11553,13 @@ module Aws::CloudFormation
|
|
11476
11553
|
end
|
11477
11554
|
|
11478
11555
|
# @!attribute [rw] stack_set_name
|
11479
|
-
# The name or unique ID of the
|
11556
|
+
# The name or unique ID of the StackSet associated with the stack
|
11480
11557
|
# instances.
|
11481
11558
|
# @return [String]
|
11482
11559
|
#
|
11483
11560
|
# @!attribute [rw] accounts
|
11484
11561
|
# \[Self-managed permissions\] The account IDs of one or more Amazon
|
11485
|
-
# Web Services accounts
|
11562
|
+
# Web Services accounts in which you want to update parameter values
|
11486
11563
|
# for stack instances. The overridden parameter values will be applied
|
11487
11564
|
# to all stack instances in the specified accounts and Amazon Web
|
11488
11565
|
# Services Regions.
|
@@ -11491,7 +11568,7 @@ module Aws::CloudFormation
|
|
11491
11568
|
# @return [Array<String>]
|
11492
11569
|
#
|
11493
11570
|
# @!attribute [rw] deployment_targets
|
11494
|
-
# \[Service-managed permissions\] The Organizations accounts
|
11571
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
11495
11572
|
# you want to update parameter values for stack instances. If your
|
11496
11573
|
# update targets OUs, the overridden parameter values only apply to
|
11497
11574
|
# the accounts that are currently in the target OUs and their child
|
@@ -11526,22 +11603,22 @@ module Aws::CloudFormation
|
|
11526
11603
|
# can't specify both a value and set `UsePreviousValue` to `true`.)
|
11527
11604
|
#
|
11528
11605
|
# * To set an overridden parameter back to the value specified in the
|
11529
|
-
#
|
11606
|
+
# StackSet, specify a parameter list but don't include the
|
11530
11607
|
# parameter in the list.
|
11531
11608
|
#
|
11532
11609
|
# * To leave all parameters set to their present values, don't
|
11533
11610
|
# specify this property at all.
|
11534
11611
|
#
|
11535
|
-
# During
|
11536
|
-
#
|
11612
|
+
# During StackSet updates, any parameter values overridden for a stack
|
11613
|
+
# instance aren't updated, but retain their overridden value.
|
11537
11614
|
#
|
11538
11615
|
# You can only override the parameter *values* that are specified in
|
11539
|
-
# the
|
11540
|
-
# `UpdateStackSet` to update the
|
11616
|
+
# the StackSet. To add or delete a parameter itself, use
|
11617
|
+
# `UpdateStackSet` to update the StackSet template. If you add a
|
11541
11618
|
# parameter to a template, before you can override the parameter value
|
11542
|
-
# specified in the
|
11619
|
+
# specified in the StackSet you must first use [UpdateStackSet][1] to
|
11543
11620
|
# update all stack instances with the updated template and parameter
|
11544
|
-
# value specified in the
|
11621
|
+
# value specified in the StackSet. Once a stack instance has been
|
11545
11622
|
# updated with the new parameter, you can then override the parameter
|
11546
11623
|
# value using `UpdateStackInstances`.
|
11547
11624
|
#
|
@@ -11551,16 +11628,15 @@ module Aws::CloudFormation
|
|
11551
11628
|
# @return [Array<Types::Parameter>]
|
11552
11629
|
#
|
11553
11630
|
# @!attribute [rw] operation_preferences
|
11554
|
-
# Preferences for how CloudFormation performs this
|
11555
|
-
# operation.
|
11631
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
11556
11632
|
# @return [Types::StackSetOperationPreferences]
|
11557
11633
|
#
|
11558
11634
|
# @!attribute [rw] operation_id
|
11559
|
-
# The unique identifier for this
|
11635
|
+
# The unique identifier for this StackSet operation.
|
11560
11636
|
#
|
11561
11637
|
# The operation ID also functions as an idempotency token, to ensure
|
11562
|
-
# that CloudFormation performs the
|
11563
|
-
# if you retry the request multiple times. You might retry
|
11638
|
+
# that CloudFormation performs the StackSet operation only once, even
|
11639
|
+
# if you retry the request multiple times. You might retry StackSet
|
11564
11640
|
# operation requests to ensure that CloudFormation successfully
|
11565
11641
|
# received them.
|
11566
11642
|
#
|
@@ -11576,7 +11652,7 @@ module Aws::CloudFormation
|
|
11576
11652
|
# an account administrator in the organization's management account
|
11577
11653
|
# or as a delegated administrator in a member account.
|
11578
11654
|
#
|
11579
|
-
# By default, `SELF` is specified. Use `SELF` for
|
11655
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
11580
11656
|
# self-managed permissions.
|
11581
11657
|
#
|
11582
11658
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -11610,7 +11686,7 @@ module Aws::CloudFormation
|
|
11610
11686
|
end
|
11611
11687
|
|
11612
11688
|
# @!attribute [rw] operation_id
|
11613
|
-
# The unique identifier for this
|
11689
|
+
# The unique identifier for this StackSet operation.
|
11614
11690
|
# @return [String]
|
11615
11691
|
#
|
11616
11692
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstancesOutput AWS API Documentation
|
@@ -11636,7 +11712,7 @@ module Aws::CloudFormation
|
|
11636
11712
|
end
|
11637
11713
|
|
11638
11714
|
# @!attribute [rw] stack_set_name
|
11639
|
-
# The name or unique ID of the
|
11715
|
+
# The name or unique ID of the StackSet that you want to update.
|
11640
11716
|
# @return [String]
|
11641
11717
|
#
|
11642
11718
|
# @!attribute [rw] description
|
@@ -11665,7 +11741,7 @@ module Aws::CloudFormation
|
|
11665
11741
|
# @return [String]
|
11666
11742
|
#
|
11667
11743
|
# @!attribute [rw] use_previous_template
|
11668
|
-
# Use the existing template that's associated with the
|
11744
|
+
# Use the existing template that's associated with the StackSet that
|
11669
11745
|
# you're updating.
|
11670
11746
|
#
|
11671
11747
|
# Conditional: You must specify only one of the following parameters:
|
@@ -11674,13 +11750,13 @@ module Aws::CloudFormation
|
|
11674
11750
|
# @return [Boolean]
|
11675
11751
|
#
|
11676
11752
|
# @!attribute [rw] parameters
|
11677
|
-
# A list of input parameters for the
|
11753
|
+
# A list of input parameters for the StackSet template.
|
11678
11754
|
# @return [Array<Types::Parameter>]
|
11679
11755
|
#
|
11680
11756
|
# @!attribute [rw] capabilities
|
11681
11757
|
# In some cases, you must explicitly acknowledge that your stack
|
11682
11758
|
# template contains certain capabilities in order for CloudFormation
|
11683
|
-
# to update the
|
11759
|
+
# to update the StackSet and its associated stack instances.
|
11684
11760
|
#
|
11685
11761
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
11686
11762
|
#
|
@@ -11721,21 +11797,21 @@ module Aws::CloudFormation
|
|
11721
11797
|
#
|
11722
11798
|
# * `CAPABILITY_AUTO_EXPAND`
|
11723
11799
|
#
|
11724
|
-
# Some templates reference macros. If your
|
11725
|
-
# references one or more macros, you must update the
|
11800
|
+
# Some templates reference macros. If your StackSet template
|
11801
|
+
# references one or more macros, you must update the StackSet
|
11726
11802
|
# directly from the processed template, without first reviewing the
|
11727
|
-
# resulting changes in a change set. To update the
|
11803
|
+
# resulting changes in a change set. To update the StackSet
|
11728
11804
|
# directly, you must acknowledge this capability. For more
|
11729
11805
|
# information, see [Perform custom processing on CloudFormation
|
11730
11806
|
# templates with template macros][9].
|
11731
11807
|
#
|
11732
|
-
#
|
11808
|
+
# StackSets with service-managed permissions do not currently
|
11733
11809
|
# support the use of macros in templates. (This includes the
|
11734
11810
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
11735
11811
|
# macros hosted by CloudFormation.) Even if you specify this
|
11736
|
-
# capability for a
|
11737
|
-
#
|
11738
|
-
#
|
11812
|
+
# capability for a StackSet with service-managed permissions, if you
|
11813
|
+
# reference a macro in your template the StackSet operation will
|
11814
|
+
# fail.
|
11739
11815
|
#
|
11740
11816
|
#
|
11741
11817
|
#
|
@@ -11753,24 +11829,24 @@ module Aws::CloudFormation
|
|
11753
11829
|
# @return [Array<String>]
|
11754
11830
|
#
|
11755
11831
|
# @!attribute [rw] tags
|
11756
|
-
# The key-value pairs to associate with this
|
11832
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
11757
11833
|
# created from it. CloudFormation also propagates these tags to
|
11758
11834
|
# supported resources that are created in the stacks. You can specify
|
11759
11835
|
# a maximum number of 50 tags.
|
11760
11836
|
#
|
11761
11837
|
# If you specify tags for this parameter, those tags replace any list
|
11762
|
-
# of tags that are currently associated with this
|
11838
|
+
# of tags that are currently associated with this StackSet. This
|
11763
11839
|
# means:
|
11764
11840
|
#
|
11765
11841
|
# * If you don't specify this parameter, CloudFormation doesn't
|
11766
11842
|
# modify the stack's tags.
|
11767
11843
|
#
|
11768
11844
|
# * If you specify *any* tags using this parameter, you must specify
|
11769
|
-
# *all* the tags that you want associated with this
|
11845
|
+
# *all* the tags that you want associated with this StackSet, even
|
11770
11846
|
# tags you've specified before (for example, when creating the
|
11771
|
-
#
|
11847
|
+
# StackSet or during a previous update of the StackSet.). Any tags
|
11772
11848
|
# that you don't include in the updated list of tags are removed
|
11773
|
-
# from the
|
11849
|
+
# from the StackSet, and therefore from the stacks and resources as
|
11774
11850
|
# well.
|
11775
11851
|
#
|
11776
11852
|
# * If you specify an empty value, CloudFormation removes all
|
@@ -11779,33 +11855,32 @@ module Aws::CloudFormation
|
|
11779
11855
|
# If you specify new tags as part of an `UpdateStackSet` action,
|
11780
11856
|
# CloudFormation checks to see if you have the required IAM permission
|
11781
11857
|
# to tag resources. If you omit tags that are currently associated
|
11782
|
-
# with the
|
11783
|
-
# assumes that you want to remove those tags from the
|
11858
|
+
# with the StackSet from the list of tags you specify, CloudFormation
|
11859
|
+
# assumes that you want to remove those tags from the StackSet, and
|
11784
11860
|
# checks to see if you have permission to untag resources. If you
|
11785
11861
|
# don't have the necessary permission(s), the entire `UpdateStackSet`
|
11786
|
-
# action fails with an `access denied` error, and the
|
11862
|
+
# action fails with an `access denied` error, and the StackSet is not
|
11787
11863
|
# updated.
|
11788
11864
|
# @return [Array<Types::Tag>]
|
11789
11865
|
#
|
11790
11866
|
# @!attribute [rw] operation_preferences
|
11791
|
-
# Preferences for how CloudFormation performs this
|
11792
|
-
# operation.
|
11867
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
11793
11868
|
# @return [Types::StackSetOperationPreferences]
|
11794
11869
|
#
|
11795
11870
|
# @!attribute [rw] administration_role_arn
|
11796
11871
|
# \[Self-managed permissions\] The Amazon Resource Name (ARN) of the
|
11797
|
-
# IAM role to use to update this
|
11872
|
+
# IAM role to use to update this StackSet.
|
11798
11873
|
#
|
11799
11874
|
# Specify an IAM role only if you are using customized administrator
|
11800
|
-
# roles to control which users or groups can manage specific
|
11801
|
-
#
|
11802
|
-
#
|
11875
|
+
# roles to control which users or groups can manage specific StackSets
|
11876
|
+
# within the same administrator account. For more information, see
|
11877
|
+
# [Grant self-managed permissions][1] in the *CloudFormation User
|
11803
11878
|
# Guide*.
|
11804
11879
|
#
|
11805
11880
|
# If you specified a customized administrator role when you created
|
11806
|
-
# the
|
11807
|
-
#
|
11808
|
-
#
|
11881
|
+
# the StackSet, you must specify a customized administrator role, even
|
11882
|
+
# if it is the same customized administrator role used with this
|
11883
|
+
# StackSet previously.
|
11809
11884
|
#
|
11810
11885
|
#
|
11811
11886
|
#
|
@@ -11816,40 +11891,39 @@ module Aws::CloudFormation
|
|
11816
11891
|
# \[Self-managed permissions\] The name of the IAM execution role to
|
11817
11892
|
# use to update the stack set. If you do not specify an execution
|
11818
11893
|
# role, CloudFormation uses the
|
11819
|
-
# `AWSCloudFormationStackSetExecutionRole` role for the
|
11894
|
+
# `AWSCloudFormationStackSetExecutionRole` role for the StackSet
|
11820
11895
|
# operation.
|
11821
11896
|
#
|
11822
11897
|
# Specify an IAM role only if you are using customized execution roles
|
11823
11898
|
# to control which stack resources users and groups can include in
|
11824
|
-
# their
|
11899
|
+
# their StackSets.
|
11825
11900
|
#
|
11826
11901
|
# If you specify a customized execution role, CloudFormation uses that
|
11827
11902
|
# role to update the stack. If you do not specify a customized
|
11828
11903
|
# execution role, CloudFormation performs the update using the role
|
11829
|
-
# previously associated with the
|
11830
|
-
# permissions to perform operations on the
|
11904
|
+
# previously associated with the StackSet, so long as you have
|
11905
|
+
# permissions to perform operations on the StackSet.
|
11831
11906
|
# @return [String]
|
11832
11907
|
#
|
11833
11908
|
# @!attribute [rw] deployment_targets
|
11834
11909
|
# \[Service-managed permissions\] The Organizations accounts in which
|
11835
11910
|
# to update associated stack instances.
|
11836
11911
|
#
|
11837
|
-
# To update all the stack instances associated with this
|
11912
|
+
# To update all the stack instances associated with this StackSet, do
|
11838
11913
|
# not specify `DeploymentTargets` or `Regions`.
|
11839
11914
|
#
|
11840
|
-
# If the
|
11841
|
-
#
|
11842
|
-
#
|
11843
|
-
#
|
11844
|
-
#
|
11845
|
-
#
|
11846
|
-
#
|
11847
|
-
#
|
11848
|
-
# existing stack instance status.
|
11915
|
+
# If the StackSet update includes changes to the template (that is, if
|
11916
|
+
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
11917
|
+
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
11918
|
+
# prior to updating the stack instances in the specified accounts and
|
11919
|
+
# Amazon Web Services Regions. If the StackSet update doesn't include
|
11920
|
+
# changes to the template or parameters, CloudFormation updates the
|
11921
|
+
# stack instances in the specified accounts and Regions, while leaving
|
11922
|
+
# all other stack instances with their existing stack instance status.
|
11849
11923
|
# @return [Types::DeploymentTargets]
|
11850
11924
|
#
|
11851
11925
|
# @!attribute [rw] permission_model
|
11852
|
-
# Describes how the IAM roles required for
|
11926
|
+
# Describes how the IAM roles required for StackSet operations are
|
11853
11927
|
# created. You cannot modify `PermissionModel` if there are stack
|
11854
11928
|
# instances associated with your stack set.
|
11855
11929
|
#
|
@@ -11860,7 +11934,7 @@ module Aws::CloudFormation
|
|
11860
11934
|
# * With `service-managed` permissions, StackSets automatically
|
11861
11935
|
# creates the IAM roles required to deploy to accounts managed by
|
11862
11936
|
# Organizations. For more information, see [Activate trusted access
|
11863
|
-
# for
|
11937
|
+
# for StackSets with Organizations][2].
|
11864
11938
|
#
|
11865
11939
|
#
|
11866
11940
|
#
|
@@ -11872,9 +11946,8 @@ module Aws::CloudFormation
|
|
11872
11946
|
# \[Service-managed permissions\] Describes whether StackSets
|
11873
11947
|
# automatically deploys to Organizations accounts that are added to a
|
11874
11948
|
# target organization or organizational unit (OU). For more
|
11875
|
-
# information, see [
|
11876
|
-
# StackSets
|
11877
|
-
# *CloudFormation User Guide*.
|
11949
|
+
# information, see [Enable or disable automatic deployments for
|
11950
|
+
# StackSets in Organizations][1] in the *CloudFormation User Guide*.
|
11878
11951
|
#
|
11879
11952
|
# If you specify `AutoDeployment`, don't specify `DeploymentTargets`
|
11880
11953
|
# or `Regions`.
|
@@ -11885,18 +11958,18 @@ module Aws::CloudFormation
|
|
11885
11958
|
# @return [Types::AutoDeployment]
|
11886
11959
|
#
|
11887
11960
|
# @!attribute [rw] operation_id
|
11888
|
-
# The unique ID for this
|
11961
|
+
# The unique ID for this StackSet operation.
|
11889
11962
|
#
|
11890
11963
|
# The operation ID also functions as an idempotency token, to ensure
|
11891
|
-
# that CloudFormation performs the
|
11892
|
-
# if you retry the request multiple times. You might retry
|
11964
|
+
# that CloudFormation performs the StackSet operation only once, even
|
11965
|
+
# if you retry the request multiple times. You might retry StackSet
|
11893
11966
|
# operation requests to ensure that CloudFormation successfully
|
11894
11967
|
# received them.
|
11895
11968
|
#
|
11896
11969
|
# If you don't specify an operation ID, CloudFormation generates one
|
11897
11970
|
# automatically.
|
11898
11971
|
#
|
11899
|
-
# Repeating this
|
11972
|
+
# Repeating this StackSet operation with a new operation ID retries
|
11900
11973
|
# all stack instances whose status is `OUTDATED`.
|
11901
11974
|
#
|
11902
11975
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -11906,36 +11979,36 @@ module Aws::CloudFormation
|
|
11906
11979
|
# @!attribute [rw] accounts
|
11907
11980
|
# \[Self-managed permissions\] The accounts in which to update
|
11908
11981
|
# associated stack instances. If you specify accounts, you must also
|
11909
|
-
# specify the Amazon Web Services Regions in which to update
|
11982
|
+
# specify the Amazon Web Services Regions in which to update StackSet
|
11910
11983
|
# instances.
|
11911
11984
|
#
|
11912
|
-
# To update *all* the stack instances associated with this
|
11985
|
+
# To update *all* the stack instances associated with this StackSet,
|
11913
11986
|
# don't specify the `Accounts` or `Regions` properties.
|
11914
11987
|
#
|
11915
|
-
# If the
|
11916
|
-
#
|
11988
|
+
# If the StackSet update includes changes to the template (that is, if
|
11989
|
+
# the `TemplateBody` or `TemplateURL` properties are specified), or
|
11917
11990
|
# the `Parameters` property, CloudFormation marks all stack instances
|
11918
11991
|
# with a status of `OUTDATED` prior to updating the stack instances in
|
11919
|
-
# the specified accounts and Amazon Web Services Regions. If the
|
11920
|
-
#
|
11921
|
-
# CloudFormation updates the stack instances in the
|
11922
|
-
# and Amazon Web Services Regions, while leaving
|
11923
|
-
# instances with their existing stack instance status.
|
11992
|
+
# the specified accounts and Amazon Web Services Regions. If the
|
11993
|
+
# StackSet update does not include changes to the template or
|
11994
|
+
# parameters, CloudFormation updates the stack instances in the
|
11995
|
+
# specified accounts and Amazon Web Services Regions, while leaving
|
11996
|
+
# all other stack instances with their existing stack instance status.
|
11924
11997
|
# @return [Array<String>]
|
11925
11998
|
#
|
11926
11999
|
# @!attribute [rw] regions
|
11927
12000
|
# The Amazon Web Services Regions in which to update associated stack
|
11928
12001
|
# instances. If you specify Regions, you must also specify accounts in
|
11929
|
-
# which to update
|
12002
|
+
# which to update StackSet instances.
|
11930
12003
|
#
|
11931
|
-
# To update *all* the stack instances associated with this
|
12004
|
+
# To update *all* the stack instances associated with this StackSet,
|
11932
12005
|
# do not specify the `Accounts` or `Regions` properties.
|
11933
12006
|
#
|
11934
|
-
# If the
|
11935
|
-
#
|
12007
|
+
# If the StackSet update includes changes to the template (that is, if
|
12008
|
+
# the `TemplateBody` or `TemplateURL` properties are specified), or
|
11936
12009
|
# the `Parameters` property, CloudFormation marks all stack instances
|
11937
12010
|
# with a status of `OUTDATED` prior to updating the stack instances in
|
11938
|
-
# the specified accounts and Regions. If the
|
12011
|
+
# the specified accounts and Regions. If the StackSet update does not
|
11939
12012
|
# include changes to the template or parameters, CloudFormation
|
11940
12013
|
# updates the stack instances in the specified accounts and Regions,
|
11941
12014
|
# while leaving all other stack instances with their existing stack
|
@@ -11947,7 +12020,7 @@ module Aws::CloudFormation
|
|
11947
12020
|
# an account administrator in the organization's management account
|
11948
12021
|
# or as a delegated administrator in a member account.
|
11949
12022
|
#
|
11950
|
-
# By default, `SELF` is specified. Use `SELF` for
|
12023
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
11951
12024
|
# self-managed permissions.
|
11952
12025
|
#
|
11953
12026
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -11966,7 +12039,7 @@ module Aws::CloudFormation
|
|
11966
12039
|
# @return [String]
|
11967
12040
|
#
|
11968
12041
|
# @!attribute [rw] managed_execution
|
11969
|
-
# Describes whether
|
12042
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
11970
12043
|
# concurrently and queues conflicting operations.
|
11971
12044
|
# @return [Types::ManagedExecution]
|
11972
12045
|
#
|
@@ -11997,7 +12070,7 @@ module Aws::CloudFormation
|
|
11997
12070
|
end
|
11998
12071
|
|
11999
12072
|
# @!attribute [rw] operation_id
|
12000
|
-
# The unique ID for this
|
12073
|
+
# The unique ID for this StackSet operation.
|
12001
12074
|
# @return [String]
|
12002
12075
|
#
|
12003
12076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSetOutput AWS API Documentation
|