aws-sdk-cloudformation 1.62.0 → 1.66.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +329 -233
- data/lib/aws-sdk-cloudformation/client_api.rb +67 -0
- data/lib/aws-sdk-cloudformation/event.rb +36 -0
- data/lib/aws-sdk-cloudformation/resource.rb +20 -20
- data/lib/aws-sdk-cloudformation/stack.rb +31 -30
- data/lib/aws-sdk-cloudformation/stack_resource.rb +2 -2
- data/lib/aws-sdk-cloudformation/types.rb +558 -317
- data/lib/aws-sdk-cloudformation.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::CloudFormation
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::Query)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::CloudFormation
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::CloudFormation
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -295,7 +305,7 @@ module Aws::CloudFormation
|
|
295
305
|
# seconds to wait when opening a HTTP session before raising a
|
296
306
|
# `Timeout::Error`.
|
297
307
|
#
|
298
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
309
|
# number of seconds to wait for response data. This value can
|
300
310
|
# safely be set per-request on the session.
|
301
311
|
#
|
@@ -311,6 +321,9 @@ module Aws::CloudFormation
|
|
311
321
|
# disables this behaviour. This value can safely be set per
|
312
322
|
# request on the session.
|
313
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
314
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
328
|
# HTTP debug output will be sent to the `:logger`.
|
316
329
|
#
|
@@ -427,7 +440,7 @@ module Aws::CloudFormation
|
|
427
440
|
# @example Request syntax with placeholder values
|
428
441
|
#
|
429
442
|
# resp = client.activate_type({
|
430
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
443
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
431
444
|
# public_type_arn: "ThirdPartyTypeArn",
|
432
445
|
# publisher_id: "PublisherId",
|
433
446
|
# type_name: "TypeName",
|
@@ -483,7 +496,7 @@ module Aws::CloudFormation
|
|
483
496
|
# type_arn: "TypeArn",
|
484
497
|
# type_configuration_alias: "TypeConfigurationAlias",
|
485
498
|
# type_configuration_arn: "TypeConfigurationArn",
|
486
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
499
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
487
500
|
# type_name: "TypeName",
|
488
501
|
# },
|
489
502
|
# ],
|
@@ -497,13 +510,13 @@ module Aws::CloudFormation
|
|
497
510
|
# resp.errors[0].type_configuration_identifier.type_arn #=> String
|
498
511
|
# resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
|
499
512
|
# resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
|
500
|
-
# resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE"
|
513
|
+
# resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
501
514
|
# resp.errors[0].type_configuration_identifier.type_name #=> String
|
502
515
|
# resp.unprocessed_type_configurations #=> Array
|
503
516
|
# resp.unprocessed_type_configurations[0].type_arn #=> String
|
504
517
|
# resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
|
505
518
|
# resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
|
506
|
-
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE"
|
519
|
+
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
507
520
|
# resp.unprocessed_type_configurations[0].type_name #=> String
|
508
521
|
# resp.type_configurations #=> Array
|
509
522
|
# resp.type_configurations[0].arn #=> String
|
@@ -527,12 +540,12 @@ module Aws::CloudFormation
|
|
527
540
|
# successfully, the stack rolls back the update and reverts to the
|
528
541
|
# previous stack configuration.
|
529
542
|
#
|
530
|
-
# <note markdown="1"> You can cancel only stacks that are in the
|
543
|
+
# <note markdown="1"> You can cancel only stacks that are in the `UPDATE_IN_PROGRESS` state.
|
531
544
|
#
|
532
545
|
# </note>
|
533
546
|
#
|
534
547
|
# @option params [required, String] :stack_name
|
535
|
-
# The name or the unique stack ID that
|
548
|
+
# The name or the unique stack ID that's associated with the stack.
|
536
549
|
#
|
537
550
|
# @option params [String] :client_request_token
|
538
551
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
@@ -559,7 +572,7 @@ module Aws::CloudFormation
|
|
559
572
|
req.send_request(options)
|
560
573
|
end
|
561
574
|
|
562
|
-
# For a specified stack that
|
575
|
+
# For a specified stack that's in the `UPDATE_ROLLBACK_FAILED` state,
|
563
576
|
# continues rolling it back to the `UPDATE_ROLLBACK_COMPLETE` state.
|
564
577
|
# Depending on the cause of the failure, you can manually [ fix the
|
565
578
|
# error][1] and continue the rollback. By continuing the rollback, you
|
@@ -568,8 +581,8 @@ module Aws::CloudFormation
|
|
568
581
|
# again.
|
569
582
|
#
|
570
583
|
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
571
|
-
# CloudFormation
|
572
|
-
# update. For example, you might have a stack that
|
584
|
+
# CloudFormation can't roll back all changes after a failed stack
|
585
|
+
# update. For example, you might have a stack that's rolling back to an
|
573
586
|
# old database instance that was deleted outside of CloudFormation.
|
574
587
|
# Because CloudFormation doesn't know the database was deleted, it
|
575
588
|
# assumes that the database instance still exists and attempts to roll
|
@@ -595,13 +608,13 @@ module Aws::CloudFormation
|
|
595
608
|
# (IAM) role that CloudFormation assumes to roll back the stack.
|
596
609
|
# CloudFormation uses the role's credentials to make calls on your
|
597
610
|
# behalf. CloudFormation always uses this role for all future operations
|
598
|
-
# on the stack.
|
611
|
+
# on the stack. Provided that users have permission to operate on the
|
599
612
|
# stack, CloudFormation uses this role even if the users don't have
|
600
|
-
# permission to pass it. Ensure that the role grants least
|
613
|
+
# permission to pass it. Ensure that the role grants least permission.
|
601
614
|
#
|
602
615
|
# If you don't specify a value, CloudFormation uses the role that was
|
603
616
|
# previously associated with the stack. If no role is available,
|
604
|
-
# CloudFormation uses a temporary session that
|
617
|
+
# CloudFormation uses a temporary session that's generated from your
|
605
618
|
# user credentials.
|
606
619
|
#
|
607
620
|
# @option params [Array<String>] :resources_to_skip
|
@@ -609,7 +622,7 @@ module Aws::CloudFormation
|
|
609
622
|
# during the continue update rollback operation. You can specify only
|
610
623
|
# resources that are in the `UPDATE_FAILED` state because a rollback
|
611
624
|
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
612
|
-
# state for other reasons, for example, because an update was
|
625
|
+
# state for other reasons, for example, because an update was canceled.
|
613
626
|
# To check why a resource update failed, use the DescribeStackResources
|
614
627
|
# action, and view the resource status reason.
|
615
628
|
#
|
@@ -700,7 +713,7 @@ module Aws::CloudFormation
|
|
700
713
|
# execute the change set by using the ExecuteChangeSet action.
|
701
714
|
# CloudFormation doesn't make changes until you execute the change set.
|
702
715
|
#
|
703
|
-
# To create a change set for the entire stack
|
716
|
+
# To create a change set for the entire stack hierarchy, set
|
704
717
|
# `IncludeNestedStacks` to `True`.
|
705
718
|
#
|
706
719
|
# @option params [required, String] :stack_name
|
@@ -719,15 +732,15 @@ module Aws::CloudFormation
|
|
719
732
|
#
|
720
733
|
# @option params [String] :template_url
|
721
734
|
# The location of the file that contains the revised template. The URL
|
722
|
-
# must point to a template (max size: 460,800 bytes) that
|
723
|
-
# an S3 bucket or a Systems Manager document. CloudFormation
|
724
|
-
# the change set by comparing this template with the stack
|
725
|
-
# specified.
|
735
|
+
# must point to a template (max size: 460,800 bytes) that's located in
|
736
|
+
# an Amazon S3 bucket or a Systems Manager document. CloudFormation
|
737
|
+
# generates the change set by comparing this template with the stack
|
738
|
+
# that you specified.
|
726
739
|
#
|
727
740
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
728
741
|
#
|
729
742
|
# @option params [Boolean] :use_previous_template
|
730
|
-
# Whether to reuse the template that
|
743
|
+
# Whether to reuse the template that's associated with the stack to
|
731
744
|
# create the change set.
|
732
745
|
#
|
733
746
|
# @option params [Array<Types::Parameter>] :parameters
|
@@ -766,7 +779,7 @@ module Aws::CloudFormation
|
|
766
779
|
#
|
767
780
|
# * [ AWS::IAM::Group][2]
|
768
781
|
#
|
769
|
-
# * [
|
782
|
+
# * [AWS::IAM::InstanceProfile][3]
|
770
783
|
#
|
771
784
|
# * [ AWS::IAM::Policy][4]
|
772
785
|
#
|
@@ -774,10 +787,10 @@ module Aws::CloudFormation
|
|
774
787
|
#
|
775
788
|
# * [ AWS::IAM::User][6]
|
776
789
|
#
|
777
|
-
# * [
|
790
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
778
791
|
#
|
779
|
-
# For more information, see [Acknowledging IAM
|
780
|
-
# CloudFormation
|
792
|
+
# For more information, see [Acknowledging IAM resources in
|
793
|
+
# CloudFormation templates][8].
|
781
794
|
#
|
782
795
|
# * `CAPABILITY_AUTO_EXPAND`
|
783
796
|
#
|
@@ -794,7 +807,7 @@ module Aws::CloudFormation
|
|
794
807
|
# [AWS::Serverless][10] transforms, which are macros hosted by
|
795
808
|
# CloudFormation.
|
796
809
|
#
|
797
|
-
# <note markdown="1"> This capacity
|
810
|
+
# <note markdown="1"> This capacity doesn't apply to creating change sets, and specifying
|
798
811
|
# it when creating change sets has no effect.
|
799
812
|
#
|
800
813
|
# If you want to create a stack from a stack template that contains
|
@@ -804,8 +817,8 @@ module Aws::CloudFormation
|
|
804
817
|
#
|
805
818
|
# </note>
|
806
819
|
#
|
807
|
-
# For more information on macros, see [Using CloudFormation
|
808
|
-
#
|
820
|
+
# For more information on macros, see [Using CloudFormation macros to
|
821
|
+
# perform custom processing on templates][11].
|
809
822
|
#
|
810
823
|
#
|
811
824
|
#
|
@@ -831,7 +844,7 @@ module Aws::CloudFormation
|
|
831
844
|
# grants permissions to all resource types. Identity and Access
|
832
845
|
# Management (IAM) uses this parameter for condition keys in IAM
|
833
846
|
# policies for CloudFormation. For more information, see [Controlling
|
834
|
-
#
|
847
|
+
# access with Identity and Access Management][1] in the CloudFormation
|
835
848
|
# User Guide.
|
836
849
|
#
|
837
850
|
#
|
@@ -843,9 +856,9 @@ module Aws::CloudFormation
|
|
843
856
|
# (IAM) role that CloudFormation assumes when executing the change set.
|
844
857
|
# CloudFormation uses the role's credentials to make calls on your
|
845
858
|
# behalf. CloudFormation uses this role for all future operations on the
|
846
|
-
# stack.
|
859
|
+
# stack. Provided that users have permission to operate on the stack,
|
847
860
|
# CloudFormation uses this role even if the users don't have permission
|
848
|
-
# to pass it. Ensure that the role grants least
|
861
|
+
# to pass it. Ensure that the role grants least permission.
|
849
862
|
#
|
850
863
|
# If you don't specify a value, CloudFormation uses the role that was
|
851
864
|
# previously associated with the stack. If no role is available,
|
@@ -872,8 +885,8 @@ module Aws::CloudFormation
|
|
872
885
|
# sets that are associated with the specified stack.
|
873
886
|
#
|
874
887
|
# A change set name can contain only alphanumeric, case sensitive
|
875
|
-
# characters and hyphens. It must start with an
|
876
|
-
#
|
888
|
+
# characters, and hyphens. It must start with an alphabetical character
|
889
|
+
# and can't exceed 128 characters.
|
877
890
|
#
|
878
891
|
# @option params [String] :client_token
|
879
892
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
@@ -983,14 +996,14 @@ module Aws::CloudFormation
|
|
983
996
|
|
984
997
|
# Creates a stack as specified in the template. After the call completes
|
985
998
|
# successfully, the stack creation starts. You can check the status of
|
986
|
-
# the stack
|
999
|
+
# the stack through the DescribeStacksoperation.
|
987
1000
|
#
|
988
1001
|
# @option params [required, String] :stack_name
|
989
|
-
# The name that
|
1002
|
+
# The name that's associated with the stack. The name must be unique in
|
990
1003
|
# the Region in which you are creating the stack.
|
991
1004
|
#
|
992
1005
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
|
993
|
-
# and hyphens. It must start with an alphabetical character and
|
1006
|
+
# and hyphens. It must start with an alphabetical character and can't
|
994
1007
|
# be longer than 128 characters.
|
995
1008
|
#
|
996
1009
|
# </note>
|
@@ -998,7 +1011,7 @@ module Aws::CloudFormation
|
|
998
1011
|
# @option params [String] :template_body
|
999
1012
|
# Structure containing the template body with a minimum length of 1 byte
|
1000
1013
|
# and a maximum length of 51,200 bytes. For more information, go to
|
1001
|
-
# [Template
|
1014
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1002
1015
|
#
|
1003
1016
|
# Conditional: You must specify either the `TemplateBody` or the
|
1004
1017
|
# `TemplateURL` parameter, but not both.
|
@@ -1009,9 +1022,9 @@ module Aws::CloudFormation
|
|
1009
1022
|
#
|
1010
1023
|
# @option params [String] :template_url
|
1011
1024
|
# Location of file containing the template body. The URL must point to a
|
1012
|
-
# template (max size: 460,800 bytes) that
|
1025
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
1013
1026
|
# bucket or a Systems Manager document. For more information, go to the
|
1014
|
-
# [Template
|
1027
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1015
1028
|
#
|
1016
1029
|
# Conditional: You must specify either the `TemplateBody` or the
|
1017
1030
|
# `TemplateURL` parameter, but not both.
|
@@ -1046,9 +1059,9 @@ module Aws::CloudFormation
|
|
1046
1059
|
# the stack will be rolled back.
|
1047
1060
|
#
|
1048
1061
|
# @option params [Array<String>] :notification_arns
|
1049
|
-
# The Simple Notification Service (SNS) topic ARNs to
|
1050
|
-
# related events. You can find your SNS topic ARNs
|
1051
|
-
# or your Command Line Interface (CLI).
|
1062
|
+
# The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
|
1063
|
+
# publish stack related events. You can find your Amazon SNS topic ARNs
|
1064
|
+
# using the Amazon SNS console or your Command Line Interface (CLI).
|
1052
1065
|
#
|
1053
1066
|
# @option params [Array<String>] :capabilities
|
1054
1067
|
# In some cases, you must explicitly acknowledge that your stack
|
@@ -1082,7 +1095,7 @@ module Aws::CloudFormation
|
|
1082
1095
|
#
|
1083
1096
|
# * [ AWS::IAM::Group][2]
|
1084
1097
|
#
|
1085
|
-
# * [
|
1098
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1086
1099
|
#
|
1087
1100
|
# * [ AWS::IAM::Policy][4]
|
1088
1101
|
#
|
@@ -1090,7 +1103,7 @@ module Aws::CloudFormation
|
|
1090
1103
|
#
|
1091
1104
|
# * [ AWS::IAM::User][6]
|
1092
1105
|
#
|
1093
|
-
# * [
|
1106
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1094
1107
|
#
|
1095
1108
|
# For more information, see [Acknowledging IAM Resources in
|
1096
1109
|
# CloudFormation Templates][8].
|
@@ -1122,8 +1135,8 @@ module Aws::CloudFormation
|
|
1122
1135
|
# can update the function operation without CloudFormation being
|
1123
1136
|
# notified.
|
1124
1137
|
#
|
1125
|
-
# For more information, see [Using CloudFormation
|
1126
|
-
#
|
1138
|
+
# For more information, see [Using CloudFormation macros to perform
|
1139
|
+
# custom processing on templates][11].
|
1127
1140
|
#
|
1128
1141
|
#
|
1129
1142
|
#
|
@@ -1166,18 +1179,18 @@ module Aws::CloudFormation
|
|
1166
1179
|
# (IAM) role that CloudFormation assumes to create the stack.
|
1167
1180
|
# CloudFormation uses the role's credentials to make calls on your
|
1168
1181
|
# behalf. CloudFormation always uses this role for all future operations
|
1169
|
-
# on the stack.
|
1182
|
+
# on the stack. Provided that users have permission to operate on the
|
1170
1183
|
# stack, CloudFormation uses this role even if the users don't have
|
1171
1184
|
# permission to pass it. Ensure that the role grants least privilege.
|
1172
1185
|
#
|
1173
1186
|
# If you don't specify a value, CloudFormation uses the role that was
|
1174
1187
|
# previously associated with the stack. If no role is available,
|
1175
|
-
# CloudFormation uses a temporary session that
|
1188
|
+
# CloudFormation uses a temporary session that's generated from your
|
1176
1189
|
# user credentials.
|
1177
1190
|
#
|
1178
1191
|
# @option params [String] :on_failure
|
1179
1192
|
# Determines what action will be taken if stack creation fails. This
|
1180
|
-
# must be one of:
|
1193
|
+
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
1181
1194
|
# either `OnFailure` or `DisableRollback`, but not both.
|
1182
1195
|
#
|
1183
1196
|
# Default: `ROLLBACK`
|
@@ -1210,7 +1223,7 @@ module Aws::CloudFormation
|
|
1210
1223
|
# retry `CreateStack` requests to ensure that CloudFormation
|
1211
1224
|
# successfully received them.
|
1212
1225
|
#
|
1213
|
-
# All events
|
1226
|
+
# All events initiated by a given stack operation are assigned the same
|
1214
1227
|
# client request token, which you can use to track operations. For
|
1215
1228
|
# example, if you execute a `CreateStack` operation with the token
|
1216
1229
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1229,11 +1242,11 @@ module Aws::CloudFormation
|
|
1229
1242
|
# user attempts to delete a stack with termination protection enabled,
|
1230
1243
|
# the operation fails and the stack remains unchanged. For more
|
1231
1244
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
1232
|
-
# *CloudFormation User Guide*. Termination protection is
|
1245
|
+
# *CloudFormation User Guide*. Termination protection is deactivated on
|
1233
1246
|
# stacks by default.
|
1234
1247
|
#
|
1235
1248
|
# For [nested stacks][2], termination protection is set on the root
|
1236
|
-
# stack and
|
1249
|
+
# stack and can't be changed directly on the nested stack.
|
1237
1250
|
#
|
1238
1251
|
#
|
1239
1252
|
#
|
@@ -1300,10 +1313,10 @@ module Aws::CloudFormation
|
|
1300
1313
|
end
|
1301
1314
|
|
1302
1315
|
# Creates stack instances for the specified accounts, within the
|
1303
|
-
# specified Regions. A stack instance refers to a
|
1304
|
-
# account and Region. You must specify at least one
|
1305
|
-
# `Accounts` or `DeploymentTargets`, and you must
|
1306
|
-
# value for `Regions`.
|
1316
|
+
# specified Amazon Web Services Regions. A stack instance refers to a
|
1317
|
+
# stack in a specific account and Region. You must specify at least one
|
1318
|
+
# value for either `Accounts` or `DeploymentTargets`, and you must
|
1319
|
+
# specify at least one value for `Regions`.
|
1307
1320
|
#
|
1308
1321
|
# @option params [required, String] :stack_set_name
|
1309
1322
|
# The name or unique ID of the stack set that you want to create stack
|
@@ -1318,39 +1331,41 @@ module Aws::CloudFormation
|
|
1318
1331
|
#
|
1319
1332
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1320
1333
|
# \[Service-managed permissions\] The Organizations accounts for which
|
1321
|
-
# to create stack instances in the specified
|
1334
|
+
# to create stack instances in the specified Amazon Web Services
|
1335
|
+
# Regions.
|
1322
1336
|
#
|
1323
1337
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1324
1338
|
#
|
1325
1339
|
# @option params [required, Array<String>] :regions
|
1326
|
-
# The names of one or more Regions where you want to
|
1327
|
-
# instances using the specified Amazon Web Services
|
1340
|
+
# The names of one or more Amazon Web Services Regions where you want to
|
1341
|
+
# create stack instances using the specified Amazon Web Services
|
1342
|
+
# accounts.
|
1328
1343
|
#
|
1329
1344
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
1330
1345
|
# A list of stack set parameters whose values you want to override in
|
1331
1346
|
# the selected stack instances.
|
1332
1347
|
#
|
1333
1348
|
# Any overridden parameter values will be applied to all stack instances
|
1334
|
-
# in the specified accounts and Regions. When
|
1335
|
-
# their values, be aware of how CloudFormation
|
1336
|
-
# during stack instance operations:
|
1349
|
+
# in the specified accounts and Amazon Web Services Regions. When
|
1350
|
+
# specifying parameters and their values, be aware of how CloudFormation
|
1351
|
+
# sets parameter values during stack instance operations:
|
1337
1352
|
#
|
1338
1353
|
# * To override the current value for a parameter, include the parameter
|
1339
1354
|
# and specify its value.
|
1340
1355
|
#
|
1341
1356
|
# * To leave an overridden parameter set to its present value, include
|
1342
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
1357
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
1343
1358
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
1344
1359
|
#
|
1345
1360
|
# * To set an overridden parameter back to the value specified in the
|
1346
|
-
# stack set, specify a parameter list but
|
1361
|
+
# stack set, specify a parameter list but don't include the parameter
|
1347
1362
|
# in the list.
|
1348
1363
|
#
|
1349
|
-
# * To leave all parameters set to their present values,
|
1364
|
+
# * To leave all parameters set to their present values, don't specify
|
1350
1365
|
# this property at all.
|
1351
1366
|
#
|
1352
1367
|
# During stack set updates, any parameter values overridden for a stack
|
1353
|
-
# instance
|
1368
|
+
# instance aren't updated, but retain their overridden value.
|
1354
1369
|
#
|
1355
1370
|
# You can only override the parameter *values* that are specified in the
|
1356
1371
|
# stack set; to add or delete a parameter itself, use
|
@@ -1532,7 +1547,7 @@ module Aws::CloudFormation
|
|
1532
1547
|
#
|
1533
1548
|
# * [ AWS::IAM::Group][2]
|
1534
1549
|
#
|
1535
|
-
# * [
|
1550
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1536
1551
|
#
|
1537
1552
|
# * [ AWS::IAM::Policy][4]
|
1538
1553
|
#
|
@@ -1540,7 +1555,7 @@ module Aws::CloudFormation
|
|
1540
1555
|
#
|
1541
1556
|
# * [ AWS::IAM::User][6]
|
1542
1557
|
#
|
1543
|
-
# * [
|
1558
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1544
1559
|
#
|
1545
1560
|
# For more information, see [Acknowledging IAM Resources in
|
1546
1561
|
# CloudFormation Templates][8].
|
@@ -1555,7 +1570,7 @@ module Aws::CloudFormation
|
|
1555
1570
|
# [Using CloudFormation Macros to Perform Custom Processing on
|
1556
1571
|
# Templates][9].
|
1557
1572
|
#
|
1558
|
-
# Stack sets with service-managed permissions
|
1573
|
+
# Stack sets with service-managed permissions don't currently support
|
1559
1574
|
# the use of macros in templates. (This includes the
|
1560
1575
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1561
1576
|
# macros hosted by CloudFormation.) Even if you specify this
|
@@ -1735,10 +1750,10 @@ module Aws::CloudFormation
|
|
1735
1750
|
# Deactivates a public extension that was previously activated in this
|
1736
1751
|
# account and region.
|
1737
1752
|
#
|
1738
|
-
# Once deactivated, an extension
|
1753
|
+
# Once deactivated, an extension can't be used in any CloudFormation
|
1739
1754
|
# operation. This includes stack update operations where the stack
|
1740
1755
|
# template includes the extension, even if no updates are being made to
|
1741
|
-
# the extension. In addition, deactivated extensions
|
1756
|
+
# the extension. In addition, deactivated extensions aren't
|
1742
1757
|
# automatically updated if a new version of the extension is released.
|
1743
1758
|
#
|
1744
1759
|
# @option params [String] :type_name
|
@@ -1765,7 +1780,7 @@ module Aws::CloudFormation
|
|
1765
1780
|
#
|
1766
1781
|
# resp = client.deactivate_type({
|
1767
1782
|
# type_name: "TypeName",
|
1768
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1783
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
1769
1784
|
# arn: "PrivateTypeArn",
|
1770
1785
|
# })
|
1771
1786
|
#
|
@@ -1795,7 +1810,7 @@ module Aws::CloudFormation
|
|
1795
1810
|
#
|
1796
1811
|
# @option params [String] :stack_name
|
1797
1812
|
# If you specified the name of a change set to delete, specify the stack
|
1798
|
-
# name or
|
1813
|
+
# name or Amazon Resource Name (ARN) that's associated with it.
|
1799
1814
|
#
|
1800
1815
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1801
1816
|
#
|
@@ -1816,19 +1831,19 @@ module Aws::CloudFormation
|
|
1816
1831
|
end
|
1817
1832
|
|
1818
1833
|
# Deletes a specified stack. Once the call completes successfully, stack
|
1819
|
-
# deletion starts. Deleted stacks
|
1820
|
-
#
|
1834
|
+
# deletion starts. Deleted stacks don't show up in the DescribeStacks
|
1835
|
+
# operation if the deletion has been completed successfully.
|
1821
1836
|
#
|
1822
1837
|
# @option params [required, String] :stack_name
|
1823
|
-
# The name or the unique stack ID that
|
1838
|
+
# The name or the unique stack ID that's associated with the stack.
|
1824
1839
|
#
|
1825
1840
|
# @option params [Array<String>] :retain_resources
|
1826
1841
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1827
1842
|
# IDs that are associated with the resources you want to retain. During
|
1828
|
-
# deletion, CloudFormation deletes the stack but
|
1843
|
+
# deletion, CloudFormation deletes the stack but doesn't delete the
|
1829
1844
|
# retained resources.
|
1830
1845
|
#
|
1831
|
-
# Retaining resources is useful when you
|
1846
|
+
# Retaining resources is useful when you can't delete a resource, such
|
1832
1847
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
1833
1848
|
#
|
1834
1849
|
# @option params [String] :role_arn
|
@@ -1839,7 +1854,7 @@ module Aws::CloudFormation
|
|
1839
1854
|
#
|
1840
1855
|
# If you don't specify a value, CloudFormation uses the role that was
|
1841
1856
|
# previously associated with the stack. If no role is available,
|
1842
|
-
# CloudFormation uses a temporary session that
|
1857
|
+
# CloudFormation uses a temporary session that's generated from your
|
1843
1858
|
# user credentials.
|
1844
1859
|
#
|
1845
1860
|
# @option params [String] :client_request_token
|
@@ -1849,7 +1864,7 @@ module Aws::CloudFormation
|
|
1849
1864
|
# retry `DeleteStack` requests to ensure that CloudFormation
|
1850
1865
|
# successfully received them.
|
1851
1866
|
#
|
1852
|
-
# All events
|
1867
|
+
# All events initiated by a given stack operation are assigned the same
|
1853
1868
|
# client request token, which you can use to track operations. For
|
1854
1869
|
# example, if you execute a `CreateStack` operation with the token
|
1855
1870
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1884,7 +1899,7 @@ module Aws::CloudFormation
|
|
1884
1899
|
end
|
1885
1900
|
|
1886
1901
|
# Deletes stack instances for the specified accounts, in the specified
|
1887
|
-
# Regions.
|
1902
|
+
# Amazon Web Services Regions.
|
1888
1903
|
#
|
1889
1904
|
# @option params [required, String] :stack_set_name
|
1890
1905
|
# The name or unique ID of the stack set that you want to delete stack
|
@@ -1903,7 +1918,8 @@ module Aws::CloudFormation
|
|
1903
1918
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1904
1919
|
#
|
1905
1920
|
# @option params [required, Array<String>] :regions
|
1906
|
-
# The Regions where you want to delete stack set
|
1921
|
+
# The Amazon Web Services Regions where you want to delete stack set
|
1922
|
+
# instances.
|
1907
1923
|
#
|
1908
1924
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1909
1925
|
# Preferences for how CloudFormation performs this stack set operation.
|
@@ -2059,9 +2075,9 @@ module Aws::CloudFormation
|
|
2059
2075
|
# extension itself being deregistered and marked as deprecated in the
|
2060
2076
|
# registry.
|
2061
2077
|
#
|
2062
|
-
# You
|
2078
|
+
# You can't deregister the default version of an extension if there are
|
2063
2079
|
# other active version of that extension. If you do deregister the
|
2064
|
-
# default version of an extension, the
|
2080
|
+
# default version of an extension, the extension type itself is
|
2065
2081
|
# deregistered as well and marked as deprecated.
|
2066
2082
|
#
|
2067
2083
|
# To view the deprecation status of an extension or extension version,
|
@@ -2097,7 +2113,7 @@ module Aws::CloudFormation
|
|
2097
2113
|
#
|
2098
2114
|
# resp = client.deregister_type({
|
2099
2115
|
# arn: "PrivateTypeArn",
|
2100
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
2116
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
2101
2117
|
# type_name: "TypeName",
|
2102
2118
|
# version_id: "TypeVersionId",
|
2103
2119
|
# })
|
@@ -2113,7 +2129,7 @@ module Aws::CloudFormation
|
|
2113
2129
|
|
2114
2130
|
# Retrieves your account's CloudFormation limits, such as the maximum
|
2115
2131
|
# number of stacks that you can create in your account. For more
|
2116
|
-
# information about account limits, see [CloudFormation
|
2132
|
+
# information about account limits, see [CloudFormation Quotas][1] in
|
2117
2133
|
# the *CloudFormation User Guide*.
|
2118
2134
|
#
|
2119
2135
|
#
|
@@ -2233,6 +2249,7 @@ module Aws::CloudFormation
|
|
2233
2249
|
# resp.tags[0].value #=> String
|
2234
2250
|
# resp.changes #=> Array
|
2235
2251
|
# resp.changes[0].type #=> String, one of "Resource"
|
2252
|
+
# resp.changes[0].hook_invocation_count #=> Integer
|
2236
2253
|
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
2237
2254
|
# resp.changes[0].resource_change.logical_resource_id #=> String
|
2238
2255
|
# resp.changes[0].resource_change.physical_resource_id #=> String
|
@@ -2269,9 +2286,76 @@ module Aws::CloudFormation
|
|
2269
2286
|
req.send_request(options)
|
2270
2287
|
end
|
2271
2288
|
|
2289
|
+
# Returns hook-related information for the change set and a list of
|
2290
|
+
# changes that CloudFormation makes when you run the change set.
|
2291
|
+
#
|
2292
|
+
# @option params [required, String] :change_set_name
|
2293
|
+
# The name or Amazon Resource Name (ARN) of the change set that you want
|
2294
|
+
# to describe.
|
2295
|
+
#
|
2296
|
+
# @option params [String] :stack_name
|
2297
|
+
# If you specified the name of a change set, specify the stack name or
|
2298
|
+
# stack ID (ARN) of the change set you want to describe.
|
2299
|
+
#
|
2300
|
+
# @option params [String] :next_token
|
2301
|
+
# A string, provided by the `DescribeChangeSetHooks` response output,
|
2302
|
+
# that identifies the next page of information that you want to
|
2303
|
+
# retrieve.
|
2304
|
+
#
|
2305
|
+
# @option params [String] :logical_resource_id
|
2306
|
+
# If specified, lists only the hooks related to the specified
|
2307
|
+
# `LogicalResourceId`.
|
2308
|
+
#
|
2309
|
+
# @return [Types::DescribeChangeSetHooksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2310
|
+
#
|
2311
|
+
# * {Types::DescribeChangeSetHooksOutput#change_set_id #change_set_id} => String
|
2312
|
+
# * {Types::DescribeChangeSetHooksOutput#change_set_name #change_set_name} => String
|
2313
|
+
# * {Types::DescribeChangeSetHooksOutput#hooks #hooks} => Array<Types::ChangeSetHook>
|
2314
|
+
# * {Types::DescribeChangeSetHooksOutput#status #status} => String
|
2315
|
+
# * {Types::DescribeChangeSetHooksOutput#next_token #next_token} => String
|
2316
|
+
# * {Types::DescribeChangeSetHooksOutput#stack_id #stack_id} => String
|
2317
|
+
# * {Types::DescribeChangeSetHooksOutput#stack_name #stack_name} => String
|
2318
|
+
#
|
2319
|
+
# @example Request syntax with placeholder values
|
2320
|
+
#
|
2321
|
+
# resp = client.describe_change_set_hooks({
|
2322
|
+
# change_set_name: "ChangeSetNameOrId", # required
|
2323
|
+
# stack_name: "StackNameOrId",
|
2324
|
+
# next_token: "NextToken",
|
2325
|
+
# logical_resource_id: "LogicalResourceId",
|
2326
|
+
# })
|
2327
|
+
#
|
2328
|
+
# @example Response structure
|
2329
|
+
#
|
2330
|
+
# resp.change_set_id #=> String
|
2331
|
+
# resp.change_set_name #=> String
|
2332
|
+
# resp.hooks #=> Array
|
2333
|
+
# resp.hooks[0].invocation_point #=> String, one of "PRE_PROVISION"
|
2334
|
+
# resp.hooks[0].failure_mode #=> String, one of "FAIL", "WARN"
|
2335
|
+
# resp.hooks[0].type_name #=> String
|
2336
|
+
# resp.hooks[0].type_version_id #=> String
|
2337
|
+
# resp.hooks[0].type_configuration_version_id #=> String
|
2338
|
+
# resp.hooks[0].target_details.target_type #=> String, one of "RESOURCE"
|
2339
|
+
# resp.hooks[0].target_details.resource_target_details.logical_resource_id #=> String
|
2340
|
+
# resp.hooks[0].target_details.resource_target_details.resource_type #=> String
|
2341
|
+
# resp.hooks[0].target_details.resource_target_details.resource_action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
2342
|
+
# resp.status #=> String, one of "PLANNING", "PLANNED", "UNAVAILABLE"
|
2343
|
+
# resp.next_token #=> String
|
2344
|
+
# resp.stack_id #=> String
|
2345
|
+
# resp.stack_name #=> String
|
2346
|
+
#
|
2347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooks AWS API Documentation
|
2348
|
+
#
|
2349
|
+
# @overload describe_change_set_hooks(params = {})
|
2350
|
+
# @param [Hash] params ({})
|
2351
|
+
def describe_change_set_hooks(params = {}, options = {})
|
2352
|
+
req = build_request(:describe_change_set_hooks, params)
|
2353
|
+
req.send_request(options)
|
2354
|
+
end
|
2355
|
+
|
2272
2356
|
# Returns information about a CloudFormation extension publisher.
|
2273
2357
|
#
|
2274
|
-
# If you
|
2358
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2275
2359
|
# extension publisher, `DescribePublisher` returns information about
|
2276
2360
|
# your own publisher account.
|
2277
2361
|
#
|
@@ -2290,7 +2374,7 @@ module Aws::CloudFormation
|
|
2290
2374
|
# @option params [String] :publisher_id
|
2291
2375
|
# The ID of the extension publisher.
|
2292
2376
|
#
|
2293
|
-
# If you
|
2377
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2294
2378
|
# extension publisher, `DescribePublisher` returns information about
|
2295
2379
|
# your own publisher account.
|
2296
2380
|
#
|
@@ -2400,8 +2484,8 @@ module Aws::CloudFormation
|
|
2400
2484
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
|
2401
2485
|
#
|
2402
2486
|
# @option params [String] :stack_name
|
2403
|
-
# The name or the unique stack ID that
|
2404
|
-
# which
|
2487
|
+
# The name or the unique stack ID that's associated with the stack,
|
2488
|
+
# which aren't always interchangeable:
|
2405
2489
|
#
|
2406
2490
|
# * Running stacks: You can specify either the stack's name or its
|
2407
2491
|
# unique stack ID.
|
@@ -2442,6 +2526,11 @@ module Aws::CloudFormation
|
|
2442
2526
|
# resp.stack_events[0].resource_status_reason #=> String
|
2443
2527
|
# resp.stack_events[0].resource_properties #=> String
|
2444
2528
|
# resp.stack_events[0].client_request_token #=> String
|
2529
|
+
# resp.stack_events[0].hook_type #=> String
|
2530
|
+
# resp.stack_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
2531
|
+
# resp.stack_events[0].hook_status_reason #=> String
|
2532
|
+
# resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
|
2533
|
+
# resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
|
2445
2534
|
# resp.next_token #=> String
|
2446
2535
|
#
|
2447
2536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
|
@@ -2539,8 +2628,8 @@ module Aws::CloudFormation
|
|
2539
2628
|
# for up to 90 days after the stack has been deleted.
|
2540
2629
|
#
|
2541
2630
|
# @option params [required, String] :stack_name
|
2542
|
-
# The name or the unique stack ID that
|
2543
|
-
# which
|
2631
|
+
# The name or the unique stack ID that's associated with the stack,
|
2632
|
+
# which aren't always interchangeable:
|
2544
2633
|
#
|
2545
2634
|
# * Running stacks: You can specify either the stack's name or its
|
2546
2635
|
# unique stack ID.
|
@@ -2598,8 +2687,8 @@ module Aws::CloudFormation
|
|
2598
2687
|
#
|
2599
2688
|
# For a given stack, there will be one `StackResourceDrift` for each
|
2600
2689
|
# stack resource that has been checked for drift. Resources that
|
2601
|
-
# haven't yet been checked for drift
|
2602
|
-
#
|
2690
|
+
# haven't yet been checked for drift aren't included. Resources that
|
2691
|
+
# don't currently support drift detection aren't checked, and so not
|
2603
2692
|
# included. For a list of resources that support drift detection, see
|
2604
2693
|
# [Resources that Support Drift Detection][1].
|
2605
2694
|
#
|
@@ -2624,10 +2713,10 @@ module Aws::CloudFormation
|
|
2624
2713
|
# * `MODIFIED`\: One or more resource properties differ from their
|
2625
2714
|
# expected template values.
|
2626
2715
|
#
|
2627
|
-
# * `IN_SYNC`\: The
|
2716
|
+
# * `IN_SYNC`\: The resource's actual configuration matches its
|
2628
2717
|
# expected template configuration.
|
2629
2718
|
#
|
2630
|
-
# * `NOT_CHECKED`\: CloudFormation
|
2719
|
+
# * `NOT_CHECKED`\: CloudFormation doesn't currently return this value.
|
2631
2720
|
#
|
2632
2721
|
# @option params [String] :next_token
|
2633
2722
|
# A string that identifies the next page of stack resource drift
|
@@ -2718,7 +2807,7 @@ module Aws::CloudFormation
|
|
2718
2807
|
#
|
2719
2808
|
# @option params [String] :stack_name
|
2720
2809
|
# The name or the unique stack ID that is associated with the stack,
|
2721
|
-
# which
|
2810
|
+
# which aren't always interchangeable:
|
2722
2811
|
#
|
2723
2812
|
# * Running stacks: You can specify either the stack's name or its
|
2724
2813
|
# unique stack ID.
|
@@ -2727,7 +2816,7 @@ module Aws::CloudFormation
|
|
2727
2816
|
#
|
2728
2817
|
# Default: There is no default value.
|
2729
2818
|
#
|
2730
|
-
# Required: Conditional. If you
|
2819
|
+
# Required: Conditional. If you don't specify `StackName`, you must
|
2731
2820
|
# specify `PhysicalResourceId`.
|
2732
2821
|
#
|
2733
2822
|
# @option params [String] :logical_resource_id
|
@@ -2744,7 +2833,7 @@ module Aws::CloudFormation
|
|
2744
2833
|
# EC2 `InstanceId` to `DescribeStackResources` to find which stack the
|
2745
2834
|
# instance belongs to and what other resources are part of the stack.
|
2746
2835
|
#
|
2747
|
-
# Required: Conditional. If you
|
2836
|
+
# Required: Conditional. If you don't specify `PhysicalResourceId`, you
|
2748
2837
|
# must specify `StackName`.
|
2749
2838
|
#
|
2750
2839
|
# Default: There is no default value.
|
@@ -2956,13 +3045,13 @@ module Aws::CloudFormation
|
|
2956
3045
|
# Returns the description for the specified stack; if no stack name was
|
2957
3046
|
# specified, then it returns the description for all the stacks created.
|
2958
3047
|
#
|
2959
|
-
# <note markdown="1"> If the stack
|
3048
|
+
# <note markdown="1"> If the stack doesn't exist, an `ValidationError` is returned.
|
2960
3049
|
#
|
2961
3050
|
# </note>
|
2962
3051
|
#
|
2963
3052
|
# @option params [String] :stack_name
|
2964
|
-
# The name or the unique stack ID that
|
2965
|
-
# which
|
3053
|
+
# The name or the unique stack ID that's associated with the stack,
|
3054
|
+
# which aren't always interchangeable:
|
2966
3055
|
#
|
2967
3056
|
# * Running stacks: You can specify either the stack's name or its
|
2968
3057
|
# unique stack ID.
|
@@ -3123,7 +3212,7 @@ module Aws::CloudFormation
|
|
3123
3212
|
# @example Request syntax with placeholder values
|
3124
3213
|
#
|
3125
3214
|
# resp = client.describe_type({
|
3126
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3215
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
3127
3216
|
# type_name: "TypeName",
|
3128
3217
|
# arn: "TypeArn",
|
3129
3218
|
# version_id: "TypeVersionId",
|
@@ -3134,7 +3223,7 @@ module Aws::CloudFormation
|
|
3134
3223
|
# @example Response structure
|
3135
3224
|
#
|
3136
3225
|
# resp.arn #=> String
|
3137
|
-
# resp.type #=> String, one of "RESOURCE", "MODULE"
|
3226
|
+
# resp.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
3138
3227
|
# resp.type_name #=> String
|
3139
3228
|
# resp.default_version_id #=> String
|
3140
3229
|
# resp.is_default_version #=> Boolean
|
@@ -3251,7 +3340,7 @@ module Aws::CloudFormation
|
|
3251
3340
|
# completed, use DescribeStackResourceDrifts to return drift information
|
3252
3341
|
# about the stack and its resources.
|
3253
3342
|
#
|
3254
|
-
# When detecting drift on a stack, CloudFormation
|
3343
|
+
# When detecting drift on a stack, CloudFormation doesn't detect drift
|
3255
3344
|
# on any nested stacks belonging to that stack. Perform
|
3256
3345
|
# `DetectStackDrift` directly on the nested stack itself.
|
3257
3346
|
#
|
@@ -3304,7 +3393,7 @@ module Aws::CloudFormation
|
|
3304
3393
|
# resources, or DetectStackDrift to detect drift on all resources in a
|
3305
3394
|
# given stack that support drift detection.
|
3306
3395
|
#
|
3307
|
-
# Resources that
|
3396
|
+
# Resources that don't currently support drift detection can't be
|
3308
3397
|
# checked. For a list of resources that support drift detection, see
|
3309
3398
|
# [Resources that Support Drift Detection][2].
|
3310
3399
|
#
|
@@ -3364,15 +3453,15 @@ module Aws::CloudFormation
|
|
3364
3453
|
# Detect drift on a stack set. When CloudFormation performs drift
|
3365
3454
|
# detection on a stack set, it performs drift detection on the stack
|
3366
3455
|
# associated with each stack instance in the stack set. For more
|
3367
|
-
# information, see [How CloudFormation
|
3368
|
-
#
|
3456
|
+
# information, see [How CloudFormation performs drift detection on a
|
3457
|
+
# stack set][1].
|
3369
3458
|
#
|
3370
3459
|
# `DetectStackSetDrift` returns the `OperationId` of the stack set drift
|
3371
3460
|
# detection operation. Use this operation id with `
|
3372
3461
|
# DescribeStackSetOperation ` to monitor the progress of the drift
|
3373
3462
|
# detection operation. The drift detection operation may take some time,
|
3374
3463
|
# depending on the number of stack instances included in the stack set,
|
3375
|
-
#
|
3464
|
+
# in addition to the number of resources included in each stack.
|
3376
3465
|
#
|
3377
3466
|
# Once the operation has completed, use the following actions to return
|
3378
3467
|
# drift information:
|
@@ -3380,7 +3469,7 @@ module Aws::CloudFormation
|
|
3380
3469
|
# * Use ` DescribeStackSet ` to return detailed information about the
|
3381
3470
|
# stack set, including detailed information about the last *completed*
|
3382
3471
|
# drift operation performed on the stack set. (Information about drift
|
3383
|
-
# operations that are in progress
|
3472
|
+
# operations that are in progress isn't included.)
|
3384
3473
|
#
|
3385
3474
|
# * Use ` ListStackInstances ` to return a list of stack instances
|
3386
3475
|
# belonging to the stack set, including the drift status and last
|
@@ -3391,7 +3480,7 @@ module Aws::CloudFormation
|
|
3391
3480
|
# time checked.
|
3392
3481
|
#
|
3393
3482
|
# For more information on performing a drift detection operation on a
|
3394
|
-
# stack set, see [Detecting
|
3483
|
+
# stack set, see [Detecting unmanaged changes in stack sets][1].
|
3395
3484
|
#
|
3396
3485
|
# You can only run a single drift detection operation on a given stack
|
3397
3486
|
# set at one time.
|
@@ -3497,7 +3586,7 @@ module Aws::CloudFormation
|
|
3497
3586
|
#
|
3498
3587
|
# @option params [String] :template_url
|
3499
3588
|
# Location of file containing the template body. The URL must point to a
|
3500
|
-
# template that
|
3589
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
3501
3590
|
# document. For more information, go to [Template Anatomy][1] in the
|
3502
3591
|
# CloudFormation User Guide.
|
3503
3592
|
#
|
@@ -3556,16 +3645,17 @@ module Aws::CloudFormation
|
|
3556
3645
|
# enforces the policy during the update. You can't specify a temporary
|
3557
3646
|
# stack policy that overrides the current policy.
|
3558
3647
|
#
|
3559
|
-
# To create a change set for the entire stack
|
3648
|
+
# To create a change set for the entire stack hierarchy,
|
3560
3649
|
# `IncludeNestedStacks` must have been set to `True`.
|
3561
3650
|
#
|
3562
3651
|
# @option params [required, String] :change_set_name
|
3563
|
-
# The name or ARN of the change set that you want
|
3564
|
-
# specified stack.
|
3652
|
+
# The name or Amazon Resource Name (ARN) of the change set that you want
|
3653
|
+
# use to update the specified stack.
|
3565
3654
|
#
|
3566
3655
|
# @option params [String] :stack_name
|
3567
3656
|
# If you specified the name of a change set, specify the stack name or
|
3568
|
-
#
|
3657
|
+
# Amazon Resource Name (ARN) that's associated with the change set you
|
3658
|
+
# want to execute.
|
3569
3659
|
#
|
3570
3660
|
# @option params [String] :client_request_token
|
3571
3661
|
# A unique identifier for this `ExecuteChangeSet` request. Specify this
|
@@ -3604,7 +3694,7 @@ module Aws::CloudFormation
|
|
3604
3694
|
# have a policy, a null value is returned.
|
3605
3695
|
#
|
3606
3696
|
# @option params [required, String] :stack_name
|
3607
|
-
# The name or unique stack ID that
|
3697
|
+
# The name or unique stack ID that's associated with the stack whose
|
3608
3698
|
# policy you want to get.
|
3609
3699
|
#
|
3610
3700
|
# @return [Types::GetStackPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3633,16 +3723,16 @@ module Aws::CloudFormation
|
|
3633
3723
|
# Returns the template body for a specified stack. You can get the
|
3634
3724
|
# template for running or deleted stacks.
|
3635
3725
|
#
|
3636
|
-
# For deleted stacks, GetTemplate returns the template for up to 90
|
3637
|
-
# after the stack has been deleted.
|
3726
|
+
# For deleted stacks, `GetTemplate` returns the template for up to 90
|
3727
|
+
# days after the stack has been deleted.
|
3638
3728
|
#
|
3639
|
-
# <note markdown="1"> If the template
|
3729
|
+
# <note markdown="1"> If the template doesn't exist, a `ValidationError` is returned.
|
3640
3730
|
#
|
3641
3731
|
# </note>
|
3642
3732
|
#
|
3643
3733
|
# @option params [String] :stack_name
|
3644
|
-
# The name or the unique stack ID that
|
3645
|
-
# which
|
3734
|
+
# The name or the unique stack ID that's associated with the stack,
|
3735
|
+
# which aren't always interchangeable:
|
3646
3736
|
#
|
3647
3737
|
# * Running stacks: You can specify either the stack's name or its
|
3648
3738
|
# unique stack ID.
|
@@ -3705,12 +3795,12 @@ module Aws::CloudFormation
|
|
3705
3795
|
#
|
3706
3796
|
# For deleted stacks, `GetTemplateSummary` returns the template
|
3707
3797
|
# information for up to 90 days after the stack has been deleted. If the
|
3708
|
-
# template
|
3798
|
+
# template doesn't exist, a `ValidationError` is returned.
|
3709
3799
|
#
|
3710
3800
|
# @option params [String] :template_body
|
3711
3801
|
# Structure containing the template body with a minimum length of 1 byte
|
3712
3802
|
# and a maximum length of 51,200 bytes. For more information about
|
3713
|
-
# templates, see [Template
|
3803
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3714
3804
|
#
|
3715
3805
|
# Conditional: You must specify only one of the following parameters:
|
3716
3806
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3721,9 +3811,9 @@ module Aws::CloudFormation
|
|
3721
3811
|
#
|
3722
3812
|
# @option params [String] :template_url
|
3723
3813
|
# Location of file containing the template body. The URL must point to a
|
3724
|
-
# template (max size: 460,800 bytes) that
|
3814
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
3725
3815
|
# bucket or a Systems Manager document. For more information about
|
3726
|
-
# templates, see [Template
|
3816
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3727
3817
|
#
|
3728
3818
|
# Conditional: You must specify only one of the following parameters:
|
3729
3819
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3733,10 +3823,10 @@ module Aws::CloudFormation
|
|
3733
3823
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
3734
3824
|
#
|
3735
3825
|
# @option params [String] :stack_name
|
3736
|
-
# The name or the stack ID that
|
3737
|
-
#
|
3738
|
-
# the stack's name or its unique stack ID. For deleted stack,
|
3739
|
-
# specify the unique stack ID.
|
3826
|
+
# The name or the stack ID that's associated with the stack, which
|
3827
|
+
# aren't always interchangeable. For running stacks, you can specify
|
3828
|
+
# either the stack's name or its unique stack ID. For deleted stack,
|
3829
|
+
# you must specify the unique stack ID.
|
3740
3830
|
#
|
3741
3831
|
# Conditional: You must specify only one of the following parameters:
|
3742
3832
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3828,14 +3918,16 @@ module Aws::CloudFormation
|
|
3828
3918
|
req.send_request(options)
|
3829
3919
|
end
|
3830
3920
|
|
3831
|
-
#
|
3832
|
-
#
|
3833
|
-
#
|
3834
|
-
# and
|
3835
|
-
# import
|
3836
|
-
#
|
3837
|
-
#
|
3838
|
-
#
|
3921
|
+
# Import existing stacks into a new stack sets. Use the stack import
|
3922
|
+
# operation to import up to 10 stacks into a new stack set in the same
|
3923
|
+
# account as the source stack or in a different administrator account
|
3924
|
+
# and Region, by specifying the stack ID of the stack you intend to
|
3925
|
+
# import.
|
3926
|
+
#
|
3927
|
+
# <note markdown="1"> `ImportStacksToStackSet` is only supported by self-managed
|
3928
|
+
# permissions.
|
3929
|
+
#
|
3930
|
+
# </note>
|
3839
3931
|
#
|
3840
3932
|
# @option params [required, String] :stack_set_name
|
3841
3933
|
# The name of the stack set. The name must be unique in the Region where
|
@@ -3853,7 +3945,7 @@ module Aws::CloudFormation
|
|
3853
3945
|
# Specify either `StackIds` or `StackIdsUrl`.
|
3854
3946
|
#
|
3855
3947
|
# @option params [Array<String>] :organizational_unit_ids
|
3856
|
-
# The list of OU ID
|
3948
|
+
# The list of OU ID's to which the stacks being imported has to be
|
3857
3949
|
# mapped as deployment target.
|
3858
3950
|
#
|
3859
3951
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
@@ -3974,8 +4066,8 @@ module Aws::CloudFormation
|
|
3974
4066
|
# values that you can import into other stacks. To import values, use
|
3975
4067
|
# the [ `Fn::ImportValue` ][1] function.
|
3976
4068
|
#
|
3977
|
-
# For more information, see [ CloudFormation
|
3978
|
-
#
|
4069
|
+
# For more information, see [ CloudFormation export stack output
|
4070
|
+
# values][2].
|
3979
4071
|
#
|
3980
4072
|
#
|
3981
4073
|
#
|
@@ -4176,7 +4268,7 @@ module Aws::CloudFormation
|
|
4176
4268
|
#
|
4177
4269
|
# @option params [required, String] :stack_name
|
4178
4270
|
# The name or the unique stack ID that is associated with the stack,
|
4179
|
-
# which
|
4271
|
+
# which aren't always interchangeable:
|
4180
4272
|
#
|
4181
4273
|
# * Running stacks: You can specify either the stack's name or its
|
4182
4274
|
# unique stack ID.
|
@@ -4408,7 +4500,7 @@ module Aws::CloudFormation
|
|
4408
4500
|
# permissions in the management account.
|
4409
4501
|
#
|
4410
4502
|
# @option params [String] :next_token
|
4411
|
-
# If the previous paginated request didn't return all
|
4503
|
+
# If the previous paginated request didn't return all the remaining
|
4412
4504
|
# results, the response object's `NextToken` parameter value is set to
|
4413
4505
|
# a token. To retrieve the next set of results, call `ListStackSets`
|
4414
4506
|
# again and assign that token to the request object's `NextToken`
|
@@ -4573,7 +4665,7 @@ module Aws::CloudFormation
|
|
4573
4665
|
# request parameter to get the next set of results.
|
4574
4666
|
#
|
4575
4667
|
# @option params [String] :next_token
|
4576
|
-
# If the previous paginated request didn't return all
|
4668
|
+
# If the previous paginated request didn't return all the remaining
|
4577
4669
|
# results, the response object's `NextToken` parameter value is set to
|
4578
4670
|
# a token. To retrieve the next set of results, call this action again
|
4579
4671
|
# and assign that token to the request object's `NextToken` parameter.
|
@@ -4590,7 +4682,7 @@ module Aws::CloudFormation
|
|
4590
4682
|
# @example Request syntax with placeholder values
|
4591
4683
|
#
|
4592
4684
|
# resp = client.list_type_registrations({
|
4593
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4685
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4594
4686
|
# type_name: "TypeName",
|
4595
4687
|
# type_arn: "TypeArn",
|
4596
4688
|
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
|
@@ -4664,7 +4756,7 @@ module Aws::CloudFormation
|
|
4664
4756
|
# @option params [String] :publisher_id
|
4665
4757
|
# The publisher ID of the extension publisher.
|
4666
4758
|
#
|
4667
|
-
# Extensions published by Amazon
|
4759
|
+
# Extensions published by Amazon aren't assigned a publisher ID.
|
4668
4760
|
#
|
4669
4761
|
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4670
4762
|
#
|
@@ -4676,7 +4768,7 @@ module Aws::CloudFormation
|
|
4676
4768
|
# @example Request syntax with placeholder values
|
4677
4769
|
#
|
4678
4770
|
# resp = client.list_type_versions({
|
4679
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4771
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4680
4772
|
# type_name: "TypeName",
|
4681
4773
|
# arn: "TypeArn",
|
4682
4774
|
# max_results: 1,
|
@@ -4688,7 +4780,7 @@ module Aws::CloudFormation
|
|
4688
4780
|
# @example Response structure
|
4689
4781
|
#
|
4690
4782
|
# resp.type_version_summaries #=> Array
|
4691
|
-
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4783
|
+
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4692
4784
|
# resp.type_version_summaries[0].type_name #=> String
|
4693
4785
|
# resp.type_version_summaries[0].version_id #=> String
|
4694
4786
|
# resp.type_version_summaries[0].is_default_version #=> Boolean
|
@@ -4741,12 +4833,12 @@ module Aws::CloudFormation
|
|
4741
4833
|
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
4742
4834
|
# process updates to the type during stack update operations.
|
4743
4835
|
#
|
4744
|
-
# * `IMMUTABLE`\: The resource type
|
4745
|
-
# so the type
|
4836
|
+
# * `IMMUTABLE`\: The resource type doesn't include an update handler,
|
4837
|
+
# so the type can't be updated and must instead be replaced during
|
4746
4838
|
# stack update operations.
|
4747
4839
|
#
|
4748
|
-
# * `NON_PROVISIONABLE`\: The resource type
|
4749
|
-
# read, and delete handlers, and therefore
|
4840
|
+
# * `NON_PROVISIONABLE`\: The resource type doesn't include create,
|
4841
|
+
# read, and delete handlers, and therefore can't actually be
|
4750
4842
|
# provisioned.
|
4751
4843
|
#
|
4752
4844
|
# The default is `FULLY_MUTABLE`.
|
@@ -4801,7 +4893,7 @@ module Aws::CloudFormation
|
|
4801
4893
|
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
4802
4894
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
4803
4895
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4804
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4896
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4805
4897
|
# filters: {
|
4806
4898
|
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
4807
4899
|
# publisher_id: "PublisherId",
|
@@ -4814,7 +4906,7 @@ module Aws::CloudFormation
|
|
4814
4906
|
# @example Response structure
|
4815
4907
|
#
|
4816
4908
|
# resp.type_summaries #=> Array
|
4817
|
-
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4909
|
+
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4818
4910
|
# resp.type_summaries[0].type_name #=> String
|
4819
4911
|
# resp.type_summaries[0].default_version_id #=> String
|
4820
4912
|
# resp.type_summaries[0].type_arn #=> String
|
@@ -4877,7 +4969,7 @@ module Aws::CloudFormation
|
|
4877
4969
|
#
|
4878
4970
|
# For more information, see [Semantic Versioning 2.0.0][1].
|
4879
4971
|
#
|
4880
|
-
# If you
|
4972
|
+
# If you don't specify a version number, CloudFormation increments the
|
4881
4973
|
# version number by one minor version release.
|
4882
4974
|
#
|
4883
4975
|
# You cannot specify a version number the first time you publish a type.
|
@@ -4895,7 +4987,7 @@ module Aws::CloudFormation
|
|
4895
4987
|
# @example Request syntax with placeholder values
|
4896
4988
|
#
|
4897
4989
|
# resp = client.publish_type({
|
4898
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4990
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4899
4991
|
# arn: "PrivateTypeArn",
|
4900
4992
|
# type_name: "TypeName",
|
4901
4993
|
# public_version_number: "PublicVersionNumber",
|
@@ -4916,7 +5008,7 @@ module Aws::CloudFormation
|
|
4916
5008
|
|
4917
5009
|
# Reports progress of a resource handler to CloudFormation.
|
4918
5010
|
#
|
4919
|
-
# Reserved for use by the [CloudFormation CLI][1].
|
5011
|
+
# Reserved for use by the [CloudFormation CLI][1]. Don't use this API
|
4920
5012
|
# in your code.
|
4921
5013
|
#
|
4922
5014
|
#
|
@@ -5062,15 +5154,15 @@ module Aws::CloudFormation
|
|
5062
5154
|
# extension makes it available for use in CloudFormation templates in
|
5063
5155
|
# your Amazon Web Services account, and includes:
|
5064
5156
|
#
|
5065
|
-
# * Validating the extension schema
|
5157
|
+
# * Validating the extension schema.
|
5066
5158
|
#
|
5067
5159
|
# * Determining which handlers, if any, have been specified for the
|
5068
|
-
# extension
|
5160
|
+
# extension.
|
5069
5161
|
#
|
5070
|
-
# * Making the extension available for use in your account
|
5162
|
+
# * Making the extension available for use in your account.
|
5071
5163
|
#
|
5072
5164
|
# For more information on how to develop extensions and ready them for
|
5073
|
-
#
|
5165
|
+
# registration, see [Creating Resource Providers][1] in the
|
5074
5166
|
# *CloudFormation CLI User Guide*.
|
5075
5167
|
#
|
5076
5168
|
# You can have a maximum of 50 resource extension versions registered at
|
@@ -5108,7 +5200,7 @@ module Aws::CloudFormation
|
|
5108
5200
|
# * For modules,
|
5109
5201
|
# *company\_or\_organization*\::*service*\::*type*\::MODULE.
|
5110
5202
|
#
|
5111
|
-
# <note markdown="1"> The following organization namespaces are reserved and
|
5203
|
+
# <note markdown="1"> The following organization namespaces are reserved and can't be used
|
5112
5204
|
# in your extension names:
|
5113
5205
|
#
|
5114
5206
|
# * `Alexa`
|
@@ -5126,15 +5218,15 @@ module Aws::CloudFormation
|
|
5126
5218
|
# </note>
|
5127
5219
|
#
|
5128
5220
|
# @option params [required, String] :schema_handler_package
|
5129
|
-
# A
|
5130
|
-
# contains the
|
5221
|
+
# A URL to the S3 bucket containing the extension project package that
|
5222
|
+
# contains the necessary files for the extension you want to register.
|
5131
5223
|
#
|
5132
5224
|
# For information on generating a schema handler package for the
|
5133
5225
|
# extension you want to register, see [submit][1] in the *CloudFormation
|
5134
5226
|
# CLI User Guide*.
|
5135
5227
|
#
|
5136
5228
|
# <note markdown="1"> The user registering the extension must be able to access the package
|
5137
|
-
# in the S3 bucket. That
|
5229
|
+
# in the S3 bucket. That's, the user needs to have [GetObject][2]
|
5138
5230
|
# permissions for the schema handler package. For more information, see
|
5139
5231
|
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
5140
5232
|
# *Identity and Access Management User Guide*.
|
@@ -5176,7 +5268,7 @@ module Aws::CloudFormation
|
|
5176
5268
|
# A unique identifier that acts as an idempotency key for this
|
5177
5269
|
# registration request. Specifying a client request token prevents
|
5178
5270
|
# CloudFormation from generating more than one version of an extension
|
5179
|
-
# from the same
|
5271
|
+
# from the same registration request, even if the request is submitted
|
5180
5272
|
# multiple times.
|
5181
5273
|
#
|
5182
5274
|
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5186,7 +5278,7 @@ module Aws::CloudFormation
|
|
5186
5278
|
# @example Request syntax with placeholder values
|
5187
5279
|
#
|
5188
5280
|
# resp = client.register_type({
|
5189
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5281
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5190
5282
|
# type_name: "TypeName", # required
|
5191
5283
|
# schema_handler_package: "S3Url", # required
|
5192
5284
|
# logging_config: {
|
@@ -5212,7 +5304,7 @@ module Aws::CloudFormation
|
|
5212
5304
|
|
5213
5305
|
# When specifying `RollbackStack`, you preserve the state of previously
|
5214
5306
|
# provisioned resources when an operation fails. You can check the
|
5215
|
-
# status of the stack through the DescribeStacks
|
5307
|
+
# status of the stack through the DescribeStacks operation.
|
5216
5308
|
#
|
5217
5309
|
# Rolls back the specified stack to the last known stable state from
|
5218
5310
|
# `CREATE_FAILED` or `UPDATE_FAILED` stack statuses.
|
@@ -5232,7 +5324,7 @@ module Aws::CloudFormation
|
|
5232
5324
|
# * `IMPORT_ROLLBACK_COMPLETE`
|
5233
5325
|
#
|
5234
5326
|
# @option params [required, String] :stack_name
|
5235
|
-
# The name that
|
5327
|
+
# The name that's associated with the stack.
|
5236
5328
|
#
|
5237
5329
|
# @option params [String] :role_arn
|
5238
5330
|
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
@@ -5273,7 +5365,7 @@ module Aws::CloudFormation
|
|
5273
5365
|
#
|
5274
5366
|
# @option params [String] :stack_policy_body
|
5275
5367
|
# Structure containing the stack policy body. For more information, go
|
5276
|
-
# to [ Prevent
|
5368
|
+
# to [ Prevent updates to stack resources][1] in the CloudFormation User
|
5277
5369
|
# Guide. You can specify either the `StackPolicyBody` or the
|
5278
5370
|
# `StackPolicyURL` parameter, but not both.
|
5279
5371
|
#
|
@@ -5283,9 +5375,9 @@ module Aws::CloudFormation
|
|
5283
5375
|
#
|
5284
5376
|
# @option params [String] :stack_policy_url
|
5285
5377
|
# Location of a file containing the stack policy. The URL must point to
|
5286
|
-
# a policy (maximum size: 16 KB) located in an S3 bucket in the
|
5287
|
-
# Region as the stack. You can specify either
|
5288
|
-
# the `StackPolicyURL` parameter, but not both.
|
5378
|
+
# a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the
|
5379
|
+
# same Amazon Web Services Region as the stack. You can specify either
|
5380
|
+
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
5289
5381
|
#
|
5290
5382
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5291
5383
|
#
|
@@ -5315,7 +5407,7 @@ module Aws::CloudFormation
|
|
5315
5407
|
# For more information, see [Configuring extensions at the account
|
5316
5408
|
# level][1] in the *CloudFormation User Guide*.
|
5317
5409
|
#
|
5318
|
-
# It
|
5410
|
+
# It's strongly recommended that you use dynamic references to restrict
|
5319
5411
|
# sensitive configuration definitions, such as third-party credentials.
|
5320
5412
|
# For more details on dynamic references, see [Using dynamic references
|
5321
5413
|
# to specify template values][2] in the *CloudFormation User Guide*.
|
@@ -5385,7 +5477,7 @@ module Aws::CloudFormation
|
|
5385
5477
|
# configuration: "TypeConfiguration", # required
|
5386
5478
|
# configuration_alias: "TypeConfigurationAlias",
|
5387
5479
|
# type_name: "TypeName",
|
5388
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5480
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5389
5481
|
# })
|
5390
5482
|
#
|
5391
5483
|
# @example Response structure
|
@@ -5431,7 +5523,7 @@ module Aws::CloudFormation
|
|
5431
5523
|
#
|
5432
5524
|
# resp = client.set_type_default_version({
|
5433
5525
|
# arn: "PrivateTypeArn",
|
5434
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5526
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5435
5527
|
# type_name: "TypeName",
|
5436
5528
|
# version_id: "TypeVersionId",
|
5437
5529
|
# })
|
@@ -5446,12 +5538,12 @@ module Aws::CloudFormation
|
|
5446
5538
|
end
|
5447
5539
|
|
5448
5540
|
# Sends a signal to the specified resource with a success or failure
|
5449
|
-
# status. You can use the SignalResource
|
5450
|
-
# creation policy or update policy. CloudFormation doesn't proceed
|
5451
|
-
# a stack creation or update until resources receive the required
|
5452
|
-
# of signals or the timeout period is exceeded. The
|
5453
|
-
# is useful in cases where you want to send
|
5454
|
-
# than an Amazon EC2 instance.
|
5541
|
+
# status. You can use the `SignalResource` operation in conjunction with
|
5542
|
+
# a creation policy or update policy. CloudFormation doesn't proceed
|
5543
|
+
# with a stack creation or update until resources receive the required
|
5544
|
+
# number of signals or the timeout period is exceeded. The
|
5545
|
+
# `SignalResource` operation is useful in cases where you want to send
|
5546
|
+
# signals from anywhere other than an Amazon EC2 instance.
|
5455
5547
|
#
|
5456
5548
|
# @option params [required, String] :stack_name
|
5457
5549
|
# The stack name or unique stack ID that includes the resource that you
|
@@ -5494,7 +5586,8 @@ module Aws::CloudFormation
|
|
5494
5586
|
end
|
5495
5587
|
|
5496
5588
|
# Stops an in-progress operation on a stack set and its associated stack
|
5497
|
-
# instances.
|
5589
|
+
# instances. StackSets will cancel all the unstarted stack instance
|
5590
|
+
# deployments and wait for those are in-progress to complete.
|
5498
5591
|
#
|
5499
5592
|
# @option params [required, String] :stack_set_name
|
5500
5593
|
# The name or unique ID of the stack set that you want to stop the
|
@@ -5556,7 +5649,7 @@ module Aws::CloudFormation
|
|
5556
5649
|
# For more information, see [Testing your public extension prior to
|
5557
5650
|
# publishing][1] in the *CloudFormation CLI User Guide*.
|
5558
5651
|
#
|
5559
|
-
# If you
|
5652
|
+
# If you don't specify a version, CloudFormation uses the default
|
5560
5653
|
# version of the extension in your account and region for testing.
|
5561
5654
|
#
|
5562
5655
|
# To perform testing, CloudFormation assumes the execution role
|
@@ -5579,7 +5672,7 @@ module Aws::CloudFormation
|
|
5579
5672
|
# [3]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
|
5580
5673
|
#
|
5581
5674
|
# @option params [String] :arn
|
5582
|
-
# The Amazon Resource
|
5675
|
+
# The Amazon Resource Name (ARN) of the extension.
|
5583
5676
|
#
|
5584
5677
|
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5585
5678
|
#
|
@@ -5599,7 +5692,7 @@ module Aws::CloudFormation
|
|
5599
5692
|
# You can specify the version id with either `Arn`, or with `TypeName`
|
5600
5693
|
# and `Type`.
|
5601
5694
|
#
|
5602
|
-
# If you
|
5695
|
+
# If you don't specify a version, CloudFormation uses the default
|
5603
5696
|
# version of the extension in this account and region for testing.
|
5604
5697
|
#
|
5605
5698
|
# @option params [String] :log_delivery_bucket
|
@@ -5614,9 +5707,9 @@ module Aws::CloudFormation
|
|
5614
5707
|
# specified S3 bucket. Specifically, the user needs the following
|
5615
5708
|
# permissions:
|
5616
5709
|
#
|
5617
|
-
# * GetObject
|
5710
|
+
# * `GetObject`
|
5618
5711
|
#
|
5619
|
-
# * PutObject
|
5712
|
+
# * `PutObject`
|
5620
5713
|
#
|
5621
5714
|
# For more information, see [Actions, Resources, and Condition Keys for
|
5622
5715
|
# Amazon S3][1] in the *Amazon Web Services Identity and Access
|
@@ -5634,7 +5727,7 @@ module Aws::CloudFormation
|
|
5634
5727
|
#
|
5635
5728
|
# resp = client.test_type({
|
5636
5729
|
# arn: "TypeArn",
|
5637
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5730
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5638
5731
|
# type_name: "TypeName",
|
5639
5732
|
# version_id: "TypeVersionId",
|
5640
5733
|
# log_delivery_bucket: "S3Bucket",
|
@@ -5655,7 +5748,7 @@ module Aws::CloudFormation
|
|
5655
5748
|
|
5656
5749
|
# Updates a stack as specified in the template. After the call completes
|
5657
5750
|
# successfully, the stack update starts. You can check the status of the
|
5658
|
-
# stack
|
5751
|
+
# stack through the DescribeStacks action.
|
5659
5752
|
#
|
5660
5753
|
# To get a copy of the template for an existing stack, you can use the
|
5661
5754
|
# GetTemplate action.
|
@@ -5686,7 +5779,7 @@ module Aws::CloudFormation
|
|
5686
5779
|
#
|
5687
5780
|
# @option params [String] :template_url
|
5688
5781
|
# Location of file containing the template body. The URL must point to a
|
5689
|
-
# template that
|
5782
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
5690
5783
|
# document. For more information, go to [Template Anatomy][1] in the
|
5691
5784
|
# CloudFormation User Guide.
|
5692
5785
|
#
|
@@ -5768,7 +5861,7 @@ module Aws::CloudFormation
|
|
5768
5861
|
#
|
5769
5862
|
# * [ AWS::IAM::Group][2]
|
5770
5863
|
#
|
5771
|
-
# * [
|
5864
|
+
# * [AWS::IAM::InstanceProfile][3]
|
5772
5865
|
#
|
5773
5866
|
# * [ AWS::IAM::Policy][4]
|
5774
5867
|
#
|
@@ -5776,7 +5869,7 @@ module Aws::CloudFormation
|
|
5776
5869
|
#
|
5777
5870
|
# * [ AWS::IAM::User][6]
|
5778
5871
|
#
|
5779
|
-
# * [
|
5872
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
5780
5873
|
#
|
5781
5874
|
# For more information, see [Acknowledging IAM Resources in
|
5782
5875
|
# CloudFormation Templates][8].
|
@@ -5846,7 +5939,7 @@ module Aws::CloudFormation
|
|
5846
5939
|
# (IAM) role that CloudFormation assumes to update the stack.
|
5847
5940
|
# CloudFormation uses the role's credentials to make calls on your
|
5848
5941
|
# behalf. CloudFormation always uses this role for all future operations
|
5849
|
-
# on the stack.
|
5942
|
+
# on the stack. Provided that users have permission to operate on the
|
5850
5943
|
# stack, CloudFormation uses this role even if the users don't have
|
5851
5944
|
# permission to pass it. Ensure that the role grants least privilege.
|
5852
5945
|
#
|
@@ -5865,7 +5958,7 @@ module Aws::CloudFormation
|
|
5865
5958
|
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
5866
5959
|
#
|
5867
5960
|
# You might update the stack policy, for example, in order to protect a
|
5868
|
-
# new resource that you created during a stack update. If you
|
5961
|
+
# new resource that you created during a stack update. If you don't
|
5869
5962
|
# specify a stack policy, the current policy that is associated with the
|
5870
5963
|
# stack is unchanged.
|
5871
5964
|
#
|
@@ -5876,7 +5969,7 @@ module Aws::CloudFormation
|
|
5876
5969
|
# the `StackPolicyURL` parameter, but not both.
|
5877
5970
|
#
|
5878
5971
|
# You might update the stack policy, for example, in order to protect a
|
5879
|
-
# new resource that you created during a stack update. If you
|
5972
|
+
# new resource that you created during a stack update. If you don't
|
5880
5973
|
# specify a stack policy, the current policy that is associated with the
|
5881
5974
|
# stack is unchanged.
|
5882
5975
|
#
|
@@ -5981,15 +6074,15 @@ module Aws::CloudFormation
|
|
5981
6074
|
end
|
5982
6075
|
|
5983
6076
|
# Updates the parameter values for stack instances for the specified
|
5984
|
-
# accounts, within the specified Regions. A stack
|
5985
|
-
# stack in a specific account and Region.
|
6077
|
+
# accounts, within the specified Amazon Web Services Regions. A stack
|
6078
|
+
# instance refers to a stack in a specific account and Region.
|
5986
6079
|
#
|
5987
|
-
# You can only update stack instances in
|
5988
|
-
# already exist; to create additional stack
|
5989
|
-
# [CreateStackInstances][1].
|
6080
|
+
# You can only update stack instances in Amazon Web Services Regions and
|
6081
|
+
# accounts where they already exist; to create additional stack
|
6082
|
+
# instances, use [CreateStackInstances][1].
|
5990
6083
|
#
|
5991
6084
|
# During stack set updates, any parameters overridden for a stack
|
5992
|
-
# instance
|
6085
|
+
# instance aren't updated, but retain their overridden value.
|
5993
6086
|
#
|
5994
6087
|
# You can only update the parameter *values* that are specified in the
|
5995
6088
|
# stack set; to add or delete a parameter itself, use
|
@@ -6014,7 +6107,8 @@ module Aws::CloudFormation
|
|
6014
6107
|
# \[Self-managed permissions\] The names of one or more Amazon Web
|
6015
6108
|
# Services accounts for which you want to update parameter values for
|
6016
6109
|
# stack instances. The overridden parameter values will be applied to
|
6017
|
-
# all stack instances in the specified accounts and
|
6110
|
+
# all stack instances in the specified accounts and Amazon Web Services
|
6111
|
+
# Regions.
|
6018
6112
|
#
|
6019
6113
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6020
6114
|
#
|
@@ -6029,35 +6123,36 @@ module Aws::CloudFormation
|
|
6029
6123
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6030
6124
|
#
|
6031
6125
|
# @option params [required, Array<String>] :regions
|
6032
|
-
# The names of one or more Regions in which you want
|
6033
|
-
# values for stack instances. The overridden
|
6034
|
-
# applied to all stack instances in the
|
6126
|
+
# The names of one or more Amazon Web Services Regions in which you want
|
6127
|
+
# to update parameter values for stack instances. The overridden
|
6128
|
+
# parameter values will be applied to all stack instances in the
|
6129
|
+
# specified accounts and Amazon Web Services Regions.
|
6035
6130
|
#
|
6036
6131
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
6037
6132
|
# A list of input parameters whose values you want to update for the
|
6038
6133
|
# specified stack instances.
|
6039
6134
|
#
|
6040
6135
|
# Any overridden parameter values will be applied to all stack instances
|
6041
|
-
# in the specified accounts and Regions. When
|
6042
|
-
# their values, be aware of how CloudFormation
|
6043
|
-
# during stack instance update operations:
|
6136
|
+
# in the specified accounts and Amazon Web Services Regions. When
|
6137
|
+
# specifying parameters and their values, be aware of how CloudFormation
|
6138
|
+
# sets parameter values during stack instance update operations:
|
6044
6139
|
#
|
6045
6140
|
# * To override the current value for a parameter, include the parameter
|
6046
6141
|
# and specify its value.
|
6047
6142
|
#
|
6048
6143
|
# * To leave an overridden parameter set to its present value, include
|
6049
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
6144
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
6050
6145
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
6051
6146
|
#
|
6052
6147
|
# * To set an overridden parameter back to the value specified in the
|
6053
|
-
# stack set, specify a parameter list but
|
6148
|
+
# stack set, specify a parameter list but don't include the parameter
|
6054
6149
|
# in the list.
|
6055
6150
|
#
|
6056
|
-
# * To leave all parameters set to their present values,
|
6151
|
+
# * To leave all parameters set to their present values, don't specify
|
6057
6152
|
# this property at all.
|
6058
6153
|
#
|
6059
6154
|
# During stack set updates, any parameter values overridden for a stack
|
6060
|
-
# instance
|
6155
|
+
# instance aren't updated, but retain their overridden value.
|
6061
6156
|
#
|
6062
6157
|
# You can only override the parameter *values* that are specified in the
|
6063
6158
|
# stack set; to add or delete a parameter itself, use `UpdateStackSet`
|
@@ -6162,7 +6257,7 @@ module Aws::CloudFormation
|
|
6162
6257
|
end
|
6163
6258
|
|
6164
6259
|
# Updates the stack set, and associated stack instances in the specified
|
6165
|
-
# accounts and Regions.
|
6260
|
+
# accounts and Amazon Web Services Regions.
|
6166
6261
|
#
|
6167
6262
|
# Even if the stack set operation created by updating the stack set
|
6168
6263
|
# fails (completely or partially, below or above a specified failure
|
@@ -6303,7 +6398,7 @@ module Aws::CloudFormation
|
|
6303
6398
|
#
|
6304
6399
|
# * If you specify *any* tags using this parameter, you must specify
|
6305
6400
|
# *all* the tags that you want associated with this stack set, even
|
6306
|
-
# tags you've
|
6401
|
+
# tags you've specified before (for example, when creating the stack
|
6307
6402
|
# set or during a previous update of the stack set.). Any tags that
|
6308
6403
|
# you don't include in the updated list of tags are removed from the
|
6309
6404
|
# stack set, and therefore from the stacks and resources as well.
|
@@ -6369,10 +6464,10 @@ module Aws::CloudFormation
|
|
6369
6464
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
6370
6465
|
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
6371
6466
|
# prior to updating the stack instances in the specified accounts and
|
6372
|
-
# Regions. If the stack set update
|
6373
|
-
# template or parameters, CloudFormation updates the
|
6374
|
-
# the specified accounts and Regions, while leaving
|
6375
|
-
# instances with their existing stack instance status.
|
6467
|
+
# Amazon Web Services Regions. If the stack set update doesn't include
|
6468
|
+
# changes to the template or parameters, CloudFormation updates the
|
6469
|
+
# stack instances in the specified accounts and Regions, while leaving
|
6470
|
+
# all other stack instances with their existing stack instance status.
|
6376
6471
|
#
|
6377
6472
|
# @option params [String] :permission_model
|
6378
6473
|
# Describes how the IAM roles required for stack set operations are
|
@@ -6398,7 +6493,7 @@ module Aws::CloudFormation
|
|
6398
6493
|
# automatically deploys to Organizations accounts that are added to a
|
6399
6494
|
# target organization or organizational unit (OU).
|
6400
6495
|
#
|
6401
|
-
# If you specify `AutoDeployment`,
|
6496
|
+
# If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
|
6402
6497
|
# `Regions`.
|
6403
6498
|
#
|
6404
6499
|
# @option params [String] :operation_id
|
@@ -6422,25 +6517,26 @@ module Aws::CloudFormation
|
|
6422
6517
|
# @option params [Array<String>] :accounts
|
6423
6518
|
# \[Self-managed permissions\] The accounts in which to update
|
6424
6519
|
# associated stack instances. If you specify accounts, you must also
|
6425
|
-
# specify the Regions in which to update stack set
|
6520
|
+
# specify the Amazon Web Services Regions in which to update stack set
|
6521
|
+
# instances.
|
6426
6522
|
#
|
6427
|
-
# To update *all* the stack instances associated with this stack set,
|
6428
|
-
#
|
6523
|
+
# To update *all* the stack instances associated with this stack set,
|
6524
|
+
# don't specify the `Accounts` or `Regions` properties.
|
6429
6525
|
#
|
6430
6526
|
# If the stack set update includes changes to the template (that is, if
|
6431
6527
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
6432
6528
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
6433
6529
|
# status of `OUTDATED` prior to updating the stack instances in the
|
6434
|
-
# specified accounts and Regions. If the stack set
|
6435
|
-
# include changes to the template or parameters,
|
6436
|
-
# the stack instances in the specified accounts
|
6437
|
-
#
|
6438
|
-
# status.
|
6530
|
+
# specified accounts and Amazon Web Services Regions. If the stack set
|
6531
|
+
# update does not include changes to the template or parameters,
|
6532
|
+
# CloudFormation updates the stack instances in the specified accounts
|
6533
|
+
# and Amazon Web Services Regions, while leaving all other stack
|
6534
|
+
# instances with their existing stack instance status.
|
6439
6535
|
#
|
6440
6536
|
# @option params [Array<String>] :regions
|
6441
|
-
# The Regions in which to update associated stack
|
6442
|
-
# specify Regions, you must also specify accounts in
|
6443
|
-
# stack set instances.
|
6537
|
+
# The Amazon Web Services Regions in which to update associated stack
|
6538
|
+
# instances. If you specify Regions, you must also specify accounts in
|
6539
|
+
# which to update stack set instances.
|
6444
6540
|
#
|
6445
6541
|
# To update *all* the stack instances associated with this stack set, do
|
6446
6542
|
# not specify the `Accounts` or `Regions` properties.
|
@@ -6557,7 +6653,7 @@ module Aws::CloudFormation
|
|
6557
6653
|
# User Guide*.
|
6558
6654
|
#
|
6559
6655
|
# For [nested stacks][2], termination protection is set on the root
|
6560
|
-
# stack and
|
6656
|
+
# stack and can't be changed directly on the nested stack.
|
6561
6657
|
#
|
6562
6658
|
#
|
6563
6659
|
#
|
@@ -6676,7 +6772,7 @@ module Aws::CloudFormation
|
|
6676
6772
|
params: params,
|
6677
6773
|
config: config)
|
6678
6774
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
6679
|
-
context[:gem_version] = '1.
|
6775
|
+
context[:gem_version] = '1.66.0'
|
6680
6776
|
Seahorse::Client::Request.new(handlers, context)
|
6681
6777
|
end
|
6682
6778
|
|