aws-sdk-cloudformation 1.53.0 → 1.54.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +534 -470
- data/lib/aws-sdk-cloudformation/client_api.rb +34 -0
- data/lib/aws-sdk-cloudformation/errors.rb +11 -0
- data/lib/aws-sdk-cloudformation/event.rb +2 -2
- data/lib/aws-sdk-cloudformation/resource.rb +41 -42
- data/lib/aws-sdk-cloudformation/stack.rb +102 -105
- data/lib/aws-sdk-cloudformation/stack_resource.rb +5 -5
- data/lib/aws-sdk-cloudformation/stack_resource_summary.rb +2 -2
- data/lib/aws-sdk-cloudformation/types.rb +722 -668
- metadata +4 -4
@@ -50,14 +50,14 @@ module Aws::CloudFormation
|
|
50
50
|
end
|
51
51
|
|
52
52
|
# The name or unique identifier that corresponds to a physical instance
|
53
|
-
# ID of a resource supported by
|
53
|
+
# ID of a resource supported by CloudFormation.
|
54
54
|
# @return [String]
|
55
55
|
def physical_resource_id
|
56
56
|
data[:physical_resource_id]
|
57
57
|
end
|
58
58
|
|
59
|
-
# Type of resource. ((For more information, go to [
|
60
|
-
# Reference][1] in the
|
59
|
+
# Type of resource. ((For more information, go to [Amazon Web Services
|
60
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
61
61
|
#
|
62
62
|
#
|
63
63
|
#
|
@@ -92,8 +92,8 @@ module Aws::CloudFormation
|
|
92
92
|
end
|
93
93
|
|
94
94
|
# The content of the `Metadata` attribute declared for the resource. For
|
95
|
-
# more information, see [Metadata Attribute][1] in the
|
96
|
-
#
|
95
|
+
# more information, see [Metadata Attribute][1] in the CloudFormation
|
96
|
+
# User Guide.
|
97
97
|
#
|
98
98
|
#
|
99
99
|
#
|
@@ -50,8 +50,8 @@ module Aws::CloudFormation
|
|
50
50
|
data[:physical_resource_id]
|
51
51
|
end
|
52
52
|
|
53
|
-
# Type of resource. (For more information, go to [
|
54
|
-
# Reference][1] in the
|
53
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
54
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
55
55
|
#
|
56
56
|
#
|
57
57
|
#
|
@@ -11,17 +11,17 @@ module Aws::CloudFormation
|
|
11
11
|
module Types
|
12
12
|
|
13
13
|
# Structure that contains the results of the account gate function which
|
14
|
-
#
|
15
|
-
#
|
16
|
-
#
|
17
|
-
# For each account and Region,
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
23
|
-
#
|
24
|
-
#
|
14
|
+
# CloudFormation invokes, if present, before proceeding with a stack set
|
15
|
+
# operation in an account and Region.
|
16
|
+
#
|
17
|
+
# For each account and Region, CloudFormation lets you specify a Lamdba
|
18
|
+
# function that encapsulates any requirements that must be met before
|
19
|
+
# CloudFormation can proceed with a stack set operation in that account
|
20
|
+
# and Region. CloudFormation invokes the function each time a stack set
|
21
|
+
# operation is requested for that account and Region; if the function
|
22
|
+
# returns `FAILED`, CloudFormation cancels the operation in that account
|
23
|
+
# and Region, and sets the stack set operation result status for that
|
24
|
+
# account and Region to `FAILED`.
|
25
25
|
#
|
26
26
|
# For more information, see [Configuring a target account gate][1].
|
27
27
|
#
|
@@ -34,7 +34,7 @@ module Aws::CloudFormation
|
|
34
34
|
#
|
35
35
|
# * `SUCCEEDED`\: The account gate function has determined that the
|
36
36
|
# account and Region passes any requirements for a stack set
|
37
|
-
# operation to occur.
|
37
|
+
# operation to occur. CloudFormation proceeds with the stack
|
38
38
|
# operation in that account and Region.
|
39
39
|
#
|
40
40
|
# * `FAILED`\: The account gate function has determined that the
|
@@ -43,21 +43,21 @@ module Aws::CloudFormation
|
|
43
43
|
# operation in that account and Region, and sets the stack set
|
44
44
|
# operation result status for that account and Region to `FAILED`.
|
45
45
|
#
|
46
|
-
# * `SKIPPED`\:
|
47
|
-
#
|
48
|
-
#
|
46
|
+
# * `SKIPPED`\: CloudFormation has skipped calling the account gate
|
47
|
+
# function for this account and Region, for one of the following
|
48
|
+
# reasons:
|
49
49
|
#
|
50
50
|
# * An account gate function has not been specified for the account
|
51
|
-
# and Region.
|
52
|
-
#
|
51
|
+
# and Region. CloudFormation proceeds with the stack set operation
|
52
|
+
# in this account and Region.
|
53
53
|
#
|
54
54
|
# * The `AWSCloudFormationStackSetExecutionRole` of the stack set
|
55
55
|
# adminstration account lacks permissions to invoke the function.
|
56
|
-
#
|
56
|
+
# CloudFormation proceeds with the stack set operation in this
|
57
57
|
# account and Region.
|
58
58
|
#
|
59
59
|
# * Either no action is necessary, or no action is possible, on the
|
60
|
-
# stack.
|
60
|
+
# stack. CloudFormation skips the stack set operation in this
|
61
61
|
# account and Region.
|
62
62
|
# @return [String]
|
63
63
|
#
|
@@ -86,8 +86,8 @@ module Aws::CloudFormation
|
|
86
86
|
# * Number of stack outputs
|
87
87
|
#
|
88
88
|
# For more information about these account limits, and other
|
89
|
-
# CloudFormation limits, see [
|
90
|
-
# CloudFormation User Guide*.
|
89
|
+
# CloudFormation limits, see [CloudFormation Limits][1] in the
|
90
|
+
# *CloudFormation User Guide*.
|
91
91
|
#
|
92
92
|
#
|
93
93
|
#
|
@@ -247,8 +247,8 @@ module Aws::CloudFormation
|
|
247
247
|
class AlreadyExistsException < Aws::EmptyStructure; end
|
248
248
|
|
249
249
|
# \[Service-managed permissions\] Describes whether StackSets
|
250
|
-
# automatically deploys to
|
251
|
-
#
|
250
|
+
# automatically deploys to Organizations accounts that are added to a
|
251
|
+
# target organization or organizational unit (OU).
|
252
252
|
#
|
253
253
|
# @note When making an API call, you may pass AutoDeployment
|
254
254
|
# data as a hash:
|
@@ -260,7 +260,7 @@ module Aws::CloudFormation
|
|
260
260
|
#
|
261
261
|
# @!attribute [rw] enabled
|
262
262
|
# If set to `true`, StackSets automatically deploys additional stack
|
263
|
-
# instances to
|
263
|
+
# instances to Organizations accounts that are added to a target
|
264
264
|
# organization or organizational unit (OU) in the specified Regions.
|
265
265
|
# If an account is removed from a target organization or OU, StackSets
|
266
266
|
# deletes stack instances from the account in the specified Regions.
|
@@ -388,10 +388,10 @@ module Aws::CloudFormation
|
|
388
388
|
#
|
389
389
|
# @!attribute [rw] client_request_token
|
390
390
|
# A unique identifier for this `CancelUpdateStack` request. Specify
|
391
|
-
# this token if you plan to retry requests so that
|
391
|
+
# this token if you plan to retry requests so that CloudFormation
|
392
392
|
# knows that you're not attempting to cancel an update on a stack
|
393
393
|
# with the same name. You might retry `CancelUpdateStack` requests to
|
394
|
-
# ensure that
|
394
|
+
# ensure that CloudFormation successfully received them.
|
395
395
|
# @return [String]
|
396
396
|
#
|
397
397
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStackInput AWS API Documentation
|
@@ -403,17 +403,17 @@ module Aws::CloudFormation
|
|
403
403
|
include Aws::Structure
|
404
404
|
end
|
405
405
|
|
406
|
-
# The `Change` structure describes the changes
|
406
|
+
# The `Change` structure describes the changes CloudFormation will
|
407
407
|
# perform if you execute the change set.
|
408
408
|
#
|
409
409
|
# @!attribute [rw] type
|
410
|
-
# The type of entity that
|
411
|
-
#
|
410
|
+
# The type of entity that CloudFormation changes. Currently, the only
|
411
|
+
# entity type is `Resource`.
|
412
412
|
# @return [String]
|
413
413
|
#
|
414
414
|
# @!attribute [rw] resource_change
|
415
415
|
# A `ResourceChange` structure that describes the resource and action
|
416
|
-
# that
|
416
|
+
# that CloudFormation will perform.
|
417
417
|
# @return [Types::ResourceChange]
|
418
418
|
#
|
419
419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Change AWS API Documentation
|
@@ -455,8 +455,8 @@ module Aws::CloudFormation
|
|
455
455
|
# If the change set execution status is `AVAILABLE`, you can execute
|
456
456
|
# the change set. If you can’t execute the change set, the status
|
457
457
|
# indicates why. For example, a change set might be in an
|
458
|
-
# `UNAVAILABLE` state because
|
459
|
-
#
|
458
|
+
# `UNAVAILABLE` state because CloudFormation is still creating it or
|
459
|
+
# in an `OBSOLETE` state because the stack was already updated.
|
460
460
|
# @return [String]
|
461
461
|
#
|
462
462
|
# @!attribute [rw] status
|
@@ -466,8 +466,8 @@ module Aws::CloudFormation
|
|
466
466
|
#
|
467
467
|
# @!attribute [rw] status_reason
|
468
468
|
# A description of the change set's status. For example, if your
|
469
|
-
# change set is in the `FAILED` state,
|
470
|
-
#
|
469
|
+
# change set is in the `FAILED` state, CloudFormation shows the error
|
470
|
+
# message.
|
471
471
|
# @return [String]
|
472
472
|
#
|
473
473
|
# @!attribute [rw] creation_time
|
@@ -535,41 +535,40 @@ module Aws::CloudFormation
|
|
535
535
|
# @return [String]
|
536
536
|
#
|
537
537
|
# @!attribute [rw] role_arn
|
538
|
-
# The Amazon Resource Name (ARN) of an
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
538
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
539
|
+
# (IAM) role that CloudFormation assumes to roll back the stack.
|
540
|
+
# CloudFormation uses the role's credentials to make calls on your
|
541
|
+
# behalf. CloudFormation always uses this role for all future
|
542
|
+
# operations on the stack. As long as users have permission to operate
|
543
|
+
# on the stack, CloudFormation uses this role even if the users don't
|
544
|
+
# have permission to pass it. Ensure that the role grants least
|
545
|
+
# privilege.
|
546
546
|
#
|
547
|
-
# If you don't specify a value,
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
547
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
548
|
+
# previously associated with the stack. If no role is available,
|
549
|
+
# CloudFormation uses a temporary session that is generated from your
|
550
|
+
# user credentials.
|
551
551
|
# @return [String]
|
552
552
|
#
|
553
553
|
# @!attribute [rw] resources_to_skip
|
554
|
-
# A list of the logical IDs of the resources that
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
554
|
+
# A list of the logical IDs of the resources that CloudFormation skips
|
555
|
+
# during the continue update rollback operation. You can specify only
|
556
|
+
# resources that are in the `UPDATE_FAILED` state because a rollback
|
557
|
+
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
558
|
+
# state for other reasons, for example, because an update was
|
559
|
+
# cancelled. To check why a resource update failed, use the
|
560
560
|
# DescribeStackResources action, and view the resource status reason.
|
561
561
|
#
|
562
|
-
# Specify this property to skip rolling back resources that
|
562
|
+
# Specify this property to skip rolling back resources that
|
563
563
|
# CloudFormation can't successfully roll back. We recommend that you
|
564
|
-
# [ troubleshoot][1] resources before skipping them.
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
# unrecoverable.
|
564
|
+
# [ troubleshoot][1] resources before skipping them. CloudFormation
|
565
|
+
# sets the status of the specified resources to `UPDATE_COMPLETE` and
|
566
|
+
# continues to roll back the stack. After the rollback is complete,
|
567
|
+
# the state of the skipped resources will be inconsistent with the
|
568
|
+
# state of the resources in the stack template. Before performing
|
569
|
+
# another stack update, you must update the stack or resources to be
|
570
|
+
# consistent with each other. If you don't, subsequent stack updates
|
571
|
+
# might fail, and the stack will become unrecoverable.
|
573
572
|
#
|
574
573
|
# Specify the minimum number of resources required to successfully
|
575
574
|
# roll back your stack. For example, a failed resource update might
|
@@ -598,10 +597,10 @@ module Aws::CloudFormation
|
|
598
597
|
#
|
599
598
|
# @!attribute [rw] client_request_token
|
600
599
|
# A unique identifier for this `ContinueUpdateRollback` request.
|
601
|
-
# Specify this token if you plan to retry requests so that
|
602
|
-
#
|
600
|
+
# Specify this token if you plan to retry requests so that
|
601
|
+
# CloudFormationknows that you're not attempting to continue the
|
603
602
|
# rollback to a stack with the same name. You might retry
|
604
|
-
# `ContinueUpdateRollback` requests to ensure that
|
603
|
+
# `ContinueUpdateRollback` requests to ensure that CloudFormation
|
605
604
|
# successfully received them.
|
606
605
|
# @return [String]
|
607
606
|
#
|
@@ -677,14 +676,14 @@ module Aws::CloudFormation
|
|
677
676
|
#
|
678
677
|
# @!attribute [rw] stack_name
|
679
678
|
# The name or the unique ID of the stack for which you are creating a
|
680
|
-
# change set.
|
679
|
+
# change set. CloudFormation generates the change set by comparing
|
681
680
|
# this stack's information with the information that you submit, such
|
682
681
|
# as a modified template or different parameter input values.
|
683
682
|
# @return [String]
|
684
683
|
#
|
685
684
|
# @!attribute [rw] template_body
|
686
685
|
# A structure that contains the body of the revised template, with a
|
687
|
-
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
686
|
+
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
688
687
|
# CloudFormation generates the change set by comparing this template
|
689
688
|
# with the template of the stack that you specified.
|
690
689
|
#
|
@@ -694,7 +693,7 @@ module Aws::CloudFormation
|
|
694
693
|
# @!attribute [rw] template_url
|
695
694
|
# The location of the file that contains the revised template. The URL
|
696
695
|
# must point to a template (max size: 460,800 bytes) that is located
|
697
|
-
# in an S3 bucket or a Systems Manager document.
|
696
|
+
# in an S3 bucket or a Systems Manager document. CloudFormation
|
698
697
|
# generates the change set by comparing this template with the stack
|
699
698
|
# that you specified.
|
700
699
|
#
|
@@ -713,15 +712,15 @@ module Aws::CloudFormation
|
|
713
712
|
#
|
714
713
|
# @!attribute [rw] capabilities
|
715
714
|
# In some cases, you must explicitly acknowledge that your stack
|
716
|
-
# template contains certain capabilities in order for
|
717
|
-
#
|
715
|
+
# template contains certain capabilities in order for CloudFormation
|
716
|
+
# to create the stack.
|
718
717
|
#
|
719
718
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
720
719
|
#
|
721
720
|
# Some stack templates might include resources that can affect
|
722
|
-
# permissions in your
|
723
|
-
#
|
724
|
-
#
|
721
|
+
# permissions in your account; for example, by creating new Identity
|
722
|
+
# and Access Management (IAM) users. For those stacks, you must
|
723
|
+
# explicitly acknowledge this by specifying one of these
|
725
724
|
# capabilities.
|
726
725
|
#
|
727
726
|
# The following IAM resources require you to specify either the
|
@@ -732,7 +731,7 @@ module Aws::CloudFormation
|
|
732
731
|
# * If you have IAM resources with custom names, you *must* specify
|
733
732
|
# `CAPABILITY_NAMED_IAM`.
|
734
733
|
#
|
735
|
-
# * If you don't specify either of these capabilities,
|
734
|
+
# * If you don't specify either of these capabilities,
|
736
735
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
737
736
|
#
|
738
737
|
# If your stack template contains these resources, we recommend that
|
@@ -753,7 +752,7 @@ module Aws::CloudFormation
|
|
753
752
|
#
|
754
753
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
755
754
|
#
|
756
|
-
# For more information, see [Acknowledging IAM Resources in
|
755
|
+
# For more information, see [Acknowledging IAM Resources in
|
757
756
|
# CloudFormation Templates][8].
|
758
757
|
#
|
759
758
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -769,7 +768,7 @@ module Aws::CloudFormation
|
|
769
768
|
# reviewing the resulting changes in a change set, you must
|
770
769
|
# acknowledge this capability. This includes the [AWS::Include][9]
|
771
770
|
# and [AWS::Serverless][10] transforms, which are macros hosted by
|
772
|
-
#
|
771
|
+
# CloudFormation.
|
773
772
|
#
|
774
773
|
# <note markdown="1"> This capacity does not apply to creating change sets, and
|
775
774
|
# specifying it when creating change sets has no effect.
|
@@ -781,8 +780,8 @@ module Aws::CloudFormation
|
|
781
780
|
#
|
782
781
|
# </note>
|
783
782
|
#
|
784
|
-
# For more information on macros, see [Using
|
785
|
-
#
|
783
|
+
# For more information on macros, see [Using CloudFormation Macros
|
784
|
+
# to Perform Custom Processing on Templates][11].
|
786
785
|
#
|
787
786
|
#
|
788
787
|
#
|
@@ -805,12 +804,12 @@ module Aws::CloudFormation
|
|
805
804
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
806
805
|
#
|
807
806
|
# If the list of resource types doesn't include a resource type that
|
808
|
-
# you're updating, the stack update fails. By default,
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
807
|
+
# you're updating, the stack update fails. By default, CloudFormation
|
808
|
+
# grants permissions to all resource types. Identity and Access
|
809
|
+
# Management (IAM) uses this parameter for condition keys in IAM
|
810
|
+
# policies for CloudFormation. For more information, see [Controlling
|
811
|
+
# Access with Identity and Access Management][1] in the CloudFormation
|
812
|
+
# User Guide.
|
814
813
|
#
|
815
814
|
#
|
816
815
|
#
|
@@ -818,38 +817,37 @@ module Aws::CloudFormation
|
|
818
817
|
# @return [Array<String>]
|
819
818
|
#
|
820
819
|
# @!attribute [rw] role_arn
|
821
|
-
# The Amazon Resource Name (ARN) of an
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
828
|
-
# least privilege.
|
820
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
821
|
+
# (IAM) role that CloudFormation assumes when executing the change
|
822
|
+
# set. CloudFormation uses the role's credentials to make calls on
|
823
|
+
# your behalf. CloudFormation uses this role for all future operations
|
824
|
+
# on the stack. As long as users have permission to operate on the
|
825
|
+
# stack, CloudFormation uses this role even if the users don't have
|
826
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
829
827
|
#
|
830
|
-
# If you don't specify a value,
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
828
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
829
|
+
# previously associated with the stack. If no role is available,
|
830
|
+
# CloudFormation uses a temporary session that is generated from your
|
831
|
+
# user credentials.
|
834
832
|
# @return [String]
|
835
833
|
#
|
836
834
|
# @!attribute [rw] rollback_configuration
|
837
|
-
# The rollback triggers for
|
835
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
838
836
|
# creation and updating operations, and for the specified monitoring
|
839
837
|
# period afterwards.
|
840
838
|
# @return [Types::RollbackConfiguration]
|
841
839
|
#
|
842
840
|
# @!attribute [rw] notification_arns
|
843
841
|
# The Amazon Resource Names (ARNs) of Amazon Simple Notification
|
844
|
-
# Service (Amazon SNS) topics that
|
845
|
-
#
|
842
|
+
# Service (Amazon SNS) topics that CloudFormation associates with the
|
843
|
+
# stack. To remove all associated notification topics, specify an
|
846
844
|
# empty list.
|
847
845
|
# @return [Array<String>]
|
848
846
|
#
|
849
847
|
# @!attribute [rw] tags
|
850
|
-
# Key-value pairs to associate with this stack.
|
851
|
-
#
|
852
|
-
#
|
848
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
849
|
+
# propagates these tags to resources in the stack. You can specify a
|
850
|
+
# maximum of 50 tags.
|
853
851
|
# @return [Array<Types::Tag>]
|
854
852
|
#
|
855
853
|
# @!attribute [rw] change_set_name
|
@@ -863,10 +861,10 @@ module Aws::CloudFormation
|
|
863
861
|
#
|
864
862
|
# @!attribute [rw] client_token
|
865
863
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
866
|
-
# token if you plan to retry requests so that
|
864
|
+
# token if you plan to retry requests so that CloudFormation knows
|
867
865
|
# that you're not attempting to create another change set with the
|
868
866
|
# same name. You might retry `CreateChangeSet` requests to ensure that
|
869
|
-
#
|
867
|
+
# CloudFormation successfully received them.
|
870
868
|
# @return [String]
|
871
869
|
#
|
872
870
|
# @!attribute [rw] description
|
@@ -879,14 +877,14 @@ module Aws::CloudFormation
|
|
879
877
|
# stack, specify `UPDATE`. To create a change set for an import
|
880
878
|
# operation, specify `IMPORT`.
|
881
879
|
#
|
882
|
-
# If you create a change set for a new stack,
|
883
|
-
#
|
884
|
-
#
|
885
|
-
#
|
880
|
+
# If you create a change set for a new stack, CloudFormation creates a
|
881
|
+
# stack with a unique stack ID, but no template or resources. The
|
882
|
+
# stack will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you
|
883
|
+
# execute the change set.
|
886
884
|
#
|
887
|
-
# By default,
|
888
|
-
#
|
889
|
-
#
|
885
|
+
# By default, CloudFormation specifies `UPDATE`. You can't use the
|
886
|
+
# `UPDATE` type to create a change set for a new stack or the `CREATE`
|
887
|
+
# type to create a change set for an existing stack.
|
890
888
|
#
|
891
889
|
#
|
892
890
|
#
|
@@ -1005,7 +1003,7 @@ module Aws::CloudFormation
|
|
1005
1003
|
# @!attribute [rw] template_body
|
1006
1004
|
# Structure containing the template body with a minimum length of 1
|
1007
1005
|
# byte and a maximum length of 51,200 bytes. For more information, go
|
1008
|
-
# to [Template Anatomy][1] in the
|
1006
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.
|
1009
1007
|
#
|
1010
1008
|
# Conditional: You must specify either the `TemplateBody` or the
|
1011
1009
|
# `TemplateURL` parameter, but not both.
|
@@ -1019,7 +1017,7 @@ module Aws::CloudFormation
|
|
1019
1017
|
# Location of file containing the template body. The URL must point to
|
1020
1018
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
1021
1019
|
# bucket or a Systems Manager document. For more information, go to
|
1022
|
-
# the [Template Anatomy][1] in the
|
1020
|
+
# the [Template Anatomy][1] in the CloudFormation User Guide.
|
1023
1021
|
#
|
1024
1022
|
# Conditional: You must specify either the `TemplateBody` or the
|
1025
1023
|
# `TemplateURL` parameter, but not both.
|
@@ -1047,7 +1045,7 @@ module Aws::CloudFormation
|
|
1047
1045
|
# @return [Boolean]
|
1048
1046
|
#
|
1049
1047
|
# @!attribute [rw] rollback_configuration
|
1050
|
-
# The rollback triggers for
|
1048
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
1051
1049
|
# creation and updating operations, and for the specified monitoring
|
1052
1050
|
# period afterwards.
|
1053
1051
|
# @return [Types::RollbackConfiguration]
|
@@ -1066,15 +1064,15 @@ module Aws::CloudFormation
|
|
1066
1064
|
#
|
1067
1065
|
# @!attribute [rw] capabilities
|
1068
1066
|
# In some cases, you must explicitly acknowledge that your stack
|
1069
|
-
# template contains certain capabilities in order for
|
1070
|
-
#
|
1067
|
+
# template contains certain capabilities in order for CloudFormation
|
1068
|
+
# to create the stack.
|
1071
1069
|
#
|
1072
1070
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
1073
1071
|
#
|
1074
1072
|
# Some stack templates might include resources that can affect
|
1075
|
-
# permissions in your
|
1076
|
-
#
|
1077
|
-
#
|
1073
|
+
# permissions in your account; for example, by creating new Identity
|
1074
|
+
# and Access Management (IAM) users. For those stacks, you must
|
1075
|
+
# explicitly acknowledge this by specifying one of these
|
1078
1076
|
# capabilities.
|
1079
1077
|
#
|
1080
1078
|
# The following IAM resources require you to specify either the
|
@@ -1085,7 +1083,7 @@ module Aws::CloudFormation
|
|
1085
1083
|
# * If you have IAM resources with custom names, you *must* specify
|
1086
1084
|
# `CAPABILITY_NAMED_IAM`.
|
1087
1085
|
#
|
1088
|
-
# * If you don't specify either of these capabilities,
|
1086
|
+
# * If you don't specify either of these capabilities,
|
1089
1087
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
1090
1088
|
#
|
1091
1089
|
# If your stack template contains these resources, we recommend that
|
@@ -1106,7 +1104,7 @@ module Aws::CloudFormation
|
|
1106
1104
|
#
|
1107
1105
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
1108
1106
|
#
|
1109
|
-
# For more information, see [Acknowledging IAM Resources in
|
1107
|
+
# For more information, see [Acknowledging IAM Resources in
|
1110
1108
|
# CloudFormation Templates][8].
|
1111
1109
|
#
|
1112
1110
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -1122,7 +1120,7 @@ module Aws::CloudFormation
|
|
1122
1120
|
# reviewing the resulting changes in a change set, you must
|
1123
1121
|
# acknowledge this capability. This includes the [AWS::Include][9]
|
1124
1122
|
# and [AWS::Serverless][10] transforms, which are macros hosted by
|
1125
|
-
#
|
1123
|
+
# CloudFormation.
|
1126
1124
|
#
|
1127
1125
|
# If you want to create a stack from a stack template that contains
|
1128
1126
|
# macros *and* nested stacks, you must create the stack directly
|
@@ -1133,11 +1131,11 @@ module Aws::CloudFormation
|
|
1133
1131
|
#
|
1134
1132
|
# Each macro relies on an underlying Lambda service function for
|
1135
1133
|
# processing stack templates. Be aware that the Lambda function
|
1136
|
-
# owner can update the function operation without
|
1134
|
+
# owner can update the function operation without CloudFormation
|
1137
1135
|
# being notified.
|
1138
1136
|
#
|
1139
|
-
# For more information, see [Using
|
1140
|
-
#
|
1137
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
1138
|
+
# Custom Processing on Templates][11].
|
1141
1139
|
#
|
1142
1140
|
#
|
1143
1141
|
#
|
@@ -1158,19 +1156,19 @@ module Aws::CloudFormation
|
|
1158
1156
|
# The template resource types that you have permissions to work with
|
1159
1157
|
# for this create stack action, such as `AWS::EC2::Instance`,
|
1160
1158
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`. Use the following
|
1161
|
-
# syntax to describe template resource types: `AWS::*` (for all
|
1162
|
-
#
|
1159
|
+
# syntax to describe template resource types: `AWS::*` (for all Amazon
|
1160
|
+
# Web Services resources), `Custom::*` (for all custom resources),
|
1163
1161
|
# `Custom::logical_ID ` (for a specific custom resource),
|
1164
|
-
# `AWS::service_name::*` (for all resources of a particular
|
1165
|
-
# service), and `AWS::service_name::resource_logical_ID `
|
1166
|
-
# specific
|
1162
|
+
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
1163
|
+
# Services service), and `AWS::service_name::resource_logical_ID `
|
1164
|
+
# (for a specific Amazon Web Services resource).
|
1167
1165
|
#
|
1168
1166
|
# If the list of resource types doesn't include a resource that
|
1169
|
-
# you're creating, the stack creation fails. By default,
|
1170
|
-
# CloudFormation grants permissions to all resource types.
|
1171
|
-
#
|
1167
|
+
# you're creating, the stack creation fails. By default,
|
1168
|
+
# CloudFormation grants permissions to all resource types. Identity
|
1169
|
+
# and Access Management (IAM) uses this parameter for
|
1172
1170
|
# CloudFormation-specific condition keys in IAM policies. For more
|
1173
|
-
# information, see [Controlling Access with
|
1171
|
+
# information, see [Controlling Access with Identity and Access
|
1174
1172
|
# Management][1].
|
1175
1173
|
#
|
1176
1174
|
#
|
@@ -1179,19 +1177,19 @@ module Aws::CloudFormation
|
|
1179
1177
|
# @return [Array<String>]
|
1180
1178
|
#
|
1181
1179
|
# @!attribute [rw] role_arn
|
1182
|
-
# The Amazon Resource Name (ARN) of an
|
1183
|
-
#
|
1184
|
-
#
|
1185
|
-
#
|
1186
|
-
#
|
1187
|
-
#
|
1188
|
-
#
|
1189
|
-
#
|
1180
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
1181
|
+
# (IAM) role that CloudFormation assumes to create the stack.
|
1182
|
+
# CloudFormation uses the role's credentials to make calls on your
|
1183
|
+
# behalf. CloudFormation always uses this role for all future
|
1184
|
+
# operations on the stack. As long as users have permission to operate
|
1185
|
+
# on the stack, CloudFormation uses this role even if the users don't
|
1186
|
+
# have permission to pass it. Ensure that the role grants least
|
1187
|
+
# privilege.
|
1190
1188
|
#
|
1191
|
-
# If you don't specify a value,
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
#
|
1189
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
1190
|
+
# previously associated with the stack. If no role is available,
|
1191
|
+
# CloudFormation uses a temporary session that is generated from your
|
1192
|
+
# user credentials.
|
1195
1193
|
# @return [String]
|
1196
1194
|
#
|
1197
1195
|
# @!attribute [rw] on_failure
|
@@ -1204,9 +1202,9 @@ module Aws::CloudFormation
|
|
1204
1202
|
#
|
1205
1203
|
# @!attribute [rw] stack_policy_body
|
1206
1204
|
# Structure containing the stack policy body. For more information, go
|
1207
|
-
# to [ Prevent Updates to Stack Resources][1] in the *
|
1208
|
-
#
|
1209
|
-
# `
|
1205
|
+
# to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
|
1206
|
+
# User Guide*. You can specify either the `StackPolicyBody` or the
|
1207
|
+
# `StackPolicyURL` parameter, but not both.
|
1210
1208
|
#
|
1211
1209
|
#
|
1212
1210
|
#
|
@@ -1221,17 +1219,17 @@ module Aws::CloudFormation
|
|
1221
1219
|
# @return [String]
|
1222
1220
|
#
|
1223
1221
|
# @!attribute [rw] tags
|
1224
|
-
# Key-value pairs to associate with this stack.
|
1225
|
-
#
|
1222
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
1223
|
+
# propagates these tags to the resources created in the stack. A
|
1226
1224
|
# maximum number of 50 tags can be specified.
|
1227
1225
|
# @return [Array<Types::Tag>]
|
1228
1226
|
#
|
1229
1227
|
# @!attribute [rw] client_request_token
|
1230
1228
|
# A unique identifier for this `CreateStack` request. Specify this
|
1231
|
-
# token if you plan to retry requests so that
|
1229
|
+
# token if you plan to retry requests so that CloudFormation knows
|
1232
1230
|
# that you're not attempting to create a stack with the same name.
|
1233
|
-
# You might retry `CreateStack` requests to ensure that
|
1234
|
-
#
|
1231
|
+
# You might retry `CreateStack` requests to ensure that CloudFormation
|
1232
|
+
# successfully received them.
|
1235
1233
|
#
|
1236
1234
|
# All events triggered by a given stack operation are assigned the
|
1237
1235
|
# same client request token, which you can use to track operations.
|
@@ -1253,8 +1251,8 @@ module Aws::CloudFormation
|
|
1253
1251
|
# a user attempts to delete a stack with termination protection
|
1254
1252
|
# enabled, the operation fails and the stack remains unchanged. For
|
1255
1253
|
# more information, see [Protecting a Stack From Being Deleted][1] in
|
1256
|
-
# the *
|
1257
|
-
#
|
1254
|
+
# the *CloudFormation User Guide*. Termination protection is disabled
|
1255
|
+
# on stacks by default.
|
1258
1256
|
#
|
1259
1257
|
# For [nested stacks][2], termination protection is set on the root
|
1260
1258
|
# stack and cannot be changed directly on the nested stack.
|
@@ -1327,23 +1325,22 @@ module Aws::CloudFormation
|
|
1327
1325
|
# @return [String]
|
1328
1326
|
#
|
1329
1327
|
# @!attribute [rw] accounts
|
1330
|
-
# \[Self-managed permissions\] The names of one or more
|
1331
|
-
#
|
1332
|
-
# for.
|
1328
|
+
# \[Self-managed permissions\] The names of one or more accounts that
|
1329
|
+
# you want to create stack instances in the specified Region(s) for.
|
1333
1330
|
#
|
1334
1331
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1335
1332
|
# @return [Array<String>]
|
1336
1333
|
#
|
1337
1334
|
# @!attribute [rw] deployment_targets
|
1338
|
-
# \[Service-managed permissions\] The
|
1339
|
-
#
|
1335
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
1336
|
+
# to create stack instances in the specified Regions.
|
1340
1337
|
#
|
1341
1338
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1342
1339
|
# @return [Types::DeploymentTargets]
|
1343
1340
|
#
|
1344
1341
|
# @!attribute [rw] regions
|
1345
1342
|
# The names of one or more Regions where you want to create stack
|
1346
|
-
# instances using the specified
|
1343
|
+
# instances using the specified accounts.
|
1347
1344
|
# @return [Array<String>]
|
1348
1345
|
#
|
1349
1346
|
# @!attribute [rw] parameter_overrides
|
@@ -1352,24 +1349,19 @@ module Aws::CloudFormation
|
|
1352
1349
|
#
|
1353
1350
|
# Any overridden parameter values will be applied to all stack
|
1354
1351
|
# instances in the specified accounts and Regions. When specifying
|
1355
|
-
# parameters and their values, be aware of how
|
1352
|
+
# parameters and their values, be aware of how CloudFormation sets
|
1356
1353
|
# parameter values during stack instance operations:
|
1357
1354
|
#
|
1358
1355
|
# * To override the current value for a parameter, include the
|
1359
1356
|
# parameter and specify its value.
|
1360
1357
|
#
|
1361
|
-
# * To leave
|
1362
|
-
# the
|
1363
|
-
#
|
1364
|
-
# * Do not include the parameter in the list.
|
1365
|
-
#
|
1366
|
-
# * Include the parameter and specify `UsePreviousValue` as `true`.
|
1367
|
-
# (You cannot specify both a value and set `UsePreviousValue` to
|
1368
|
-
# `true`.)
|
1358
|
+
# * To leave an overridden parameter set to its present value, include
|
1359
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You
|
1360
|
+
# cannot specify both a value and set `UsePreviousValue` to `true`.)
|
1369
1361
|
#
|
1370
|
-
# * To set
|
1371
|
-
#
|
1372
|
-
#
|
1362
|
+
# * To set an overridden parameter back to the value specified in the
|
1363
|
+
# stack set, specify a parameter list but do not include the
|
1364
|
+
# parameter in the list.
|
1373
1365
|
#
|
1374
1366
|
# * To leave all parameters set to their present values, do not
|
1375
1367
|
# specify this property at all.
|
@@ -1387,7 +1379,7 @@ module Aws::CloudFormation
|
|
1387
1379
|
# @return [Array<Types::Parameter>]
|
1388
1380
|
#
|
1389
1381
|
# @!attribute [rw] operation_preferences
|
1390
|
-
# Preferences for how
|
1382
|
+
# Preferences for how CloudFormation performs this stack set
|
1391
1383
|
# operation.
|
1392
1384
|
# @return [Types::StackSetOperationPreferences]
|
1393
1385
|
#
|
@@ -1395,10 +1387,10 @@ module Aws::CloudFormation
|
|
1395
1387
|
# The unique identifier for this stack set operation.
|
1396
1388
|
#
|
1397
1389
|
# The operation ID also functions as an idempotency token, to ensure
|
1398
|
-
# that
|
1399
|
-
#
|
1400
|
-
#
|
1401
|
-
#
|
1390
|
+
# that CloudFormation performs the stack set operation only once, even
|
1391
|
+
# if you retry the request multiple times. You might retry stack set
|
1392
|
+
# operation requests to ensure that CloudFormation successfully
|
1393
|
+
# received them.
|
1402
1394
|
#
|
1403
1395
|
# If you don't specify an operation ID, the SDK generates one
|
1404
1396
|
# automatically.
|
@@ -1423,10 +1415,9 @@ module Aws::CloudFormation
|
|
1423
1415
|
# * If you are signed in to a delegated administrator account, specify
|
1424
1416
|
# `DELEGATED_ADMIN`.
|
1425
1417
|
#
|
1426
|
-
# Your
|
1427
|
-
#
|
1428
|
-
# delegated administrator][1] in the *
|
1429
|
-
# Guide*.
|
1418
|
+
# Your account must be registered as a delegated administrator in
|
1419
|
+
# the management account. For more information, see [Register a
|
1420
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
1430
1421
|
#
|
1431
1422
|
#
|
1432
1423
|
#
|
@@ -1482,6 +1473,7 @@ module Aws::CloudFormation
|
|
1482
1473
|
# description: "Description",
|
1483
1474
|
# template_body: "TemplateBody",
|
1484
1475
|
# template_url: "TemplateURL",
|
1476
|
+
# stack_id: "StackId",
|
1485
1477
|
# parameters: [
|
1486
1478
|
# {
|
1487
1479
|
# parameter_key: "ParameterKey",
|
@@ -1527,8 +1519,8 @@ module Aws::CloudFormation
|
|
1527
1519
|
# @!attribute [rw] template_body
|
1528
1520
|
# The structure that contains the template body, with a minimum length
|
1529
1521
|
# of 1 byte and a maximum length of 51,200 bytes. For more
|
1530
|
-
# information, see [Template Anatomy][1] in the
|
1531
|
-
#
|
1522
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
1523
|
+
# Guide.
|
1532
1524
|
#
|
1533
1525
|
# Conditional: You must specify either the TemplateBody or the
|
1534
1526
|
# TemplateURL parameter, but not both.
|
@@ -1542,8 +1534,8 @@ module Aws::CloudFormation
|
|
1542
1534
|
# The location of the file that contains the template body. The URL
|
1543
1535
|
# must point to a template (maximum size: 460,800 bytes) that's
|
1544
1536
|
# located in an Amazon S3 bucket or a Systems Manager document. For
|
1545
|
-
# more information, see [Template Anatomy][1] in the
|
1546
|
-
#
|
1537
|
+
# more information, see [Template Anatomy][1] in the CloudFormation
|
1538
|
+
# User Guide.
|
1547
1539
|
#
|
1548
1540
|
# Conditional: You must specify either the TemplateBody or the
|
1549
1541
|
# TemplateURL parameter, but not both.
|
@@ -1553,21 +1545,26 @@ module Aws::CloudFormation
|
|
1553
1545
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
1554
1546
|
# @return [String]
|
1555
1547
|
#
|
1548
|
+
# @!attribute [rw] stack_id
|
1549
|
+
# The stack ID you are importing into a new stack set. Specify the
|
1550
|
+
# Amazon Resource Number (ARN) of the stack.
|
1551
|
+
# @return [String]
|
1552
|
+
#
|
1556
1553
|
# @!attribute [rw] parameters
|
1557
1554
|
# The input parameters for the stack set template.
|
1558
1555
|
# @return [Array<Types::Parameter>]
|
1559
1556
|
#
|
1560
1557
|
# @!attribute [rw] capabilities
|
1561
1558
|
# In some cases, you must explicitly acknowledge that your stack set
|
1562
|
-
# template contains certain capabilities in order for
|
1563
|
-
#
|
1559
|
+
# template contains certain capabilities in order for CloudFormation
|
1560
|
+
# to create the stack set and related stack instances.
|
1564
1561
|
#
|
1565
1562
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
1566
1563
|
#
|
1567
1564
|
# Some stack templates might include resources that can affect
|
1568
|
-
# permissions in your
|
1569
|
-
#
|
1570
|
-
#
|
1565
|
+
# permissions in your account; for example, by creating new Identity
|
1566
|
+
# and Access Management (IAM) users. For those stack sets, you must
|
1567
|
+
# explicitly acknowledge this by specifying one of these
|
1571
1568
|
# capabilities.
|
1572
1569
|
#
|
1573
1570
|
# The following IAM resources require you to specify either the
|
@@ -1578,7 +1575,7 @@ module Aws::CloudFormation
|
|
1578
1575
|
# * If you have IAM resources with custom names, you *must* specify
|
1579
1576
|
# `CAPABILITY_NAMED_IAM`.
|
1580
1577
|
#
|
1581
|
-
# * If you don't specify either of these capabilities,
|
1578
|
+
# * If you don't specify either of these capabilities,
|
1582
1579
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
1583
1580
|
#
|
1584
1581
|
# If your stack template contains these resources, we recommend that
|
@@ -1599,7 +1596,7 @@ module Aws::CloudFormation
|
|
1599
1596
|
#
|
1600
1597
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
1601
1598
|
#
|
1602
|
-
# For more information, see [Acknowledging IAM Resources in
|
1599
|
+
# For more information, see [Acknowledging IAM Resources in
|
1603
1600
|
# CloudFormation Templates][8].
|
1604
1601
|
#
|
1605
1602
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -1609,13 +1606,13 @@ module Aws::CloudFormation
|
|
1609
1606
|
# directly from the processed template, without first reviewing the
|
1610
1607
|
# resulting changes in a change set. To create the stack set
|
1611
1608
|
# directly, you must acknowledge this capability. For more
|
1612
|
-
# information, see [Using
|
1613
|
-
#
|
1609
|
+
# information, see [Using CloudFormation Macros to Perform Custom
|
1610
|
+
# Processing on Templates][9].
|
1614
1611
|
#
|
1615
1612
|
# Stack sets with service-managed permissions do not currently
|
1616
1613
|
# support the use of macros in templates. (This includes the
|
1617
1614
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1618
|
-
# macros hosted by
|
1615
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
1619
1616
|
# capability for a stack set with service-managed permissions, if
|
1620
1617
|
# you reference a macro in your template the stack set operation
|
1621
1618
|
# will fail.
|
@@ -1637,11 +1634,11 @@ module Aws::CloudFormation
|
|
1637
1634
|
#
|
1638
1635
|
# @!attribute [rw] tags
|
1639
1636
|
# The key-value pairs to associate with this stack set and the stacks
|
1640
|
-
# created from it.
|
1637
|
+
# created from it. CloudFormation also propagates these tags to
|
1641
1638
|
# supported resources that are created in the stacks. A maximum number
|
1642
1639
|
# of 50 tags can be specified.
|
1643
1640
|
#
|
1644
|
-
# If you specify tags as part of a `CreateStackSet` action,
|
1641
|
+
# If you specify tags as part of a `CreateStackSet` action,
|
1645
1642
|
# CloudFormation checks to see if you have the required IAM permission
|
1646
1643
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
1647
1644
|
# fails with an `access denied` error, and the stack set is not
|
@@ -1656,7 +1653,7 @@ module Aws::CloudFormation
|
|
1656
1653
|
# roles to control which users or groups can manage specific stack
|
1657
1654
|
# sets within the same administrator account. For more information,
|
1658
1655
|
# see [Prerequisites: Granting Permissions for Stack Set
|
1659
|
-
# Operations][1] in the *
|
1656
|
+
# Operations][1] in the *CloudFormation User Guide*.
|
1660
1657
|
#
|
1661
1658
|
#
|
1662
1659
|
#
|
@@ -1665,7 +1662,7 @@ module Aws::CloudFormation
|
|
1665
1662
|
#
|
1666
1663
|
# @!attribute [rw] execution_role_name
|
1667
1664
|
# The name of the IAM execution role to use to create the stack set.
|
1668
|
-
# If you do not specify an execution role,
|
1665
|
+
# If you do not specify an execution role, CloudFormation uses the
|
1669
1666
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
1670
1667
|
# operation.
|
1671
1668
|
#
|
@@ -1685,8 +1682,8 @@ module Aws::CloudFormation
|
|
1685
1682
|
#
|
1686
1683
|
# * With `service-managed` permissions, StackSets automatically
|
1687
1684
|
# creates the IAM roles required to deploy to accounts managed by
|
1688
|
-
#
|
1689
|
-
#
|
1685
|
+
# Organizations. For more information, see [Grant Service-Managed
|
1686
|
+
# Stack Set Permissions][2].
|
1690
1687
|
#
|
1691
1688
|
#
|
1692
1689
|
#
|
@@ -1695,10 +1692,9 @@ module Aws::CloudFormation
|
|
1695
1692
|
# @return [String]
|
1696
1693
|
#
|
1697
1694
|
# @!attribute [rw] auto_deployment
|
1698
|
-
# Describes whether StackSets automatically deploys to
|
1699
|
-
#
|
1700
|
-
#
|
1701
|
-
# `SERVICE_MANAGED`.
|
1695
|
+
# Describes whether StackSets automatically deploys to Organizations
|
1696
|
+
# accounts that are added to the target organization or organizational
|
1697
|
+
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
|
1702
1698
|
# @return [Types::AutoDeployment]
|
1703
1699
|
#
|
1704
1700
|
# @!attribute [rw] call_as
|
@@ -1716,10 +1712,9 @@ module Aws::CloudFormation
|
|
1716
1712
|
# signed in to a delegated administrator account, specify
|
1717
1713
|
# `DELEGATED_ADMIN`.
|
1718
1714
|
#
|
1719
|
-
# Your
|
1715
|
+
# Your account must be registered as a delegated admin in the
|
1720
1716
|
# management account. For more information, see [Register a
|
1721
|
-
# delegated administrator][1] in the *
|
1722
|
-
# Guide*.
|
1717
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
1723
1718
|
#
|
1724
1719
|
# Stack sets with service-managed permissions are created in the
|
1725
1720
|
# management account, including stack sets that are created by
|
@@ -1732,10 +1727,10 @@ module Aws::CloudFormation
|
|
1732
1727
|
#
|
1733
1728
|
# @!attribute [rw] client_request_token
|
1734
1729
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
1735
|
-
# token if you plan to retry requests so that
|
1730
|
+
# token if you plan to retry requests so that CloudFormation knows
|
1736
1731
|
# that you're not attempting to create another stack set with the
|
1737
1732
|
# same name. You might retry `CreateStackSet` requests to ensure that
|
1738
|
-
#
|
1733
|
+
# CloudFormation successfully received them.
|
1739
1734
|
#
|
1740
1735
|
# If you don't specify an operation ID, the SDK generates one
|
1741
1736
|
# automatically.
|
@@ -1751,6 +1746,7 @@ module Aws::CloudFormation
|
|
1751
1746
|
:description,
|
1752
1747
|
:template_body,
|
1753
1748
|
:template_url,
|
1749
|
+
:stack_id,
|
1754
1750
|
:parameters,
|
1755
1751
|
:capabilities,
|
1756
1752
|
:tags,
|
@@ -1883,7 +1879,7 @@ module Aws::CloudFormation
|
|
1883
1879
|
# @!attribute [rw] retain_resources
|
1884
1880
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1885
1881
|
# IDs that are associated with the resources you want to retain.
|
1886
|
-
# During deletion,
|
1882
|
+
# During deletion, CloudFormation deletes the stack but does not
|
1887
1883
|
# delete the retained resources.
|
1888
1884
|
#
|
1889
1885
|
# Retaining resources is useful when you cannot delete a resource,
|
@@ -1891,23 +1887,23 @@ module Aws::CloudFormation
|
|
1891
1887
|
# @return [Array<String>]
|
1892
1888
|
#
|
1893
1889
|
# @!attribute [rw] role_arn
|
1894
|
-
# The Amazon Resource Name (ARN) of an
|
1895
|
-
#
|
1896
|
-
#
|
1897
|
-
#
|
1890
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
1891
|
+
# (IAM) role that CloudFormation assumes to delete the stack.
|
1892
|
+
# CloudFormation uses the role's credentials to make calls on your
|
1893
|
+
# behalf.
|
1898
1894
|
#
|
1899
|
-
# If you don't specify a value,
|
1900
|
-
#
|
1901
|
-
#
|
1902
|
-
#
|
1895
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
1896
|
+
# previously associated with the stack. If no role is available,
|
1897
|
+
# CloudFormation uses a temporary session that is generated from your
|
1898
|
+
# user credentials.
|
1903
1899
|
# @return [String]
|
1904
1900
|
#
|
1905
1901
|
# @!attribute [rw] client_request_token
|
1906
1902
|
# A unique identifier for this `DeleteStack` request. Specify this
|
1907
|
-
# token if you plan to retry requests so that
|
1903
|
+
# token if you plan to retry requests so that CloudFormation knows
|
1908
1904
|
# that you're not attempting to delete a stack with the same name.
|
1909
|
-
# You might retry `DeleteStack` requests to ensure that
|
1910
|
-
#
|
1905
|
+
# You might retry `DeleteStack` requests to ensure that CloudFormation
|
1906
|
+
# successfully received them.
|
1911
1907
|
#
|
1912
1908
|
# All events triggered by a given stack operation are assigned the
|
1913
1909
|
# same client request token, which you can use to track operations.
|
@@ -1966,14 +1962,14 @@ module Aws::CloudFormation
|
|
1966
1962
|
# @return [String]
|
1967
1963
|
#
|
1968
1964
|
# @!attribute [rw] accounts
|
1969
|
-
# \[Self-managed permissions\] The names of the
|
1970
|
-
#
|
1965
|
+
# \[Self-managed permissions\] The names of the accounts that you want
|
1966
|
+
# to delete stack instances for.
|
1971
1967
|
#
|
1972
1968
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1973
1969
|
# @return [Array<String>]
|
1974
1970
|
#
|
1975
1971
|
# @!attribute [rw] deployment_targets
|
1976
|
-
# \[Service-managed permissions\] The
|
1972
|
+
# \[Service-managed permissions\] The Organizations accounts from
|
1977
1973
|
# which to delete stack instances.
|
1978
1974
|
#
|
1979
1975
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
@@ -1984,7 +1980,7 @@ module Aws::CloudFormation
|
|
1984
1980
|
# @return [Array<String>]
|
1985
1981
|
#
|
1986
1982
|
# @!attribute [rw] operation_preferences
|
1987
|
-
# Preferences for how
|
1983
|
+
# Preferences for how CloudFormation performs this stack set
|
1988
1984
|
# operation.
|
1989
1985
|
# @return [Types::StackSetOperationPreferences]
|
1990
1986
|
#
|
@@ -2007,10 +2003,10 @@ module Aws::CloudFormation
|
|
2007
2003
|
# automatically.
|
2008
2004
|
#
|
2009
2005
|
# The operation ID also functions as an idempotency token, to ensure
|
2010
|
-
# that
|
2011
|
-
#
|
2012
|
-
#
|
2013
|
-
#
|
2006
|
+
# that CloudFormation performs the stack set operation only once, even
|
2007
|
+
# if you retry the request multiple times. You can retry stack set
|
2008
|
+
# operation requests to ensure that CloudFormation successfully
|
2009
|
+
# received them.
|
2014
2010
|
#
|
2015
2011
|
# Repeating this stack set operation with a new operation ID retries
|
2016
2012
|
# all stack instances whose status is `OUTDATED`.
|
@@ -2032,10 +2028,9 @@ module Aws::CloudFormation
|
|
2032
2028
|
# * If you are signed in to a delegated administrator account, specify
|
2033
2029
|
# `DELEGATED_ADMIN`.
|
2034
2030
|
#
|
2035
|
-
# Your
|
2036
|
-
#
|
2037
|
-
# delegated administrator][1] in the *
|
2038
|
-
# Guide*.
|
2031
|
+
# Your account must be registered as a delegated administrator in
|
2032
|
+
# the management account. For more information, see [Register a
|
2033
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2039
2034
|
#
|
2040
2035
|
#
|
2041
2036
|
#
|
@@ -2095,10 +2090,9 @@ module Aws::CloudFormation
|
|
2095
2090
|
# * If you are signed in to a delegated administrator account, specify
|
2096
2091
|
# `DELEGATED_ADMIN`.
|
2097
2092
|
#
|
2098
|
-
# Your
|
2099
|
-
#
|
2100
|
-
# delegated administrator][1] in the *
|
2101
|
-
# Guide*.
|
2093
|
+
# Your account must be registered as a delegated administrator in
|
2094
|
+
# the management account. For more information, see [Register a
|
2095
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2102
2096
|
#
|
2103
2097
|
#
|
2104
2098
|
#
|
@@ -2118,11 +2112,10 @@ module Aws::CloudFormation
|
|
2118
2112
|
#
|
2119
2113
|
class DeleteStackSetOutput < Aws::EmptyStructure; end
|
2120
2114
|
|
2121
|
-
# \[Service-managed permissions\] The
|
2122
|
-
#
|
2123
|
-
#
|
2124
|
-
#
|
2125
|
-
# organization.
|
2115
|
+
# \[Service-managed permissions\] The Organizations accounts to which
|
2116
|
+
# StackSets deploys. StackSets does not deploy stack instances to the
|
2117
|
+
# organization management account, even if the organization management
|
2118
|
+
# account is in your organization or in an OU in your organization.
|
2126
2119
|
#
|
2127
2120
|
# For update operations, you can specify either `Accounts` or
|
2128
2121
|
# `OrganizationalUnitIds`. For create and delete operations, specify
|
@@ -2138,12 +2131,12 @@ module Aws::CloudFormation
|
|
2138
2131
|
# }
|
2139
2132
|
#
|
2140
2133
|
# @!attribute [rw] accounts
|
2141
|
-
# The names of one or more
|
2142
|
-
#
|
2134
|
+
# The names of one or more accounts for which you want to deploy stack
|
2135
|
+
# set updates.
|
2143
2136
|
# @return [Array<String>]
|
2144
2137
|
#
|
2145
2138
|
# @!attribute [rw] accounts_url
|
2146
|
-
# Returns the value of the AccountsUrl property.
|
2139
|
+
# Returns the value of the `AccountsUrl` property.
|
2147
2140
|
# @return [String]
|
2148
2141
|
#
|
2149
2142
|
# @!attribute [rw] organizational_unit_ids
|
@@ -2238,7 +2231,7 @@ module Aws::CloudFormation
|
|
2238
2231
|
# The output for the DescribeAccountLimits action.
|
2239
2232
|
#
|
2240
2233
|
# @!attribute [rw] account_limits
|
2241
|
-
# An account limit structure that contain a list of
|
2234
|
+
# An account limit structure that contain a list of CloudFormation
|
2242
2235
|
# account limits and their values.
|
2243
2236
|
# @return [Array<Types::AccountLimit>]
|
2244
2237
|
#
|
@@ -2333,8 +2326,8 @@ module Aws::CloudFormation
|
|
2333
2326
|
# If the change set execution status is `AVAILABLE`, you can execute
|
2334
2327
|
# the change set. If you can’t execute the change set, the status
|
2335
2328
|
# indicates why. For example, a change set might be in an
|
2336
|
-
# `UNAVAILABLE` state because
|
2337
|
-
#
|
2329
|
+
# `UNAVAILABLE` state because CloudFormation is still creating it or
|
2330
|
+
# in an `OBSOLETE` state because the stack was already updated.
|
2338
2331
|
# @return [String]
|
2339
2332
|
#
|
2340
2333
|
# @!attribute [rw] status
|
@@ -2344,7 +2337,7 @@ module Aws::CloudFormation
|
|
2344
2337
|
#
|
2345
2338
|
# @!attribute [rw] status_reason
|
2346
2339
|
# A description of the change set's status. For example, if your
|
2347
|
-
# attempt to create a change set failed,
|
2340
|
+
# attempt to create a change set failed, CloudFormation shows the
|
2348
2341
|
# error message.
|
2349
2342
|
# @return [String]
|
2350
2343
|
#
|
@@ -2355,7 +2348,7 @@ module Aws::CloudFormation
|
|
2355
2348
|
# @return [Array<String>]
|
2356
2349
|
#
|
2357
2350
|
# @!attribute [rw] rollback_configuration
|
2358
|
-
# The rollback triggers for
|
2351
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
2359
2352
|
# creation and updating operations, and for the specified monitoring
|
2360
2353
|
# period afterwards.
|
2361
2354
|
# @return [Types::RollbackConfiguration]
|
@@ -2371,7 +2364,7 @@ module Aws::CloudFormation
|
|
2371
2364
|
# @return [Array<Types::Tag>]
|
2372
2365
|
#
|
2373
2366
|
# @!attribute [rw] changes
|
2374
|
-
# A list of `Change` structures that describes the resources
|
2367
|
+
# A list of `Change` structures that describes the resources
|
2375
2368
|
# CloudFormation changes if you execute the change set.
|
2376
2369
|
# @return [Array<Types::Change>]
|
2377
2370
|
#
|
@@ -2482,9 +2475,9 @@ module Aws::CloudFormation
|
|
2482
2475
|
# @!attribute [rw] stack_drift_detection_id
|
2483
2476
|
# The ID of the drift detection results of this operation.
|
2484
2477
|
#
|
2485
|
-
#
|
2486
|
-
#
|
2487
|
-
# results
|
2478
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
2479
|
+
# each time this operation is run. However, the number of drift
|
2480
|
+
# results CloudFormation retains for any given stack, and for how
|
2488
2481
|
# long, may vary.
|
2489
2482
|
# @return [String]
|
2490
2483
|
#
|
@@ -2503,10 +2496,10 @@ module Aws::CloudFormation
|
|
2503
2496
|
# @!attribute [rw] stack_drift_detection_id
|
2504
2497
|
# The ID of the drift detection results of this operation.
|
2505
2498
|
#
|
2506
|
-
#
|
2507
|
-
#
|
2508
|
-
#
|
2509
|
-
#
|
2499
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
2500
|
+
# each time this operation is run. However, the number of reports
|
2501
|
+
# CloudFormation retains for any given stack, and for how long, may
|
2502
|
+
# vary.
|
2510
2503
|
# @return [String]
|
2511
2504
|
#
|
2512
2505
|
# @!attribute [rw] stack_drift_status
|
@@ -2517,7 +2510,7 @@ module Aws::CloudFormation
|
|
2517
2510
|
# configuration. A stack is considered to have drifted if one or
|
2518
2511
|
# more of its resources have drifted.
|
2519
2512
|
#
|
2520
|
-
# * `NOT_CHECKED`\:
|
2513
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
2521
2514
|
# differs from its expected template configuration.
|
2522
2515
|
#
|
2523
2516
|
# * `IN_SYNC`\: The stack's actual configuration matches its expected
|
@@ -2534,13 +2527,13 @@ module Aws::CloudFormation
|
|
2534
2527
|
# drift detection. (Resources that do not currently support stack
|
2535
2528
|
# detection remain unchecked.)
|
2536
2529
|
#
|
2537
|
-
# If you specified logical resource IDs for
|
2538
|
-
#
|
2530
|
+
# If you specified logical resource IDs for CloudFormation to use as
|
2531
|
+
# a filter for the stack drift detection operation, only the
|
2539
2532
|
# resources with those logical IDs are checked for drift.
|
2540
2533
|
#
|
2541
2534
|
# * `DETECTION_FAILED`\: The stack drift detection operation has
|
2542
2535
|
# failed for at least one resource in the stack. Results will be
|
2543
|
-
# available for resources on which
|
2536
|
+
# available for resources on which CloudFormation successfully
|
2544
2537
|
# completed drift detection.
|
2545
2538
|
#
|
2546
2539
|
# * `DETECTION_IN_PROGRESS`\: The stack drift detection operation is
|
@@ -2650,8 +2643,7 @@ module Aws::CloudFormation
|
|
2650
2643
|
# @return [String]
|
2651
2644
|
#
|
2652
2645
|
# @!attribute [rw] stack_instance_account
|
2653
|
-
# The ID of an
|
2654
|
-
# instance.
|
2646
|
+
# The ID of an account that's associated with this stack instance.
|
2655
2647
|
# @return [String]
|
2656
2648
|
#
|
2657
2649
|
# @!attribute [rw] stack_instance_region
|
@@ -2671,10 +2663,9 @@ module Aws::CloudFormation
|
|
2671
2663
|
# * If you are signed in to a delegated administrator account, specify
|
2672
2664
|
# `DELEGATED_ADMIN`.
|
2673
2665
|
#
|
2674
|
-
# Your
|
2675
|
-
#
|
2676
|
-
# delegated administrator][1] in the *
|
2677
|
-
# Guide*.
|
2666
|
+
# Your account must be registered as a delegated administrator in
|
2667
|
+
# the management account. For more information, see [Register a
|
2668
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2678
2669
|
#
|
2679
2670
|
#
|
2680
2671
|
#
|
@@ -2731,7 +2722,7 @@ module Aws::CloudFormation
|
|
2731
2722
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
2732
2723
|
# expected template configuration.
|
2733
2724
|
#
|
2734
|
-
# * `NOT_CHECKED`\:
|
2725
|
+
# * `NOT_CHECKED`\: CloudFormation does not currently return this
|
2735
2726
|
# value.
|
2736
2727
|
# @return [Array<String>]
|
2737
2728
|
#
|
@@ -2761,7 +2752,7 @@ module Aws::CloudFormation
|
|
2761
2752
|
# @!attribute [rw] stack_resource_drifts
|
2762
2753
|
# Drift information for the resources that have been checked for drift
|
2763
2754
|
# in the specified stack. This includes actual and expected
|
2764
|
-
# configuration values for resources where
|
2755
|
+
# configuration values for resources where CloudFormation detects
|
2765
2756
|
# drift.
|
2766
2757
|
#
|
2767
2758
|
# For a given stack, there will be one `StackResourceDrift` for each
|
@@ -2879,7 +2870,7 @@ module Aws::CloudFormation
|
|
2879
2870
|
#
|
2880
2871
|
# @!attribute [rw] physical_resource_id
|
2881
2872
|
# The name or unique identifier that corresponds to a physical
|
2882
|
-
# instance ID of a resource supported by
|
2873
|
+
# instance ID of a resource supported by CloudFormation.
|
2883
2874
|
#
|
2884
2875
|
# For example, for an Amazon Elastic Compute Cloud (EC2) instance,
|
2885
2876
|
# `PhysicalResourceId` corresponds to the `InstanceId`. You can pass
|
@@ -2942,10 +2933,9 @@ module Aws::CloudFormation
|
|
2942
2933
|
# * If you are signed in to a delegated administrator account, specify
|
2943
2934
|
# `DELEGATED_ADMIN`.
|
2944
2935
|
#
|
2945
|
-
# Your
|
2946
|
-
#
|
2947
|
-
# delegated administrator][1] in the *
|
2948
|
-
# Guide*.
|
2936
|
+
# Your account must be registered as a delegated administrator in
|
2937
|
+
# the management account. For more information, see [Register a
|
2938
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2949
2939
|
#
|
2950
2940
|
#
|
2951
2941
|
#
|
@@ -2992,10 +2982,9 @@ module Aws::CloudFormation
|
|
2992
2982
|
# * If you are signed in to a delegated administrator account, specify
|
2993
2983
|
# `DELEGATED_ADMIN`.
|
2994
2984
|
#
|
2995
|
-
# Your
|
2996
|
-
#
|
2997
|
-
# delegated administrator][1] in the *
|
2998
|
-
# Guide*.
|
2985
|
+
# Your account must be registered as a delegated administrator in
|
2986
|
+
# the management account. For more information, see [Register a
|
2987
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
2999
2988
|
#
|
3000
2989
|
#
|
3001
2990
|
#
|
@@ -3261,7 +3250,7 @@ module Aws::CloudFormation
|
|
3261
3250
|
#
|
3262
3251
|
# @!attribute [rw] provisioning_type
|
3263
3252
|
# For resource type extensions, the provisioning behavior of the
|
3264
|
-
# resource type.
|
3253
|
+
# resource type. CloudFormation determines the provisioning type
|
3265
3254
|
# during registration, based on the types of handlers in the schema
|
3266
3255
|
# handler package submitted.
|
3267
3256
|
#
|
@@ -3326,13 +3315,13 @@ module Aws::CloudFormation
|
|
3326
3315
|
#
|
3327
3316
|
#
|
3328
3317
|
#
|
3329
|
-
# If the registered extension calls any
|
3330
|
-
# <i> <a
|
3318
|
+
# If the registered extension calls any Amazon Web Services APIs, you
|
3319
|
+
# must create an <i> <a
|
3331
3320
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
3332
3321
|
# execution role</a> </i> that includes the necessary permissions to
|
3333
|
-
# call those
|
3334
|
-
# account. CloudFormation then assumes that execution
|
3335
|
-
# your extension with the appropriate credentials.
|
3322
|
+
# call those Amazon Web Services APIs, and provision that execution
|
3323
|
+
# role in your account. CloudFormation then assumes that execution
|
3324
|
+
# role to provide your extension with the appropriate credentials.
|
3336
3325
|
#
|
3337
3326
|
#
|
3338
3327
|
#
|
@@ -3346,7 +3335,7 @@ module Aws::CloudFormation
|
|
3346
3335
|
# Valid values include:
|
3347
3336
|
#
|
3348
3337
|
# * `PRIVATE`\: The extension is only visible and usable within the
|
3349
|
-
# account in which it is registered.
|
3338
|
+
# account in which it is registered. CloudFormation marks any
|
3350
3339
|
# extensions you register as `PRIVATE`.
|
3351
3340
|
#
|
3352
3341
|
# * `PUBLIC`\: The extension is publically visible and usable within
|
@@ -3460,7 +3449,7 @@ module Aws::CloudFormation
|
|
3460
3449
|
# be manually updated. For more information, see [Activating public
|
3461
3450
|
# extensions for use in your
|
3462
3451
|
# account](AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable)
|
3463
|
-
# in the *
|
3452
|
+
# in the *CloudFormation User Guide*.
|
3464
3453
|
# @return [Boolean]
|
3465
3454
|
#
|
3466
3455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation
|
@@ -3581,9 +3570,9 @@ module Aws::CloudFormation
|
|
3581
3570
|
# @!attribute [rw] stack_drift_detection_id
|
3582
3571
|
# The ID of the drift detection results of this operation.
|
3583
3572
|
#
|
3584
|
-
#
|
3585
|
-
#
|
3586
|
-
# results
|
3573
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
3574
|
+
# each time this operation is run. However, the number of drift
|
3575
|
+
# results CloudFormation retains for any given stack, and for how
|
3587
3576
|
# long, may vary.
|
3588
3577
|
# @return [String]
|
3589
3578
|
#
|
@@ -3658,7 +3647,7 @@ module Aws::CloudFormation
|
|
3658
3647
|
# @return [String]
|
3659
3648
|
#
|
3660
3649
|
# @!attribute [rw] operation_preferences
|
3661
|
-
# The user-specified preferences for how
|
3650
|
+
# The user-specified preferences for how CloudFormation performs a
|
3662
3651
|
# stack set operation.
|
3663
3652
|
#
|
3664
3653
|
# For more information on maximum concurrent accounts and failure
|
@@ -3689,10 +3678,9 @@ module Aws::CloudFormation
|
|
3689
3678
|
# * If you are signed in to a delegated administrator account, specify
|
3690
3679
|
# `DELEGATED_ADMIN`.
|
3691
3680
|
#
|
3692
|
-
# Your
|
3693
|
-
#
|
3694
|
-
# delegated administrator][1] in the *
|
3695
|
-
# Guide*.
|
3681
|
+
# Your account must be registered as a delegated administrator in
|
3682
|
+
# the management account. For more information, see [Register a
|
3683
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
3696
3684
|
#
|
3697
3685
|
#
|
3698
3686
|
#
|
@@ -3746,7 +3734,7 @@ module Aws::CloudFormation
|
|
3746
3734
|
# @!attribute [rw] template_body
|
3747
3735
|
# Structure containing the template body with a minimum length of 1
|
3748
3736
|
# byte and a maximum length of 51,200 bytes. (For more information, go
|
3749
|
-
# to [Template Anatomy][1] in the
|
3737
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.)
|
3750
3738
|
#
|
3751
3739
|
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
|
3752
3740
|
# are passed, only `TemplateBody` is used.
|
@@ -3760,7 +3748,7 @@ module Aws::CloudFormation
|
|
3760
3748
|
# Location of file containing the template body. The URL must point to
|
3761
3749
|
# a template that is located in an Amazon S3 bucket or a Systems
|
3762
3750
|
# Manager document. For more information, go to [Template Anatomy][1]
|
3763
|
-
# in the
|
3751
|
+
# in the CloudFormation User Guide.
|
3764
3752
|
#
|
3765
3753
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
3766
3754
|
# are passed, only `TemplateBody` is used.
|
@@ -3787,8 +3775,8 @@ module Aws::CloudFormation
|
|
3787
3775
|
# The output for a EstimateTemplateCost action.
|
3788
3776
|
#
|
3789
3777
|
# @!attribute [rw] url
|
3790
|
-
# An
|
3791
|
-
# describes the resources required to run the template.
|
3778
|
+
# An Amazon Web Services Simple Monthly Calculator URL with a query
|
3779
|
+
# string that describes the resources required to run the template.
|
3792
3780
|
# @return [String]
|
3793
3781
|
#
|
3794
3782
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCostOutput AWS API Documentation
|
@@ -3822,11 +3810,10 @@ module Aws::CloudFormation
|
|
3822
3810
|
#
|
3823
3811
|
# @!attribute [rw] client_request_token
|
3824
3812
|
# A unique identifier for this `ExecuteChangeSet` request. Specify
|
3825
|
-
# this token if you plan to retry requests so that
|
3813
|
+
# this token if you plan to retry requests so that CloudFormation
|
3826
3814
|
# knows that you're not attempting to execute a change set to update
|
3827
3815
|
# a stack with the same name. You might retry `ExecuteChangeSet`
|
3828
|
-
# requests to ensure that
|
3829
|
-
# them.
|
3816
|
+
# requests to ensure that CloudFormation successfully received them.
|
3830
3817
|
# @return [String]
|
3831
3818
|
#
|
3832
3819
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSetInput AWS API Documentation
|
@@ -3901,8 +3888,8 @@ module Aws::CloudFormation
|
|
3901
3888
|
#
|
3902
3889
|
# @!attribute [rw] stack_policy_body
|
3903
3890
|
# Structure containing the stack policy body. (For more information,
|
3904
|
-
# go to [ Prevent Updates to Stack Resources][1] in the
|
3905
|
-
#
|
3891
|
+
# go to [ Prevent Updates to Stack Resources][1] in the CloudFormation
|
3892
|
+
# User Guide.)
|
3906
3893
|
#
|
3907
3894
|
#
|
3908
3895
|
#
|
@@ -3941,19 +3928,19 @@ module Aws::CloudFormation
|
|
3941
3928
|
# @return [String]
|
3942
3929
|
#
|
3943
3930
|
# @!attribute [rw] change_set_name
|
3944
|
-
# The name or Amazon Resource Name (ARN) of a change set for which
|
3931
|
+
# The name or Amazon Resource Name (ARN) of a change set for which
|
3945
3932
|
# CloudFormation returns the associated template. If you specify a
|
3946
3933
|
# name, you must also specify the `StackName`.
|
3947
3934
|
# @return [String]
|
3948
3935
|
#
|
3949
3936
|
# @!attribute [rw] template_stage
|
3950
3937
|
# For templates that include transforms, the stage of the template
|
3951
|
-
# that
|
3952
|
-
# specify `Original`. To get the template after
|
3938
|
+
# that CloudFormation returns. To get the user-submitted template,
|
3939
|
+
# specify `Original`. To get the template after CloudFormation has
|
3953
3940
|
# processed all transforms, specify `Processed`.
|
3954
3941
|
#
|
3955
3942
|
# If the template doesn't include transforms, `Original` and
|
3956
|
-
# `Processed` return the same template. By default,
|
3943
|
+
# `Processed` return the same template. By default, CloudFormation
|
3957
3944
|
# specifies `Processed`.
|
3958
3945
|
# @return [String]
|
3959
3946
|
#
|
@@ -3971,9 +3958,9 @@ module Aws::CloudFormation
|
|
3971
3958
|
#
|
3972
3959
|
# @!attribute [rw] template_body
|
3973
3960
|
# Structure containing the template body. (For more information, go to
|
3974
|
-
# [Template Anatomy][1] in the
|
3961
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
3975
3962
|
#
|
3976
|
-
#
|
3963
|
+
# CloudFormation returns the same template that was used when the
|
3977
3964
|
# stack was created.
|
3978
3965
|
#
|
3979
3966
|
#
|
@@ -3984,7 +3971,7 @@ module Aws::CloudFormation
|
|
3984
3971
|
# @!attribute [rw] stages_available
|
3985
3972
|
# The stage of the template that you can retrieve. For stacks, the
|
3986
3973
|
# `Original` and `Processed` templates are always available. For
|
3987
|
-
# change sets, the `Original` template is always available. After
|
3974
|
+
# change sets, the `Original` template is always available. After
|
3988
3975
|
# CloudFormation finishes creating the change set, the `Processed`
|
3989
3976
|
# template becomes available.
|
3990
3977
|
# @return [Array<String>]
|
@@ -4014,7 +4001,7 @@ module Aws::CloudFormation
|
|
4014
4001
|
# @!attribute [rw] template_body
|
4015
4002
|
# Structure containing the template body with a minimum length of 1
|
4016
4003
|
# byte and a maximum length of 51,200 bytes. For more information
|
4017
|
-
# about templates, see [Template Anatomy][1] in the
|
4004
|
+
# about templates, see [Template Anatomy][1] in the CloudFormation
|
4018
4005
|
# User Guide.
|
4019
4006
|
#
|
4020
4007
|
# Conditional: You must specify only one of the following parameters:
|
@@ -4029,7 +4016,7 @@ module Aws::CloudFormation
|
|
4029
4016
|
# Location of file containing the template body. The URL must point to
|
4030
4017
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
4031
4018
|
# bucket or a Systems Manager document. For more information about
|
4032
|
-
# templates, see [Template Anatomy][1] in the
|
4019
|
+
# templates, see [Template Anatomy][1] in the CloudFormation User
|
4033
4020
|
# Guide.
|
4034
4021
|
#
|
4035
4022
|
# Conditional: You must specify only one of the following parameters:
|
@@ -4071,10 +4058,9 @@ module Aws::CloudFormation
|
|
4071
4058
|
# * If you are signed in to a delegated administrator account, specify
|
4072
4059
|
# `DELEGATED_ADMIN`.
|
4073
4060
|
#
|
4074
|
-
# Your
|
4075
|
-
#
|
4076
|
-
# delegated administrator][1] in the *
|
4077
|
-
# Guide*.
|
4061
|
+
# Your account must be registered as a delegated administrator in
|
4062
|
+
# the management account. For more information, see [Register a
|
4063
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4078
4064
|
#
|
4079
4065
|
#
|
4080
4066
|
#
|
@@ -4112,7 +4098,7 @@ module Aws::CloudFormation
|
|
4112
4098
|
# CreateStack or UpdateStack actions with your template; otherwise,
|
4113
4099
|
# those actions return an InsufficientCapabilities error.
|
4114
4100
|
#
|
4115
|
-
# For more information, see [Acknowledging IAM Resources in
|
4101
|
+
# For more information, see [Acknowledging IAM Resources in
|
4116
4102
|
# CloudFormation Templates][1].
|
4117
4103
|
#
|
4118
4104
|
#
|
@@ -4132,8 +4118,8 @@ module Aws::CloudFormation
|
|
4132
4118
|
# @return [Array<String>]
|
4133
4119
|
#
|
4134
4120
|
# @!attribute [rw] version
|
4135
|
-
# The
|
4136
|
-
# of the template.
|
4121
|
+
# The Amazon Web Services template format version, which identifies
|
4122
|
+
# the capabilities of the template.
|
4137
4123
|
# @return [String]
|
4138
4124
|
#
|
4139
4125
|
# @!attribute [rw] metadata
|
@@ -4169,6 +4155,86 @@ module Aws::CloudFormation
|
|
4169
4155
|
include Aws::Structure
|
4170
4156
|
end
|
4171
4157
|
|
4158
|
+
# @note When making an API call, you may pass ImportStacksToStackSetInput
|
4159
|
+
# data as a hash:
|
4160
|
+
#
|
4161
|
+
# {
|
4162
|
+
# stack_set_name: "StackSetNameOrId", # required
|
4163
|
+
# stack_ids: ["StackId"], # required
|
4164
|
+
# operation_preferences: {
|
4165
|
+
# region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
|
4166
|
+
# region_order: ["Region"],
|
4167
|
+
# failure_tolerance_count: 1,
|
4168
|
+
# failure_tolerance_percentage: 1,
|
4169
|
+
# max_concurrent_count: 1,
|
4170
|
+
# max_concurrent_percentage: 1,
|
4171
|
+
# },
|
4172
|
+
# operation_id: "ClientRequestToken",
|
4173
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
4174
|
+
# }
|
4175
|
+
#
|
4176
|
+
# @!attribute [rw] stack_set_name
|
4177
|
+
# The name of the stack set. The name must be unique in the Region
|
4178
|
+
# where you create your stack set.
|
4179
|
+
# @return [String]
|
4180
|
+
#
|
4181
|
+
# @!attribute [rw] stack_ids
|
4182
|
+
# The IDs of the stacks you are importing into a stack set. You import
|
4183
|
+
# up to 10 stacks per stack set at a time.
|
4184
|
+
# @return [Array<String>]
|
4185
|
+
#
|
4186
|
+
# @!attribute [rw] operation_preferences
|
4187
|
+
# The user-specified preferences for how CloudFormation performs a
|
4188
|
+
# stack set operation.
|
4189
|
+
#
|
4190
|
+
# For more information on maximum concurrent accounts and failure
|
4191
|
+
# tolerance, see [Stack set operation options][1].
|
4192
|
+
#
|
4193
|
+
#
|
4194
|
+
#
|
4195
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
4196
|
+
# @return [Types::StackSetOperationPreferences]
|
4197
|
+
#
|
4198
|
+
# @!attribute [rw] operation_id
|
4199
|
+
# A unique, user defined, identifier for the stack set operation.
|
4200
|
+
#
|
4201
|
+
# **A suitable default value is auto-generated.** You should normally
|
4202
|
+
# not need to pass this option.
|
4203
|
+
# @return [String]
|
4204
|
+
#
|
4205
|
+
# @!attribute [rw] call_as
|
4206
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
4207
|
+
# self-managed permissions.
|
4208
|
+
#
|
4209
|
+
# * If you are signed in to the management account, specify `SELF`.
|
4210
|
+
#
|
4211
|
+
# * For service managed stack sets, specify `DELEGATED_ADMIN`.
|
4212
|
+
# @return [String]
|
4213
|
+
#
|
4214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetInput AWS API Documentation
|
4215
|
+
#
|
4216
|
+
class ImportStacksToStackSetInput < Struct.new(
|
4217
|
+
:stack_set_name,
|
4218
|
+
:stack_ids,
|
4219
|
+
:operation_preferences,
|
4220
|
+
:operation_id,
|
4221
|
+
:call_as)
|
4222
|
+
SENSITIVE = []
|
4223
|
+
include Aws::Structure
|
4224
|
+
end
|
4225
|
+
|
4226
|
+
# @!attribute [rw] operation_id
|
4227
|
+
# The unique identifier for the stack set operation.
|
4228
|
+
# @return [String]
|
4229
|
+
#
|
4230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetOutput AWS API Documentation
|
4231
|
+
#
|
4232
|
+
class ImportStacksToStackSetOutput < Struct.new(
|
4233
|
+
:operation_id)
|
4234
|
+
SENSITIVE = []
|
4235
|
+
include Aws::Structure
|
4236
|
+
end
|
4237
|
+
|
4172
4238
|
# The template contains resources with capabilities that weren't
|
4173
4239
|
# specified in the Capabilities parameter.
|
4174
4240
|
#
|
@@ -4204,7 +4270,7 @@ module Aws::CloudFormation
|
|
4204
4270
|
# The quota for the resource has already been reached.
|
4205
4271
|
#
|
4206
4272
|
# For information on resource and stack limitations, see [Limits][1] in
|
4207
|
-
# the *
|
4273
|
+
# the *CloudFormation User Guide*.
|
4208
4274
|
#
|
4209
4275
|
#
|
4210
4276
|
#
|
@@ -4313,8 +4379,8 @@ module Aws::CloudFormation
|
|
4313
4379
|
# }
|
4314
4380
|
#
|
4315
4381
|
# @!attribute [rw] export_name
|
4316
|
-
# The name of the exported output value.
|
4317
|
-
#
|
4382
|
+
# The name of the exported output value. CloudFormation returns the
|
4383
|
+
# stack names that are importing this value.
|
4318
4384
|
# @return [String]
|
4319
4385
|
#
|
4320
4386
|
# @!attribute [rw] next_token
|
@@ -4395,8 +4461,7 @@ module Aws::CloudFormation
|
|
4395
4461
|
# @return [Array<Types::StackInstanceFilter>]
|
4396
4462
|
#
|
4397
4463
|
# @!attribute [rw] stack_instance_account
|
4398
|
-
# The name of the
|
4399
|
-
# for.
|
4464
|
+
# The name of the account that you want to list stack instances for.
|
4400
4465
|
# @return [String]
|
4401
4466
|
#
|
4402
4467
|
# @!attribute [rw] stack_instance_region
|
@@ -4416,10 +4481,9 @@ module Aws::CloudFormation
|
|
4416
4481
|
# * If you are signed in to a delegated administrator account, specify
|
4417
4482
|
# `DELEGATED_ADMIN`.
|
4418
4483
|
#
|
4419
|
-
# Your
|
4420
|
-
#
|
4421
|
-
# delegated administrator][1] in the *
|
4422
|
-
# Guide*.
|
4484
|
+
# Your account must be registered as a delegated administrator in
|
4485
|
+
# the management account. For more information, see [Register a
|
4486
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4423
4487
|
#
|
4424
4488
|
#
|
4425
4489
|
#
|
@@ -4569,10 +4633,9 @@ module Aws::CloudFormation
|
|
4569
4633
|
# * If you are signed in to a delegated administrator account, specify
|
4570
4634
|
# `DELEGATED_ADMIN`.
|
4571
4635
|
#
|
4572
|
-
# Your
|
4573
|
-
#
|
4574
|
-
# delegated administrator][1] in the *
|
4575
|
-
# Guide*.
|
4636
|
+
# Your account must be registered as a delegated administrator in
|
4637
|
+
# the management account. For more information, see [Register a
|
4638
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4576
4639
|
#
|
4577
4640
|
#
|
4578
4641
|
#
|
@@ -4659,10 +4722,9 @@ module Aws::CloudFormation
|
|
4659
4722
|
# * If you are signed in to a delegated administrator account, specify
|
4660
4723
|
# `DELEGATED_ADMIN`.
|
4661
4724
|
#
|
4662
|
-
# Your
|
4663
|
-
#
|
4664
|
-
# delegated administrator][1] in the *
|
4665
|
-
# Guide*.
|
4725
|
+
# Your account must be registered as a delegated administrator in
|
4726
|
+
# the management account. For more information, see [Register a
|
4727
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4666
4728
|
#
|
4667
4729
|
#
|
4668
4730
|
#
|
@@ -4746,10 +4808,9 @@ module Aws::CloudFormation
|
|
4746
4808
|
# * If you are signed in to a delegated administrator account, specify
|
4747
4809
|
# `DELEGATED_ADMIN`.
|
4748
4810
|
#
|
4749
|
-
# Your
|
4750
|
-
#
|
4751
|
-
# delegated administrator][1] in the *
|
4752
|
-
# Guide*.
|
4811
|
+
# Your account must be registered as a delegated administrator in
|
4812
|
+
# the management account. For more information, see [Register a
|
4813
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
4753
4814
|
#
|
4754
4815
|
#
|
4755
4816
|
#
|
@@ -5085,9 +5146,9 @@ module Aws::CloudFormation
|
|
5085
5146
|
#
|
5086
5147
|
# @!attribute [rw] provisioning_type
|
5087
5148
|
# For resource types, the provisioning behavior of the resource type.
|
5088
|
-
#
|
5089
|
-
#
|
5090
|
-
#
|
5149
|
+
# CloudFormation determines the provisioning type during registration,
|
5150
|
+
# based on the types of handlers in the schema handler package
|
5151
|
+
# submitted.
|
5091
5152
|
#
|
5092
5153
|
# Valid values include:
|
5093
5154
|
#
|
@@ -5334,7 +5395,7 @@ module Aws::CloudFormation
|
|
5334
5395
|
#
|
5335
5396
|
# @!attribute [rw] parameter_key
|
5336
5397
|
# The key associated with the parameter. If you don't specify a key
|
5337
|
-
# and value for a particular parameter,
|
5398
|
+
# and value for a particular parameter, CloudFormation uses the
|
5338
5399
|
# default value that is specified in your template.
|
5339
5400
|
# @return [String]
|
5340
5401
|
#
|
@@ -5369,10 +5430,9 @@ module Aws::CloudFormation
|
|
5369
5430
|
include Aws::Structure
|
5370
5431
|
end
|
5371
5432
|
|
5372
|
-
# A set of criteria that
|
5433
|
+
# A set of criteria that CloudFormation uses to validate parameter
|
5373
5434
|
# values. Although other constraints might be defined in the stack
|
5374
|
-
# template,
|
5375
|
-
# property.
|
5435
|
+
# template, CloudFormation returns only the `AllowedValues` property.
|
5376
5436
|
#
|
5377
5437
|
# @!attribute [rw] allowed_values
|
5378
5438
|
# A list of values that are permitted for a parameter.
|
@@ -5402,7 +5462,7 @@ module Aws::CloudFormation
|
|
5402
5462
|
#
|
5403
5463
|
# @!attribute [rw] no_echo
|
5404
5464
|
# Flag that indicates whether the parameter value is shown as plain
|
5405
|
-
# text in logs and in the
|
5465
|
+
# text in logs and in the Management Console.
|
5406
5466
|
# @return [Boolean]
|
5407
5467
|
#
|
5408
5468
|
# @!attribute [rw] description
|
@@ -5410,8 +5470,7 @@ module Aws::CloudFormation
|
|
5410
5470
|
# @return [String]
|
5411
5471
|
#
|
5412
5472
|
# @!attribute [rw] parameter_constraints
|
5413
|
-
# The criteria that
|
5414
|
-
# values.
|
5473
|
+
# The criteria that CloudFormation uses to validate parameter values.
|
5415
5474
|
# @return [Types::ParameterConstraints]
|
5416
5475
|
#
|
5417
5476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ParameterDeclaration AWS API Documentation
|
@@ -5427,11 +5486,11 @@ module Aws::CloudFormation
|
|
5427
5486
|
include Aws::Structure
|
5428
5487
|
end
|
5429
5488
|
|
5430
|
-
# Context information that enables
|
5431
|
-
#
|
5432
|
-
#
|
5433
|
-
#
|
5434
|
-
#
|
5489
|
+
# Context information that enables CloudFormation to uniquely identify a
|
5490
|
+
# resource. CloudFormation uses context key-value pairs in cases where a
|
5491
|
+
# resource's logical and physical IDs are not enough to uniquely
|
5492
|
+
# identify that resource. Each context key-value pair specifies a
|
5493
|
+
# resource that contains the targeted resource.
|
5435
5494
|
#
|
5436
5495
|
# @!attribute [rw] key
|
5437
5496
|
# The resource context key.
|
@@ -5540,6 +5599,9 @@ module Aws::CloudFormation
|
|
5540
5599
|
# If you do not specify a version number, CloudFormation increments
|
5541
5600
|
# the version number by one minor version release.
|
5542
5601
|
#
|
5602
|
+
# The first time you publish a type, CloudFormation sets the version
|
5603
|
+
# number to `1.0.0`, regardless of the value you specify.
|
5604
|
+
#
|
5543
5605
|
#
|
5544
5606
|
#
|
5545
5607
|
# [1]: https://semver.org/
|
@@ -5665,12 +5727,16 @@ module Aws::CloudFormation
|
|
5665
5727
|
# }
|
5666
5728
|
#
|
5667
5729
|
# @!attribute [rw] accept_terms_and_conditions
|
5668
|
-
# Whether you accept the
|
5730
|
+
# Whether you accept the [Terms and Conditions][1] for publishing
|
5669
5731
|
# extensions in the CloudFormation registry. You must accept the terms
|
5670
5732
|
# and conditions in order to register to publish public extensions to
|
5671
5733
|
# the CloudFormation registry.
|
5672
5734
|
#
|
5673
5735
|
# The default is `false`.
|
5736
|
+
#
|
5737
|
+
#
|
5738
|
+
#
|
5739
|
+
# [1]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
|
5674
5740
|
# @return [Boolean]
|
5675
5741
|
#
|
5676
5742
|
# @!attribute [rw] connection_arn
|
@@ -5770,7 +5836,7 @@ module Aws::CloudFormation
|
|
5770
5836
|
# package in the S3 bucket. That is, the user needs to have
|
5771
5837
|
# [GetObject][2] permissions for the schema handler package. For more
|
5772
5838
|
# information, see [Actions, Resources, and Condition Keys for Amazon
|
5773
|
-
# S3][3] in the *
|
5839
|
+
# S3][3] in the *Identity and Access Management User Guide*.
|
5774
5840
|
#
|
5775
5841
|
# </note>
|
5776
5842
|
#
|
@@ -5795,18 +5861,18 @@ module Aws::CloudFormation
|
|
5795
5861
|
# information on adding trust relationships, see [Modifying a role
|
5796
5862
|
# trust
|
5797
5863
|
# policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
|
5798
|
-
# in the *
|
5864
|
+
# in the *Identity and Access Management User Guide*.
|
5799
5865
|
#
|
5800
|
-
# If your extension calls
|
5801
|
-
# create an <i> <a
|
5866
|
+
# If your extension calls Amazon Web Services APIs in any of its
|
5867
|
+
# handlers, you must create an <i> <a
|
5802
5868
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
5803
5869
|
# execution role</a> </i> that includes the necessary permissions to
|
5804
|
-
# call those
|
5805
|
-
# account. When CloudFormation needs to invoke the
|
5806
|
-
# handler, CloudFormation assumes this execution role to
|
5807
|
-
# temporary session token, which it then passes to the
|
5808
|
-
# handler, thereby supplying your resource type with the
|
5809
|
-
# credentials.
|
5870
|
+
# call those Amazon Web Services APIs, and provision that execution
|
5871
|
+
# role in your account. When CloudFormation needs to invoke the
|
5872
|
+
# resource type handler, CloudFormation assumes this execution role to
|
5873
|
+
# create a temporary session token, which it then passes to the
|
5874
|
+
# resource type handler, thereby supplying your resource type with the
|
5875
|
+
# appropriate credentials.
|
5810
5876
|
# @return [String]
|
5811
5877
|
#
|
5812
5878
|
# @!attribute [rw] client_request_token
|
@@ -5851,7 +5917,7 @@ module Aws::CloudFormation
|
|
5851
5917
|
# activated.
|
5852
5918
|
#
|
5853
5919
|
# For more information, see [Activating public modules for use in your
|
5854
|
-
# account][1] in the *
|
5920
|
+
# account][1] in the *CloudFormation User Guide*.
|
5855
5921
|
#
|
5856
5922
|
#
|
5857
5923
|
#
|
@@ -5901,12 +5967,11 @@ module Aws::CloudFormation
|
|
5901
5967
|
end
|
5902
5968
|
|
5903
5969
|
# The `ResourceChange` structure describes the resource and the action
|
5904
|
-
# that
|
5905
|
-
# set.
|
5970
|
+
# that CloudFormation will perform on it if you execute this change set.
|
5906
5971
|
#
|
5907
5972
|
# @!attribute [rw] action
|
5908
|
-
# The action that
|
5909
|
-
#
|
5973
|
+
# The action that CloudFormation takes on the resource, such as `Add`
|
5974
|
+
# (adds a new resource), `Modify` (changes a resource), `Remove`
|
5910
5975
|
# (deletes a resource), `Import` (imports a resource), or `Dynamic`
|
5911
5976
|
# (exact action for the resource cannot be determined).
|
5912
5977
|
# @return [String]
|
@@ -5922,11 +5987,11 @@ module Aws::CloudFormation
|
|
5922
5987
|
# @return [String]
|
5923
5988
|
#
|
5924
5989
|
# @!attribute [rw] resource_type
|
5925
|
-
# The type of
|
5990
|
+
# The type of CloudFormation resource, such as `AWS::S3::Bucket`.
|
5926
5991
|
# @return [String]
|
5927
5992
|
#
|
5928
5993
|
# @!attribute [rw] replacement
|
5929
|
-
# For the `Modify` action, indicates whether
|
5994
|
+
# For the `Modify` action, indicates whether CloudFormation will
|
5930
5995
|
# replace the resource by creating a new one and deleting the old one.
|
5931
5996
|
# This value depends on the value of the `RequiresRecreation` property
|
5932
5997
|
# in the `ResourceTargetDefinition` structure. For example, if the
|
@@ -5949,7 +6014,7 @@ module Aws::CloudFormation
|
|
5949
6014
|
#
|
5950
6015
|
# @!attribute [rw] details
|
5951
6016
|
# For the `Modify` action, a list of `ResourceChangeDetail` structures
|
5952
|
-
# that describes the changes that
|
6017
|
+
# that describes the changes that CloudFormation will make to the
|
5953
6018
|
# resource.
|
5954
6019
|
# @return [Array<Types::ResourceChangeDetail>]
|
5955
6020
|
#
|
@@ -5980,23 +6045,23 @@ module Aws::CloudFormation
|
|
5980
6045
|
end
|
5981
6046
|
|
5982
6047
|
# For a resource with `Modify` as the action, the `ResourceChange`
|
5983
|
-
# structure describes the changes
|
6048
|
+
# structure describes the changes CloudFormation will make to that
|
5984
6049
|
# resource.
|
5985
6050
|
#
|
5986
6051
|
# @!attribute [rw] target
|
5987
6052
|
# A `ResourceTargetDefinition` structure that describes the field that
|
5988
|
-
#
|
6053
|
+
# CloudFormation will change and whether the resource will be
|
5989
6054
|
# recreated.
|
5990
6055
|
# @return [Types::ResourceTargetDefinition]
|
5991
6056
|
#
|
5992
6057
|
# @!attribute [rw] evaluation
|
5993
|
-
# Indicates whether
|
5994
|
-
#
|
6058
|
+
# Indicates whether CloudFormation can determine the target value, and
|
6059
|
+
# whether the target value will change before you execute a change
|
5995
6060
|
# set.
|
5996
6061
|
#
|
5997
|
-
# For `Static` evaluations,
|
6062
|
+
# For `Static` evaluations, CloudFormation can determine that the
|
5998
6063
|
# target value will change, and its value. For example, if you
|
5999
|
-
# directly modify the `InstanceType` property of an EC2 instance,
|
6064
|
+
# directly modify the `InstanceType` property of an EC2 instance,
|
6000
6065
|
# CloudFormation knows that this property value will change, and its
|
6001
6066
|
# value, so this is a `Static` evaluation.
|
6002
6067
|
#
|
@@ -6031,11 +6096,11 @@ module Aws::CloudFormation
|
|
6031
6096
|
#
|
6032
6097
|
# * `Automatic` entities are `AWS::CloudFormation::Stack` resource
|
6033
6098
|
# types, which are also known as nested stacks. If you made no
|
6034
|
-
# changes to the `AWS::CloudFormation::Stack` resource,
|
6099
|
+
# changes to the `AWS::CloudFormation::Stack` resource,
|
6035
6100
|
# CloudFormation sets the `ChangeSource` to `Automatic` because the
|
6036
6101
|
# nested stack's template might have changed. Changes to a nested
|
6037
|
-
# stack's template aren't visible to
|
6038
|
-
#
|
6102
|
+
# stack's template aren't visible to CloudFormation until you run
|
6103
|
+
# an update on the parent stack.
|
6039
6104
|
# @return [String]
|
6040
6105
|
#
|
6041
6106
|
# @!attribute [rw] causing_entity
|
@@ -6091,7 +6156,7 @@ module Aws::CloudFormation
|
|
6091
6156
|
include Aws::Structure
|
6092
6157
|
end
|
6093
6158
|
|
6094
|
-
# The field that
|
6159
|
+
# The field that CloudFormation will change, such as the name of a
|
6095
6160
|
# resource's property, and whether the resource will be recreated.
|
6096
6161
|
#
|
6097
6162
|
# @!attribute [rw] attribute
|
@@ -6110,7 +6175,7 @@ module Aws::CloudFormation
|
|
6110
6175
|
# to this property causes the resource to be recreated. The value can
|
6111
6176
|
# be `Never`, `Always`, or `Conditionally`. To determine the
|
6112
6177
|
# conditions for a `Conditionally` recreation, see the update behavior
|
6113
|
-
# for that [property][1] in the
|
6178
|
+
# for that [property][1] in the CloudFormation User Guide.
|
6114
6179
|
#
|
6115
6180
|
#
|
6116
6181
|
#
|
@@ -6143,8 +6208,8 @@ module Aws::CloudFormation
|
|
6143
6208
|
# @!attribute [rw] resource_type
|
6144
6209
|
# The type of resource to import into your stack, such as
|
6145
6210
|
# `AWS::S3::Bucket`. For a list of supported resource types, see
|
6146
|
-
# [Resources that support import operations][1] in the
|
6147
|
-
#
|
6211
|
+
# [Resources that support import operations][1] in the CloudFormation
|
6212
|
+
# User Guide.
|
6148
6213
|
#
|
6149
6214
|
#
|
6150
6215
|
#
|
@@ -6172,15 +6237,15 @@ module Aws::CloudFormation
|
|
6172
6237
|
include Aws::Structure
|
6173
6238
|
end
|
6174
6239
|
|
6175
|
-
# Structure containing the rollback triggers for
|
6240
|
+
# Structure containing the rollback triggers for CloudFormation to
|
6176
6241
|
# monitor during stack creation and updating operations, and for the
|
6177
6242
|
# specified monitoring period afterwards.
|
6178
6243
|
#
|
6179
|
-
# Rollback triggers enable you to have
|
6180
|
-
#
|
6181
|
-
#
|
6182
|
-
#
|
6183
|
-
#
|
6244
|
+
# Rollback triggers enable you to have CloudFormation monitor the state
|
6245
|
+
# of your application during stack creation and updating, and to roll
|
6246
|
+
# back that operation if the application breaches the threshold of any
|
6247
|
+
# of the alarms you've specified. For more information, see [Monitor
|
6248
|
+
# and Roll Back Stack Operations][1].
|
6184
6249
|
#
|
6185
6250
|
#
|
6186
6251
|
#
|
@@ -6202,9 +6267,9 @@ module Aws::CloudFormation
|
|
6202
6267
|
# @!attribute [rw] rollback_triggers
|
6203
6268
|
# The triggers to monitor during stack creation or update actions.
|
6204
6269
|
#
|
6205
|
-
# By default,
|
6206
|
-
#
|
6207
|
-
#
|
6270
|
+
# By default, CloudFormation saves the rollback triggers specified for
|
6271
|
+
# a stack and applies them to any subsequent update operations for the
|
6272
|
+
# stack, unless you specify otherwise. If you do specify rollback
|
6208
6273
|
# triggers for this parameter, those triggers replace any list of
|
6209
6274
|
# triggers previously specified for the stack. This means:
|
6210
6275
|
#
|
@@ -6258,7 +6323,7 @@ module Aws::CloudFormation
|
|
6258
6323
|
include Aws::Structure
|
6259
6324
|
end
|
6260
6325
|
|
6261
|
-
# A rollback trigger
|
6326
|
+
# A rollback trigger CloudFormation monitors during creation and
|
6262
6327
|
# updating of stacks. If any of the alarms you specify goes to ALARM
|
6263
6328
|
# state during the stack operation or within the specified monitoring
|
6264
6329
|
# period afterwards, CloudFormation rolls back the entire stack
|
@@ -6315,9 +6380,9 @@ module Aws::CloudFormation
|
|
6315
6380
|
#
|
6316
6381
|
# @!attribute [rw] stack_policy_body
|
6317
6382
|
# Structure containing the stack policy body. For more information, go
|
6318
|
-
# to [ Prevent Updates to Stack Resources][1] in the
|
6319
|
-
#
|
6320
|
-
# `
|
6383
|
+
# to [ Prevent Updates to Stack Resources][1] in the CloudFormation
|
6384
|
+
# User Guide. You can specify either the `StackPolicyBody` or the
|
6385
|
+
# `StackPolicyURL` parameter, but not both.
|
6321
6386
|
#
|
6322
6387
|
#
|
6323
6388
|
#
|
@@ -6521,8 +6586,8 @@ module Aws::CloudFormation
|
|
6521
6586
|
#
|
6522
6587
|
# @!attribute [rw] status
|
6523
6588
|
# The status of the signal, which is either success or failure. A
|
6524
|
-
# failure signal causes
|
6525
|
-
#
|
6589
|
+
# failure signal causes CloudFormation to immediately fail the stack
|
6590
|
+
# creation or update.
|
6526
6591
|
# @return [String]
|
6527
6592
|
#
|
6528
6593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResourceInput AWS API Documentation
|
@@ -6572,7 +6637,7 @@ module Aws::CloudFormation
|
|
6572
6637
|
# @return [Time]
|
6573
6638
|
#
|
6574
6639
|
# @!attribute [rw] rollback_configuration
|
6575
|
-
# The rollback triggers for
|
6640
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
6576
6641
|
# creation and updating operations, and for the specified monitoring
|
6577
6642
|
# period afterwards.
|
6578
6643
|
# @return [Types::RollbackConfiguration]
|
@@ -6610,10 +6675,10 @@ module Aws::CloudFormation
|
|
6610
6675
|
# @return [Array<Types::Output>]
|
6611
6676
|
#
|
6612
6677
|
# @!attribute [rw] role_arn
|
6613
|
-
# The Amazon Resource Name (ARN) of an
|
6614
|
-
#
|
6615
|
-
#
|
6616
|
-
#
|
6678
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
6679
|
+
# (IAM) role that is associated with the stack. During a stack
|
6680
|
+
# operation, CloudFormation uses this role's credentials to make
|
6681
|
+
# calls on your behalf.
|
6617
6682
|
# @return [String]
|
6618
6683
|
#
|
6619
6684
|
# @!attribute [rw] tags
|
@@ -6626,7 +6691,7 @@ module Aws::CloudFormation
|
|
6626
6691
|
# For [nested stacks][1], termination protection is set on the root
|
6627
6692
|
# stack and cannot be changed directly on the nested stack. For more
|
6628
6693
|
# information, see [Protecting a Stack From Being Deleted][2] in the
|
6629
|
-
# *
|
6694
|
+
# *CloudFormation User Guide*.
|
6630
6695
|
#
|
6631
6696
|
#
|
6632
6697
|
#
|
@@ -6641,7 +6706,7 @@ module Aws::CloudFormation
|
|
6641
6706
|
# stack.
|
6642
6707
|
#
|
6643
6708
|
# For more information, see [Working with Nested Stacks][1] in the
|
6644
|
-
# *
|
6709
|
+
# *CloudFormation User Guide*.
|
6645
6710
|
#
|
6646
6711
|
#
|
6647
6712
|
#
|
@@ -6654,7 +6719,7 @@ module Aws::CloudFormation
|
|
6654
6719
|
# ultimately belongs.
|
6655
6720
|
#
|
6656
6721
|
# For more information, see [Working with Nested Stacks][1] in the
|
6657
|
-
# *
|
6722
|
+
# *CloudFormation User Guide*.
|
6658
6723
|
#
|
6659
6724
|
#
|
6660
6725
|
#
|
@@ -6716,7 +6781,7 @@ module Aws::CloudFormation
|
|
6716
6781
|
# configuration. A stack is considered to have drifted if one or
|
6717
6782
|
# more of its resources have drifted.
|
6718
6783
|
#
|
6719
|
-
# * `NOT_CHECKED`\:
|
6784
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
6720
6785
|
# differs from its expected template configuration.
|
6721
6786
|
#
|
6722
6787
|
# * `IN_SYNC`\: The stack's actual configuration matches its expected
|
@@ -6754,7 +6819,7 @@ module Aws::CloudFormation
|
|
6754
6819
|
# configuration. A stack is considered to have drifted if one or
|
6755
6820
|
# more of its resources have drifted.
|
6756
6821
|
#
|
6757
|
-
# * `NOT_CHECKED`\:
|
6822
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
6758
6823
|
# differs from its expected template configuration.
|
6759
6824
|
#
|
6760
6825
|
# * `IN_SYNC`\: The stack's actual configuration matches its expected
|
@@ -6802,8 +6867,8 @@ module Aws::CloudFormation
|
|
6802
6867
|
# @return [String]
|
6803
6868
|
#
|
6804
6869
|
# @!attribute [rw] resource_type
|
6805
|
-
# Type of resource. (For more information, go to [
|
6806
|
-
# Reference][1] in the
|
6870
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
6871
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
6807
6872
|
#
|
6808
6873
|
#
|
6809
6874
|
#
|
@@ -6862,7 +6927,7 @@ module Aws::CloudFormation
|
|
6862
6927
|
include Aws::Structure
|
6863
6928
|
end
|
6864
6929
|
|
6865
|
-
# An
|
6930
|
+
# An CloudFormation stack, in a specific account and Region, that's
|
6866
6931
|
# part of a stack set operation. A stack instance is a reference to an
|
6867
6932
|
# attempted or actual stack in a given account within a given Region. A
|
6868
6933
|
# stack instance can exist without a stack—for example, if the stack
|
@@ -6877,13 +6942,12 @@ module Aws::CloudFormation
|
|
6877
6942
|
# @return [String]
|
6878
6943
|
#
|
6879
6944
|
# @!attribute [rw] region
|
6880
|
-
# The name of the
|
6881
|
-
# with.
|
6945
|
+
# The name of the Region that the stack instance is associated with.
|
6882
6946
|
# @return [String]
|
6883
6947
|
#
|
6884
6948
|
# @!attribute [rw] account
|
6885
|
-
# \[Self-managed permissions\] The name of the
|
6886
|
-
#
|
6949
|
+
# \[Self-managed permissions\] The name of the account that the stack
|
6950
|
+
# instance is associated with.
|
6887
6951
|
# @return [String]
|
6888
6952
|
#
|
6889
6953
|
# @!attribute [rw] stack_id
|
@@ -6948,7 +7012,7 @@ module Aws::CloudFormation
|
|
6948
7012
|
# stack instance is considered to have drifted if one or more of the
|
6949
7013
|
# resources in the associated stack have drifted.
|
6950
7014
|
#
|
6951
|
-
# * `NOT_CHECKED`\:
|
7015
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
6952
7016
|
# instance differs from its expected stack set configuration.
|
6953
7017
|
#
|
6954
7018
|
# * `IN_SYNC`\: The stack instance's actual configuration matches its
|
@@ -7061,13 +7125,12 @@ module Aws::CloudFormation
|
|
7061
7125
|
# @return [String]
|
7062
7126
|
#
|
7063
7127
|
# @!attribute [rw] region
|
7064
|
-
# The name of the
|
7065
|
-
# with.
|
7128
|
+
# The name of the Region that the stack instance is associated with.
|
7066
7129
|
# @return [String]
|
7067
7130
|
#
|
7068
7131
|
# @!attribute [rw] account
|
7069
|
-
# \[Self-managed permissions\] The name of the
|
7070
|
-
#
|
7132
|
+
# \[Self-managed permissions\] The name of the account that the stack
|
7133
|
+
# instance is associated with.
|
7071
7134
|
# @return [String]
|
7072
7135
|
#
|
7073
7136
|
# @!attribute [rw] stack_id
|
@@ -7127,7 +7190,7 @@ module Aws::CloudFormation
|
|
7127
7190
|
# stack instance is considered to have drifted if one or more of the
|
7128
7191
|
# resources in the associated stack have drifted.
|
7129
7192
|
#
|
7130
|
-
# * `NOT_CHECKED`\:
|
7193
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the stack
|
7131
7194
|
# instance differs from its expected stack set configuration.
|
7132
7195
|
#
|
7133
7196
|
# * `IN_SYNC`\: The stack instance's actual configuration matches its
|
@@ -7159,6 +7222,13 @@ module Aws::CloudFormation
|
|
7159
7222
|
include Aws::Structure
|
7160
7223
|
end
|
7161
7224
|
|
7225
|
+
# The specified stack ARN doesn’t exist or stack doesn’t exist
|
7226
|
+
# corresponding to the ARN in input.
|
7227
|
+
#
|
7228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackNotFoundException AWS API Documentation
|
7229
|
+
#
|
7230
|
+
class StackNotFoundException < Aws::EmptyStructure; end
|
7231
|
+
|
7162
7232
|
# The StackResource data type.
|
7163
7233
|
#
|
7164
7234
|
# @!attribute [rw] stack_name
|
@@ -7175,12 +7245,12 @@ module Aws::CloudFormation
|
|
7175
7245
|
#
|
7176
7246
|
# @!attribute [rw] physical_resource_id
|
7177
7247
|
# The name or unique identifier that corresponds to a physical
|
7178
|
-
# instance ID of a resource supported by
|
7248
|
+
# instance ID of a resource supported by CloudFormation.
|
7179
7249
|
# @return [String]
|
7180
7250
|
#
|
7181
7251
|
# @!attribute [rw] resource_type
|
7182
|
-
# Type of resource. (For more information, go to [
|
7183
|
-
# Reference][1] in the
|
7252
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
7253
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
7184
7254
|
#
|
7185
7255
|
#
|
7186
7256
|
#
|
@@ -7255,12 +7325,12 @@ module Aws::CloudFormation
|
|
7255
7325
|
#
|
7256
7326
|
# @!attribute [rw] physical_resource_id
|
7257
7327
|
# The name or unique identifier that corresponds to a physical
|
7258
|
-
# instance ID of a resource supported by
|
7328
|
+
# instance ID of a resource supported by CloudFormation.
|
7259
7329
|
# @return [String]
|
7260
7330
|
#
|
7261
7331
|
# @!attribute [rw] resource_type
|
7262
|
-
# Type of resource. ((For more information, go to [
|
7263
|
-
# Reference][1] in the
|
7332
|
+
# Type of resource. ((For more information, go to [Amazon Web Services
|
7333
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
7264
7334
|
#
|
7265
7335
|
#
|
7266
7336
|
#
|
@@ -7285,7 +7355,7 @@ module Aws::CloudFormation
|
|
7285
7355
|
#
|
7286
7356
|
# @!attribute [rw] metadata
|
7287
7357
|
# The content of the `Metadata` attribute declared for the resource.
|
7288
|
-
# For more information, see [Metadata Attribute][1] in the
|
7358
|
+
# For more information, see [Metadata Attribute][1] in the
|
7289
7359
|
# CloudFormation User Guide.
|
7290
7360
|
#
|
7291
7361
|
#
|
@@ -7332,10 +7402,10 @@ module Aws::CloudFormation
|
|
7332
7402
|
|
7333
7403
|
# Contains the drift information for a resource that has been checked
|
7334
7404
|
# for drift. This includes actual and expected property values for
|
7335
|
-
# resources in which
|
7336
|
-
#
|
7337
|
-
#
|
7338
|
-
#
|
7405
|
+
# resources in which CloudFormation has detected drift. Only resource
|
7406
|
+
# properties explicitly defined in the stack template are checked for
|
7407
|
+
# drift. For more information, see [Detecting Unregulated Configuration
|
7408
|
+
# Changes to Stacks and Resources][1].
|
7339
7409
|
#
|
7340
7410
|
# Resources that do not currently support drift detection cannot be
|
7341
7411
|
# checked. For a list of resources that support drift detection, see
|
@@ -7360,14 +7430,14 @@ module Aws::CloudFormation
|
|
7360
7430
|
#
|
7361
7431
|
# @!attribute [rw] physical_resource_id
|
7362
7432
|
# The name or unique identifier that corresponds to a physical
|
7363
|
-
# instance ID of a resource supported by
|
7433
|
+
# instance ID of a resource supported by CloudFormation.
|
7364
7434
|
# @return [String]
|
7365
7435
|
#
|
7366
7436
|
# @!attribute [rw] physical_resource_id_context
|
7367
|
-
# Context information that enables
|
7368
|
-
#
|
7369
|
-
#
|
7370
|
-
#
|
7437
|
+
# Context information that enables CloudFormation to uniquely identify
|
7438
|
+
# a resource. CloudFormation uses context key-value pairs in cases
|
7439
|
+
# where a resource's logical and physical IDs are not enough to
|
7440
|
+
# uniquely identify that resource. Each context key-value pair
|
7371
7441
|
# specifies a unique resource that contains the targeted resource.
|
7372
7442
|
# @return [Array<Types::PhysicalResourceIdContextKeyValuePair>]
|
7373
7443
|
#
|
@@ -7412,13 +7482,13 @@ module Aws::CloudFormation
|
|
7412
7482
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
7413
7483
|
# expected template configuration.
|
7414
7484
|
#
|
7415
|
-
# * `NOT_CHECKED`\:
|
7485
|
+
# * `NOT_CHECKED`\: CloudFormation does not currently return this
|
7416
7486
|
# value.
|
7417
7487
|
# @return [String]
|
7418
7488
|
#
|
7419
7489
|
# @!attribute [rw] timestamp
|
7420
|
-
# Time at which
|
7421
|
-
#
|
7490
|
+
# Time at which CloudFormation performed drift detection on the stack
|
7491
|
+
# resource.
|
7422
7492
|
# @return [Time]
|
7423
7493
|
#
|
7424
7494
|
# @!attribute [rw] module_info
|
@@ -7458,7 +7528,7 @@ module Aws::CloudFormation
|
|
7458
7528
|
#
|
7459
7529
|
# * `MODIFIED`\: The resource differs from its expected configuration.
|
7460
7530
|
#
|
7461
|
-
# * `NOT_CHECKED`\:
|
7531
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the resource
|
7462
7532
|
# differs from its expected configuration.
|
7463
7533
|
#
|
7464
7534
|
# Any resources that do not currently support drift detection have a
|
@@ -7474,8 +7544,8 @@ module Aws::CloudFormation
|
|
7474
7544
|
# @return [String]
|
7475
7545
|
#
|
7476
7546
|
# @!attribute [rw] last_check_timestamp
|
7477
|
-
# When
|
7478
|
-
#
|
7547
|
+
# When CloudFormation last checked if the resource had drifted from
|
7548
|
+
# its expected configuration.
|
7479
7549
|
# @return [Time]
|
7480
7550
|
#
|
7481
7551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDriftInformation AWS API Documentation
|
@@ -7500,7 +7570,7 @@ module Aws::CloudFormation
|
|
7500
7570
|
#
|
7501
7571
|
# * `MODIFIED`\: The resource differs from its expected configuration.
|
7502
7572
|
#
|
7503
|
-
# * `NOT_CHECKED`\:
|
7573
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked if the resource
|
7504
7574
|
# differs from its expected configuration.
|
7505
7575
|
#
|
7506
7576
|
# Any resources that do not currently support drift detection have a
|
@@ -7510,7 +7580,7 @@ module Aws::CloudFormation
|
|
7510
7580
|
# included in `ResourcesToSkip` will also have a status of
|
7511
7581
|
# `NOT_CHECKED`. For more information on skipping resources during
|
7512
7582
|
# rollback operations, see [Continue Rolling Back an Update][2] in
|
7513
|
-
# the
|
7583
|
+
# the CloudFormation User Guide.
|
7514
7584
|
#
|
7515
7585
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
7516
7586
|
# expected configuration.
|
@@ -7522,8 +7592,8 @@ module Aws::CloudFormation
|
|
7522
7592
|
# @return [String]
|
7523
7593
|
#
|
7524
7594
|
# @!attribute [rw] last_check_timestamp
|
7525
|
-
# When
|
7526
|
-
#
|
7595
|
+
# When CloudFormation last checked if the resource had drifted from
|
7596
|
+
# its expected configuration.
|
7527
7597
|
# @return [Time]
|
7528
7598
|
#
|
7529
7599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDriftInformationSummary AWS API Documentation
|
@@ -7547,8 +7617,8 @@ module Aws::CloudFormation
|
|
7547
7617
|
# @return [String]
|
7548
7618
|
#
|
7549
7619
|
# @!attribute [rw] resource_type
|
7550
|
-
# Type of resource. (For more information, go to [
|
7551
|
-
# Reference][1] in the
|
7620
|
+
# Type of resource. (For more information, go to [Amazon Web Services
|
7621
|
+
# Resource Types Reference][1] in the CloudFormation User Guide.)
|
7552
7622
|
#
|
7553
7623
|
#
|
7554
7624
|
#
|
@@ -7601,10 +7671,10 @@ module Aws::CloudFormation
|
|
7601
7671
|
end
|
7602
7672
|
|
7603
7673
|
# A structure that contains information about a stack set. A stack set
|
7604
|
-
# enables you to provision stacks into
|
7605
|
-
#
|
7606
|
-
#
|
7607
|
-
#
|
7674
|
+
# enables you to provision stacks into accounts and across Regions by
|
7675
|
+
# using a single CloudFormation template. In the stack set, you specify
|
7676
|
+
# the template to use, as well as any parameters and capabilities that
|
7677
|
+
# the template requires.
|
7608
7678
|
#
|
7609
7679
|
# @!attribute [rw] stack_set_name
|
7610
7680
|
# The name that's associated with the stack set.
|
@@ -7635,9 +7705,9 @@ module Aws::CloudFormation
|
|
7635
7705
|
# @!attribute [rw] capabilities
|
7636
7706
|
# The capabilities that are allowed in the stack set. Some stack set
|
7637
7707
|
# templates might include resources that can affect permissions in
|
7638
|
-
# your
|
7639
|
-
#
|
7640
|
-
#
|
7708
|
+
# your account—for example, by creating new Identity and Access
|
7709
|
+
# Management (IAM) users. For more information, see [Acknowledging IAM
|
7710
|
+
# Resources in CloudFormation Templates.][1]
|
7641
7711
|
#
|
7642
7712
|
#
|
7643
7713
|
#
|
@@ -7660,8 +7730,8 @@ module Aws::CloudFormation
|
|
7660
7730
|
# Use customized administrator roles to control which users or groups
|
7661
7731
|
# can manage specific stack sets within the same administrator
|
7662
7732
|
# account. For more information, see [Prerequisites: Granting
|
7663
|
-
# Permissions for Stack Set Operations][1] in the *
|
7664
|
-
#
|
7733
|
+
# Permissions for Stack Set Operations][1] in the *CloudFormation User
|
7734
|
+
# Guide*.
|
7665
7735
|
#
|
7666
7736
|
#
|
7667
7737
|
#
|
@@ -7686,8 +7756,8 @@ module Aws::CloudFormation
|
|
7686
7756
|
#
|
7687
7757
|
# @!attribute [rw] auto_deployment
|
7688
7758
|
# \[Service-managed permissions\] Describes whether StackSets
|
7689
|
-
# automatically deploys to
|
7690
|
-
#
|
7759
|
+
# automatically deploys to Organizations accounts that are added to a
|
7760
|
+
# target organization or organizational unit (OU).
|
7691
7761
|
# @return [Types::AutoDeployment]
|
7692
7762
|
#
|
7693
7763
|
# @!attribute [rw] permission_model
|
@@ -7701,8 +7771,8 @@ module Aws::CloudFormation
|
|
7701
7771
|
#
|
7702
7772
|
# * With `service-managed` permissions, StackSets automatically
|
7703
7773
|
# creates the IAM roles required to deploy to accounts managed by
|
7704
|
-
#
|
7705
|
-
#
|
7774
|
+
# Organizations. For more information, see [Grant Service-Managed
|
7775
|
+
# Stack Set Permissions][2].
|
7706
7776
|
#
|
7707
7777
|
#
|
7708
7778
|
#
|
@@ -7752,7 +7822,7 @@ module Aws::CloudFormation
|
|
7752
7822
|
# currently being performed on the stack set.
|
7753
7823
|
#
|
7754
7824
|
# For more information, see [Detecting Unmanaged Changes in Stack
|
7755
|
-
# Sets][1] in the *
|
7825
|
+
# Sets][1] in the *CloudFormation User Guide*.
|
7756
7826
|
#
|
7757
7827
|
#
|
7758
7828
|
#
|
@@ -7770,8 +7840,8 @@ module Aws::CloudFormation
|
|
7770
7840
|
# configuration. A stack instance is considered to have drifted if
|
7771
7841
|
# one or more of the resources in the associated stack have drifted.
|
7772
7842
|
#
|
7773
|
-
# * `NOT_CHECKED`\:
|
7774
|
-
#
|
7843
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked the stack set for
|
7844
|
+
# drift.
|
7775
7845
|
#
|
7776
7846
|
# * `IN_SYNC`\: All of the stack instances belonging to the stack set
|
7777
7847
|
# stack match from the expected template and parameter
|
@@ -7896,14 +7966,13 @@ module Aws::CloudFormation
|
|
7896
7966
|
# If the number of failed stacks within a Region exceeds the failure
|
7897
7967
|
# tolerance, the status of the operation in the Region is set to
|
7898
7968
|
# `FAILED`. This in turn sets the status of the operation as a whole
|
7899
|
-
# to `FAILED`, and
|
7969
|
+
# to `FAILED`, and CloudFormation cancels the operation in any
|
7900
7970
|
# remaining Regions.
|
7901
7971
|
#
|
7902
7972
|
# * `QUEUED`\: \[Service-managed permissions\] For automatic
|
7903
7973
|
# deployments that require a sequence of operations, the operation
|
7904
7974
|
# is queued to be performed. For more information, see the [stack
|
7905
|
-
# set operation status codes][1] in the
|
7906
|
-
# Guide.
|
7975
|
+
# set operation status codes][1] in the CloudFormation User Guide.
|
7907
7976
|
#
|
7908
7977
|
# * `RUNNING`\: The operation is currently being performed.
|
7909
7978
|
#
|
@@ -7922,7 +7991,7 @@ module Aws::CloudFormation
|
|
7922
7991
|
# @return [String]
|
7923
7992
|
#
|
7924
7993
|
# @!attribute [rw] operation_preferences
|
7925
|
-
# The preferences for how
|
7994
|
+
# The preferences for how CloudFormation performs this stack set
|
7926
7995
|
# operation.
|
7927
7996
|
# @return [Types::StackSetOperationPreferences]
|
7928
7997
|
#
|
@@ -7940,7 +8009,7 @@ module Aws::CloudFormation
|
|
7940
8009
|
# Use customized administrator roles to control which users or groups
|
7941
8010
|
# can manage specific stack sets within the same administrator
|
7942
8011
|
# account. For more information, see [Define Permissions for Multiple
|
7943
|
-
# Administrators][1] in the *
|
8012
|
+
# Administrators][1] in the *CloudFormation User Guide*.
|
7944
8013
|
#
|
7945
8014
|
#
|
7946
8015
|
#
|
@@ -7959,9 +8028,9 @@ module Aws::CloudFormation
|
|
7959
8028
|
# The time at which the operation was initiated. Note that the
|
7960
8029
|
# creation times for the stack set operation might differ from the
|
7961
8030
|
# creation time of the individual stacks themselves. This is because
|
7962
|
-
#
|
7963
|
-
#
|
7964
|
-
#
|
8031
|
+
# CloudFormation needs to perform preparatory work for the operation,
|
8032
|
+
# such as dispatching the work to the requested Regions, before
|
8033
|
+
# actually creating the first stacks.
|
7965
8034
|
# @return [Time]
|
7966
8035
|
#
|
7967
8036
|
# @!attribute [rw] end_timestamp
|
@@ -7972,8 +8041,8 @@ module Aws::CloudFormation
|
|
7972
8041
|
# @return [Time]
|
7973
8042
|
#
|
7974
8043
|
# @!attribute [rw] deployment_targets
|
7975
|
-
# \[Service-managed permissions\] The
|
7976
|
-
#
|
8044
|
+
# \[Service-managed permissions\] The Organizations accounts affected
|
8045
|
+
# by the stack operation.
|
7977
8046
|
# @return [Types::DeploymentTargets]
|
7978
8047
|
#
|
7979
8048
|
# @!attribute [rw] stack_set_drift_detection_details
|
@@ -7985,7 +8054,7 @@ module Aws::CloudFormation
|
|
7985
8054
|
# `Action` type is `DETECT_DRIFT`.
|
7986
8055
|
#
|
7987
8056
|
# For more information, see [Detecting Unmanaged Changes in Stack
|
7988
|
-
# Sets][1] in the
|
8057
|
+
# Sets][1] in the CloudFormation User Guide.
|
7989
8058
|
#
|
7990
8059
|
#
|
7991
8060
|
#
|
@@ -8011,8 +8080,8 @@ module Aws::CloudFormation
|
|
8011
8080
|
include Aws::Structure
|
8012
8081
|
end
|
8013
8082
|
|
8014
|
-
# The user-specified preferences for how
|
8015
|
-
#
|
8083
|
+
# The user-specified preferences for how CloudFormation performs a stack
|
8084
|
+
# set operation.
|
8016
8085
|
#
|
8017
8086
|
# For more information on maximum concurrent accounts and failure
|
8018
8087
|
# tolerance, see [Stack set operation options][1].
|
@@ -8034,8 +8103,8 @@ module Aws::CloudFormation
|
|
8034
8103
|
# }
|
8035
8104
|
#
|
8036
8105
|
# @!attribute [rw] region_concurrency_type
|
8037
|
-
# The concurrency type of deploying StackSets operations in
|
8038
|
-
# could be in parallel or one
|
8106
|
+
# The concurrency type of deploying StackSets operations in Regions,
|
8107
|
+
# could be in parallel or one Region at a time.
|
8039
8108
|
# @return [String]
|
8040
8109
|
#
|
8041
8110
|
# @!attribute [rw] region_order
|
@@ -8045,8 +8114,8 @@ module Aws::CloudFormation
|
|
8045
8114
|
#
|
8046
8115
|
# @!attribute [rw] failure_tolerance_count
|
8047
8116
|
# The number of accounts, per Region, for which this operation can
|
8048
|
-
# fail before
|
8049
|
-
#
|
8117
|
+
# fail before CloudFormation stops the operation in that Region. If
|
8118
|
+
# the operation is stopped in a Region, CloudFormation doesn't
|
8050
8119
|
# attempt the operation in any subsequent Regions.
|
8051
8120
|
#
|
8052
8121
|
# Conditional: You must specify either `FailureToleranceCount` or
|
@@ -8057,14 +8126,12 @@ module Aws::CloudFormation
|
|
8057
8126
|
#
|
8058
8127
|
# @!attribute [rw] failure_tolerance_percentage
|
8059
8128
|
# The percentage of accounts, per Region, for which this stack
|
8060
|
-
# operation can fail before
|
8061
|
-
#
|
8062
|
-
#
|
8063
|
-
# Regions.
|
8129
|
+
# operation can fail before CloudFormation stops the operation in that
|
8130
|
+
# Region. If the operation is stopped in a Region, CloudFormation
|
8131
|
+
# doesn't attempt the operation in any subsequent Regions.
|
8064
8132
|
#
|
8065
8133
|
# When calculating the number of accounts based on the specified
|
8066
|
-
# percentage,
|
8067
|
-
# number.
|
8134
|
+
# percentage, CloudFormation rounds *down* to the next whole number.
|
8068
8135
|
#
|
8069
8136
|
# Conditional: You must specify either `FailureToleranceCount` or
|
8070
8137
|
# `FailureTolerancePercentage`, but not both.
|
@@ -8094,7 +8161,7 @@ module Aws::CloudFormation
|
|
8094
8161
|
# operation at one time.
|
8095
8162
|
#
|
8096
8163
|
# When calculating the number of accounts based on the specified
|
8097
|
-
# percentage,
|
8164
|
+
# percentage, CloudFormation rounds down to the next whole number.
|
8098
8165
|
# This is true except in cases where rounding down would result is
|
8099
8166
|
# zero. In this case, CloudFormation sets the number as one instead.
|
8100
8167
|
#
|
@@ -8126,12 +8193,12 @@ module Aws::CloudFormation
|
|
8126
8193
|
# results for a given account in a given Region.
|
8127
8194
|
#
|
8128
8195
|
# @!attribute [rw] account
|
8129
|
-
# \[Self-managed permissions\] The name of the
|
8196
|
+
# \[Self-managed permissions\] The name of the account for this
|
8130
8197
|
# operation result.
|
8131
8198
|
# @return [String]
|
8132
8199
|
#
|
8133
8200
|
# @!attribute [rw] region
|
8134
|
-
# The name of the
|
8201
|
+
# The name of the Region for this operation result.
|
8135
8202
|
# @return [String]
|
8136
8203
|
#
|
8137
8204
|
# @!attribute [rw] status
|
@@ -8165,9 +8232,8 @@ module Aws::CloudFormation
|
|
8165
8232
|
# @return [String]
|
8166
8233
|
#
|
8167
8234
|
# @!attribute [rw] account_gate_result
|
8168
|
-
# The results of the account gate function
|
8169
|
-
#
|
8170
|
-
# account
|
8235
|
+
# The results of the account gate function CloudFormation invokes, if
|
8236
|
+
# present, before proceeding with stack set operations in an account
|
8171
8237
|
# @return [Types::AccountGateResult]
|
8172
8238
|
#
|
8173
8239
|
# @!attribute [rw] organizational_unit_id
|
@@ -8217,14 +8283,13 @@ module Aws::CloudFormation
|
|
8217
8283
|
# If the number of failed stacks within a Region exceeds the failure
|
8218
8284
|
# tolerance, the status of the operation in the Region is set to
|
8219
8285
|
# `FAILED`. This in turn sets the status of the operation as a whole
|
8220
|
-
# to `FAILED`, and
|
8286
|
+
# to `FAILED`, and CloudFormation cancels the operation in any
|
8221
8287
|
# remaining Regions.
|
8222
8288
|
#
|
8223
8289
|
# * `QUEUED`\: \[Service-managed permissions\] For automatic
|
8224
8290
|
# deployments that require a sequence of operations, the operation
|
8225
8291
|
# is queued to be performed. For more information, see the [stack
|
8226
|
-
# set operation status codes][1] in the
|
8227
|
-
# Guide.
|
8292
|
+
# set operation status codes][1] in the CloudFormation User Guide.
|
8228
8293
|
#
|
8229
8294
|
# * `RUNNING`\: The operation is currently being performed.
|
8230
8295
|
#
|
@@ -8246,9 +8311,9 @@ module Aws::CloudFormation
|
|
8246
8311
|
# The time at which the operation was initiated. Note that the
|
8247
8312
|
# creation times for the stack set operation might differ from the
|
8248
8313
|
# creation time of the individual stacks themselves. This is because
|
8249
|
-
#
|
8250
|
-
#
|
8251
|
-
#
|
8314
|
+
# CloudFormation needs to perform preparatory work for the operation,
|
8315
|
+
# such as dispatching the work to the requested Regions, before
|
8316
|
+
# actually creating the first stacks.
|
8252
8317
|
# @return [Time]
|
8253
8318
|
#
|
8254
8319
|
# @!attribute [rw] end_timestamp
|
@@ -8292,8 +8357,8 @@ module Aws::CloudFormation
|
|
8292
8357
|
#
|
8293
8358
|
# @!attribute [rw] auto_deployment
|
8294
8359
|
# \[Service-managed permissions\] Describes whether StackSets
|
8295
|
-
# automatically deploys to
|
8296
|
-
#
|
8360
|
+
# automatically deploys to Organizations accounts that are added to a
|
8361
|
+
# target organizational unit (OU).
|
8297
8362
|
# @return [Types::AutoDeployment]
|
8298
8363
|
#
|
8299
8364
|
# @!attribute [rw] permission_model
|
@@ -8307,8 +8372,8 @@ module Aws::CloudFormation
|
|
8307
8372
|
#
|
8308
8373
|
# * With `service-managed` permissions, StackSets automatically
|
8309
8374
|
# creates the IAM roles required to deploy to accounts managed by
|
8310
|
-
#
|
8311
|
-
#
|
8375
|
+
# Organizations. For more information, see [Grant Service-Managed
|
8376
|
+
# Stack Set Permissions][2].
|
8312
8377
|
#
|
8313
8378
|
#
|
8314
8379
|
#
|
@@ -8328,8 +8393,8 @@ module Aws::CloudFormation
|
|
8328
8393
|
# configuration. A stack instance is considered to have drifted if
|
8329
8394
|
# one or more of the resources in the associated stack have drifted.
|
8330
8395
|
#
|
8331
|
-
# * `NOT_CHECKED`\:
|
8332
|
-
#
|
8396
|
+
# * `NOT_CHECKED`\: CloudFormation has not checked the stack set for
|
8397
|
+
# drift.
|
8333
8398
|
#
|
8334
8399
|
# * `IN_SYNC`\: All of the stack instances belonging to the stack set
|
8335
8400
|
# stack match from the expected template and parameter
|
@@ -8401,7 +8466,7 @@ module Aws::CloudFormation
|
|
8401
8466
|
# stack.
|
8402
8467
|
#
|
8403
8468
|
# For more information, see [Working with Nested Stacks][1] in the
|
8404
|
-
# *
|
8469
|
+
# *CloudFormation User Guide*.
|
8405
8470
|
#
|
8406
8471
|
#
|
8407
8472
|
#
|
@@ -8414,7 +8479,7 @@ module Aws::CloudFormation
|
|
8414
8479
|
# ultimately belongs.
|
8415
8480
|
#
|
8416
8481
|
# For more information, see [Working with Nested Stacks][1] in the
|
8417
|
-
# *
|
8482
|
+
# *CloudFormation User Guide*.
|
8418
8483
|
#
|
8419
8484
|
#
|
8420
8485
|
#
|
@@ -8489,10 +8554,9 @@ module Aws::CloudFormation
|
|
8489
8554
|
# * If you are signed in to a delegated administrator account, specify
|
8490
8555
|
# `DELEGATED_ADMIN`.
|
8491
8556
|
#
|
8492
|
-
# Your
|
8493
|
-
#
|
8494
|
-
# delegated administrator][1] in the *
|
8495
|
-
# Guide*.
|
8557
|
+
# Your account must be registered as a delegated administrator in
|
8558
|
+
# the management account. For more information, see [Register a
|
8559
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
8496
8560
|
#
|
8497
8561
|
#
|
8498
8562
|
#
|
@@ -8514,7 +8578,7 @@ module Aws::CloudFormation
|
|
8514
8578
|
class StopStackSetOperationOutput < Aws::EmptyStructure; end
|
8515
8579
|
|
8516
8580
|
# The Tag type enables you to specify a key-value pair that can be used
|
8517
|
-
# to store information about an
|
8581
|
+
# to store information about an CloudFormation stack.
|
8518
8582
|
#
|
8519
8583
|
# @note When making an API call, you may pass Tag
|
8520
8584
|
# data as a hash:
|
@@ -8527,7 +8591,7 @@ module Aws::CloudFormation
|
|
8527
8591
|
# @!attribute [rw] key
|
8528
8592
|
# *Required*. A string used to identify this tag. You can specify a
|
8529
8593
|
# maximum of 128 characters for a tag key. Tags owned by Amazon Web
|
8530
|
-
# Services (
|
8594
|
+
# Services (Amazon Web Services) have the reserved prefix: `aws:`.
|
8531
8595
|
# @return [String]
|
8532
8596
|
#
|
8533
8597
|
# @!attribute [rw] value
|
@@ -8630,8 +8694,8 @@ module Aws::CloudFormation
|
|
8630
8694
|
# * PutObject
|
8631
8695
|
#
|
8632
8696
|
# For more information, see [Actions, Resources, and Condition Keys
|
8633
|
-
# for Amazon S3][1] in the *
|
8634
|
-
# Guide*.
|
8697
|
+
# for Amazon S3][1] in the *Amazon Web Services Identity and Access
|
8698
|
+
# Management User Guide*.
|
8635
8699
|
#
|
8636
8700
|
#
|
8637
8701
|
#
|
@@ -9151,7 +9215,7 @@ module Aws::CloudFormation
|
|
9151
9215
|
# @!attribute [rw] template_body
|
9152
9216
|
# Structure containing the template body with a minimum length of 1
|
9153
9217
|
# byte and a maximum length of 51,200 bytes. (For more information, go
|
9154
|
-
# to [Template Anatomy][1] in the
|
9218
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.)
|
9155
9219
|
#
|
9156
9220
|
# Conditional: You must specify only one of the following parameters:
|
9157
9221
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -9166,7 +9230,7 @@ module Aws::CloudFormation
|
|
9166
9230
|
# Location of file containing the template body. The URL must point to
|
9167
9231
|
# a template that is located in an Amazon S3 bucket or a Systems
|
9168
9232
|
# Manager document. For more information, go to [Template Anatomy][1]
|
9169
|
-
# in the
|
9233
|
+
# in the CloudFormation User Guide.
|
9170
9234
|
#
|
9171
9235
|
# Conditional: You must specify only one of the following parameters:
|
9172
9236
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -9221,15 +9285,15 @@ module Aws::CloudFormation
|
|
9221
9285
|
#
|
9222
9286
|
# @!attribute [rw] capabilities
|
9223
9287
|
# In some cases, you must explicitly acknowledge that your stack
|
9224
|
-
# template contains certain capabilities in order for
|
9225
|
-
#
|
9288
|
+
# template contains certain capabilities in order for CloudFormation
|
9289
|
+
# to update the stack.
|
9226
9290
|
#
|
9227
9291
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
9228
9292
|
#
|
9229
9293
|
# Some stack templates might include resources that can affect
|
9230
|
-
# permissions in your
|
9231
|
-
#
|
9232
|
-
#
|
9294
|
+
# permissions in your account; for example, by creating new Identity
|
9295
|
+
# and Access Management (IAM) users. For those stacks, you must
|
9296
|
+
# explicitly acknowledge this by specifying one of these
|
9233
9297
|
# capabilities.
|
9234
9298
|
#
|
9235
9299
|
# The following IAM resources require you to specify either the
|
@@ -9240,7 +9304,7 @@ module Aws::CloudFormation
|
|
9240
9304
|
# * If you have IAM resources with custom names, you *must* specify
|
9241
9305
|
# `CAPABILITY_NAMED_IAM`.
|
9242
9306
|
#
|
9243
|
-
# * If you don't specify either of these capabilities,
|
9307
|
+
# * If you don't specify either of these capabilities,
|
9244
9308
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
9245
9309
|
#
|
9246
9310
|
# If your stack template contains these resources, we recommend that
|
@@ -9261,7 +9325,7 @@ module Aws::CloudFormation
|
|
9261
9325
|
#
|
9262
9326
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
9263
9327
|
#
|
9264
|
-
# For more information, see [Acknowledging IAM Resources in
|
9328
|
+
# For more information, see [Acknowledging IAM Resources in
|
9265
9329
|
# CloudFormation Templates][8].
|
9266
9330
|
#
|
9267
9331
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -9277,7 +9341,7 @@ module Aws::CloudFormation
|
|
9277
9341
|
# reviewing the resulting changes in a change set, you must
|
9278
9342
|
# acknowledge this capability. This includes the [AWS::Include][9]
|
9279
9343
|
# and [AWS::Serverless][10] transforms, which are macros hosted by
|
9280
|
-
#
|
9344
|
+
# CloudFormation.
|
9281
9345
|
#
|
9282
9346
|
# If you want to update a stack from a stack template that contains
|
9283
9347
|
# macros *and* nested stacks, you must update the stack directly
|
@@ -9288,11 +9352,11 @@ module Aws::CloudFormation
|
|
9288
9352
|
#
|
9289
9353
|
# Each macro relies on an underlying Lambda service function for
|
9290
9354
|
# processing stack templates. Be aware that the Lambda function
|
9291
|
-
# owner can update the function operation without
|
9355
|
+
# owner can update the function operation without CloudFormation
|
9292
9356
|
# being notified.
|
9293
9357
|
#
|
9294
|
-
# For more information, see [Using
|
9295
|
-
#
|
9358
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
9359
|
+
# Custom Processing on Templates][11].
|
9296
9360
|
#
|
9297
9361
|
#
|
9298
9362
|
#
|
@@ -9315,12 +9379,11 @@ module Aws::CloudFormation
|
|
9315
9379
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
9316
9380
|
#
|
9317
9381
|
# If the list of resource types doesn't include a resource that
|
9318
|
-
# you're updating, the stack update fails. By default,
|
9319
|
-
#
|
9320
|
-
#
|
9321
|
-
#
|
9322
|
-
#
|
9323
|
-
# Management][1].
|
9382
|
+
# you're updating, the stack update fails. By default, CloudFormation
|
9383
|
+
# grants permissions to all resource types. Identity and Access
|
9384
|
+
# Management (IAM) uses this parameter for CloudFormation-specific
|
9385
|
+
# condition keys in IAM policies. For more information, see
|
9386
|
+
# [Controlling Access with Identity and Access Management][1].
|
9324
9387
|
#
|
9325
9388
|
#
|
9326
9389
|
#
|
@@ -9328,23 +9391,23 @@ module Aws::CloudFormation
|
|
9328
9391
|
# @return [Array<String>]
|
9329
9392
|
#
|
9330
9393
|
# @!attribute [rw] role_arn
|
9331
|
-
# The Amazon Resource Name (ARN) of an
|
9332
|
-
#
|
9333
|
-
#
|
9334
|
-
#
|
9335
|
-
#
|
9336
|
-
#
|
9337
|
-
#
|
9338
|
-
#
|
9394
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
9395
|
+
# (IAM) role that CloudFormation assumes to update the stack.
|
9396
|
+
# CloudFormation uses the role's credentials to make calls on your
|
9397
|
+
# behalf. CloudFormation always uses this role for all future
|
9398
|
+
# operations on the stack. As long as users have permission to operate
|
9399
|
+
# on the stack, CloudFormation uses this role even if the users don't
|
9400
|
+
# have permission to pass it. Ensure that the role grants least
|
9401
|
+
# privilege.
|
9339
9402
|
#
|
9340
|
-
# If you don't specify a value,
|
9341
|
-
#
|
9342
|
-
#
|
9343
|
-
#
|
9403
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
9404
|
+
# previously associated with the stack. If no role is available,
|
9405
|
+
# CloudFormation uses a temporary session that is generated from your
|
9406
|
+
# user credentials.
|
9344
9407
|
# @return [String]
|
9345
9408
|
#
|
9346
9409
|
# @!attribute [rw] rollback_configuration
|
9347
|
-
# The rollback triggers for
|
9410
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
9348
9411
|
# creation and updating operations, and for the specified monitoring
|
9349
9412
|
# period afterwards.
|
9350
9413
|
# @return [Types::RollbackConfiguration]
|
@@ -9374,26 +9437,26 @@ module Aws::CloudFormation
|
|
9374
9437
|
#
|
9375
9438
|
# @!attribute [rw] notification_arns
|
9376
9439
|
# Amazon Simple Notification Service topic Amazon Resource Names
|
9377
|
-
# (ARNs) that
|
9440
|
+
# (ARNs) that CloudFormation associates with the stack. Specify an
|
9378
9441
|
# empty list to remove all notification topics.
|
9379
9442
|
# @return [Array<String>]
|
9380
9443
|
#
|
9381
9444
|
# @!attribute [rw] tags
|
9382
|
-
# Key-value pairs to associate with this stack.
|
9383
|
-
#
|
9384
|
-
#
|
9445
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
9446
|
+
# propagates these tags to supported resources in the stack. You can
|
9447
|
+
# specify a maximum number of 50 tags.
|
9385
9448
|
#
|
9386
|
-
# If you don't specify this parameter,
|
9387
|
-
#
|
9388
|
-
#
|
9449
|
+
# If you don't specify this parameter, CloudFormation doesn't modify
|
9450
|
+
# the stack's tags. If you specify an empty value, CloudFormation
|
9451
|
+
# removes all associated tags.
|
9389
9452
|
# @return [Array<Types::Tag>]
|
9390
9453
|
#
|
9391
9454
|
# @!attribute [rw] client_request_token
|
9392
9455
|
# A unique identifier for this `UpdateStack` request. Specify this
|
9393
|
-
# token if you plan to retry requests so that
|
9456
|
+
# token if you plan to retry requests so that CloudFormation knows
|
9394
9457
|
# that you're not attempting to update a stack with the same name.
|
9395
|
-
# You might retry `UpdateStack` requests to ensure that
|
9396
|
-
#
|
9458
|
+
# You might retry `UpdateStack` requests to ensure that CloudFormation
|
9459
|
+
# successfully received them.
|
9397
9460
|
#
|
9398
9461
|
# All events triggered by a given stack operation are assigned the
|
9399
9462
|
# same client request token, which you can use to track operations.
|
@@ -9471,19 +9534,19 @@ module Aws::CloudFormation
|
|
9471
9534
|
# @return [String]
|
9472
9535
|
#
|
9473
9536
|
# @!attribute [rw] accounts
|
9474
|
-
# \[Self-managed permissions\] The names of one or more
|
9475
|
-
#
|
9476
|
-
#
|
9477
|
-
#
|
9537
|
+
# \[Self-managed permissions\] The names of one or more accounts for
|
9538
|
+
# which you want to update parameter values for stack instances. The
|
9539
|
+
# overridden parameter values will be applied to all stack instances
|
9540
|
+
# in the specified accounts and Regions.
|
9478
9541
|
#
|
9479
9542
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
9480
9543
|
# @return [Array<String>]
|
9481
9544
|
#
|
9482
9545
|
# @!attribute [rw] deployment_targets
|
9483
|
-
# \[Service-managed permissions\] The
|
9484
|
-
#
|
9485
|
-
#
|
9486
|
-
#
|
9546
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
9547
|
+
# you want to update parameter values for stack instances. If your
|
9548
|
+
# update targets OUs, the overridden parameter values only apply to
|
9549
|
+
# the accounts that are currently in the target OUs and their child
|
9487
9550
|
# OUs. Accounts added to the target OUs and their child OUs in the
|
9488
9551
|
# future won't use the overridden values.
|
9489
9552
|
#
|
@@ -9503,24 +9566,19 @@ module Aws::CloudFormation
|
|
9503
9566
|
#
|
9504
9567
|
# Any overridden parameter values will be applied to all stack
|
9505
9568
|
# instances in the specified accounts and Regions. When specifying
|
9506
|
-
# parameters and their values, be aware of how
|
9569
|
+
# parameters and their values, be aware of how CloudFormation sets
|
9507
9570
|
# parameter values during stack instance update operations:
|
9508
9571
|
#
|
9509
9572
|
# * To override the current value for a parameter, include the
|
9510
9573
|
# parameter and specify its value.
|
9511
9574
|
#
|
9512
|
-
# * To leave
|
9513
|
-
# the
|
9514
|
-
#
|
9515
|
-
# * Do not include the parameter in the list.
|
9575
|
+
# * To leave an overridden parameter set to its present value, include
|
9576
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You
|
9577
|
+
# cannot specify both a value and set `UsePreviousValue` to `true`.)
|
9516
9578
|
#
|
9517
|
-
#
|
9518
|
-
#
|
9519
|
-
#
|
9520
|
-
#
|
9521
|
-
# * To set all overridden parameter back to the values specified in
|
9522
|
-
# the stack set, specify a parameter list but do not include any
|
9523
|
-
# parameters.
|
9579
|
+
# * To set an overridden parameter back to the value specified in the
|
9580
|
+
# stack set, specify a parameter list but do not include the
|
9581
|
+
# parameter in the list.
|
9524
9582
|
#
|
9525
9583
|
# * To leave all parameters set to their present values, do not
|
9526
9584
|
# specify this property at all.
|
@@ -9544,7 +9602,7 @@ module Aws::CloudFormation
|
|
9544
9602
|
# @return [Array<Types::Parameter>]
|
9545
9603
|
#
|
9546
9604
|
# @!attribute [rw] operation_preferences
|
9547
|
-
# Preferences for how
|
9605
|
+
# Preferences for how CloudFormation performs this stack set
|
9548
9606
|
# operation.
|
9549
9607
|
# @return [Types::StackSetOperationPreferences]
|
9550
9608
|
#
|
@@ -9552,10 +9610,10 @@ module Aws::CloudFormation
|
|
9552
9610
|
# The unique identifier for this stack set operation.
|
9553
9611
|
#
|
9554
9612
|
# The operation ID also functions as an idempotency token, to ensure
|
9555
|
-
# that
|
9556
|
-
#
|
9557
|
-
#
|
9558
|
-
#
|
9613
|
+
# that CloudFormation performs the stack set operation only once, even
|
9614
|
+
# if you retry the request multiple times. You might retry stack set
|
9615
|
+
# operation requests to ensure that CloudFormation successfully
|
9616
|
+
# received them.
|
9559
9617
|
#
|
9560
9618
|
# If you don't specify an operation ID, the SDK generates one
|
9561
9619
|
# automatically.
|
@@ -9577,10 +9635,9 @@ module Aws::CloudFormation
|
|
9577
9635
|
# * If you are signed in to a delegated administrator account, specify
|
9578
9636
|
# `DELEGATED_ADMIN`.
|
9579
9637
|
#
|
9580
|
-
# Your
|
9581
|
-
#
|
9582
|
-
# delegated administrator][1] in the *
|
9583
|
-
# Guide*.
|
9638
|
+
# Your account must be registered as a delegated administrator in
|
9639
|
+
# the management account. For more information, see [Register a
|
9640
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
9584
9641
|
#
|
9585
9642
|
#
|
9586
9643
|
#
|
@@ -9689,8 +9746,8 @@ module Aws::CloudFormation
|
|
9689
9746
|
# @!attribute [rw] template_body
|
9690
9747
|
# The structure that contains the template body, with a minimum length
|
9691
9748
|
# of 1 byte and a maximum length of 51,200 bytes. For more
|
9692
|
-
# information, see [Template Anatomy][1] in the
|
9693
|
-
#
|
9749
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
9750
|
+
# Guide.
|
9694
9751
|
#
|
9695
9752
|
# Conditional: You must specify only one of the following parameters:
|
9696
9753
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
|
@@ -9705,8 +9762,8 @@ module Aws::CloudFormation
|
|
9705
9762
|
# The location of the file that contains the template body. The URL
|
9706
9763
|
# must point to a template (maximum size: 460,800 bytes) that is
|
9707
9764
|
# located in an Amazon S3 bucket or a Systems Manager document. For
|
9708
|
-
# more information, see [Template Anatomy][1] in the
|
9709
|
-
#
|
9765
|
+
# more information, see [Template Anatomy][1] in the CloudFormation
|
9766
|
+
# User Guide.
|
9710
9767
|
#
|
9711
9768
|
# Conditional: You must specify only one of the following parameters:
|
9712
9769
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
|
@@ -9732,16 +9789,15 @@ module Aws::CloudFormation
|
|
9732
9789
|
#
|
9733
9790
|
# @!attribute [rw] capabilities
|
9734
9791
|
# In some cases, you must explicitly acknowledge that your stack
|
9735
|
-
# template contains certain capabilities in order for
|
9736
|
-
#
|
9737
|
-
# instances.
|
9792
|
+
# template contains certain capabilities in order for CloudFormation
|
9793
|
+
# to update the stack set and its associated stack instances.
|
9738
9794
|
#
|
9739
9795
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
9740
9796
|
#
|
9741
9797
|
# Some stack templates might include resources that can affect
|
9742
|
-
# permissions in your
|
9743
|
-
#
|
9744
|
-
#
|
9798
|
+
# permissions in your account; for example, by creating new Identity
|
9799
|
+
# and Access Management (IAM) users. For those stacks sets, you must
|
9800
|
+
# explicitly acknowledge this by specifying one of these
|
9745
9801
|
# capabilities.
|
9746
9802
|
#
|
9747
9803
|
# The following IAM resources require you to specify either the
|
@@ -9752,7 +9808,7 @@ module Aws::CloudFormation
|
|
9752
9808
|
# * If you have IAM resources with custom names, you *must* specify
|
9753
9809
|
# `CAPABILITY_NAMED_IAM`.
|
9754
9810
|
#
|
9755
|
-
# * If you don't specify either of these capabilities,
|
9811
|
+
# * If you don't specify either of these capabilities,
|
9756
9812
|
# CloudFormation returns an `InsufficientCapabilities` error.
|
9757
9813
|
#
|
9758
9814
|
# If your stack template contains these resources, we recommend that
|
@@ -9773,7 +9829,7 @@ module Aws::CloudFormation
|
|
9773
9829
|
#
|
9774
9830
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
9775
9831
|
#
|
9776
|
-
# For more information, see [Acknowledging IAM Resources in
|
9832
|
+
# For more information, see [Acknowledging IAM Resources in
|
9777
9833
|
# CloudFormation Templates][8].
|
9778
9834
|
#
|
9779
9835
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -9783,13 +9839,13 @@ module Aws::CloudFormation
|
|
9783
9839
|
# directly from the processed template, without first reviewing the
|
9784
9840
|
# resulting changes in a change set. To update the stack set
|
9785
9841
|
# directly, you must acknowledge this capability. For more
|
9786
|
-
# information, see [Using
|
9787
|
-
#
|
9842
|
+
# information, see [Using CloudFormation Macros to Perform Custom
|
9843
|
+
# Processing on Templates][9].
|
9788
9844
|
#
|
9789
9845
|
# Stack sets with service-managed permissions do not currently
|
9790
9846
|
# support the use of macros in templates. (This includes the
|
9791
9847
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
9792
|
-
# macros hosted by
|
9848
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
9793
9849
|
# capability for a stack set with service-managed permissions, if
|
9794
9850
|
# you reference a macro in your template the stack set operation
|
9795
9851
|
# will fail.
|
@@ -9811,7 +9867,7 @@ module Aws::CloudFormation
|
|
9811
9867
|
#
|
9812
9868
|
# @!attribute [rw] tags
|
9813
9869
|
# The key-value pairs to associate with this stack set and the stacks
|
9814
|
-
# created from it.
|
9870
|
+
# created from it. CloudFormation also propagates these tags to
|
9815
9871
|
# supported resources that are created in the stacks. You can specify
|
9816
9872
|
# a maximum number of 50 tags.
|
9817
9873
|
#
|
@@ -9819,7 +9875,7 @@ module Aws::CloudFormation
|
|
9819
9875
|
# of tags that are currently associated with this stack set. This
|
9820
9876
|
# means:
|
9821
9877
|
#
|
9822
|
-
# * If you don't specify this parameter,
|
9878
|
+
# * If you don't specify this parameter, CloudFormation doesn't
|
9823
9879
|
# modify the stack's tags.
|
9824
9880
|
#
|
9825
9881
|
# * If you specify *any* tags using this parameter, you must specify
|
@@ -9830,22 +9886,22 @@ module Aws::CloudFormation
|
|
9830
9886
|
# the stack set, and therefore from the stacks and resources as
|
9831
9887
|
# well.
|
9832
9888
|
#
|
9833
|
-
# * If you specify an empty value,
|
9889
|
+
# * If you specify an empty value, CloudFormation removes all
|
9834
9890
|
# currently associated tags.
|
9835
9891
|
#
|
9836
|
-
# If you specify new tags as part of an `UpdateStackSet` action,
|
9892
|
+
# If you specify new tags as part of an `UpdateStackSet` action,
|
9837
9893
|
# CloudFormation checks to see if you have the required IAM permission
|
9838
9894
|
# to tag resources. If you omit tags that are currently associated
|
9839
|
-
# with the stack set from the list of tags you specify,
|
9840
|
-
#
|
9841
|
-
#
|
9842
|
-
#
|
9843
|
-
#
|
9844
|
-
#
|
9895
|
+
# with the stack set from the list of tags you specify, CloudFormation
|
9896
|
+
# assumes that you want to remove those tags from the stack set, and
|
9897
|
+
# checks to see if you have permission to untag resources. If you
|
9898
|
+
# don't have the necessary permission(s), the entire `UpdateStackSet`
|
9899
|
+
# action fails with an `access denied` error, and the stack set is not
|
9900
|
+
# updated.
|
9845
9901
|
# @return [Array<Types::Tag>]
|
9846
9902
|
#
|
9847
9903
|
# @!attribute [rw] operation_preferences
|
9848
|
-
# Preferences for how
|
9904
|
+
# Preferences for how CloudFormation performs this stack set
|
9849
9905
|
# operation.
|
9850
9906
|
# @return [Types::StackSetOperationPreferences]
|
9851
9907
|
#
|
@@ -9856,8 +9912,8 @@ module Aws::CloudFormation
|
|
9856
9912
|
# Specify an IAM role only if you are using customized administrator
|
9857
9913
|
# roles to control which users or groups can manage specific stack
|
9858
9914
|
# sets within the same administrator account. For more information,
|
9859
|
-
# see [Granting Permissions for Stack Set Operations][1] in the
|
9860
|
-
# CloudFormation User Guide*.
|
9915
|
+
# see [Granting Permissions for Stack Set Operations][1] in the
|
9916
|
+
# *CloudFormation User Guide*.
|
9861
9917
|
#
|
9862
9918
|
# If you specified a customized administrator role when you created
|
9863
9919
|
# the stack set, you must specify a customized administrator role,
|
@@ -9871,7 +9927,7 @@ module Aws::CloudFormation
|
|
9871
9927
|
#
|
9872
9928
|
# @!attribute [rw] execution_role_name
|
9873
9929
|
# The name of the IAM execution role to use to update the stack set.
|
9874
|
-
# If you do not specify an execution role,
|
9930
|
+
# If you do not specify an execution role, CloudFormation uses the
|
9875
9931
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
9876
9932
|
# operation.
|
9877
9933
|
#
|
@@ -9879,29 +9935,28 @@ module Aws::CloudFormation
|
|
9879
9935
|
# to control which stack resources users and groups can include in
|
9880
9936
|
# their stack sets.
|
9881
9937
|
#
|
9882
|
-
# If you specify a customized execution role,
|
9883
|
-
#
|
9884
|
-
# execution role,
|
9885
|
-
#
|
9938
|
+
# If you specify a customized execution role, CloudFormation uses that
|
9939
|
+
# role to update the stack. If you do not specify a customized
|
9940
|
+
# execution role, CloudFormation performs the update using the role
|
9941
|
+
# previously associated with the stack set, so long as you have
|
9886
9942
|
# permissions to perform operations on the stack set.
|
9887
9943
|
# @return [String]
|
9888
9944
|
#
|
9889
9945
|
# @!attribute [rw] deployment_targets
|
9890
|
-
# \[Service-managed permissions\] The
|
9891
|
-
#
|
9946
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
9947
|
+
# to update associated stack instances.
|
9892
9948
|
#
|
9893
9949
|
# To update all the stack instances associated with this stack set, do
|
9894
9950
|
# not specify `DeploymentTargets` or `Regions`.
|
9895
9951
|
#
|
9896
9952
|
# If the stack set update includes changes to the template (that is,
|
9897
9953
|
# if `TemplateBody` or `TemplateURL` is specified), or the
|
9898
|
-
# `Parameters`,
|
9899
|
-
#
|
9900
|
-
#
|
9901
|
-
#
|
9902
|
-
#
|
9903
|
-
#
|
9904
|
-
# instance status.
|
9954
|
+
# `Parameters`, CloudFormation marks all stack instances with a status
|
9955
|
+
# of `OUTDATED` prior to updating the stack instances in the specified
|
9956
|
+
# accounts and Regions. If the stack set update does not include
|
9957
|
+
# changes to the template or parameters, CloudFormation updates the
|
9958
|
+
# stack instances in the specified accounts and Regions, while leaving
|
9959
|
+
# all other stack instances with their existing stack instance status.
|
9905
9960
|
# @return [Types::DeploymentTargets]
|
9906
9961
|
#
|
9907
9962
|
# @!attribute [rw] permission_model
|
@@ -9916,8 +9971,8 @@ module Aws::CloudFormation
|
|
9916
9971
|
#
|
9917
9972
|
# * With `service-managed` permissions, StackSets automatically
|
9918
9973
|
# creates the IAM roles required to deploy to accounts managed by
|
9919
|
-
#
|
9920
|
-
#
|
9974
|
+
# Organizations. For more information, see [Grant Service-Managed
|
9975
|
+
# Stack Set Permissions][2].
|
9921
9976
|
#
|
9922
9977
|
#
|
9923
9978
|
#
|
@@ -9927,8 +9982,8 @@ module Aws::CloudFormation
|
|
9927
9982
|
#
|
9928
9983
|
# @!attribute [rw] auto_deployment
|
9929
9984
|
# \[Service-managed permissions\] Describes whether StackSets
|
9930
|
-
# automatically deploys to
|
9931
|
-
#
|
9985
|
+
# automatically deploys to Organizations accounts that are added to a
|
9986
|
+
# target organization or organizational unit (OU).
|
9932
9987
|
#
|
9933
9988
|
# If you specify `AutoDeployment`, do not specify `DeploymentTargets`
|
9934
9989
|
# or `Regions`.
|
@@ -9938,13 +9993,13 @@ module Aws::CloudFormation
|
|
9938
9993
|
# The unique ID for this stack set operation.
|
9939
9994
|
#
|
9940
9995
|
# The operation ID also functions as an idempotency token, to ensure
|
9941
|
-
# that
|
9942
|
-
#
|
9943
|
-
#
|
9944
|
-
#
|
9996
|
+
# that CloudFormation performs the stack set operation only once, even
|
9997
|
+
# if you retry the request multiple times. You might retry stack set
|
9998
|
+
# operation requests to ensure that CloudFormation successfully
|
9999
|
+
# received them.
|
9945
10000
|
#
|
9946
|
-
# If you don't specify an operation ID,
|
9947
|
-
#
|
10001
|
+
# If you don't specify an operation ID, CloudFormation generates one
|
10002
|
+
# automatically.
|
9948
10003
|
#
|
9949
10004
|
# Repeating this stack set operation with a new operation ID retries
|
9950
10005
|
# all stack instances whose status is `OUTDATED`.
|
@@ -9963,13 +10018,13 @@ module Aws::CloudFormation
|
|
9963
10018
|
#
|
9964
10019
|
# If the stack set update includes changes to the template (that is,
|
9965
10020
|
# if the `TemplateBody` or `TemplateURL` properties are specified), or
|
9966
|
-
# the `Parameters` property,
|
9967
|
-
#
|
9968
|
-
#
|
9969
|
-
#
|
9970
|
-
#
|
9971
|
-
#
|
9972
|
-
#
|
10021
|
+
# the `Parameters` property, CloudFormation marks all stack instances
|
10022
|
+
# with a status of `OUTDATED` prior to updating the stack instances in
|
10023
|
+
# the specified accounts and Regions. If the stack set update does not
|
10024
|
+
# include changes to the template or parameters, CloudFormation
|
10025
|
+
# updates the stack instances in the specified accounts and Regions,
|
10026
|
+
# while leaving all other stack instances with their existing stack
|
10027
|
+
# instance status.
|
9973
10028
|
# @return [Array<String>]
|
9974
10029
|
#
|
9975
10030
|
# @!attribute [rw] regions
|
@@ -9982,13 +10037,13 @@ module Aws::CloudFormation
|
|
9982
10037
|
#
|
9983
10038
|
# If the stack set update includes changes to the template (that is,
|
9984
10039
|
# if the `TemplateBody` or `TemplateURL` properties are specified), or
|
9985
|
-
# the `Parameters` property,
|
9986
|
-
#
|
9987
|
-
#
|
9988
|
-
#
|
9989
|
-
#
|
9990
|
-
#
|
9991
|
-
#
|
10040
|
+
# the `Parameters` property, CloudFormation marks all stack instances
|
10041
|
+
# with a status of `OUTDATED` prior to updating the stack instances in
|
10042
|
+
# the specified accounts and Regions. If the stack set update does not
|
10043
|
+
# include changes to the template or parameters, CloudFormation
|
10044
|
+
# updates the stack instances in the specified accounts and Regions,
|
10045
|
+
# while leaving all other stack instances with their existing stack
|
10046
|
+
# instance status.
|
9992
10047
|
# @return [Array<String>]
|
9993
10048
|
#
|
9994
10049
|
# @!attribute [rw] call_as
|
@@ -10004,10 +10059,9 @@ module Aws::CloudFormation
|
|
10004
10059
|
# * If you are signed in to a delegated administrator account, specify
|
10005
10060
|
# `DELEGATED_ADMIN`.
|
10006
10061
|
#
|
10007
|
-
# Your
|
10008
|
-
#
|
10009
|
-
# delegated administrator][1] in the *
|
10010
|
-
# Guide*.
|
10062
|
+
# Your account must be registered as a delegated administrator in
|
10063
|
+
# the management account. For more information, see [Register a
|
10064
|
+
# delegated administrator][1] in the *CloudFormation User Guide*.
|
10011
10065
|
#
|
10012
10066
|
#
|
10013
10067
|
#
|
@@ -10102,7 +10156,7 @@ module Aws::CloudFormation
|
|
10102
10156
|
# @!attribute [rw] template_body
|
10103
10157
|
# Structure containing the template body with a minimum length of 1
|
10104
10158
|
# byte and a maximum length of 51,200 bytes. For more information, go
|
10105
|
-
# to [Template Anatomy][1] in the
|
10159
|
+
# to [Template Anatomy][1] in the CloudFormation User Guide.
|
10106
10160
|
#
|
10107
10161
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
10108
10162
|
# are passed, only `TemplateBody` is used.
|
@@ -10116,7 +10170,7 @@ module Aws::CloudFormation
|
|
10116
10170
|
# Location of file containing the template body. The URL must point to
|
10117
10171
|
# a template (max size: 460,800 bytes) that is located in an Amazon S3
|
10118
10172
|
# bucket or a Systems Manager document. For more information, go to
|
10119
|
-
# [Template Anatomy][1] in the
|
10173
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
10120
10174
|
#
|
10121
10175
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
10122
10176
|
# are passed, only `TemplateBody` is used.
|
@@ -10152,7 +10206,7 @@ module Aws::CloudFormation
|
|
10152
10206
|
# CreateStack or UpdateStack actions with your template; otherwise,
|
10153
10207
|
# those actions return an InsufficientCapabilities error.
|
10154
10208
|
#
|
10155
|
-
# For more information, see [Acknowledging IAM Resources in
|
10209
|
+
# For more information, see [Acknowledging IAM Resources in
|
10156
10210
|
# CloudFormation Templates][1].
|
10157
10211
|
#
|
10158
10212
|
#
|