aws-sdk-cloudformation 1.139.0 → 1.140.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +361 -278
- data/lib/aws-sdk-cloudformation/client_api.rb +13 -2
- data/lib/aws-sdk-cloudformation/event.rb +12 -6
- data/lib/aws-sdk-cloudformation/resource.rb +8 -0
- data/lib/aws-sdk-cloudformation/stack.rb +9 -1
- data/lib/aws-sdk-cloudformation/types.rb +594 -514
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/client.rbs +5 -3
- data/sig/event.rbs +3 -0
- data/sig/types.rbs +9 -0
- metadata +1 -1
@@ -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
|
#
|
@@ -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
|
@@ -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.
|
2210
|
+
#
|
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.
|
2198
2214
|
#
|
2199
|
-
#
|
2200
|
-
# `OrganizationalUnitIds
|
2201
|
-
# `
|
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
|
-
#
|
2246
|
+
# Refines which accounts will have stack operations performed on them
|
2247
|
+
# by specifying how to use the `Accounts` and `OrganizationalUnitIds`
|
2248
|
+
# properties together.
|
2224
2249
|
#
|
2225
|
-
# The following
|
2226
|
-
#
|
2250
|
+
# The following values determine how CloudFormation selects target
|
2251
|
+
# accounts:
|
2227
2252
|
#
|
2228
|
-
# * `INTERSECTION`:
|
2229
|
-
#
|
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.
|
2230
2257
|
#
|
2231
|
-
# * `DIFFERENCE`:
|
2232
|
-
#
|
2233
|
-
#
|
2234
|
-
#
|
2235
|
-
# * `UNION`: StackSets includes additional accounts deployment
|
2236
|
-
# targets.
|
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
|
@@ -4015,24 +4042,24 @@ module Aws::CloudFormation
|
|
4015
4042
|
end
|
4016
4043
|
|
4017
4044
|
# @!attribute [rw] stack_set_name
|
4018
|
-
# The name of the
|
4045
|
+
# The name of the StackSet on which to perform the drift detection
|
4019
4046
|
# operation.
|
4020
4047
|
# @return [String]
|
4021
4048
|
#
|
4022
4049
|
# @!attribute [rw] operation_preferences
|
4023
4050
|
# The user-specified preferences for how CloudFormation performs a
|
4024
|
-
#
|
4051
|
+
# StackSet operation.
|
4025
4052
|
#
|
4026
4053
|
# For more information about maximum concurrent accounts and failure
|
4027
|
-
# tolerance, see [
|
4054
|
+
# tolerance, see [StackSet operation options][1].
|
4028
4055
|
#
|
4029
4056
|
#
|
4030
4057
|
#
|
4031
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
4058
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4032
4059
|
# @return [Types::StackSetOperationPreferences]
|
4033
4060
|
#
|
4034
4061
|
# @!attribute [rw] operation_id
|
4035
|
-
# *The ID of the
|
4062
|
+
# *The ID of the StackSet operation.*
|
4036
4063
|
#
|
4037
4064
|
# **A suitable default value is auto-generated.** You should normally
|
4038
4065
|
# not need to pass this option.
|
@@ -4043,7 +4070,7 @@ module Aws::CloudFormation
|
|
4043
4070
|
# an account administrator in the organization's management account
|
4044
4071
|
# or as a delegated administrator in a member account.
|
4045
4072
|
#
|
4046
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4073
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4047
4074
|
# self-managed permissions.
|
4048
4075
|
#
|
4049
4076
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4073,7 +4100,7 @@ module Aws::CloudFormation
|
|
4073
4100
|
end
|
4074
4101
|
|
4075
4102
|
# @!attribute [rw] operation_id
|
4076
|
-
# The ID of the drift detection
|
4103
|
+
# The ID of the drift detection StackSet operation.
|
4077
4104
|
#
|
4078
4105
|
# You can use this operation ID with DescribeStackSetOperation to
|
4079
4106
|
# monitor the progress of the drift detection operation.
|
@@ -4221,6 +4248,13 @@ module Aws::CloudFormation
|
|
4221
4248
|
# The `Export` structure describes the exported output values for a
|
4222
4249
|
# stack.
|
4223
4250
|
#
|
4251
|
+
# For more information, see [Get exported outputs from a deployed
|
4252
|
+
# CloudFormation stack][1].
|
4253
|
+
#
|
4254
|
+
#
|
4255
|
+
#
|
4256
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html
|
4257
|
+
#
|
4224
4258
|
# @!attribute [rw] exporting_stack_id
|
4225
4259
|
# The stack that contains the exported output name and value.
|
4226
4260
|
# @return [String]
|
@@ -4446,7 +4480,7 @@ module Aws::CloudFormation
|
|
4446
4480
|
# @return [String]
|
4447
4481
|
#
|
4448
4482
|
# @!attribute [rw] stack_set_name
|
4449
|
-
# The name or unique ID of the
|
4483
|
+
# The name or unique ID of the StackSet from which the stack was
|
4450
4484
|
# created.
|
4451
4485
|
#
|
4452
4486
|
# Conditional: You must specify only one of the following parameters:
|
@@ -4458,7 +4492,7 @@ module Aws::CloudFormation
|
|
4458
4492
|
# an account administrator in the organization's management account
|
4459
4493
|
# or as a delegated administrator in a member account.
|
4460
4494
|
#
|
4461
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4495
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4462
4496
|
# self-managed permissions.
|
4463
4497
|
#
|
4464
4498
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -4583,65 +4617,105 @@ module Aws::CloudFormation
|
|
4583
4617
|
# Describes a Hook invocation, its status, and the reason for its
|
4584
4618
|
# status.
|
4585
4619
|
#
|
4620
|
+
# @!attribute [rw] hook_result_id
|
4621
|
+
# The unique identifier for this Hook invocation result.
|
4622
|
+
# @return [String]
|
4623
|
+
#
|
4586
4624
|
# @!attribute [rw] invocation_point
|
4587
|
-
# The
|
4625
|
+
# The specific point in the provisioning process where the Hook is
|
4626
|
+
# invoked.
|
4588
4627
|
# @return [String]
|
4589
4628
|
#
|
4590
4629
|
# @!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.
|
4630
|
+
# The failure mode of the invocation.
|
4599
4631
|
# @return [String]
|
4600
4632
|
#
|
4601
4633
|
# @!attribute [rw] type_name
|
4602
|
-
# The
|
4634
|
+
# The name of the Hook that was invoked.
|
4603
4635
|
# @return [String]
|
4604
4636
|
#
|
4605
4637
|
# @!attribute [rw] type_version_id
|
4606
|
-
# The version of the Hook
|
4638
|
+
# The version of the Hook that was invoked.
|
4607
4639
|
# @return [String]
|
4608
4640
|
#
|
4609
4641
|
# @!attribute [rw] type_configuration_version_id
|
4610
|
-
# The version of the Hook
|
4642
|
+
# The version of the Hook configuration.
|
4611
4643
|
# @return [String]
|
4612
4644
|
#
|
4613
4645
|
# @!attribute [rw] status
|
4614
|
-
# The
|
4646
|
+
# The status of the Hook invocation. The following statuses are
|
4647
|
+
# possible:
|
4648
|
+
#
|
4649
|
+
# * `HOOK_IN_PROGRESS`: The Hook is currently running.
|
4650
|
+
#
|
4651
|
+
# * `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
|
4652
|
+
#
|
4653
|
+
# * `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
|
4654
|
+
#
|
4655
|
+
# * `HOOK_FAILED`: The Hook encountered an error during execution.
|
4615
4656
|
# @return [String]
|
4616
4657
|
#
|
4617
4658
|
# @!attribute [rw] hook_status_reason
|
4618
4659
|
# A description of the Hook results status. For example, if the Hook
|
4619
|
-
# result is in a
|
4620
|
-
#
|
4660
|
+
# result is in a failed state, this may contain additional information
|
4661
|
+
# for the failed state.
|
4662
|
+
# @return [String]
|
4663
|
+
#
|
4664
|
+
# @!attribute [rw] invoked_at
|
4665
|
+
# The timestamp when the Hook was invoked.
|
4666
|
+
#
|
4667
|
+
# Only shown in responses when the request does not specify
|
4668
|
+
# `TargetType` and `TargetId` filters.
|
4669
|
+
# @return [Time]
|
4670
|
+
#
|
4671
|
+
# @!attribute [rw] target_type
|
4672
|
+
# The target type that the Hook was invoked against.
|
4673
|
+
# @return [String]
|
4674
|
+
#
|
4675
|
+
# @!attribute [rw] target_id
|
4676
|
+
# The unique identifier of the Hook invocation target.
|
4677
|
+
# @return [String]
|
4678
|
+
#
|
4679
|
+
# @!attribute [rw] type_arn
|
4680
|
+
# The ARN of the Hook that was invoked.
|
4681
|
+
# @return [String]
|
4682
|
+
#
|
4683
|
+
# @!attribute [rw] hook_execution_target
|
4684
|
+
# The ARN of the target stack or request token of the Cloud Control
|
4685
|
+
# API operation.
|
4686
|
+
#
|
4687
|
+
# Only shown in responses when the request does not specify
|
4688
|
+
# `TargetType` and `TargetId` filters.
|
4621
4689
|
# @return [String]
|
4622
4690
|
#
|
4623
4691
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/HookResultSummary AWS API Documentation
|
4624
4692
|
#
|
4625
4693
|
class HookResultSummary < Struct.new(
|
4694
|
+
:hook_result_id,
|
4626
4695
|
:invocation_point,
|
4627
4696
|
:failure_mode,
|
4628
4697
|
:type_name,
|
4629
4698
|
:type_version_id,
|
4630
4699
|
:type_configuration_version_id,
|
4631
4700
|
:status,
|
4632
|
-
:hook_status_reason
|
4701
|
+
:hook_status_reason,
|
4702
|
+
:invoked_at,
|
4703
|
+
:target_type,
|
4704
|
+
:target_id,
|
4705
|
+
:type_arn,
|
4706
|
+
:hook_execution_target)
|
4633
4707
|
SENSITIVE = []
|
4634
4708
|
include Aws::Structure
|
4635
4709
|
end
|
4636
4710
|
|
4637
4711
|
# @!attribute [rw] stack_set_name
|
4638
|
-
# The name of the
|
4639
|
-
# where you create your
|
4712
|
+
# The name of the StackSet. The name must be unique in the Region
|
4713
|
+
# where you create your StackSet.
|
4640
4714
|
# @return [String]
|
4641
4715
|
#
|
4642
4716
|
# @!attribute [rw] stack_ids
|
4643
|
-
# The IDs of the stacks you are importing into a
|
4644
|
-
# up to 10 stacks per
|
4717
|
+
# The IDs of the stacks you are importing into a StackSet. You import
|
4718
|
+
# up to 10 stacks per StackSet at a time.
|
4645
4719
|
#
|
4646
4720
|
# Specify either `StackIds` or `StackIdsUrl`.
|
4647
4721
|
# @return [Array<String>]
|
@@ -4653,36 +4727,36 @@ module Aws::CloudFormation
|
|
4653
4727
|
# @return [String]
|
4654
4728
|
#
|
4655
4729
|
# @!attribute [rw] organizational_unit_ids
|
4656
|
-
# The list of OU ID's to which the stacks
|
4657
|
-
#
|
4730
|
+
# The list of OU ID's to which the imported stacks must be mapped as
|
4731
|
+
# deployment targets.
|
4658
4732
|
# @return [Array<String>]
|
4659
4733
|
#
|
4660
4734
|
# @!attribute [rw] operation_preferences
|
4661
4735
|
# The user-specified preferences for how CloudFormation performs a
|
4662
|
-
#
|
4736
|
+
# StackSet operation.
|
4663
4737
|
#
|
4664
4738
|
# For more information about maximum concurrent accounts and failure
|
4665
|
-
# tolerance, see [
|
4739
|
+
# tolerance, see [StackSet operation options][1].
|
4666
4740
|
#
|
4667
4741
|
#
|
4668
4742
|
#
|
4669
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
4743
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4670
4744
|
# @return [Types::StackSetOperationPreferences]
|
4671
4745
|
#
|
4672
4746
|
# @!attribute [rw] operation_id
|
4673
|
-
# A unique, user defined, identifier for the
|
4747
|
+
# A unique, user defined, identifier for the StackSet operation.
|
4674
4748
|
#
|
4675
4749
|
# **A suitable default value is auto-generated.** You should normally
|
4676
4750
|
# not need to pass this option.
|
4677
4751
|
# @return [String]
|
4678
4752
|
#
|
4679
4753
|
# @!attribute [rw] call_as
|
4680
|
-
# By default, `SELF` is specified. Use `SELF` for
|
4754
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
4681
4755
|
# self-managed permissions.
|
4682
4756
|
#
|
4683
4757
|
# * If you are signed in to the management account, specify `SELF`.
|
4684
4758
|
#
|
4685
|
-
# * For service managed
|
4759
|
+
# * For service managed StackSets, specify `DELEGATED_ADMIN`.
|
4686
4760
|
# @return [String]
|
4687
4761
|
#
|
4688
4762
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetInput AWS API Documentation
|
@@ -4700,7 +4774,7 @@ module Aws::CloudFormation
|
|
4700
4774
|
end
|
4701
4775
|
|
4702
4776
|
# @!attribute [rw] operation_id
|
4703
|
-
# The unique identifier for the
|
4777
|
+
# The unique identifier for the StackSet operation.
|
4704
4778
|
# @return [String]
|
4705
4779
|
#
|
4706
4780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetOutput AWS API Documentation
|
@@ -4875,23 +4949,47 @@ module Aws::CloudFormation
|
|
4875
4949
|
end
|
4876
4950
|
|
4877
4951
|
# @!attribute [rw] target_type
|
4878
|
-
#
|
4952
|
+
# Filters results by target type. Currently, only `CHANGE_SET` and
|
4953
|
+
# `CLOUD_CONTROL` are supported filter options.
|
4954
|
+
#
|
4955
|
+
# Required when `TargetId` is specified and cannot be used otherwise.
|
4879
4956
|
# @return [String]
|
4880
4957
|
#
|
4881
4958
|
# @!attribute [rw] target_id
|
4882
|
-
#
|
4883
|
-
#
|
4959
|
+
# Filters results by the unique identifier of the target the Hook was
|
4960
|
+
# invoked against.
|
4961
|
+
#
|
4962
|
+
# For change sets, this is the change set ARN. When the target is a
|
4963
|
+
# Cloud Control API operation, this value must be the
|
4964
|
+
# `HookRequestToken` returned by the Cloud Control API request. For
|
4965
|
+
# more information on the `HookRequestToken`, see [ProgressEvent][1].
|
4884
4966
|
#
|
4885
|
-
#
|
4886
|
-
#
|
4887
|
-
# request. For more information on the `HookRequestToken`, see
|
4888
|
-
# [ProgressEvent][1].
|
4967
|
+
# Required when `TargetType` is specified and cannot be used
|
4968
|
+
# otherwise.
|
4889
4969
|
#
|
4890
4970
|
#
|
4891
4971
|
#
|
4892
4972
|
# [1]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html
|
4893
4973
|
# @return [String]
|
4894
4974
|
#
|
4975
|
+
# @!attribute [rw] type_arn
|
4976
|
+
# Filters results by the ARN of the Hook. Can be used alone or in
|
4977
|
+
# combination with `Status`.
|
4978
|
+
# @return [String]
|
4979
|
+
#
|
4980
|
+
# @!attribute [rw] status
|
4981
|
+
# Filters results by the status of Hook invocations. Can only be used
|
4982
|
+
# in combination with `TypeArn`. Valid values are:
|
4983
|
+
#
|
4984
|
+
# * `HOOK_IN_PROGRESS`: The Hook is currently running.
|
4985
|
+
#
|
4986
|
+
# * `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
|
4987
|
+
#
|
4988
|
+
# * `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
|
4989
|
+
#
|
4990
|
+
# * `HOOK_FAILED`: The Hook encountered an error during execution.
|
4991
|
+
# @return [String]
|
4992
|
+
#
|
4895
4993
|
# @!attribute [rw] next_token
|
4896
4994
|
# A string that identifies the next page of events that you want to
|
4897
4995
|
# retrieve.
|
@@ -4902,27 +5000,19 @@ module Aws::CloudFormation
|
|
4902
5000
|
class ListHookResultsInput < Struct.new(
|
4903
5001
|
:target_type,
|
4904
5002
|
:target_id,
|
5003
|
+
:type_arn,
|
5004
|
+
:status,
|
4905
5005
|
:next_token)
|
4906
5006
|
SENSITIVE = []
|
4907
5007
|
include Aws::Structure
|
4908
5008
|
end
|
4909
5009
|
|
4910
5010
|
# @!attribute [rw] target_type
|
4911
|
-
# The type
|
5011
|
+
# The target type.
|
4912
5012
|
# @return [String]
|
4913
5013
|
#
|
4914
5014
|
# @!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
|
5015
|
+
# The unique identifier of the Hook invocation target.
|
4926
5016
|
# @return [String]
|
4927
5017
|
#
|
4928
5018
|
# @!attribute [rw] hook_results
|
@@ -5158,7 +5248,7 @@ module Aws::CloudFormation
|
|
5158
5248
|
end
|
5159
5249
|
|
5160
5250
|
# @!attribute [rw] stack_set_name
|
5161
|
-
# The name or unique ID of the
|
5251
|
+
# The name or unique ID of the StackSet that you want to list drifted
|
5162
5252
|
# resources for.
|
5163
5253
|
# @return [String]
|
5164
5254
|
#
|
@@ -5212,7 +5302,7 @@ module Aws::CloudFormation
|
|
5212
5302
|
# an account administrator in the organization's management account
|
5213
5303
|
# or as a delegated administrator in a member account.
|
5214
5304
|
#
|
5215
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5305
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5216
5306
|
# self-managed permissions.
|
5217
5307
|
#
|
5218
5308
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5269,7 +5359,7 @@ module Aws::CloudFormation
|
|
5269
5359
|
end
|
5270
5360
|
|
5271
5361
|
# @!attribute [rw] stack_set_name
|
5272
|
-
# The name or unique ID of the
|
5362
|
+
# The name or unique ID of the StackSet that you want to list stack
|
5273
5363
|
# instances for.
|
5274
5364
|
# @return [String]
|
5275
5365
|
#
|
@@ -5307,7 +5397,7 @@ module Aws::CloudFormation
|
|
5307
5397
|
# an account administrator in the organization's management account
|
5308
5398
|
# or as a delegated administrator in a member account.
|
5309
5399
|
#
|
5310
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5400
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5311
5401
|
# self-managed permissions.
|
5312
5402
|
#
|
5313
5403
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5524,13 +5614,13 @@ module Aws::CloudFormation
|
|
5524
5614
|
end
|
5525
5615
|
|
5526
5616
|
# @!attribute [rw] stack_set_name
|
5527
|
-
# The name or unique ID of the
|
5528
|
-
#
|
5617
|
+
# The name or unique ID of the StackSet that you want to get automatic
|
5618
|
+
# deployment targets for.
|
5529
5619
|
# @return [String]
|
5530
5620
|
#
|
5531
5621
|
# @!attribute [rw] next_token
|
5532
|
-
# A string that identifies the next page of
|
5533
|
-
#
|
5622
|
+
# A string that identifies the next page of deployment targets that
|
5623
|
+
# you want to retrieve.
|
5534
5624
|
# @return [String]
|
5535
5625
|
#
|
5536
5626
|
# @!attribute [rw] max_results
|
@@ -5575,7 +5665,7 @@ module Aws::CloudFormation
|
|
5575
5665
|
end
|
5576
5666
|
|
5577
5667
|
# @!attribute [rw] summaries
|
5578
|
-
# An array of summaries of the deployment targets for the
|
5668
|
+
# An array of summaries of the deployment targets for the StackSet.
|
5579
5669
|
# @return [Array<Types::StackSetAutoDeploymentTargetSummary>]
|
5580
5670
|
#
|
5581
5671
|
# @!attribute [rw] next_token
|
@@ -5600,12 +5690,12 @@ module Aws::CloudFormation
|
|
5600
5690
|
end
|
5601
5691
|
|
5602
5692
|
# @!attribute [rw] stack_set_name
|
5603
|
-
# The name or unique ID of the
|
5604
|
-
#
|
5693
|
+
# The name or unique ID of the StackSet that you want to get operation
|
5694
|
+
# results for.
|
5605
5695
|
# @return [String]
|
5606
5696
|
#
|
5607
5697
|
# @!attribute [rw] operation_id
|
5608
|
-
# The ID of the
|
5698
|
+
# The ID of the StackSet operation.
|
5609
5699
|
# @return [String]
|
5610
5700
|
#
|
5611
5701
|
# @!attribute [rw] next_token
|
@@ -5630,7 +5720,7 @@ module Aws::CloudFormation
|
|
5630
5720
|
# an account administrator in the organization's management account
|
5631
5721
|
# or as a delegated administrator in a member account.
|
5632
5722
|
#
|
5633
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5723
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5634
5724
|
# self-managed permissions.
|
5635
5725
|
#
|
5636
5726
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5689,8 +5779,8 @@ module Aws::CloudFormation
|
|
5689
5779
|
end
|
5690
5780
|
|
5691
5781
|
# @!attribute [rw] stack_set_name
|
5692
|
-
# The name or unique ID of the
|
5693
|
-
#
|
5782
|
+
# The name or unique ID of the StackSet that you want to get operation
|
5783
|
+
# summaries for.
|
5694
5784
|
# @return [String]
|
5695
5785
|
#
|
5696
5786
|
# @!attribute [rw] next_token
|
@@ -5715,7 +5805,7 @@ module Aws::CloudFormation
|
|
5715
5805
|
# an account administrator in the organization's management account
|
5716
5806
|
# or as a delegated administrator in a member account.
|
5717
5807
|
#
|
5718
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5808
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5719
5809
|
# self-managed permissions.
|
5720
5810
|
#
|
5721
5811
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5746,7 +5836,7 @@ module Aws::CloudFormation
|
|
5746
5836
|
|
5747
5837
|
# @!attribute [rw] summaries
|
5748
5838
|
# A list of `StackSetOperationSummary` structures that contain summary
|
5749
|
-
# information about operations for the specified
|
5839
|
+
# information about operations for the specified StackSet.
|
5750
5840
|
# @return [Array<Types::StackSetOperationSummary>]
|
5751
5841
|
#
|
5752
5842
|
# @!attribute [rw] next_token
|
@@ -5783,8 +5873,8 @@ module Aws::CloudFormation
|
|
5783
5873
|
# @return [Integer]
|
5784
5874
|
#
|
5785
5875
|
# @!attribute [rw] status
|
5786
|
-
# The status of the
|
5787
|
-
#
|
5876
|
+
# The status of the StackSets that you want to get summary information
|
5877
|
+
# about.
|
5788
5878
|
# @return [String]
|
5789
5879
|
#
|
5790
5880
|
# @!attribute [rw] call_as
|
@@ -5792,7 +5882,7 @@ module Aws::CloudFormation
|
|
5792
5882
|
# an account administrator in the management account or as a delegated
|
5793
5883
|
# administrator in a member account.
|
5794
5884
|
#
|
5795
|
-
# By default, `SELF` is specified. Use `SELF` for
|
5885
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
5796
5886
|
# self-managed permissions.
|
5797
5887
|
#
|
5798
5888
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -5823,7 +5913,7 @@ module Aws::CloudFormation
|
|
5823
5913
|
|
5824
5914
|
# @!attribute [rw] summaries
|
5825
5915
|
# A list of `StackSetSummary` structures that contain information
|
5826
|
-
# about the user's
|
5916
|
+
# about the user's StackSets.
|
5827
5917
|
# @return [Array<Types::StackSetSummary>]
|
5828
5918
|
#
|
5829
5919
|
# @!attribute [rw] next_token
|
@@ -6212,16 +6302,16 @@ module Aws::CloudFormation
|
|
6212
6302
|
# concurrently and queues conflicting operations.
|
6213
6303
|
#
|
6214
6304
|
# @!attribute [rw] active
|
6215
|
-
# When `true`,
|
6305
|
+
# When `true`, CloudFormation performs non-conflicting operations
|
6216
6306
|
# concurrently and queues conflicting operations. After conflicting
|
6217
|
-
# operations finish,
|
6218
|
-
# order.
|
6307
|
+
# operations finish, CloudFormation starts queued operations in
|
6308
|
+
# request order.
|
6219
6309
|
#
|
6220
|
-
# <note markdown="1"> If there are already running or queued operations,
|
6221
|
-
# all incoming operations even if they are non-conflicting.
|
6310
|
+
# <note markdown="1"> If there are already running or queued operations, CloudFormation
|
6311
|
+
# queues all incoming operations even if they are non-conflicting.
|
6222
6312
|
#
|
6223
|
-
# You can't modify your
|
6224
|
-
# there are running or queued operations for that
|
6313
|
+
# You can't modify your StackSet's execution configuration while
|
6314
|
+
# there are running or queued operations for that StackSet.
|
6225
6315
|
#
|
6226
6316
|
# </note>
|
6227
6317
|
#
|
@@ -6300,8 +6390,8 @@ module Aws::CloudFormation
|
|
6300
6390
|
#
|
6301
6391
|
class OperationIdAlreadyExistsException < Aws::EmptyStructure; end
|
6302
6392
|
|
6303
|
-
# Another operation is currently in progress for this
|
6304
|
-
#
|
6393
|
+
# Another operation is currently in progress for this StackSet. Only one
|
6394
|
+
# operation can be performed for a stack set at a given time.
|
6305
6395
|
#
|
6306
6396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/OperationInProgressException AWS API Documentation
|
6307
6397
|
#
|
@@ -8094,7 +8184,7 @@ module Aws::CloudFormation
|
|
8094
8184
|
# The detailed status of the resource or stack. If
|
8095
8185
|
# `CONFIGURATION_COMPLETE` is present, the resource or resource
|
8096
8186
|
# configuration phase has completed and the stabilization of the
|
8097
|
-
# resources is in progress. The
|
8187
|
+
# resources is in progress. The StackSets `CONFIGURATION_COMPLETE`
|
8098
8188
|
# when all of the resources in the stack have reached that event. For
|
8099
8189
|
# more information, see [Understand CloudFormation stack creation
|
8100
8190
|
# events][1] in the *CloudFormation User Guide*.
|
@@ -8245,7 +8335,7 @@ module Aws::CloudFormation
|
|
8245
8335
|
# @return [String]
|
8246
8336
|
#
|
8247
8337
|
# @!attribute [rw] event_id
|
8248
|
-
# The unique
|
8338
|
+
# The unique identifier of this event.
|
8249
8339
|
# @return [String]
|
8250
8340
|
#
|
8251
8341
|
# @!attribute [rw] stack_name
|
@@ -8306,24 +8396,28 @@ module Aws::CloudFormation
|
|
8306
8396
|
# @return [String]
|
8307
8397
|
#
|
8308
8398
|
# @!attribute [rw] hook_type
|
8309
|
-
# The name of the
|
8399
|
+
# The name of the Hook.
|
8310
8400
|
# @return [String]
|
8311
8401
|
#
|
8312
8402
|
# @!attribute [rw] hook_status
|
8313
|
-
# Provides the status of the change set
|
8403
|
+
# Provides the status of the change set Hook.
|
8314
8404
|
# @return [String]
|
8315
8405
|
#
|
8316
8406
|
# @!attribute [rw] hook_status_reason
|
8317
|
-
# Provides the reason for the
|
8407
|
+
# Provides the reason for the Hook status.
|
8318
8408
|
# @return [String]
|
8319
8409
|
#
|
8320
8410
|
# @!attribute [rw] hook_invocation_point
|
8321
|
-
#
|
8322
|
-
#
|
8411
|
+
# The specific point in the provisioning process where the Hook is
|
8412
|
+
# invoked.
|
8413
|
+
# @return [String]
|
8414
|
+
#
|
8415
|
+
# @!attribute [rw] hook_invocation_id
|
8416
|
+
# The unique identifier of the Hook invocation.
|
8323
8417
|
# @return [String]
|
8324
8418
|
#
|
8325
8419
|
# @!attribute [rw] hook_failure_mode
|
8326
|
-
# Specify the
|
8420
|
+
# Specify the Hook failure mode for non-compliant resources in the
|
8327
8421
|
# followings ways.
|
8328
8422
|
#
|
8329
8423
|
# * `FAIL` Stops provisioning resources.
|
@@ -8372,6 +8466,7 @@ module Aws::CloudFormation
|
|
8372
8466
|
:hook_status,
|
8373
8467
|
:hook_status_reason,
|
8374
8468
|
:hook_invocation_point,
|
8469
|
+
:hook_invocation_id,
|
8375
8470
|
:hook_failure_mode,
|
8376
8471
|
:detailed_status)
|
8377
8472
|
SENSITIVE = []
|
@@ -8379,16 +8474,16 @@ module Aws::CloudFormation
|
|
8379
8474
|
end
|
8380
8475
|
|
8381
8476
|
# A CloudFormation stack, in a specific account and Region, that's part
|
8382
|
-
# of a
|
8477
|
+
# of a StackSet operation. A stack instance is a reference to an
|
8383
8478
|
# attempted or actual stack in a given account within a given Region. A
|
8384
8479
|
# stack instance can exist without a stack—for example, if the stack
|
8385
8480
|
# couldn't be created for some reason. A stack instance is associated
|
8386
|
-
# with only one
|
8387
|
-
# associated
|
8388
|
-
#
|
8481
|
+
# with only one StackSet. Each stack instance contains the ID of its
|
8482
|
+
# associated StackSet, in addition to the ID of the actual stack and the
|
8483
|
+
# stack status.
|
8389
8484
|
#
|
8390
8485
|
# @!attribute [rw] stack_set_id
|
8391
|
-
# The name or unique ID of the
|
8486
|
+
# The name or unique ID of the StackSet that the stack instance is
|
8392
8487
|
# associated with.
|
8393
8488
|
# @return [String]
|
8394
8489
|
#
|
@@ -8407,7 +8502,7 @@ module Aws::CloudFormation
|
|
8407
8502
|
# @return [String]
|
8408
8503
|
#
|
8409
8504
|
# @!attribute [rw] parameter_overrides
|
8410
|
-
# A list of parameters from the
|
8505
|
+
# A list of parameters from the StackSet template whose values have
|
8411
8506
|
# been overridden in this stack instance.
|
8412
8507
|
# @return [Array<Types::Parameter>]
|
8413
8508
|
#
|
@@ -8427,8 +8522,8 @@ module Aws::CloudFormation
|
|
8427
8522
|
# `StackInstanceSummary` member that is a peer to this `Status`
|
8428
8523
|
# member.
|
8429
8524
|
#
|
8430
|
-
# * `OUTDATED`: The stack isn't currently up to date with the
|
8431
|
-
#
|
8525
|
+
# * `OUTDATED`: The stack isn't currently up to date with the
|
8526
|
+
# StackSet because:
|
8432
8527
|
#
|
8433
8528
|
# * The associated stack failed during a `CreateStackSet` or
|
8434
8529
|
# `UpdateStackSet` operation.
|
@@ -8436,7 +8531,7 @@ module Aws::CloudFormation
|
|
8436
8531
|
# * The stack was part of a `CreateStackSet` or `UpdateStackSet`
|
8437
8532
|
# operation that failed or was stopped before the stack was
|
8438
8533
|
# created or updated.
|
8439
|
-
# * `CURRENT`: The stack is currently up to date with the
|
8534
|
+
# * `CURRENT`: The stack is currently up to date with the StackSet.
|
8440
8535
|
# @return [String]
|
8441
8536
|
#
|
8442
8537
|
# @!attribute [rw] stack_instance_status
|
@@ -8460,19 +8555,19 @@ module Aws::CloudFormation
|
|
8460
8555
|
#
|
8461
8556
|
# @!attribute [rw] drift_status
|
8462
8557
|
# Status of the stack instance's actual configuration compared to the
|
8463
|
-
# expected template and parameter configuration of the
|
8464
|
-
#
|
8558
|
+
# expected template and parameter configuration of the StackSet it
|
8559
|
+
# belongs to.
|
8465
8560
|
#
|
8466
8561
|
# * `DRIFTED`: The stack differs from the expected template and
|
8467
|
-
# parameter configuration of the
|
8468
|
-
#
|
8562
|
+
# parameter configuration of the StackSet it belongs to. A stack
|
8563
|
+
# instance is considered to have drifted if one or more of the
|
8469
8564
|
# resources in the associated stack have drifted.
|
8470
8565
|
#
|
8471
8566
|
# * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
|
8472
|
-
# instance differs from its expected
|
8567
|
+
# instance differs from its expected StackSet configuration.
|
8473
8568
|
#
|
8474
8569
|
# * `IN_SYNC`: The stack instance's actual configuration matches its
|
8475
|
-
# expected
|
8570
|
+
# expected StackSset configuration.
|
8476
8571
|
#
|
8477
8572
|
# * `UNKNOWN`: This value is reserved for future use.
|
8478
8573
|
# @return [String]
|
@@ -8480,7 +8575,7 @@ module Aws::CloudFormation
|
|
8480
8575
|
# @!attribute [rw] last_drift_check_timestamp
|
8481
8576
|
# Most recent time when CloudFormation performed a drift detection
|
8482
8577
|
# operation on the stack instance. This value will be `NULL` for any
|
8483
|
-
# stack instance
|
8578
|
+
# stack instance that drift detection hasn't yet been performed on.
|
8484
8579
|
# @return [Time]
|
8485
8580
|
#
|
8486
8581
|
# @!attribute [rw] last_operation_id
|
@@ -8511,21 +8606,21 @@ module Aws::CloudFormation
|
|
8511
8606
|
#
|
8512
8607
|
# @!attribute [rw] detailed_status
|
8513
8608
|
# * `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.
|
8609
|
+
# been canceled. This is either because a user has stopped the
|
8610
|
+
# StackSet operation, or because the failure tolerance of the
|
8611
|
+
# StackSet operation has been exceeded.
|
8517
8612
|
#
|
8518
8613
|
# * `FAILED`: The operation in the specified account and Region
|
8519
|
-
# failed. If the
|
8520
|
-
# a Region, the failure tolerance for the
|
8614
|
+
# failed. If the StackSet operation fails in enough accounts within
|
8615
|
+
# a Region, the failure tolerance for the StackSet operation as a
|
8521
8616
|
# whole might be exceeded.
|
8522
8617
|
#
|
8523
8618
|
# * `FAILED_IMPORT`: The import of the stack instance in the specified
|
8524
8619
|
# account and Region failed and left the stack in an unstable state.
|
8525
8620
|
# Once the issues causing the failure are fixed, the import
|
8526
|
-
# operation can be retried. If enough
|
8621
|
+
# operation can be retried. If enough StackSet operations fail in
|
8527
8622
|
# enough accounts within a Region, the failure tolerance for the
|
8528
|
-
#
|
8623
|
+
# StackSet operation as a whole might be exceeded.
|
8529
8624
|
#
|
8530
8625
|
# * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
|
8531
8626
|
# left the stack in an unstable state. Stacks in this state are
|
@@ -8661,7 +8756,7 @@ module Aws::CloudFormation
|
|
8661
8756
|
# instance.
|
8662
8757
|
#
|
8663
8758
|
# @!attribute [rw] stack_set_id
|
8664
|
-
# The name or unique ID of the
|
8759
|
+
# The name or unique ID of the StackSet that the stack instance is
|
8665
8760
|
# associated with.
|
8666
8761
|
# @return [String]
|
8667
8762
|
#
|
@@ -8695,8 +8790,8 @@ module Aws::CloudFormation
|
|
8695
8790
|
# look at the `DetailedStatus` member returned in the
|
8696
8791
|
# `StackInstanceSummary` member.
|
8697
8792
|
#
|
8698
|
-
# * `OUTDATED`: The stack isn't currently up to date with the
|
8699
|
-
#
|
8793
|
+
# * `OUTDATED`: The stack isn't currently up to date with the
|
8794
|
+
# StackSet because:
|
8700
8795
|
#
|
8701
8796
|
# * The associated stack failed during a `CreateStackSet` or
|
8702
8797
|
# `UpdateStackSet` operation.
|
@@ -8704,7 +8799,7 @@ module Aws::CloudFormation
|
|
8704
8799
|
# * The stack was part of a `CreateStackSet` or `UpdateStackSet`
|
8705
8800
|
# operation that failed or was stopped before the stack was
|
8706
8801
|
# created or updated.
|
8707
|
-
# * `CURRENT`: The stack is currently up to date with the
|
8802
|
+
# * `CURRENT`: The stack is currently up to date with the StackSet.
|
8708
8803
|
# @return [String]
|
8709
8804
|
#
|
8710
8805
|
# @!attribute [rw] status_reason
|
@@ -8728,19 +8823,19 @@ module Aws::CloudFormation
|
|
8728
8823
|
#
|
8729
8824
|
# @!attribute [rw] drift_status
|
8730
8825
|
# Status of the stack instance's actual configuration compared to the
|
8731
|
-
# expected template and parameter configuration of the
|
8732
|
-
#
|
8826
|
+
# expected template and parameter configuration of the StackSet it
|
8827
|
+
# belongs to.
|
8733
8828
|
#
|
8734
8829
|
# * `DRIFTED`: The stack differs from the expected template and
|
8735
|
-
# parameter configuration of the
|
8736
|
-
#
|
8830
|
+
# parameter configuration of the StackSet it belongs to. A stack
|
8831
|
+
# instance is considered to have drifted if one or more of the
|
8737
8832
|
# resources in the associated stack have drifted.
|
8738
8833
|
#
|
8739
8834
|
# * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
|
8740
|
-
# instance differs from its expected
|
8835
|
+
# instance differs from its expected StackSet configuration.
|
8741
8836
|
#
|
8742
8837
|
# * `IN_SYNC`: The stack instance's actual configuration matches its
|
8743
|
-
# expected
|
8838
|
+
# expected StackSet configuration.
|
8744
8839
|
#
|
8745
8840
|
# * `UNKNOWN`: This value is reserved for future use.
|
8746
8841
|
# @return [String]
|
@@ -8748,7 +8843,7 @@ module Aws::CloudFormation
|
|
8748
8843
|
# @!attribute [rw] last_drift_check_timestamp
|
8749
8844
|
# Most recent time when CloudFormation performed a drift detection
|
8750
8845
|
# operation on the stack instance. This value will be `NULL` for any
|
8751
|
-
# stack instance
|
8846
|
+
# stack instance that drift detection hasn't yet been performed on.
|
8752
8847
|
# @return [Time]
|
8753
8848
|
#
|
8754
8849
|
# @!attribute [rw] last_operation_id
|
@@ -9359,40 +9454,40 @@ module Aws::CloudFormation
|
|
9359
9454
|
include Aws::Structure
|
9360
9455
|
end
|
9361
9456
|
|
9362
|
-
# A structure that contains information about a
|
9363
|
-
#
|
9364
|
-
#
|
9365
|
-
#
|
9366
|
-
#
|
9457
|
+
# A structure that contains information about a StackSet. With
|
9458
|
+
# StackSets, you can provision stacks across Amazon Web Services
|
9459
|
+
# accounts and Regions from a single CloudFormation template. Each stack
|
9460
|
+
# is based on the same CloudFormation template, but you can customize
|
9461
|
+
# individual stacks using parameters.
|
9367
9462
|
#
|
9368
9463
|
# @!attribute [rw] stack_set_name
|
9369
|
-
# The name that's associated with the
|
9464
|
+
# The name that's associated with the StackSet.
|
9370
9465
|
# @return [String]
|
9371
9466
|
#
|
9372
9467
|
# @!attribute [rw] stack_set_id
|
9373
|
-
# The ID of the
|
9468
|
+
# The ID of the StackSet.
|
9374
9469
|
# @return [String]
|
9375
9470
|
#
|
9376
9471
|
# @!attribute [rw] description
|
9377
|
-
# A description of the
|
9378
|
-
#
|
9472
|
+
# A description of the StackSet that you specify when the StackSet is
|
9473
|
+
# created or updated.
|
9379
9474
|
# @return [String]
|
9380
9475
|
#
|
9381
9476
|
# @!attribute [rw] status
|
9382
|
-
# The status of the
|
9477
|
+
# The status of the StackSet.
|
9383
9478
|
# @return [String]
|
9384
9479
|
#
|
9385
9480
|
# @!attribute [rw] template_body
|
9386
9481
|
# The structure that contains the body of the template that was used
|
9387
|
-
# to create or update the
|
9482
|
+
# to create or update the StackSet.
|
9388
9483
|
# @return [String]
|
9389
9484
|
#
|
9390
9485
|
# @!attribute [rw] parameters
|
9391
|
-
# A list of input parameters for a
|
9486
|
+
# A list of input parameters for a StackSet.
|
9392
9487
|
# @return [Array<Types::Parameter>]
|
9393
9488
|
#
|
9394
9489
|
# @!attribute [rw] capabilities
|
9395
|
-
# The capabilities that are allowed in the
|
9490
|
+
# The capabilities that are allowed in the StackSet. Some StackSet
|
9396
9491
|
# templates might include resources that can affect permissions in
|
9397
9492
|
# your Amazon Web Services account—for example, by creating new
|
9398
9493
|
# Identity and Access Management (IAM) users. For more information,
|
@@ -9404,12 +9499,12 @@ module Aws::CloudFormation
|
|
9404
9499
|
# @return [Array<String>]
|
9405
9500
|
#
|
9406
9501
|
# @!attribute [rw] tags
|
9407
|
-
# A list of tags that specify information about the
|
9502
|
+
# A list of tags that specify information about the StackSet. A
|
9408
9503
|
# maximum number of 50 tags can be specified.
|
9409
9504
|
# @return [Array<Types::Tag>]
|
9410
9505
|
#
|
9411
9506
|
# @!attribute [rw] stack_set_arn
|
9412
|
-
# The Amazon Resource Name (ARN) of the
|
9507
|
+
# The Amazon Resource Name (ARN) of the StackSet.
|
9413
9508
|
# @return [String]
|
9414
9509
|
#
|
9415
9510
|
# @!attribute [rw] administration_role_arn
|
@@ -9417,9 +9512,9 @@ module Aws::CloudFormation
|
|
9417
9512
|
# update the stack set.
|
9418
9513
|
#
|
9419
9514
|
# Use customized administrator roles to control which users or groups
|
9420
|
-
# can manage specific
|
9421
|
-
#
|
9422
|
-
#
|
9515
|
+
# can manage specific StackSets within the same administrator account.
|
9516
|
+
# For more information, see [Prerequisites for using CloudFormation
|
9517
|
+
# StackSets][1] in the *CloudFormation User Guide*.
|
9423
9518
|
#
|
9424
9519
|
#
|
9425
9520
|
#
|
@@ -9428,28 +9523,29 @@ module Aws::CloudFormation
|
|
9428
9523
|
#
|
9429
9524
|
# @!attribute [rw] execution_role_name
|
9430
9525
|
# The name of the IAM execution role used to create or update the
|
9431
|
-
#
|
9526
|
+
# StackSet.
|
9432
9527
|
#
|
9433
9528
|
# Use customized execution roles to control which stack resources
|
9434
|
-
# users and groups can include in their
|
9529
|
+
# users and groups can include in their StackSets.
|
9435
9530
|
# @return [String]
|
9436
9531
|
#
|
9437
9532
|
# @!attribute [rw] stack_set_drift_detection_details
|
9438
|
-
# Detailed information about the drift status of the
|
9533
|
+
# Detailed information about the drift status of the StackSet.
|
9439
9534
|
#
|
9440
|
-
# For
|
9441
|
-
#
|
9535
|
+
# For StackSets, contains information about the last *completed* drift
|
9536
|
+
# operation performed on the StackSet. Information about drift
|
9442
9537
|
# operations currently in progress isn't included.
|
9443
9538
|
# @return [Types::StackSetDriftDetectionDetails]
|
9444
9539
|
#
|
9445
9540
|
# @!attribute [rw] auto_deployment
|
9446
|
-
#
|
9447
|
-
#
|
9448
|
-
#
|
9541
|
+
# Describes whether StackSets automatically deploys to Organizations
|
9542
|
+
# accounts that are added to a target organization or organizational
|
9543
|
+
# unit (OU). Valid only if the StackSet uses service-managed
|
9544
|
+
# permissions.
|
9449
9545
|
# @return [Types::AutoDeployment]
|
9450
9546
|
#
|
9451
9547
|
# @!attribute [rw] permission_model
|
9452
|
-
# Describes how the IAM roles required for
|
9548
|
+
# Describes how the IAM roles required for StackSet operations are
|
9453
9549
|
# created.
|
9454
9550
|
#
|
9455
9551
|
# * With `self-managed` permissions, you must create the administrator
|
@@ -9459,7 +9555,7 @@ module Aws::CloudFormation
|
|
9459
9555
|
# * With `service-managed` permissions, StackSets automatically
|
9460
9556
|
# creates the IAM roles required to deploy to accounts managed by
|
9461
9557
|
# Organizations. For more information, see [Activate trusted access
|
9462
|
-
# for
|
9558
|
+
# for StackSets with Organizations][2].
|
9463
9559
|
#
|
9464
9560
|
#
|
9465
9561
|
#
|
@@ -9512,7 +9608,7 @@ module Aws::CloudFormation
|
|
9512
9608
|
include Aws::Structure
|
9513
9609
|
end
|
9514
9610
|
|
9515
|
-
# One of the targets for the
|
9611
|
+
# One of the targets for the StackSet. Returned by the
|
9516
9612
|
# [ListStackSetAutoDeploymentTargets][1] API operation.
|
9517
9613
|
#
|
9518
9614
|
#
|
@@ -9521,7 +9617,7 @@ module Aws::CloudFormation
|
|
9521
9617
|
#
|
9522
9618
|
# @!attribute [rw] organizational_unit_id
|
9523
9619
|
# The organization root ID or organizational unit (OU) IDs where the
|
9524
|
-
#
|
9620
|
+
# StackSet is targeted.
|
9525
9621
|
# @return [String]
|
9526
9622
|
#
|
9527
9623
|
# @!attribute [rw] regions
|
@@ -9537,14 +9633,14 @@ module Aws::CloudFormation
|
|
9537
9633
|
include Aws::Structure
|
9538
9634
|
end
|
9539
9635
|
|
9540
|
-
# Detailed information about the drift status of the
|
9636
|
+
# Detailed information about the drift status of the StackSet.
|
9541
9637
|
#
|
9542
|
-
# For
|
9543
|
-
# operation performed on the
|
9638
|
+
# For StackSets, contains information about the last *completed* drift
|
9639
|
+
# operation performed on the StackSet. Information about drift
|
9544
9640
|
# operations in-progress isn't included.
|
9545
9641
|
#
|
9546
|
-
# For
|
9547
|
-
# currently being performed on the
|
9642
|
+
# For StackSet operations, includes information about drift operations
|
9643
|
+
# currently being performed on the StackSet.
|
9548
9644
|
#
|
9549
9645
|
# For more information, see [Performing drift detection on
|
9550
9646
|
# CloudFormation StackSets][1] in the *CloudFormation User Guide*.
|
@@ -9554,27 +9650,23 @@ module Aws::CloudFormation
|
|
9554
9650
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
|
9555
9651
|
#
|
9556
9652
|
# @!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.
|
9653
|
+
# Status of the StackSet's actual configuration compared to its
|
9654
|
+
# expected template and parameter configuration.
|
9562
9655
|
#
|
9563
9656
|
# * `DRIFTED`: One or more of the stack instances belonging to the
|
9564
|
-
#
|
9657
|
+
# StackSet differs from the expected template and parameter
|
9565
9658
|
# configuration. A stack instance is considered to have drifted if
|
9566
9659
|
# one or more of the resources in the associated stack have drifted.
|
9567
9660
|
#
|
9568
|
-
# * `NOT_CHECKED`: CloudFormation hasn't checked the
|
9661
|
+
# * `NOT_CHECKED`: CloudFormation hasn't checked the StackSet for
|
9569
9662
|
# drift.
|
9570
9663
|
#
|
9571
|
-
# * `IN_SYNC`: All of the stack instances belonging to the
|
9572
|
-
# stack match
|
9573
|
-
# configuration.
|
9664
|
+
# * `IN_SYNC`: All of the stack instances belonging to the StackSet
|
9665
|
+
# stack match the expected template and parameter configuration.
|
9574
9666
|
# @return [String]
|
9575
9667
|
#
|
9576
9668
|
# @!attribute [rw] drift_detection_status
|
9577
|
-
# The status of the
|
9669
|
+
# The status of the StackSet drift detection operation.
|
9578
9670
|
#
|
9579
9671
|
# * `COMPLETED`: The drift detection operation completed without
|
9580
9672
|
# failing on any stack instances.
|
@@ -9593,19 +9685,18 @@ module Aws::CloudFormation
|
|
9593
9685
|
#
|
9594
9686
|
# @!attribute [rw] last_drift_check_timestamp
|
9595
9687
|
# Most recent time when CloudFormation performed a drift detection
|
9596
|
-
# operation on the
|
9597
|
-
#
|
9688
|
+
# operation on the StackSet. This value will be `NULL` for any
|
9689
|
+
# StackSet that drift detection hasn't yet been performed on.
|
9598
9690
|
# @return [Time]
|
9599
9691
|
#
|
9600
9692
|
# @!attribute [rw] total_stack_instances_count
|
9601
|
-
# The total number of stack instances belonging to this
|
9693
|
+
# The total number of stack instances belonging to this StackSet.
|
9602
9694
|
#
|
9603
9695
|
# The total number of stack instances is equal to the total of:
|
9604
9696
|
#
|
9605
|
-
# * Stack instances that match the
|
9697
|
+
# * Stack instances that match the StackSet configuration.
|
9606
9698
|
#
|
9607
|
-
# * Stack instances that have drifted from the
|
9608
|
-
# configuration.
|
9699
|
+
# * Stack instances that have drifted from the StackSet configuration.
|
9609
9700
|
#
|
9610
9701
|
# * Stack instances where the drift detection operation has failed.
|
9611
9702
|
#
|
@@ -9614,7 +9705,7 @@ module Aws::CloudFormation
|
|
9614
9705
|
#
|
9615
9706
|
# @!attribute [rw] drifted_stack_instances_count
|
9616
9707
|
# The number of stack instances that have drifted from the expected
|
9617
|
-
# template and parameter configuration of the
|
9708
|
+
# template and parameter configuration of the StackSet. A stack
|
9618
9709
|
# instance is considered to have drifted if one or more of the
|
9619
9710
|
# resources in the associated stack don't match their expected
|
9620
9711
|
# configuration.
|
@@ -9622,7 +9713,7 @@ module Aws::CloudFormation
|
|
9622
9713
|
#
|
9623
9714
|
# @!attribute [rw] in_sync_stack_instances_count
|
9624
9715
|
# The number of stack instances which match the expected template and
|
9625
|
-
# parameter configuration of the
|
9716
|
+
# parameter configuration of the StackSet.
|
9626
9717
|
# @return [Integer]
|
9627
9718
|
#
|
9628
9719
|
# @!attribute [rw] in_progress_stack_instances_count
|
@@ -9650,36 +9741,36 @@ module Aws::CloudFormation
|
|
9650
9741
|
include Aws::Structure
|
9651
9742
|
end
|
9652
9743
|
|
9653
|
-
# You can't yet delete this
|
9654
|
-
# more stack instances. Delete all stack instances from the
|
9655
|
-
# before deleting the
|
9744
|
+
# You can't yet delete this StackSet, because it still contains one or
|
9745
|
+
# more stack instances. Delete all stack instances from the StackSet
|
9746
|
+
# before deleting the StackSet.
|
9656
9747
|
#
|
9657
9748
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetNotEmptyException AWS API Documentation
|
9658
9749
|
#
|
9659
9750
|
class StackSetNotEmptyException < Aws::EmptyStructure; end
|
9660
9751
|
|
9661
|
-
# The specified
|
9752
|
+
# The specified StackSet doesn't exist.
|
9662
9753
|
#
|
9663
9754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetNotFoundException AWS API Documentation
|
9664
9755
|
#
|
9665
9756
|
class StackSetNotFoundException < Aws::EmptyStructure; end
|
9666
9757
|
|
9667
|
-
# The structure that contains information about a
|
9758
|
+
# The structure that contains information about a StackSet operation.
|
9668
9759
|
#
|
9669
9760
|
# @!attribute [rw] operation_id
|
9670
|
-
# The unique ID of a
|
9761
|
+
# The unique ID of a StackSet operation.
|
9671
9762
|
# @return [String]
|
9672
9763
|
#
|
9673
9764
|
# @!attribute [rw] stack_set_id
|
9674
|
-
# The ID of the
|
9765
|
+
# The ID of the StackSet.
|
9675
9766
|
# @return [String]
|
9676
9767
|
#
|
9677
9768
|
# @!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
|
9769
|
+
# The type of StackSet operation: `CREATE`, `UPDATE`, or `DELETE`.
|
9770
|
+
# Create and delete operations affect only the specified stack
|
9771
|
+
# instances that are associated with the specified StackSet. Update
|
9772
|
+
# operations affect both the StackSet itself, in addition to *all*
|
9773
|
+
# associated stack instances.
|
9683
9774
|
# @return [String]
|
9684
9775
|
#
|
9685
9776
|
# @!attribute [rw] status
|
@@ -9712,29 +9803,29 @@ module Aws::CloudFormation
|
|
9712
9803
|
#
|
9713
9804
|
#
|
9714
9805
|
#
|
9715
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
9806
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes
|
9716
9807
|
# @return [String]
|
9717
9808
|
#
|
9718
9809
|
# @!attribute [rw] operation_preferences
|
9719
|
-
# The preferences for how CloudFormation performs this
|
9810
|
+
# The preferences for how CloudFormation performs this StackSet
|
9720
9811
|
# operation.
|
9721
9812
|
# @return [Types::StackSetOperationPreferences]
|
9722
9813
|
#
|
9723
9814
|
# @!attribute [rw] retain_stacks
|
9724
|
-
# For
|
9725
|
-
# to remove the stack instances from the specified
|
9815
|
+
# For StackSet operations of action type `DELETE`, specifies whether
|
9816
|
+
# to remove the stack instances from the specified StackSet, but
|
9726
9817
|
# doesn't delete the stacks. You can't re-associate a retained
|
9727
|
-
# stack, or add an existing, saved stack to a new
|
9818
|
+
# stack, or add an existing, saved stack to a new StackSet.
|
9728
9819
|
# @return [Boolean]
|
9729
9820
|
#
|
9730
9821
|
# @!attribute [rw] administration_role_arn
|
9731
9822
|
# The Amazon Resource Name (ARN) of the IAM role used to perform this
|
9732
|
-
#
|
9823
|
+
# StackSet operation.
|
9733
9824
|
#
|
9734
9825
|
# Use customized administrator roles to control which users or groups
|
9735
|
-
# can manage specific
|
9736
|
-
#
|
9737
|
-
#
|
9826
|
+
# can manage specific StackSets within the same administrator account.
|
9827
|
+
# For more information, see [Grant self-managed permissions][1] in the
|
9828
|
+
# *CloudFormation User Guide*.
|
9738
9829
|
#
|
9739
9830
|
#
|
9740
9831
|
#
|
@@ -9743,10 +9834,10 @@ module Aws::CloudFormation
|
|
9743
9834
|
#
|
9744
9835
|
# @!attribute [rw] execution_role_name
|
9745
9836
|
# The name of the IAM execution role used to create or update the
|
9746
|
-
#
|
9837
|
+
# StackSet.
|
9747
9838
|
#
|
9748
9839
|
# Use customized execution roles to control which stack resources
|
9749
|
-
# users and groups can include in their
|
9840
|
+
# users and groups can include in their StackSets.
|
9750
9841
|
# @return [String]
|
9751
9842
|
#
|
9752
9843
|
# @!attribute [rw] creation_timestamp
|
@@ -9759,23 +9850,23 @@ module Aws::CloudFormation
|
|
9759
9850
|
# @return [Time]
|
9760
9851
|
#
|
9761
9852
|
# @!attribute [rw] end_timestamp
|
9762
|
-
# The time at which the
|
9853
|
+
# The time at which the StackSet operation ended, across all accounts
|
9763
9854
|
# and Regions specified. Note that this doesn't necessarily mean that
|
9764
|
-
# the
|
9855
|
+
# the StackSet operation was successful, or even attempted, in each
|
9765
9856
|
# account or Region.
|
9766
9857
|
# @return [Time]
|
9767
9858
|
#
|
9768
9859
|
# @!attribute [rw] deployment_targets
|
9769
|
-
#
|
9770
|
-
#
|
9860
|
+
# The Organizations accounts affected by the stack operation. Valid
|
9861
|
+
# only if the StackSet uses service-managed permissions.
|
9771
9862
|
# @return [Types::DeploymentTargets]
|
9772
9863
|
#
|
9773
9864
|
# @!attribute [rw] stack_set_drift_detection_details
|
9774
|
-
# Detailed information about the drift status of the
|
9865
|
+
# Detailed information about the drift status of the StackSet. This
|
9775
9866
|
# includes information about drift operations currently being
|
9776
|
-
# performed on the
|
9867
|
+
# performed on the StackSet.
|
9777
9868
|
#
|
9778
|
-
# This information will only be present for
|
9869
|
+
# This information will only be present for StackSet operations whose
|
9779
9870
|
# `Action` type is `DETECT_DRIFT`.
|
9780
9871
|
#
|
9781
9872
|
# For more information, see [Performing drift detection on
|
@@ -9815,11 +9906,11 @@ module Aws::CloudFormation
|
|
9815
9906
|
include Aws::Structure
|
9816
9907
|
end
|
9817
9908
|
|
9818
|
-
# The user-specified preferences for how CloudFormation performs a
|
9819
|
-
#
|
9909
|
+
# The user-specified preferences for how CloudFormation performs a
|
9910
|
+
# StackSet operation.
|
9820
9911
|
#
|
9821
9912
|
# For more information about maximum concurrent accounts and failure
|
9822
|
-
# tolerance, see [
|
9913
|
+
# tolerance, see [StackSet operation options][1].
|
9823
9914
|
#
|
9824
9915
|
# <note markdown="1"> `StackSetOperationPreferences` don't apply to `AutoDeployment`, even
|
9825
9916
|
# if it's enabled.
|
@@ -9828,7 +9919,7 @@ module Aws::CloudFormation
|
|
9828
9919
|
#
|
9829
9920
|
#
|
9830
9921
|
#
|
9831
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
9922
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
9832
9923
|
#
|
9833
9924
|
# @!attribute [rw] region_concurrency_type
|
9834
9925
|
# The concurrency type of deploying StackSets operations in Regions,
|
@@ -9841,10 +9932,10 @@ module Aws::CloudFormation
|
|
9841
9932
|
# @return [Array<String>]
|
9842
9933
|
#
|
9843
9934
|
# @!attribute [rw] failure_tolerance_count
|
9844
|
-
# The number of accounts
|
9845
|
-
#
|
9846
|
-
#
|
9847
|
-
#
|
9935
|
+
# The number of accounts per Region this operation can fail in before
|
9936
|
+
# CloudFormation stops the operation in that Region. If the operation
|
9937
|
+
# is stopped in a Region, CloudFormation doesn't attempt the
|
9938
|
+
# operation in any subsequent Regions.
|
9848
9939
|
#
|
9849
9940
|
# You can specify either `FailureToleranceCount` or
|
9850
9941
|
# `FailureTolerancePercentage`, but not both.
|
@@ -9853,10 +9944,10 @@ module Aws::CloudFormation
|
|
9853
9944
|
# @return [Integer]
|
9854
9945
|
#
|
9855
9946
|
# @!attribute [rw] failure_tolerance_percentage
|
9856
|
-
# The percentage of accounts
|
9857
|
-
#
|
9858
|
-
#
|
9859
|
-
#
|
9947
|
+
# The percentage of accounts per Region this stack operation can fail
|
9948
|
+
# in before CloudFormation stops the operation in that Region. If the
|
9949
|
+
# operation is stopped in a Region, CloudFormation doesn't attempt
|
9950
|
+
# the operation in any subsequent Regions.
|
9860
9951
|
#
|
9861
9952
|
# When calculating the number of accounts based on the specified
|
9862
9953
|
# percentage, CloudFormation rounds *down* to the next whole number.
|
@@ -9922,7 +10013,7 @@ module Aws::CloudFormation
|
|
9922
10013
|
#
|
9923
10014
|
# * `SOFT_FAILURE_TOLERANCE`: This option decouples
|
9924
10015
|
# `FailureToleranceCount` from the actual concurrency. This allows
|
9925
|
-
#
|
10016
|
+
# StackSet operations to run at the concurrency level set by the
|
9926
10017
|
# `MaxConcurrentCount` value, or `MaxConcurrentPercentage`,
|
9927
10018
|
# regardless of the number of failures.
|
9928
10019
|
# @return [String]
|
@@ -9955,19 +10046,19 @@ module Aws::CloudFormation
|
|
9955
10046
|
# @return [String]
|
9956
10047
|
#
|
9957
10048
|
# @!attribute [rw] status
|
9958
|
-
# The result status of the
|
9959
|
-
#
|
10049
|
+
# The result status of the StackSet operation for the given account in
|
10050
|
+
# the given Region.
|
9960
10051
|
#
|
9961
10052
|
# * `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.
|
10053
|
+
# been canceled. This is either because a user has stopped the
|
10054
|
+
# StackSet operation, or because the failure tolerance of the
|
10055
|
+
# StackSet operation has been exceeded.
|
9965
10056
|
#
|
9966
10057
|
# * `FAILED`: The operation in the specified account and Region
|
9967
10058
|
# failed.
|
9968
10059
|
#
|
9969
|
-
# If the
|
9970
|
-
# Region, the failure tolerance for the
|
10060
|
+
# If the StackSet operation fails in enough accounts within a
|
10061
|
+
# Region, the failure tolerance for the StackSet operation as a
|
9971
10062
|
# whole might be exceeded.
|
9972
10063
|
#
|
9973
10064
|
# * `RUNNING`: The operation in the specified account and Region is
|
@@ -9986,7 +10077,7 @@ module Aws::CloudFormation
|
|
9986
10077
|
#
|
9987
10078
|
# @!attribute [rw] account_gate_result
|
9988
10079
|
# The results of the account gate function CloudFormation invokes, if
|
9989
|
-
# present, before proceeding with
|
10080
|
+
# present, before proceeding with StackSet operations in an account.
|
9990
10081
|
# @return [Types::AccountGateResult]
|
9991
10082
|
#
|
9992
10083
|
# @!attribute [rw] organizational_unit_id
|
@@ -10031,14 +10122,14 @@ module Aws::CloudFormation
|
|
10031
10122
|
# operation.
|
10032
10123
|
#
|
10033
10124
|
# @!attribute [rw] operation_id
|
10034
|
-
# The unique ID of the
|
10125
|
+
# The unique ID of the StackSet operation.
|
10035
10126
|
# @return [String]
|
10036
10127
|
#
|
10037
10128
|
# @!attribute [rw] action
|
10038
10129
|
# The type of operation: `CREATE`, `UPDATE`, or `DELETE`. Create and
|
10039
10130
|
# delete operations affect only the specified stack instances that are
|
10040
|
-
# associated with the specified
|
10041
|
-
# both the
|
10131
|
+
# associated with the specified StackSet. Update operations affect
|
10132
|
+
# both the StackSet itself and *all* associated StackSet instances.
|
10042
10133
|
# @return [String]
|
10043
10134
|
#
|
10044
10135
|
# @!attribute [rw] status
|
@@ -10055,8 +10146,8 @@ module Aws::CloudFormation
|
|
10055
10146
|
#
|
10056
10147
|
# * `QUEUED`: \[Service-managed permissions\] For automatic
|
10057
10148
|
# deployments that require a sequence of operations, the operation
|
10058
|
-
# is queued to be performed. For more information, see the [
|
10059
|
-
#
|
10149
|
+
# is queued to be performed. For more information, see the [StackSet
|
10150
|
+
# status codes][1] in the *CloudFormation User Guide*.
|
10060
10151
|
#
|
10061
10152
|
# * `RUNNING`: The operation is currently being performed.
|
10062
10153
|
#
|
@@ -10071,12 +10162,12 @@ module Aws::CloudFormation
|
|
10071
10162
|
#
|
10072
10163
|
#
|
10073
10164
|
#
|
10074
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
10165
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes
|
10075
10166
|
# @return [String]
|
10076
10167
|
#
|
10077
10168
|
# @!attribute [rw] creation_timestamp
|
10078
10169
|
# The time at which the operation was initiated. Note that the
|
10079
|
-
# creation times for the
|
10170
|
+
# creation times for the StackSet operation might differ from the
|
10080
10171
|
# creation time of the individual stacks themselves. This is because
|
10081
10172
|
# CloudFormation needs to perform preparatory work for the operation,
|
10082
10173
|
# such as dispatching the work to the requested Regions, before
|
@@ -10084,9 +10175,9 @@ module Aws::CloudFormation
|
|
10084
10175
|
# @return [Time]
|
10085
10176
|
#
|
10086
10177
|
# @!attribute [rw] end_timestamp
|
10087
|
-
# The time at which the
|
10178
|
+
# The time at which the StackSet operation ended, across all accounts
|
10088
10179
|
# and Regions specified. Note that this doesn't necessarily mean that
|
10089
|
-
# the
|
10180
|
+
# the StackSet operation was successful, or even attempted, in each
|
10090
10181
|
# account or Region.
|
10091
10182
|
# @return [Time]
|
10092
10183
|
#
|
@@ -10095,19 +10186,19 @@ module Aws::CloudFormation
|
|
10095
10186
|
# @return [String]
|
10096
10187
|
#
|
10097
10188
|
# @!attribute [rw] status_details
|
10098
|
-
# Detailed information about the
|
10189
|
+
# Detailed information about the StackSet operation.
|
10099
10190
|
# @return [Types::StackSetOperationStatusDetails]
|
10100
10191
|
#
|
10101
10192
|
# @!attribute [rw] operation_preferences
|
10102
10193
|
# The user-specified preferences for how CloudFormation performs a
|
10103
|
-
#
|
10194
|
+
# StackSet operation.
|
10104
10195
|
#
|
10105
10196
|
# For more information about maximum concurrent accounts and failure
|
10106
|
-
# tolerance, see [
|
10197
|
+
# tolerance, see [StackSet operation options][1].
|
10107
10198
|
#
|
10108
10199
|
#
|
10109
10200
|
#
|
10110
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
10201
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
10111
10202
|
# @return [Types::StackSetOperationPreferences]
|
10112
10203
|
#
|
10113
10204
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationSummary AWS API Documentation
|
@@ -10126,23 +10217,23 @@ module Aws::CloudFormation
|
|
10126
10217
|
end
|
10127
10218
|
|
10128
10219
|
# The structures that contain summary information about the specified
|
10129
|
-
#
|
10220
|
+
# StackSet.
|
10130
10221
|
#
|
10131
10222
|
# @!attribute [rw] stack_set_name
|
10132
|
-
# The name of the
|
10223
|
+
# The name of the StackSet.
|
10133
10224
|
# @return [String]
|
10134
10225
|
#
|
10135
10226
|
# @!attribute [rw] stack_set_id
|
10136
|
-
# The ID of the
|
10227
|
+
# The ID of the StackSet.
|
10137
10228
|
# @return [String]
|
10138
10229
|
#
|
10139
10230
|
# @!attribute [rw] description
|
10140
|
-
# A description of the
|
10141
|
-
#
|
10231
|
+
# A description of the StackSet that you specify when the StackSet is
|
10232
|
+
# created or updated.
|
10142
10233
|
# @return [String]
|
10143
10234
|
#
|
10144
10235
|
# @!attribute [rw] status
|
10145
|
-
# The status of the
|
10236
|
+
# The status of the StackSet.
|
10146
10237
|
# @return [String]
|
10147
10238
|
#
|
10148
10239
|
# @!attribute [rw] auto_deployment
|
@@ -10152,7 +10243,7 @@ module Aws::CloudFormation
|
|
10152
10243
|
# @return [Types::AutoDeployment]
|
10153
10244
|
#
|
10154
10245
|
# @!attribute [rw] permission_model
|
10155
|
-
# Describes how the IAM roles required for
|
10246
|
+
# Describes how the IAM roles required for StackSet operations are
|
10156
10247
|
# created.
|
10157
10248
|
#
|
10158
10249
|
# * With `self-managed` permissions, you must create the administrator
|
@@ -10162,7 +10253,7 @@ module Aws::CloudFormation
|
|
10162
10253
|
# * With `service-managed` permissions, StackSets automatically
|
10163
10254
|
# creates the IAM roles required to deploy to accounts managed by
|
10164
10255
|
# Organizations. For more information, see [Activate trusted access
|
10165
|
-
# for
|
10256
|
+
# for StackSets with Organizations][2].
|
10166
10257
|
#
|
10167
10258
|
#
|
10168
10259
|
#
|
@@ -10171,31 +10262,27 @@ module Aws::CloudFormation
|
|
10171
10262
|
# @return [String]
|
10172
10263
|
#
|
10173
10264
|
# @!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.
|
10265
|
+
# Status of the StackSet's actual configuration compared to its
|
10266
|
+
# expected template and parameter configuration.
|
10179
10267
|
#
|
10180
10268
|
# * `DRIFTED`: One or more of the stack instances belonging to the
|
10181
|
-
#
|
10269
|
+
# StackSet differs from the expected template and parameter
|
10182
10270
|
# configuration. A stack instance is considered to have drifted if
|
10183
10271
|
# one or more of the resources in the associated stack have drifted.
|
10184
10272
|
#
|
10185
|
-
# * `NOT_CHECKED`: CloudFormation hasn't checked the
|
10273
|
+
# * `NOT_CHECKED`: CloudFormation hasn't checked the StackSet for
|
10186
10274
|
# drift.
|
10187
10275
|
#
|
10188
|
-
# * `IN_SYNC`: All the stack instances belonging to the
|
10189
|
-
#
|
10190
|
-
# configuration.
|
10276
|
+
# * `IN_SYNC`: All the stack instances belonging to the StackSet match
|
10277
|
+
# the expected template and parameter configuration.
|
10191
10278
|
#
|
10192
10279
|
# * `UNKNOWN`: This value is reserved for future use.
|
10193
10280
|
# @return [String]
|
10194
10281
|
#
|
10195
10282
|
# @!attribute [rw] last_drift_check_timestamp
|
10196
10283
|
# Most recent time when CloudFormation performed a drift detection
|
10197
|
-
# operation on the
|
10198
|
-
#
|
10284
|
+
# operation on the StackSet. This value will be `NULL` for any
|
10285
|
+
# StackSet that drift detection hasn't yet been performed on.
|
10199
10286
|
# @return [Time]
|
10200
10287
|
#
|
10201
10288
|
# @!attribute [rw] managed_execution
|
@@ -10310,7 +10397,7 @@ module Aws::CloudFormation
|
|
10310
10397
|
include Aws::Structure
|
10311
10398
|
end
|
10312
10399
|
|
10313
|
-
# Another operation has been performed on this
|
10400
|
+
# Another operation has been performed on this StackSet since the
|
10314
10401
|
# specified operation was performed.
|
10315
10402
|
#
|
10316
10403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StaleRequestException AWS API Documentation
|
@@ -10353,7 +10440,7 @@ module Aws::CloudFormation
|
|
10353
10440
|
end
|
10354
10441
|
|
10355
10442
|
# @!attribute [rw] stack_set_name
|
10356
|
-
# The name or unique ID of the
|
10443
|
+
# The name or unique ID of the StackSet that you want to stop the
|
10357
10444
|
# operation for.
|
10358
10445
|
# @return [String]
|
10359
10446
|
#
|
@@ -10362,11 +10449,12 @@ module Aws::CloudFormation
|
|
10362
10449
|
# @return [String]
|
10363
10450
|
#
|
10364
10451
|
# @!attribute [rw] call_as
|
10365
|
-
#
|
10366
|
-
#
|
10367
|
-
#
|
10452
|
+
# Specifies whether you are acting as an account administrator in the
|
10453
|
+
# organization's management account or as a delegated administrator
|
10454
|
+
# in a member account. Valid only if the StackSet uses service-managed
|
10455
|
+
# permissions.
|
10368
10456
|
#
|
10369
|
-
# By default, `SELF` is specified. Use `SELF` for
|
10457
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
10370
10458
|
# self-managed permissions.
|
10371
10459
|
#
|
10372
10460
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -10704,8 +10792,7 @@ module Aws::CloudFormation
|
|
10704
10792
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html
|
10705
10793
|
#
|
10706
10794
|
# @!attribute [rw] arn
|
10707
|
-
# The
|
10708
|
-
# account and Region.
|
10795
|
+
# The ARN for the configuration data, in this account and Region.
|
10709
10796
|
# @return [String]
|
10710
10797
|
#
|
10711
10798
|
# @!attribute [rw] alias
|
@@ -10729,8 +10816,7 @@ module Aws::CloudFormation
|
|
10729
10816
|
# @return [Time]
|
10730
10817
|
#
|
10731
10818
|
# @!attribute [rw] type_arn
|
10732
|
-
# The
|
10733
|
-
# and Region.
|
10819
|
+
# The ARN for the extension, in this account and Region.
|
10734
10820
|
#
|
10735
10821
|
# For public extensions, this will be the ARN assigned when you call
|
10736
10822
|
# the [ActivateType][1] API operation in this account and Region. For
|
@@ -10770,8 +10856,7 @@ module Aws::CloudFormation
|
|
10770
10856
|
# extension.
|
10771
10857
|
#
|
10772
10858
|
# @!attribute [rw] type_arn
|
10773
|
-
# The
|
10774
|
-
# and Region.
|
10859
|
+
# The ARN for the extension, in this account and Region.
|
10775
10860
|
#
|
10776
10861
|
# For public extensions, this will be the ARN assigned when you call
|
10777
10862
|
# the [ActivateType][1] API operation in this account and Region. For
|
@@ -10790,8 +10875,7 @@ module Aws::CloudFormation
|
|
10790
10875
|
# @return [String]
|
10791
10876
|
#
|
10792
10877
|
# @!attribute [rw] type_configuration_arn
|
10793
|
-
# The
|
10794
|
-
# account and Region.
|
10878
|
+
# The ARN for the configuration, in this account and Region.
|
10795
10879
|
# @return [String]
|
10796
10880
|
#
|
10797
10881
|
# @!attribute [rw] type
|
@@ -10906,7 +10990,7 @@ module Aws::CloudFormation
|
|
10906
10990
|
# @return [String]
|
10907
10991
|
#
|
10908
10992
|
# @!attribute [rw] type_arn
|
10909
|
-
# The
|
10993
|
+
# The ARN of the extension.
|
10910
10994
|
# @return [String]
|
10911
10995
|
#
|
10912
10996
|
# @!attribute [rw] last_updated
|
@@ -11043,8 +11127,8 @@ module Aws::CloudFormation
|
|
11043
11127
|
#
|
11044
11128
|
# @!attribute [rw] version_id
|
11045
11129
|
# The ID of a specific version of the extension. The version ID is the
|
11046
|
-
# value at the end of the
|
11047
|
-
#
|
11130
|
+
# value at the end of the ARN assigned to the extension version when
|
11131
|
+
# it's registered.
|
11048
11132
|
# @return [String]
|
11049
11133
|
#
|
11050
11134
|
# @!attribute [rw] is_default_version
|
@@ -11057,7 +11141,7 @@ module Aws::CloudFormation
|
|
11057
11141
|
# @return [Boolean]
|
11058
11142
|
#
|
11059
11143
|
# @!attribute [rw] arn
|
11060
|
-
# The
|
11144
|
+
# The ARN of the extension version.
|
11061
11145
|
# @return [String]
|
11062
11146
|
#
|
11063
11147
|
# @!attribute [rw] time_created
|
@@ -11476,13 +11560,13 @@ module Aws::CloudFormation
|
|
11476
11560
|
end
|
11477
11561
|
|
11478
11562
|
# @!attribute [rw] stack_set_name
|
11479
|
-
# The name or unique ID of the
|
11563
|
+
# The name or unique ID of the StackSet associated with the stack
|
11480
11564
|
# instances.
|
11481
11565
|
# @return [String]
|
11482
11566
|
#
|
11483
11567
|
# @!attribute [rw] accounts
|
11484
11568
|
# \[Self-managed permissions\] The account IDs of one or more Amazon
|
11485
|
-
# Web Services accounts
|
11569
|
+
# Web Services accounts in which you want to update parameter values
|
11486
11570
|
# for stack instances. The overridden parameter values will be applied
|
11487
11571
|
# to all stack instances in the specified accounts and Amazon Web
|
11488
11572
|
# Services Regions.
|
@@ -11491,7 +11575,7 @@ module Aws::CloudFormation
|
|
11491
11575
|
# @return [Array<String>]
|
11492
11576
|
#
|
11493
11577
|
# @!attribute [rw] deployment_targets
|
11494
|
-
# \[Service-managed permissions\] The Organizations accounts
|
11578
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
11495
11579
|
# you want to update parameter values for stack instances. If your
|
11496
11580
|
# update targets OUs, the overridden parameter values only apply to
|
11497
11581
|
# the accounts that are currently in the target OUs and their child
|
@@ -11526,22 +11610,22 @@ module Aws::CloudFormation
|
|
11526
11610
|
# can't specify both a value and set `UsePreviousValue` to `true`.)
|
11527
11611
|
#
|
11528
11612
|
# * To set an overridden parameter back to the value specified in the
|
11529
|
-
#
|
11613
|
+
# StackSet, specify a parameter list but don't include the
|
11530
11614
|
# parameter in the list.
|
11531
11615
|
#
|
11532
11616
|
# * To leave all parameters set to their present values, don't
|
11533
11617
|
# specify this property at all.
|
11534
11618
|
#
|
11535
|
-
# During
|
11536
|
-
#
|
11619
|
+
# During StackSet updates, any parameter values overridden for a stack
|
11620
|
+
# instance aren't updated, but retain their overridden value.
|
11537
11621
|
#
|
11538
11622
|
# You can only override the parameter *values* that are specified in
|
11539
|
-
# the
|
11540
|
-
# `UpdateStackSet` to update the
|
11623
|
+
# the StackSet. To add or delete a parameter itself, use
|
11624
|
+
# `UpdateStackSet` to update the StackSet template. If you add a
|
11541
11625
|
# parameter to a template, before you can override the parameter value
|
11542
|
-
# specified in the
|
11626
|
+
# specified in the StackSet you must first use [UpdateStackSet][1] to
|
11543
11627
|
# update all stack instances with the updated template and parameter
|
11544
|
-
# value specified in the
|
11628
|
+
# value specified in the StackSet. Once a stack instance has been
|
11545
11629
|
# updated with the new parameter, you can then override the parameter
|
11546
11630
|
# value using `UpdateStackInstances`.
|
11547
11631
|
#
|
@@ -11551,16 +11635,15 @@ module Aws::CloudFormation
|
|
11551
11635
|
# @return [Array<Types::Parameter>]
|
11552
11636
|
#
|
11553
11637
|
# @!attribute [rw] operation_preferences
|
11554
|
-
# Preferences for how CloudFormation performs this
|
11555
|
-
# operation.
|
11638
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
11556
11639
|
# @return [Types::StackSetOperationPreferences]
|
11557
11640
|
#
|
11558
11641
|
# @!attribute [rw] operation_id
|
11559
|
-
# The unique identifier for this
|
11642
|
+
# The unique identifier for this StackSet operation.
|
11560
11643
|
#
|
11561
11644
|
# 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
|
11645
|
+
# that CloudFormation performs the StackSet operation only once, even
|
11646
|
+
# if you retry the request multiple times. You might retry StackSet
|
11564
11647
|
# operation requests to ensure that CloudFormation successfully
|
11565
11648
|
# received them.
|
11566
11649
|
#
|
@@ -11576,7 +11659,7 @@ module Aws::CloudFormation
|
|
11576
11659
|
# an account administrator in the organization's management account
|
11577
11660
|
# or as a delegated administrator in a member account.
|
11578
11661
|
#
|
11579
|
-
# By default, `SELF` is specified. Use `SELF` for
|
11662
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
11580
11663
|
# self-managed permissions.
|
11581
11664
|
#
|
11582
11665
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -11610,7 +11693,7 @@ module Aws::CloudFormation
|
|
11610
11693
|
end
|
11611
11694
|
|
11612
11695
|
# @!attribute [rw] operation_id
|
11613
|
-
# The unique identifier for this
|
11696
|
+
# The unique identifier for this StackSet operation.
|
11614
11697
|
# @return [String]
|
11615
11698
|
#
|
11616
11699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstancesOutput AWS API Documentation
|
@@ -11636,7 +11719,7 @@ module Aws::CloudFormation
|
|
11636
11719
|
end
|
11637
11720
|
|
11638
11721
|
# @!attribute [rw] stack_set_name
|
11639
|
-
# The name or unique ID of the
|
11722
|
+
# The name or unique ID of the StackSet that you want to update.
|
11640
11723
|
# @return [String]
|
11641
11724
|
#
|
11642
11725
|
# @!attribute [rw] description
|
@@ -11665,7 +11748,7 @@ module Aws::CloudFormation
|
|
11665
11748
|
# @return [String]
|
11666
11749
|
#
|
11667
11750
|
# @!attribute [rw] use_previous_template
|
11668
|
-
# Use the existing template that's associated with the
|
11751
|
+
# Use the existing template that's associated with the StackSet that
|
11669
11752
|
# you're updating.
|
11670
11753
|
#
|
11671
11754
|
# Conditional: You must specify only one of the following parameters:
|
@@ -11674,13 +11757,13 @@ module Aws::CloudFormation
|
|
11674
11757
|
# @return [Boolean]
|
11675
11758
|
#
|
11676
11759
|
# @!attribute [rw] parameters
|
11677
|
-
# A list of input parameters for the
|
11760
|
+
# A list of input parameters for the StackSet template.
|
11678
11761
|
# @return [Array<Types::Parameter>]
|
11679
11762
|
#
|
11680
11763
|
# @!attribute [rw] capabilities
|
11681
11764
|
# In some cases, you must explicitly acknowledge that your stack
|
11682
11765
|
# template contains certain capabilities in order for CloudFormation
|
11683
|
-
# to update the
|
11766
|
+
# to update the StackSet and its associated stack instances.
|
11684
11767
|
#
|
11685
11768
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
11686
11769
|
#
|
@@ -11721,21 +11804,21 @@ module Aws::CloudFormation
|
|
11721
11804
|
#
|
11722
11805
|
# * `CAPABILITY_AUTO_EXPAND`
|
11723
11806
|
#
|
11724
|
-
# Some templates reference macros. If your
|
11725
|
-
# references one or more macros, you must update the
|
11807
|
+
# Some templates reference macros. If your StackSet template
|
11808
|
+
# references one or more macros, you must update the StackSet
|
11726
11809
|
# directly from the processed template, without first reviewing the
|
11727
|
-
# resulting changes in a change set. To update the
|
11810
|
+
# resulting changes in a change set. To update the StackSet
|
11728
11811
|
# directly, you must acknowledge this capability. For more
|
11729
11812
|
# information, see [Perform custom processing on CloudFormation
|
11730
11813
|
# templates with template macros][9].
|
11731
11814
|
#
|
11732
|
-
#
|
11815
|
+
# StackSets with service-managed permissions do not currently
|
11733
11816
|
# support the use of macros in templates. (This includes the
|
11734
11817
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
11735
11818
|
# macros hosted by CloudFormation.) Even if you specify this
|
11736
|
-
# capability for a
|
11737
|
-
#
|
11738
|
-
#
|
11819
|
+
# capability for a StackSet with service-managed permissions, if you
|
11820
|
+
# reference a macro in your template the StackSet operation will
|
11821
|
+
# fail.
|
11739
11822
|
#
|
11740
11823
|
#
|
11741
11824
|
#
|
@@ -11753,24 +11836,24 @@ module Aws::CloudFormation
|
|
11753
11836
|
# @return [Array<String>]
|
11754
11837
|
#
|
11755
11838
|
# @!attribute [rw] tags
|
11756
|
-
# The key-value pairs to associate with this
|
11839
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
11757
11840
|
# created from it. CloudFormation also propagates these tags to
|
11758
11841
|
# supported resources that are created in the stacks. You can specify
|
11759
11842
|
# a maximum number of 50 tags.
|
11760
11843
|
#
|
11761
11844
|
# If you specify tags for this parameter, those tags replace any list
|
11762
|
-
# of tags that are currently associated with this
|
11845
|
+
# of tags that are currently associated with this StackSet. This
|
11763
11846
|
# means:
|
11764
11847
|
#
|
11765
11848
|
# * If you don't specify this parameter, CloudFormation doesn't
|
11766
11849
|
# modify the stack's tags.
|
11767
11850
|
#
|
11768
11851
|
# * If you specify *any* tags using this parameter, you must specify
|
11769
|
-
# *all* the tags that you want associated with this
|
11852
|
+
# *all* the tags that you want associated with this StackSet, even
|
11770
11853
|
# tags you've specified before (for example, when creating the
|
11771
|
-
#
|
11854
|
+
# StackSet or during a previous update of the StackSet.). Any tags
|
11772
11855
|
# that you don't include in the updated list of tags are removed
|
11773
|
-
# from the
|
11856
|
+
# from the StackSet, and therefore from the stacks and resources as
|
11774
11857
|
# well.
|
11775
11858
|
#
|
11776
11859
|
# * If you specify an empty value, CloudFormation removes all
|
@@ -11779,33 +11862,32 @@ module Aws::CloudFormation
|
|
11779
11862
|
# If you specify new tags as part of an `UpdateStackSet` action,
|
11780
11863
|
# CloudFormation checks to see if you have the required IAM permission
|
11781
11864
|
# 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
|
11865
|
+
# with the StackSet from the list of tags you specify, CloudFormation
|
11866
|
+
# assumes that you want to remove those tags from the StackSet, and
|
11784
11867
|
# checks to see if you have permission to untag resources. If you
|
11785
11868
|
# don't have the necessary permission(s), the entire `UpdateStackSet`
|
11786
|
-
# action fails with an `access denied` error, and the
|
11869
|
+
# action fails with an `access denied` error, and the StackSet is not
|
11787
11870
|
# updated.
|
11788
11871
|
# @return [Array<Types::Tag>]
|
11789
11872
|
#
|
11790
11873
|
# @!attribute [rw] operation_preferences
|
11791
|
-
# Preferences for how CloudFormation performs this
|
11792
|
-
# operation.
|
11874
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
11793
11875
|
# @return [Types::StackSetOperationPreferences]
|
11794
11876
|
#
|
11795
11877
|
# @!attribute [rw] administration_role_arn
|
11796
11878
|
# \[Self-managed permissions\] The Amazon Resource Name (ARN) of the
|
11797
|
-
# IAM role to use to update this
|
11879
|
+
# IAM role to use to update this StackSet.
|
11798
11880
|
#
|
11799
11881
|
# Specify an IAM role only if you are using customized administrator
|
11800
|
-
# roles to control which users or groups can manage specific
|
11801
|
-
#
|
11802
|
-
#
|
11882
|
+
# roles to control which users or groups can manage specific StackSets
|
11883
|
+
# within the same administrator account. For more information, see
|
11884
|
+
# [Grant self-managed permissions][1] in the *CloudFormation User
|
11803
11885
|
# Guide*.
|
11804
11886
|
#
|
11805
11887
|
# If you specified a customized administrator role when you created
|
11806
|
-
# the
|
11807
|
-
#
|
11808
|
-
#
|
11888
|
+
# the StackSet, you must specify a customized administrator role, even
|
11889
|
+
# if it is the same customized administrator role used with this
|
11890
|
+
# StackSet previously.
|
11809
11891
|
#
|
11810
11892
|
#
|
11811
11893
|
#
|
@@ -11816,40 +11898,39 @@ module Aws::CloudFormation
|
|
11816
11898
|
# \[Self-managed permissions\] The name of the IAM execution role to
|
11817
11899
|
# use to update the stack set. If you do not specify an execution
|
11818
11900
|
# role, CloudFormation uses the
|
11819
|
-
# `AWSCloudFormationStackSetExecutionRole` role for the
|
11901
|
+
# `AWSCloudFormationStackSetExecutionRole` role for the StackSet
|
11820
11902
|
# operation.
|
11821
11903
|
#
|
11822
11904
|
# Specify an IAM role only if you are using customized execution roles
|
11823
11905
|
# to control which stack resources users and groups can include in
|
11824
|
-
# their
|
11906
|
+
# their StackSets.
|
11825
11907
|
#
|
11826
11908
|
# If you specify a customized execution role, CloudFormation uses that
|
11827
11909
|
# role to update the stack. If you do not specify a customized
|
11828
11910
|
# execution role, CloudFormation performs the update using the role
|
11829
|
-
# previously associated with the
|
11830
|
-
# permissions to perform operations on the
|
11911
|
+
# previously associated with the StackSet, so long as you have
|
11912
|
+
# permissions to perform operations on the StackSet.
|
11831
11913
|
# @return [String]
|
11832
11914
|
#
|
11833
11915
|
# @!attribute [rw] deployment_targets
|
11834
11916
|
# \[Service-managed permissions\] The Organizations accounts in which
|
11835
11917
|
# to update associated stack instances.
|
11836
11918
|
#
|
11837
|
-
# To update all the stack instances associated with this
|
11919
|
+
# To update all the stack instances associated with this StackSet, do
|
11838
11920
|
# not specify `DeploymentTargets` or `Regions`.
|
11839
11921
|
#
|
11840
|
-
# If the
|
11841
|
-
#
|
11842
|
-
#
|
11843
|
-
#
|
11844
|
-
#
|
11845
|
-
#
|
11846
|
-
#
|
11847
|
-
#
|
11848
|
-
# existing stack instance status.
|
11922
|
+
# If the StackSet update includes changes to the template (that is, if
|
11923
|
+
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
11924
|
+
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
11925
|
+
# prior to updating the stack instances in the specified accounts and
|
11926
|
+
# Amazon Web Services Regions. If the StackSet update doesn't include
|
11927
|
+
# changes to the template or parameters, CloudFormation updates the
|
11928
|
+
# stack instances in the specified accounts and Regions, while leaving
|
11929
|
+
# all other stack instances with their existing stack instance status.
|
11849
11930
|
# @return [Types::DeploymentTargets]
|
11850
11931
|
#
|
11851
11932
|
# @!attribute [rw] permission_model
|
11852
|
-
# Describes how the IAM roles required for
|
11933
|
+
# Describes how the IAM roles required for StackSet operations are
|
11853
11934
|
# created. You cannot modify `PermissionModel` if there are stack
|
11854
11935
|
# instances associated with your stack set.
|
11855
11936
|
#
|
@@ -11860,7 +11941,7 @@ module Aws::CloudFormation
|
|
11860
11941
|
# * With `service-managed` permissions, StackSets automatically
|
11861
11942
|
# creates the IAM roles required to deploy to accounts managed by
|
11862
11943
|
# Organizations. For more information, see [Activate trusted access
|
11863
|
-
# for
|
11944
|
+
# for StackSets with Organizations][2].
|
11864
11945
|
#
|
11865
11946
|
#
|
11866
11947
|
#
|
@@ -11872,9 +11953,8 @@ module Aws::CloudFormation
|
|
11872
11953
|
# \[Service-managed permissions\] Describes whether StackSets
|
11873
11954
|
# automatically deploys to Organizations accounts that are added to a
|
11874
11955
|
# target organization or organizational unit (OU). For more
|
11875
|
-
# information, see [
|
11876
|
-
# StackSets
|
11877
|
-
# *CloudFormation User Guide*.
|
11956
|
+
# information, see [Enable or disable automatic deployments for
|
11957
|
+
# StackSets in Organizations][1] in the *CloudFormation User Guide*.
|
11878
11958
|
#
|
11879
11959
|
# If you specify `AutoDeployment`, don't specify `DeploymentTargets`
|
11880
11960
|
# or `Regions`.
|
@@ -11885,18 +11965,18 @@ module Aws::CloudFormation
|
|
11885
11965
|
# @return [Types::AutoDeployment]
|
11886
11966
|
#
|
11887
11967
|
# @!attribute [rw] operation_id
|
11888
|
-
# The unique ID for this
|
11968
|
+
# The unique ID for this StackSet operation.
|
11889
11969
|
#
|
11890
11970
|
# 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
|
11971
|
+
# that CloudFormation performs the StackSet operation only once, even
|
11972
|
+
# if you retry the request multiple times. You might retry StackSet
|
11893
11973
|
# operation requests to ensure that CloudFormation successfully
|
11894
11974
|
# received them.
|
11895
11975
|
#
|
11896
11976
|
# If you don't specify an operation ID, CloudFormation generates one
|
11897
11977
|
# automatically.
|
11898
11978
|
#
|
11899
|
-
# Repeating this
|
11979
|
+
# Repeating this StackSet operation with a new operation ID retries
|
11900
11980
|
# all stack instances whose status is `OUTDATED`.
|
11901
11981
|
#
|
11902
11982
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -11906,36 +11986,36 @@ module Aws::CloudFormation
|
|
11906
11986
|
# @!attribute [rw] accounts
|
11907
11987
|
# \[Self-managed permissions\] The accounts in which to update
|
11908
11988
|
# associated stack instances. If you specify accounts, you must also
|
11909
|
-
# specify the Amazon Web Services Regions in which to update
|
11989
|
+
# specify the Amazon Web Services Regions in which to update StackSet
|
11910
11990
|
# instances.
|
11911
11991
|
#
|
11912
|
-
# To update *all* the stack instances associated with this
|
11992
|
+
# To update *all* the stack instances associated with this StackSet,
|
11913
11993
|
# don't specify the `Accounts` or `Regions` properties.
|
11914
11994
|
#
|
11915
|
-
# If the
|
11916
|
-
#
|
11995
|
+
# If the StackSet update includes changes to the template (that is, if
|
11996
|
+
# the `TemplateBody` or `TemplateURL` properties are specified), or
|
11917
11997
|
# the `Parameters` property, CloudFormation marks all stack instances
|
11918
11998
|
# 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.
|
11999
|
+
# the specified accounts and Amazon Web Services Regions. If the
|
12000
|
+
# StackSet update does not include changes to the template or
|
12001
|
+
# parameters, CloudFormation updates the stack instances in the
|
12002
|
+
# specified accounts and Amazon Web Services Regions, while leaving
|
12003
|
+
# all other stack instances with their existing stack instance status.
|
11924
12004
|
# @return [Array<String>]
|
11925
12005
|
#
|
11926
12006
|
# @!attribute [rw] regions
|
11927
12007
|
# The Amazon Web Services Regions in which to update associated stack
|
11928
12008
|
# instances. If you specify Regions, you must also specify accounts in
|
11929
|
-
# which to update
|
12009
|
+
# which to update StackSet instances.
|
11930
12010
|
#
|
11931
|
-
# To update *all* the stack instances associated with this
|
12011
|
+
# To update *all* the stack instances associated with this StackSet,
|
11932
12012
|
# do not specify the `Accounts` or `Regions` properties.
|
11933
12013
|
#
|
11934
|
-
# If the
|
11935
|
-
#
|
12014
|
+
# If the StackSet update includes changes to the template (that is, if
|
12015
|
+
# the `TemplateBody` or `TemplateURL` properties are specified), or
|
11936
12016
|
# the `Parameters` property, CloudFormation marks all stack instances
|
11937
12017
|
# with a status of `OUTDATED` prior to updating the stack instances in
|
11938
|
-
# the specified accounts and Regions. If the
|
12018
|
+
# the specified accounts and Regions. If the StackSet update does not
|
11939
12019
|
# include changes to the template or parameters, CloudFormation
|
11940
12020
|
# updates the stack instances in the specified accounts and Regions,
|
11941
12021
|
# while leaving all other stack instances with their existing stack
|
@@ -11947,7 +12027,7 @@ module Aws::CloudFormation
|
|
11947
12027
|
# an account administrator in the organization's management account
|
11948
12028
|
# or as a delegated administrator in a member account.
|
11949
12029
|
#
|
11950
|
-
# By default, `SELF` is specified. Use `SELF` for
|
12030
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
11951
12031
|
# self-managed permissions.
|
11952
12032
|
#
|
11953
12033
|
# * If you are signed in to the management account, specify `SELF`.
|
@@ -11966,7 +12046,7 @@ module Aws::CloudFormation
|
|
11966
12046
|
# @return [String]
|
11967
12047
|
#
|
11968
12048
|
# @!attribute [rw] managed_execution
|
11969
|
-
# Describes whether
|
12049
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
11970
12050
|
# concurrently and queues conflicting operations.
|
11971
12051
|
# @return [Types::ManagedExecution]
|
11972
12052
|
#
|
@@ -11997,7 +12077,7 @@ module Aws::CloudFormation
|
|
11997
12077
|
end
|
11998
12078
|
|
11999
12079
|
# @!attribute [rw] operation_id
|
12000
|
-
# The unique ID for this
|
12080
|
+
# The unique ID for this StackSet operation.
|
12001
12081
|
# @return [String]
|
12002
12082
|
#
|
12003
12083
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSetOutput AWS API Documentation
|