aws-sdk-cloudformation 1.63.0 → 1.67.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +327 -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 +559 -318
- 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
|
|
@@ -175,6 +179,10 @@ module Aws::CloudFormation
|
|
175
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
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
|
+
#
|
178
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
187
|
# Set to true to disable SDK automatically adding host prefix
|
180
188
|
# to default service endpoint when available.
|
@@ -297,7 +305,7 @@ module Aws::CloudFormation
|
|
297
305
|
# seconds to wait when opening a HTTP session before raising a
|
298
306
|
# `Timeout::Error`.
|
299
307
|
#
|
300
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
309
|
# number of seconds to wait for response data. This value can
|
302
310
|
# safely be set per-request on the session.
|
303
311
|
#
|
@@ -313,6 +321,9 @@ module Aws::CloudFormation
|
|
313
321
|
# disables this behaviour. This value can safely be set per
|
314
322
|
# request on the session.
|
315
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
316
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
328
|
# HTTP debug output will be sent to the `:logger`.
|
318
329
|
#
|
@@ -429,7 +440,7 @@ module Aws::CloudFormation
|
|
429
440
|
# @example Request syntax with placeholder values
|
430
441
|
#
|
431
442
|
# resp = client.activate_type({
|
432
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
443
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
433
444
|
# public_type_arn: "ThirdPartyTypeArn",
|
434
445
|
# publisher_id: "PublisherId",
|
435
446
|
# type_name: "TypeName",
|
@@ -485,7 +496,7 @@ module Aws::CloudFormation
|
|
485
496
|
# type_arn: "TypeArn",
|
486
497
|
# type_configuration_alias: "TypeConfigurationAlias",
|
487
498
|
# type_configuration_arn: "TypeConfigurationArn",
|
488
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
499
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
489
500
|
# type_name: "TypeName",
|
490
501
|
# },
|
491
502
|
# ],
|
@@ -499,13 +510,13 @@ module Aws::CloudFormation
|
|
499
510
|
# resp.errors[0].type_configuration_identifier.type_arn #=> String
|
500
511
|
# resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
|
501
512
|
# resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
|
502
|
-
# 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"
|
503
514
|
# resp.errors[0].type_configuration_identifier.type_name #=> String
|
504
515
|
# resp.unprocessed_type_configurations #=> Array
|
505
516
|
# resp.unprocessed_type_configurations[0].type_arn #=> String
|
506
517
|
# resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
|
507
518
|
# resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
|
508
|
-
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE"
|
519
|
+
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
509
520
|
# resp.unprocessed_type_configurations[0].type_name #=> String
|
510
521
|
# resp.type_configurations #=> Array
|
511
522
|
# resp.type_configurations[0].arn #=> String
|
@@ -529,12 +540,12 @@ module Aws::CloudFormation
|
|
529
540
|
# successfully, the stack rolls back the update and reverts to the
|
530
541
|
# previous stack configuration.
|
531
542
|
#
|
532
|
-
# <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.
|
533
544
|
#
|
534
545
|
# </note>
|
535
546
|
#
|
536
547
|
# @option params [required, String] :stack_name
|
537
|
-
# The name or the unique stack ID that
|
548
|
+
# The name or the unique stack ID that's associated with the stack.
|
538
549
|
#
|
539
550
|
# @option params [String] :client_request_token
|
540
551
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
@@ -561,7 +572,7 @@ module Aws::CloudFormation
|
|
561
572
|
req.send_request(options)
|
562
573
|
end
|
563
574
|
|
564
|
-
# For a specified stack that
|
575
|
+
# For a specified stack that's in the `UPDATE_ROLLBACK_FAILED` state,
|
565
576
|
# continues rolling it back to the `UPDATE_ROLLBACK_COMPLETE` state.
|
566
577
|
# Depending on the cause of the failure, you can manually [ fix the
|
567
578
|
# error][1] and continue the rollback. By continuing the rollback, you
|
@@ -570,8 +581,8 @@ module Aws::CloudFormation
|
|
570
581
|
# again.
|
571
582
|
#
|
572
583
|
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
573
|
-
# CloudFormation
|
574
|
-
# 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
|
575
586
|
# old database instance that was deleted outside of CloudFormation.
|
576
587
|
# Because CloudFormation doesn't know the database was deleted, it
|
577
588
|
# assumes that the database instance still exists and attempts to roll
|
@@ -597,13 +608,13 @@ module Aws::CloudFormation
|
|
597
608
|
# (IAM) role that CloudFormation assumes to roll back the stack.
|
598
609
|
# CloudFormation uses the role's credentials to make calls on your
|
599
610
|
# behalf. CloudFormation always uses this role for all future operations
|
600
|
-
# on the stack.
|
611
|
+
# on the stack. Provided that users have permission to operate on the
|
601
612
|
# stack, CloudFormation uses this role even if the users don't have
|
602
|
-
# permission to pass it. Ensure that the role grants least
|
613
|
+
# permission to pass it. Ensure that the role grants least permission.
|
603
614
|
#
|
604
615
|
# If you don't specify a value, CloudFormation uses the role that was
|
605
616
|
# previously associated with the stack. If no role is available,
|
606
|
-
# CloudFormation uses a temporary session that
|
617
|
+
# CloudFormation uses a temporary session that's generated from your
|
607
618
|
# user credentials.
|
608
619
|
#
|
609
620
|
# @option params [Array<String>] :resources_to_skip
|
@@ -611,7 +622,7 @@ module Aws::CloudFormation
|
|
611
622
|
# during the continue update rollback operation. You can specify only
|
612
623
|
# resources that are in the `UPDATE_FAILED` state because a rollback
|
613
624
|
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
614
|
-
# state for other reasons, for example, because an update was
|
625
|
+
# state for other reasons, for example, because an update was canceled.
|
615
626
|
# To check why a resource update failed, use the DescribeStackResources
|
616
627
|
# action, and view the resource status reason.
|
617
628
|
#
|
@@ -702,7 +713,7 @@ module Aws::CloudFormation
|
|
702
713
|
# execute the change set by using the ExecuteChangeSet action.
|
703
714
|
# CloudFormation doesn't make changes until you execute the change set.
|
704
715
|
#
|
705
|
-
# To create a change set for the entire stack
|
716
|
+
# To create a change set for the entire stack hierarchy, set
|
706
717
|
# `IncludeNestedStacks` to `True`.
|
707
718
|
#
|
708
719
|
# @option params [required, String] :stack_name
|
@@ -721,15 +732,15 @@ module Aws::CloudFormation
|
|
721
732
|
#
|
722
733
|
# @option params [String] :template_url
|
723
734
|
# The location of the file that contains the revised template. The URL
|
724
|
-
# must point to a template (max size: 460,800 bytes) that
|
725
|
-
# an S3 bucket or a Systems Manager document. CloudFormation
|
726
|
-
# the change set by comparing this template with the stack
|
727
|
-
# 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.
|
728
739
|
#
|
729
740
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
730
741
|
#
|
731
742
|
# @option params [Boolean] :use_previous_template
|
732
|
-
# Whether to reuse the template that
|
743
|
+
# Whether to reuse the template that's associated with the stack to
|
733
744
|
# create the change set.
|
734
745
|
#
|
735
746
|
# @option params [Array<Types::Parameter>] :parameters
|
@@ -768,7 +779,7 @@ module Aws::CloudFormation
|
|
768
779
|
#
|
769
780
|
# * [ AWS::IAM::Group][2]
|
770
781
|
#
|
771
|
-
# * [
|
782
|
+
# * [AWS::IAM::InstanceProfile][3]
|
772
783
|
#
|
773
784
|
# * [ AWS::IAM::Policy][4]
|
774
785
|
#
|
@@ -776,10 +787,10 @@ module Aws::CloudFormation
|
|
776
787
|
#
|
777
788
|
# * [ AWS::IAM::User][6]
|
778
789
|
#
|
779
|
-
# * [
|
790
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
780
791
|
#
|
781
|
-
# For more information, see [Acknowledging IAM
|
782
|
-
# CloudFormation
|
792
|
+
# For more information, see [Acknowledging IAM resources in
|
793
|
+
# CloudFormation templates][8].
|
783
794
|
#
|
784
795
|
# * `CAPABILITY_AUTO_EXPAND`
|
785
796
|
#
|
@@ -796,7 +807,7 @@ module Aws::CloudFormation
|
|
796
807
|
# [AWS::Serverless][10] transforms, which are macros hosted by
|
797
808
|
# CloudFormation.
|
798
809
|
#
|
799
|
-
# <note markdown="1"> This capacity
|
810
|
+
# <note markdown="1"> This capacity doesn't apply to creating change sets, and specifying
|
800
811
|
# it when creating change sets has no effect.
|
801
812
|
#
|
802
813
|
# If you want to create a stack from a stack template that contains
|
@@ -806,8 +817,8 @@ module Aws::CloudFormation
|
|
806
817
|
#
|
807
818
|
# </note>
|
808
819
|
#
|
809
|
-
# For more information on macros, see [Using CloudFormation
|
810
|
-
#
|
820
|
+
# For more information on macros, see [Using CloudFormation macros to
|
821
|
+
# perform custom processing on templates][11].
|
811
822
|
#
|
812
823
|
#
|
813
824
|
#
|
@@ -833,7 +844,7 @@ module Aws::CloudFormation
|
|
833
844
|
# grants permissions to all resource types. Identity and Access
|
834
845
|
# Management (IAM) uses this parameter for condition keys in IAM
|
835
846
|
# policies for CloudFormation. For more information, see [Controlling
|
836
|
-
#
|
847
|
+
# access with Identity and Access Management][1] in the CloudFormation
|
837
848
|
# User Guide.
|
838
849
|
#
|
839
850
|
#
|
@@ -845,9 +856,9 @@ module Aws::CloudFormation
|
|
845
856
|
# (IAM) role that CloudFormation assumes when executing the change set.
|
846
857
|
# CloudFormation uses the role's credentials to make calls on your
|
847
858
|
# behalf. CloudFormation uses this role for all future operations on the
|
848
|
-
# stack.
|
859
|
+
# stack. Provided that users have permission to operate on the stack,
|
849
860
|
# CloudFormation uses this role even if the users don't have permission
|
850
|
-
# to pass it. Ensure that the role grants least
|
861
|
+
# to pass it. Ensure that the role grants least permission.
|
851
862
|
#
|
852
863
|
# If you don't specify a value, CloudFormation uses the role that was
|
853
864
|
# previously associated with the stack. If no role is available,
|
@@ -874,8 +885,8 @@ module Aws::CloudFormation
|
|
874
885
|
# sets that are associated with the specified stack.
|
875
886
|
#
|
876
887
|
# A change set name can contain only alphanumeric, case sensitive
|
877
|
-
# characters and hyphens. It must start with an
|
878
|
-
#
|
888
|
+
# characters, and hyphens. It must start with an alphabetical character
|
889
|
+
# and can't exceed 128 characters.
|
879
890
|
#
|
880
891
|
# @option params [String] :client_token
|
881
892
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
@@ -985,14 +996,14 @@ module Aws::CloudFormation
|
|
985
996
|
|
986
997
|
# Creates a stack as specified in the template. After the call completes
|
987
998
|
# successfully, the stack creation starts. You can check the status of
|
988
|
-
# the stack
|
999
|
+
# the stack through the DescribeStacksoperation.
|
989
1000
|
#
|
990
1001
|
# @option params [required, String] :stack_name
|
991
|
-
# The name that
|
1002
|
+
# The name that's associated with the stack. The name must be unique in
|
992
1003
|
# the Region in which you are creating the stack.
|
993
1004
|
#
|
994
1005
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
|
995
|
-
# and hyphens. It must start with an alphabetical character and
|
1006
|
+
# and hyphens. It must start with an alphabetical character and can't
|
996
1007
|
# be longer than 128 characters.
|
997
1008
|
#
|
998
1009
|
# </note>
|
@@ -1000,7 +1011,7 @@ module Aws::CloudFormation
|
|
1000
1011
|
# @option params [String] :template_body
|
1001
1012
|
# Structure containing the template body with a minimum length of 1 byte
|
1002
1013
|
# and a maximum length of 51,200 bytes. For more information, go to
|
1003
|
-
# [Template
|
1014
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1004
1015
|
#
|
1005
1016
|
# Conditional: You must specify either the `TemplateBody` or the
|
1006
1017
|
# `TemplateURL` parameter, but not both.
|
@@ -1011,9 +1022,9 @@ module Aws::CloudFormation
|
|
1011
1022
|
#
|
1012
1023
|
# @option params [String] :template_url
|
1013
1024
|
# Location of file containing the template body. The URL must point to a
|
1014
|
-
# template (max size: 460,800 bytes) that
|
1025
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
1015
1026
|
# bucket or a Systems Manager document. For more information, go to the
|
1016
|
-
# [Template
|
1027
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1017
1028
|
#
|
1018
1029
|
# Conditional: You must specify either the `TemplateBody` or the
|
1019
1030
|
# `TemplateURL` parameter, but not both.
|
@@ -1048,9 +1059,9 @@ module Aws::CloudFormation
|
|
1048
1059
|
# the stack will be rolled back.
|
1049
1060
|
#
|
1050
1061
|
# @option params [Array<String>] :notification_arns
|
1051
|
-
# The Simple Notification Service (SNS) topic ARNs to
|
1052
|
-
# related events. You can find your SNS topic ARNs
|
1053
|
-
# 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).
|
1054
1065
|
#
|
1055
1066
|
# @option params [Array<String>] :capabilities
|
1056
1067
|
# In some cases, you must explicitly acknowledge that your stack
|
@@ -1084,7 +1095,7 @@ module Aws::CloudFormation
|
|
1084
1095
|
#
|
1085
1096
|
# * [ AWS::IAM::Group][2]
|
1086
1097
|
#
|
1087
|
-
# * [
|
1098
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1088
1099
|
#
|
1089
1100
|
# * [ AWS::IAM::Policy][4]
|
1090
1101
|
#
|
@@ -1092,7 +1103,7 @@ module Aws::CloudFormation
|
|
1092
1103
|
#
|
1093
1104
|
# * [ AWS::IAM::User][6]
|
1094
1105
|
#
|
1095
|
-
# * [
|
1106
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1096
1107
|
#
|
1097
1108
|
# For more information, see [Acknowledging IAM Resources in
|
1098
1109
|
# CloudFormation Templates][8].
|
@@ -1124,8 +1135,8 @@ module Aws::CloudFormation
|
|
1124
1135
|
# can update the function operation without CloudFormation being
|
1125
1136
|
# notified.
|
1126
1137
|
#
|
1127
|
-
# For more information, see [Using CloudFormation
|
1128
|
-
#
|
1138
|
+
# For more information, see [Using CloudFormation macros to perform
|
1139
|
+
# custom processing on templates][11].
|
1129
1140
|
#
|
1130
1141
|
#
|
1131
1142
|
#
|
@@ -1168,18 +1179,18 @@ module Aws::CloudFormation
|
|
1168
1179
|
# (IAM) role that CloudFormation assumes to create the stack.
|
1169
1180
|
# CloudFormation uses the role's credentials to make calls on your
|
1170
1181
|
# behalf. CloudFormation always uses this role for all future operations
|
1171
|
-
# on the stack.
|
1182
|
+
# on the stack. Provided that users have permission to operate on the
|
1172
1183
|
# stack, CloudFormation uses this role even if the users don't have
|
1173
1184
|
# permission to pass it. Ensure that the role grants least privilege.
|
1174
1185
|
#
|
1175
1186
|
# If you don't specify a value, CloudFormation uses the role that was
|
1176
1187
|
# previously associated with the stack. If no role is available,
|
1177
|
-
# CloudFormation uses a temporary session that
|
1188
|
+
# CloudFormation uses a temporary session that's generated from your
|
1178
1189
|
# user credentials.
|
1179
1190
|
#
|
1180
1191
|
# @option params [String] :on_failure
|
1181
1192
|
# Determines what action will be taken if stack creation fails. This
|
1182
|
-
# must be one of:
|
1193
|
+
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
1183
1194
|
# either `OnFailure` or `DisableRollback`, but not both.
|
1184
1195
|
#
|
1185
1196
|
# Default: `ROLLBACK`
|
@@ -1212,7 +1223,7 @@ module Aws::CloudFormation
|
|
1212
1223
|
# retry `CreateStack` requests to ensure that CloudFormation
|
1213
1224
|
# successfully received them.
|
1214
1225
|
#
|
1215
|
-
# All events
|
1226
|
+
# All events initiated by a given stack operation are assigned the same
|
1216
1227
|
# client request token, which you can use to track operations. For
|
1217
1228
|
# example, if you execute a `CreateStack` operation with the token
|
1218
1229
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1231,11 +1242,11 @@ module Aws::CloudFormation
|
|
1231
1242
|
# user attempts to delete a stack with termination protection enabled,
|
1232
1243
|
# the operation fails and the stack remains unchanged. For more
|
1233
1244
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
1234
|
-
# *CloudFormation User Guide*. Termination protection is
|
1245
|
+
# *CloudFormation User Guide*. Termination protection is deactivated on
|
1235
1246
|
# stacks by default.
|
1236
1247
|
#
|
1237
1248
|
# For [nested stacks][2], termination protection is set on the root
|
1238
|
-
# stack and
|
1249
|
+
# stack and can't be changed directly on the nested stack.
|
1239
1250
|
#
|
1240
1251
|
#
|
1241
1252
|
#
|
@@ -1302,10 +1313,10 @@ module Aws::CloudFormation
|
|
1302
1313
|
end
|
1303
1314
|
|
1304
1315
|
# Creates stack instances for the specified accounts, within the
|
1305
|
-
# specified Regions. A stack instance refers to a
|
1306
|
-
# account and Region. You must specify at least one
|
1307
|
-
# `Accounts` or `DeploymentTargets`, and you must
|
1308
|
-
# 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`.
|
1309
1320
|
#
|
1310
1321
|
# @option params [required, String] :stack_set_name
|
1311
1322
|
# The name or unique ID of the stack set that you want to create stack
|
@@ -1320,39 +1331,41 @@ module Aws::CloudFormation
|
|
1320
1331
|
#
|
1321
1332
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1322
1333
|
# \[Service-managed permissions\] The Organizations accounts for which
|
1323
|
-
# to create stack instances in the specified
|
1334
|
+
# to create stack instances in the specified Amazon Web Services
|
1335
|
+
# Regions.
|
1324
1336
|
#
|
1325
1337
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1326
1338
|
#
|
1327
1339
|
# @option params [required, Array<String>] :regions
|
1328
|
-
# The names of one or more Regions where you want to
|
1329
|
-
# 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.
|
1330
1343
|
#
|
1331
1344
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
1332
1345
|
# A list of stack set parameters whose values you want to override in
|
1333
1346
|
# the selected stack instances.
|
1334
1347
|
#
|
1335
1348
|
# Any overridden parameter values will be applied to all stack instances
|
1336
|
-
# in the specified accounts and Regions. When
|
1337
|
-
# their values, be aware of how CloudFormation
|
1338
|
-
# 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:
|
1339
1352
|
#
|
1340
1353
|
# * To override the current value for a parameter, include the parameter
|
1341
1354
|
# and specify its value.
|
1342
1355
|
#
|
1343
1356
|
# * To leave an overridden parameter set to its present value, include
|
1344
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
1357
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
1345
1358
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
1346
1359
|
#
|
1347
1360
|
# * To set an overridden parameter back to the value specified in the
|
1348
|
-
# stack set, specify a parameter list but
|
1361
|
+
# stack set, specify a parameter list but don't include the parameter
|
1349
1362
|
# in the list.
|
1350
1363
|
#
|
1351
|
-
# * To leave all parameters set to their present values,
|
1364
|
+
# * To leave all parameters set to their present values, don't specify
|
1352
1365
|
# this property at all.
|
1353
1366
|
#
|
1354
1367
|
# During stack set updates, any parameter values overridden for a stack
|
1355
|
-
# instance
|
1368
|
+
# instance aren't updated, but retain their overridden value.
|
1356
1369
|
#
|
1357
1370
|
# You can only override the parameter *values* that are specified in the
|
1358
1371
|
# stack set; to add or delete a parameter itself, use
|
@@ -1534,7 +1547,7 @@ module Aws::CloudFormation
|
|
1534
1547
|
#
|
1535
1548
|
# * [ AWS::IAM::Group][2]
|
1536
1549
|
#
|
1537
|
-
# * [
|
1550
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1538
1551
|
#
|
1539
1552
|
# * [ AWS::IAM::Policy][4]
|
1540
1553
|
#
|
@@ -1542,7 +1555,7 @@ module Aws::CloudFormation
|
|
1542
1555
|
#
|
1543
1556
|
# * [ AWS::IAM::User][6]
|
1544
1557
|
#
|
1545
|
-
# * [
|
1558
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1546
1559
|
#
|
1547
1560
|
# For more information, see [Acknowledging IAM Resources in
|
1548
1561
|
# CloudFormation Templates][8].
|
@@ -1557,7 +1570,7 @@ module Aws::CloudFormation
|
|
1557
1570
|
# [Using CloudFormation Macros to Perform Custom Processing on
|
1558
1571
|
# Templates][9].
|
1559
1572
|
#
|
1560
|
-
# Stack sets with service-managed permissions
|
1573
|
+
# Stack sets with service-managed permissions don't currently support
|
1561
1574
|
# the use of macros in templates. (This includes the
|
1562
1575
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1563
1576
|
# macros hosted by CloudFormation.) Even if you specify this
|
@@ -1737,10 +1750,10 @@ module Aws::CloudFormation
|
|
1737
1750
|
# Deactivates a public extension that was previously activated in this
|
1738
1751
|
# account and region.
|
1739
1752
|
#
|
1740
|
-
# Once deactivated, an extension
|
1753
|
+
# Once deactivated, an extension can't be used in any CloudFormation
|
1741
1754
|
# operation. This includes stack update operations where the stack
|
1742
1755
|
# template includes the extension, even if no updates are being made to
|
1743
|
-
# the extension. In addition, deactivated extensions
|
1756
|
+
# the extension. In addition, deactivated extensions aren't
|
1744
1757
|
# automatically updated if a new version of the extension is released.
|
1745
1758
|
#
|
1746
1759
|
# @option params [String] :type_name
|
@@ -1767,7 +1780,7 @@ module Aws::CloudFormation
|
|
1767
1780
|
#
|
1768
1781
|
# resp = client.deactivate_type({
|
1769
1782
|
# type_name: "TypeName",
|
1770
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1783
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
1771
1784
|
# arn: "PrivateTypeArn",
|
1772
1785
|
# })
|
1773
1786
|
#
|
@@ -1797,7 +1810,7 @@ module Aws::CloudFormation
|
|
1797
1810
|
#
|
1798
1811
|
# @option params [String] :stack_name
|
1799
1812
|
# If you specified the name of a change set to delete, specify the stack
|
1800
|
-
# name or
|
1813
|
+
# name or Amazon Resource Name (ARN) that's associated with it.
|
1801
1814
|
#
|
1802
1815
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1803
1816
|
#
|
@@ -1818,19 +1831,19 @@ module Aws::CloudFormation
|
|
1818
1831
|
end
|
1819
1832
|
|
1820
1833
|
# Deletes a specified stack. Once the call completes successfully, stack
|
1821
|
-
# deletion starts. Deleted stacks
|
1822
|
-
#
|
1834
|
+
# deletion starts. Deleted stacks don't show up in the DescribeStacks
|
1835
|
+
# operation if the deletion has been completed successfully.
|
1823
1836
|
#
|
1824
1837
|
# @option params [required, String] :stack_name
|
1825
|
-
# The name or the unique stack ID that
|
1838
|
+
# The name or the unique stack ID that's associated with the stack.
|
1826
1839
|
#
|
1827
1840
|
# @option params [Array<String>] :retain_resources
|
1828
1841
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1829
1842
|
# IDs that are associated with the resources you want to retain. During
|
1830
|
-
# deletion, CloudFormation deletes the stack but
|
1843
|
+
# deletion, CloudFormation deletes the stack but doesn't delete the
|
1831
1844
|
# retained resources.
|
1832
1845
|
#
|
1833
|
-
# Retaining resources is useful when you
|
1846
|
+
# Retaining resources is useful when you can't delete a resource, such
|
1834
1847
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
1835
1848
|
#
|
1836
1849
|
# @option params [String] :role_arn
|
@@ -1841,7 +1854,7 @@ module Aws::CloudFormation
|
|
1841
1854
|
#
|
1842
1855
|
# If you don't specify a value, CloudFormation uses the role that was
|
1843
1856
|
# previously associated with the stack. If no role is available,
|
1844
|
-
# CloudFormation uses a temporary session that
|
1857
|
+
# CloudFormation uses a temporary session that's generated from your
|
1845
1858
|
# user credentials.
|
1846
1859
|
#
|
1847
1860
|
# @option params [String] :client_request_token
|
@@ -1851,7 +1864,7 @@ module Aws::CloudFormation
|
|
1851
1864
|
# retry `DeleteStack` requests to ensure that CloudFormation
|
1852
1865
|
# successfully received them.
|
1853
1866
|
#
|
1854
|
-
# All events
|
1867
|
+
# All events initiated by a given stack operation are assigned the same
|
1855
1868
|
# client request token, which you can use to track operations. For
|
1856
1869
|
# example, if you execute a `CreateStack` operation with the token
|
1857
1870
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1886,7 +1899,7 @@ module Aws::CloudFormation
|
|
1886
1899
|
end
|
1887
1900
|
|
1888
1901
|
# Deletes stack instances for the specified accounts, in the specified
|
1889
|
-
# Regions.
|
1902
|
+
# Amazon Web Services Regions.
|
1890
1903
|
#
|
1891
1904
|
# @option params [required, String] :stack_set_name
|
1892
1905
|
# The name or unique ID of the stack set that you want to delete stack
|
@@ -1905,7 +1918,8 @@ module Aws::CloudFormation
|
|
1905
1918
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1906
1919
|
#
|
1907
1920
|
# @option params [required, Array<String>] :regions
|
1908
|
-
# The Regions where you want to delete stack set
|
1921
|
+
# The Amazon Web Services Regions where you want to delete stack set
|
1922
|
+
# instances.
|
1909
1923
|
#
|
1910
1924
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1911
1925
|
# Preferences for how CloudFormation performs this stack set operation.
|
@@ -2061,9 +2075,9 @@ module Aws::CloudFormation
|
|
2061
2075
|
# extension itself being deregistered and marked as deprecated in the
|
2062
2076
|
# registry.
|
2063
2077
|
#
|
2064
|
-
# You
|
2078
|
+
# You can't deregister the default version of an extension if there are
|
2065
2079
|
# other active version of that extension. If you do deregister the
|
2066
|
-
# default version of an extension, the
|
2080
|
+
# default version of an extension, the extension type itself is
|
2067
2081
|
# deregistered as well and marked as deprecated.
|
2068
2082
|
#
|
2069
2083
|
# To view the deprecation status of an extension or extension version,
|
@@ -2099,7 +2113,7 @@ module Aws::CloudFormation
|
|
2099
2113
|
#
|
2100
2114
|
# resp = client.deregister_type({
|
2101
2115
|
# arn: "PrivateTypeArn",
|
2102
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
2116
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
2103
2117
|
# type_name: "TypeName",
|
2104
2118
|
# version_id: "TypeVersionId",
|
2105
2119
|
# })
|
@@ -2115,7 +2129,7 @@ module Aws::CloudFormation
|
|
2115
2129
|
|
2116
2130
|
# Retrieves your account's CloudFormation limits, such as the maximum
|
2117
2131
|
# number of stacks that you can create in your account. For more
|
2118
|
-
# information about account limits, see [CloudFormation
|
2132
|
+
# information about account limits, see [CloudFormation Quotas][1] in
|
2119
2133
|
# the *CloudFormation User Guide*.
|
2120
2134
|
#
|
2121
2135
|
#
|
@@ -2235,6 +2249,7 @@ module Aws::CloudFormation
|
|
2235
2249
|
# resp.tags[0].value #=> String
|
2236
2250
|
# resp.changes #=> Array
|
2237
2251
|
# resp.changes[0].type #=> String, one of "Resource"
|
2252
|
+
# resp.changes[0].hook_invocation_count #=> Integer
|
2238
2253
|
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
2239
2254
|
# resp.changes[0].resource_change.logical_resource_id #=> String
|
2240
2255
|
# resp.changes[0].resource_change.physical_resource_id #=> String
|
@@ -2271,9 +2286,76 @@ module Aws::CloudFormation
|
|
2271
2286
|
req.send_request(options)
|
2272
2287
|
end
|
2273
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
|
+
|
2274
2356
|
# Returns information about a CloudFormation extension publisher.
|
2275
2357
|
#
|
2276
|
-
# If you
|
2358
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2277
2359
|
# extension publisher, `DescribePublisher` returns information about
|
2278
2360
|
# your own publisher account.
|
2279
2361
|
#
|
@@ -2292,7 +2374,7 @@ module Aws::CloudFormation
|
|
2292
2374
|
# @option params [String] :publisher_id
|
2293
2375
|
# The ID of the extension publisher.
|
2294
2376
|
#
|
2295
|
-
# If you
|
2377
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2296
2378
|
# extension publisher, `DescribePublisher` returns information about
|
2297
2379
|
# your own publisher account.
|
2298
2380
|
#
|
@@ -2402,8 +2484,8 @@ module Aws::CloudFormation
|
|
2402
2484
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
|
2403
2485
|
#
|
2404
2486
|
# @option params [String] :stack_name
|
2405
|
-
# The name or the unique stack ID that
|
2406
|
-
# which
|
2487
|
+
# The name or the unique stack ID that's associated with the stack,
|
2488
|
+
# which aren't always interchangeable:
|
2407
2489
|
#
|
2408
2490
|
# * Running stacks: You can specify either the stack's name or its
|
2409
2491
|
# unique stack ID.
|
@@ -2444,6 +2526,11 @@ module Aws::CloudFormation
|
|
2444
2526
|
# resp.stack_events[0].resource_status_reason #=> String
|
2445
2527
|
# resp.stack_events[0].resource_properties #=> String
|
2446
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"
|
2447
2534
|
# resp.next_token #=> String
|
2448
2535
|
#
|
2449
2536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
|
@@ -2541,8 +2628,8 @@ module Aws::CloudFormation
|
|
2541
2628
|
# for up to 90 days after the stack has been deleted.
|
2542
2629
|
#
|
2543
2630
|
# @option params [required, String] :stack_name
|
2544
|
-
# The name or the unique stack ID that
|
2545
|
-
# which
|
2631
|
+
# The name or the unique stack ID that's associated with the stack,
|
2632
|
+
# which aren't always interchangeable:
|
2546
2633
|
#
|
2547
2634
|
# * Running stacks: You can specify either the stack's name or its
|
2548
2635
|
# unique stack ID.
|
@@ -2600,8 +2687,8 @@ module Aws::CloudFormation
|
|
2600
2687
|
#
|
2601
2688
|
# For a given stack, there will be one `StackResourceDrift` for each
|
2602
2689
|
# stack resource that has been checked for drift. Resources that
|
2603
|
-
# haven't yet been checked for drift
|
2604
|
-
#
|
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
|
2605
2692
|
# included. For a list of resources that support drift detection, see
|
2606
2693
|
# [Resources that Support Drift Detection][1].
|
2607
2694
|
#
|
@@ -2626,10 +2713,10 @@ module Aws::CloudFormation
|
|
2626
2713
|
# * `MODIFIED`\: One or more resource properties differ from their
|
2627
2714
|
# expected template values.
|
2628
2715
|
#
|
2629
|
-
# * `IN_SYNC`\: The
|
2716
|
+
# * `IN_SYNC`\: The resource's actual configuration matches its
|
2630
2717
|
# expected template configuration.
|
2631
2718
|
#
|
2632
|
-
# * `NOT_CHECKED`\: CloudFormation
|
2719
|
+
# * `NOT_CHECKED`\: CloudFormation doesn't currently return this value.
|
2633
2720
|
#
|
2634
2721
|
# @option params [String] :next_token
|
2635
2722
|
# A string that identifies the next page of stack resource drift
|
@@ -2720,7 +2807,7 @@ module Aws::CloudFormation
|
|
2720
2807
|
#
|
2721
2808
|
# @option params [String] :stack_name
|
2722
2809
|
# The name or the unique stack ID that is associated with the stack,
|
2723
|
-
# which
|
2810
|
+
# which aren't always interchangeable:
|
2724
2811
|
#
|
2725
2812
|
# * Running stacks: You can specify either the stack's name or its
|
2726
2813
|
# unique stack ID.
|
@@ -2729,7 +2816,7 @@ module Aws::CloudFormation
|
|
2729
2816
|
#
|
2730
2817
|
# Default: There is no default value.
|
2731
2818
|
#
|
2732
|
-
# Required: Conditional. If you
|
2819
|
+
# Required: Conditional. If you don't specify `StackName`, you must
|
2733
2820
|
# specify `PhysicalResourceId`.
|
2734
2821
|
#
|
2735
2822
|
# @option params [String] :logical_resource_id
|
@@ -2746,7 +2833,7 @@ module Aws::CloudFormation
|
|
2746
2833
|
# EC2 `InstanceId` to `DescribeStackResources` to find which stack the
|
2747
2834
|
# instance belongs to and what other resources are part of the stack.
|
2748
2835
|
#
|
2749
|
-
# Required: Conditional. If you
|
2836
|
+
# Required: Conditional. If you don't specify `PhysicalResourceId`, you
|
2750
2837
|
# must specify `StackName`.
|
2751
2838
|
#
|
2752
2839
|
# Default: There is no default value.
|
@@ -2958,13 +3045,13 @@ module Aws::CloudFormation
|
|
2958
3045
|
# Returns the description for the specified stack; if no stack name was
|
2959
3046
|
# specified, then it returns the description for all the stacks created.
|
2960
3047
|
#
|
2961
|
-
# <note markdown="1"> If the stack
|
3048
|
+
# <note markdown="1"> If the stack doesn't exist, an `ValidationError` is returned.
|
2962
3049
|
#
|
2963
3050
|
# </note>
|
2964
3051
|
#
|
2965
3052
|
# @option params [String] :stack_name
|
2966
|
-
# The name or the unique stack ID that
|
2967
|
-
# which
|
3053
|
+
# The name or the unique stack ID that's associated with the stack,
|
3054
|
+
# which aren't always interchangeable:
|
2968
3055
|
#
|
2969
3056
|
# * Running stacks: You can specify either the stack's name or its
|
2970
3057
|
# unique stack ID.
|
@@ -3125,7 +3212,7 @@ module Aws::CloudFormation
|
|
3125
3212
|
# @example Request syntax with placeholder values
|
3126
3213
|
#
|
3127
3214
|
# resp = client.describe_type({
|
3128
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3215
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
3129
3216
|
# type_name: "TypeName",
|
3130
3217
|
# arn: "TypeArn",
|
3131
3218
|
# version_id: "TypeVersionId",
|
@@ -3136,7 +3223,7 @@ module Aws::CloudFormation
|
|
3136
3223
|
# @example Response structure
|
3137
3224
|
#
|
3138
3225
|
# resp.arn #=> String
|
3139
|
-
# resp.type #=> String, one of "RESOURCE", "MODULE"
|
3226
|
+
# resp.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
3140
3227
|
# resp.type_name #=> String
|
3141
3228
|
# resp.default_version_id #=> String
|
3142
3229
|
# resp.is_default_version #=> Boolean
|
@@ -3253,7 +3340,7 @@ module Aws::CloudFormation
|
|
3253
3340
|
# completed, use DescribeStackResourceDrifts to return drift information
|
3254
3341
|
# about the stack and its resources.
|
3255
3342
|
#
|
3256
|
-
# When detecting drift on a stack, CloudFormation
|
3343
|
+
# When detecting drift on a stack, CloudFormation doesn't detect drift
|
3257
3344
|
# on any nested stacks belonging to that stack. Perform
|
3258
3345
|
# `DetectStackDrift` directly on the nested stack itself.
|
3259
3346
|
#
|
@@ -3306,7 +3393,7 @@ module Aws::CloudFormation
|
|
3306
3393
|
# resources, or DetectStackDrift to detect drift on all resources in a
|
3307
3394
|
# given stack that support drift detection.
|
3308
3395
|
#
|
3309
|
-
# Resources that
|
3396
|
+
# Resources that don't currently support drift detection can't be
|
3310
3397
|
# checked. For a list of resources that support drift detection, see
|
3311
3398
|
# [Resources that Support Drift Detection][2].
|
3312
3399
|
#
|
@@ -3366,15 +3453,15 @@ module Aws::CloudFormation
|
|
3366
3453
|
# Detect drift on a stack set. When CloudFormation performs drift
|
3367
3454
|
# detection on a stack set, it performs drift detection on the stack
|
3368
3455
|
# associated with each stack instance in the stack set. For more
|
3369
|
-
# information, see [How CloudFormation
|
3370
|
-
#
|
3456
|
+
# information, see [How CloudFormation performs drift detection on a
|
3457
|
+
# stack set][1].
|
3371
3458
|
#
|
3372
3459
|
# `DetectStackSetDrift` returns the `OperationId` of the stack set drift
|
3373
3460
|
# detection operation. Use this operation id with `
|
3374
3461
|
# DescribeStackSetOperation ` to monitor the progress of the drift
|
3375
3462
|
# detection operation. The drift detection operation may take some time,
|
3376
3463
|
# depending on the number of stack instances included in the stack set,
|
3377
|
-
#
|
3464
|
+
# in addition to the number of resources included in each stack.
|
3378
3465
|
#
|
3379
3466
|
# Once the operation has completed, use the following actions to return
|
3380
3467
|
# drift information:
|
@@ -3382,7 +3469,7 @@ module Aws::CloudFormation
|
|
3382
3469
|
# * Use ` DescribeStackSet ` to return detailed information about the
|
3383
3470
|
# stack set, including detailed information about the last *completed*
|
3384
3471
|
# drift operation performed on the stack set. (Information about drift
|
3385
|
-
# operations that are in progress
|
3472
|
+
# operations that are in progress isn't included.)
|
3386
3473
|
#
|
3387
3474
|
# * Use ` ListStackInstances ` to return a list of stack instances
|
3388
3475
|
# belonging to the stack set, including the drift status and last
|
@@ -3393,7 +3480,7 @@ module Aws::CloudFormation
|
|
3393
3480
|
# time checked.
|
3394
3481
|
#
|
3395
3482
|
# For more information on performing a drift detection operation on a
|
3396
|
-
# stack set, see [Detecting
|
3483
|
+
# stack set, see [Detecting unmanaged changes in stack sets][1].
|
3397
3484
|
#
|
3398
3485
|
# You can only run a single drift detection operation on a given stack
|
3399
3486
|
# set at one time.
|
@@ -3499,7 +3586,7 @@ module Aws::CloudFormation
|
|
3499
3586
|
#
|
3500
3587
|
# @option params [String] :template_url
|
3501
3588
|
# Location of file containing the template body. The URL must point to a
|
3502
|
-
# template that
|
3589
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
3503
3590
|
# document. For more information, go to [Template Anatomy][1] in the
|
3504
3591
|
# CloudFormation User Guide.
|
3505
3592
|
#
|
@@ -3558,16 +3645,17 @@ module Aws::CloudFormation
|
|
3558
3645
|
# enforces the policy during the update. You can't specify a temporary
|
3559
3646
|
# stack policy that overrides the current policy.
|
3560
3647
|
#
|
3561
|
-
# To create a change set for the entire stack
|
3648
|
+
# To create a change set for the entire stack hierarchy,
|
3562
3649
|
# `IncludeNestedStacks` must have been set to `True`.
|
3563
3650
|
#
|
3564
3651
|
# @option params [required, String] :change_set_name
|
3565
|
-
# The name or ARN of the change set that you want
|
3566
|
-
# specified stack.
|
3652
|
+
# The name or Amazon Resource Name (ARN) of the change set that you want
|
3653
|
+
# use to update the specified stack.
|
3567
3654
|
#
|
3568
3655
|
# @option params [String] :stack_name
|
3569
3656
|
# If you specified the name of a change set, specify the stack name or
|
3570
|
-
#
|
3657
|
+
# Amazon Resource Name (ARN) that's associated with the change set you
|
3658
|
+
# want to execute.
|
3571
3659
|
#
|
3572
3660
|
# @option params [String] :client_request_token
|
3573
3661
|
# A unique identifier for this `ExecuteChangeSet` request. Specify this
|
@@ -3606,7 +3694,7 @@ module Aws::CloudFormation
|
|
3606
3694
|
# have a policy, a null value is returned.
|
3607
3695
|
#
|
3608
3696
|
# @option params [required, String] :stack_name
|
3609
|
-
# The name or unique stack ID that
|
3697
|
+
# The name or unique stack ID that's associated with the stack whose
|
3610
3698
|
# policy you want to get.
|
3611
3699
|
#
|
3612
3700
|
# @return [Types::GetStackPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3635,16 +3723,16 @@ module Aws::CloudFormation
|
|
3635
3723
|
# Returns the template body for a specified stack. You can get the
|
3636
3724
|
# template for running or deleted stacks.
|
3637
3725
|
#
|
3638
|
-
# For deleted stacks, GetTemplate returns the template for up to 90
|
3639
|
-
# 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.
|
3640
3728
|
#
|
3641
|
-
# <note markdown="1"> If the template
|
3729
|
+
# <note markdown="1"> If the template doesn't exist, a `ValidationError` is returned.
|
3642
3730
|
#
|
3643
3731
|
# </note>
|
3644
3732
|
#
|
3645
3733
|
# @option params [String] :stack_name
|
3646
|
-
# The name or the unique stack ID that
|
3647
|
-
# which
|
3734
|
+
# The name or the unique stack ID that's associated with the stack,
|
3735
|
+
# which aren't always interchangeable:
|
3648
3736
|
#
|
3649
3737
|
# * Running stacks: You can specify either the stack's name or its
|
3650
3738
|
# unique stack ID.
|
@@ -3707,12 +3795,12 @@ module Aws::CloudFormation
|
|
3707
3795
|
#
|
3708
3796
|
# For deleted stacks, `GetTemplateSummary` returns the template
|
3709
3797
|
# information for up to 90 days after the stack has been deleted. If the
|
3710
|
-
# template
|
3798
|
+
# template doesn't exist, a `ValidationError` is returned.
|
3711
3799
|
#
|
3712
3800
|
# @option params [String] :template_body
|
3713
3801
|
# Structure containing the template body with a minimum length of 1 byte
|
3714
3802
|
# and a maximum length of 51,200 bytes. For more information about
|
3715
|
-
# templates, see [Template
|
3803
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3716
3804
|
#
|
3717
3805
|
# Conditional: You must specify only one of the following parameters:
|
3718
3806
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3723,9 +3811,9 @@ module Aws::CloudFormation
|
|
3723
3811
|
#
|
3724
3812
|
# @option params [String] :template_url
|
3725
3813
|
# Location of file containing the template body. The URL must point to a
|
3726
|
-
# template (max size: 460,800 bytes) that
|
3814
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
3727
3815
|
# bucket or a Systems Manager document. For more information about
|
3728
|
-
# templates, see [Template
|
3816
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3729
3817
|
#
|
3730
3818
|
# Conditional: You must specify only one of the following parameters:
|
3731
3819
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3735,10 +3823,10 @@ module Aws::CloudFormation
|
|
3735
3823
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
3736
3824
|
#
|
3737
3825
|
# @option params [String] :stack_name
|
3738
|
-
# The name or the stack ID that
|
3739
|
-
#
|
3740
|
-
# the stack's name or its unique stack ID. For deleted stack,
|
3741
|
-
# 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.
|
3742
3830
|
#
|
3743
3831
|
# Conditional: You must specify only one of the following parameters:
|
3744
3832
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3830,14 +3918,16 @@ module Aws::CloudFormation
|
|
3830
3918
|
req.send_request(options)
|
3831
3919
|
end
|
3832
3920
|
|
3833
|
-
#
|
3834
|
-
#
|
3835
|
-
#
|
3836
|
-
# and
|
3837
|
-
# import
|
3838
|
-
#
|
3839
|
-
#
|
3840
|
-
#
|
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>
|
3841
3931
|
#
|
3842
3932
|
# @option params [required, String] :stack_set_name
|
3843
3933
|
# The name of the stack set. The name must be unique in the Region where
|
@@ -3855,7 +3945,7 @@ module Aws::CloudFormation
|
|
3855
3945
|
# Specify either `StackIds` or `StackIdsUrl`.
|
3856
3946
|
#
|
3857
3947
|
# @option params [Array<String>] :organizational_unit_ids
|
3858
|
-
# The list of OU ID
|
3948
|
+
# The list of OU ID's to which the stacks being imported has to be
|
3859
3949
|
# mapped as deployment target.
|
3860
3950
|
#
|
3861
3951
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
@@ -3976,8 +4066,8 @@ module Aws::CloudFormation
|
|
3976
4066
|
# values that you can import into other stacks. To import values, use
|
3977
4067
|
# the [ `Fn::ImportValue` ][1] function.
|
3978
4068
|
#
|
3979
|
-
# For more information, see [ CloudFormation
|
3980
|
-
#
|
4069
|
+
# For more information, see [ CloudFormation export stack output
|
4070
|
+
# values][2].
|
3981
4071
|
#
|
3982
4072
|
#
|
3983
4073
|
#
|
@@ -4178,7 +4268,7 @@ module Aws::CloudFormation
|
|
4178
4268
|
#
|
4179
4269
|
# @option params [required, String] :stack_name
|
4180
4270
|
# The name or the unique stack ID that is associated with the stack,
|
4181
|
-
# which
|
4271
|
+
# which aren't always interchangeable:
|
4182
4272
|
#
|
4183
4273
|
# * Running stacks: You can specify either the stack's name or its
|
4184
4274
|
# unique stack ID.
|
@@ -4410,7 +4500,7 @@ module Aws::CloudFormation
|
|
4410
4500
|
# permissions in the management account.
|
4411
4501
|
#
|
4412
4502
|
# @option params [String] :next_token
|
4413
|
-
# If the previous paginated request didn't return all
|
4503
|
+
# If the previous paginated request didn't return all the remaining
|
4414
4504
|
# results, the response object's `NextToken` parameter value is set to
|
4415
4505
|
# a token. To retrieve the next set of results, call `ListStackSets`
|
4416
4506
|
# again and assign that token to the request object's `NextToken`
|
@@ -4575,7 +4665,7 @@ module Aws::CloudFormation
|
|
4575
4665
|
# request parameter to get the next set of results.
|
4576
4666
|
#
|
4577
4667
|
# @option params [String] :next_token
|
4578
|
-
# If the previous paginated request didn't return all
|
4668
|
+
# If the previous paginated request didn't return all the remaining
|
4579
4669
|
# results, the response object's `NextToken` parameter value is set to
|
4580
4670
|
# a token. To retrieve the next set of results, call this action again
|
4581
4671
|
# and assign that token to the request object's `NextToken` parameter.
|
@@ -4592,7 +4682,7 @@ module Aws::CloudFormation
|
|
4592
4682
|
# @example Request syntax with placeholder values
|
4593
4683
|
#
|
4594
4684
|
# resp = client.list_type_registrations({
|
4595
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4685
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4596
4686
|
# type_name: "TypeName",
|
4597
4687
|
# type_arn: "TypeArn",
|
4598
4688
|
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
|
@@ -4666,7 +4756,7 @@ module Aws::CloudFormation
|
|
4666
4756
|
# @option params [String] :publisher_id
|
4667
4757
|
# The publisher ID of the extension publisher.
|
4668
4758
|
#
|
4669
|
-
# Extensions published by Amazon
|
4759
|
+
# Extensions published by Amazon aren't assigned a publisher ID.
|
4670
4760
|
#
|
4671
4761
|
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4672
4762
|
#
|
@@ -4678,7 +4768,7 @@ module Aws::CloudFormation
|
|
4678
4768
|
# @example Request syntax with placeholder values
|
4679
4769
|
#
|
4680
4770
|
# resp = client.list_type_versions({
|
4681
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4771
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4682
4772
|
# type_name: "TypeName",
|
4683
4773
|
# arn: "TypeArn",
|
4684
4774
|
# max_results: 1,
|
@@ -4690,7 +4780,7 @@ module Aws::CloudFormation
|
|
4690
4780
|
# @example Response structure
|
4691
4781
|
#
|
4692
4782
|
# resp.type_version_summaries #=> Array
|
4693
|
-
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4783
|
+
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4694
4784
|
# resp.type_version_summaries[0].type_name #=> String
|
4695
4785
|
# resp.type_version_summaries[0].version_id #=> String
|
4696
4786
|
# resp.type_version_summaries[0].is_default_version #=> Boolean
|
@@ -4743,12 +4833,12 @@ module Aws::CloudFormation
|
|
4743
4833
|
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
4744
4834
|
# process updates to the type during stack update operations.
|
4745
4835
|
#
|
4746
|
-
# * `IMMUTABLE`\: The resource type
|
4747
|
-
# 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
|
4748
4838
|
# stack update operations.
|
4749
4839
|
#
|
4750
|
-
# * `NON_PROVISIONABLE`\: The resource type
|
4751
|
-
# 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
|
4752
4842
|
# provisioned.
|
4753
4843
|
#
|
4754
4844
|
# The default is `FULLY_MUTABLE`.
|
@@ -4803,7 +4893,7 @@ module Aws::CloudFormation
|
|
4803
4893
|
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
4804
4894
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
4805
4895
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4806
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4896
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4807
4897
|
# filters: {
|
4808
4898
|
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
4809
4899
|
# publisher_id: "PublisherId",
|
@@ -4816,7 +4906,7 @@ module Aws::CloudFormation
|
|
4816
4906
|
# @example Response structure
|
4817
4907
|
#
|
4818
4908
|
# resp.type_summaries #=> Array
|
4819
|
-
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4909
|
+
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4820
4910
|
# resp.type_summaries[0].type_name #=> String
|
4821
4911
|
# resp.type_summaries[0].default_version_id #=> String
|
4822
4912
|
# resp.type_summaries[0].type_arn #=> String
|
@@ -4879,7 +4969,7 @@ module Aws::CloudFormation
|
|
4879
4969
|
#
|
4880
4970
|
# For more information, see [Semantic Versioning 2.0.0][1].
|
4881
4971
|
#
|
4882
|
-
# If you
|
4972
|
+
# If you don't specify a version number, CloudFormation increments the
|
4883
4973
|
# version number by one minor version release.
|
4884
4974
|
#
|
4885
4975
|
# You cannot specify a version number the first time you publish a type.
|
@@ -4897,7 +4987,7 @@ module Aws::CloudFormation
|
|
4897
4987
|
# @example Request syntax with placeholder values
|
4898
4988
|
#
|
4899
4989
|
# resp = client.publish_type({
|
4900
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4990
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4901
4991
|
# arn: "PrivateTypeArn",
|
4902
4992
|
# type_name: "TypeName",
|
4903
4993
|
# public_version_number: "PublicVersionNumber",
|
@@ -4918,7 +5008,7 @@ module Aws::CloudFormation
|
|
4918
5008
|
|
4919
5009
|
# Reports progress of a resource handler to CloudFormation.
|
4920
5010
|
#
|
4921
|
-
# Reserved for use by the [CloudFormation CLI][1].
|
5011
|
+
# Reserved for use by the [CloudFormation CLI][1]. Don't use this API
|
4922
5012
|
# in your code.
|
4923
5013
|
#
|
4924
5014
|
#
|
@@ -4983,7 +5073,7 @@ module Aws::CloudFormation
|
|
4983
5073
|
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4984
5074
|
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4985
5075
|
# status_message: "StatusMessage",
|
4986
|
-
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration
|
5076
|
+
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration, HandlerInternalFailure, NonCompliant, Unknown
|
4987
5077
|
# resource_model: "ResourceModel",
|
4988
5078
|
# client_request_token: "ClientRequestToken",
|
4989
5079
|
# })
|
@@ -5064,15 +5154,15 @@ module Aws::CloudFormation
|
|
5064
5154
|
# extension makes it available for use in CloudFormation templates in
|
5065
5155
|
# your Amazon Web Services account, and includes:
|
5066
5156
|
#
|
5067
|
-
# * Validating the extension schema
|
5157
|
+
# * Validating the extension schema.
|
5068
5158
|
#
|
5069
5159
|
# * Determining which handlers, if any, have been specified for the
|
5070
|
-
# extension
|
5160
|
+
# extension.
|
5071
5161
|
#
|
5072
|
-
# * Making the extension available for use in your account
|
5162
|
+
# * Making the extension available for use in your account.
|
5073
5163
|
#
|
5074
5164
|
# For more information on how to develop extensions and ready them for
|
5075
|
-
#
|
5165
|
+
# registration, see [Creating Resource Providers][1] in the
|
5076
5166
|
# *CloudFormation CLI User Guide*.
|
5077
5167
|
#
|
5078
5168
|
# You can have a maximum of 50 resource extension versions registered at
|
@@ -5110,7 +5200,7 @@ module Aws::CloudFormation
|
|
5110
5200
|
# * For modules,
|
5111
5201
|
# *company\_or\_organization*\::*service*\::*type*\::MODULE.
|
5112
5202
|
#
|
5113
|
-
# <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
|
5114
5204
|
# in your extension names:
|
5115
5205
|
#
|
5116
5206
|
# * `Alexa`
|
@@ -5128,15 +5218,15 @@ module Aws::CloudFormation
|
|
5128
5218
|
# </note>
|
5129
5219
|
#
|
5130
5220
|
# @option params [required, String] :schema_handler_package
|
5131
|
-
# A
|
5132
|
-
# 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.
|
5133
5223
|
#
|
5134
5224
|
# For information on generating a schema handler package for the
|
5135
5225
|
# extension you want to register, see [submit][1] in the *CloudFormation
|
5136
5226
|
# CLI User Guide*.
|
5137
5227
|
#
|
5138
5228
|
# <note markdown="1"> The user registering the extension must be able to access the package
|
5139
|
-
# in the S3 bucket. That
|
5229
|
+
# in the S3 bucket. That's, the user needs to have [GetObject][2]
|
5140
5230
|
# permissions for the schema handler package. For more information, see
|
5141
5231
|
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
5142
5232
|
# *Identity and Access Management User Guide*.
|
@@ -5178,7 +5268,7 @@ module Aws::CloudFormation
|
|
5178
5268
|
# A unique identifier that acts as an idempotency key for this
|
5179
5269
|
# registration request. Specifying a client request token prevents
|
5180
5270
|
# CloudFormation from generating more than one version of an extension
|
5181
|
-
# from the same
|
5271
|
+
# from the same registration request, even if the request is submitted
|
5182
5272
|
# multiple times.
|
5183
5273
|
#
|
5184
5274
|
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5188,7 +5278,7 @@ module Aws::CloudFormation
|
|
5188
5278
|
# @example Request syntax with placeholder values
|
5189
5279
|
#
|
5190
5280
|
# resp = client.register_type({
|
5191
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5281
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5192
5282
|
# type_name: "TypeName", # required
|
5193
5283
|
# schema_handler_package: "S3Url", # required
|
5194
5284
|
# logging_config: {
|
@@ -5214,7 +5304,7 @@ module Aws::CloudFormation
|
|
5214
5304
|
|
5215
5305
|
# When specifying `RollbackStack`, you preserve the state of previously
|
5216
5306
|
# provisioned resources when an operation fails. You can check the
|
5217
|
-
# status of the stack through the DescribeStacks
|
5307
|
+
# status of the stack through the DescribeStacks operation.
|
5218
5308
|
#
|
5219
5309
|
# Rolls back the specified stack to the last known stable state from
|
5220
5310
|
# `CREATE_FAILED` or `UPDATE_FAILED` stack statuses.
|
@@ -5234,7 +5324,7 @@ module Aws::CloudFormation
|
|
5234
5324
|
# * `IMPORT_ROLLBACK_COMPLETE`
|
5235
5325
|
#
|
5236
5326
|
# @option params [required, String] :stack_name
|
5237
|
-
# The name that
|
5327
|
+
# The name that's associated with the stack.
|
5238
5328
|
#
|
5239
5329
|
# @option params [String] :role_arn
|
5240
5330
|
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
@@ -5275,7 +5365,7 @@ module Aws::CloudFormation
|
|
5275
5365
|
#
|
5276
5366
|
# @option params [String] :stack_policy_body
|
5277
5367
|
# Structure containing the stack policy body. For more information, go
|
5278
|
-
# to [ Prevent
|
5368
|
+
# to [ Prevent updates to stack resources][1] in the CloudFormation User
|
5279
5369
|
# Guide. You can specify either the `StackPolicyBody` or the
|
5280
5370
|
# `StackPolicyURL` parameter, but not both.
|
5281
5371
|
#
|
@@ -5285,9 +5375,9 @@ module Aws::CloudFormation
|
|
5285
5375
|
#
|
5286
5376
|
# @option params [String] :stack_policy_url
|
5287
5377
|
# Location of a file containing the stack policy. The URL must point to
|
5288
|
-
# a policy (maximum size: 16 KB) located in an S3 bucket in the
|
5289
|
-
# Region as the stack. You can specify either
|
5290
|
-
# 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.
|
5291
5381
|
#
|
5292
5382
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5293
5383
|
#
|
@@ -5317,7 +5407,7 @@ module Aws::CloudFormation
|
|
5317
5407
|
# For more information, see [Configuring extensions at the account
|
5318
5408
|
# level][1] in the *CloudFormation User Guide*.
|
5319
5409
|
#
|
5320
|
-
# It
|
5410
|
+
# It's strongly recommended that you use dynamic references to restrict
|
5321
5411
|
# sensitive configuration definitions, such as third-party credentials.
|
5322
5412
|
# For more details on dynamic references, see [Using dynamic references
|
5323
5413
|
# to specify template values][2] in the *CloudFormation User Guide*.
|
@@ -5387,7 +5477,7 @@ module Aws::CloudFormation
|
|
5387
5477
|
# configuration: "TypeConfiguration", # required
|
5388
5478
|
# configuration_alias: "TypeConfigurationAlias",
|
5389
5479
|
# type_name: "TypeName",
|
5390
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5480
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5391
5481
|
# })
|
5392
5482
|
#
|
5393
5483
|
# @example Response structure
|
@@ -5433,7 +5523,7 @@ module Aws::CloudFormation
|
|
5433
5523
|
#
|
5434
5524
|
# resp = client.set_type_default_version({
|
5435
5525
|
# arn: "PrivateTypeArn",
|
5436
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5526
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5437
5527
|
# type_name: "TypeName",
|
5438
5528
|
# version_id: "TypeVersionId",
|
5439
5529
|
# })
|
@@ -5448,12 +5538,12 @@ module Aws::CloudFormation
|
|
5448
5538
|
end
|
5449
5539
|
|
5450
5540
|
# Sends a signal to the specified resource with a success or failure
|
5451
|
-
# status. You can use the SignalResource
|
5452
|
-
# creation policy or update policy. CloudFormation doesn't proceed
|
5453
|
-
# a stack creation or update until resources receive the required
|
5454
|
-
# of signals or the timeout period is exceeded. The
|
5455
|
-
# is useful in cases where you want to send
|
5456
|
-
# 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.
|
5457
5547
|
#
|
5458
5548
|
# @option params [required, String] :stack_name
|
5459
5549
|
# The stack name or unique stack ID that includes the resource that you
|
@@ -5496,7 +5586,8 @@ module Aws::CloudFormation
|
|
5496
5586
|
end
|
5497
5587
|
|
5498
5588
|
# Stops an in-progress operation on a stack set and its associated stack
|
5499
|
-
# instances.
|
5589
|
+
# instances. StackSets will cancel all the unstarted stack instance
|
5590
|
+
# deployments and wait for those are in-progress to complete.
|
5500
5591
|
#
|
5501
5592
|
# @option params [required, String] :stack_set_name
|
5502
5593
|
# The name or unique ID of the stack set that you want to stop the
|
@@ -5558,7 +5649,7 @@ module Aws::CloudFormation
|
|
5558
5649
|
# For more information, see [Testing your public extension prior to
|
5559
5650
|
# publishing][1] in the *CloudFormation CLI User Guide*.
|
5560
5651
|
#
|
5561
|
-
# If you
|
5652
|
+
# If you don't specify a version, CloudFormation uses the default
|
5562
5653
|
# version of the extension in your account and region for testing.
|
5563
5654
|
#
|
5564
5655
|
# To perform testing, CloudFormation assumes the execution role
|
@@ -5581,7 +5672,7 @@ module Aws::CloudFormation
|
|
5581
5672
|
# [3]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
|
5582
5673
|
#
|
5583
5674
|
# @option params [String] :arn
|
5584
|
-
# The Amazon Resource
|
5675
|
+
# The Amazon Resource Name (ARN) of the extension.
|
5585
5676
|
#
|
5586
5677
|
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5587
5678
|
#
|
@@ -5601,7 +5692,7 @@ module Aws::CloudFormation
|
|
5601
5692
|
# You can specify the version id with either `Arn`, or with `TypeName`
|
5602
5693
|
# and `Type`.
|
5603
5694
|
#
|
5604
|
-
# If you
|
5695
|
+
# If you don't specify a version, CloudFormation uses the default
|
5605
5696
|
# version of the extension in this account and region for testing.
|
5606
5697
|
#
|
5607
5698
|
# @option params [String] :log_delivery_bucket
|
@@ -5616,9 +5707,9 @@ module Aws::CloudFormation
|
|
5616
5707
|
# specified S3 bucket. Specifically, the user needs the following
|
5617
5708
|
# permissions:
|
5618
5709
|
#
|
5619
|
-
# * GetObject
|
5710
|
+
# * `GetObject`
|
5620
5711
|
#
|
5621
|
-
# * PutObject
|
5712
|
+
# * `PutObject`
|
5622
5713
|
#
|
5623
5714
|
# For more information, see [Actions, Resources, and Condition Keys for
|
5624
5715
|
# Amazon S3][1] in the *Amazon Web Services Identity and Access
|
@@ -5636,7 +5727,7 @@ module Aws::CloudFormation
|
|
5636
5727
|
#
|
5637
5728
|
# resp = client.test_type({
|
5638
5729
|
# arn: "TypeArn",
|
5639
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5730
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5640
5731
|
# type_name: "TypeName",
|
5641
5732
|
# version_id: "TypeVersionId",
|
5642
5733
|
# log_delivery_bucket: "S3Bucket",
|
@@ -5657,7 +5748,7 @@ module Aws::CloudFormation
|
|
5657
5748
|
|
5658
5749
|
# Updates a stack as specified in the template. After the call completes
|
5659
5750
|
# successfully, the stack update starts. You can check the status of the
|
5660
|
-
# stack
|
5751
|
+
# stack through the DescribeStacks action.
|
5661
5752
|
#
|
5662
5753
|
# To get a copy of the template for an existing stack, you can use the
|
5663
5754
|
# GetTemplate action.
|
@@ -5688,7 +5779,7 @@ module Aws::CloudFormation
|
|
5688
5779
|
#
|
5689
5780
|
# @option params [String] :template_url
|
5690
5781
|
# Location of file containing the template body. The URL must point to a
|
5691
|
-
# template that
|
5782
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
5692
5783
|
# document. For more information, go to [Template Anatomy][1] in the
|
5693
5784
|
# CloudFormation User Guide.
|
5694
5785
|
#
|
@@ -5770,7 +5861,7 @@ module Aws::CloudFormation
|
|
5770
5861
|
#
|
5771
5862
|
# * [ AWS::IAM::Group][2]
|
5772
5863
|
#
|
5773
|
-
# * [
|
5864
|
+
# * [AWS::IAM::InstanceProfile][3]
|
5774
5865
|
#
|
5775
5866
|
# * [ AWS::IAM::Policy][4]
|
5776
5867
|
#
|
@@ -5778,7 +5869,7 @@ module Aws::CloudFormation
|
|
5778
5869
|
#
|
5779
5870
|
# * [ AWS::IAM::User][6]
|
5780
5871
|
#
|
5781
|
-
# * [
|
5872
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
5782
5873
|
#
|
5783
5874
|
# For more information, see [Acknowledging IAM Resources in
|
5784
5875
|
# CloudFormation Templates][8].
|
@@ -5848,7 +5939,7 @@ module Aws::CloudFormation
|
|
5848
5939
|
# (IAM) role that CloudFormation assumes to update the stack.
|
5849
5940
|
# CloudFormation uses the role's credentials to make calls on your
|
5850
5941
|
# behalf. CloudFormation always uses this role for all future operations
|
5851
|
-
# on the stack.
|
5942
|
+
# on the stack. Provided that users have permission to operate on the
|
5852
5943
|
# stack, CloudFormation uses this role even if the users don't have
|
5853
5944
|
# permission to pass it. Ensure that the role grants least privilege.
|
5854
5945
|
#
|
@@ -5867,7 +5958,7 @@ module Aws::CloudFormation
|
|
5867
5958
|
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
5868
5959
|
#
|
5869
5960
|
# You might update the stack policy, for example, in order to protect a
|
5870
|
-
# 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
|
5871
5962
|
# specify a stack policy, the current policy that is associated with the
|
5872
5963
|
# stack is unchanged.
|
5873
5964
|
#
|
@@ -5878,7 +5969,7 @@ module Aws::CloudFormation
|
|
5878
5969
|
# the `StackPolicyURL` parameter, but not both.
|
5879
5970
|
#
|
5880
5971
|
# You might update the stack policy, for example, in order to protect a
|
5881
|
-
# 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
|
5882
5973
|
# specify a stack policy, the current policy that is associated with the
|
5883
5974
|
# stack is unchanged.
|
5884
5975
|
#
|
@@ -5983,15 +6074,15 @@ module Aws::CloudFormation
|
|
5983
6074
|
end
|
5984
6075
|
|
5985
6076
|
# Updates the parameter values for stack instances for the specified
|
5986
|
-
# accounts, within the specified Regions. A stack
|
5987
|
-
# 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.
|
5988
6079
|
#
|
5989
|
-
# You can only update stack instances in
|
5990
|
-
# already exist; to create additional stack
|
5991
|
-
# [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].
|
5992
6083
|
#
|
5993
6084
|
# During stack set updates, any parameters overridden for a stack
|
5994
|
-
# instance
|
6085
|
+
# instance aren't updated, but retain their overridden value.
|
5995
6086
|
#
|
5996
6087
|
# You can only update the parameter *values* that are specified in the
|
5997
6088
|
# stack set; to add or delete a parameter itself, use
|
@@ -6016,7 +6107,8 @@ module Aws::CloudFormation
|
|
6016
6107
|
# \[Self-managed permissions\] The names of one or more Amazon Web
|
6017
6108
|
# Services accounts for which you want to update parameter values for
|
6018
6109
|
# stack instances. The overridden parameter values will be applied to
|
6019
|
-
# all stack instances in the specified accounts and
|
6110
|
+
# all stack instances in the specified accounts and Amazon Web Services
|
6111
|
+
# Regions.
|
6020
6112
|
#
|
6021
6113
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6022
6114
|
#
|
@@ -6031,35 +6123,36 @@ module Aws::CloudFormation
|
|
6031
6123
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6032
6124
|
#
|
6033
6125
|
# @option params [required, Array<String>] :regions
|
6034
|
-
# The names of one or more Regions in which you want
|
6035
|
-
# values for stack instances. The overridden
|
6036
|
-
# 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.
|
6037
6130
|
#
|
6038
6131
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
6039
6132
|
# A list of input parameters whose values you want to update for the
|
6040
6133
|
# specified stack instances.
|
6041
6134
|
#
|
6042
6135
|
# Any overridden parameter values will be applied to all stack instances
|
6043
|
-
# in the specified accounts and Regions. When
|
6044
|
-
# their values, be aware of how CloudFormation
|
6045
|
-
# 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:
|
6046
6139
|
#
|
6047
6140
|
# * To override the current value for a parameter, include the parameter
|
6048
6141
|
# and specify its value.
|
6049
6142
|
#
|
6050
6143
|
# * To leave an overridden parameter set to its present value, include
|
6051
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
6144
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
6052
6145
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
6053
6146
|
#
|
6054
6147
|
# * To set an overridden parameter back to the value specified in the
|
6055
|
-
# stack set, specify a parameter list but
|
6148
|
+
# stack set, specify a parameter list but don't include the parameter
|
6056
6149
|
# in the list.
|
6057
6150
|
#
|
6058
|
-
# * To leave all parameters set to their present values,
|
6151
|
+
# * To leave all parameters set to their present values, don't specify
|
6059
6152
|
# this property at all.
|
6060
6153
|
#
|
6061
6154
|
# During stack set updates, any parameter values overridden for a stack
|
6062
|
-
# instance
|
6155
|
+
# instance aren't updated, but retain their overridden value.
|
6063
6156
|
#
|
6064
6157
|
# You can only override the parameter *values* that are specified in the
|
6065
6158
|
# stack set; to add or delete a parameter itself, use `UpdateStackSet`
|
@@ -6164,7 +6257,7 @@ module Aws::CloudFormation
|
|
6164
6257
|
end
|
6165
6258
|
|
6166
6259
|
# Updates the stack set, and associated stack instances in the specified
|
6167
|
-
# accounts and Regions.
|
6260
|
+
# accounts and Amazon Web Services Regions.
|
6168
6261
|
#
|
6169
6262
|
# Even if the stack set operation created by updating the stack set
|
6170
6263
|
# fails (completely or partially, below or above a specified failure
|
@@ -6305,7 +6398,7 @@ module Aws::CloudFormation
|
|
6305
6398
|
#
|
6306
6399
|
# * If you specify *any* tags using this parameter, you must specify
|
6307
6400
|
# *all* the tags that you want associated with this stack set, even
|
6308
|
-
# tags you've
|
6401
|
+
# tags you've specified before (for example, when creating the stack
|
6309
6402
|
# set or during a previous update of the stack set.). Any tags that
|
6310
6403
|
# you don't include in the updated list of tags are removed from the
|
6311
6404
|
# stack set, and therefore from the stacks and resources as well.
|
@@ -6371,10 +6464,10 @@ module Aws::CloudFormation
|
|
6371
6464
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
6372
6465
|
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
6373
6466
|
# prior to updating the stack instances in the specified accounts and
|
6374
|
-
# Regions. If the stack set update
|
6375
|
-
# template or parameters, CloudFormation updates the
|
6376
|
-
# the specified accounts and Regions, while leaving
|
6377
|
-
# 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.
|
6378
6471
|
#
|
6379
6472
|
# @option params [String] :permission_model
|
6380
6473
|
# Describes how the IAM roles required for stack set operations are
|
@@ -6400,7 +6493,7 @@ module Aws::CloudFormation
|
|
6400
6493
|
# automatically deploys to Organizations accounts that are added to a
|
6401
6494
|
# target organization or organizational unit (OU).
|
6402
6495
|
#
|
6403
|
-
# If you specify `AutoDeployment`,
|
6496
|
+
# If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
|
6404
6497
|
# `Regions`.
|
6405
6498
|
#
|
6406
6499
|
# @option params [String] :operation_id
|
@@ -6424,25 +6517,26 @@ module Aws::CloudFormation
|
|
6424
6517
|
# @option params [Array<String>] :accounts
|
6425
6518
|
# \[Self-managed permissions\] The accounts in which to update
|
6426
6519
|
# associated stack instances. If you specify accounts, you must also
|
6427
|
-
# specify the Regions in which to update stack set
|
6520
|
+
# specify the Amazon Web Services Regions in which to update stack set
|
6521
|
+
# instances.
|
6428
6522
|
#
|
6429
|
-
# To update *all* the stack instances associated with this stack set,
|
6430
|
-
#
|
6523
|
+
# To update *all* the stack instances associated with this stack set,
|
6524
|
+
# don't specify the `Accounts` or `Regions` properties.
|
6431
6525
|
#
|
6432
6526
|
# If the stack set update includes changes to the template (that is, if
|
6433
6527
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
6434
6528
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
6435
6529
|
# status of `OUTDATED` prior to updating the stack instances in the
|
6436
|
-
# specified accounts and Regions. If the stack set
|
6437
|
-
# include changes to the template or parameters,
|
6438
|
-
# the stack instances in the specified accounts
|
6439
|
-
#
|
6440
|
-
# 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.
|
6441
6535
|
#
|
6442
6536
|
# @option params [Array<String>] :regions
|
6443
|
-
# The Regions in which to update associated stack
|
6444
|
-
# specify Regions, you must also specify accounts in
|
6445
|
-
# 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.
|
6446
6540
|
#
|
6447
6541
|
# To update *all* the stack instances associated with this stack set, do
|
6448
6542
|
# not specify the `Accounts` or `Regions` properties.
|
@@ -6559,7 +6653,7 @@ module Aws::CloudFormation
|
|
6559
6653
|
# User Guide*.
|
6560
6654
|
#
|
6561
6655
|
# For [nested stacks][2], termination protection is set on the root
|
6562
|
-
# stack and
|
6656
|
+
# stack and can't be changed directly on the nested stack.
|
6563
6657
|
#
|
6564
6658
|
#
|
6565
6659
|
#
|
@@ -6678,7 +6772,7 @@ module Aws::CloudFormation
|
|
6678
6772
|
params: params,
|
6679
6773
|
config: config)
|
6680
6774
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
6681
|
-
context[:gem_version] = '1.
|
6775
|
+
context[:gem_version] = '1.67.0'
|
6682
6776
|
Seahorse::Client::Request.new(handlers, context)
|
6683
6777
|
end
|
6684
6778
|
|