aws-sdk-cloudformation 1.65.0 → 1.68.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +317 -232
- 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,7 @@ 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/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::CloudFormation
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -440,7 +442,7 @@ module Aws::CloudFormation
|
|
440
442
|
# @example Request syntax with placeholder values
|
441
443
|
#
|
442
444
|
# resp = client.activate_type({
|
443
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
445
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
444
446
|
# public_type_arn: "ThirdPartyTypeArn",
|
445
447
|
# publisher_id: "PublisherId",
|
446
448
|
# type_name: "TypeName",
|
@@ -496,7 +498,7 @@ module Aws::CloudFormation
|
|
496
498
|
# type_arn: "TypeArn",
|
497
499
|
# type_configuration_alias: "TypeConfigurationAlias",
|
498
500
|
# type_configuration_arn: "TypeConfigurationArn",
|
499
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
501
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
500
502
|
# type_name: "TypeName",
|
501
503
|
# },
|
502
504
|
# ],
|
@@ -510,13 +512,13 @@ module Aws::CloudFormation
|
|
510
512
|
# resp.errors[0].type_configuration_identifier.type_arn #=> String
|
511
513
|
# resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
|
512
514
|
# resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
|
513
|
-
# resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE"
|
515
|
+
# resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
514
516
|
# resp.errors[0].type_configuration_identifier.type_name #=> String
|
515
517
|
# resp.unprocessed_type_configurations #=> Array
|
516
518
|
# resp.unprocessed_type_configurations[0].type_arn #=> String
|
517
519
|
# resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
|
518
520
|
# resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
|
519
|
-
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE"
|
521
|
+
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
520
522
|
# resp.unprocessed_type_configurations[0].type_name #=> String
|
521
523
|
# resp.type_configurations #=> Array
|
522
524
|
# resp.type_configurations[0].arn #=> String
|
@@ -540,12 +542,12 @@ module Aws::CloudFormation
|
|
540
542
|
# successfully, the stack rolls back the update and reverts to the
|
541
543
|
# previous stack configuration.
|
542
544
|
#
|
543
|
-
# <note markdown="1"> You can cancel only stacks that are in the
|
545
|
+
# <note markdown="1"> You can cancel only stacks that are in the `UPDATE_IN_PROGRESS` state.
|
544
546
|
#
|
545
547
|
# </note>
|
546
548
|
#
|
547
549
|
# @option params [required, String] :stack_name
|
548
|
-
# The name or the unique stack ID that
|
550
|
+
# The name or the unique stack ID that's associated with the stack.
|
549
551
|
#
|
550
552
|
# @option params [String] :client_request_token
|
551
553
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
@@ -572,7 +574,7 @@ module Aws::CloudFormation
|
|
572
574
|
req.send_request(options)
|
573
575
|
end
|
574
576
|
|
575
|
-
# For a specified stack that
|
577
|
+
# For a specified stack that's in the `UPDATE_ROLLBACK_FAILED` state,
|
576
578
|
# continues rolling it back to the `UPDATE_ROLLBACK_COMPLETE` state.
|
577
579
|
# Depending on the cause of the failure, you can manually [ fix the
|
578
580
|
# error][1] and continue the rollback. By continuing the rollback, you
|
@@ -581,8 +583,8 @@ module Aws::CloudFormation
|
|
581
583
|
# again.
|
582
584
|
#
|
583
585
|
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
584
|
-
# CloudFormation
|
585
|
-
# update. For example, you might have a stack that
|
586
|
+
# CloudFormation can't roll back all changes after a failed stack
|
587
|
+
# update. For example, you might have a stack that's rolling back to an
|
586
588
|
# old database instance that was deleted outside of CloudFormation.
|
587
589
|
# Because CloudFormation doesn't know the database was deleted, it
|
588
590
|
# assumes that the database instance still exists and attempts to roll
|
@@ -608,13 +610,13 @@ module Aws::CloudFormation
|
|
608
610
|
# (IAM) role that CloudFormation assumes to roll back the stack.
|
609
611
|
# CloudFormation uses the role's credentials to make calls on your
|
610
612
|
# behalf. CloudFormation always uses this role for all future operations
|
611
|
-
# on the stack.
|
613
|
+
# on the stack. Provided that users have permission to operate on the
|
612
614
|
# stack, CloudFormation uses this role even if the users don't have
|
613
|
-
# permission to pass it. Ensure that the role grants least
|
615
|
+
# permission to pass it. Ensure that the role grants least permission.
|
614
616
|
#
|
615
617
|
# If you don't specify a value, CloudFormation uses the role that was
|
616
618
|
# previously associated with the stack. If no role is available,
|
617
|
-
# CloudFormation uses a temporary session that
|
619
|
+
# CloudFormation uses a temporary session that's generated from your
|
618
620
|
# user credentials.
|
619
621
|
#
|
620
622
|
# @option params [Array<String>] :resources_to_skip
|
@@ -622,7 +624,7 @@ module Aws::CloudFormation
|
|
622
624
|
# during the continue update rollback operation. You can specify only
|
623
625
|
# resources that are in the `UPDATE_FAILED` state because a rollback
|
624
626
|
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
625
|
-
# state for other reasons, for example, because an update was
|
627
|
+
# state for other reasons, for example, because an update was canceled.
|
626
628
|
# To check why a resource update failed, use the DescribeStackResources
|
627
629
|
# action, and view the resource status reason.
|
628
630
|
#
|
@@ -713,7 +715,7 @@ module Aws::CloudFormation
|
|
713
715
|
# execute the change set by using the ExecuteChangeSet action.
|
714
716
|
# CloudFormation doesn't make changes until you execute the change set.
|
715
717
|
#
|
716
|
-
# To create a change set for the entire stack
|
718
|
+
# To create a change set for the entire stack hierarchy, set
|
717
719
|
# `IncludeNestedStacks` to `True`.
|
718
720
|
#
|
719
721
|
# @option params [required, String] :stack_name
|
@@ -732,15 +734,15 @@ module Aws::CloudFormation
|
|
732
734
|
#
|
733
735
|
# @option params [String] :template_url
|
734
736
|
# The location of the file that contains the revised template. The URL
|
735
|
-
# must point to a template (max size: 460,800 bytes) that
|
736
|
-
# an S3 bucket or a Systems Manager document. CloudFormation
|
737
|
-
# the change set by comparing this template with the stack
|
738
|
-
# specified.
|
737
|
+
# must point to a template (max size: 460,800 bytes) that's located in
|
738
|
+
# an Amazon S3 bucket or a Systems Manager document. CloudFormation
|
739
|
+
# generates the change set by comparing this template with the stack
|
740
|
+
# that you specified.
|
739
741
|
#
|
740
742
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
741
743
|
#
|
742
744
|
# @option params [Boolean] :use_previous_template
|
743
|
-
# Whether to reuse the template that
|
745
|
+
# Whether to reuse the template that's associated with the stack to
|
744
746
|
# create the change set.
|
745
747
|
#
|
746
748
|
# @option params [Array<Types::Parameter>] :parameters
|
@@ -779,7 +781,7 @@ module Aws::CloudFormation
|
|
779
781
|
#
|
780
782
|
# * [ AWS::IAM::Group][2]
|
781
783
|
#
|
782
|
-
# * [
|
784
|
+
# * [AWS::IAM::InstanceProfile][3]
|
783
785
|
#
|
784
786
|
# * [ AWS::IAM::Policy][4]
|
785
787
|
#
|
@@ -787,10 +789,10 @@ module Aws::CloudFormation
|
|
787
789
|
#
|
788
790
|
# * [ AWS::IAM::User][6]
|
789
791
|
#
|
790
|
-
# * [
|
792
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
791
793
|
#
|
792
|
-
# For more information, see [Acknowledging IAM
|
793
|
-
# CloudFormation
|
794
|
+
# For more information, see [Acknowledging IAM resources in
|
795
|
+
# CloudFormation templates][8].
|
794
796
|
#
|
795
797
|
# * `CAPABILITY_AUTO_EXPAND`
|
796
798
|
#
|
@@ -807,7 +809,7 @@ module Aws::CloudFormation
|
|
807
809
|
# [AWS::Serverless][10] transforms, which are macros hosted by
|
808
810
|
# CloudFormation.
|
809
811
|
#
|
810
|
-
# <note markdown="1"> This capacity
|
812
|
+
# <note markdown="1"> This capacity doesn't apply to creating change sets, and specifying
|
811
813
|
# it when creating change sets has no effect.
|
812
814
|
#
|
813
815
|
# If you want to create a stack from a stack template that contains
|
@@ -817,8 +819,8 @@ module Aws::CloudFormation
|
|
817
819
|
#
|
818
820
|
# </note>
|
819
821
|
#
|
820
|
-
# For more information on macros, see [Using CloudFormation
|
821
|
-
#
|
822
|
+
# For more information on macros, see [Using CloudFormation macros to
|
823
|
+
# perform custom processing on templates][11].
|
822
824
|
#
|
823
825
|
#
|
824
826
|
#
|
@@ -844,7 +846,7 @@ module Aws::CloudFormation
|
|
844
846
|
# grants permissions to all resource types. Identity and Access
|
845
847
|
# Management (IAM) uses this parameter for condition keys in IAM
|
846
848
|
# policies for CloudFormation. For more information, see [Controlling
|
847
|
-
#
|
849
|
+
# access with Identity and Access Management][1] in the CloudFormation
|
848
850
|
# User Guide.
|
849
851
|
#
|
850
852
|
#
|
@@ -856,9 +858,9 @@ module Aws::CloudFormation
|
|
856
858
|
# (IAM) role that CloudFormation assumes when executing the change set.
|
857
859
|
# CloudFormation uses the role's credentials to make calls on your
|
858
860
|
# behalf. CloudFormation uses this role for all future operations on the
|
859
|
-
# stack.
|
861
|
+
# stack. Provided that users have permission to operate on the stack,
|
860
862
|
# CloudFormation uses this role even if the users don't have permission
|
861
|
-
# to pass it. Ensure that the role grants least
|
863
|
+
# to pass it. Ensure that the role grants least permission.
|
862
864
|
#
|
863
865
|
# If you don't specify a value, CloudFormation uses the role that was
|
864
866
|
# previously associated with the stack. If no role is available,
|
@@ -885,8 +887,8 @@ module Aws::CloudFormation
|
|
885
887
|
# sets that are associated with the specified stack.
|
886
888
|
#
|
887
889
|
# A change set name can contain only alphanumeric, case sensitive
|
888
|
-
# characters and hyphens. It must start with an
|
889
|
-
#
|
890
|
+
# characters, and hyphens. It must start with an alphabetical character
|
891
|
+
# and can't exceed 128 characters.
|
890
892
|
#
|
891
893
|
# @option params [String] :client_token
|
892
894
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
@@ -996,14 +998,14 @@ module Aws::CloudFormation
|
|
996
998
|
|
997
999
|
# Creates a stack as specified in the template. After the call completes
|
998
1000
|
# successfully, the stack creation starts. You can check the status of
|
999
|
-
# the stack
|
1001
|
+
# the stack through the DescribeStacksoperation.
|
1000
1002
|
#
|
1001
1003
|
# @option params [required, String] :stack_name
|
1002
|
-
# The name that
|
1004
|
+
# The name that's associated with the stack. The name must be unique in
|
1003
1005
|
# the Region in which you are creating the stack.
|
1004
1006
|
#
|
1005
1007
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
|
1006
|
-
# and hyphens. It must start with an alphabetical character and
|
1008
|
+
# and hyphens. It must start with an alphabetical character and can't
|
1007
1009
|
# be longer than 128 characters.
|
1008
1010
|
#
|
1009
1011
|
# </note>
|
@@ -1011,7 +1013,7 @@ module Aws::CloudFormation
|
|
1011
1013
|
# @option params [String] :template_body
|
1012
1014
|
# Structure containing the template body with a minimum length of 1 byte
|
1013
1015
|
# and a maximum length of 51,200 bytes. For more information, go to
|
1014
|
-
# [Template
|
1016
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1015
1017
|
#
|
1016
1018
|
# Conditional: You must specify either the `TemplateBody` or the
|
1017
1019
|
# `TemplateURL` parameter, but not both.
|
@@ -1022,9 +1024,9 @@ module Aws::CloudFormation
|
|
1022
1024
|
#
|
1023
1025
|
# @option params [String] :template_url
|
1024
1026
|
# Location of file containing the template body. The URL must point to a
|
1025
|
-
# template (max size: 460,800 bytes) that
|
1027
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
1026
1028
|
# bucket or a Systems Manager document. For more information, go to the
|
1027
|
-
# [Template
|
1029
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1028
1030
|
#
|
1029
1031
|
# Conditional: You must specify either the `TemplateBody` or the
|
1030
1032
|
# `TemplateURL` parameter, but not both.
|
@@ -1059,9 +1061,9 @@ module Aws::CloudFormation
|
|
1059
1061
|
# the stack will be rolled back.
|
1060
1062
|
#
|
1061
1063
|
# @option params [Array<String>] :notification_arns
|
1062
|
-
# The Simple Notification Service (SNS) topic ARNs to
|
1063
|
-
# related events. You can find your SNS topic ARNs
|
1064
|
-
# or your Command Line Interface (CLI).
|
1064
|
+
# The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
|
1065
|
+
# publish stack related events. You can find your Amazon SNS topic ARNs
|
1066
|
+
# using the Amazon SNS console or your Command Line Interface (CLI).
|
1065
1067
|
#
|
1066
1068
|
# @option params [Array<String>] :capabilities
|
1067
1069
|
# In some cases, you must explicitly acknowledge that your stack
|
@@ -1095,7 +1097,7 @@ module Aws::CloudFormation
|
|
1095
1097
|
#
|
1096
1098
|
# * [ AWS::IAM::Group][2]
|
1097
1099
|
#
|
1098
|
-
# * [
|
1100
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1099
1101
|
#
|
1100
1102
|
# * [ AWS::IAM::Policy][4]
|
1101
1103
|
#
|
@@ -1103,7 +1105,7 @@ module Aws::CloudFormation
|
|
1103
1105
|
#
|
1104
1106
|
# * [ AWS::IAM::User][6]
|
1105
1107
|
#
|
1106
|
-
# * [
|
1108
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1107
1109
|
#
|
1108
1110
|
# For more information, see [Acknowledging IAM Resources in
|
1109
1111
|
# CloudFormation Templates][8].
|
@@ -1135,8 +1137,8 @@ module Aws::CloudFormation
|
|
1135
1137
|
# can update the function operation without CloudFormation being
|
1136
1138
|
# notified.
|
1137
1139
|
#
|
1138
|
-
# For more information, see [Using CloudFormation
|
1139
|
-
#
|
1140
|
+
# For more information, see [Using CloudFormation macros to perform
|
1141
|
+
# custom processing on templates][11].
|
1140
1142
|
#
|
1141
1143
|
#
|
1142
1144
|
#
|
@@ -1179,18 +1181,18 @@ module Aws::CloudFormation
|
|
1179
1181
|
# (IAM) role that CloudFormation assumes to create the stack.
|
1180
1182
|
# CloudFormation uses the role's credentials to make calls on your
|
1181
1183
|
# behalf. CloudFormation always uses this role for all future operations
|
1182
|
-
# on the stack.
|
1184
|
+
# on the stack. Provided that users have permission to operate on the
|
1183
1185
|
# stack, CloudFormation uses this role even if the users don't have
|
1184
1186
|
# permission to pass it. Ensure that the role grants least privilege.
|
1185
1187
|
#
|
1186
1188
|
# If you don't specify a value, CloudFormation uses the role that was
|
1187
1189
|
# previously associated with the stack. If no role is available,
|
1188
|
-
# CloudFormation uses a temporary session that
|
1190
|
+
# CloudFormation uses a temporary session that's generated from your
|
1189
1191
|
# user credentials.
|
1190
1192
|
#
|
1191
1193
|
# @option params [String] :on_failure
|
1192
1194
|
# Determines what action will be taken if stack creation fails. This
|
1193
|
-
# must be one of:
|
1195
|
+
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
1194
1196
|
# either `OnFailure` or `DisableRollback`, but not both.
|
1195
1197
|
#
|
1196
1198
|
# Default: `ROLLBACK`
|
@@ -1223,7 +1225,7 @@ module Aws::CloudFormation
|
|
1223
1225
|
# retry `CreateStack` requests to ensure that CloudFormation
|
1224
1226
|
# successfully received them.
|
1225
1227
|
#
|
1226
|
-
# All events
|
1228
|
+
# All events initiated by a given stack operation are assigned the same
|
1227
1229
|
# client request token, which you can use to track operations. For
|
1228
1230
|
# example, if you execute a `CreateStack` operation with the token
|
1229
1231
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1242,11 +1244,11 @@ module Aws::CloudFormation
|
|
1242
1244
|
# user attempts to delete a stack with termination protection enabled,
|
1243
1245
|
# the operation fails and the stack remains unchanged. For more
|
1244
1246
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
1245
|
-
# *CloudFormation User Guide*. Termination protection is
|
1247
|
+
# *CloudFormation User Guide*. Termination protection is deactivated on
|
1246
1248
|
# stacks by default.
|
1247
1249
|
#
|
1248
1250
|
# For [nested stacks][2], termination protection is set on the root
|
1249
|
-
# stack and
|
1251
|
+
# stack and can't be changed directly on the nested stack.
|
1250
1252
|
#
|
1251
1253
|
#
|
1252
1254
|
#
|
@@ -1313,10 +1315,10 @@ module Aws::CloudFormation
|
|
1313
1315
|
end
|
1314
1316
|
|
1315
1317
|
# Creates stack instances for the specified accounts, within the
|
1316
|
-
# specified Regions. A stack instance refers to a
|
1317
|
-
# account and Region. You must specify at least one
|
1318
|
-
# `Accounts` or `DeploymentTargets`, and you must
|
1319
|
-
# value for `Regions`.
|
1318
|
+
# specified Amazon Web Services Regions. A stack instance refers to a
|
1319
|
+
# stack in a specific account and Region. You must specify at least one
|
1320
|
+
# value for either `Accounts` or `DeploymentTargets`, and you must
|
1321
|
+
# specify at least one value for `Regions`.
|
1320
1322
|
#
|
1321
1323
|
# @option params [required, String] :stack_set_name
|
1322
1324
|
# The name or unique ID of the stack set that you want to create stack
|
@@ -1331,39 +1333,41 @@ module Aws::CloudFormation
|
|
1331
1333
|
#
|
1332
1334
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1333
1335
|
# \[Service-managed permissions\] The Organizations accounts for which
|
1334
|
-
# to create stack instances in the specified
|
1336
|
+
# to create stack instances in the specified Amazon Web Services
|
1337
|
+
# Regions.
|
1335
1338
|
#
|
1336
1339
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1337
1340
|
#
|
1338
1341
|
# @option params [required, Array<String>] :regions
|
1339
|
-
# The names of one or more Regions where you want to
|
1340
|
-
# instances using the specified Amazon Web Services
|
1342
|
+
# The names of one or more Amazon Web Services Regions where you want to
|
1343
|
+
# create stack instances using the specified Amazon Web Services
|
1344
|
+
# accounts.
|
1341
1345
|
#
|
1342
1346
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
1343
1347
|
# A list of stack set parameters whose values you want to override in
|
1344
1348
|
# the selected stack instances.
|
1345
1349
|
#
|
1346
1350
|
# Any overridden parameter values will be applied to all stack instances
|
1347
|
-
# in the specified accounts and Regions. When
|
1348
|
-
# their values, be aware of how CloudFormation
|
1349
|
-
# during stack instance operations:
|
1351
|
+
# in the specified accounts and Amazon Web Services Regions. When
|
1352
|
+
# specifying parameters and their values, be aware of how CloudFormation
|
1353
|
+
# sets parameter values during stack instance operations:
|
1350
1354
|
#
|
1351
1355
|
# * To override the current value for a parameter, include the parameter
|
1352
1356
|
# and specify its value.
|
1353
1357
|
#
|
1354
1358
|
# * To leave an overridden parameter set to its present value, include
|
1355
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
1359
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
1356
1360
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
1357
1361
|
#
|
1358
1362
|
# * To set an overridden parameter back to the value specified in the
|
1359
|
-
# stack set, specify a parameter list but
|
1363
|
+
# stack set, specify a parameter list but don't include the parameter
|
1360
1364
|
# in the list.
|
1361
1365
|
#
|
1362
|
-
# * To leave all parameters set to their present values,
|
1366
|
+
# * To leave all parameters set to their present values, don't specify
|
1363
1367
|
# this property at all.
|
1364
1368
|
#
|
1365
1369
|
# During stack set updates, any parameter values overridden for a stack
|
1366
|
-
# instance
|
1370
|
+
# instance aren't updated, but retain their overridden value.
|
1367
1371
|
#
|
1368
1372
|
# You can only override the parameter *values* that are specified in the
|
1369
1373
|
# stack set; to add or delete a parameter itself, use
|
@@ -1545,7 +1549,7 @@ module Aws::CloudFormation
|
|
1545
1549
|
#
|
1546
1550
|
# * [ AWS::IAM::Group][2]
|
1547
1551
|
#
|
1548
|
-
# * [
|
1552
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1549
1553
|
#
|
1550
1554
|
# * [ AWS::IAM::Policy][4]
|
1551
1555
|
#
|
@@ -1553,7 +1557,7 @@ module Aws::CloudFormation
|
|
1553
1557
|
#
|
1554
1558
|
# * [ AWS::IAM::User][6]
|
1555
1559
|
#
|
1556
|
-
# * [
|
1560
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1557
1561
|
#
|
1558
1562
|
# For more information, see [Acknowledging IAM Resources in
|
1559
1563
|
# CloudFormation Templates][8].
|
@@ -1568,7 +1572,7 @@ module Aws::CloudFormation
|
|
1568
1572
|
# [Using CloudFormation Macros to Perform Custom Processing on
|
1569
1573
|
# Templates][9].
|
1570
1574
|
#
|
1571
|
-
# Stack sets with service-managed permissions
|
1575
|
+
# Stack sets with service-managed permissions don't currently support
|
1572
1576
|
# the use of macros in templates. (This includes the
|
1573
1577
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1574
1578
|
# macros hosted by CloudFormation.) Even if you specify this
|
@@ -1748,10 +1752,10 @@ module Aws::CloudFormation
|
|
1748
1752
|
# Deactivates a public extension that was previously activated in this
|
1749
1753
|
# account and region.
|
1750
1754
|
#
|
1751
|
-
# Once deactivated, an extension
|
1755
|
+
# Once deactivated, an extension can't be used in any CloudFormation
|
1752
1756
|
# operation. This includes stack update operations where the stack
|
1753
1757
|
# template includes the extension, even if no updates are being made to
|
1754
|
-
# the extension. In addition, deactivated extensions
|
1758
|
+
# the extension. In addition, deactivated extensions aren't
|
1755
1759
|
# automatically updated if a new version of the extension is released.
|
1756
1760
|
#
|
1757
1761
|
# @option params [String] :type_name
|
@@ -1778,7 +1782,7 @@ module Aws::CloudFormation
|
|
1778
1782
|
#
|
1779
1783
|
# resp = client.deactivate_type({
|
1780
1784
|
# type_name: "TypeName",
|
1781
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1785
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
1782
1786
|
# arn: "PrivateTypeArn",
|
1783
1787
|
# })
|
1784
1788
|
#
|
@@ -1808,7 +1812,7 @@ module Aws::CloudFormation
|
|
1808
1812
|
#
|
1809
1813
|
# @option params [String] :stack_name
|
1810
1814
|
# If you specified the name of a change set to delete, specify the stack
|
1811
|
-
# name or
|
1815
|
+
# name or Amazon Resource Name (ARN) that's associated with it.
|
1812
1816
|
#
|
1813
1817
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1814
1818
|
#
|
@@ -1829,19 +1833,19 @@ module Aws::CloudFormation
|
|
1829
1833
|
end
|
1830
1834
|
|
1831
1835
|
# Deletes a specified stack. Once the call completes successfully, stack
|
1832
|
-
# deletion starts. Deleted stacks
|
1833
|
-
#
|
1836
|
+
# deletion starts. Deleted stacks don't show up in the DescribeStacks
|
1837
|
+
# operation if the deletion has been completed successfully.
|
1834
1838
|
#
|
1835
1839
|
# @option params [required, String] :stack_name
|
1836
|
-
# The name or the unique stack ID that
|
1840
|
+
# The name or the unique stack ID that's associated with the stack.
|
1837
1841
|
#
|
1838
1842
|
# @option params [Array<String>] :retain_resources
|
1839
1843
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1840
1844
|
# IDs that are associated with the resources you want to retain. During
|
1841
|
-
# deletion, CloudFormation deletes the stack but
|
1845
|
+
# deletion, CloudFormation deletes the stack but doesn't delete the
|
1842
1846
|
# retained resources.
|
1843
1847
|
#
|
1844
|
-
# Retaining resources is useful when you
|
1848
|
+
# Retaining resources is useful when you can't delete a resource, such
|
1845
1849
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
1846
1850
|
#
|
1847
1851
|
# @option params [String] :role_arn
|
@@ -1852,7 +1856,7 @@ module Aws::CloudFormation
|
|
1852
1856
|
#
|
1853
1857
|
# If you don't specify a value, CloudFormation uses the role that was
|
1854
1858
|
# previously associated with the stack. If no role is available,
|
1855
|
-
# CloudFormation uses a temporary session that
|
1859
|
+
# CloudFormation uses a temporary session that's generated from your
|
1856
1860
|
# user credentials.
|
1857
1861
|
#
|
1858
1862
|
# @option params [String] :client_request_token
|
@@ -1862,7 +1866,7 @@ module Aws::CloudFormation
|
|
1862
1866
|
# retry `DeleteStack` requests to ensure that CloudFormation
|
1863
1867
|
# successfully received them.
|
1864
1868
|
#
|
1865
|
-
# All events
|
1869
|
+
# All events initiated by a given stack operation are assigned the same
|
1866
1870
|
# client request token, which you can use to track operations. For
|
1867
1871
|
# example, if you execute a `CreateStack` operation with the token
|
1868
1872
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1897,7 +1901,7 @@ module Aws::CloudFormation
|
|
1897
1901
|
end
|
1898
1902
|
|
1899
1903
|
# Deletes stack instances for the specified accounts, in the specified
|
1900
|
-
# Regions.
|
1904
|
+
# Amazon Web Services Regions.
|
1901
1905
|
#
|
1902
1906
|
# @option params [required, String] :stack_set_name
|
1903
1907
|
# The name or unique ID of the stack set that you want to delete stack
|
@@ -1916,7 +1920,8 @@ module Aws::CloudFormation
|
|
1916
1920
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1917
1921
|
#
|
1918
1922
|
# @option params [required, Array<String>] :regions
|
1919
|
-
# The Regions where you want to delete stack set
|
1923
|
+
# The Amazon Web Services Regions where you want to delete stack set
|
1924
|
+
# instances.
|
1920
1925
|
#
|
1921
1926
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1922
1927
|
# Preferences for how CloudFormation performs this stack set operation.
|
@@ -2072,9 +2077,9 @@ module Aws::CloudFormation
|
|
2072
2077
|
# extension itself being deregistered and marked as deprecated in the
|
2073
2078
|
# registry.
|
2074
2079
|
#
|
2075
|
-
# You
|
2080
|
+
# You can't deregister the default version of an extension if there are
|
2076
2081
|
# other active version of that extension. If you do deregister the
|
2077
|
-
# default version of an extension, the
|
2082
|
+
# default version of an extension, the extension type itself is
|
2078
2083
|
# deregistered as well and marked as deprecated.
|
2079
2084
|
#
|
2080
2085
|
# To view the deprecation status of an extension or extension version,
|
@@ -2110,7 +2115,7 @@ module Aws::CloudFormation
|
|
2110
2115
|
#
|
2111
2116
|
# resp = client.deregister_type({
|
2112
2117
|
# arn: "PrivateTypeArn",
|
2113
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
2118
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
2114
2119
|
# type_name: "TypeName",
|
2115
2120
|
# version_id: "TypeVersionId",
|
2116
2121
|
# })
|
@@ -2126,7 +2131,7 @@ module Aws::CloudFormation
|
|
2126
2131
|
|
2127
2132
|
# Retrieves your account's CloudFormation limits, such as the maximum
|
2128
2133
|
# number of stacks that you can create in your account. For more
|
2129
|
-
# information about account limits, see [CloudFormation
|
2134
|
+
# information about account limits, see [CloudFormation Quotas][1] in
|
2130
2135
|
# the *CloudFormation User Guide*.
|
2131
2136
|
#
|
2132
2137
|
#
|
@@ -2246,6 +2251,7 @@ module Aws::CloudFormation
|
|
2246
2251
|
# resp.tags[0].value #=> String
|
2247
2252
|
# resp.changes #=> Array
|
2248
2253
|
# resp.changes[0].type #=> String, one of "Resource"
|
2254
|
+
# resp.changes[0].hook_invocation_count #=> Integer
|
2249
2255
|
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
2250
2256
|
# resp.changes[0].resource_change.logical_resource_id #=> String
|
2251
2257
|
# resp.changes[0].resource_change.physical_resource_id #=> String
|
@@ -2282,9 +2288,76 @@ module Aws::CloudFormation
|
|
2282
2288
|
req.send_request(options)
|
2283
2289
|
end
|
2284
2290
|
|
2291
|
+
# Returns hook-related information for the change set and a list of
|
2292
|
+
# changes that CloudFormation makes when you run the change set.
|
2293
|
+
#
|
2294
|
+
# @option params [required, String] :change_set_name
|
2295
|
+
# The name or Amazon Resource Name (ARN) of the change set that you want
|
2296
|
+
# to describe.
|
2297
|
+
#
|
2298
|
+
# @option params [String] :stack_name
|
2299
|
+
# If you specified the name of a change set, specify the stack name or
|
2300
|
+
# stack ID (ARN) of the change set you want to describe.
|
2301
|
+
#
|
2302
|
+
# @option params [String] :next_token
|
2303
|
+
# A string, provided by the `DescribeChangeSetHooks` response output,
|
2304
|
+
# that identifies the next page of information that you want to
|
2305
|
+
# retrieve.
|
2306
|
+
#
|
2307
|
+
# @option params [String] :logical_resource_id
|
2308
|
+
# If specified, lists only the hooks related to the specified
|
2309
|
+
# `LogicalResourceId`.
|
2310
|
+
#
|
2311
|
+
# @return [Types::DescribeChangeSetHooksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2312
|
+
#
|
2313
|
+
# * {Types::DescribeChangeSetHooksOutput#change_set_id #change_set_id} => String
|
2314
|
+
# * {Types::DescribeChangeSetHooksOutput#change_set_name #change_set_name} => String
|
2315
|
+
# * {Types::DescribeChangeSetHooksOutput#hooks #hooks} => Array<Types::ChangeSetHook>
|
2316
|
+
# * {Types::DescribeChangeSetHooksOutput#status #status} => String
|
2317
|
+
# * {Types::DescribeChangeSetHooksOutput#next_token #next_token} => String
|
2318
|
+
# * {Types::DescribeChangeSetHooksOutput#stack_id #stack_id} => String
|
2319
|
+
# * {Types::DescribeChangeSetHooksOutput#stack_name #stack_name} => String
|
2320
|
+
#
|
2321
|
+
# @example Request syntax with placeholder values
|
2322
|
+
#
|
2323
|
+
# resp = client.describe_change_set_hooks({
|
2324
|
+
# change_set_name: "ChangeSetNameOrId", # required
|
2325
|
+
# stack_name: "StackNameOrId",
|
2326
|
+
# next_token: "NextToken",
|
2327
|
+
# logical_resource_id: "LogicalResourceId",
|
2328
|
+
# })
|
2329
|
+
#
|
2330
|
+
# @example Response structure
|
2331
|
+
#
|
2332
|
+
# resp.change_set_id #=> String
|
2333
|
+
# resp.change_set_name #=> String
|
2334
|
+
# resp.hooks #=> Array
|
2335
|
+
# resp.hooks[0].invocation_point #=> String, one of "PRE_PROVISION"
|
2336
|
+
# resp.hooks[0].failure_mode #=> String, one of "FAIL", "WARN"
|
2337
|
+
# resp.hooks[0].type_name #=> String
|
2338
|
+
# resp.hooks[0].type_version_id #=> String
|
2339
|
+
# resp.hooks[0].type_configuration_version_id #=> String
|
2340
|
+
# resp.hooks[0].target_details.target_type #=> String, one of "RESOURCE"
|
2341
|
+
# resp.hooks[0].target_details.resource_target_details.logical_resource_id #=> String
|
2342
|
+
# resp.hooks[0].target_details.resource_target_details.resource_type #=> String
|
2343
|
+
# resp.hooks[0].target_details.resource_target_details.resource_action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
2344
|
+
# resp.status #=> String, one of "PLANNING", "PLANNED", "UNAVAILABLE"
|
2345
|
+
# resp.next_token #=> String
|
2346
|
+
# resp.stack_id #=> String
|
2347
|
+
# resp.stack_name #=> String
|
2348
|
+
#
|
2349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooks AWS API Documentation
|
2350
|
+
#
|
2351
|
+
# @overload describe_change_set_hooks(params = {})
|
2352
|
+
# @param [Hash] params ({})
|
2353
|
+
def describe_change_set_hooks(params = {}, options = {})
|
2354
|
+
req = build_request(:describe_change_set_hooks, params)
|
2355
|
+
req.send_request(options)
|
2356
|
+
end
|
2357
|
+
|
2285
2358
|
# Returns information about a CloudFormation extension publisher.
|
2286
2359
|
#
|
2287
|
-
# If you
|
2360
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2288
2361
|
# extension publisher, `DescribePublisher` returns information about
|
2289
2362
|
# your own publisher account.
|
2290
2363
|
#
|
@@ -2303,7 +2376,7 @@ module Aws::CloudFormation
|
|
2303
2376
|
# @option params [String] :publisher_id
|
2304
2377
|
# The ID of the extension publisher.
|
2305
2378
|
#
|
2306
|
-
# If you
|
2379
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2307
2380
|
# extension publisher, `DescribePublisher` returns information about
|
2308
2381
|
# your own publisher account.
|
2309
2382
|
#
|
@@ -2413,8 +2486,8 @@ module Aws::CloudFormation
|
|
2413
2486
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
|
2414
2487
|
#
|
2415
2488
|
# @option params [String] :stack_name
|
2416
|
-
# The name or the unique stack ID that
|
2417
|
-
# which
|
2489
|
+
# The name or the unique stack ID that's associated with the stack,
|
2490
|
+
# which aren't always interchangeable:
|
2418
2491
|
#
|
2419
2492
|
# * Running stacks: You can specify either the stack's name or its
|
2420
2493
|
# unique stack ID.
|
@@ -2455,6 +2528,11 @@ module Aws::CloudFormation
|
|
2455
2528
|
# resp.stack_events[0].resource_status_reason #=> String
|
2456
2529
|
# resp.stack_events[0].resource_properties #=> String
|
2457
2530
|
# resp.stack_events[0].client_request_token #=> String
|
2531
|
+
# resp.stack_events[0].hook_type #=> String
|
2532
|
+
# resp.stack_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
2533
|
+
# resp.stack_events[0].hook_status_reason #=> String
|
2534
|
+
# resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
|
2535
|
+
# resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
|
2458
2536
|
# resp.next_token #=> String
|
2459
2537
|
#
|
2460
2538
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
|
@@ -2552,8 +2630,8 @@ module Aws::CloudFormation
|
|
2552
2630
|
# for up to 90 days after the stack has been deleted.
|
2553
2631
|
#
|
2554
2632
|
# @option params [required, String] :stack_name
|
2555
|
-
# The name or the unique stack ID that
|
2556
|
-
# which
|
2633
|
+
# The name or the unique stack ID that's associated with the stack,
|
2634
|
+
# which aren't always interchangeable:
|
2557
2635
|
#
|
2558
2636
|
# * Running stacks: You can specify either the stack's name or its
|
2559
2637
|
# unique stack ID.
|
@@ -2611,8 +2689,8 @@ module Aws::CloudFormation
|
|
2611
2689
|
#
|
2612
2690
|
# For a given stack, there will be one `StackResourceDrift` for each
|
2613
2691
|
# stack resource that has been checked for drift. Resources that
|
2614
|
-
# haven't yet been checked for drift
|
2615
|
-
#
|
2692
|
+
# haven't yet been checked for drift aren't included. Resources that
|
2693
|
+
# don't currently support drift detection aren't checked, and so not
|
2616
2694
|
# included. For a list of resources that support drift detection, see
|
2617
2695
|
# [Resources that Support Drift Detection][1].
|
2618
2696
|
#
|
@@ -2637,10 +2715,10 @@ module Aws::CloudFormation
|
|
2637
2715
|
# * `MODIFIED`\: One or more resource properties differ from their
|
2638
2716
|
# expected template values.
|
2639
2717
|
#
|
2640
|
-
# * `IN_SYNC`\: The
|
2718
|
+
# * `IN_SYNC`\: The resource's actual configuration matches its
|
2641
2719
|
# expected template configuration.
|
2642
2720
|
#
|
2643
|
-
# * `NOT_CHECKED`\: CloudFormation
|
2721
|
+
# * `NOT_CHECKED`\: CloudFormation doesn't currently return this value.
|
2644
2722
|
#
|
2645
2723
|
# @option params [String] :next_token
|
2646
2724
|
# A string that identifies the next page of stack resource drift
|
@@ -2731,7 +2809,7 @@ module Aws::CloudFormation
|
|
2731
2809
|
#
|
2732
2810
|
# @option params [String] :stack_name
|
2733
2811
|
# The name or the unique stack ID that is associated with the stack,
|
2734
|
-
# which
|
2812
|
+
# which aren't always interchangeable:
|
2735
2813
|
#
|
2736
2814
|
# * Running stacks: You can specify either the stack's name or its
|
2737
2815
|
# unique stack ID.
|
@@ -2740,7 +2818,7 @@ module Aws::CloudFormation
|
|
2740
2818
|
#
|
2741
2819
|
# Default: There is no default value.
|
2742
2820
|
#
|
2743
|
-
# Required: Conditional. If you
|
2821
|
+
# Required: Conditional. If you don't specify `StackName`, you must
|
2744
2822
|
# specify `PhysicalResourceId`.
|
2745
2823
|
#
|
2746
2824
|
# @option params [String] :logical_resource_id
|
@@ -2757,7 +2835,7 @@ module Aws::CloudFormation
|
|
2757
2835
|
# EC2 `InstanceId` to `DescribeStackResources` to find which stack the
|
2758
2836
|
# instance belongs to and what other resources are part of the stack.
|
2759
2837
|
#
|
2760
|
-
# Required: Conditional. If you
|
2838
|
+
# Required: Conditional. If you don't specify `PhysicalResourceId`, you
|
2761
2839
|
# must specify `StackName`.
|
2762
2840
|
#
|
2763
2841
|
# Default: There is no default value.
|
@@ -2969,13 +3047,13 @@ module Aws::CloudFormation
|
|
2969
3047
|
# Returns the description for the specified stack; if no stack name was
|
2970
3048
|
# specified, then it returns the description for all the stacks created.
|
2971
3049
|
#
|
2972
|
-
# <note markdown="1"> If the stack
|
3050
|
+
# <note markdown="1"> If the stack doesn't exist, an `ValidationError` is returned.
|
2973
3051
|
#
|
2974
3052
|
# </note>
|
2975
3053
|
#
|
2976
3054
|
# @option params [String] :stack_name
|
2977
|
-
# The name or the unique stack ID that
|
2978
|
-
# which
|
3055
|
+
# The name or the unique stack ID that's associated with the stack,
|
3056
|
+
# which aren't always interchangeable:
|
2979
3057
|
#
|
2980
3058
|
# * Running stacks: You can specify either the stack's name or its
|
2981
3059
|
# unique stack ID.
|
@@ -3136,7 +3214,7 @@ module Aws::CloudFormation
|
|
3136
3214
|
# @example Request syntax with placeholder values
|
3137
3215
|
#
|
3138
3216
|
# resp = client.describe_type({
|
3139
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3217
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
3140
3218
|
# type_name: "TypeName",
|
3141
3219
|
# arn: "TypeArn",
|
3142
3220
|
# version_id: "TypeVersionId",
|
@@ -3147,7 +3225,7 @@ module Aws::CloudFormation
|
|
3147
3225
|
# @example Response structure
|
3148
3226
|
#
|
3149
3227
|
# resp.arn #=> String
|
3150
|
-
# resp.type #=> String, one of "RESOURCE", "MODULE"
|
3228
|
+
# resp.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
3151
3229
|
# resp.type_name #=> String
|
3152
3230
|
# resp.default_version_id #=> String
|
3153
3231
|
# resp.is_default_version #=> Boolean
|
@@ -3264,7 +3342,7 @@ module Aws::CloudFormation
|
|
3264
3342
|
# completed, use DescribeStackResourceDrifts to return drift information
|
3265
3343
|
# about the stack and its resources.
|
3266
3344
|
#
|
3267
|
-
# When detecting drift on a stack, CloudFormation
|
3345
|
+
# When detecting drift on a stack, CloudFormation doesn't detect drift
|
3268
3346
|
# on any nested stacks belonging to that stack. Perform
|
3269
3347
|
# `DetectStackDrift` directly on the nested stack itself.
|
3270
3348
|
#
|
@@ -3317,7 +3395,7 @@ module Aws::CloudFormation
|
|
3317
3395
|
# resources, or DetectStackDrift to detect drift on all resources in a
|
3318
3396
|
# given stack that support drift detection.
|
3319
3397
|
#
|
3320
|
-
# Resources that
|
3398
|
+
# Resources that don't currently support drift detection can't be
|
3321
3399
|
# checked. For a list of resources that support drift detection, see
|
3322
3400
|
# [Resources that Support Drift Detection][2].
|
3323
3401
|
#
|
@@ -3377,15 +3455,15 @@ module Aws::CloudFormation
|
|
3377
3455
|
# Detect drift on a stack set. When CloudFormation performs drift
|
3378
3456
|
# detection on a stack set, it performs drift detection on the stack
|
3379
3457
|
# associated with each stack instance in the stack set. For more
|
3380
|
-
# information, see [How CloudFormation
|
3381
|
-
#
|
3458
|
+
# information, see [How CloudFormation performs drift detection on a
|
3459
|
+
# stack set][1].
|
3382
3460
|
#
|
3383
3461
|
# `DetectStackSetDrift` returns the `OperationId` of the stack set drift
|
3384
3462
|
# detection operation. Use this operation id with `
|
3385
3463
|
# DescribeStackSetOperation ` to monitor the progress of the drift
|
3386
3464
|
# detection operation. The drift detection operation may take some time,
|
3387
3465
|
# depending on the number of stack instances included in the stack set,
|
3388
|
-
#
|
3466
|
+
# in addition to the number of resources included in each stack.
|
3389
3467
|
#
|
3390
3468
|
# Once the operation has completed, use the following actions to return
|
3391
3469
|
# drift information:
|
@@ -3393,7 +3471,7 @@ module Aws::CloudFormation
|
|
3393
3471
|
# * Use ` DescribeStackSet ` to return detailed information about the
|
3394
3472
|
# stack set, including detailed information about the last *completed*
|
3395
3473
|
# drift operation performed on the stack set. (Information about drift
|
3396
|
-
# operations that are in progress
|
3474
|
+
# operations that are in progress isn't included.)
|
3397
3475
|
#
|
3398
3476
|
# * Use ` ListStackInstances ` to return a list of stack instances
|
3399
3477
|
# belonging to the stack set, including the drift status and last
|
@@ -3404,7 +3482,7 @@ module Aws::CloudFormation
|
|
3404
3482
|
# time checked.
|
3405
3483
|
#
|
3406
3484
|
# For more information on performing a drift detection operation on a
|
3407
|
-
# stack set, see [Detecting
|
3485
|
+
# stack set, see [Detecting unmanaged changes in stack sets][1].
|
3408
3486
|
#
|
3409
3487
|
# You can only run a single drift detection operation on a given stack
|
3410
3488
|
# set at one time.
|
@@ -3510,7 +3588,7 @@ module Aws::CloudFormation
|
|
3510
3588
|
#
|
3511
3589
|
# @option params [String] :template_url
|
3512
3590
|
# Location of file containing the template body. The URL must point to a
|
3513
|
-
# template that
|
3591
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
3514
3592
|
# document. For more information, go to [Template Anatomy][1] in the
|
3515
3593
|
# CloudFormation User Guide.
|
3516
3594
|
#
|
@@ -3569,16 +3647,17 @@ module Aws::CloudFormation
|
|
3569
3647
|
# enforces the policy during the update. You can't specify a temporary
|
3570
3648
|
# stack policy that overrides the current policy.
|
3571
3649
|
#
|
3572
|
-
# To create a change set for the entire stack
|
3650
|
+
# To create a change set for the entire stack hierarchy,
|
3573
3651
|
# `IncludeNestedStacks` must have been set to `True`.
|
3574
3652
|
#
|
3575
3653
|
# @option params [required, String] :change_set_name
|
3576
|
-
# The name or ARN of the change set that you want
|
3577
|
-
# specified stack.
|
3654
|
+
# The name or Amazon Resource Name (ARN) of the change set that you want
|
3655
|
+
# use to update the specified stack.
|
3578
3656
|
#
|
3579
3657
|
# @option params [String] :stack_name
|
3580
3658
|
# If you specified the name of a change set, specify the stack name or
|
3581
|
-
#
|
3659
|
+
# Amazon Resource Name (ARN) that's associated with the change set you
|
3660
|
+
# want to execute.
|
3582
3661
|
#
|
3583
3662
|
# @option params [String] :client_request_token
|
3584
3663
|
# A unique identifier for this `ExecuteChangeSet` request. Specify this
|
@@ -3617,7 +3696,7 @@ module Aws::CloudFormation
|
|
3617
3696
|
# have a policy, a null value is returned.
|
3618
3697
|
#
|
3619
3698
|
# @option params [required, String] :stack_name
|
3620
|
-
# The name or unique stack ID that
|
3699
|
+
# The name or unique stack ID that's associated with the stack whose
|
3621
3700
|
# policy you want to get.
|
3622
3701
|
#
|
3623
3702
|
# @return [Types::GetStackPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3646,16 +3725,16 @@ module Aws::CloudFormation
|
|
3646
3725
|
# Returns the template body for a specified stack. You can get the
|
3647
3726
|
# template for running or deleted stacks.
|
3648
3727
|
#
|
3649
|
-
# For deleted stacks, GetTemplate returns the template for up to 90
|
3650
|
-
# after the stack has been deleted.
|
3728
|
+
# For deleted stacks, `GetTemplate` returns the template for up to 90
|
3729
|
+
# days after the stack has been deleted.
|
3651
3730
|
#
|
3652
|
-
# <note markdown="1"> If the template
|
3731
|
+
# <note markdown="1"> If the template doesn't exist, a `ValidationError` is returned.
|
3653
3732
|
#
|
3654
3733
|
# </note>
|
3655
3734
|
#
|
3656
3735
|
# @option params [String] :stack_name
|
3657
|
-
# The name or the unique stack ID that
|
3658
|
-
# which
|
3736
|
+
# The name or the unique stack ID that's associated with the stack,
|
3737
|
+
# which aren't always interchangeable:
|
3659
3738
|
#
|
3660
3739
|
# * Running stacks: You can specify either the stack's name or its
|
3661
3740
|
# unique stack ID.
|
@@ -3718,12 +3797,12 @@ module Aws::CloudFormation
|
|
3718
3797
|
#
|
3719
3798
|
# For deleted stacks, `GetTemplateSummary` returns the template
|
3720
3799
|
# information for up to 90 days after the stack has been deleted. If the
|
3721
|
-
# template
|
3800
|
+
# template doesn't exist, a `ValidationError` is returned.
|
3722
3801
|
#
|
3723
3802
|
# @option params [String] :template_body
|
3724
3803
|
# Structure containing the template body with a minimum length of 1 byte
|
3725
3804
|
# and a maximum length of 51,200 bytes. For more information about
|
3726
|
-
# templates, see [Template
|
3805
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3727
3806
|
#
|
3728
3807
|
# Conditional: You must specify only one of the following parameters:
|
3729
3808
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3734,9 +3813,9 @@ module Aws::CloudFormation
|
|
3734
3813
|
#
|
3735
3814
|
# @option params [String] :template_url
|
3736
3815
|
# Location of file containing the template body. The URL must point to a
|
3737
|
-
# template (max size: 460,800 bytes) that
|
3816
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
3738
3817
|
# bucket or a Systems Manager document. For more information about
|
3739
|
-
# templates, see [Template
|
3818
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3740
3819
|
#
|
3741
3820
|
# Conditional: You must specify only one of the following parameters:
|
3742
3821
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3746,10 +3825,10 @@ module Aws::CloudFormation
|
|
3746
3825
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
3747
3826
|
#
|
3748
3827
|
# @option params [String] :stack_name
|
3749
|
-
# The name or the stack ID that
|
3750
|
-
#
|
3751
|
-
# the stack's name or its unique stack ID. For deleted stack,
|
3752
|
-
# specify the unique stack ID.
|
3828
|
+
# The name or the stack ID that's associated with the stack, which
|
3829
|
+
# aren't always interchangeable. For running stacks, you can specify
|
3830
|
+
# either the stack's name or its unique stack ID. For deleted stack,
|
3831
|
+
# you must specify the unique stack ID.
|
3753
3832
|
#
|
3754
3833
|
# Conditional: You must specify only one of the following parameters:
|
3755
3834
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3841,14 +3920,16 @@ module Aws::CloudFormation
|
|
3841
3920
|
req.send_request(options)
|
3842
3921
|
end
|
3843
3922
|
|
3844
|
-
#
|
3845
|
-
#
|
3846
|
-
#
|
3847
|
-
# and
|
3848
|
-
# import
|
3849
|
-
#
|
3850
|
-
#
|
3851
|
-
#
|
3923
|
+
# Import existing stacks into a new stack sets. Use the stack import
|
3924
|
+
# operation to import up to 10 stacks into a new stack set in the same
|
3925
|
+
# account as the source stack or in a different administrator account
|
3926
|
+
# and Region, by specifying the stack ID of the stack you intend to
|
3927
|
+
# import.
|
3928
|
+
#
|
3929
|
+
# <note markdown="1"> `ImportStacksToStackSet` is only supported by self-managed
|
3930
|
+
# permissions.
|
3931
|
+
#
|
3932
|
+
# </note>
|
3852
3933
|
#
|
3853
3934
|
# @option params [required, String] :stack_set_name
|
3854
3935
|
# The name of the stack set. The name must be unique in the Region where
|
@@ -3866,7 +3947,7 @@ module Aws::CloudFormation
|
|
3866
3947
|
# Specify either `StackIds` or `StackIdsUrl`.
|
3867
3948
|
#
|
3868
3949
|
# @option params [Array<String>] :organizational_unit_ids
|
3869
|
-
# The list of OU ID
|
3950
|
+
# The list of OU ID's to which the stacks being imported has to be
|
3870
3951
|
# mapped as deployment target.
|
3871
3952
|
#
|
3872
3953
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
@@ -3987,8 +4068,8 @@ module Aws::CloudFormation
|
|
3987
4068
|
# values that you can import into other stacks. To import values, use
|
3988
4069
|
# the [ `Fn::ImportValue` ][1] function.
|
3989
4070
|
#
|
3990
|
-
# For more information, see [ CloudFormation
|
3991
|
-
#
|
4071
|
+
# For more information, see [ CloudFormation export stack output
|
4072
|
+
# values][2].
|
3992
4073
|
#
|
3993
4074
|
#
|
3994
4075
|
#
|
@@ -4189,7 +4270,7 @@ module Aws::CloudFormation
|
|
4189
4270
|
#
|
4190
4271
|
# @option params [required, String] :stack_name
|
4191
4272
|
# The name or the unique stack ID that is associated with the stack,
|
4192
|
-
# which
|
4273
|
+
# which aren't always interchangeable:
|
4193
4274
|
#
|
4194
4275
|
# * Running stacks: You can specify either the stack's name or its
|
4195
4276
|
# unique stack ID.
|
@@ -4421,7 +4502,7 @@ module Aws::CloudFormation
|
|
4421
4502
|
# permissions in the management account.
|
4422
4503
|
#
|
4423
4504
|
# @option params [String] :next_token
|
4424
|
-
# If the previous paginated request didn't return all
|
4505
|
+
# If the previous paginated request didn't return all the remaining
|
4425
4506
|
# results, the response object's `NextToken` parameter value is set to
|
4426
4507
|
# a token. To retrieve the next set of results, call `ListStackSets`
|
4427
4508
|
# again and assign that token to the request object's `NextToken`
|
@@ -4586,7 +4667,7 @@ module Aws::CloudFormation
|
|
4586
4667
|
# request parameter to get the next set of results.
|
4587
4668
|
#
|
4588
4669
|
# @option params [String] :next_token
|
4589
|
-
# If the previous paginated request didn't return all
|
4670
|
+
# If the previous paginated request didn't return all the remaining
|
4590
4671
|
# results, the response object's `NextToken` parameter value is set to
|
4591
4672
|
# a token. To retrieve the next set of results, call this action again
|
4592
4673
|
# and assign that token to the request object's `NextToken` parameter.
|
@@ -4603,7 +4684,7 @@ module Aws::CloudFormation
|
|
4603
4684
|
# @example Request syntax with placeholder values
|
4604
4685
|
#
|
4605
4686
|
# resp = client.list_type_registrations({
|
4606
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4687
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4607
4688
|
# type_name: "TypeName",
|
4608
4689
|
# type_arn: "TypeArn",
|
4609
4690
|
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
|
@@ -4677,7 +4758,7 @@ module Aws::CloudFormation
|
|
4677
4758
|
# @option params [String] :publisher_id
|
4678
4759
|
# The publisher ID of the extension publisher.
|
4679
4760
|
#
|
4680
|
-
# Extensions published by Amazon
|
4761
|
+
# Extensions published by Amazon aren't assigned a publisher ID.
|
4681
4762
|
#
|
4682
4763
|
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4683
4764
|
#
|
@@ -4689,7 +4770,7 @@ module Aws::CloudFormation
|
|
4689
4770
|
# @example Request syntax with placeholder values
|
4690
4771
|
#
|
4691
4772
|
# resp = client.list_type_versions({
|
4692
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4773
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4693
4774
|
# type_name: "TypeName",
|
4694
4775
|
# arn: "TypeArn",
|
4695
4776
|
# max_results: 1,
|
@@ -4701,7 +4782,7 @@ module Aws::CloudFormation
|
|
4701
4782
|
# @example Response structure
|
4702
4783
|
#
|
4703
4784
|
# resp.type_version_summaries #=> Array
|
4704
|
-
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4785
|
+
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4705
4786
|
# resp.type_version_summaries[0].type_name #=> String
|
4706
4787
|
# resp.type_version_summaries[0].version_id #=> String
|
4707
4788
|
# resp.type_version_summaries[0].is_default_version #=> Boolean
|
@@ -4754,12 +4835,12 @@ module Aws::CloudFormation
|
|
4754
4835
|
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
4755
4836
|
# process updates to the type during stack update operations.
|
4756
4837
|
#
|
4757
|
-
# * `IMMUTABLE`\: The resource type
|
4758
|
-
# so the type
|
4838
|
+
# * `IMMUTABLE`\: The resource type doesn't include an update handler,
|
4839
|
+
# so the type can't be updated and must instead be replaced during
|
4759
4840
|
# stack update operations.
|
4760
4841
|
#
|
4761
|
-
# * `NON_PROVISIONABLE`\: The resource type
|
4762
|
-
# read, and delete handlers, and therefore
|
4842
|
+
# * `NON_PROVISIONABLE`\: The resource type doesn't include create,
|
4843
|
+
# read, and delete handlers, and therefore can't actually be
|
4763
4844
|
# provisioned.
|
4764
4845
|
#
|
4765
4846
|
# The default is `FULLY_MUTABLE`.
|
@@ -4814,7 +4895,7 @@ module Aws::CloudFormation
|
|
4814
4895
|
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
4815
4896
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
4816
4897
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4817
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4898
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4818
4899
|
# filters: {
|
4819
4900
|
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
4820
4901
|
# publisher_id: "PublisherId",
|
@@ -4827,7 +4908,7 @@ module Aws::CloudFormation
|
|
4827
4908
|
# @example Response structure
|
4828
4909
|
#
|
4829
4910
|
# resp.type_summaries #=> Array
|
4830
|
-
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4911
|
+
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4831
4912
|
# resp.type_summaries[0].type_name #=> String
|
4832
4913
|
# resp.type_summaries[0].default_version_id #=> String
|
4833
4914
|
# resp.type_summaries[0].type_arn #=> String
|
@@ -4890,7 +4971,7 @@ module Aws::CloudFormation
|
|
4890
4971
|
#
|
4891
4972
|
# For more information, see [Semantic Versioning 2.0.0][1].
|
4892
4973
|
#
|
4893
|
-
# If you
|
4974
|
+
# If you don't specify a version number, CloudFormation increments the
|
4894
4975
|
# version number by one minor version release.
|
4895
4976
|
#
|
4896
4977
|
# You cannot specify a version number the first time you publish a type.
|
@@ -4908,7 +4989,7 @@ module Aws::CloudFormation
|
|
4908
4989
|
# @example Request syntax with placeholder values
|
4909
4990
|
#
|
4910
4991
|
# resp = client.publish_type({
|
4911
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4992
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4912
4993
|
# arn: "PrivateTypeArn",
|
4913
4994
|
# type_name: "TypeName",
|
4914
4995
|
# public_version_number: "PublicVersionNumber",
|
@@ -4929,7 +5010,7 @@ module Aws::CloudFormation
|
|
4929
5010
|
|
4930
5011
|
# Reports progress of a resource handler to CloudFormation.
|
4931
5012
|
#
|
4932
|
-
# Reserved for use by the [CloudFormation CLI][1].
|
5013
|
+
# Reserved for use by the [CloudFormation CLI][1]. Don't use this API
|
4933
5014
|
# in your code.
|
4934
5015
|
#
|
4935
5016
|
#
|
@@ -4994,7 +5075,7 @@ module Aws::CloudFormation
|
|
4994
5075
|
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4995
5076
|
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4996
5077
|
# status_message: "StatusMessage",
|
4997
|
-
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration
|
5078
|
+
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration, HandlerInternalFailure, NonCompliant, Unknown
|
4998
5079
|
# resource_model: "ResourceModel",
|
4999
5080
|
# client_request_token: "ClientRequestToken",
|
5000
5081
|
# })
|
@@ -5075,15 +5156,15 @@ module Aws::CloudFormation
|
|
5075
5156
|
# extension makes it available for use in CloudFormation templates in
|
5076
5157
|
# your Amazon Web Services account, and includes:
|
5077
5158
|
#
|
5078
|
-
# * Validating the extension schema
|
5159
|
+
# * Validating the extension schema.
|
5079
5160
|
#
|
5080
5161
|
# * Determining which handlers, if any, have been specified for the
|
5081
|
-
# extension
|
5162
|
+
# extension.
|
5082
5163
|
#
|
5083
|
-
# * Making the extension available for use in your account
|
5164
|
+
# * Making the extension available for use in your account.
|
5084
5165
|
#
|
5085
5166
|
# For more information on how to develop extensions and ready them for
|
5086
|
-
#
|
5167
|
+
# registration, see [Creating Resource Providers][1] in the
|
5087
5168
|
# *CloudFormation CLI User Guide*.
|
5088
5169
|
#
|
5089
5170
|
# You can have a maximum of 50 resource extension versions registered at
|
@@ -5121,7 +5202,7 @@ module Aws::CloudFormation
|
|
5121
5202
|
# * For modules,
|
5122
5203
|
# *company\_or\_organization*\::*service*\::*type*\::MODULE.
|
5123
5204
|
#
|
5124
|
-
# <note markdown="1"> The following organization namespaces are reserved and
|
5205
|
+
# <note markdown="1"> The following organization namespaces are reserved and can't be used
|
5125
5206
|
# in your extension names:
|
5126
5207
|
#
|
5127
5208
|
# * `Alexa`
|
@@ -5139,15 +5220,15 @@ module Aws::CloudFormation
|
|
5139
5220
|
# </note>
|
5140
5221
|
#
|
5141
5222
|
# @option params [required, String] :schema_handler_package
|
5142
|
-
# A
|
5143
|
-
# contains the
|
5223
|
+
# A URL to the S3 bucket containing the extension project package that
|
5224
|
+
# contains the necessary files for the extension you want to register.
|
5144
5225
|
#
|
5145
5226
|
# For information on generating a schema handler package for the
|
5146
5227
|
# extension you want to register, see [submit][1] in the *CloudFormation
|
5147
5228
|
# CLI User Guide*.
|
5148
5229
|
#
|
5149
5230
|
# <note markdown="1"> The user registering the extension must be able to access the package
|
5150
|
-
# in the S3 bucket. That
|
5231
|
+
# in the S3 bucket. That's, the user needs to have [GetObject][2]
|
5151
5232
|
# permissions for the schema handler package. For more information, see
|
5152
5233
|
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
5153
5234
|
# *Identity and Access Management User Guide*.
|
@@ -5189,7 +5270,7 @@ module Aws::CloudFormation
|
|
5189
5270
|
# A unique identifier that acts as an idempotency key for this
|
5190
5271
|
# registration request. Specifying a client request token prevents
|
5191
5272
|
# CloudFormation from generating more than one version of an extension
|
5192
|
-
# from the same
|
5273
|
+
# from the same registration request, even if the request is submitted
|
5193
5274
|
# multiple times.
|
5194
5275
|
#
|
5195
5276
|
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5199,7 +5280,7 @@ module Aws::CloudFormation
|
|
5199
5280
|
# @example Request syntax with placeholder values
|
5200
5281
|
#
|
5201
5282
|
# resp = client.register_type({
|
5202
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5283
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5203
5284
|
# type_name: "TypeName", # required
|
5204
5285
|
# schema_handler_package: "S3Url", # required
|
5205
5286
|
# logging_config: {
|
@@ -5225,7 +5306,7 @@ module Aws::CloudFormation
|
|
5225
5306
|
|
5226
5307
|
# When specifying `RollbackStack`, you preserve the state of previously
|
5227
5308
|
# provisioned resources when an operation fails. You can check the
|
5228
|
-
# status of the stack through the DescribeStacks
|
5309
|
+
# status of the stack through the DescribeStacks operation.
|
5229
5310
|
#
|
5230
5311
|
# Rolls back the specified stack to the last known stable state from
|
5231
5312
|
# `CREATE_FAILED` or `UPDATE_FAILED` stack statuses.
|
@@ -5245,7 +5326,7 @@ module Aws::CloudFormation
|
|
5245
5326
|
# * `IMPORT_ROLLBACK_COMPLETE`
|
5246
5327
|
#
|
5247
5328
|
# @option params [required, String] :stack_name
|
5248
|
-
# The name that
|
5329
|
+
# The name that's associated with the stack.
|
5249
5330
|
#
|
5250
5331
|
# @option params [String] :role_arn
|
5251
5332
|
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
@@ -5286,7 +5367,7 @@ module Aws::CloudFormation
|
|
5286
5367
|
#
|
5287
5368
|
# @option params [String] :stack_policy_body
|
5288
5369
|
# Structure containing the stack policy body. For more information, go
|
5289
|
-
# to [ Prevent
|
5370
|
+
# to [ Prevent updates to stack resources][1] in the CloudFormation User
|
5290
5371
|
# Guide. You can specify either the `StackPolicyBody` or the
|
5291
5372
|
# `StackPolicyURL` parameter, but not both.
|
5292
5373
|
#
|
@@ -5296,9 +5377,9 @@ module Aws::CloudFormation
|
|
5296
5377
|
#
|
5297
5378
|
# @option params [String] :stack_policy_url
|
5298
5379
|
# Location of a file containing the stack policy. The URL must point to
|
5299
|
-
# a policy (maximum size: 16 KB) located in an S3 bucket in the
|
5300
|
-
# Region as the stack. You can specify either
|
5301
|
-
# the `StackPolicyURL` parameter, but not both.
|
5380
|
+
# a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the
|
5381
|
+
# same Amazon Web Services Region as the stack. You can specify either
|
5382
|
+
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
5302
5383
|
#
|
5303
5384
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5304
5385
|
#
|
@@ -5328,7 +5409,7 @@ module Aws::CloudFormation
|
|
5328
5409
|
# For more information, see [Configuring extensions at the account
|
5329
5410
|
# level][1] in the *CloudFormation User Guide*.
|
5330
5411
|
#
|
5331
|
-
# It
|
5412
|
+
# It's strongly recommended that you use dynamic references to restrict
|
5332
5413
|
# sensitive configuration definitions, such as third-party credentials.
|
5333
5414
|
# For more details on dynamic references, see [Using dynamic references
|
5334
5415
|
# to specify template values][2] in the *CloudFormation User Guide*.
|
@@ -5398,7 +5479,7 @@ module Aws::CloudFormation
|
|
5398
5479
|
# configuration: "TypeConfiguration", # required
|
5399
5480
|
# configuration_alias: "TypeConfigurationAlias",
|
5400
5481
|
# type_name: "TypeName",
|
5401
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5482
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5402
5483
|
# })
|
5403
5484
|
#
|
5404
5485
|
# @example Response structure
|
@@ -5444,7 +5525,7 @@ module Aws::CloudFormation
|
|
5444
5525
|
#
|
5445
5526
|
# resp = client.set_type_default_version({
|
5446
5527
|
# arn: "PrivateTypeArn",
|
5447
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5528
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5448
5529
|
# type_name: "TypeName",
|
5449
5530
|
# version_id: "TypeVersionId",
|
5450
5531
|
# })
|
@@ -5459,12 +5540,12 @@ module Aws::CloudFormation
|
|
5459
5540
|
end
|
5460
5541
|
|
5461
5542
|
# Sends a signal to the specified resource with a success or failure
|
5462
|
-
# status. You can use the SignalResource
|
5463
|
-
# creation policy or update policy. CloudFormation doesn't proceed
|
5464
|
-
# a stack creation or update until resources receive the required
|
5465
|
-
# of signals or the timeout period is exceeded. The
|
5466
|
-
# is useful in cases where you want to send
|
5467
|
-
# than an Amazon EC2 instance.
|
5543
|
+
# status. You can use the `SignalResource` operation in conjunction with
|
5544
|
+
# a creation policy or update policy. CloudFormation doesn't proceed
|
5545
|
+
# with a stack creation or update until resources receive the required
|
5546
|
+
# number of signals or the timeout period is exceeded. The
|
5547
|
+
# `SignalResource` operation is useful in cases where you want to send
|
5548
|
+
# signals from anywhere other than an Amazon EC2 instance.
|
5468
5549
|
#
|
5469
5550
|
# @option params [required, String] :stack_name
|
5470
5551
|
# The stack name or unique stack ID that includes the resource that you
|
@@ -5507,7 +5588,8 @@ module Aws::CloudFormation
|
|
5507
5588
|
end
|
5508
5589
|
|
5509
5590
|
# Stops an in-progress operation on a stack set and its associated stack
|
5510
|
-
# instances.
|
5591
|
+
# instances. StackSets will cancel all the unstarted stack instance
|
5592
|
+
# deployments and wait for those are in-progress to complete.
|
5511
5593
|
#
|
5512
5594
|
# @option params [required, String] :stack_set_name
|
5513
5595
|
# The name or unique ID of the stack set that you want to stop the
|
@@ -5569,7 +5651,7 @@ module Aws::CloudFormation
|
|
5569
5651
|
# For more information, see [Testing your public extension prior to
|
5570
5652
|
# publishing][1] in the *CloudFormation CLI User Guide*.
|
5571
5653
|
#
|
5572
|
-
# If you
|
5654
|
+
# If you don't specify a version, CloudFormation uses the default
|
5573
5655
|
# version of the extension in your account and region for testing.
|
5574
5656
|
#
|
5575
5657
|
# To perform testing, CloudFormation assumes the execution role
|
@@ -5592,7 +5674,7 @@ module Aws::CloudFormation
|
|
5592
5674
|
# [3]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
|
5593
5675
|
#
|
5594
5676
|
# @option params [String] :arn
|
5595
|
-
# The Amazon Resource
|
5677
|
+
# The Amazon Resource Name (ARN) of the extension.
|
5596
5678
|
#
|
5597
5679
|
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5598
5680
|
#
|
@@ -5612,7 +5694,7 @@ module Aws::CloudFormation
|
|
5612
5694
|
# You can specify the version id with either `Arn`, or with `TypeName`
|
5613
5695
|
# and `Type`.
|
5614
5696
|
#
|
5615
|
-
# If you
|
5697
|
+
# If you don't specify a version, CloudFormation uses the default
|
5616
5698
|
# version of the extension in this account and region for testing.
|
5617
5699
|
#
|
5618
5700
|
# @option params [String] :log_delivery_bucket
|
@@ -5627,9 +5709,9 @@ module Aws::CloudFormation
|
|
5627
5709
|
# specified S3 bucket. Specifically, the user needs the following
|
5628
5710
|
# permissions:
|
5629
5711
|
#
|
5630
|
-
# * GetObject
|
5712
|
+
# * `GetObject`
|
5631
5713
|
#
|
5632
|
-
# * PutObject
|
5714
|
+
# * `PutObject`
|
5633
5715
|
#
|
5634
5716
|
# For more information, see [Actions, Resources, and Condition Keys for
|
5635
5717
|
# Amazon S3][1] in the *Amazon Web Services Identity and Access
|
@@ -5647,7 +5729,7 @@ module Aws::CloudFormation
|
|
5647
5729
|
#
|
5648
5730
|
# resp = client.test_type({
|
5649
5731
|
# arn: "TypeArn",
|
5650
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5732
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5651
5733
|
# type_name: "TypeName",
|
5652
5734
|
# version_id: "TypeVersionId",
|
5653
5735
|
# log_delivery_bucket: "S3Bucket",
|
@@ -5668,7 +5750,7 @@ module Aws::CloudFormation
|
|
5668
5750
|
|
5669
5751
|
# Updates a stack as specified in the template. After the call completes
|
5670
5752
|
# successfully, the stack update starts. You can check the status of the
|
5671
|
-
# stack
|
5753
|
+
# stack through the DescribeStacks action.
|
5672
5754
|
#
|
5673
5755
|
# To get a copy of the template for an existing stack, you can use the
|
5674
5756
|
# GetTemplate action.
|
@@ -5699,7 +5781,7 @@ module Aws::CloudFormation
|
|
5699
5781
|
#
|
5700
5782
|
# @option params [String] :template_url
|
5701
5783
|
# Location of file containing the template body. The URL must point to a
|
5702
|
-
# template that
|
5784
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
5703
5785
|
# document. For more information, go to [Template Anatomy][1] in the
|
5704
5786
|
# CloudFormation User Guide.
|
5705
5787
|
#
|
@@ -5781,7 +5863,7 @@ module Aws::CloudFormation
|
|
5781
5863
|
#
|
5782
5864
|
# * [ AWS::IAM::Group][2]
|
5783
5865
|
#
|
5784
|
-
# * [
|
5866
|
+
# * [AWS::IAM::InstanceProfile][3]
|
5785
5867
|
#
|
5786
5868
|
# * [ AWS::IAM::Policy][4]
|
5787
5869
|
#
|
@@ -5789,7 +5871,7 @@ module Aws::CloudFormation
|
|
5789
5871
|
#
|
5790
5872
|
# * [ AWS::IAM::User][6]
|
5791
5873
|
#
|
5792
|
-
# * [
|
5874
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
5793
5875
|
#
|
5794
5876
|
# For more information, see [Acknowledging IAM Resources in
|
5795
5877
|
# CloudFormation Templates][8].
|
@@ -5859,7 +5941,7 @@ module Aws::CloudFormation
|
|
5859
5941
|
# (IAM) role that CloudFormation assumes to update the stack.
|
5860
5942
|
# CloudFormation uses the role's credentials to make calls on your
|
5861
5943
|
# behalf. CloudFormation always uses this role for all future operations
|
5862
|
-
# on the stack.
|
5944
|
+
# on the stack. Provided that users have permission to operate on the
|
5863
5945
|
# stack, CloudFormation uses this role even if the users don't have
|
5864
5946
|
# permission to pass it. Ensure that the role grants least privilege.
|
5865
5947
|
#
|
@@ -5878,7 +5960,7 @@ module Aws::CloudFormation
|
|
5878
5960
|
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
5879
5961
|
#
|
5880
5962
|
# 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
|
5963
|
+
# new resource that you created during a stack update. If you don't
|
5882
5964
|
# specify a stack policy, the current policy that is associated with the
|
5883
5965
|
# stack is unchanged.
|
5884
5966
|
#
|
@@ -5889,7 +5971,7 @@ module Aws::CloudFormation
|
|
5889
5971
|
# the `StackPolicyURL` parameter, but not both.
|
5890
5972
|
#
|
5891
5973
|
# You might update the stack policy, for example, in order to protect a
|
5892
|
-
# new resource that you created during a stack update. If you
|
5974
|
+
# new resource that you created during a stack update. If you don't
|
5893
5975
|
# specify a stack policy, the current policy that is associated with the
|
5894
5976
|
# stack is unchanged.
|
5895
5977
|
#
|
@@ -5994,15 +6076,15 @@ module Aws::CloudFormation
|
|
5994
6076
|
end
|
5995
6077
|
|
5996
6078
|
# Updates the parameter values for stack instances for the specified
|
5997
|
-
# accounts, within the specified Regions. A stack
|
5998
|
-
# stack in a specific account and Region.
|
6079
|
+
# accounts, within the specified Amazon Web Services Regions. A stack
|
6080
|
+
# instance refers to a stack in a specific account and Region.
|
5999
6081
|
#
|
6000
|
-
# You can only update stack instances in
|
6001
|
-
# already exist; to create additional stack
|
6002
|
-
# [CreateStackInstances][1].
|
6082
|
+
# You can only update stack instances in Amazon Web Services Regions and
|
6083
|
+
# accounts where they already exist; to create additional stack
|
6084
|
+
# instances, use [CreateStackInstances][1].
|
6003
6085
|
#
|
6004
6086
|
# During stack set updates, any parameters overridden for a stack
|
6005
|
-
# instance
|
6087
|
+
# instance aren't updated, but retain their overridden value.
|
6006
6088
|
#
|
6007
6089
|
# You can only update the parameter *values* that are specified in the
|
6008
6090
|
# stack set; to add or delete a parameter itself, use
|
@@ -6027,7 +6109,8 @@ module Aws::CloudFormation
|
|
6027
6109
|
# \[Self-managed permissions\] The names of one or more Amazon Web
|
6028
6110
|
# Services accounts for which you want to update parameter values for
|
6029
6111
|
# stack instances. The overridden parameter values will be applied to
|
6030
|
-
# all stack instances in the specified accounts and
|
6112
|
+
# all stack instances in the specified accounts and Amazon Web Services
|
6113
|
+
# Regions.
|
6031
6114
|
#
|
6032
6115
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6033
6116
|
#
|
@@ -6042,35 +6125,36 @@ module Aws::CloudFormation
|
|
6042
6125
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6043
6126
|
#
|
6044
6127
|
# @option params [required, Array<String>] :regions
|
6045
|
-
# The names of one or more Regions in which you want
|
6046
|
-
# values for stack instances. The overridden
|
6047
|
-
# applied to all stack instances in the
|
6128
|
+
# The names of one or more Amazon Web Services Regions in which you want
|
6129
|
+
# to update parameter values for stack instances. The overridden
|
6130
|
+
# parameter values will be applied to all stack instances in the
|
6131
|
+
# specified accounts and Amazon Web Services Regions.
|
6048
6132
|
#
|
6049
6133
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
6050
6134
|
# A list of input parameters whose values you want to update for the
|
6051
6135
|
# specified stack instances.
|
6052
6136
|
#
|
6053
6137
|
# Any overridden parameter values will be applied to all stack instances
|
6054
|
-
# in the specified accounts and Regions. When
|
6055
|
-
# their values, be aware of how CloudFormation
|
6056
|
-
# during stack instance update operations:
|
6138
|
+
# in the specified accounts and Amazon Web Services Regions. When
|
6139
|
+
# specifying parameters and their values, be aware of how CloudFormation
|
6140
|
+
# sets parameter values during stack instance update operations:
|
6057
6141
|
#
|
6058
6142
|
# * To override the current value for a parameter, include the parameter
|
6059
6143
|
# and specify its value.
|
6060
6144
|
#
|
6061
6145
|
# * To leave an overridden parameter set to its present value, include
|
6062
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
6146
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
6063
6147
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
6064
6148
|
#
|
6065
6149
|
# * To set an overridden parameter back to the value specified in the
|
6066
|
-
# stack set, specify a parameter list but
|
6150
|
+
# stack set, specify a parameter list but don't include the parameter
|
6067
6151
|
# in the list.
|
6068
6152
|
#
|
6069
|
-
# * To leave all parameters set to their present values,
|
6153
|
+
# * To leave all parameters set to their present values, don't specify
|
6070
6154
|
# this property at all.
|
6071
6155
|
#
|
6072
6156
|
# During stack set updates, any parameter values overridden for a stack
|
6073
|
-
# instance
|
6157
|
+
# instance aren't updated, but retain their overridden value.
|
6074
6158
|
#
|
6075
6159
|
# You can only override the parameter *values* that are specified in the
|
6076
6160
|
# stack set; to add or delete a parameter itself, use `UpdateStackSet`
|
@@ -6175,7 +6259,7 @@ module Aws::CloudFormation
|
|
6175
6259
|
end
|
6176
6260
|
|
6177
6261
|
# Updates the stack set, and associated stack instances in the specified
|
6178
|
-
# accounts and Regions.
|
6262
|
+
# accounts and Amazon Web Services Regions.
|
6179
6263
|
#
|
6180
6264
|
# Even if the stack set operation created by updating the stack set
|
6181
6265
|
# fails (completely or partially, below or above a specified failure
|
@@ -6316,7 +6400,7 @@ module Aws::CloudFormation
|
|
6316
6400
|
#
|
6317
6401
|
# * If you specify *any* tags using this parameter, you must specify
|
6318
6402
|
# *all* the tags that you want associated with this stack set, even
|
6319
|
-
# tags you've
|
6403
|
+
# tags you've specified before (for example, when creating the stack
|
6320
6404
|
# set or during a previous update of the stack set.). Any tags that
|
6321
6405
|
# you don't include in the updated list of tags are removed from the
|
6322
6406
|
# stack set, and therefore from the stacks and resources as well.
|
@@ -6382,10 +6466,10 @@ module Aws::CloudFormation
|
|
6382
6466
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
6383
6467
|
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
6384
6468
|
# prior to updating the stack instances in the specified accounts and
|
6385
|
-
# Regions. If the stack set update
|
6386
|
-
# template or parameters, CloudFormation updates the
|
6387
|
-
# the specified accounts and Regions, while leaving
|
6388
|
-
# instances with their existing stack instance status.
|
6469
|
+
# Amazon Web Services Regions. If the stack set update doesn't include
|
6470
|
+
# changes to the template or parameters, CloudFormation updates the
|
6471
|
+
# stack instances in the specified accounts and Regions, while leaving
|
6472
|
+
# all other stack instances with their existing stack instance status.
|
6389
6473
|
#
|
6390
6474
|
# @option params [String] :permission_model
|
6391
6475
|
# Describes how the IAM roles required for stack set operations are
|
@@ -6411,7 +6495,7 @@ module Aws::CloudFormation
|
|
6411
6495
|
# automatically deploys to Organizations accounts that are added to a
|
6412
6496
|
# target organization or organizational unit (OU).
|
6413
6497
|
#
|
6414
|
-
# If you specify `AutoDeployment`,
|
6498
|
+
# If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
|
6415
6499
|
# `Regions`.
|
6416
6500
|
#
|
6417
6501
|
# @option params [String] :operation_id
|
@@ -6435,25 +6519,26 @@ module Aws::CloudFormation
|
|
6435
6519
|
# @option params [Array<String>] :accounts
|
6436
6520
|
# \[Self-managed permissions\] The accounts in which to update
|
6437
6521
|
# associated stack instances. If you specify accounts, you must also
|
6438
|
-
# specify the Regions in which to update stack set
|
6522
|
+
# specify the Amazon Web Services Regions in which to update stack set
|
6523
|
+
# instances.
|
6439
6524
|
#
|
6440
|
-
# To update *all* the stack instances associated with this stack set,
|
6441
|
-
#
|
6525
|
+
# To update *all* the stack instances associated with this stack set,
|
6526
|
+
# don't specify the `Accounts` or `Regions` properties.
|
6442
6527
|
#
|
6443
6528
|
# If the stack set update includes changes to the template (that is, if
|
6444
6529
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
6445
6530
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
6446
6531
|
# status of `OUTDATED` prior to updating the stack instances in the
|
6447
|
-
# specified accounts and Regions. If the stack set
|
6448
|
-
# include changes to the template or parameters,
|
6449
|
-
# the stack instances in the specified accounts
|
6450
|
-
#
|
6451
|
-
# status.
|
6532
|
+
# specified accounts and Amazon Web Services Regions. If the stack set
|
6533
|
+
# update does not include changes to the template or parameters,
|
6534
|
+
# CloudFormation updates the stack instances in the specified accounts
|
6535
|
+
# and Amazon Web Services Regions, while leaving all other stack
|
6536
|
+
# instances with their existing stack instance status.
|
6452
6537
|
#
|
6453
6538
|
# @option params [Array<String>] :regions
|
6454
|
-
# The Regions in which to update associated stack
|
6455
|
-
# specify Regions, you must also specify accounts in
|
6456
|
-
# stack set instances.
|
6539
|
+
# The Amazon Web Services Regions in which to update associated stack
|
6540
|
+
# instances. If you specify Regions, you must also specify accounts in
|
6541
|
+
# which to update stack set instances.
|
6457
6542
|
#
|
6458
6543
|
# To update *all* the stack instances associated with this stack set, do
|
6459
6544
|
# not specify the `Accounts` or `Regions` properties.
|
@@ -6570,7 +6655,7 @@ module Aws::CloudFormation
|
|
6570
6655
|
# User Guide*.
|
6571
6656
|
#
|
6572
6657
|
# For [nested stacks][2], termination protection is set on the root
|
6573
|
-
# stack and
|
6658
|
+
# stack and can't be changed directly on the nested stack.
|
6574
6659
|
#
|
6575
6660
|
#
|
6576
6661
|
#
|
@@ -6689,7 +6774,7 @@ module Aws::CloudFormation
|
|
6689
6774
|
params: params,
|
6690
6775
|
config: config)
|
6691
6776
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
6692
|
-
context[:gem_version] = '1.
|
6777
|
+
context[:gem_version] = '1.68.0'
|
6693
6778
|
Seahorse::Client::Request.new(handlers, context)
|
6694
6779
|
end
|
6695
6780
|
|