aws-sdk-cloudformation 1.0.0.rc9 → 1.0.0.rc10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +974 -16
- data/lib/aws-sdk-cloudformation/client_api.rb +412 -2
- data/lib/aws-sdk-cloudformation/event.rb +11 -1
- data/lib/aws-sdk-cloudformation/resource.rb +17 -3
- data/lib/aws-sdk-cloudformation/stack.rb +48 -6
- data/lib/aws-sdk-cloudformation/types.rb +1607 -19
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8950d5fff5307b3c36fba2256aeac6abc380fdc4
|
4
|
+
data.tar.gz: 364b6ef6665ae5ae9245572362fa4beb06caf809
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 777b6a719a649675fd8823e549b2ae7d3b4a243f01b5d1094240088f1305eaf908b6131e98db4956ae9d9b491f5f9b6005ffb1aa6de079ef3f885639624a81b9
|
7
|
+
data.tar.gz: 7c340d9a8e67c121c35e0687088834d2efb9ef7784066257cda7af8c096554b20cb7b27b3ff04c19f8f52f86582086ab5f8963c4ec684bee37531d4e944bd35e
|
@@ -233,7 +233,7 @@ module Aws::CloudFormation
|
|
233
233
|
# only resources that are in the `UPDATE_FAILED` state because a
|
234
234
|
# rollback failed. You can't specify resources that are in the
|
235
235
|
# `UPDATE_FAILED` state for other reasons, for example, because an
|
236
|
-
# update was
|
236
|
+
# update was cancelled. To check why a resource update failed, use the
|
237
237
|
# DescribeStackResources action, and view the resource status reason.
|
238
238
|
#
|
239
239
|
# Specify this property to skip rolling back resources that AWS
|
@@ -252,15 +252,24 @@ module Aws::CloudFormation
|
|
252
252
|
# dependent resources to fail. In this case, it might not be necessary
|
253
253
|
# to skip the dependent resources.
|
254
254
|
#
|
255
|
-
# To
|
256
|
-
# `NestedStackName.ResourceLogicalID`. If
|
257
|
-
# stack resource (`Type:
|
258
|
-
#
|
259
|
-
#
|
255
|
+
# To skip resources that are part of nested stacks, use the following
|
256
|
+
# format: `NestedStackName.ResourceLogicalID`. If you want to specify
|
257
|
+
# the logical ID of a stack resource (`Type:
|
258
|
+
# AWS::CloudFormation::Stack`) in the `ResourcesToSkip` list, then its
|
259
|
+
# corresponding embedded stack must be in one of the following states:
|
260
|
+
# `DELETE_IN_PROGRESS`, `DELETE_COMPLETE`, or `DELETE_FAILED`.
|
261
|
+
#
|
262
|
+
# <note markdown="1"> Don't confuse a child stack's name with its corresponding logical ID
|
263
|
+
# defined in the parent stack. For an example of a continue update
|
264
|
+
# rollback operation with nested stacks, see [Using ResourcesToSkip to
|
265
|
+
# recover a nested stacks hierarchy][2].
|
266
|
+
#
|
267
|
+
# </note>
|
260
268
|
#
|
261
269
|
#
|
262
270
|
#
|
263
271
|
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed
|
272
|
+
# [2]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks
|
264
273
|
#
|
265
274
|
# @option params [String] :client_request_token
|
266
275
|
# A unique identifier for this `ContinueUpdateRollback` request. Specify
|
@@ -422,7 +431,7 @@ module Aws::CloudFormation
|
|
422
431
|
# @option params [Array<Types::Tag>] :tags
|
423
432
|
# Key-value pairs to associate with this stack. AWS CloudFormation also
|
424
433
|
# propagates these tags to resources in the stack. You can specify a
|
425
|
-
# maximum of
|
434
|
+
# maximum of 50 tags.
|
426
435
|
#
|
427
436
|
# @option params [required, String] :change_set_name
|
428
437
|
# The name of the change set. The name must be unique among all change
|
@@ -485,8 +494,8 @@ module Aws::CloudFormation
|
|
485
494
|
# notification_arns: ["NotificationARN"],
|
486
495
|
# tags: [
|
487
496
|
# {
|
488
|
-
# key: "TagKey",
|
489
|
-
# value: "TagValue",
|
497
|
+
# key: "TagKey", # required
|
498
|
+
# value: "TagValue", # required
|
490
499
|
# },
|
491
500
|
# ],
|
492
501
|
# change_set_name: "ChangeSetName", # required
|
@@ -671,7 +680,7 @@ module Aws::CloudFormation
|
|
671
680
|
# @option params [Array<Types::Tag>] :tags
|
672
681
|
# Key-value pairs to associate with this stack. AWS CloudFormation also
|
673
682
|
# propagates these tags to the resources created in the stack. A maximum
|
674
|
-
# number of
|
683
|
+
# number of 50 tags can be specified.
|
675
684
|
#
|
676
685
|
# @option params [String] :client_request_token
|
677
686
|
# A unique identifier for this `CreateStack` request. Specify this token
|
@@ -680,6 +689,20 @@ module Aws::CloudFormation
|
|
680
689
|
# retry `CreateStack` requests to ensure that AWS CloudFormation
|
681
690
|
# successfully received them.
|
682
691
|
#
|
692
|
+
# All events triggered by a given stack operation are assigned the same
|
693
|
+
# client request token, which you can use to track operations. For
|
694
|
+
# example, if you execute a `CreateStack` operation with the token
|
695
|
+
# `token1`, then all the `StackEvents` generated by that operation will
|
696
|
+
# have `ClientRequestToken` set as `token1`.
|
697
|
+
#
|
698
|
+
# In the console, stack operations display the client request token on
|
699
|
+
# the Events tab. Stack operations that are initiated from the console
|
700
|
+
# use the token format *Console-StackOperation-ID*, which helps you
|
701
|
+
# easily identify the stack operation . For example, if you create a
|
702
|
+
# stack using the console, each stack event would be assigned the same
|
703
|
+
# token in the following format:
|
704
|
+
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
|
705
|
+
#
|
683
706
|
# @return [Types::CreateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
684
707
|
#
|
685
708
|
# * {Types::CreateStackOutput#stack_id #stack_id} => String
|
@@ -708,8 +731,8 @@ module Aws::CloudFormation
|
|
708
731
|
# stack_policy_url: "StackPolicyURL",
|
709
732
|
# tags: [
|
710
733
|
# {
|
711
|
-
# key: "TagKey",
|
712
|
-
# value: "TagValue",
|
734
|
+
# key: "TagKey", # required
|
735
|
+
# value: "TagValue", # required
|
713
736
|
# },
|
714
737
|
# ],
|
715
738
|
# client_request_token: "ClientRequestToken",
|
@@ -728,6 +751,228 @@ module Aws::CloudFormation
|
|
728
751
|
req.send_request(options)
|
729
752
|
end
|
730
753
|
|
754
|
+
# Creates stack instances for the specified accounts, within the
|
755
|
+
# specified regions. A stack instance refers to a stack in a specific
|
756
|
+
# account and region. `Accounts` and `Regions` are required
|
757
|
+
# parameters—you must specify at least one account and one region.
|
758
|
+
#
|
759
|
+
# @option params [required, String] :stack_set_name
|
760
|
+
# The name or unique ID of the stack set that you want to create stack
|
761
|
+
# instances from.
|
762
|
+
#
|
763
|
+
# @option params [required, Array<String>] :accounts
|
764
|
+
# The names of one or more AWS accounts that you want to create stack
|
765
|
+
# instances in the specified region(s) for.
|
766
|
+
#
|
767
|
+
# @option params [required, Array<String>] :regions
|
768
|
+
# The names of one or more regions where you want to create stack
|
769
|
+
# instances using the specified AWS account(s).
|
770
|
+
#
|
771
|
+
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
772
|
+
# Preferences for how AWS CloudFormation performs this stack set
|
773
|
+
# operation.
|
774
|
+
#
|
775
|
+
# @option params [String] :operation_id
|
776
|
+
# The unique identifier for this stack set operation.
|
777
|
+
#
|
778
|
+
# The operation ID also functions as an idempotency token, to ensure
|
779
|
+
# that AWS CloudFormation performs the stack set operation only once,
|
780
|
+
# even if you retry the request multiple times. You might retry stack
|
781
|
+
# set operation requests to ensure that AWS CloudFormation successfully
|
782
|
+
# received them.
|
783
|
+
#
|
784
|
+
# If you don't specify an operation ID, the SDK generates one
|
785
|
+
# automatically.
|
786
|
+
#
|
787
|
+
# Repeating this stack set operation with a new operation ID retries all
|
788
|
+
# stack instances whose status is `OUTDATED`.
|
789
|
+
#
|
790
|
+
# **A suitable default value is auto-generated.** You should normally
|
791
|
+
# not need to pass this option.**
|
792
|
+
#
|
793
|
+
# @return [Types::CreateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
794
|
+
#
|
795
|
+
# * {Types::CreateStackInstancesOutput#operation_id #operation_id} => String
|
796
|
+
#
|
797
|
+
# @example Request syntax with placeholder values
|
798
|
+
#
|
799
|
+
# resp = client.create_stack_instances({
|
800
|
+
# stack_set_name: "StackSetName", # required
|
801
|
+
# accounts: ["Account"], # required
|
802
|
+
# regions: ["Region"], # required
|
803
|
+
# operation_preferences: {
|
804
|
+
# region_order: ["Region"],
|
805
|
+
# failure_tolerance_count: 1,
|
806
|
+
# failure_tolerance_percentage: 1,
|
807
|
+
# max_concurrent_count: 1,
|
808
|
+
# max_concurrent_percentage: 1,
|
809
|
+
# },
|
810
|
+
# operation_id: "ClientRequestToken",
|
811
|
+
# })
|
812
|
+
#
|
813
|
+
# @example Response structure
|
814
|
+
#
|
815
|
+
# resp.operation_id #=> String
|
816
|
+
#
|
817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstances AWS API Documentation
|
818
|
+
#
|
819
|
+
# @overload create_stack_instances(params = {})
|
820
|
+
# @param [Hash] params ({})
|
821
|
+
def create_stack_instances(params = {}, options = {})
|
822
|
+
req = build_request(:create_stack_instances, params)
|
823
|
+
req.send_request(options)
|
824
|
+
end
|
825
|
+
|
826
|
+
# Creates a stack set.
|
827
|
+
#
|
828
|
+
# @option params [required, String] :stack_set_name
|
829
|
+
# The name to associate with the stack set. The name must be unique in
|
830
|
+
# the region where you create your stack set.
|
831
|
+
#
|
832
|
+
# <note markdown="1"> A stack name can contain only alphanumeric characters (case-sensitive)
|
833
|
+
# and hyphens. It must start with an alphabetic character and can't be
|
834
|
+
# longer than 128 characters.
|
835
|
+
#
|
836
|
+
# </note>
|
837
|
+
#
|
838
|
+
# @option params [String] :description
|
839
|
+
# A description of the stack set. You can use the description to
|
840
|
+
# identify the stack set's purpose or other important information.
|
841
|
+
#
|
842
|
+
# @option params [String] :template_body
|
843
|
+
# The structure that contains the template body, with a minimum length
|
844
|
+
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
845
|
+
# see [Template Anatomy][1] in the AWS CloudFormation User Guide.
|
846
|
+
#
|
847
|
+
# Conditional: You must specify either the TemplateBody or the
|
848
|
+
# TemplateURL parameter, but not both.
|
849
|
+
#
|
850
|
+
#
|
851
|
+
#
|
852
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
853
|
+
#
|
854
|
+
# @option params [String] :template_url
|
855
|
+
# The location of the file that contains the template body. The URL must
|
856
|
+
# point to a template (maximum size: 460,800 bytes) that's located in
|
857
|
+
# an Amazon S3 bucket. For more information, see [Template Anatomy][1]
|
858
|
+
# in the AWS CloudFormation User Guide.
|
859
|
+
#
|
860
|
+
# Conditional: You must specify either the TemplateBody or the
|
861
|
+
# TemplateURL parameter, but not both.
|
862
|
+
#
|
863
|
+
#
|
864
|
+
#
|
865
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
866
|
+
#
|
867
|
+
# @option params [Array<Types::Parameter>] :parameters
|
868
|
+
# The input parameters for the stack set template.
|
869
|
+
#
|
870
|
+
# @option params [Array<String>] :capabilities
|
871
|
+
# A list of values that you must specify before AWS CloudFormation can
|
872
|
+
# create certain stack sets. Some stack set templates might include
|
873
|
+
# resources that can affect permissions in your AWS account—for example,
|
874
|
+
# by creating new AWS Identity and Access Management (IAM) users. For
|
875
|
+
# those stack sets, you must explicitly acknowledge their capabilities
|
876
|
+
# by specifying this parameter.
|
877
|
+
#
|
878
|
+
# The only valid values are CAPABILITY\_IAM and CAPABILITY\_NAMED\_IAM.
|
879
|
+
# The following resources require you to specify this parameter:
|
880
|
+
#
|
881
|
+
# * AWS::IAM::AccessKey
|
882
|
+
#
|
883
|
+
# * AWS::IAM::Group
|
884
|
+
#
|
885
|
+
# * AWS::IAM::InstanceProfile
|
886
|
+
#
|
887
|
+
# * AWS::IAM::Policy
|
888
|
+
#
|
889
|
+
# * AWS::IAM::Role
|
890
|
+
#
|
891
|
+
# * AWS::IAM::User
|
892
|
+
#
|
893
|
+
# * AWS::IAM::UserToGroupAddition
|
894
|
+
#
|
895
|
+
# If your stack template contains these resources, we recommend that you
|
896
|
+
# review all permissions that are associated with them and edit their
|
897
|
+
# permissions if necessary.
|
898
|
+
#
|
899
|
+
# If you have IAM resources, you can specify either capability. If you
|
900
|
+
# have IAM resources with custom names, you must specify
|
901
|
+
# CAPABILITY\_NAMED\_IAM. If you don't specify this parameter, this
|
902
|
+
# action returns an `InsufficientCapabilities` error.
|
903
|
+
#
|
904
|
+
# For more information, see [Acknowledging IAM Resources in AWS
|
905
|
+
# CloudFormation Templates.][1]
|
906
|
+
#
|
907
|
+
#
|
908
|
+
#
|
909
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
910
|
+
#
|
911
|
+
# @option params [Array<Types::Tag>] :tags
|
912
|
+
# The key-value pairs to associate with this stack set and the stacks
|
913
|
+
# created from it. AWS CloudFormation also propagates these tags to
|
914
|
+
# supported resources that are created in the stacks. A maximum number
|
915
|
+
# of 50 tags can be specified.
|
916
|
+
#
|
917
|
+
# If you specify tags as part of a `CreateStackSet` action, AWS
|
918
|
+
# CloudFormation checks to see if you have the required IAM permission
|
919
|
+
# to tag resources. If you don't, the entire `CreateStackSet` action
|
920
|
+
# fails with an `access denied` error, and the stack set is not created.
|
921
|
+
#
|
922
|
+
# @option params [String] :client_request_token
|
923
|
+
# A unique identifier for this `CreateStackSet` request. Specify this
|
924
|
+
# token if you plan to retry requests so that AWS CloudFormation knows
|
925
|
+
# that you're not attempting to create another stack set with the same
|
926
|
+
# name. You might retry `CreateStackSet` requests to ensure that AWS
|
927
|
+
# CloudFormation successfully received them.
|
928
|
+
#
|
929
|
+
# If you don't specify an operation ID, the SDK generates one
|
930
|
+
# automatically.
|
931
|
+
#
|
932
|
+
# **A suitable default value is auto-generated.** You should normally
|
933
|
+
# not need to pass this option.**
|
934
|
+
#
|
935
|
+
# @return [Types::CreateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
|
+
#
|
937
|
+
# * {Types::CreateStackSetOutput#stack_set_id #stack_set_id} => String
|
938
|
+
#
|
939
|
+
# @example Request syntax with placeholder values
|
940
|
+
#
|
941
|
+
# resp = client.create_stack_set({
|
942
|
+
# stack_set_name: "StackSetName", # required
|
943
|
+
# description: "Description",
|
944
|
+
# template_body: "TemplateBody",
|
945
|
+
# template_url: "TemplateURL",
|
946
|
+
# parameters: [
|
947
|
+
# {
|
948
|
+
# parameter_key: "ParameterKey",
|
949
|
+
# parameter_value: "ParameterValue",
|
950
|
+
# use_previous_value: false,
|
951
|
+
# },
|
952
|
+
# ],
|
953
|
+
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM
|
954
|
+
# tags: [
|
955
|
+
# {
|
956
|
+
# key: "TagKey", # required
|
957
|
+
# value: "TagValue", # required
|
958
|
+
# },
|
959
|
+
# ],
|
960
|
+
# client_request_token: "ClientRequestToken",
|
961
|
+
# })
|
962
|
+
#
|
963
|
+
# @example Response structure
|
964
|
+
#
|
965
|
+
# resp.stack_set_id #=> String
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSet AWS API Documentation
|
968
|
+
#
|
969
|
+
# @overload create_stack_set(params = {})
|
970
|
+
# @param [Hash] params ({})
|
971
|
+
def create_stack_set(params = {}, options = {})
|
972
|
+
req = build_request(:create_stack_set, params)
|
973
|
+
req.send_request(options)
|
974
|
+
end
|
975
|
+
|
731
976
|
# Deletes the specified change set. Deleting change sets ensures that no
|
732
977
|
# one executes the wrong change set.
|
733
978
|
#
|
@@ -794,6 +1039,20 @@ module Aws::CloudFormation
|
|
794
1039
|
# retry `DeleteStack` requests to ensure that AWS CloudFormation
|
795
1040
|
# successfully received them.
|
796
1041
|
#
|
1042
|
+
# All events triggered by a given stack operation are assigned the same
|
1043
|
+
# client request token, which you can use to track operations. For
|
1044
|
+
# example, if you execute a `CreateStack` operation with the token
|
1045
|
+
# `token1`, then all the `StackEvents` generated by that operation will
|
1046
|
+
# have `ClientRequestToken` set as `token1`.
|
1047
|
+
#
|
1048
|
+
# In the console, stack operations display the client request token on
|
1049
|
+
# the Events tab. Stack operations that are initiated from the console
|
1050
|
+
# use the token format *Console-StackOperation-ID*, which helps you
|
1051
|
+
# easily identify the stack operation . For example, if you create a
|
1052
|
+
# stack using the console, each stack event would be assigned the same
|
1053
|
+
# token in the following format:
|
1054
|
+
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
|
1055
|
+
#
|
797
1056
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
798
1057
|
#
|
799
1058
|
# @example Request syntax with placeholder values
|
@@ -814,6 +1073,106 @@ module Aws::CloudFormation
|
|
814
1073
|
req.send_request(options)
|
815
1074
|
end
|
816
1075
|
|
1076
|
+
# Deletes stack instances for the specified accounts, in the specified
|
1077
|
+
# regions.
|
1078
|
+
#
|
1079
|
+
# @option params [required, String] :stack_set_name
|
1080
|
+
# The name or unique ID of the stack set that you want to delete stack
|
1081
|
+
# instances for.
|
1082
|
+
#
|
1083
|
+
# @option params [required, Array<String>] :accounts
|
1084
|
+
# The names of the AWS accounts that you want to delete stack instances
|
1085
|
+
# for.
|
1086
|
+
#
|
1087
|
+
# @option params [required, Array<String>] :regions
|
1088
|
+
# The regions where you want to delete stack set instances.
|
1089
|
+
#
|
1090
|
+
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1091
|
+
# Preferences for how AWS CloudFormation performs this stack set
|
1092
|
+
# operation.
|
1093
|
+
#
|
1094
|
+
# @option params [required, Boolean] :retain_stacks
|
1095
|
+
# Removes the stack instances from the specified stack set, but doesn't
|
1096
|
+
# delete the stacks. You can't reassociate a retained stack or add an
|
1097
|
+
# existing, saved stack to a new stack set.
|
1098
|
+
#
|
1099
|
+
# @option params [String] :operation_id
|
1100
|
+
# The unique identifier for this stack set operation.
|
1101
|
+
#
|
1102
|
+
# If you don't specify an operation ID, the SDK generates one
|
1103
|
+
# automatically.
|
1104
|
+
#
|
1105
|
+
# The operation ID also functions as an idempotency token, to ensure
|
1106
|
+
# that AWS CloudFormation performs the stack set operation only once,
|
1107
|
+
# even if you retry the request multiple times. You can retry stack set
|
1108
|
+
# operation requests to ensure that AWS CloudFormation successfully
|
1109
|
+
# received them.
|
1110
|
+
#
|
1111
|
+
# Repeating this stack set operation with a new operation ID retries all
|
1112
|
+
# stack instances whose status is `OUTDATED`.
|
1113
|
+
#
|
1114
|
+
# **A suitable default value is auto-generated.** You should normally
|
1115
|
+
# not need to pass this option.**
|
1116
|
+
#
|
1117
|
+
# @return [Types::DeleteStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1118
|
+
#
|
1119
|
+
# * {Types::DeleteStackInstancesOutput#operation_id #operation_id} => String
|
1120
|
+
#
|
1121
|
+
# @example Request syntax with placeholder values
|
1122
|
+
#
|
1123
|
+
# resp = client.delete_stack_instances({
|
1124
|
+
# stack_set_name: "StackSetName", # required
|
1125
|
+
# accounts: ["Account"], # required
|
1126
|
+
# regions: ["Region"], # required
|
1127
|
+
# operation_preferences: {
|
1128
|
+
# region_order: ["Region"],
|
1129
|
+
# failure_tolerance_count: 1,
|
1130
|
+
# failure_tolerance_percentage: 1,
|
1131
|
+
# max_concurrent_count: 1,
|
1132
|
+
# max_concurrent_percentage: 1,
|
1133
|
+
# },
|
1134
|
+
# retain_stacks: false, # required
|
1135
|
+
# operation_id: "ClientRequestToken",
|
1136
|
+
# })
|
1137
|
+
#
|
1138
|
+
# @example Response structure
|
1139
|
+
#
|
1140
|
+
# resp.operation_id #=> String
|
1141
|
+
#
|
1142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstances AWS API Documentation
|
1143
|
+
#
|
1144
|
+
# @overload delete_stack_instances(params = {})
|
1145
|
+
# @param [Hash] params ({})
|
1146
|
+
def delete_stack_instances(params = {}, options = {})
|
1147
|
+
req = build_request(:delete_stack_instances, params)
|
1148
|
+
req.send_request(options)
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
# Deletes a stack set. Before you can delete a stack set, all of its
|
1152
|
+
# member stack instances must be deleted. For more information about how
|
1153
|
+
# to do this, see DeleteStackInstances.
|
1154
|
+
#
|
1155
|
+
# @option params [required, String] :stack_set_name
|
1156
|
+
# The name or unique ID of the stack set that you're deleting. You can
|
1157
|
+
# obtain this value by running ListStackSets.
|
1158
|
+
#
|
1159
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1160
|
+
#
|
1161
|
+
# @example Request syntax with placeholder values
|
1162
|
+
#
|
1163
|
+
# resp = client.delete_stack_set({
|
1164
|
+
# stack_set_name: "StackSetName", # required
|
1165
|
+
# })
|
1166
|
+
#
|
1167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet AWS API Documentation
|
1168
|
+
#
|
1169
|
+
# @overload delete_stack_set(params = {})
|
1170
|
+
# @param [Hash] params ({})
|
1171
|
+
def delete_stack_set(params = {}, options = {})
|
1172
|
+
req = build_request(:delete_stack_set, params)
|
1173
|
+
req.send_request(options)
|
1174
|
+
end
|
1175
|
+
|
817
1176
|
# Retrieves your account's AWS CloudFormation limits, such as the
|
818
1177
|
# maximum number of stacks that you can create in your account.
|
819
1178
|
#
|
@@ -1009,6 +1368,52 @@ module Aws::CloudFormation
|
|
1009
1368
|
req.send_request(options)
|
1010
1369
|
end
|
1011
1370
|
|
1371
|
+
# Returns the stack instance that's associated with the specified stack
|
1372
|
+
# set, AWS account, and region.
|
1373
|
+
#
|
1374
|
+
# For a list of stack instances that are associated with a specific
|
1375
|
+
# stack set, use ListStackInstances.
|
1376
|
+
#
|
1377
|
+
# @option params [required, String] :stack_set_name
|
1378
|
+
# The name or the unique stack ID of the stack set that you want to get
|
1379
|
+
# stack instance information for.
|
1380
|
+
#
|
1381
|
+
# @option params [required, String] :stack_instance_account
|
1382
|
+
# The ID of an AWS account that's associated with this stack instance.
|
1383
|
+
#
|
1384
|
+
# @option params [required, String] :stack_instance_region
|
1385
|
+
# The name of a region that's associated with this stack instance.
|
1386
|
+
#
|
1387
|
+
# @return [Types::DescribeStackInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1388
|
+
#
|
1389
|
+
# * {Types::DescribeStackInstanceOutput#stack_instance #stack_instance} => Types::StackInstance
|
1390
|
+
#
|
1391
|
+
# @example Request syntax with placeholder values
|
1392
|
+
#
|
1393
|
+
# resp = client.describe_stack_instance({
|
1394
|
+
# stack_set_name: "StackSetName", # required
|
1395
|
+
# stack_instance_account: "Account", # required
|
1396
|
+
# stack_instance_region: "Region", # required
|
1397
|
+
# })
|
1398
|
+
#
|
1399
|
+
# @example Response structure
|
1400
|
+
#
|
1401
|
+
# resp.stack_instance.stack_set_id #=> String
|
1402
|
+
# resp.stack_instance.region #=> String
|
1403
|
+
# resp.stack_instance.account #=> String
|
1404
|
+
# resp.stack_instance.stack_id #=> String
|
1405
|
+
# resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
|
1406
|
+
# resp.stack_instance.status_reason #=> String
|
1407
|
+
#
|
1408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstance AWS API Documentation
|
1409
|
+
#
|
1410
|
+
# @overload describe_stack_instance(params = {})
|
1411
|
+
# @param [Hash] params ({})
|
1412
|
+
def describe_stack_instance(params = {}, options = {})
|
1413
|
+
req = build_request(:describe_stack_instance, params)
|
1414
|
+
req.send_request(options)
|
1415
|
+
end
|
1416
|
+
|
1012
1417
|
# Returns a description of the specified resource in the specified
|
1013
1418
|
# stack.
|
1014
1419
|
#
|
@@ -1160,6 +1565,92 @@ module Aws::CloudFormation
|
|
1160
1565
|
req.send_request(options)
|
1161
1566
|
end
|
1162
1567
|
|
1568
|
+
# Returns the description of the specified stack set.
|
1569
|
+
#
|
1570
|
+
# @option params [required, String] :stack_set_name
|
1571
|
+
# The name or unique ID of the stack set whose description you want.
|
1572
|
+
#
|
1573
|
+
# @return [Types::DescribeStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1574
|
+
#
|
1575
|
+
# * {Types::DescribeStackSetOutput#stack_set #stack_set} => Types::StackSet
|
1576
|
+
#
|
1577
|
+
# @example Request syntax with placeholder values
|
1578
|
+
#
|
1579
|
+
# resp = client.describe_stack_set({
|
1580
|
+
# stack_set_name: "StackSetName", # required
|
1581
|
+
# })
|
1582
|
+
#
|
1583
|
+
# @example Response structure
|
1584
|
+
#
|
1585
|
+
# resp.stack_set.stack_set_name #=> String
|
1586
|
+
# resp.stack_set.stack_set_id #=> String
|
1587
|
+
# resp.stack_set.description #=> String
|
1588
|
+
# resp.stack_set.status #=> String, one of "ACTIVE", "DELETED"
|
1589
|
+
# resp.stack_set.template_body #=> String
|
1590
|
+
# resp.stack_set.parameters #=> Array
|
1591
|
+
# resp.stack_set.parameters[0].parameter_key #=> String
|
1592
|
+
# resp.stack_set.parameters[0].parameter_value #=> String
|
1593
|
+
# resp.stack_set.parameters[0].use_previous_value #=> Boolean
|
1594
|
+
# resp.stack_set.capabilities #=> Array
|
1595
|
+
# resp.stack_set.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"
|
1596
|
+
# resp.stack_set.tags #=> Array
|
1597
|
+
# resp.stack_set.tags[0].key #=> String
|
1598
|
+
# resp.stack_set.tags[0].value #=> String
|
1599
|
+
#
|
1600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSet AWS API Documentation
|
1601
|
+
#
|
1602
|
+
# @overload describe_stack_set(params = {})
|
1603
|
+
# @param [Hash] params ({})
|
1604
|
+
def describe_stack_set(params = {}, options = {})
|
1605
|
+
req = build_request(:describe_stack_set, params)
|
1606
|
+
req.send_request(options)
|
1607
|
+
end
|
1608
|
+
|
1609
|
+
# Returns the description of the specified stack set operation.
|
1610
|
+
#
|
1611
|
+
# @option params [required, String] :stack_set_name
|
1612
|
+
# The name or the unique stack ID of the stack set for the stack
|
1613
|
+
# operation.
|
1614
|
+
#
|
1615
|
+
# @option params [required, String] :operation_id
|
1616
|
+
# The unique ID of the stack set operation.
|
1617
|
+
#
|
1618
|
+
# @return [Types::DescribeStackSetOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1619
|
+
#
|
1620
|
+
# * {Types::DescribeStackSetOperationOutput#stack_set_operation #stack_set_operation} => Types::StackSetOperation
|
1621
|
+
#
|
1622
|
+
# @example Request syntax with placeholder values
|
1623
|
+
#
|
1624
|
+
# resp = client.describe_stack_set_operation({
|
1625
|
+
# stack_set_name: "StackSetName", # required
|
1626
|
+
# operation_id: "ClientRequestToken", # required
|
1627
|
+
# })
|
1628
|
+
#
|
1629
|
+
# @example Response structure
|
1630
|
+
#
|
1631
|
+
# resp.stack_set_operation.operation_id #=> String
|
1632
|
+
# resp.stack_set_operation.stack_set_id #=> String
|
1633
|
+
# resp.stack_set_operation.action #=> String, one of "CREATE", "UPDATE", "DELETE"
|
1634
|
+
# resp.stack_set_operation.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED"
|
1635
|
+
# resp.stack_set_operation.operation_preferences.region_order #=> Array
|
1636
|
+
# resp.stack_set_operation.operation_preferences.region_order[0] #=> String
|
1637
|
+
# resp.stack_set_operation.operation_preferences.failure_tolerance_count #=> Integer
|
1638
|
+
# resp.stack_set_operation.operation_preferences.failure_tolerance_percentage #=> Integer
|
1639
|
+
# resp.stack_set_operation.operation_preferences.max_concurrent_count #=> Integer
|
1640
|
+
# resp.stack_set_operation.operation_preferences.max_concurrent_percentage #=> Integer
|
1641
|
+
# resp.stack_set_operation.retain_stacks #=> Boolean
|
1642
|
+
# resp.stack_set_operation.creation_timestamp #=> Time
|
1643
|
+
# resp.stack_set_operation.end_timestamp #=> Time
|
1644
|
+
#
|
1645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperation AWS API Documentation
|
1646
|
+
#
|
1647
|
+
# @overload describe_stack_set_operation(params = {})
|
1648
|
+
# @param [Hash] params ({})
|
1649
|
+
def describe_stack_set_operation(params = {}, options = {})
|
1650
|
+
req = build_request(:describe_stack_set_operation, params)
|
1651
|
+
req.send_request(options)
|
1652
|
+
end
|
1653
|
+
|
1163
1654
|
# Returns the description for the specified stack; if no stack name was
|
1164
1655
|
# specified, then it returns the description for all the stacks created.
|
1165
1656
|
#
|
@@ -1220,6 +1711,7 @@ module Aws::CloudFormation
|
|
1220
1711
|
# resp.stacks[0].outputs[0].output_key #=> String
|
1221
1712
|
# resp.stacks[0].outputs[0].output_value #=> String
|
1222
1713
|
# resp.stacks[0].outputs[0].description #=> String
|
1714
|
+
# resp.stacks[0].outputs[0].export_name #=> String
|
1223
1715
|
# resp.stacks[0].role_arn #=> String
|
1224
1716
|
# resp.stacks[0].tags #=> Array
|
1225
1717
|
# resp.stacks[0].tags[0].key #=> String
|
@@ -1486,6 +1978,10 @@ module Aws::CloudFormation
|
|
1486
1978
|
# Conditional: You must specify only one of the following parameters:
|
1487
1979
|
# `StackName`, `TemplateBody`, or `TemplateURL`.
|
1488
1980
|
#
|
1981
|
+
# @option params [String] :stack_set_name
|
1982
|
+
# The name or unique ID of the stack set from which the stack was
|
1983
|
+
# created.
|
1984
|
+
#
|
1489
1985
|
# @return [Types::GetTemplateSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1490
1986
|
#
|
1491
1987
|
# * {Types::GetTemplateSummaryOutput#parameters #parameters} => Array<Types::ParameterDeclaration>
|
@@ -1503,6 +1999,7 @@ module Aws::CloudFormation
|
|
1503
1999
|
# template_body: "TemplateBody",
|
1504
2000
|
# template_url: "TemplateURL",
|
1505
2001
|
# stack_name: "StackNameOrId",
|
2002
|
+
# stack_set_name: "StackSetNameOrId",
|
1506
2003
|
# })
|
1507
2004
|
#
|
1508
2005
|
# @example Response structure
|
@@ -1675,6 +2172,69 @@ module Aws::CloudFormation
|
|
1675
2172
|
req.send_request(options)
|
1676
2173
|
end
|
1677
2174
|
|
2175
|
+
# Returns summary information about stack instances that are associated
|
2176
|
+
# with the specified stack set. You can filter for stack instances that
|
2177
|
+
# are associated with a specific AWS account name or region.
|
2178
|
+
#
|
2179
|
+
# @option params [required, String] :stack_set_name
|
2180
|
+
# The name or unique ID of the stack set that you want to list stack
|
2181
|
+
# instances for.
|
2182
|
+
#
|
2183
|
+
# @option params [String] :next_token
|
2184
|
+
# If the previous request didn't return all of the remaining results,
|
2185
|
+
# the response's `NextToken` parameter value is set to a token. To
|
2186
|
+
# retrieve the next set of results, call `ListStackInstances` again and
|
2187
|
+
# assign that token to the request object's `NextToken` parameter. If
|
2188
|
+
# there are no remaining results, the previous response object's
|
2189
|
+
# `NextToken` parameter is set to `null`.
|
2190
|
+
#
|
2191
|
+
# @option params [Integer] :max_results
|
2192
|
+
# The maximum number of results to be returned with a single call. If
|
2193
|
+
# the number of available results exceeds this maximum, the response
|
2194
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
2195
|
+
# request parameter to get the next set of results.
|
2196
|
+
#
|
2197
|
+
# @option params [String] :stack_instance_account
|
2198
|
+
# The name of the AWS account that you want to list stack instances for.
|
2199
|
+
#
|
2200
|
+
# @option params [String] :stack_instance_region
|
2201
|
+
# The name of the region where you want to list stack instances.
|
2202
|
+
#
|
2203
|
+
# @return [Types::ListStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2204
|
+
#
|
2205
|
+
# * {Types::ListStackInstancesOutput#summaries #summaries} => Array<Types::StackInstanceSummary>
|
2206
|
+
# * {Types::ListStackInstancesOutput#next_token #next_token} => String
|
2207
|
+
#
|
2208
|
+
# @example Request syntax with placeholder values
|
2209
|
+
#
|
2210
|
+
# resp = client.list_stack_instances({
|
2211
|
+
# stack_set_name: "StackSetName", # required
|
2212
|
+
# next_token: "NextToken",
|
2213
|
+
# max_results: 1,
|
2214
|
+
# stack_instance_account: "Account",
|
2215
|
+
# stack_instance_region: "Region",
|
2216
|
+
# })
|
2217
|
+
#
|
2218
|
+
# @example Response structure
|
2219
|
+
#
|
2220
|
+
# resp.summaries #=> Array
|
2221
|
+
# resp.summaries[0].stack_set_id #=> String
|
2222
|
+
# resp.summaries[0].region #=> String
|
2223
|
+
# resp.summaries[0].account #=> String
|
2224
|
+
# resp.summaries[0].stack_id #=> String
|
2225
|
+
# resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
|
2226
|
+
# resp.summaries[0].status_reason #=> String
|
2227
|
+
# resp.next_token #=> String
|
2228
|
+
#
|
2229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstances AWS API Documentation
|
2230
|
+
#
|
2231
|
+
# @overload list_stack_instances(params = {})
|
2232
|
+
# @param [Hash] params ({})
|
2233
|
+
def list_stack_instances(params = {}, options = {})
|
2234
|
+
req = build_request(:list_stack_instances, params)
|
2235
|
+
req.send_request(options)
|
2236
|
+
end
|
2237
|
+
|
1678
2238
|
# Returns descriptions of all resources of the specified stack.
|
1679
2239
|
#
|
1680
2240
|
# For deleted stacks, ListStackResources returns resource information
|
@@ -1727,6 +2287,170 @@ module Aws::CloudFormation
|
|
1727
2287
|
req.send_request(options)
|
1728
2288
|
end
|
1729
2289
|
|
2290
|
+
# Returns summary information about the results of a stack set
|
2291
|
+
# operation.
|
2292
|
+
#
|
2293
|
+
# @option params [required, String] :stack_set_name
|
2294
|
+
# The name or unique ID of the stack set that you want to get operation
|
2295
|
+
# results for.
|
2296
|
+
#
|
2297
|
+
# @option params [required, String] :operation_id
|
2298
|
+
# The ID of the stack set operation.
|
2299
|
+
#
|
2300
|
+
# @option params [String] :next_token
|
2301
|
+
# If the previous request didn't return all of the remaining results,
|
2302
|
+
# the response object's `NextToken` parameter value is set to a token.
|
2303
|
+
# To retrieve the next set of results, call
|
2304
|
+
# `ListStackSetOperationResults` again and assign that token to the
|
2305
|
+
# request object's `NextToken` parameter. If there are no remaining
|
2306
|
+
# results, the previous response object's `NextToken` parameter is set
|
2307
|
+
# to `null`.
|
2308
|
+
#
|
2309
|
+
# @option params [Integer] :max_results
|
2310
|
+
# The maximum number of results to be returned with a single call. If
|
2311
|
+
# the number of available results exceeds this maximum, the response
|
2312
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
2313
|
+
# request parameter to get the next set of results.
|
2314
|
+
#
|
2315
|
+
# @return [Types::ListStackSetOperationResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2316
|
+
#
|
2317
|
+
# * {Types::ListStackSetOperationResultsOutput#summaries #summaries} => Array<Types::StackSetOperationResultSummary>
|
2318
|
+
# * {Types::ListStackSetOperationResultsOutput#next_token #next_token} => String
|
2319
|
+
#
|
2320
|
+
# @example Request syntax with placeholder values
|
2321
|
+
#
|
2322
|
+
# resp = client.list_stack_set_operation_results({
|
2323
|
+
# stack_set_name: "StackSetName", # required
|
2324
|
+
# operation_id: "ClientRequestToken", # required
|
2325
|
+
# next_token: "NextToken",
|
2326
|
+
# max_results: 1,
|
2327
|
+
# })
|
2328
|
+
#
|
2329
|
+
# @example Response structure
|
2330
|
+
#
|
2331
|
+
# resp.summaries #=> Array
|
2332
|
+
# resp.summaries[0].account #=> String
|
2333
|
+
# resp.summaries[0].region #=> String
|
2334
|
+
# resp.summaries[0].status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
|
2335
|
+
# resp.summaries[0].status_reason #=> String
|
2336
|
+
# resp.summaries[0].account_gate_result.status #=> String, one of "SUCCEEDED", "FAILED", "SKIPPED"
|
2337
|
+
# resp.summaries[0].account_gate_result.status_reason #=> String
|
2338
|
+
# resp.next_token #=> String
|
2339
|
+
#
|
2340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationResults AWS API Documentation
|
2341
|
+
#
|
2342
|
+
# @overload list_stack_set_operation_results(params = {})
|
2343
|
+
# @param [Hash] params ({})
|
2344
|
+
def list_stack_set_operation_results(params = {}, options = {})
|
2345
|
+
req = build_request(:list_stack_set_operation_results, params)
|
2346
|
+
req.send_request(options)
|
2347
|
+
end
|
2348
|
+
|
2349
|
+
# Returns summary information about operations performed on a stack set.
|
2350
|
+
#
|
2351
|
+
# @option params [required, String] :stack_set_name
|
2352
|
+
# The name or unique ID of the stack set that you want to get operation
|
2353
|
+
# summaries for.
|
2354
|
+
#
|
2355
|
+
# @option params [String] :next_token
|
2356
|
+
# If the previous paginated request didn't return all of the remaining
|
2357
|
+
# results, the response object's `NextToken` parameter value is set to
|
2358
|
+
# a token. To retrieve the next set of results, call
|
2359
|
+
# `ListStackSetOperations` again and assign that token to the request
|
2360
|
+
# object's `NextToken` parameter. If there are no remaining results,
|
2361
|
+
# the previous response object's `NextToken` parameter is set to
|
2362
|
+
# `null`.
|
2363
|
+
#
|
2364
|
+
# @option params [Integer] :max_results
|
2365
|
+
# The maximum number of results to be returned with a single call. If
|
2366
|
+
# the number of available results exceeds this maximum, the response
|
2367
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
2368
|
+
# request parameter to get the next set of results.
|
2369
|
+
#
|
2370
|
+
# @return [Types::ListStackSetOperationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2371
|
+
#
|
2372
|
+
# * {Types::ListStackSetOperationsOutput#summaries #summaries} => Array<Types::StackSetOperationSummary>
|
2373
|
+
# * {Types::ListStackSetOperationsOutput#next_token #next_token} => String
|
2374
|
+
#
|
2375
|
+
# @example Request syntax with placeholder values
|
2376
|
+
#
|
2377
|
+
# resp = client.list_stack_set_operations({
|
2378
|
+
# stack_set_name: "StackSetName", # required
|
2379
|
+
# next_token: "NextToken",
|
2380
|
+
# max_results: 1,
|
2381
|
+
# })
|
2382
|
+
#
|
2383
|
+
# @example Response structure
|
2384
|
+
#
|
2385
|
+
# resp.summaries #=> Array
|
2386
|
+
# resp.summaries[0].operation_id #=> String
|
2387
|
+
# resp.summaries[0].action #=> String, one of "CREATE", "UPDATE", "DELETE"
|
2388
|
+
# resp.summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED"
|
2389
|
+
# resp.summaries[0].creation_timestamp #=> Time
|
2390
|
+
# resp.summaries[0].end_timestamp #=> Time
|
2391
|
+
# resp.next_token #=> String
|
2392
|
+
#
|
2393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperations AWS API Documentation
|
2394
|
+
#
|
2395
|
+
# @overload list_stack_set_operations(params = {})
|
2396
|
+
# @param [Hash] params ({})
|
2397
|
+
def list_stack_set_operations(params = {}, options = {})
|
2398
|
+
req = build_request(:list_stack_set_operations, params)
|
2399
|
+
req.send_request(options)
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
# Returns summary information about stack sets that are associated with
|
2403
|
+
# the user.
|
2404
|
+
#
|
2405
|
+
# @option params [String] :next_token
|
2406
|
+
# If the previous paginated request didn't return all of the remaining
|
2407
|
+
# results, the response object's `NextToken` parameter value is set to
|
2408
|
+
# a token. To retrieve the next set of results, call `ListStackSets`
|
2409
|
+
# again and assign that token to the request object's `NextToken`
|
2410
|
+
# parameter. If there are no remaining results, the previous response
|
2411
|
+
# object's `NextToken` parameter is set to `null`.
|
2412
|
+
#
|
2413
|
+
# @option params [Integer] :max_results
|
2414
|
+
# The maximum number of results to be returned with a single call. If
|
2415
|
+
# the number of available results exceeds this maximum, the response
|
2416
|
+
# includes a `NextToken` value that you can assign to the `NextToken`
|
2417
|
+
# request parameter to get the next set of results.
|
2418
|
+
#
|
2419
|
+
# @option params [String] :status
|
2420
|
+
# The status of the stack sets that you want to get summary information
|
2421
|
+
# about.
|
2422
|
+
#
|
2423
|
+
# @return [Types::ListStackSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2424
|
+
#
|
2425
|
+
# * {Types::ListStackSetsOutput#summaries #summaries} => Array<Types::StackSetSummary>
|
2426
|
+
# * {Types::ListStackSetsOutput#next_token #next_token} => String
|
2427
|
+
#
|
2428
|
+
# @example Request syntax with placeholder values
|
2429
|
+
#
|
2430
|
+
# resp = client.list_stack_sets({
|
2431
|
+
# next_token: "NextToken",
|
2432
|
+
# max_results: 1,
|
2433
|
+
# status: "ACTIVE", # accepts ACTIVE, DELETED
|
2434
|
+
# })
|
2435
|
+
#
|
2436
|
+
# @example Response structure
|
2437
|
+
#
|
2438
|
+
# resp.summaries #=> Array
|
2439
|
+
# resp.summaries[0].stack_set_name #=> String
|
2440
|
+
# resp.summaries[0].stack_set_id #=> String
|
2441
|
+
# resp.summaries[0].description #=> String
|
2442
|
+
# resp.summaries[0].status #=> String, one of "ACTIVE", "DELETED"
|
2443
|
+
# resp.next_token #=> String
|
2444
|
+
#
|
2445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSets AWS API Documentation
|
2446
|
+
#
|
2447
|
+
# @overload list_stack_sets(params = {})
|
2448
|
+
# @param [Hash] params ({})
|
2449
|
+
def list_stack_sets(params = {}, options = {})
|
2450
|
+
req = build_request(:list_stack_sets, params)
|
2451
|
+
req.send_request(options)
|
2452
|
+
end
|
2453
|
+
|
1730
2454
|
# Returns the summary information for stacks whose status matches the
|
1731
2455
|
# specified StackStatusFilter. Summary information for stacks that have
|
1732
2456
|
# been deleted is kept for 90 days after the stack is deleted. If no
|
@@ -1866,6 +2590,34 @@ module Aws::CloudFormation
|
|
1866
2590
|
req.send_request(options)
|
1867
2591
|
end
|
1868
2592
|
|
2593
|
+
# Stops an in-progress operation on a stack set and its associated stack
|
2594
|
+
# instances.
|
2595
|
+
#
|
2596
|
+
# @option params [required, String] :stack_set_name
|
2597
|
+
# The name or unique ID of the stack set that you want to stop the
|
2598
|
+
# operation for.
|
2599
|
+
#
|
2600
|
+
# @option params [required, String] :operation_id
|
2601
|
+
# The ID of the stack operation.
|
2602
|
+
#
|
2603
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2604
|
+
#
|
2605
|
+
# @example Request syntax with placeholder values
|
2606
|
+
#
|
2607
|
+
# resp = client.stop_stack_set_operation({
|
2608
|
+
# stack_set_name: "StackSetName", # required
|
2609
|
+
# operation_id: "ClientRequestToken", # required
|
2610
|
+
# })
|
2611
|
+
#
|
2612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation AWS API Documentation
|
2613
|
+
#
|
2614
|
+
# @overload stop_stack_set_operation(params = {})
|
2615
|
+
# @param [Hash] params ({})
|
2616
|
+
def stop_stack_set_operation(params = {}, options = {})
|
2617
|
+
req = build_request(:stop_stack_set_operation, params)
|
2618
|
+
req.send_request(options)
|
2619
|
+
end
|
2620
|
+
|
1869
2621
|
# Updates a stack as specified in the template. After the call completes
|
1870
2622
|
# successfully, the stack update starts. You can check the status of the
|
1871
2623
|
# stack via the DescribeStacks action.
|
@@ -2043,7 +2795,7 @@ module Aws::CloudFormation
|
|
2043
2795
|
# @option params [Array<Types::Tag>] :tags
|
2044
2796
|
# Key-value pairs to associate with this stack. AWS CloudFormation also
|
2045
2797
|
# propagates these tags to supported resources in the stack. You can
|
2046
|
-
# specify a maximum number of
|
2798
|
+
# specify a maximum number of 50 tags.
|
2047
2799
|
#
|
2048
2800
|
# If you don't specify this parameter, AWS CloudFormation doesn't
|
2049
2801
|
# modify the stack's tags. If you specify an empty value, AWS
|
@@ -2056,6 +2808,20 @@ module Aws::CloudFormation
|
|
2056
2808
|
# retry `UpdateStack` requests to ensure that AWS CloudFormation
|
2057
2809
|
# successfully received them.
|
2058
2810
|
#
|
2811
|
+
# All events triggered by a given stack operation are assigned the same
|
2812
|
+
# client request token, which you can use to track operations. For
|
2813
|
+
# example, if you execute a `CreateStack` operation with the token
|
2814
|
+
# `token1`, then all the `StackEvents` generated by that operation will
|
2815
|
+
# have `ClientRequestToken` set as `token1`.
|
2816
|
+
#
|
2817
|
+
# In the console, stack operations display the client request token on
|
2818
|
+
# the Events tab. Stack operations that are initiated from the console
|
2819
|
+
# use the token format *Console-StackOperation-ID*, which helps you
|
2820
|
+
# easily identify the stack operation . For example, if you create a
|
2821
|
+
# stack using the console, each stack event would be assigned the same
|
2822
|
+
# token in the following format:
|
2823
|
+
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
|
2824
|
+
#
|
2059
2825
|
# @return [Types::UpdateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2060
2826
|
#
|
2061
2827
|
# * {Types::UpdateStackOutput#stack_id #stack_id} => String
|
@@ -2084,8 +2850,8 @@ module Aws::CloudFormation
|
|
2084
2850
|
# notification_arns: ["NotificationARN"],
|
2085
2851
|
# tags: [
|
2086
2852
|
# {
|
2087
|
-
# key: "TagKey",
|
2088
|
-
# value: "TagValue",
|
2853
|
+
# key: "TagKey", # required
|
2854
|
+
# value: "TagValue", # required
|
2089
2855
|
# },
|
2090
2856
|
# ],
|
2091
2857
|
# client_request_token: "ClientRequestToken",
|
@@ -2104,6 +2870,198 @@ module Aws::CloudFormation
|
|
2104
2870
|
req.send_request(options)
|
2105
2871
|
end
|
2106
2872
|
|
2873
|
+
# Updates the stack set and *all* associated stack instances.
|
2874
|
+
#
|
2875
|
+
# Even if the stack set operation created by updating the stack set
|
2876
|
+
# fails (completely or partially, below or above a specified failure
|
2877
|
+
# tolerance), the stack set is updated with your changes. Subsequent
|
2878
|
+
# CreateStackInstances calls on the specified stack set use the updated
|
2879
|
+
# stack set.
|
2880
|
+
#
|
2881
|
+
# @option params [required, String] :stack_set_name
|
2882
|
+
# The name or unique ID of the stack set that you want to update.
|
2883
|
+
#
|
2884
|
+
# @option params [String] :description
|
2885
|
+
# A brief description of updates that you are making.
|
2886
|
+
#
|
2887
|
+
# @option params [String] :template_body
|
2888
|
+
# The structure that contains the template body, with a minimum length
|
2889
|
+
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
2890
|
+
# see [Template Anatomy][1] in the AWS CloudFormation User Guide.
|
2891
|
+
#
|
2892
|
+
# Conditional: You must specify only one of the following parameters:
|
2893
|
+
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
2894
|
+
#
|
2895
|
+
#
|
2896
|
+
#
|
2897
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
2898
|
+
#
|
2899
|
+
# @option params [String] :template_url
|
2900
|
+
# The location of the file that contains the template body. The URL must
|
2901
|
+
# point to a template (maximum size: 460,800 bytes) that is located in
|
2902
|
+
# an Amazon S3 bucket. For more information, see [Template Anatomy][1]
|
2903
|
+
# in the AWS CloudFormation User Guide.
|
2904
|
+
#
|
2905
|
+
# Conditional: You must specify only one of the following parameters:
|
2906
|
+
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
2907
|
+
#
|
2908
|
+
#
|
2909
|
+
#
|
2910
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
2911
|
+
#
|
2912
|
+
# @option params [Boolean] :use_previous_template
|
2913
|
+
# Use the existing template that's associated with the stack set that
|
2914
|
+
# you're updating.
|
2915
|
+
#
|
2916
|
+
# Conditional: You must specify only one of the following parameters:
|
2917
|
+
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
2918
|
+
#
|
2919
|
+
# @option params [Array<Types::Parameter>] :parameters
|
2920
|
+
# A list of input parameters for the stack set template.
|
2921
|
+
#
|
2922
|
+
# @option params [Array<String>] :capabilities
|
2923
|
+
# A list of values that you must specify before AWS CloudFormation can
|
2924
|
+
# create certain stack sets. Some stack set templates might include
|
2925
|
+
# resources that can affect permissions in your AWS account—for example,
|
2926
|
+
# by creating new AWS Identity and Access Management (IAM) users. For
|
2927
|
+
# those stack sets, you must explicitly acknowledge their capabilities
|
2928
|
+
# by specifying this parameter.
|
2929
|
+
#
|
2930
|
+
# The only valid values are CAPABILITY\_IAM and CAPABILITY\_NAMED\_IAM.
|
2931
|
+
# The following resources require you to specify this parameter:
|
2932
|
+
#
|
2933
|
+
# * AWS::IAM::AccessKey
|
2934
|
+
#
|
2935
|
+
# * AWS::IAM::Group
|
2936
|
+
#
|
2937
|
+
# * AWS::IAM::InstanceProfile
|
2938
|
+
#
|
2939
|
+
# * AWS::IAM::Policy
|
2940
|
+
#
|
2941
|
+
# * AWS::IAM::Role
|
2942
|
+
#
|
2943
|
+
# * AWS::IAM::User
|
2944
|
+
#
|
2945
|
+
# * AWS::IAM::UserToGroupAddition
|
2946
|
+
#
|
2947
|
+
# If your stack template contains these resources, we recommend that you
|
2948
|
+
# review all permissions that are associated with them and edit their
|
2949
|
+
# permissions if necessary.
|
2950
|
+
#
|
2951
|
+
# If you have IAM resources, you can specify either capability. If you
|
2952
|
+
# have IAM resources with custom names, you must specify
|
2953
|
+
# CAPABILITY\_NAMED\_IAM. If you don't specify this parameter, this
|
2954
|
+
# action returns an `InsufficientCapabilities` error.
|
2955
|
+
#
|
2956
|
+
# For more information, see [Acknowledging IAM Resources in AWS
|
2957
|
+
# CloudFormation Templates.][1]
|
2958
|
+
#
|
2959
|
+
#
|
2960
|
+
#
|
2961
|
+
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
2962
|
+
#
|
2963
|
+
# @option params [Array<Types::Tag>] :tags
|
2964
|
+
# The key-value pairs to associate with this stack set and the stacks
|
2965
|
+
# created from it. AWS CloudFormation also propagates these tags to
|
2966
|
+
# supported resources that are created in the stacks. You can specify a
|
2967
|
+
# maximum number of 50 tags.
|
2968
|
+
#
|
2969
|
+
# If you specify tags for this parameter, those tags replace any list of
|
2970
|
+
# tags that are currently associated with this stack set. This means:
|
2971
|
+
#
|
2972
|
+
# * If you don't specify this parameter, AWS CloudFormation doesn't
|
2973
|
+
# modify the stack's tags.
|
2974
|
+
#
|
2975
|
+
# * If you specify *any* tags using this parameter, you must specify
|
2976
|
+
# *all* the tags that you want associated with this stack set, even
|
2977
|
+
# tags you've specifed before (for example, when creating the stack
|
2978
|
+
# set or during a previous update of the stack set.). Any tags that
|
2979
|
+
# you don't include in the updated list of tags are removed from the
|
2980
|
+
# stack set, and therefore from the stacks and resources as well.
|
2981
|
+
#
|
2982
|
+
# * If you specify an empty value, AWS CloudFormation removes all
|
2983
|
+
# currently associated tags.
|
2984
|
+
#
|
2985
|
+
# If you specify new tags as part of an `UpdateStackSet` action, AWS
|
2986
|
+
# CloudFormation checks to see if you have the required IAM permission
|
2987
|
+
# to tag resources. If you omit tags that are currently associated with
|
2988
|
+
# the stack set from the list of tags you specify, AWS CloudFormation
|
2989
|
+
# assumes that you want to remove those tags from the stack set, and
|
2990
|
+
# checks to see if you have permission to untag resources. If you don't
|
2991
|
+
# have the necessary permission(s), the entire `UpdateStackSet` action
|
2992
|
+
# fails with an `access denied` error, and the stack set is not updated.
|
2993
|
+
#
|
2994
|
+
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
2995
|
+
# Preferences for how AWS CloudFormation performs this stack set
|
2996
|
+
# operation.
|
2997
|
+
#
|
2998
|
+
# @option params [String] :operation_id
|
2999
|
+
# The unique ID for this stack set operation.
|
3000
|
+
#
|
3001
|
+
# The operation ID also functions as an idempotency token, to ensure
|
3002
|
+
# that AWS CloudFormation performs the stack set operation only once,
|
3003
|
+
# even if you retry the request multiple times. You might retry stack
|
3004
|
+
# set operation requests to ensure that AWS CloudFormation successfully
|
3005
|
+
# received them.
|
3006
|
+
#
|
3007
|
+
# If you don't specify an operation ID, AWS CloudFormation generates
|
3008
|
+
# one automatically.
|
3009
|
+
#
|
3010
|
+
# Repeating this stack set operation with a new operation ID retries all
|
3011
|
+
# stack instances whose status is `OUTDATED`.
|
3012
|
+
#
|
3013
|
+
# **A suitable default value is auto-generated.** You should normally
|
3014
|
+
# not need to pass this option.**
|
3015
|
+
#
|
3016
|
+
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3017
|
+
#
|
3018
|
+
# * {Types::UpdateStackSetOutput#operation_id #operation_id} => String
|
3019
|
+
#
|
3020
|
+
# @example Request syntax with placeholder values
|
3021
|
+
#
|
3022
|
+
# resp = client.update_stack_set({
|
3023
|
+
# stack_set_name: "StackSetName", # required
|
3024
|
+
# description: "Description",
|
3025
|
+
# template_body: "TemplateBody",
|
3026
|
+
# template_url: "TemplateURL",
|
3027
|
+
# use_previous_template: false,
|
3028
|
+
# parameters: [
|
3029
|
+
# {
|
3030
|
+
# parameter_key: "ParameterKey",
|
3031
|
+
# parameter_value: "ParameterValue",
|
3032
|
+
# use_previous_value: false,
|
3033
|
+
# },
|
3034
|
+
# ],
|
3035
|
+
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM
|
3036
|
+
# tags: [
|
3037
|
+
# {
|
3038
|
+
# key: "TagKey", # required
|
3039
|
+
# value: "TagValue", # required
|
3040
|
+
# },
|
3041
|
+
# ],
|
3042
|
+
# operation_preferences: {
|
3043
|
+
# region_order: ["Region"],
|
3044
|
+
# failure_tolerance_count: 1,
|
3045
|
+
# failure_tolerance_percentage: 1,
|
3046
|
+
# max_concurrent_count: 1,
|
3047
|
+
# max_concurrent_percentage: 1,
|
3048
|
+
# },
|
3049
|
+
# operation_id: "ClientRequestToken",
|
3050
|
+
# })
|
3051
|
+
#
|
3052
|
+
# @example Response structure
|
3053
|
+
#
|
3054
|
+
# resp.operation_id #=> String
|
3055
|
+
#
|
3056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSet AWS API Documentation
|
3057
|
+
#
|
3058
|
+
# @overload update_stack_set(params = {})
|
3059
|
+
# @param [Hash] params ({})
|
3060
|
+
def update_stack_set(params = {}, options = {})
|
3061
|
+
req = build_request(:update_stack_set, params)
|
3062
|
+
req.send_request(options)
|
3063
|
+
end
|
3064
|
+
|
2107
3065
|
# Validates a specified template. AWS CloudFormation first checks if the
|
2108
3066
|
# template is valid JSON. If it isn't, AWS CloudFormation checks if the
|
2109
3067
|
# template is valid YAML. If both these checks fail, AWS CloudFormation
|
@@ -2185,7 +3143,7 @@ module Aws::CloudFormation
|
|
2185
3143
|
params: params,
|
2186
3144
|
config: config)
|
2187
3145
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
2188
|
-
context[:gem_version] = '1.0.0.
|
3146
|
+
context[:gem_version] = '1.0.0.rc10'
|
2189
3147
|
Seahorse::Client::Request.new(handlers, context)
|
2190
3148
|
end
|
2191
3149
|
|