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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 642a8c36978ebf152ba0b7df35f3c1e627e0101432269f02eee095dcc3f18f3e
|
|
4
|
+
data.tar.gz: 4573401978788bdecf9a7d29a0e4117bc194e86017bbc24ff29d3bb9ad7103a3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c7025f03f4433653da5cfea4f11d2ac755edee61fa291f5b4036b0c4d1af311d59f95ed0e94aa49f99c97f1bf5905c597f805731e6879329c9835886d944a96c
|
|
7
|
+
data.tar.gz: 3df65c06788d3e4384895b3447c29f37b34030c3ff31dc66ec626aa978bbc43ab150e249053d9f772eb18b0c91370cc3e58b70db39842a9b8faaff621aa1262b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.54.0 (2021-07-28)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - SDK update to support Importing existing Stacks to new/existing Self Managed StackSet - Stack Import feature.
|
|
8
|
+
|
|
4
9
|
1.53.0 (2021-06-21)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.54.0
|
|
@@ -527,10 +527,10 @@ module Aws::CloudFormation
|
|
|
527
527
|
#
|
|
528
528
|
# @option params [String] :client_request_token
|
|
529
529
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
|
530
|
-
# token if you plan to retry requests so that
|
|
531
|
-
#
|
|
532
|
-
#
|
|
533
|
-
#
|
|
530
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
|
531
|
+
# you're not attempting to cancel an update on a stack with the same
|
|
532
|
+
# name. You might retry `CancelUpdateStack` requests to ensure that
|
|
533
|
+
# CloudFormation successfully received them.
|
|
534
534
|
#
|
|
535
535
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
536
536
|
#
|
|
@@ -558,11 +558,11 @@ module Aws::CloudFormation
|
|
|
558
558
|
# `UPDATE_ROLLBACK_COMPLETE` state), and then try to update the stack
|
|
559
559
|
# again.
|
|
560
560
|
#
|
|
561
|
-
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
|
561
|
+
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
|
562
562
|
# CloudFormation cannot roll back all changes after a failed stack
|
|
563
563
|
# update. For example, you might have a stack that is rolling back to an
|
|
564
|
-
# old database instance that was deleted outside of
|
|
565
|
-
# Because
|
|
564
|
+
# old database instance that was deleted outside of CloudFormation.
|
|
565
|
+
# Because CloudFormation doesn't know the database was deleted, it
|
|
566
566
|
# assumes that the database instance still exists and attempts to roll
|
|
567
567
|
# back to it, causing the update rollback to fail.
|
|
568
568
|
#
|
|
@@ -582,33 +582,32 @@ module Aws::CloudFormation
|
|
|
582
582
|
# </note>
|
|
583
583
|
#
|
|
584
584
|
# @option params [String] :role_arn
|
|
585
|
-
# The Amazon Resource Name (ARN) of an
|
|
586
|
-
#
|
|
587
|
-
#
|
|
588
|
-
#
|
|
589
|
-
#
|
|
590
|
-
#
|
|
591
|
-
#
|
|
592
|
-
#
|
|
593
|
-
#
|
|
594
|
-
#
|
|
595
|
-
# was previously associated with the stack. If no role is available, AWS
|
|
585
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
|
586
|
+
# (IAM) role that CloudFormation assumes to roll back the stack.
|
|
587
|
+
# CloudFormation uses the role's credentials to make calls on your
|
|
588
|
+
# behalf. CloudFormation always uses this role for all future operations
|
|
589
|
+
# on the stack. As long as users have permission to operate on the
|
|
590
|
+
# stack, CloudFormation uses this role even if the users don't have
|
|
591
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
|
592
|
+
#
|
|
593
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
|
594
|
+
# previously associated with the stack. If no role is available,
|
|
596
595
|
# CloudFormation uses a temporary session that is generated from your
|
|
597
596
|
# user credentials.
|
|
598
597
|
#
|
|
599
598
|
# @option params [Array<String>] :resources_to_skip
|
|
600
|
-
# A list of the logical IDs of the resources that
|
|
601
|
-
#
|
|
602
|
-
#
|
|
603
|
-
#
|
|
604
|
-
#
|
|
605
|
-
#
|
|
606
|
-
#
|
|
607
|
-
#
|
|
608
|
-
# Specify this property to skip rolling back resources that
|
|
599
|
+
# A list of the logical IDs of the resources that CloudFormation skips
|
|
600
|
+
# during the continue update rollback operation. You can specify only
|
|
601
|
+
# resources that are in the `UPDATE_FAILED` state because a rollback
|
|
602
|
+
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
|
603
|
+
# state for other reasons, for example, because an update was cancelled.
|
|
604
|
+
# To check why a resource update failed, use the DescribeStackResources
|
|
605
|
+
# action, and view the resource status reason.
|
|
606
|
+
#
|
|
607
|
+
# Specify this property to skip rolling back resources that
|
|
609
608
|
# CloudFormation can't successfully roll back. We recommend that you [
|
|
610
|
-
# troubleshoot][1] resources before skipping them.
|
|
611
|
-
#
|
|
609
|
+
# troubleshoot][1] resources before skipping them. CloudFormation sets
|
|
610
|
+
# the status of the specified resources to `UPDATE_COMPLETE` and
|
|
612
611
|
# continues to roll back the stack. After the rollback is complete, the
|
|
613
612
|
# state of the skipped resources will be inconsistent with the state of
|
|
614
613
|
# the resources in the stack template. Before performing another stack
|
|
@@ -642,10 +641,10 @@ module Aws::CloudFormation
|
|
|
642
641
|
#
|
|
643
642
|
# @option params [String] :client_request_token
|
|
644
643
|
# A unique identifier for this `ContinueUpdateRollback` request. Specify
|
|
645
|
-
# this token if you plan to retry requests so that
|
|
646
|
-
#
|
|
647
|
-
#
|
|
648
|
-
#
|
|
644
|
+
# this token if you plan to retry requests so that CloudFormationknows
|
|
645
|
+
# that you're not attempting to continue the rollback to a stack with
|
|
646
|
+
# the same name. You might retry `ContinueUpdateRollback` requests to
|
|
647
|
+
# ensure that CloudFormation successfully received them.
|
|
649
648
|
#
|
|
650
649
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
651
650
|
#
|
|
@@ -671,25 +670,25 @@ module Aws::CloudFormation
|
|
|
671
670
|
# can review the changes before executing them. You can create a change
|
|
672
671
|
# set for a stack that doesn't exist or an existing stack. If you
|
|
673
672
|
# create a change set for a stack that doesn't exist, the change set
|
|
674
|
-
# shows all of the resources that
|
|
675
|
-
# create a change set for an existing stack,
|
|
676
|
-
#
|
|
673
|
+
# shows all of the resources that CloudFormation will create. If you
|
|
674
|
+
# create a change set for an existing stack, CloudFormation compares the
|
|
675
|
+
# stack's information with the information that you submit in the
|
|
677
676
|
# change set and lists the differences. Use change sets to understand
|
|
678
|
-
# which resources
|
|
679
|
-
#
|
|
680
|
-
#
|
|
677
|
+
# which resources CloudFormation will create or change, and how it will
|
|
678
|
+
# change resources in an existing stack, before you create or update a
|
|
679
|
+
# stack.
|
|
681
680
|
#
|
|
682
681
|
# To create a change set for a stack that doesn't exist, for the
|
|
683
682
|
# `ChangeSetType` parameter, specify `CREATE`. To create a change set
|
|
684
683
|
# for an existing stack, specify `UPDATE` for the `ChangeSetType`
|
|
685
684
|
# parameter. To create a change set for an import operation, specify
|
|
686
685
|
# `IMPORT` for the `ChangeSetType` parameter. After the
|
|
687
|
-
# `CreateChangeSet` call successfully completes,
|
|
688
|
-
#
|
|
689
|
-
#
|
|
686
|
+
# `CreateChangeSet` call successfully completes, CloudFormation starts
|
|
687
|
+
# creating the change set. To check the status of the change set or to
|
|
688
|
+
# review it, use the DescribeChangeSet action.
|
|
690
689
|
#
|
|
691
690
|
# When you are satisfied with the changes the change set will make,
|
|
692
|
-
# execute the change set by using the ExecuteChangeSet action.
|
|
691
|
+
# execute the change set by using the ExecuteChangeSet action.
|
|
693
692
|
# CloudFormation doesn't make changes until you execute the change set.
|
|
694
693
|
#
|
|
695
694
|
# To create a change set for the entire stack hierachy, set
|
|
@@ -697,13 +696,13 @@ module Aws::CloudFormation
|
|
|
697
696
|
#
|
|
698
697
|
# @option params [required, String] :stack_name
|
|
699
698
|
# The name or the unique ID of the stack for which you are creating a
|
|
700
|
-
# change set.
|
|
701
|
-
#
|
|
702
|
-
#
|
|
699
|
+
# change set. CloudFormation generates the change set by comparing this
|
|
700
|
+
# stack's information with the information that you submit, such as a
|
|
701
|
+
# modified template or different parameter input values.
|
|
703
702
|
#
|
|
704
703
|
# @option params [String] :template_body
|
|
705
704
|
# A structure that contains the body of the revised template, with a
|
|
706
|
-
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
|
705
|
+
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
|
707
706
|
# CloudFormation generates the change set by comparing this template
|
|
708
707
|
# with the template of the stack that you specified.
|
|
709
708
|
#
|
|
@@ -712,9 +711,9 @@ module Aws::CloudFormation
|
|
|
712
711
|
# @option params [String] :template_url
|
|
713
712
|
# The location of the file that contains the revised template. The URL
|
|
714
713
|
# must point to a template (max size: 460,800 bytes) that is located in
|
|
715
|
-
# an S3 bucket or a Systems Manager document.
|
|
716
|
-
#
|
|
717
|
-
#
|
|
714
|
+
# an S3 bucket or a Systems Manager document. CloudFormation generates
|
|
715
|
+
# the change set by comparing this template with the stack that you
|
|
716
|
+
# specified.
|
|
718
717
|
#
|
|
719
718
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
|
720
719
|
#
|
|
@@ -728,16 +727,15 @@ module Aws::CloudFormation
|
|
|
728
727
|
#
|
|
729
728
|
# @option params [Array<String>] :capabilities
|
|
730
729
|
# In some cases, you must explicitly acknowledge that your stack
|
|
731
|
-
# template contains certain capabilities in order for
|
|
732
|
-
#
|
|
730
|
+
# template contains certain capabilities in order for CloudFormation to
|
|
731
|
+
# create the stack.
|
|
733
732
|
#
|
|
734
733
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
735
734
|
#
|
|
736
735
|
# Some stack templates might include resources that can affect
|
|
737
|
-
# permissions in your
|
|
738
|
-
#
|
|
739
|
-
#
|
|
740
|
-
# capabilities.
|
|
736
|
+
# permissions in your account; for example, by creating new Identity
|
|
737
|
+
# and Access Management (IAM) users. For those stacks, you must
|
|
738
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
|
741
739
|
#
|
|
742
740
|
# The following IAM resources require you to specify either the
|
|
743
741
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
|
@@ -747,8 +745,8 @@ module Aws::CloudFormation
|
|
|
747
745
|
# * If you have IAM resources with custom names, you *must* specify
|
|
748
746
|
# `CAPABILITY_NAMED_IAM`.
|
|
749
747
|
#
|
|
750
|
-
# * If you don't specify either of these capabilities,
|
|
751
|
-
#
|
|
748
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
|
749
|
+
# returns an `InsufficientCapabilities` error.
|
|
752
750
|
#
|
|
753
751
|
# If your stack template contains these resources, we recommend that
|
|
754
752
|
# you review all permissions associated with them and edit their
|
|
@@ -768,7 +766,7 @@ module Aws::CloudFormation
|
|
|
768
766
|
#
|
|
769
767
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
|
770
768
|
#
|
|
771
|
-
# For more information, see [Acknowledging IAM Resources in
|
|
769
|
+
# For more information, see [Acknowledging IAM Resources in
|
|
772
770
|
# CloudFormation Templates][8].
|
|
773
771
|
#
|
|
774
772
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
@@ -783,7 +781,7 @@ module Aws::CloudFormation
|
|
|
783
781
|
# create a stack directly from the processed template, without first
|
|
784
782
|
# reviewing the resulting changes in a change set, you must
|
|
785
783
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
|
786
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
|
784
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
|
787
785
|
# CloudFormation.
|
|
788
786
|
#
|
|
789
787
|
# <note markdown="1"> This capacity does not apply to creating change sets, and specifying
|
|
@@ -796,8 +794,8 @@ module Aws::CloudFormation
|
|
|
796
794
|
#
|
|
797
795
|
# </note>
|
|
798
796
|
#
|
|
799
|
-
# For more information on macros, see [Using
|
|
800
|
-
#
|
|
797
|
+
# For more information on macros, see [Using CloudFormation Macros to
|
|
798
|
+
# Perform Custom Processing on Templates][11].
|
|
801
799
|
#
|
|
802
800
|
#
|
|
803
801
|
#
|
|
@@ -819,44 +817,43 @@ module Aws::CloudFormation
|
|
|
819
817
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
|
820
818
|
#
|
|
821
819
|
# If the list of resource types doesn't include a resource type that
|
|
822
|
-
# you're updating, the stack update fails. By default,
|
|
823
|
-
#
|
|
824
|
-
#
|
|
825
|
-
#
|
|
826
|
-
#
|
|
827
|
-
#
|
|
820
|
+
# you're updating, the stack update fails. By default, CloudFormation
|
|
821
|
+
# grants permissions to all resource types. Identity and Access
|
|
822
|
+
# Management (IAM) uses this parameter for condition keys in IAM
|
|
823
|
+
# policies for CloudFormation. For more information, see [Controlling
|
|
824
|
+
# Access with Identity and Access Management][1] in the CloudFormation
|
|
825
|
+
# User Guide.
|
|
828
826
|
#
|
|
829
827
|
#
|
|
830
828
|
#
|
|
831
829
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
|
832
830
|
#
|
|
833
831
|
# @option params [String] :role_arn
|
|
834
|
-
# The Amazon Resource Name (ARN) of an
|
|
835
|
-
#
|
|
836
|
-
#
|
|
837
|
-
#
|
|
838
|
-
#
|
|
839
|
-
#
|
|
840
|
-
#
|
|
841
|
-
#
|
|
842
|
-
#
|
|
843
|
-
#
|
|
844
|
-
# was previously associated with the stack. If no role is available, AWS
|
|
832
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
|
833
|
+
# (IAM) role that CloudFormation assumes when executing the change set.
|
|
834
|
+
# CloudFormation uses the role's credentials to make calls on your
|
|
835
|
+
# behalf. CloudFormation uses this role for all future operations on the
|
|
836
|
+
# stack. As long as users have permission to operate on the stack,
|
|
837
|
+
# CloudFormation uses this role even if the users don't have permission
|
|
838
|
+
# to pass it. Ensure that the role grants least privilege.
|
|
839
|
+
#
|
|
840
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
|
841
|
+
# previously associated with the stack. If no role is available,
|
|
845
842
|
# CloudFormation uses a temporary session that is generated from your
|
|
846
843
|
# user credentials.
|
|
847
844
|
#
|
|
848
845
|
# @option params [Types::RollbackConfiguration] :rollback_configuration
|
|
849
|
-
# The rollback triggers for
|
|
846
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
|
850
847
|
# creation and updating operations, and for the specified monitoring
|
|
851
848
|
# period afterwards.
|
|
852
849
|
#
|
|
853
850
|
# @option params [Array<String>] :notification_arns
|
|
854
851
|
# The Amazon Resource Names (ARNs) of Amazon Simple Notification Service
|
|
855
|
-
# (Amazon SNS) topics that
|
|
856
|
-
#
|
|
852
|
+
# (Amazon SNS) topics that CloudFormation associates with the stack. To
|
|
853
|
+
# remove all associated notification topics, specify an empty list.
|
|
857
854
|
#
|
|
858
855
|
# @option params [Array<Types::Tag>] :tags
|
|
859
|
-
# Key-value pairs to associate with this stack.
|
|
856
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
|
860
857
|
# propagates these tags to resources in the stack. You can specify a
|
|
861
858
|
# maximum of 50 tags.
|
|
862
859
|
#
|
|
@@ -870,9 +867,9 @@ module Aws::CloudFormation
|
|
|
870
867
|
#
|
|
871
868
|
# @option params [String] :client_token
|
|
872
869
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
|
873
|
-
# token if you plan to retry requests so that
|
|
874
|
-
#
|
|
875
|
-
# name. You might retry `CreateChangeSet` requests to ensure that
|
|
870
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
|
871
|
+
# you're not attempting to create another change set with the same
|
|
872
|
+
# name. You might retry `CreateChangeSet` requests to ensure that
|
|
876
873
|
# CloudFormation successfully received them.
|
|
877
874
|
#
|
|
878
875
|
# @option params [String] :description
|
|
@@ -884,12 +881,12 @@ module Aws::CloudFormation
|
|
|
884
881
|
# specify `UPDATE`. To create a change set for an import operation,
|
|
885
882
|
# specify `IMPORT`.
|
|
886
883
|
#
|
|
887
|
-
# If you create a change set for a new stack,
|
|
888
|
-
#
|
|
889
|
-
#
|
|
890
|
-
#
|
|
884
|
+
# If you create a change set for a new stack, CloudFormation creates a
|
|
885
|
+
# stack with a unique stack ID, but no template or resources. The stack
|
|
886
|
+
# will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you execute the
|
|
887
|
+
# change set.
|
|
891
888
|
#
|
|
892
|
-
# By default,
|
|
889
|
+
# By default, CloudFormation specifies `UPDATE`. You can't use the
|
|
893
890
|
# `UPDATE` type to create a change set for a new stack or the `CREATE`
|
|
894
891
|
# type to create a change set for an existing stack.
|
|
895
892
|
#
|
|
@@ -991,7 +988,7 @@ module Aws::CloudFormation
|
|
|
991
988
|
# @option params [String] :template_body
|
|
992
989
|
# Structure containing the template body with a minimum length of 1 byte
|
|
993
990
|
# and a maximum length of 51,200 bytes. For more information, go to
|
|
994
|
-
# [Template Anatomy][1] in the
|
|
991
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
|
995
992
|
#
|
|
996
993
|
# Conditional: You must specify either the `TemplateBody` or the
|
|
997
994
|
# `TemplateURL` parameter, but not both.
|
|
@@ -1004,7 +1001,7 @@ module Aws::CloudFormation
|
|
|
1004
1001
|
# Location of file containing the template body. The URL must point to a
|
|
1005
1002
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
|
1006
1003
|
# bucket or a Systems Manager document. For more information, go to the
|
|
1007
|
-
# [Template Anatomy][1] in the
|
|
1004
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
|
1008
1005
|
#
|
|
1009
1006
|
# Conditional: You must specify either the `TemplateBody` or the
|
|
1010
1007
|
# `TemplateURL` parameter, but not both.
|
|
@@ -1029,7 +1026,7 @@ module Aws::CloudFormation
|
|
|
1029
1026
|
# Default: `false`
|
|
1030
1027
|
#
|
|
1031
1028
|
# @option params [Types::RollbackConfiguration] :rollback_configuration
|
|
1032
|
-
# The rollback triggers for
|
|
1029
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
|
1033
1030
|
# creation and updating operations, and for the specified monitoring
|
|
1034
1031
|
# period afterwards.
|
|
1035
1032
|
#
|
|
@@ -1045,16 +1042,15 @@ module Aws::CloudFormation
|
|
|
1045
1042
|
#
|
|
1046
1043
|
# @option params [Array<String>] :capabilities
|
|
1047
1044
|
# In some cases, you must explicitly acknowledge that your stack
|
|
1048
|
-
# template contains certain capabilities in order for
|
|
1049
|
-
#
|
|
1045
|
+
# template contains certain capabilities in order for CloudFormation to
|
|
1046
|
+
# create the stack.
|
|
1050
1047
|
#
|
|
1051
1048
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
1052
1049
|
#
|
|
1053
1050
|
# Some stack templates might include resources that can affect
|
|
1054
|
-
# permissions in your
|
|
1055
|
-
#
|
|
1056
|
-
#
|
|
1057
|
-
# capabilities.
|
|
1051
|
+
# permissions in your account; for example, by creating new Identity
|
|
1052
|
+
# and Access Management (IAM) users. For those stacks, you must
|
|
1053
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
|
1058
1054
|
#
|
|
1059
1055
|
# The following IAM resources require you to specify either the
|
|
1060
1056
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
|
@@ -1064,8 +1060,8 @@ module Aws::CloudFormation
|
|
|
1064
1060
|
# * If you have IAM resources with custom names, you *must* specify
|
|
1065
1061
|
# `CAPABILITY_NAMED_IAM`.
|
|
1066
1062
|
#
|
|
1067
|
-
# * If you don't specify either of these capabilities,
|
|
1068
|
-
#
|
|
1063
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
|
1064
|
+
# returns an `InsufficientCapabilities` error.
|
|
1069
1065
|
#
|
|
1070
1066
|
# If your stack template contains these resources, we recommend that
|
|
1071
1067
|
# you review all permissions associated with them and edit their
|
|
@@ -1085,7 +1081,7 @@ module Aws::CloudFormation
|
|
|
1085
1081
|
#
|
|
1086
1082
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
|
1087
1083
|
#
|
|
1088
|
-
# For more information, see [Acknowledging IAM Resources in
|
|
1084
|
+
# For more information, see [Acknowledging IAM Resources in
|
|
1089
1085
|
# CloudFormation Templates][8].
|
|
1090
1086
|
#
|
|
1091
1087
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
@@ -1100,7 +1096,7 @@ module Aws::CloudFormation
|
|
|
1100
1096
|
# create a stack directly from the processed template, without first
|
|
1101
1097
|
# reviewing the resulting changes in a change set, you must
|
|
1102
1098
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
|
1103
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
|
1099
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
|
1104
1100
|
# CloudFormation.
|
|
1105
1101
|
#
|
|
1106
1102
|
# If you want to create a stack from a stack template that contains
|
|
@@ -1112,11 +1108,11 @@ module Aws::CloudFormation
|
|
|
1112
1108
|
#
|
|
1113
1109
|
# Each macro relies on an underlying Lambda service function for
|
|
1114
1110
|
# processing stack templates. Be aware that the Lambda function owner
|
|
1115
|
-
# can update the function operation without
|
|
1111
|
+
# can update the function operation without CloudFormation being
|
|
1116
1112
|
# notified.
|
|
1117
1113
|
#
|
|
1118
|
-
# For more information, see [Using
|
|
1119
|
-
#
|
|
1114
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
|
1115
|
+
# Custom Processing on Templates][11].
|
|
1120
1116
|
#
|
|
1121
1117
|
#
|
|
1122
1118
|
#
|
|
@@ -1136,35 +1132,35 @@ module Aws::CloudFormation
|
|
|
1136
1132
|
# The template resource types that you have permissions to work with for
|
|
1137
1133
|
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
|
|
1138
1134
|
# or `Custom::MyCustomInstance`. Use the following syntax to describe
|
|
1139
|
-
# template resource types: `AWS::*` (for all
|
|
1140
|
-
#
|
|
1141
|
-
#
|
|
1142
|
-
#
|
|
1143
|
-
#
|
|
1135
|
+
# template resource types: `AWS::*` (for all Amazon Web Services
|
|
1136
|
+
# resources), `Custom::*` (for all custom resources),
|
|
1137
|
+
# `Custom::logical_ID ` (for a specific custom resource),
|
|
1138
|
+
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
|
1139
|
+
# Services service), and `AWS::service_name::resource_logical_ID ` (for
|
|
1140
|
+
# a specific Amazon Web Services resource).
|
|
1144
1141
|
#
|
|
1145
1142
|
# If the list of resource types doesn't include a resource that you're
|
|
1146
|
-
# creating, the stack creation fails. By default,
|
|
1147
|
-
#
|
|
1148
|
-
#
|
|
1149
|
-
#
|
|
1150
|
-
#
|
|
1143
|
+
# creating, the stack creation fails. By default, CloudFormation grants
|
|
1144
|
+
# permissions to all resource types. Identity and Access Management
|
|
1145
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
|
1146
|
+
# in IAM policies. For more information, see [Controlling Access with
|
|
1147
|
+
# Identity and Access Management][1].
|
|
1151
1148
|
#
|
|
1152
1149
|
#
|
|
1153
1150
|
#
|
|
1154
1151
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
|
1155
1152
|
#
|
|
1156
1153
|
# @option params [String] :role_arn
|
|
1157
|
-
# The Amazon Resource Name (ARN) of an
|
|
1158
|
-
#
|
|
1159
|
-
#
|
|
1160
|
-
#
|
|
1161
|
-
#
|
|
1162
|
-
#
|
|
1163
|
-
#
|
|
1164
|
-
#
|
|
1165
|
-
#
|
|
1166
|
-
#
|
|
1167
|
-
# was previously associated with the stack. If no role is available, AWS
|
|
1154
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
|
1155
|
+
# (IAM) role that CloudFormation assumes to create the stack.
|
|
1156
|
+
# CloudFormation uses the role's credentials to make calls on your
|
|
1157
|
+
# behalf. CloudFormation always uses this role for all future operations
|
|
1158
|
+
# on the stack. As long as users have permission to operate on the
|
|
1159
|
+
# stack, CloudFormation uses this role even if the users don't have
|
|
1160
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
|
1161
|
+
#
|
|
1162
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
|
1163
|
+
# previously associated with the stack. If no role is available,
|
|
1168
1164
|
# CloudFormation uses a temporary session that is generated from your
|
|
1169
1165
|
# user credentials.
|
|
1170
1166
|
#
|
|
@@ -1177,7 +1173,7 @@ module Aws::CloudFormation
|
|
|
1177
1173
|
#
|
|
1178
1174
|
# @option params [String] :stack_policy_body
|
|
1179
1175
|
# Structure containing the stack policy body. For more information, go
|
|
1180
|
-
# to [ Prevent Updates to Stack Resources][1] in the *
|
|
1176
|
+
# to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
|
|
1181
1177
|
# User Guide*. You can specify either the `StackPolicyBody` or the
|
|
1182
1178
|
# `StackPolicyURL` parameter, but not both.
|
|
1183
1179
|
#
|
|
@@ -1192,15 +1188,15 @@ module Aws::CloudFormation
|
|
|
1192
1188
|
# the `StackPolicyURL` parameter, but not both.
|
|
1193
1189
|
#
|
|
1194
1190
|
# @option params [Array<Types::Tag>] :tags
|
|
1195
|
-
# Key-value pairs to associate with this stack.
|
|
1191
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
|
1196
1192
|
# propagates these tags to the resources created in the stack. A maximum
|
|
1197
1193
|
# number of 50 tags can be specified.
|
|
1198
1194
|
#
|
|
1199
1195
|
# @option params [String] :client_request_token
|
|
1200
1196
|
# A unique identifier for this `CreateStack` request. Specify this token
|
|
1201
|
-
# if you plan to retry requests so that
|
|
1197
|
+
# if you plan to retry requests so that CloudFormation knows that
|
|
1202
1198
|
# you're not attempting to create a stack with the same name. You might
|
|
1203
|
-
# retry `CreateStack` requests to ensure that
|
|
1199
|
+
# retry `CreateStack` requests to ensure that CloudFormation
|
|
1204
1200
|
# successfully received them.
|
|
1205
1201
|
#
|
|
1206
1202
|
# All events triggered by a given stack operation are assigned the same
|
|
@@ -1222,7 +1218,7 @@ module Aws::CloudFormation
|
|
|
1222
1218
|
# user attempts to delete a stack with termination protection enabled,
|
|
1223
1219
|
# the operation fails and the stack remains unchanged. For more
|
|
1224
1220
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
|
1225
|
-
# *
|
|
1221
|
+
# *CloudFormation User Guide*. Termination protection is disabled on
|
|
1226
1222
|
# stacks by default.
|
|
1227
1223
|
#
|
|
1228
1224
|
# For [nested stacks][2], termination protection is set on the root
|
|
@@ -1303,21 +1299,20 @@ module Aws::CloudFormation
|
|
|
1303
1299
|
# instances from.
|
|
1304
1300
|
#
|
|
1305
1301
|
# @option params [Array<String>] :accounts
|
|
1306
|
-
# \[Self-managed permissions\] The names of one or more
|
|
1307
|
-
#
|
|
1308
|
-
# for.
|
|
1302
|
+
# \[Self-managed permissions\] The names of one or more accounts that
|
|
1303
|
+
# you want to create stack instances in the specified Region(s) for.
|
|
1309
1304
|
#
|
|
1310
1305
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
1311
1306
|
#
|
|
1312
1307
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
1313
|
-
# \[Service-managed permissions\] The
|
|
1314
|
-
#
|
|
1308
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
|
1309
|
+
# to create stack instances in the specified Regions.
|
|
1315
1310
|
#
|
|
1316
1311
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
1317
1312
|
#
|
|
1318
1313
|
# @option params [required, Array<String>] :regions
|
|
1319
1314
|
# The names of one or more Regions where you want to create stack
|
|
1320
|
-
# instances using the specified
|
|
1315
|
+
# instances using the specified accounts.
|
|
1321
1316
|
#
|
|
1322
1317
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
|
1323
1318
|
# A list of stack set parameters whose values you want to override in
|
|
@@ -1325,24 +1320,19 @@ module Aws::CloudFormation
|
|
|
1325
1320
|
#
|
|
1326
1321
|
# Any overridden parameter values will be applied to all stack instances
|
|
1327
1322
|
# in the specified accounts and Regions. When specifying parameters and
|
|
1328
|
-
# their values, be aware of how
|
|
1323
|
+
# their values, be aware of how CloudFormation sets parameter values
|
|
1329
1324
|
# during stack instance operations:
|
|
1330
1325
|
#
|
|
1331
1326
|
# * To override the current value for a parameter, include the parameter
|
|
1332
1327
|
# and specify its value.
|
|
1333
1328
|
#
|
|
1334
|
-
# * To leave
|
|
1335
|
-
#
|
|
1336
|
-
#
|
|
1337
|
-
# * Do not include the parameter in the list.
|
|
1338
|
-
#
|
|
1339
|
-
# * Include the parameter and specify `UsePreviousValue` as `true`.
|
|
1340
|
-
# (You cannot specify both a value and set `UsePreviousValue` to
|
|
1341
|
-
# `true`.)
|
|
1329
|
+
# * To leave an overridden parameter set to its present value, include
|
|
1330
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You cannot
|
|
1331
|
+
# specify both a value and set `UsePreviousValue` to `true`.)
|
|
1342
1332
|
#
|
|
1343
|
-
# * To set
|
|
1344
|
-
# stack set, specify a parameter list but do not include
|
|
1345
|
-
#
|
|
1333
|
+
# * To set an overridden parameter back to the value specified in the
|
|
1334
|
+
# stack set, specify a parameter list but do not include the parameter
|
|
1335
|
+
# in the list.
|
|
1346
1336
|
#
|
|
1347
1337
|
# * To leave all parameters set to their present values, do not specify
|
|
1348
1338
|
# this property at all.
|
|
@@ -1359,17 +1349,16 @@ module Aws::CloudFormation
|
|
|
1359
1349
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
|
1360
1350
|
#
|
|
1361
1351
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
1362
|
-
# Preferences for how
|
|
1363
|
-
# operation.
|
|
1352
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
|
1364
1353
|
#
|
|
1365
1354
|
# @option params [String] :operation_id
|
|
1366
1355
|
# The unique identifier for this stack set operation.
|
|
1367
1356
|
#
|
|
1368
1357
|
# The operation ID also functions as an idempotency token, to ensure
|
|
1369
|
-
# that
|
|
1370
|
-
#
|
|
1371
|
-
#
|
|
1372
|
-
#
|
|
1358
|
+
# that CloudFormation performs the stack set operation only once, even
|
|
1359
|
+
# if you retry the request multiple times. You might retry stack set
|
|
1360
|
+
# operation requests to ensure that CloudFormation successfully received
|
|
1361
|
+
# them.
|
|
1373
1362
|
#
|
|
1374
1363
|
# If you don't specify an operation ID, the SDK generates one
|
|
1375
1364
|
# automatically.
|
|
@@ -1393,9 +1382,9 @@ module Aws::CloudFormation
|
|
|
1393
1382
|
# * If you are signed in to a delegated administrator account, specify
|
|
1394
1383
|
# `DELEGATED_ADMIN`.
|
|
1395
1384
|
#
|
|
1396
|
-
# Your
|
|
1397
|
-
#
|
|
1398
|
-
#
|
|
1385
|
+
# Your account must be registered as a delegated administrator in the
|
|
1386
|
+
# management account. For more information, see [Register a delegated
|
|
1387
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
1399
1388
|
#
|
|
1400
1389
|
#
|
|
1401
1390
|
#
|
|
@@ -1468,7 +1457,7 @@ module Aws::CloudFormation
|
|
|
1468
1457
|
# @option params [String] :template_body
|
|
1469
1458
|
# The structure that contains the template body, with a minimum length
|
|
1470
1459
|
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
|
1471
|
-
# see [Template Anatomy][1] in the
|
|
1460
|
+
# see [Template Anatomy][1] in the CloudFormation User Guide.
|
|
1472
1461
|
#
|
|
1473
1462
|
# Conditional: You must specify either the TemplateBody or the
|
|
1474
1463
|
# TemplateURL parameter, but not both.
|
|
@@ -1481,7 +1470,7 @@ module Aws::CloudFormation
|
|
|
1481
1470
|
# The location of the file that contains the template body. The URL must
|
|
1482
1471
|
# point to a template (maximum size: 460,800 bytes) that's located in
|
|
1483
1472
|
# an Amazon S3 bucket or a Systems Manager document. For more
|
|
1484
|
-
# information, see [Template Anatomy][1] in the
|
|
1473
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
|
1485
1474
|
# Guide.
|
|
1486
1475
|
#
|
|
1487
1476
|
# Conditional: You must specify either the TemplateBody or the
|
|
@@ -1491,21 +1480,24 @@ module Aws::CloudFormation
|
|
|
1491
1480
|
#
|
|
1492
1481
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
|
1493
1482
|
#
|
|
1483
|
+
# @option params [String] :stack_id
|
|
1484
|
+
# The stack ID you are importing into a new stack set. Specify the
|
|
1485
|
+
# Amazon Resource Number (ARN) of the stack.
|
|
1486
|
+
#
|
|
1494
1487
|
# @option params [Array<Types::Parameter>] :parameters
|
|
1495
1488
|
# The input parameters for the stack set template.
|
|
1496
1489
|
#
|
|
1497
1490
|
# @option params [Array<String>] :capabilities
|
|
1498
1491
|
# In some cases, you must explicitly acknowledge that your stack set
|
|
1499
|
-
# template contains certain capabilities in order for
|
|
1500
|
-
#
|
|
1492
|
+
# template contains certain capabilities in order for CloudFormation to
|
|
1493
|
+
# create the stack set and related stack instances.
|
|
1501
1494
|
#
|
|
1502
1495
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
1503
1496
|
#
|
|
1504
1497
|
# Some stack templates might include resources that can affect
|
|
1505
|
-
# permissions in your
|
|
1506
|
-
#
|
|
1507
|
-
#
|
|
1508
|
-
# capabilities.
|
|
1498
|
+
# permissions in your account; for example, by creating new Identity
|
|
1499
|
+
# and Access Management (IAM) users. For those stack sets, you must
|
|
1500
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
|
1509
1501
|
#
|
|
1510
1502
|
# The following IAM resources require you to specify either the
|
|
1511
1503
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
|
@@ -1515,8 +1507,8 @@ module Aws::CloudFormation
|
|
|
1515
1507
|
# * If you have IAM resources with custom names, you *must* specify
|
|
1516
1508
|
# `CAPABILITY_NAMED_IAM`.
|
|
1517
1509
|
#
|
|
1518
|
-
# * If you don't specify either of these capabilities,
|
|
1519
|
-
#
|
|
1510
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
|
1511
|
+
# returns an `InsufficientCapabilities` error.
|
|
1520
1512
|
#
|
|
1521
1513
|
# If your stack template contains these resources, we recommend that
|
|
1522
1514
|
# you review all permissions associated with them and edit their
|
|
@@ -1536,7 +1528,7 @@ module Aws::CloudFormation
|
|
|
1536
1528
|
#
|
|
1537
1529
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
|
1538
1530
|
#
|
|
1539
|
-
# For more information, see [Acknowledging IAM Resources in
|
|
1531
|
+
# For more information, see [Acknowledging IAM Resources in
|
|
1540
1532
|
# CloudFormation Templates][8].
|
|
1541
1533
|
#
|
|
1542
1534
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
@@ -1546,13 +1538,13 @@ module Aws::CloudFormation
|
|
|
1546
1538
|
# directly from the processed template, without first reviewing the
|
|
1547
1539
|
# resulting changes in a change set. To create the stack set directly,
|
|
1548
1540
|
# you must acknowledge this capability. For more information, see
|
|
1549
|
-
# [Using
|
|
1541
|
+
# [Using CloudFormation Macros to Perform Custom Processing on
|
|
1550
1542
|
# Templates][9].
|
|
1551
1543
|
#
|
|
1552
1544
|
# Stack sets with service-managed permissions do not currently support
|
|
1553
1545
|
# the use of macros in templates. (This includes the
|
|
1554
1546
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
|
1555
|
-
# macros hosted by
|
|
1547
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
|
1556
1548
|
# capability for a stack set with service-managed permissions, if you
|
|
1557
1549
|
# reference a macro in your template the stack set operation will
|
|
1558
1550
|
# fail.
|
|
@@ -1573,11 +1565,11 @@ module Aws::CloudFormation
|
|
|
1573
1565
|
#
|
|
1574
1566
|
# @option params [Array<Types::Tag>] :tags
|
|
1575
1567
|
# The key-value pairs to associate with this stack set and the stacks
|
|
1576
|
-
# created from it.
|
|
1568
|
+
# created from it. CloudFormation also propagates these tags to
|
|
1577
1569
|
# supported resources that are created in the stacks. A maximum number
|
|
1578
1570
|
# of 50 tags can be specified.
|
|
1579
1571
|
#
|
|
1580
|
-
# If you specify tags as part of a `CreateStackSet` action,
|
|
1572
|
+
# If you specify tags as part of a `CreateStackSet` action,
|
|
1581
1573
|
# CloudFormation checks to see if you have the required IAM permission
|
|
1582
1574
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
|
1583
1575
|
# fails with an `access denied` error, and the stack set is not created.
|
|
@@ -1590,7 +1582,7 @@ module Aws::CloudFormation
|
|
|
1590
1582
|
# roles to control which users or groups can manage specific stack sets
|
|
1591
1583
|
# within the same administrator account. For more information, see
|
|
1592
1584
|
# [Prerequisites: Granting Permissions for Stack Set Operations][1] in
|
|
1593
|
-
# the *
|
|
1585
|
+
# the *CloudFormation User Guide*.
|
|
1594
1586
|
#
|
|
1595
1587
|
#
|
|
1596
1588
|
#
|
|
@@ -1598,7 +1590,7 @@ module Aws::CloudFormation
|
|
|
1598
1590
|
#
|
|
1599
1591
|
# @option params [String] :execution_role_name
|
|
1600
1592
|
# The name of the IAM execution role to use to create the stack set. If
|
|
1601
|
-
# you do not specify an execution role,
|
|
1593
|
+
# you do not specify an execution role, CloudFormation uses the
|
|
1602
1594
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
|
1603
1595
|
# operation.
|
|
1604
1596
|
#
|
|
@@ -1615,7 +1607,7 @@ module Aws::CloudFormation
|
|
|
1615
1607
|
# information, see [Grant Self-Managed Stack Set Permissions][1].
|
|
1616
1608
|
#
|
|
1617
1609
|
# * With `service-managed` permissions, StackSets automatically creates
|
|
1618
|
-
# the IAM roles required to deploy to accounts managed by
|
|
1610
|
+
# the IAM roles required to deploy to accounts managed by
|
|
1619
1611
|
# Organizations. For more information, see [Grant Service-Managed
|
|
1620
1612
|
# Stack Set Permissions][2].
|
|
1621
1613
|
#
|
|
@@ -1625,7 +1617,7 @@ module Aws::CloudFormation
|
|
|
1625
1617
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
|
|
1626
1618
|
#
|
|
1627
1619
|
# @option params [Types::AutoDeployment] :auto_deployment
|
|
1628
|
-
# Describes whether StackSets automatically deploys to
|
|
1620
|
+
# Describes whether StackSets automatically deploys to Organizations
|
|
1629
1621
|
# accounts that are added to the target organization or organizational
|
|
1630
1622
|
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
|
|
1631
1623
|
#
|
|
@@ -1643,9 +1635,9 @@ module Aws::CloudFormation
|
|
|
1643
1635
|
# * To create a stack set with service-managed permissions while signed
|
|
1644
1636
|
# in to a delegated administrator account, specify `DELEGATED_ADMIN`.
|
|
1645
1637
|
#
|
|
1646
|
-
# Your
|
|
1638
|
+
# Your account must be registered as a delegated admin in the
|
|
1647
1639
|
# management account. For more information, see [Register a delegated
|
|
1648
|
-
# administrator][1] in the *
|
|
1640
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
1649
1641
|
#
|
|
1650
1642
|
# Stack sets with service-managed permissions are created in the
|
|
1651
1643
|
# management account, including stack sets that are created by delegated
|
|
@@ -1657,9 +1649,9 @@ module Aws::CloudFormation
|
|
|
1657
1649
|
#
|
|
1658
1650
|
# @option params [String] :client_request_token
|
|
1659
1651
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
|
1660
|
-
# token if you plan to retry requests so that
|
|
1661
|
-
#
|
|
1662
|
-
#
|
|
1652
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
|
1653
|
+
# you're not attempting to create another stack set with the same name.
|
|
1654
|
+
# You might retry `CreateStackSet` requests to ensure that
|
|
1663
1655
|
# CloudFormation successfully received them.
|
|
1664
1656
|
#
|
|
1665
1657
|
# If you don't specify an operation ID, the SDK generates one
|
|
@@ -1679,6 +1671,7 @@ module Aws::CloudFormation
|
|
|
1679
1671
|
# description: "Description",
|
|
1680
1672
|
# template_body: "TemplateBody",
|
|
1681
1673
|
# template_url: "TemplateURL",
|
|
1674
|
+
# stack_id: "StackId",
|
|
1682
1675
|
# parameters: [
|
|
1683
1676
|
# {
|
|
1684
1677
|
# parameter_key: "ParameterKey",
|
|
@@ -1767,7 +1760,7 @@ module Aws::CloudFormation
|
|
|
1767
1760
|
# Deletes the specified change set. Deleting change sets ensures that no
|
|
1768
1761
|
# one executes the wrong change set.
|
|
1769
1762
|
#
|
|
1770
|
-
# If the call successfully completes,
|
|
1763
|
+
# If the call successfully completes, CloudFormation successfully
|
|
1771
1764
|
# deleted the change set.
|
|
1772
1765
|
#
|
|
1773
1766
|
# If `IncludeNestedStacks` specifies `True` during the creation of the
|
|
@@ -1811,28 +1804,28 @@ module Aws::CloudFormation
|
|
|
1811
1804
|
# @option params [Array<String>] :retain_resources
|
|
1812
1805
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
|
1813
1806
|
# IDs that are associated with the resources you want to retain. During
|
|
1814
|
-
# deletion,
|
|
1807
|
+
# deletion, CloudFormation deletes the stack but does not delete the
|
|
1815
1808
|
# retained resources.
|
|
1816
1809
|
#
|
|
1817
1810
|
# Retaining resources is useful when you cannot delete a resource, such
|
|
1818
1811
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
|
1819
1812
|
#
|
|
1820
1813
|
# @option params [String] :role_arn
|
|
1821
|
-
# The Amazon Resource Name (ARN) of an
|
|
1822
|
-
#
|
|
1823
|
-
#
|
|
1824
|
-
#
|
|
1814
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
|
1815
|
+
# (IAM) role that CloudFormation assumes to delete the stack.
|
|
1816
|
+
# CloudFormation uses the role's credentials to make calls on your
|
|
1817
|
+
# behalf.
|
|
1825
1818
|
#
|
|
1826
|
-
# If you don't specify a value,
|
|
1827
|
-
#
|
|
1819
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
|
1820
|
+
# previously associated with the stack. If no role is available,
|
|
1828
1821
|
# CloudFormation uses a temporary session that is generated from your
|
|
1829
1822
|
# user credentials.
|
|
1830
1823
|
#
|
|
1831
1824
|
# @option params [String] :client_request_token
|
|
1832
1825
|
# A unique identifier for this `DeleteStack` request. Specify this token
|
|
1833
|
-
# if you plan to retry requests so that
|
|
1826
|
+
# if you plan to retry requests so that CloudFormation knows that
|
|
1834
1827
|
# you're not attempting to delete a stack with the same name. You might
|
|
1835
|
-
# retry `DeleteStack` requests to ensure that
|
|
1828
|
+
# retry `DeleteStack` requests to ensure that CloudFormation
|
|
1836
1829
|
# successfully received them.
|
|
1837
1830
|
#
|
|
1838
1831
|
# All events triggered by a given stack operation are assigned the same
|
|
@@ -1877,14 +1870,14 @@ module Aws::CloudFormation
|
|
|
1877
1870
|
# instances for.
|
|
1878
1871
|
#
|
|
1879
1872
|
# @option params [Array<String>] :accounts
|
|
1880
|
-
# \[Self-managed permissions\] The names of the
|
|
1881
|
-
#
|
|
1873
|
+
# \[Self-managed permissions\] The names of the accounts that you want
|
|
1874
|
+
# to delete stack instances for.
|
|
1882
1875
|
#
|
|
1883
1876
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
1884
1877
|
#
|
|
1885
1878
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
1886
|
-
# \[Service-managed permissions\] The
|
|
1887
|
-
#
|
|
1879
|
+
# \[Service-managed permissions\] The Organizations accounts from which
|
|
1880
|
+
# to delete stack instances.
|
|
1888
1881
|
#
|
|
1889
1882
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
1890
1883
|
#
|
|
@@ -1892,8 +1885,7 @@ module Aws::CloudFormation
|
|
|
1892
1885
|
# The Regions where you want to delete stack set instances.
|
|
1893
1886
|
#
|
|
1894
1887
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
1895
|
-
# Preferences for how
|
|
1896
|
-
# operation.
|
|
1888
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
|
1897
1889
|
#
|
|
1898
1890
|
# @option params [required, Boolean] :retain_stacks
|
|
1899
1891
|
# Removes the stack instances from the specified stack set, but doesn't
|
|
@@ -1913,10 +1905,10 @@ module Aws::CloudFormation
|
|
|
1913
1905
|
# automatically.
|
|
1914
1906
|
#
|
|
1915
1907
|
# The operation ID also functions as an idempotency token, to ensure
|
|
1916
|
-
# that
|
|
1917
|
-
#
|
|
1918
|
-
# operation requests to ensure that
|
|
1919
|
-
#
|
|
1908
|
+
# that CloudFormation performs the stack set operation only once, even
|
|
1909
|
+
# if you retry the request multiple times. You can retry stack set
|
|
1910
|
+
# operation requests to ensure that CloudFormation successfully received
|
|
1911
|
+
# them.
|
|
1920
1912
|
#
|
|
1921
1913
|
# Repeating this stack set operation with a new operation ID retries all
|
|
1922
1914
|
# stack instances whose status is `OUTDATED`.
|
|
@@ -1937,9 +1929,9 @@ module Aws::CloudFormation
|
|
|
1937
1929
|
# * If you are signed in to a delegated administrator account, specify
|
|
1938
1930
|
# `DELEGATED_ADMIN`.
|
|
1939
1931
|
#
|
|
1940
|
-
# Your
|
|
1941
|
-
#
|
|
1942
|
-
#
|
|
1932
|
+
# Your account must be registered as a delegated administrator in the
|
|
1933
|
+
# management account. For more information, see [Register a delegated
|
|
1934
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
1943
1935
|
#
|
|
1944
1936
|
#
|
|
1945
1937
|
#
|
|
@@ -2007,9 +1999,9 @@ module Aws::CloudFormation
|
|
|
2007
1999
|
# * If you are signed in to a delegated administrator account, specify
|
|
2008
2000
|
# `DELEGATED_ADMIN`.
|
|
2009
2001
|
#
|
|
2010
|
-
# Your
|
|
2011
|
-
#
|
|
2012
|
-
#
|
|
2002
|
+
# Your account must be registered as a delegated administrator in the
|
|
2003
|
+
# management account. For more information, see [Register a delegated
|
|
2004
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
2013
2005
|
#
|
|
2014
2006
|
#
|
|
2015
2007
|
#
|
|
@@ -2096,10 +2088,10 @@ module Aws::CloudFormation
|
|
|
2096
2088
|
req.send_request(options)
|
|
2097
2089
|
end
|
|
2098
2090
|
|
|
2099
|
-
# Retrieves your account's
|
|
2100
|
-
#
|
|
2101
|
-
# information about account limits, see [
|
|
2102
|
-
#
|
|
2091
|
+
# Retrieves your account's CloudFormation limits, such as the maximum
|
|
2092
|
+
# number of stacks that you can create in your account. For more
|
|
2093
|
+
# information about account limits, see [CloudFormation Limits][1] in
|
|
2094
|
+
# the *CloudFormation User Guide*.
|
|
2103
2095
|
#
|
|
2104
2096
|
#
|
|
2105
2097
|
#
|
|
@@ -2138,9 +2130,9 @@ module Aws::CloudFormation
|
|
|
2138
2130
|
req.send_request(options)
|
|
2139
2131
|
end
|
|
2140
2132
|
|
|
2141
|
-
# Returns the inputs for the change set and a list of changes that
|
|
2133
|
+
# Returns the inputs for the change set and a list of changes that
|
|
2142
2134
|
# CloudFormation will make if you execute the change set. For more
|
|
2143
|
-
# information, see [Updating Stacks Using Change Sets][1] in the
|
|
2135
|
+
# information, see [Updating Stacks Using Change Sets][1] in the
|
|
2144
2136
|
# CloudFormation User Guide.
|
|
2145
2137
|
#
|
|
2146
2138
|
#
|
|
@@ -2331,10 +2323,10 @@ module Aws::CloudFormation
|
|
|
2331
2323
|
# @option params [required, String] :stack_drift_detection_id
|
|
2332
2324
|
# The ID of the drift detection results of this operation.
|
|
2333
2325
|
#
|
|
2334
|
-
#
|
|
2335
|
-
#
|
|
2336
|
-
#
|
|
2337
|
-
#
|
|
2326
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
|
2327
|
+
# each time this operation is run. However, the number of drift results
|
|
2328
|
+
# CloudFormation retains for any given stack, and for how long, may
|
|
2329
|
+
# vary.
|
|
2338
2330
|
#
|
|
2339
2331
|
# @return [Types::DescribeStackDriftDetectionStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2340
2332
|
#
|
|
@@ -2373,7 +2365,7 @@ module Aws::CloudFormation
|
|
|
2373
2365
|
|
|
2374
2366
|
# Returns all stack related events for a specified stack in reverse
|
|
2375
2367
|
# chronological order. For more information about a stack's event
|
|
2376
|
-
# history, go to [Stacks][1] in the
|
|
2368
|
+
# history, go to [Stacks][1] in the CloudFormation User Guide.
|
|
2377
2369
|
#
|
|
2378
2370
|
# <note markdown="1"> You can list events for stacks that have failed to create or have been
|
|
2379
2371
|
# deleted by specifying the unique stack identifier (stack ID).
|
|
@@ -2439,7 +2431,7 @@ module Aws::CloudFormation
|
|
|
2439
2431
|
end
|
|
2440
2432
|
|
|
2441
2433
|
# Returns the stack instance that's associated with the specified stack
|
|
2442
|
-
# set,
|
|
2434
|
+
# set, account, and Region.
|
|
2443
2435
|
#
|
|
2444
2436
|
# For a list of stack instances that are associated with a specific
|
|
2445
2437
|
# stack set, use ListStackInstances.
|
|
@@ -2449,7 +2441,7 @@ module Aws::CloudFormation
|
|
|
2449
2441
|
# stack instance information for.
|
|
2450
2442
|
#
|
|
2451
2443
|
# @option params [required, String] :stack_instance_account
|
|
2452
|
-
# The ID of an
|
|
2444
|
+
# The ID of an account that's associated with this stack instance.
|
|
2453
2445
|
#
|
|
2454
2446
|
# @option params [required, String] :stack_instance_region
|
|
2455
2447
|
# The name of a Region that's associated with this stack instance.
|
|
@@ -2467,9 +2459,9 @@ module Aws::CloudFormation
|
|
|
2467
2459
|
# * If you are signed in to a delegated administrator account, specify
|
|
2468
2460
|
# `DELEGATED_ADMIN`.
|
|
2469
2461
|
#
|
|
2470
|
-
# Your
|
|
2471
|
-
#
|
|
2472
|
-
#
|
|
2462
|
+
# Your account must be registered as a delegated administrator in the
|
|
2463
|
+
# management account. For more information, see [Register a delegated
|
|
2464
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
2473
2465
|
#
|
|
2474
2466
|
#
|
|
2475
2467
|
#
|
|
@@ -2576,7 +2568,7 @@ module Aws::CloudFormation
|
|
|
2576
2568
|
|
|
2577
2569
|
# Returns drift information for the resources that have been checked for
|
|
2578
2570
|
# drift in the specified stack. This includes actual and expected
|
|
2579
|
-
# configuration values for resources where
|
|
2571
|
+
# configuration values for resources where CloudFormation detects
|
|
2580
2572
|
# configuration drift.
|
|
2581
2573
|
#
|
|
2582
2574
|
# For a given stack, there will be one `StackResourceDrift` for each
|
|
@@ -2610,8 +2602,7 @@ module Aws::CloudFormation
|
|
|
2610
2602
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
|
2611
2603
|
# expected template configuration.
|
|
2612
2604
|
#
|
|
2613
|
-
# * `NOT_CHECKED`\:
|
|
2614
|
-
# value.
|
|
2605
|
+
# * `NOT_CHECKED`\: CloudFormation does not currently return this value.
|
|
2615
2606
|
#
|
|
2616
2607
|
# @option params [String] :next_token
|
|
2617
2608
|
# A string that identifies the next page of stack resource drift
|
|
@@ -2671,11 +2662,11 @@ module Aws::CloudFormation
|
|
|
2671
2662
|
req.send_request(options)
|
|
2672
2663
|
end
|
|
2673
2664
|
|
|
2674
|
-
# Returns
|
|
2675
|
-
# `StackName` is specified, all the associated
|
|
2676
|
-
# of the stack are returned. If
|
|
2677
|
-
#
|
|
2678
|
-
# returned.
|
|
2665
|
+
# Returns Amazon Web Services resource descriptions for running and
|
|
2666
|
+
# deleted stacks. If `StackName` is specified, all the associated
|
|
2667
|
+
# resources that are part of the stack are returned. If
|
|
2668
|
+
# `PhysicalResourceId` is specified, the associated resources of the
|
|
2669
|
+
# stack that the resource belongs to are returned.
|
|
2679
2670
|
#
|
|
2680
2671
|
# <note markdown="1"> Only the first 100 resources will be returned. If your stack has more
|
|
2681
2672
|
# resources than this, you should use `ListStackResources` instead.
|
|
@@ -2688,8 +2679,8 @@ module Aws::CloudFormation
|
|
|
2688
2679
|
# You must specify either `StackName` or `PhysicalResourceId`, but not
|
|
2689
2680
|
# both. In addition, you can specify `LogicalResourceId` to filter the
|
|
2690
2681
|
# returned result. For more information about resources, the
|
|
2691
|
-
# `LogicalResourceId` and `PhysicalResourceId`, go to the
|
|
2692
|
-
# CloudFormation User Guide][1].
|
|
2682
|
+
# `LogicalResourceId` and `PhysicalResourceId`, go to the
|
|
2683
|
+
# [CloudFormation User Guide][1].
|
|
2693
2684
|
#
|
|
2694
2685
|
# <note markdown="1"> A `ValidationError` is returned if you specify both `StackName` and
|
|
2695
2686
|
# `PhysicalResourceId` in the same request.
|
|
@@ -2721,7 +2712,7 @@ module Aws::CloudFormation
|
|
|
2721
2712
|
#
|
|
2722
2713
|
# @option params [String] :physical_resource_id
|
|
2723
2714
|
# The name or unique identifier that corresponds to a physical instance
|
|
2724
|
-
# ID of a resource supported by
|
|
2715
|
+
# ID of a resource supported by CloudFormation.
|
|
2725
2716
|
#
|
|
2726
2717
|
# For example, for an Amazon Elastic Compute Cloud (EC2) instance,
|
|
2727
2718
|
# `PhysicalResourceId` corresponds to the `InstanceId`. You can pass the
|
|
@@ -2789,9 +2780,9 @@ module Aws::CloudFormation
|
|
|
2789
2780
|
# * If you are signed in to a delegated administrator account, specify
|
|
2790
2781
|
# `DELEGATED_ADMIN`.
|
|
2791
2782
|
#
|
|
2792
|
-
# Your
|
|
2793
|
-
#
|
|
2794
|
-
#
|
|
2783
|
+
# Your account must be registered as a delegated administrator in the
|
|
2784
|
+
# management account. For more information, see [Register a delegated
|
|
2785
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
2795
2786
|
#
|
|
2796
2787
|
#
|
|
2797
2788
|
#
|
|
@@ -2873,9 +2864,9 @@ module Aws::CloudFormation
|
|
|
2873
2864
|
# * If you are signed in to a delegated administrator account, specify
|
|
2874
2865
|
# `DELEGATED_ADMIN`.
|
|
2875
2866
|
#
|
|
2876
|
-
# Your
|
|
2877
|
-
#
|
|
2878
|
-
#
|
|
2867
|
+
# Your account must be registered as a delegated administrator in the
|
|
2868
|
+
# management account. For more information, see [Register a delegated
|
|
2869
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
2879
2870
|
#
|
|
2880
2871
|
#
|
|
2881
2872
|
#
|
|
@@ -3211,14 +3202,13 @@ module Aws::CloudFormation
|
|
|
3211
3202
|
# Detects whether a stack's actual configuration differs, or has
|
|
3212
3203
|
# *drifted*, from it's expected configuration, as defined in the stack
|
|
3213
3204
|
# template and any values specified as template parameters. For each
|
|
3214
|
-
# resource in the stack that supports drift detection,
|
|
3215
|
-
#
|
|
3216
|
-
#
|
|
3217
|
-
#
|
|
3218
|
-
#
|
|
3219
|
-
#
|
|
3220
|
-
#
|
|
3221
|
-
# Stacks and Resources][1].
|
|
3205
|
+
# resource in the stack that supports drift detection, CloudFormation
|
|
3206
|
+
# compares the actual configuration of the resource with its expected
|
|
3207
|
+
# template configuration. Only resource properties explicitly defined in
|
|
3208
|
+
# the stack template are checked for drift. A stack is considered to
|
|
3209
|
+
# have drifted if one or more of its resources differ from their
|
|
3210
|
+
# expected template configurations. For more information, see [Detecting
|
|
3211
|
+
# Unregulated Configuration Changes to Stacks and Resources][1].
|
|
3222
3212
|
#
|
|
3223
3213
|
# Use `DetectStackDrift` to detect drift on all supported resources for
|
|
3224
3214
|
# a given stack, or DetectStackResourceDrift to detect drift on
|
|
@@ -3234,8 +3224,8 @@ module Aws::CloudFormation
|
|
|
3234
3224
|
# completed, use DescribeStackResourceDrifts to return drift information
|
|
3235
3225
|
# about the stack and its resources.
|
|
3236
3226
|
#
|
|
3237
|
-
# When detecting drift on a stack,
|
|
3238
|
-
#
|
|
3227
|
+
# When detecting drift on a stack, CloudFormation does not detect drift
|
|
3228
|
+
# on any nested stacks belonging to that stack. Perform
|
|
3239
3229
|
# `DetectStackDrift` directly on the nested stack itself.
|
|
3240
3230
|
#
|
|
3241
3231
|
#
|
|
@@ -3277,7 +3267,7 @@ module Aws::CloudFormation
|
|
|
3277
3267
|
# differs, or has *drifted*, from it's expected configuration, as
|
|
3278
3268
|
# defined in the stack template and any values specified as template
|
|
3279
3269
|
# parameters. This information includes actual and expected property
|
|
3280
|
-
# values for resources in which
|
|
3270
|
+
# values for resources in which CloudFormation detects drift. Only
|
|
3281
3271
|
# resource properties explicitly defined in the stack template are
|
|
3282
3272
|
# checked for drift. For more information about stack and resource
|
|
3283
3273
|
# drift, see [Detecting Unregulated Configuration Changes to Stacks and
|
|
@@ -3391,8 +3381,8 @@ module Aws::CloudFormation
|
|
|
3391
3381
|
# operation.
|
|
3392
3382
|
#
|
|
3393
3383
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
3394
|
-
# The user-specified preferences for how
|
|
3395
|
-
#
|
|
3384
|
+
# The user-specified preferences for how CloudFormation performs a stack
|
|
3385
|
+
# set operation.
|
|
3396
3386
|
#
|
|
3397
3387
|
# For more information on maximum concurrent accounts and failure
|
|
3398
3388
|
# tolerance, see [Stack set operation options][1].
|
|
@@ -3420,9 +3410,9 @@ module Aws::CloudFormation
|
|
|
3420
3410
|
# * If you are signed in to a delegated administrator account, specify
|
|
3421
3411
|
# `DELEGATED_ADMIN`.
|
|
3422
3412
|
#
|
|
3423
|
-
# Your
|
|
3424
|
-
#
|
|
3425
|
-
#
|
|
3413
|
+
# Your account must be registered as a delegated administrator in the
|
|
3414
|
+
# management account. For more information, see [Register a delegated
|
|
3415
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
3426
3416
|
#
|
|
3427
3417
|
#
|
|
3428
3418
|
#
|
|
@@ -3462,13 +3452,13 @@ module Aws::CloudFormation
|
|
|
3462
3452
|
end
|
|
3463
3453
|
|
|
3464
3454
|
# Returns the estimated monthly cost of a template. The return value is
|
|
3465
|
-
# an
|
|
3466
|
-
# describes the resources required to run the template.
|
|
3455
|
+
# an Amazon Web Services Simple Monthly Calculator URL with a query
|
|
3456
|
+
# string that describes the resources required to run the template.
|
|
3467
3457
|
#
|
|
3468
3458
|
# @option params [String] :template_body
|
|
3469
3459
|
# Structure containing the template body with a minimum length of 1 byte
|
|
3470
3460
|
# and a maximum length of 51,200 bytes. (For more information, go to
|
|
3471
|
-
# [Template Anatomy][1] in the
|
|
3461
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
|
3472
3462
|
#
|
|
3473
3463
|
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
|
|
3474
3464
|
# are passed, only `TemplateBody` is used.
|
|
@@ -3480,7 +3470,7 @@ module Aws::CloudFormation
|
|
|
3480
3470
|
# @option params [String] :template_url
|
|
3481
3471
|
# Location of file containing the template body. The URL must point to a
|
|
3482
3472
|
# template that is located in an Amazon S3 bucket or a Systems Manager
|
|
3483
|
-
# document. For more information, go to [Template Anatomy][1] in the
|
|
3473
|
+
# document. For more information, go to [Template Anatomy][1] in the
|
|
3484
3474
|
# CloudFormation User Guide.
|
|
3485
3475
|
#
|
|
3486
3476
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
|
@@ -3527,14 +3517,14 @@ module Aws::CloudFormation
|
|
|
3527
3517
|
|
|
3528
3518
|
# Updates a stack using the input information that was provided when the
|
|
3529
3519
|
# specified change set was created. After the call successfully
|
|
3530
|
-
# completes,
|
|
3520
|
+
# completes, CloudFormation starts updating the stack. Use the
|
|
3531
3521
|
# DescribeStacks action to view the status of the update.
|
|
3532
3522
|
#
|
|
3533
|
-
# When you execute a change set,
|
|
3534
|
-
#
|
|
3535
|
-
#
|
|
3523
|
+
# When you execute a change set, CloudFormation deletes all other change
|
|
3524
|
+
# sets associated with the stack because they aren't valid for the
|
|
3525
|
+
# updated stack.
|
|
3536
3526
|
#
|
|
3537
|
-
# If a stack policy is associated with the stack,
|
|
3527
|
+
# If a stack policy is associated with the stack, CloudFormation
|
|
3538
3528
|
# enforces the policy during the update. You can't specify a temporary
|
|
3539
3529
|
# stack policy that overrides the current policy.
|
|
3540
3530
|
#
|
|
@@ -3551,10 +3541,10 @@ module Aws::CloudFormation
|
|
|
3551
3541
|
#
|
|
3552
3542
|
# @option params [String] :client_request_token
|
|
3553
3543
|
# A unique identifier for this `ExecuteChangeSet` request. Specify this
|
|
3554
|
-
# token if you plan to retry requests so that
|
|
3555
|
-
#
|
|
3556
|
-
#
|
|
3557
|
-
#
|
|
3544
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
|
3545
|
+
# you're not attempting to execute a change set to update a stack with
|
|
3546
|
+
# the same name. You might retry `ExecuteChangeSet` requests to ensure
|
|
3547
|
+
# that CloudFormation successfully received them.
|
|
3558
3548
|
#
|
|
3559
3549
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3560
3550
|
#
|
|
@@ -3627,18 +3617,18 @@ module Aws::CloudFormation
|
|
|
3627
3617
|
# Default: There is no default value.
|
|
3628
3618
|
#
|
|
3629
3619
|
# @option params [String] :change_set_name
|
|
3630
|
-
# The name or Amazon Resource Name (ARN) of a change set for which
|
|
3620
|
+
# The name or Amazon Resource Name (ARN) of a change set for which
|
|
3631
3621
|
# CloudFormation returns the associated template. If you specify a name,
|
|
3632
3622
|
# you must also specify the `StackName`.
|
|
3633
3623
|
#
|
|
3634
3624
|
# @option params [String] :template_stage
|
|
3635
3625
|
# For templates that include transforms, the stage of the template that
|
|
3636
|
-
#
|
|
3637
|
-
#
|
|
3638
|
-
#
|
|
3626
|
+
# CloudFormation returns. To get the user-submitted template, specify
|
|
3627
|
+
# `Original`. To get the template after CloudFormation has processed all
|
|
3628
|
+
# transforms, specify `Processed`.
|
|
3639
3629
|
#
|
|
3640
3630
|
# If the template doesn't include transforms, `Original` and
|
|
3641
|
-
# `Processed` return the same template. By default,
|
|
3631
|
+
# `Processed` return the same template. By default, CloudFormation
|
|
3642
3632
|
# specifies `Processed`.
|
|
3643
3633
|
#
|
|
3644
3634
|
# @return [Types::GetTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -3685,8 +3675,7 @@ module Aws::CloudFormation
|
|
|
3685
3675
|
# @option params [String] :template_body
|
|
3686
3676
|
# Structure containing the template body with a minimum length of 1 byte
|
|
3687
3677
|
# and a maximum length of 51,200 bytes. For more information about
|
|
3688
|
-
# templates, see [Template Anatomy][1] in the
|
|
3689
|
-
# Guide.
|
|
3678
|
+
# templates, see [Template Anatomy][1] in the CloudFormation User Guide.
|
|
3690
3679
|
#
|
|
3691
3680
|
# Conditional: You must specify only one of the following parameters:
|
|
3692
3681
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
|
@@ -3699,8 +3688,7 @@ module Aws::CloudFormation
|
|
|
3699
3688
|
# Location of file containing the template body. The URL must point to a
|
|
3700
3689
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
|
3701
3690
|
# bucket or a Systems Manager document. For more information about
|
|
3702
|
-
# templates, see [Template Anatomy][1] in the
|
|
3703
|
-
# Guide.
|
|
3691
|
+
# templates, see [Template Anatomy][1] in the CloudFormation User Guide.
|
|
3704
3692
|
#
|
|
3705
3693
|
# Conditional: You must specify only one of the following parameters:
|
|
3706
3694
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
|
@@ -3738,9 +3726,9 @@ module Aws::CloudFormation
|
|
|
3738
3726
|
# * If you are signed in to a delegated administrator account, specify
|
|
3739
3727
|
# `DELEGATED_ADMIN`.
|
|
3740
3728
|
#
|
|
3741
|
-
# Your
|
|
3742
|
-
#
|
|
3743
|
-
#
|
|
3729
|
+
# Your account must be registered as a delegated administrator in the
|
|
3730
|
+
# management account. For more information, see [Register a delegated
|
|
3731
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
3744
3732
|
#
|
|
3745
3733
|
#
|
|
3746
3734
|
#
|
|
@@ -3804,8 +3792,86 @@ module Aws::CloudFormation
|
|
|
3804
3792
|
req.send_request(options)
|
|
3805
3793
|
end
|
|
3806
3794
|
|
|
3795
|
+
# Import existing stacks into a new stack sets. Use the stack import
|
|
3796
|
+
# operation to import up to 10 stacks into a new stack set in the same
|
|
3797
|
+
# account as the source stack or in a different administrator account
|
|
3798
|
+
# and Region, by specifying the stack ID of the stack you intend to
|
|
3799
|
+
# import.
|
|
3800
|
+
#
|
|
3801
|
+
# <note markdown="1"> `ImportStacksToStackSet` is only supported by self-managed
|
|
3802
|
+
# permissions.
|
|
3803
|
+
#
|
|
3804
|
+
# </note>
|
|
3805
|
+
#
|
|
3806
|
+
# @option params [required, String] :stack_set_name
|
|
3807
|
+
# The name of the stack set. The name must be unique in the Region where
|
|
3808
|
+
# you create your stack set.
|
|
3809
|
+
#
|
|
3810
|
+
# @option params [required, Array<String>] :stack_ids
|
|
3811
|
+
# The IDs of the stacks you are importing into a stack set. You import
|
|
3812
|
+
# up to 10 stacks per stack set at a time.
|
|
3813
|
+
#
|
|
3814
|
+
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
3815
|
+
# The user-specified preferences for how CloudFormation performs a stack
|
|
3816
|
+
# set operation.
|
|
3817
|
+
#
|
|
3818
|
+
# For more information on maximum concurrent accounts and failure
|
|
3819
|
+
# tolerance, see [Stack set operation options][1].
|
|
3820
|
+
#
|
|
3821
|
+
#
|
|
3822
|
+
#
|
|
3823
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
|
3824
|
+
#
|
|
3825
|
+
# @option params [String] :operation_id
|
|
3826
|
+
# A unique, user defined, identifier for the stack set operation.
|
|
3827
|
+
#
|
|
3828
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
3829
|
+
# not need to pass this option.**
|
|
3830
|
+
#
|
|
3831
|
+
# @option params [String] :call_as
|
|
3832
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
|
3833
|
+
# self-managed permissions.
|
|
3834
|
+
#
|
|
3835
|
+
# * If you are signed in to the management account, specify `SELF`.
|
|
3836
|
+
#
|
|
3837
|
+
# * For service managed stack sets, specify `DELEGATED_ADMIN`.
|
|
3838
|
+
#
|
|
3839
|
+
# @return [Types::ImportStacksToStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3840
|
+
#
|
|
3841
|
+
# * {Types::ImportStacksToStackSetOutput#operation_id #operation_id} => String
|
|
3842
|
+
#
|
|
3843
|
+
# @example Request syntax with placeholder values
|
|
3844
|
+
#
|
|
3845
|
+
# resp = client.import_stacks_to_stack_set({
|
|
3846
|
+
# stack_set_name: "StackSetNameOrId", # required
|
|
3847
|
+
# stack_ids: ["StackId"], # required
|
|
3848
|
+
# operation_preferences: {
|
|
3849
|
+
# region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
|
|
3850
|
+
# region_order: ["Region"],
|
|
3851
|
+
# failure_tolerance_count: 1,
|
|
3852
|
+
# failure_tolerance_percentage: 1,
|
|
3853
|
+
# max_concurrent_count: 1,
|
|
3854
|
+
# max_concurrent_percentage: 1,
|
|
3855
|
+
# },
|
|
3856
|
+
# operation_id: "ClientRequestToken",
|
|
3857
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
|
3858
|
+
# })
|
|
3859
|
+
#
|
|
3860
|
+
# @example Response structure
|
|
3861
|
+
#
|
|
3862
|
+
# resp.operation_id #=> String
|
|
3863
|
+
#
|
|
3864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSet AWS API Documentation
|
|
3865
|
+
#
|
|
3866
|
+
# @overload import_stacks_to_stack_set(params = {})
|
|
3867
|
+
# @param [Hash] params ({})
|
|
3868
|
+
def import_stacks_to_stack_set(params = {}, options = {})
|
|
3869
|
+
req = build_request(:import_stacks_to_stack_set, params)
|
|
3870
|
+
req.send_request(options)
|
|
3871
|
+
end
|
|
3872
|
+
|
|
3807
3873
|
# Returns the ID and status of each active change set for a stack. For
|
|
3808
|
-
# example,
|
|
3874
|
+
# example, CloudFormation lists change sets that are in the
|
|
3809
3875
|
# `CREATE_IN_PROGRESS` or `CREATE_PENDING` state.
|
|
3810
3876
|
#
|
|
3811
3877
|
# @option params [required, String] :stack_name
|
|
@@ -3861,7 +3927,7 @@ module Aws::CloudFormation
|
|
|
3861
3927
|
# values that you can import into other stacks. To import values, use
|
|
3862
3928
|
# the [ `Fn::ImportValue` ][1] function.
|
|
3863
3929
|
#
|
|
3864
|
-
# For more information, see [
|
|
3930
|
+
# For more information, see [ CloudFormation Export Stack Output
|
|
3865
3931
|
# Values][2].
|
|
3866
3932
|
#
|
|
3867
3933
|
#
|
|
@@ -3916,7 +3982,7 @@ module Aws::CloudFormation
|
|
|
3916
3982
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html
|
|
3917
3983
|
#
|
|
3918
3984
|
# @option params [required, String] :export_name
|
|
3919
|
-
# The name of the exported output value.
|
|
3985
|
+
# The name of the exported output value. CloudFormation returns the
|
|
3920
3986
|
# stack names that are importing this value.
|
|
3921
3987
|
#
|
|
3922
3988
|
# @option params [String] :next_token
|
|
@@ -3955,8 +4021,8 @@ module Aws::CloudFormation
|
|
|
3955
4021
|
|
|
3956
4022
|
# Returns summary information about stack instances that are associated
|
|
3957
4023
|
# with the specified stack set. You can filter for stack instances that
|
|
3958
|
-
# are associated with a specific
|
|
3959
|
-
#
|
|
4024
|
+
# are associated with a specific account name or Region, or that have a
|
|
4025
|
+
# specific status.
|
|
3960
4026
|
#
|
|
3961
4027
|
# @option params [required, String] :stack_set_name
|
|
3962
4028
|
# The name or unique ID of the stack set that you want to list stack
|
|
@@ -3980,7 +4046,7 @@ module Aws::CloudFormation
|
|
|
3980
4046
|
# The status that stack instances are filtered by.
|
|
3981
4047
|
#
|
|
3982
4048
|
# @option params [String] :stack_instance_account
|
|
3983
|
-
# The name of the
|
|
4049
|
+
# The name of the account that you want to list stack instances for.
|
|
3984
4050
|
#
|
|
3985
4051
|
# @option params [String] :stack_instance_region
|
|
3986
4052
|
# The name of the Region where you want to list stack instances.
|
|
@@ -3998,9 +4064,9 @@ module Aws::CloudFormation
|
|
|
3998
4064
|
# * If you are signed in to a delegated administrator account, specify
|
|
3999
4065
|
# `DELEGATED_ADMIN`.
|
|
4000
4066
|
#
|
|
4001
|
-
# Your
|
|
4002
|
-
#
|
|
4003
|
-
#
|
|
4067
|
+
# Your account must be registered as a delegated administrator in the
|
|
4068
|
+
# management account. For more information, see [Register a delegated
|
|
4069
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
4004
4070
|
#
|
|
4005
4071
|
#
|
|
4006
4072
|
#
|
|
@@ -4150,9 +4216,9 @@ module Aws::CloudFormation
|
|
|
4150
4216
|
# * If you are signed in to a delegated administrator account, specify
|
|
4151
4217
|
# `DELEGATED_ADMIN`.
|
|
4152
4218
|
#
|
|
4153
|
-
# Your
|
|
4154
|
-
#
|
|
4155
|
-
#
|
|
4219
|
+
# Your account must be registered as a delegated administrator in the
|
|
4220
|
+
# management account. For more information, see [Register a delegated
|
|
4221
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
4156
4222
|
#
|
|
4157
4223
|
#
|
|
4158
4224
|
#
|
|
@@ -4230,9 +4296,9 @@ module Aws::CloudFormation
|
|
|
4230
4296
|
# * If you are signed in to a delegated administrator account, specify
|
|
4231
4297
|
# `DELEGATED_ADMIN`.
|
|
4232
4298
|
#
|
|
4233
|
-
# Your
|
|
4234
|
-
#
|
|
4235
|
-
#
|
|
4299
|
+
# Your account must be registered as a delegated administrator in the
|
|
4300
|
+
# management account. For more information, see [Register a delegated
|
|
4301
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
4236
4302
|
#
|
|
4237
4303
|
#
|
|
4238
4304
|
#
|
|
@@ -4277,8 +4343,8 @@ module Aws::CloudFormation
|
|
|
4277
4343
|
# the user.
|
|
4278
4344
|
#
|
|
4279
4345
|
# * \[Self-managed permissions\] If you set the `CallAs` parameter to
|
|
4280
|
-
# `SELF` while signed in to your
|
|
4281
|
-
#
|
|
4346
|
+
# `SELF` while signed in to your account, `ListStackSets` returns all
|
|
4347
|
+
# self-managed stack sets in your account.
|
|
4282
4348
|
#
|
|
4283
4349
|
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
|
4284
4350
|
# `SELF` while signed in to the organization's management account,
|
|
@@ -4320,9 +4386,9 @@ module Aws::CloudFormation
|
|
|
4320
4386
|
# * If you are signed in to a delegated administrator account, specify
|
|
4321
4387
|
# `DELEGATED_ADMIN`.
|
|
4322
4388
|
#
|
|
4323
|
-
# Your
|
|
4324
|
-
#
|
|
4325
|
-
#
|
|
4389
|
+
# Your account must be registered as a delegated administrator in the
|
|
4390
|
+
# management account. For more information, see [Register a delegated
|
|
4391
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
4326
4392
|
#
|
|
4327
4393
|
#
|
|
4328
4394
|
#
|
|
@@ -4612,9 +4678,9 @@ module Aws::CloudFormation
|
|
|
4612
4678
|
#
|
|
4613
4679
|
# @option params [String] :provisioning_type
|
|
4614
4680
|
# For resource types, the provisioning behavior of the resource type.
|
|
4615
|
-
#
|
|
4616
|
-
#
|
|
4617
|
-
#
|
|
4681
|
+
# CloudFormation determines the provisioning type during registration,
|
|
4682
|
+
# based on the types of handlers in the schema handler package
|
|
4683
|
+
# submitted.
|
|
4618
4684
|
#
|
|
4619
4685
|
# Valid values include:
|
|
4620
4686
|
#
|
|
@@ -4758,6 +4824,9 @@ module Aws::CloudFormation
|
|
|
4758
4824
|
# If you do not specify a version number, CloudFormation increments the
|
|
4759
4825
|
# version number by one minor version release.
|
|
4760
4826
|
#
|
|
4827
|
+
# The first time you publish a type, CloudFormation sets the version
|
|
4828
|
+
# number to `1.0.0`, regardless of the value you specify.
|
|
4829
|
+
#
|
|
4761
4830
|
#
|
|
4762
4831
|
#
|
|
4763
4832
|
# [1]: https://semver.org/
|
|
@@ -4872,7 +4941,7 @@ module Aws::CloudFormation
|
|
|
4872
4941
|
# Registers your account as a publisher of public extensions in the
|
|
4873
4942
|
# CloudFormation registry. Public extensions are available for use by
|
|
4874
4943
|
# all CloudFormation users. This publisher ID applies to your account in
|
|
4875
|
-
# all
|
|
4944
|
+
# all Regions.
|
|
4876
4945
|
#
|
|
4877
4946
|
# For information on requirements for registering as a public extension
|
|
4878
4947
|
# publisher, see [Registering your account to publish CloudFormation
|
|
@@ -4885,13 +4954,17 @@ module Aws::CloudFormation
|
|
|
4885
4954
|
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
|
|
4886
4955
|
#
|
|
4887
4956
|
# @option params [Boolean] :accept_terms_and_conditions
|
|
4888
|
-
# Whether you accept the
|
|
4889
|
-
# in the CloudFormation registry. You must accept the terms
|
|
4890
|
-
# conditions in order to register to publish public extensions to
|
|
4891
|
-
# CloudFormation registry.
|
|
4957
|
+
# Whether you accept the [Terms and Conditions][1] for publishing
|
|
4958
|
+
# extensions in the CloudFormation registry. You must accept the terms
|
|
4959
|
+
# and conditions in order to register to publish public extensions to
|
|
4960
|
+
# the CloudFormation registry.
|
|
4892
4961
|
#
|
|
4893
4962
|
# The default is `false`.
|
|
4894
4963
|
#
|
|
4964
|
+
#
|
|
4965
|
+
#
|
|
4966
|
+
# [1]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
|
|
4967
|
+
#
|
|
4895
4968
|
# @option params [String] :connection_arn
|
|
4896
4969
|
# If you are using a Bitbucket or GitHub account for identity
|
|
4897
4970
|
# verification, the Amazon Resource Name (ARN) for your connection to
|
|
@@ -4930,7 +5003,7 @@ module Aws::CloudFormation
|
|
|
4930
5003
|
|
|
4931
5004
|
# Registers an extension with the CloudFormation service. Registering an
|
|
4932
5005
|
# extension makes it available for use in CloudFormation templates in
|
|
4933
|
-
# your
|
|
5006
|
+
# your account, and includes:
|
|
4934
5007
|
#
|
|
4935
5008
|
# * Validating the extension schema
|
|
4936
5009
|
#
|
|
@@ -5006,8 +5079,8 @@ module Aws::CloudFormation
|
|
|
5006
5079
|
# <note markdown="1"> The user registering the extension must be able to access the package
|
|
5007
5080
|
# in the S3 bucket. That is, the user needs to have [GetObject][2]
|
|
5008
5081
|
# permissions for the schema handler package. For more information, see
|
|
5009
|
-
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
|
5010
|
-
# Identity and Access Management User Guide*.
|
|
5082
|
+
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
|
5083
|
+
# *Identity and Access Management User Guide*.
|
|
5011
5084
|
#
|
|
5012
5085
|
# </note>
|
|
5013
5086
|
#
|
|
@@ -5029,14 +5102,14 @@ module Aws::CloudFormation
|
|
|
5029
5102
|
# principle (`resources.cloudformation.amazonaws.com`). For more
|
|
5030
5103
|
# information on adding trust relationships, see [Modifying a role trust
|
|
5031
5104
|
# policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
|
|
5032
|
-
# in the *
|
|
5105
|
+
# in the *Identity and Access Management User Guide*.
|
|
5033
5106
|
#
|
|
5034
|
-
# If your extension calls
|
|
5035
|
-
# create an <i> <a
|
|
5107
|
+
# If your extension calls Amazon Web Services APIs in any of its
|
|
5108
|
+
# handlers, you must create an <i> <a
|
|
5036
5109
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
|
5037
5110
|
# execution role</a> </i> that includes the necessary permissions to
|
|
5038
|
-
# call those
|
|
5039
|
-
# account. When CloudFormation needs to invoke the resource type
|
|
5111
|
+
# call those Amazon Web Services APIs, and provision that execution role
|
|
5112
|
+
# in your account. When CloudFormation needs to invoke the resource type
|
|
5040
5113
|
# handler, CloudFormation assumes this execution role to create a
|
|
5041
5114
|
# temporary session token, which it then passes to the resource type
|
|
5042
5115
|
# handler, thereby supplying your resource type with the appropriate
|
|
@@ -5087,8 +5160,8 @@ module Aws::CloudFormation
|
|
|
5087
5160
|
#
|
|
5088
5161
|
# @option params [String] :stack_policy_body
|
|
5089
5162
|
# Structure containing the stack policy body. For more information, go
|
|
5090
|
-
# to [ Prevent Updates to Stack Resources][1] in the
|
|
5091
|
-
#
|
|
5163
|
+
# to [ Prevent Updates to Stack Resources][1] in the CloudFormation User
|
|
5164
|
+
# Guide. You can specify either the `StackPolicyBody` or the
|
|
5092
5165
|
# `StackPolicyURL` parameter, but not both.
|
|
5093
5166
|
#
|
|
5094
5167
|
#
|
|
@@ -5132,7 +5205,7 @@ module Aws::CloudFormation
|
|
|
5132
5205
|
# It is strongly recommended that you use dynamic references to restrict
|
|
5133
5206
|
# sensitive configuration definitions, such as third-party credentials.
|
|
5134
5207
|
# For more details on dynamic references, see [Using dynamic references
|
|
5135
|
-
# to specify template values][2] in the *
|
|
5208
|
+
# to specify template values][2] in the *CloudFormation User Guide*.
|
|
5136
5209
|
#
|
|
5137
5210
|
#
|
|
5138
5211
|
#
|
|
@@ -5261,11 +5334,11 @@ module Aws::CloudFormation
|
|
|
5261
5334
|
|
|
5262
5335
|
# Sends a signal to the specified resource with a success or failure
|
|
5263
5336
|
# status. You can use the SignalResource API in conjunction with a
|
|
5264
|
-
# creation policy or update policy.
|
|
5265
|
-
#
|
|
5266
|
-
#
|
|
5267
|
-
#
|
|
5268
|
-
#
|
|
5337
|
+
# creation policy or update policy. CloudFormation doesn't proceed with
|
|
5338
|
+
# a stack creation or update until resources receive the required number
|
|
5339
|
+
# of signals or the timeout period is exceeded. The SignalResource API
|
|
5340
|
+
# is useful in cases where you want to send signals from anywhere other
|
|
5341
|
+
# than an Amazon EC2 instance.
|
|
5269
5342
|
#
|
|
5270
5343
|
# @option params [required, String] :stack_name
|
|
5271
5344
|
# The stack name or unique stack ID that includes the resource that you
|
|
@@ -5284,7 +5357,7 @@ module Aws::CloudFormation
|
|
|
5284
5357
|
#
|
|
5285
5358
|
# @option params [required, String] :status
|
|
5286
5359
|
# The status of the signal, which is either success or failure. A
|
|
5287
|
-
# failure signal causes
|
|
5360
|
+
# failure signal causes CloudFormation to immediately fail the stack
|
|
5288
5361
|
# creation or update.
|
|
5289
5362
|
#
|
|
5290
5363
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
@@ -5330,9 +5403,9 @@ module Aws::CloudFormation
|
|
|
5330
5403
|
# * If you are signed in to a delegated administrator account, specify
|
|
5331
5404
|
# `DELEGATED_ADMIN`.
|
|
5332
5405
|
#
|
|
5333
|
-
# Your
|
|
5334
|
-
#
|
|
5335
|
-
#
|
|
5406
|
+
# Your account must be registered as a delegated administrator in the
|
|
5407
|
+
# management account. For more information, see [Register a delegated
|
|
5408
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
5336
5409
|
#
|
|
5337
5410
|
#
|
|
5338
5411
|
#
|
|
@@ -5373,7 +5446,7 @@ module Aws::CloudFormation
|
|
|
5373
5446
|
# version of the extension in your account and region for testing.
|
|
5374
5447
|
#
|
|
5375
5448
|
# To perform testing, CloudFormation assumes the execution role
|
|
5376
|
-
# specified when the
|
|
5449
|
+
# specified when the type was registered. For more information, see
|
|
5377
5450
|
# [RegisterType](AWSCloudFormation/latest/APIReference/API_RegisterType.html).
|
|
5378
5451
|
#
|
|
5379
5452
|
# Once you've initiated testing on an extension using `TestType`, you
|
|
@@ -5432,7 +5505,8 @@ module Aws::CloudFormation
|
|
|
5432
5505
|
# * PutObject
|
|
5433
5506
|
#
|
|
5434
5507
|
# For more information, see [Actions, Resources, and Condition Keys for
|
|
5435
|
-
# Amazon S3][1] in the *
|
|
5508
|
+
# Amazon S3][1] in the *Amazon Web Services Identity and Access
|
|
5509
|
+
# Management User Guide*.
|
|
5436
5510
|
#
|
|
5437
5511
|
#
|
|
5438
5512
|
#
|
|
@@ -5486,7 +5560,7 @@ module Aws::CloudFormation
|
|
|
5486
5560
|
# @option params [String] :template_body
|
|
5487
5561
|
# Structure containing the template body with a minimum length of 1 byte
|
|
5488
5562
|
# and a maximum length of 51,200 bytes. (For more information, go to
|
|
5489
|
-
# [Template Anatomy][1] in the
|
|
5563
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
|
5490
5564
|
#
|
|
5491
5565
|
# Conditional: You must specify only one of the following parameters:
|
|
5492
5566
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
|
@@ -5499,7 +5573,7 @@ module Aws::CloudFormation
|
|
|
5499
5573
|
# @option params [String] :template_url
|
|
5500
5574
|
# Location of file containing the template body. The URL must point to a
|
|
5501
5575
|
# template that is located in an Amazon S3 bucket or a Systems Manager
|
|
5502
|
-
# document. For more information, go to [Template Anatomy][1] in the
|
|
5576
|
+
# document. For more information, go to [Template Anatomy][1] in the
|
|
5503
5577
|
# CloudFormation User Guide.
|
|
5504
5578
|
#
|
|
5505
5579
|
# Conditional: You must specify only one of the following parameters:
|
|
@@ -5550,16 +5624,15 @@ module Aws::CloudFormation
|
|
|
5550
5624
|
#
|
|
5551
5625
|
# @option params [Array<String>] :capabilities
|
|
5552
5626
|
# In some cases, you must explicitly acknowledge that your stack
|
|
5553
|
-
# template contains certain capabilities in order for
|
|
5554
|
-
#
|
|
5627
|
+
# template contains certain capabilities in order for CloudFormation to
|
|
5628
|
+
# update the stack.
|
|
5555
5629
|
#
|
|
5556
5630
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
5557
5631
|
#
|
|
5558
5632
|
# Some stack templates might include resources that can affect
|
|
5559
|
-
# permissions in your
|
|
5560
|
-
#
|
|
5561
|
-
#
|
|
5562
|
-
# capabilities.
|
|
5633
|
+
# permissions in your account; for example, by creating new Identity
|
|
5634
|
+
# and Access Management (IAM) users. For those stacks, you must
|
|
5635
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
|
5563
5636
|
#
|
|
5564
5637
|
# The following IAM resources require you to specify either the
|
|
5565
5638
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
|
@@ -5569,8 +5642,8 @@ module Aws::CloudFormation
|
|
|
5569
5642
|
# * If you have IAM resources with custom names, you *must* specify
|
|
5570
5643
|
# `CAPABILITY_NAMED_IAM`.
|
|
5571
5644
|
#
|
|
5572
|
-
# * If you don't specify either of these capabilities,
|
|
5573
|
-
#
|
|
5645
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
|
5646
|
+
# returns an `InsufficientCapabilities` error.
|
|
5574
5647
|
#
|
|
5575
5648
|
# If your stack template contains these resources, we recommend that
|
|
5576
5649
|
# you review all permissions associated with them and edit their
|
|
@@ -5590,7 +5663,7 @@ module Aws::CloudFormation
|
|
|
5590
5663
|
#
|
|
5591
5664
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
|
5592
5665
|
#
|
|
5593
|
-
# For more information, see [Acknowledging IAM Resources in
|
|
5666
|
+
# For more information, see [Acknowledging IAM Resources in
|
|
5594
5667
|
# CloudFormation Templates][8].
|
|
5595
5668
|
#
|
|
5596
5669
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
@@ -5605,7 +5678,7 @@ module Aws::CloudFormation
|
|
|
5605
5678
|
# update a stack directly from the processed template, without first
|
|
5606
5679
|
# reviewing the resulting changes in a change set, you must
|
|
5607
5680
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
|
5608
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
|
5681
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
|
5609
5682
|
# CloudFormation.
|
|
5610
5683
|
#
|
|
5611
5684
|
# If you want to update a stack from a stack template that contains
|
|
@@ -5617,11 +5690,11 @@ module Aws::CloudFormation
|
|
|
5617
5690
|
#
|
|
5618
5691
|
# Each macro relies on an underlying Lambda service function for
|
|
5619
5692
|
# processing stack templates. Be aware that the Lambda function owner
|
|
5620
|
-
# can update the function operation without
|
|
5693
|
+
# can update the function operation without CloudFormation being
|
|
5621
5694
|
# notified.
|
|
5622
5695
|
#
|
|
5623
|
-
# For more information, see [Using
|
|
5624
|
-
#
|
|
5696
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
|
5697
|
+
# Custom Processing on Templates][11].
|
|
5625
5698
|
#
|
|
5626
5699
|
#
|
|
5627
5700
|
#
|
|
@@ -5643,33 +5716,32 @@ module Aws::CloudFormation
|
|
|
5643
5716
|
# or `Custom::MyCustomInstance`.
|
|
5644
5717
|
#
|
|
5645
5718
|
# If the list of resource types doesn't include a resource that you're
|
|
5646
|
-
# updating, the stack update fails. By default,
|
|
5647
|
-
#
|
|
5648
|
-
#
|
|
5649
|
-
#
|
|
5650
|
-
#
|
|
5719
|
+
# updating, the stack update fails. By default, CloudFormation grants
|
|
5720
|
+
# permissions to all resource types. Identity and Access Management
|
|
5721
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
|
5722
|
+
# in IAM policies. For more information, see [Controlling Access with
|
|
5723
|
+
# Identity and Access Management][1].
|
|
5651
5724
|
#
|
|
5652
5725
|
#
|
|
5653
5726
|
#
|
|
5654
5727
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
|
5655
5728
|
#
|
|
5656
5729
|
# @option params [String] :role_arn
|
|
5657
|
-
# The Amazon Resource Name (ARN) of an
|
|
5658
|
-
#
|
|
5659
|
-
#
|
|
5660
|
-
#
|
|
5661
|
-
#
|
|
5662
|
-
#
|
|
5663
|
-
#
|
|
5664
|
-
#
|
|
5665
|
-
#
|
|
5666
|
-
#
|
|
5667
|
-
# was previously associated with the stack. If no role is available, AWS
|
|
5730
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
|
5731
|
+
# (IAM) role that CloudFormation assumes to update the stack.
|
|
5732
|
+
# CloudFormation uses the role's credentials to make calls on your
|
|
5733
|
+
# behalf. CloudFormation always uses this role for all future operations
|
|
5734
|
+
# on the stack. As long as users have permission to operate on the
|
|
5735
|
+
# stack, CloudFormation uses this role even if the users don't have
|
|
5736
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
|
5737
|
+
#
|
|
5738
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
|
5739
|
+
# previously associated with the stack. If no role is available,
|
|
5668
5740
|
# CloudFormation uses a temporary session that is generated from your
|
|
5669
5741
|
# user credentials.
|
|
5670
5742
|
#
|
|
5671
5743
|
# @option params [Types::RollbackConfiguration] :rollback_configuration
|
|
5672
|
-
# The rollback triggers for
|
|
5744
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
|
5673
5745
|
# creation and updating operations, and for the specified monitoring
|
|
5674
5746
|
# period afterwards.
|
|
5675
5747
|
#
|
|
@@ -5695,23 +5767,23 @@ module Aws::CloudFormation
|
|
|
5695
5767
|
#
|
|
5696
5768
|
# @option params [Array<String>] :notification_arns
|
|
5697
5769
|
# Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
|
|
5698
|
-
# that
|
|
5699
|
-
#
|
|
5770
|
+
# that CloudFormation associates with the stack. Specify an empty list
|
|
5771
|
+
# to remove all notification topics.
|
|
5700
5772
|
#
|
|
5701
5773
|
# @option params [Array<Types::Tag>] :tags
|
|
5702
|
-
# Key-value pairs to associate with this stack.
|
|
5774
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
|
5703
5775
|
# propagates these tags to supported resources in the stack. You can
|
|
5704
5776
|
# specify a maximum number of 50 tags.
|
|
5705
5777
|
#
|
|
5706
|
-
# If you don't specify this parameter,
|
|
5707
|
-
#
|
|
5708
|
-
#
|
|
5778
|
+
# If you don't specify this parameter, CloudFormation doesn't modify
|
|
5779
|
+
# the stack's tags. If you specify an empty value, CloudFormation
|
|
5780
|
+
# removes all associated tags.
|
|
5709
5781
|
#
|
|
5710
5782
|
# @option params [String] :client_request_token
|
|
5711
5783
|
# A unique identifier for this `UpdateStack` request. Specify this token
|
|
5712
|
-
# if you plan to retry requests so that
|
|
5784
|
+
# if you plan to retry requests so that CloudFormation knows that
|
|
5713
5785
|
# you're not attempting to update a stack with the same name. You might
|
|
5714
|
-
# retry `UpdateStack` requests to ensure that
|
|
5786
|
+
# retry `UpdateStack` requests to ensure that CloudFormation
|
|
5715
5787
|
# successfully received them.
|
|
5716
5788
|
#
|
|
5717
5789
|
# All events triggered by a given stack operation are assigned the same
|
|
@@ -5817,7 +5889,7 @@ module Aws::CloudFormation
|
|
|
5817
5889
|
# instances.
|
|
5818
5890
|
#
|
|
5819
5891
|
# @option params [Array<String>] :accounts
|
|
5820
|
-
# \[Self-managed permissions\] The names of one or more
|
|
5892
|
+
# \[Self-managed permissions\] The names of one or more accounts for
|
|
5821
5893
|
# which you want to update parameter values for stack instances. The
|
|
5822
5894
|
# overridden parameter values will be applied to all stack instances in
|
|
5823
5895
|
# the specified accounts and Regions.
|
|
@@ -5825,8 +5897,8 @@ module Aws::CloudFormation
|
|
|
5825
5897
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
5826
5898
|
#
|
|
5827
5899
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
5828
|
-
# \[Service-managed permissions\] The
|
|
5829
|
-
#
|
|
5900
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
|
5901
|
+
# you want to update parameter values for stack instances. If your
|
|
5830
5902
|
# update targets OUs, the overridden parameter values only apply to the
|
|
5831
5903
|
# accounts that are currently in the target OUs and their child OUs.
|
|
5832
5904
|
# Accounts added to the target OUs and their child OUs in the future
|
|
@@ -5845,24 +5917,19 @@ module Aws::CloudFormation
|
|
|
5845
5917
|
#
|
|
5846
5918
|
# Any overridden parameter values will be applied to all stack instances
|
|
5847
5919
|
# in the specified accounts and Regions. When specifying parameters and
|
|
5848
|
-
# their values, be aware of how
|
|
5920
|
+
# their values, be aware of how CloudFormation sets parameter values
|
|
5849
5921
|
# during stack instance update operations:
|
|
5850
5922
|
#
|
|
5851
5923
|
# * To override the current value for a parameter, include the parameter
|
|
5852
5924
|
# and specify its value.
|
|
5853
5925
|
#
|
|
5854
|
-
# * To leave
|
|
5855
|
-
#
|
|
5856
|
-
#
|
|
5857
|
-
# * Do not include the parameter in the list.
|
|
5858
|
-
#
|
|
5859
|
-
# * Include the parameter and specify `UsePreviousValue` as `true`.
|
|
5860
|
-
# (You cannot specify both a value and set `UsePreviousValue` to
|
|
5861
|
-
# `true`.)
|
|
5926
|
+
# * To leave an overridden parameter set to its present value, include
|
|
5927
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You cannot
|
|
5928
|
+
# specify both a value and set `UsePreviousValue` to `true`.)
|
|
5862
5929
|
#
|
|
5863
|
-
# * To set
|
|
5864
|
-
# stack set, specify a parameter list but do not include
|
|
5865
|
-
#
|
|
5930
|
+
# * To set an overridden parameter back to the value specified in the
|
|
5931
|
+
# stack set, specify a parameter list but do not include the parameter
|
|
5932
|
+
# in the list.
|
|
5866
5933
|
#
|
|
5867
5934
|
# * To leave all parameters set to their present values, do not specify
|
|
5868
5935
|
# this property at all.
|
|
@@ -5885,17 +5952,16 @@ module Aws::CloudFormation
|
|
|
5885
5952
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
|
5886
5953
|
#
|
|
5887
5954
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
5888
|
-
# Preferences for how
|
|
5889
|
-
# operation.
|
|
5955
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
|
5890
5956
|
#
|
|
5891
5957
|
# @option params [String] :operation_id
|
|
5892
5958
|
# The unique identifier for this stack set operation.
|
|
5893
5959
|
#
|
|
5894
5960
|
# The operation ID also functions as an idempotency token, to ensure
|
|
5895
|
-
# that
|
|
5896
|
-
#
|
|
5897
|
-
#
|
|
5898
|
-
#
|
|
5961
|
+
# that CloudFormation performs the stack set operation only once, even
|
|
5962
|
+
# if you retry the request multiple times. You might retry stack set
|
|
5963
|
+
# operation requests to ensure that CloudFormation successfully received
|
|
5964
|
+
# them.
|
|
5899
5965
|
#
|
|
5900
5966
|
# If you don't specify an operation ID, the SDK generates one
|
|
5901
5967
|
# automatically.
|
|
@@ -5916,9 +5982,9 @@ module Aws::CloudFormation
|
|
|
5916
5982
|
# * If you are signed in to a delegated administrator account, specify
|
|
5917
5983
|
# `DELEGATED_ADMIN`.
|
|
5918
5984
|
#
|
|
5919
|
-
# Your
|
|
5920
|
-
#
|
|
5921
|
-
#
|
|
5985
|
+
# Your account must be registered as a delegated administrator in the
|
|
5986
|
+
# management account. For more information, see [Register a delegated
|
|
5987
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
5922
5988
|
#
|
|
5923
5989
|
#
|
|
5924
5990
|
#
|
|
@@ -5990,7 +6056,7 @@ module Aws::CloudFormation
|
|
|
5990
6056
|
# @option params [String] :template_body
|
|
5991
6057
|
# The structure that contains the template body, with a minimum length
|
|
5992
6058
|
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
|
5993
|
-
# see [Template Anatomy][1] in the
|
|
6059
|
+
# see [Template Anatomy][1] in the CloudFormation User Guide.
|
|
5994
6060
|
#
|
|
5995
6061
|
# Conditional: You must specify only one of the following parameters:
|
|
5996
6062
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
|
@@ -6003,7 +6069,7 @@ module Aws::CloudFormation
|
|
|
6003
6069
|
# The location of the file that contains the template body. The URL must
|
|
6004
6070
|
# point to a template (maximum size: 460,800 bytes) that is located in
|
|
6005
6071
|
# an Amazon S3 bucket or a Systems Manager document. For more
|
|
6006
|
-
# information, see [Template Anatomy][1] in the
|
|
6072
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
|
6007
6073
|
# Guide.
|
|
6008
6074
|
#
|
|
6009
6075
|
# Conditional: You must specify only one of the following parameters:
|
|
@@ -6025,16 +6091,15 @@ module Aws::CloudFormation
|
|
|
6025
6091
|
#
|
|
6026
6092
|
# @option params [Array<String>] :capabilities
|
|
6027
6093
|
# In some cases, you must explicitly acknowledge that your stack
|
|
6028
|
-
# template contains certain capabilities in order for
|
|
6029
|
-
#
|
|
6094
|
+
# template contains certain capabilities in order for CloudFormation to
|
|
6095
|
+
# update the stack set and its associated stack instances.
|
|
6030
6096
|
#
|
|
6031
6097
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
6032
6098
|
#
|
|
6033
6099
|
# Some stack templates might include resources that can affect
|
|
6034
|
-
# permissions in your
|
|
6035
|
-
#
|
|
6036
|
-
#
|
|
6037
|
-
# capabilities.
|
|
6100
|
+
# permissions in your account; for example, by creating new Identity
|
|
6101
|
+
# and Access Management (IAM) users. For those stacks sets, you must
|
|
6102
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
|
6038
6103
|
#
|
|
6039
6104
|
# The following IAM resources require you to specify either the
|
|
6040
6105
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
|
@@ -6044,8 +6109,8 @@ module Aws::CloudFormation
|
|
|
6044
6109
|
# * If you have IAM resources with custom names, you *must* specify
|
|
6045
6110
|
# `CAPABILITY_NAMED_IAM`.
|
|
6046
6111
|
#
|
|
6047
|
-
# * If you don't specify either of these capabilities,
|
|
6048
|
-
#
|
|
6112
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
|
6113
|
+
# returns an `InsufficientCapabilities` error.
|
|
6049
6114
|
#
|
|
6050
6115
|
# If your stack template contains these resources, we recommend that
|
|
6051
6116
|
# you review all permissions associated with them and edit their
|
|
@@ -6065,7 +6130,7 @@ module Aws::CloudFormation
|
|
|
6065
6130
|
#
|
|
6066
6131
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
|
6067
6132
|
#
|
|
6068
|
-
# For more information, see [Acknowledging IAM Resources in
|
|
6133
|
+
# For more information, see [Acknowledging IAM Resources in
|
|
6069
6134
|
# CloudFormation Templates][8].
|
|
6070
6135
|
#
|
|
6071
6136
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
@@ -6075,13 +6140,13 @@ module Aws::CloudFormation
|
|
|
6075
6140
|
# directly from the processed template, without first reviewing the
|
|
6076
6141
|
# resulting changes in a change set. To update the stack set directly,
|
|
6077
6142
|
# you must acknowledge this capability. For more information, see
|
|
6078
|
-
# [Using
|
|
6143
|
+
# [Using CloudFormation Macros to Perform Custom Processing on
|
|
6079
6144
|
# Templates][9].
|
|
6080
6145
|
#
|
|
6081
6146
|
# Stack sets with service-managed permissions do not currently support
|
|
6082
6147
|
# the use of macros in templates. (This includes the
|
|
6083
6148
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
|
6084
|
-
# macros hosted by
|
|
6149
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
|
6085
6150
|
# capability for a stack set with service-managed permissions, if you
|
|
6086
6151
|
# reference a macro in your template the stack set operation will
|
|
6087
6152
|
# fail.
|
|
@@ -6102,15 +6167,15 @@ module Aws::CloudFormation
|
|
|
6102
6167
|
#
|
|
6103
6168
|
# @option params [Array<Types::Tag>] :tags
|
|
6104
6169
|
# The key-value pairs to associate with this stack set and the stacks
|
|
6105
|
-
# created from it.
|
|
6170
|
+
# created from it. CloudFormation also propagates these tags to
|
|
6106
6171
|
# supported resources that are created in the stacks. You can specify a
|
|
6107
6172
|
# maximum number of 50 tags.
|
|
6108
6173
|
#
|
|
6109
6174
|
# If you specify tags for this parameter, those tags replace any list of
|
|
6110
6175
|
# tags that are currently associated with this stack set. This means:
|
|
6111
6176
|
#
|
|
6112
|
-
# * If you don't specify this parameter,
|
|
6113
|
-
#
|
|
6177
|
+
# * If you don't specify this parameter, CloudFormation doesn't modify
|
|
6178
|
+
# the stack's tags.
|
|
6114
6179
|
#
|
|
6115
6180
|
# * If you specify *any* tags using this parameter, you must specify
|
|
6116
6181
|
# *all* the tags that you want associated with this stack set, even
|
|
@@ -6119,21 +6184,20 @@ module Aws::CloudFormation
|
|
|
6119
6184
|
# you don't include in the updated list of tags are removed from the
|
|
6120
6185
|
# stack set, and therefore from the stacks and resources as well.
|
|
6121
6186
|
#
|
|
6122
|
-
# * If you specify an empty value,
|
|
6123
|
-
#
|
|
6187
|
+
# * If you specify an empty value, CloudFormation removes all currently
|
|
6188
|
+
# associated tags.
|
|
6124
6189
|
#
|
|
6125
|
-
# If you specify new tags as part of an `UpdateStackSet` action,
|
|
6190
|
+
# If you specify new tags as part of an `UpdateStackSet` action,
|
|
6126
6191
|
# CloudFormation checks to see if you have the required IAM permission
|
|
6127
6192
|
# to tag resources. If you omit tags that are currently associated with
|
|
6128
|
-
# the stack set from the list of tags you specify,
|
|
6193
|
+
# the stack set from the list of tags you specify, CloudFormation
|
|
6129
6194
|
# assumes that you want to remove those tags from the stack set, and
|
|
6130
6195
|
# checks to see if you have permission to untag resources. If you don't
|
|
6131
6196
|
# have the necessary permission(s), the entire `UpdateStackSet` action
|
|
6132
6197
|
# fails with an `access denied` error, and the stack set is not updated.
|
|
6133
6198
|
#
|
|
6134
6199
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
6135
|
-
# Preferences for how
|
|
6136
|
-
# operation.
|
|
6200
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
|
6137
6201
|
#
|
|
6138
6202
|
# @option params [String] :administration_role_arn
|
|
6139
6203
|
# The Amazon Resource Number (ARN) of the IAM role to use to update this
|
|
@@ -6142,8 +6206,8 @@ module Aws::CloudFormation
|
|
|
6142
6206
|
# Specify an IAM role only if you are using customized administrator
|
|
6143
6207
|
# roles to control which users or groups can manage specific stack sets
|
|
6144
6208
|
# within the same administrator account. For more information, see
|
|
6145
|
-
# [Granting Permissions for Stack Set Operations][1] in the
|
|
6146
|
-
# CloudFormation User Guide*.
|
|
6209
|
+
# [Granting Permissions for Stack Set Operations][1] in the
|
|
6210
|
+
# *CloudFormation User Guide*.
|
|
6147
6211
|
#
|
|
6148
6212
|
# If you specified a customized administrator role when you created the
|
|
6149
6213
|
# stack set, you must specify a customized administrator role, even if
|
|
@@ -6156,7 +6220,7 @@ module Aws::CloudFormation
|
|
|
6156
6220
|
#
|
|
6157
6221
|
# @option params [String] :execution_role_name
|
|
6158
6222
|
# The name of the IAM execution role to use to update the stack set. If
|
|
6159
|
-
# you do not specify an execution role,
|
|
6223
|
+
# you do not specify an execution role, CloudFormation uses the
|
|
6160
6224
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
|
6161
6225
|
# operation.
|
|
6162
6226
|
#
|
|
@@ -6164,27 +6228,27 @@ module Aws::CloudFormation
|
|
|
6164
6228
|
# to control which stack resources users and groups can include in their
|
|
6165
6229
|
# stack sets.
|
|
6166
6230
|
#
|
|
6167
|
-
# If you specify a customized execution role,
|
|
6168
|
-
#
|
|
6169
|
-
#
|
|
6170
|
-
#
|
|
6171
|
-
#
|
|
6231
|
+
# If you specify a customized execution role, CloudFormation uses that
|
|
6232
|
+
# role to update the stack. If you do not specify a customized execution
|
|
6233
|
+
# role, CloudFormation performs the update using the role previously
|
|
6234
|
+
# associated with the stack set, so long as you have permissions to
|
|
6235
|
+
# perform operations on the stack set.
|
|
6172
6236
|
#
|
|
6173
6237
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
6174
|
-
# \[Service-managed permissions\] The
|
|
6175
|
-
#
|
|
6238
|
+
# \[Service-managed permissions\] The Organizations accounts in which to
|
|
6239
|
+
# update associated stack instances.
|
|
6176
6240
|
#
|
|
6177
6241
|
# To update all the stack instances associated with this stack set, do
|
|
6178
6242
|
# not specify `DeploymentTargets` or `Regions`.
|
|
6179
6243
|
#
|
|
6180
6244
|
# If the stack set update includes changes to the template (that is, if
|
|
6181
6245
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
|
6182
|
-
#
|
|
6183
|
-
#
|
|
6184
|
-
#
|
|
6185
|
-
#
|
|
6186
|
-
#
|
|
6187
|
-
#
|
|
6246
|
+
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
|
6247
|
+
# prior to updating the stack instances in the specified accounts and
|
|
6248
|
+
# Regions. If the stack set update does not include changes to the
|
|
6249
|
+
# template or parameters, CloudFormation updates the stack instances in
|
|
6250
|
+
# the specified accounts and Regions, while leaving all other stack
|
|
6251
|
+
# instances with their existing stack instance status.
|
|
6188
6252
|
#
|
|
6189
6253
|
# @option params [String] :permission_model
|
|
6190
6254
|
# Describes how the IAM roles required for stack set operations are
|
|
@@ -6196,7 +6260,7 @@ module Aws::CloudFormation
|
|
|
6196
6260
|
# information, see [Grant Self-Managed Stack Set Permissions][1].
|
|
6197
6261
|
#
|
|
6198
6262
|
# * With `service-managed` permissions, StackSets automatically creates
|
|
6199
|
-
# the IAM roles required to deploy to accounts managed by
|
|
6263
|
+
# the IAM roles required to deploy to accounts managed by
|
|
6200
6264
|
# Organizations. For more information, see [Grant Service-Managed
|
|
6201
6265
|
# Stack Set Permissions][2].
|
|
6202
6266
|
#
|
|
@@ -6207,8 +6271,8 @@ module Aws::CloudFormation
|
|
|
6207
6271
|
#
|
|
6208
6272
|
# @option params [Types::AutoDeployment] :auto_deployment
|
|
6209
6273
|
# \[Service-managed permissions\] Describes whether StackSets
|
|
6210
|
-
# automatically deploys to
|
|
6211
|
-
#
|
|
6274
|
+
# automatically deploys to Organizations accounts that are added to a
|
|
6275
|
+
# target organization or organizational unit (OU).
|
|
6212
6276
|
#
|
|
6213
6277
|
# If you specify `AutoDeployment`, do not specify `DeploymentTargets` or
|
|
6214
6278
|
# `Regions`.
|
|
@@ -6217,13 +6281,13 @@ module Aws::CloudFormation
|
|
|
6217
6281
|
# The unique ID for this stack set operation.
|
|
6218
6282
|
#
|
|
6219
6283
|
# The operation ID also functions as an idempotency token, to ensure
|
|
6220
|
-
# that
|
|
6221
|
-
#
|
|
6222
|
-
#
|
|
6223
|
-
#
|
|
6284
|
+
# that CloudFormation performs the stack set operation only once, even
|
|
6285
|
+
# if you retry the request multiple times. You might retry stack set
|
|
6286
|
+
# operation requests to ensure that CloudFormation successfully received
|
|
6287
|
+
# them.
|
|
6224
6288
|
#
|
|
6225
|
-
# If you don't specify an operation ID,
|
|
6226
|
-
#
|
|
6289
|
+
# If you don't specify an operation ID, CloudFormation generates one
|
|
6290
|
+
# automatically.
|
|
6227
6291
|
#
|
|
6228
6292
|
# Repeating this stack set operation with a new operation ID retries all
|
|
6229
6293
|
# stack instances whose status is `OUTDATED`.
|
|
@@ -6241,13 +6305,13 @@ module Aws::CloudFormation
|
|
|
6241
6305
|
#
|
|
6242
6306
|
# If the stack set update includes changes to the template (that is, if
|
|
6243
6307
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
|
6244
|
-
# `Parameters` property,
|
|
6245
|
-
#
|
|
6246
|
-
#
|
|
6247
|
-
# include changes to the template or parameters,
|
|
6248
|
-
#
|
|
6249
|
-
#
|
|
6250
|
-
#
|
|
6308
|
+
# `Parameters` property, CloudFormation marks all stack instances with a
|
|
6309
|
+
# status of `OUTDATED` prior to updating the stack instances in the
|
|
6310
|
+
# specified accounts and Regions. If the stack set update does not
|
|
6311
|
+
# include changes to the template or parameters, CloudFormation updates
|
|
6312
|
+
# the stack instances in the specified accounts and Regions, while
|
|
6313
|
+
# leaving all other stack instances with their existing stack instance
|
|
6314
|
+
# status.
|
|
6251
6315
|
#
|
|
6252
6316
|
# @option params [Array<String>] :regions
|
|
6253
6317
|
# The Regions in which to update associated stack instances. If you
|
|
@@ -6259,13 +6323,13 @@ module Aws::CloudFormation
|
|
|
6259
6323
|
#
|
|
6260
6324
|
# If the stack set update includes changes to the template (that is, if
|
|
6261
6325
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
|
6262
|
-
# `Parameters` property,
|
|
6263
|
-
#
|
|
6264
|
-
#
|
|
6265
|
-
# include changes to the template or parameters,
|
|
6266
|
-
#
|
|
6267
|
-
#
|
|
6268
|
-
#
|
|
6326
|
+
# `Parameters` property, CloudFormation marks all stack instances with a
|
|
6327
|
+
# status of `OUTDATED` prior to updating the stack instances in the
|
|
6328
|
+
# specified accounts and Regions. If the stack set update does not
|
|
6329
|
+
# include changes to the template or parameters, CloudFormation updates
|
|
6330
|
+
# the stack instances in the specified accounts and Regions, while
|
|
6331
|
+
# leaving all other stack instances with their existing stack instance
|
|
6332
|
+
# status.
|
|
6269
6333
|
#
|
|
6270
6334
|
# @option params [String] :call_as
|
|
6271
6335
|
# \[Service-managed permissions\] Specifies whether you are acting as an
|
|
@@ -6280,9 +6344,9 @@ module Aws::CloudFormation
|
|
|
6280
6344
|
# * If you are signed in to a delegated administrator account, specify
|
|
6281
6345
|
# `DELEGATED_ADMIN`.
|
|
6282
6346
|
#
|
|
6283
|
-
# Your
|
|
6284
|
-
#
|
|
6285
|
-
#
|
|
6347
|
+
# Your account must be registered as a delegated administrator in the
|
|
6348
|
+
# management account. For more information, see [Register a delegated
|
|
6349
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
|
6286
6350
|
#
|
|
6287
6351
|
#
|
|
6288
6352
|
#
|
|
@@ -6357,8 +6421,8 @@ module Aws::CloudFormation
|
|
|
6357
6421
|
# Updates termination protection for the specified stack. If a user
|
|
6358
6422
|
# attempts to delete a stack with termination protection enabled, the
|
|
6359
6423
|
# operation fails and the stack remains unchanged. For more information,
|
|
6360
|
-
# see [Protecting a Stack From Being Deleted][1] in the *
|
|
6361
|
-
#
|
|
6424
|
+
# see [Protecting a Stack From Being Deleted][1] in the *CloudFormation
|
|
6425
|
+
# User Guide*.
|
|
6362
6426
|
#
|
|
6363
6427
|
# For [nested stacks][2], termination protection is set on the root
|
|
6364
6428
|
# stack and cannot be changed directly on the nested stack.
|
|
@@ -6399,15 +6463,15 @@ module Aws::CloudFormation
|
|
|
6399
6463
|
req.send_request(options)
|
|
6400
6464
|
end
|
|
6401
6465
|
|
|
6402
|
-
# Validates a specified template.
|
|
6403
|
-
# template is valid JSON. If it isn't,
|
|
6404
|
-
# template is valid YAML. If both these checks fail,
|
|
6466
|
+
# Validates a specified template. CloudFormation first checks if the
|
|
6467
|
+
# template is valid JSON. If it isn't, CloudFormation checks if the
|
|
6468
|
+
# template is valid YAML. If both these checks fail, CloudFormation
|
|
6405
6469
|
# returns a template validation error.
|
|
6406
6470
|
#
|
|
6407
6471
|
# @option params [String] :template_body
|
|
6408
6472
|
# Structure containing the template body with a minimum length of 1 byte
|
|
6409
6473
|
# and a maximum length of 51,200 bytes. For more information, go to
|
|
6410
|
-
# [Template Anatomy][1] in the
|
|
6474
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
|
6411
6475
|
#
|
|
6412
6476
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
|
6413
6477
|
# are passed, only `TemplateBody` is used.
|
|
@@ -6420,7 +6484,7 @@ module Aws::CloudFormation
|
|
|
6420
6484
|
# Location of file containing the template body. The URL must point to a
|
|
6421
6485
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
|
6422
6486
|
# bucket or a Systems Manager document. For more information, go to
|
|
6423
|
-
# [Template Anatomy][1] in the
|
|
6487
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
|
6424
6488
|
#
|
|
6425
6489
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
|
6426
6490
|
# are passed, only `TemplateBody` is used.
|
|
@@ -6480,7 +6544,7 @@ module Aws::CloudFormation
|
|
|
6480
6544
|
params: params,
|
|
6481
6545
|
config: config)
|
|
6482
6546
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
|
6483
|
-
context[:gem_version] = '1.
|
|
6547
|
+
context[:gem_version] = '1.54.0'
|
|
6484
6548
|
Seahorse::Client::Request.new(handlers, context)
|
|
6485
6549
|
end
|
|
6486
6550
|
|