aws-sdk-cloudformation 1.65.0 → 1.66.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +314 -231
- data/lib/aws-sdk-cloudformation/client_api.rb +67 -0
- data/lib/aws-sdk-cloudformation/event.rb +36 -0
- data/lib/aws-sdk-cloudformation/resource.rb +20 -20
- data/lib/aws-sdk-cloudformation/stack.rb +31 -30
- data/lib/aws-sdk-cloudformation/stack_resource.rb +2 -2
- data/lib/aws-sdk-cloudformation/types.rb +558 -317
- data/lib/aws-sdk-cloudformation.rb +1 -1
- metadata +2 -2
@@ -440,7 +440,7 @@ module Aws::CloudFormation
|
|
440
440
|
# @example Request syntax with placeholder values
|
441
441
|
#
|
442
442
|
# resp = client.activate_type({
|
443
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
443
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
444
444
|
# public_type_arn: "ThirdPartyTypeArn",
|
445
445
|
# publisher_id: "PublisherId",
|
446
446
|
# type_name: "TypeName",
|
@@ -496,7 +496,7 @@ module Aws::CloudFormation
|
|
496
496
|
# type_arn: "TypeArn",
|
497
497
|
# type_configuration_alias: "TypeConfigurationAlias",
|
498
498
|
# type_configuration_arn: "TypeConfigurationArn",
|
499
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
499
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
500
500
|
# type_name: "TypeName",
|
501
501
|
# },
|
502
502
|
# ],
|
@@ -510,13 +510,13 @@ module Aws::CloudFormation
|
|
510
510
|
# resp.errors[0].type_configuration_identifier.type_arn #=> String
|
511
511
|
# resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
|
512
512
|
# resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
|
513
|
-
# 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"
|
514
514
|
# resp.errors[0].type_configuration_identifier.type_name #=> String
|
515
515
|
# resp.unprocessed_type_configurations #=> Array
|
516
516
|
# resp.unprocessed_type_configurations[0].type_arn #=> String
|
517
517
|
# resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
|
518
518
|
# resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
|
519
|
-
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE"
|
519
|
+
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
520
520
|
# resp.unprocessed_type_configurations[0].type_name #=> String
|
521
521
|
# resp.type_configurations #=> Array
|
522
522
|
# resp.type_configurations[0].arn #=> String
|
@@ -540,12 +540,12 @@ module Aws::CloudFormation
|
|
540
540
|
# successfully, the stack rolls back the update and reverts to the
|
541
541
|
# previous stack configuration.
|
542
542
|
#
|
543
|
-
# <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.
|
544
544
|
#
|
545
545
|
# </note>
|
546
546
|
#
|
547
547
|
# @option params [required, String] :stack_name
|
548
|
-
# The name or the unique stack ID that
|
548
|
+
# The name or the unique stack ID that's associated with the stack.
|
549
549
|
#
|
550
550
|
# @option params [String] :client_request_token
|
551
551
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
@@ -572,7 +572,7 @@ module Aws::CloudFormation
|
|
572
572
|
req.send_request(options)
|
573
573
|
end
|
574
574
|
|
575
|
-
# For a specified stack that
|
575
|
+
# For a specified stack that's in the `UPDATE_ROLLBACK_FAILED` state,
|
576
576
|
# continues rolling it back to the `UPDATE_ROLLBACK_COMPLETE` state.
|
577
577
|
# Depending on the cause of the failure, you can manually [ fix the
|
578
578
|
# error][1] and continue the rollback. By continuing the rollback, you
|
@@ -581,8 +581,8 @@ module Aws::CloudFormation
|
|
581
581
|
# again.
|
582
582
|
#
|
583
583
|
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
584
|
-
# CloudFormation
|
585
|
-
# 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
|
586
586
|
# old database instance that was deleted outside of CloudFormation.
|
587
587
|
# Because CloudFormation doesn't know the database was deleted, it
|
588
588
|
# assumes that the database instance still exists and attempts to roll
|
@@ -608,13 +608,13 @@ module Aws::CloudFormation
|
|
608
608
|
# (IAM) role that CloudFormation assumes to roll back the stack.
|
609
609
|
# CloudFormation uses the role's credentials to make calls on your
|
610
610
|
# behalf. CloudFormation always uses this role for all future operations
|
611
|
-
# on the stack.
|
611
|
+
# on the stack. Provided that users have permission to operate on the
|
612
612
|
# stack, CloudFormation uses this role even if the users don't have
|
613
|
-
# permission to pass it. Ensure that the role grants least
|
613
|
+
# permission to pass it. Ensure that the role grants least permission.
|
614
614
|
#
|
615
615
|
# If you don't specify a value, CloudFormation uses the role that was
|
616
616
|
# previously associated with the stack. If no role is available,
|
617
|
-
# CloudFormation uses a temporary session that
|
617
|
+
# CloudFormation uses a temporary session that's generated from your
|
618
618
|
# user credentials.
|
619
619
|
#
|
620
620
|
# @option params [Array<String>] :resources_to_skip
|
@@ -622,7 +622,7 @@ module Aws::CloudFormation
|
|
622
622
|
# during the continue update rollback operation. You can specify only
|
623
623
|
# resources that are in the `UPDATE_FAILED` state because a rollback
|
624
624
|
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
625
|
-
# state for other reasons, for example, because an update was
|
625
|
+
# state for other reasons, for example, because an update was canceled.
|
626
626
|
# To check why a resource update failed, use the DescribeStackResources
|
627
627
|
# action, and view the resource status reason.
|
628
628
|
#
|
@@ -713,7 +713,7 @@ module Aws::CloudFormation
|
|
713
713
|
# execute the change set by using the ExecuteChangeSet action.
|
714
714
|
# CloudFormation doesn't make changes until you execute the change set.
|
715
715
|
#
|
716
|
-
# To create a change set for the entire stack
|
716
|
+
# To create a change set for the entire stack hierarchy, set
|
717
717
|
# `IncludeNestedStacks` to `True`.
|
718
718
|
#
|
719
719
|
# @option params [required, String] :stack_name
|
@@ -732,15 +732,15 @@ module Aws::CloudFormation
|
|
732
732
|
#
|
733
733
|
# @option params [String] :template_url
|
734
734
|
# 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.
|
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.
|
739
739
|
#
|
740
740
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
741
741
|
#
|
742
742
|
# @option params [Boolean] :use_previous_template
|
743
|
-
# Whether to reuse the template that
|
743
|
+
# Whether to reuse the template that's associated with the stack to
|
744
744
|
# create the change set.
|
745
745
|
#
|
746
746
|
# @option params [Array<Types::Parameter>] :parameters
|
@@ -779,7 +779,7 @@ module Aws::CloudFormation
|
|
779
779
|
#
|
780
780
|
# * [ AWS::IAM::Group][2]
|
781
781
|
#
|
782
|
-
# * [
|
782
|
+
# * [AWS::IAM::InstanceProfile][3]
|
783
783
|
#
|
784
784
|
# * [ AWS::IAM::Policy][4]
|
785
785
|
#
|
@@ -787,10 +787,10 @@ module Aws::CloudFormation
|
|
787
787
|
#
|
788
788
|
# * [ AWS::IAM::User][6]
|
789
789
|
#
|
790
|
-
# * [
|
790
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
791
791
|
#
|
792
|
-
# For more information, see [Acknowledging IAM
|
793
|
-
# CloudFormation
|
792
|
+
# For more information, see [Acknowledging IAM resources in
|
793
|
+
# CloudFormation templates][8].
|
794
794
|
#
|
795
795
|
# * `CAPABILITY_AUTO_EXPAND`
|
796
796
|
#
|
@@ -807,7 +807,7 @@ module Aws::CloudFormation
|
|
807
807
|
# [AWS::Serverless][10] transforms, which are macros hosted by
|
808
808
|
# CloudFormation.
|
809
809
|
#
|
810
|
-
# <note markdown="1"> This capacity
|
810
|
+
# <note markdown="1"> This capacity doesn't apply to creating change sets, and specifying
|
811
811
|
# it when creating change sets has no effect.
|
812
812
|
#
|
813
813
|
# If you want to create a stack from a stack template that contains
|
@@ -817,8 +817,8 @@ module Aws::CloudFormation
|
|
817
817
|
#
|
818
818
|
# </note>
|
819
819
|
#
|
820
|
-
# For more information on macros, see [Using CloudFormation
|
821
|
-
#
|
820
|
+
# For more information on macros, see [Using CloudFormation macros to
|
821
|
+
# perform custom processing on templates][11].
|
822
822
|
#
|
823
823
|
#
|
824
824
|
#
|
@@ -844,7 +844,7 @@ module Aws::CloudFormation
|
|
844
844
|
# grants permissions to all resource types. Identity and Access
|
845
845
|
# Management (IAM) uses this parameter for condition keys in IAM
|
846
846
|
# policies for CloudFormation. For more information, see [Controlling
|
847
|
-
#
|
847
|
+
# access with Identity and Access Management][1] in the CloudFormation
|
848
848
|
# User Guide.
|
849
849
|
#
|
850
850
|
#
|
@@ -856,9 +856,9 @@ module Aws::CloudFormation
|
|
856
856
|
# (IAM) role that CloudFormation assumes when executing the change set.
|
857
857
|
# CloudFormation uses the role's credentials to make calls on your
|
858
858
|
# behalf. CloudFormation uses this role for all future operations on the
|
859
|
-
# stack.
|
859
|
+
# stack. Provided that users have permission to operate on the stack,
|
860
860
|
# CloudFormation uses this role even if the users don't have permission
|
861
|
-
# to pass it. Ensure that the role grants least
|
861
|
+
# to pass it. Ensure that the role grants least permission.
|
862
862
|
#
|
863
863
|
# If you don't specify a value, CloudFormation uses the role that was
|
864
864
|
# previously associated with the stack. If no role is available,
|
@@ -885,8 +885,8 @@ module Aws::CloudFormation
|
|
885
885
|
# sets that are associated with the specified stack.
|
886
886
|
#
|
887
887
|
# A change set name can contain only alphanumeric, case sensitive
|
888
|
-
# characters and hyphens. It must start with an
|
889
|
-
#
|
888
|
+
# characters, and hyphens. It must start with an alphabetical character
|
889
|
+
# and can't exceed 128 characters.
|
890
890
|
#
|
891
891
|
# @option params [String] :client_token
|
892
892
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
@@ -996,14 +996,14 @@ module Aws::CloudFormation
|
|
996
996
|
|
997
997
|
# Creates a stack as specified in the template. After the call completes
|
998
998
|
# successfully, the stack creation starts. You can check the status of
|
999
|
-
# the stack
|
999
|
+
# the stack through the DescribeStacksoperation.
|
1000
1000
|
#
|
1001
1001
|
# @option params [required, String] :stack_name
|
1002
|
-
# The name that
|
1002
|
+
# The name that's associated with the stack. The name must be unique in
|
1003
1003
|
# the Region in which you are creating the stack.
|
1004
1004
|
#
|
1005
1005
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
|
1006
|
-
# and hyphens. It must start with an alphabetical character and
|
1006
|
+
# and hyphens. It must start with an alphabetical character and can't
|
1007
1007
|
# be longer than 128 characters.
|
1008
1008
|
#
|
1009
1009
|
# </note>
|
@@ -1011,7 +1011,7 @@ module Aws::CloudFormation
|
|
1011
1011
|
# @option params [String] :template_body
|
1012
1012
|
# Structure containing the template body with a minimum length of 1 byte
|
1013
1013
|
# and a maximum length of 51,200 bytes. For more information, go to
|
1014
|
-
# [Template
|
1014
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1015
1015
|
#
|
1016
1016
|
# Conditional: You must specify either the `TemplateBody` or the
|
1017
1017
|
# `TemplateURL` parameter, but not both.
|
@@ -1022,9 +1022,9 @@ module Aws::CloudFormation
|
|
1022
1022
|
#
|
1023
1023
|
# @option params [String] :template_url
|
1024
1024
|
# Location of file containing the template body. The URL must point to a
|
1025
|
-
# template (max size: 460,800 bytes) that
|
1025
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
1026
1026
|
# bucket or a Systems Manager document. For more information, go to the
|
1027
|
-
# [Template
|
1027
|
+
# [Template anatomy][1] in the CloudFormation User Guide.
|
1028
1028
|
#
|
1029
1029
|
# Conditional: You must specify either the `TemplateBody` or the
|
1030
1030
|
# `TemplateURL` parameter, but not both.
|
@@ -1059,9 +1059,9 @@ module Aws::CloudFormation
|
|
1059
1059
|
# the stack will be rolled back.
|
1060
1060
|
#
|
1061
1061
|
# @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).
|
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).
|
1065
1065
|
#
|
1066
1066
|
# @option params [Array<String>] :capabilities
|
1067
1067
|
# In some cases, you must explicitly acknowledge that your stack
|
@@ -1095,7 +1095,7 @@ module Aws::CloudFormation
|
|
1095
1095
|
#
|
1096
1096
|
# * [ AWS::IAM::Group][2]
|
1097
1097
|
#
|
1098
|
-
# * [
|
1098
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1099
1099
|
#
|
1100
1100
|
# * [ AWS::IAM::Policy][4]
|
1101
1101
|
#
|
@@ -1103,7 +1103,7 @@ module Aws::CloudFormation
|
|
1103
1103
|
#
|
1104
1104
|
# * [ AWS::IAM::User][6]
|
1105
1105
|
#
|
1106
|
-
# * [
|
1106
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1107
1107
|
#
|
1108
1108
|
# For more information, see [Acknowledging IAM Resources in
|
1109
1109
|
# CloudFormation Templates][8].
|
@@ -1135,8 +1135,8 @@ module Aws::CloudFormation
|
|
1135
1135
|
# can update the function operation without CloudFormation being
|
1136
1136
|
# notified.
|
1137
1137
|
#
|
1138
|
-
# For more information, see [Using CloudFormation
|
1139
|
-
#
|
1138
|
+
# For more information, see [Using CloudFormation macros to perform
|
1139
|
+
# custom processing on templates][11].
|
1140
1140
|
#
|
1141
1141
|
#
|
1142
1142
|
#
|
@@ -1179,18 +1179,18 @@ module Aws::CloudFormation
|
|
1179
1179
|
# (IAM) role that CloudFormation assumes to create the stack.
|
1180
1180
|
# CloudFormation uses the role's credentials to make calls on your
|
1181
1181
|
# behalf. CloudFormation always uses this role for all future operations
|
1182
|
-
# on the stack.
|
1182
|
+
# on the stack. Provided that users have permission to operate on the
|
1183
1183
|
# stack, CloudFormation uses this role even if the users don't have
|
1184
1184
|
# permission to pass it. Ensure that the role grants least privilege.
|
1185
1185
|
#
|
1186
1186
|
# If you don't specify a value, CloudFormation uses the role that was
|
1187
1187
|
# previously associated with the stack. If no role is available,
|
1188
|
-
# CloudFormation uses a temporary session that
|
1188
|
+
# CloudFormation uses a temporary session that's generated from your
|
1189
1189
|
# user credentials.
|
1190
1190
|
#
|
1191
1191
|
# @option params [String] :on_failure
|
1192
1192
|
# Determines what action will be taken if stack creation fails. This
|
1193
|
-
# must be one of:
|
1193
|
+
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
1194
1194
|
# either `OnFailure` or `DisableRollback`, but not both.
|
1195
1195
|
#
|
1196
1196
|
# Default: `ROLLBACK`
|
@@ -1223,7 +1223,7 @@ module Aws::CloudFormation
|
|
1223
1223
|
# retry `CreateStack` requests to ensure that CloudFormation
|
1224
1224
|
# successfully received them.
|
1225
1225
|
#
|
1226
|
-
# All events
|
1226
|
+
# All events initiated by a given stack operation are assigned the same
|
1227
1227
|
# client request token, which you can use to track operations. For
|
1228
1228
|
# example, if you execute a `CreateStack` operation with the token
|
1229
1229
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1242,11 +1242,11 @@ module Aws::CloudFormation
|
|
1242
1242
|
# user attempts to delete a stack with termination protection enabled,
|
1243
1243
|
# the operation fails and the stack remains unchanged. For more
|
1244
1244
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
1245
|
-
# *CloudFormation User Guide*. Termination protection is
|
1245
|
+
# *CloudFormation User Guide*. Termination protection is deactivated on
|
1246
1246
|
# stacks by default.
|
1247
1247
|
#
|
1248
1248
|
# For [nested stacks][2], termination protection is set on the root
|
1249
|
-
# stack and
|
1249
|
+
# stack and can't be changed directly on the nested stack.
|
1250
1250
|
#
|
1251
1251
|
#
|
1252
1252
|
#
|
@@ -1313,10 +1313,10 @@ module Aws::CloudFormation
|
|
1313
1313
|
end
|
1314
1314
|
|
1315
1315
|
# 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`.
|
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`.
|
1320
1320
|
#
|
1321
1321
|
# @option params [required, String] :stack_set_name
|
1322
1322
|
# The name or unique ID of the stack set that you want to create stack
|
@@ -1331,39 +1331,41 @@ module Aws::CloudFormation
|
|
1331
1331
|
#
|
1332
1332
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1333
1333
|
# \[Service-managed permissions\] The Organizations accounts for which
|
1334
|
-
# to create stack instances in the specified
|
1334
|
+
# to create stack instances in the specified Amazon Web Services
|
1335
|
+
# Regions.
|
1335
1336
|
#
|
1336
1337
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1337
1338
|
#
|
1338
1339
|
# @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
|
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.
|
1341
1343
|
#
|
1342
1344
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
1343
1345
|
# A list of stack set parameters whose values you want to override in
|
1344
1346
|
# the selected stack instances.
|
1345
1347
|
#
|
1346
1348
|
# 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:
|
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:
|
1350
1352
|
#
|
1351
1353
|
# * To override the current value for a parameter, include the parameter
|
1352
1354
|
# and specify its value.
|
1353
1355
|
#
|
1354
1356
|
# * To leave an overridden parameter set to its present value, include
|
1355
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
1357
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
1356
1358
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
1357
1359
|
#
|
1358
1360
|
# * To set an overridden parameter back to the value specified in the
|
1359
|
-
# stack set, specify a parameter list but
|
1361
|
+
# stack set, specify a parameter list but don't include the parameter
|
1360
1362
|
# in the list.
|
1361
1363
|
#
|
1362
|
-
# * To leave all parameters set to their present values,
|
1364
|
+
# * To leave all parameters set to their present values, don't specify
|
1363
1365
|
# this property at all.
|
1364
1366
|
#
|
1365
1367
|
# During stack set updates, any parameter values overridden for a stack
|
1366
|
-
# instance
|
1368
|
+
# instance aren't updated, but retain their overridden value.
|
1367
1369
|
#
|
1368
1370
|
# You can only override the parameter *values* that are specified in the
|
1369
1371
|
# stack set; to add or delete a parameter itself, use
|
@@ -1545,7 +1547,7 @@ module Aws::CloudFormation
|
|
1545
1547
|
#
|
1546
1548
|
# * [ AWS::IAM::Group][2]
|
1547
1549
|
#
|
1548
|
-
# * [
|
1550
|
+
# * [AWS::IAM::InstanceProfile][3]
|
1549
1551
|
#
|
1550
1552
|
# * [ AWS::IAM::Policy][4]
|
1551
1553
|
#
|
@@ -1553,7 +1555,7 @@ module Aws::CloudFormation
|
|
1553
1555
|
#
|
1554
1556
|
# * [ AWS::IAM::User][6]
|
1555
1557
|
#
|
1556
|
-
# * [
|
1558
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
1557
1559
|
#
|
1558
1560
|
# For more information, see [Acknowledging IAM Resources in
|
1559
1561
|
# CloudFormation Templates][8].
|
@@ -1568,7 +1570,7 @@ module Aws::CloudFormation
|
|
1568
1570
|
# [Using CloudFormation Macros to Perform Custom Processing on
|
1569
1571
|
# Templates][9].
|
1570
1572
|
#
|
1571
|
-
# Stack sets with service-managed permissions
|
1573
|
+
# Stack sets with service-managed permissions don't currently support
|
1572
1574
|
# the use of macros in templates. (This includes the
|
1573
1575
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1574
1576
|
# macros hosted by CloudFormation.) Even if you specify this
|
@@ -1748,10 +1750,10 @@ module Aws::CloudFormation
|
|
1748
1750
|
# Deactivates a public extension that was previously activated in this
|
1749
1751
|
# account and region.
|
1750
1752
|
#
|
1751
|
-
# Once deactivated, an extension
|
1753
|
+
# Once deactivated, an extension can't be used in any CloudFormation
|
1752
1754
|
# operation. This includes stack update operations where the stack
|
1753
1755
|
# template includes the extension, even if no updates are being made to
|
1754
|
-
# the extension. In addition, deactivated extensions
|
1756
|
+
# the extension. In addition, deactivated extensions aren't
|
1755
1757
|
# automatically updated if a new version of the extension is released.
|
1756
1758
|
#
|
1757
1759
|
# @option params [String] :type_name
|
@@ -1778,7 +1780,7 @@ module Aws::CloudFormation
|
|
1778
1780
|
#
|
1779
1781
|
# resp = client.deactivate_type({
|
1780
1782
|
# type_name: "TypeName",
|
1781
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1783
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
1782
1784
|
# arn: "PrivateTypeArn",
|
1783
1785
|
# })
|
1784
1786
|
#
|
@@ -1808,7 +1810,7 @@ module Aws::CloudFormation
|
|
1808
1810
|
#
|
1809
1811
|
# @option params [String] :stack_name
|
1810
1812
|
# If you specified the name of a change set to delete, specify the stack
|
1811
|
-
# name or
|
1813
|
+
# name or Amazon Resource Name (ARN) that's associated with it.
|
1812
1814
|
#
|
1813
1815
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1814
1816
|
#
|
@@ -1829,19 +1831,19 @@ module Aws::CloudFormation
|
|
1829
1831
|
end
|
1830
1832
|
|
1831
1833
|
# Deletes a specified stack. Once the call completes successfully, stack
|
1832
|
-
# deletion starts. Deleted stacks
|
1833
|
-
#
|
1834
|
+
# deletion starts. Deleted stacks don't show up in the DescribeStacks
|
1835
|
+
# operation if the deletion has been completed successfully.
|
1834
1836
|
#
|
1835
1837
|
# @option params [required, String] :stack_name
|
1836
|
-
# The name or the unique stack ID that
|
1838
|
+
# The name or the unique stack ID that's associated with the stack.
|
1837
1839
|
#
|
1838
1840
|
# @option params [Array<String>] :retain_resources
|
1839
1841
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1840
1842
|
# IDs that are associated with the resources you want to retain. During
|
1841
|
-
# deletion, CloudFormation deletes the stack but
|
1843
|
+
# deletion, CloudFormation deletes the stack but doesn't delete the
|
1842
1844
|
# retained resources.
|
1843
1845
|
#
|
1844
|
-
# Retaining resources is useful when you
|
1846
|
+
# Retaining resources is useful when you can't delete a resource, such
|
1845
1847
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
1846
1848
|
#
|
1847
1849
|
# @option params [String] :role_arn
|
@@ -1852,7 +1854,7 @@ module Aws::CloudFormation
|
|
1852
1854
|
#
|
1853
1855
|
# If you don't specify a value, CloudFormation uses the role that was
|
1854
1856
|
# previously associated with the stack. If no role is available,
|
1855
|
-
# CloudFormation uses a temporary session that
|
1857
|
+
# CloudFormation uses a temporary session that's generated from your
|
1856
1858
|
# user credentials.
|
1857
1859
|
#
|
1858
1860
|
# @option params [String] :client_request_token
|
@@ -1862,7 +1864,7 @@ module Aws::CloudFormation
|
|
1862
1864
|
# retry `DeleteStack` requests to ensure that CloudFormation
|
1863
1865
|
# successfully received them.
|
1864
1866
|
#
|
1865
|
-
# All events
|
1867
|
+
# All events initiated by a given stack operation are assigned the same
|
1866
1868
|
# client request token, which you can use to track operations. For
|
1867
1869
|
# example, if you execute a `CreateStack` operation with the token
|
1868
1870
|
# `token1`, then all the `StackEvents` generated by that operation will
|
@@ -1897,7 +1899,7 @@ module Aws::CloudFormation
|
|
1897
1899
|
end
|
1898
1900
|
|
1899
1901
|
# Deletes stack instances for the specified accounts, in the specified
|
1900
|
-
# Regions.
|
1902
|
+
# Amazon Web Services Regions.
|
1901
1903
|
#
|
1902
1904
|
# @option params [required, String] :stack_set_name
|
1903
1905
|
# The name or unique ID of the stack set that you want to delete stack
|
@@ -1916,7 +1918,8 @@ module Aws::CloudFormation
|
|
1916
1918
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1917
1919
|
#
|
1918
1920
|
# @option params [required, Array<String>] :regions
|
1919
|
-
# The Regions where you want to delete stack set
|
1921
|
+
# The Amazon Web Services Regions where you want to delete stack set
|
1922
|
+
# instances.
|
1920
1923
|
#
|
1921
1924
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1922
1925
|
# Preferences for how CloudFormation performs this stack set operation.
|
@@ -2072,9 +2075,9 @@ module Aws::CloudFormation
|
|
2072
2075
|
# extension itself being deregistered and marked as deprecated in the
|
2073
2076
|
# registry.
|
2074
2077
|
#
|
2075
|
-
# You
|
2078
|
+
# You can't deregister the default version of an extension if there are
|
2076
2079
|
# other active version of that extension. If you do deregister the
|
2077
|
-
# default version of an extension, the
|
2080
|
+
# default version of an extension, the extension type itself is
|
2078
2081
|
# deregistered as well and marked as deprecated.
|
2079
2082
|
#
|
2080
2083
|
# To view the deprecation status of an extension or extension version,
|
@@ -2110,7 +2113,7 @@ module Aws::CloudFormation
|
|
2110
2113
|
#
|
2111
2114
|
# resp = client.deregister_type({
|
2112
2115
|
# arn: "PrivateTypeArn",
|
2113
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
2116
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
2114
2117
|
# type_name: "TypeName",
|
2115
2118
|
# version_id: "TypeVersionId",
|
2116
2119
|
# })
|
@@ -2126,7 +2129,7 @@ module Aws::CloudFormation
|
|
2126
2129
|
|
2127
2130
|
# Retrieves your account's CloudFormation limits, such as the maximum
|
2128
2131
|
# number of stacks that you can create in your account. For more
|
2129
|
-
# information about account limits, see [CloudFormation
|
2132
|
+
# information about account limits, see [CloudFormation Quotas][1] in
|
2130
2133
|
# the *CloudFormation User Guide*.
|
2131
2134
|
#
|
2132
2135
|
#
|
@@ -2246,6 +2249,7 @@ module Aws::CloudFormation
|
|
2246
2249
|
# resp.tags[0].value #=> String
|
2247
2250
|
# resp.changes #=> Array
|
2248
2251
|
# resp.changes[0].type #=> String, one of "Resource"
|
2252
|
+
# resp.changes[0].hook_invocation_count #=> Integer
|
2249
2253
|
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
2250
2254
|
# resp.changes[0].resource_change.logical_resource_id #=> String
|
2251
2255
|
# resp.changes[0].resource_change.physical_resource_id #=> String
|
@@ -2282,9 +2286,76 @@ module Aws::CloudFormation
|
|
2282
2286
|
req.send_request(options)
|
2283
2287
|
end
|
2284
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
|
+
|
2285
2356
|
# Returns information about a CloudFormation extension publisher.
|
2286
2357
|
#
|
2287
|
-
# If you
|
2358
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2288
2359
|
# extension publisher, `DescribePublisher` returns information about
|
2289
2360
|
# your own publisher account.
|
2290
2361
|
#
|
@@ -2303,7 +2374,7 @@ module Aws::CloudFormation
|
|
2303
2374
|
# @option params [String] :publisher_id
|
2304
2375
|
# The ID of the extension publisher.
|
2305
2376
|
#
|
2306
|
-
# If you
|
2377
|
+
# If you don't supply a `PublisherId`, and you have registered as an
|
2307
2378
|
# extension publisher, `DescribePublisher` returns information about
|
2308
2379
|
# your own publisher account.
|
2309
2380
|
#
|
@@ -2413,8 +2484,8 @@ module Aws::CloudFormation
|
|
2413
2484
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
|
2414
2485
|
#
|
2415
2486
|
# @option params [String] :stack_name
|
2416
|
-
# The name or the unique stack ID that
|
2417
|
-
# which
|
2487
|
+
# The name or the unique stack ID that's associated with the stack,
|
2488
|
+
# which aren't always interchangeable:
|
2418
2489
|
#
|
2419
2490
|
# * Running stacks: You can specify either the stack's name or its
|
2420
2491
|
# unique stack ID.
|
@@ -2455,6 +2526,11 @@ module Aws::CloudFormation
|
|
2455
2526
|
# resp.stack_events[0].resource_status_reason #=> String
|
2456
2527
|
# resp.stack_events[0].resource_properties #=> String
|
2457
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"
|
2458
2534
|
# resp.next_token #=> String
|
2459
2535
|
#
|
2460
2536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
|
@@ -2552,8 +2628,8 @@ module Aws::CloudFormation
|
|
2552
2628
|
# for up to 90 days after the stack has been deleted.
|
2553
2629
|
#
|
2554
2630
|
# @option params [required, String] :stack_name
|
2555
|
-
# The name or the unique stack ID that
|
2556
|
-
# which
|
2631
|
+
# The name or the unique stack ID that's associated with the stack,
|
2632
|
+
# which aren't always interchangeable:
|
2557
2633
|
#
|
2558
2634
|
# * Running stacks: You can specify either the stack's name or its
|
2559
2635
|
# unique stack ID.
|
@@ -2611,8 +2687,8 @@ module Aws::CloudFormation
|
|
2611
2687
|
#
|
2612
2688
|
# For a given stack, there will be one `StackResourceDrift` for each
|
2613
2689
|
# stack resource that has been checked for drift. Resources that
|
2614
|
-
# haven't yet been checked for drift
|
2615
|
-
#
|
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
|
2616
2692
|
# included. For a list of resources that support drift detection, see
|
2617
2693
|
# [Resources that Support Drift Detection][1].
|
2618
2694
|
#
|
@@ -2637,10 +2713,10 @@ module Aws::CloudFormation
|
|
2637
2713
|
# * `MODIFIED`\: One or more resource properties differ from their
|
2638
2714
|
# expected template values.
|
2639
2715
|
#
|
2640
|
-
# * `IN_SYNC`\: The
|
2716
|
+
# * `IN_SYNC`\: The resource's actual configuration matches its
|
2641
2717
|
# expected template configuration.
|
2642
2718
|
#
|
2643
|
-
# * `NOT_CHECKED`\: CloudFormation
|
2719
|
+
# * `NOT_CHECKED`\: CloudFormation doesn't currently return this value.
|
2644
2720
|
#
|
2645
2721
|
# @option params [String] :next_token
|
2646
2722
|
# A string that identifies the next page of stack resource drift
|
@@ -2731,7 +2807,7 @@ module Aws::CloudFormation
|
|
2731
2807
|
#
|
2732
2808
|
# @option params [String] :stack_name
|
2733
2809
|
# The name or the unique stack ID that is associated with the stack,
|
2734
|
-
# which
|
2810
|
+
# which aren't always interchangeable:
|
2735
2811
|
#
|
2736
2812
|
# * Running stacks: You can specify either the stack's name or its
|
2737
2813
|
# unique stack ID.
|
@@ -2740,7 +2816,7 @@ module Aws::CloudFormation
|
|
2740
2816
|
#
|
2741
2817
|
# Default: There is no default value.
|
2742
2818
|
#
|
2743
|
-
# Required: Conditional. If you
|
2819
|
+
# Required: Conditional. If you don't specify `StackName`, you must
|
2744
2820
|
# specify `PhysicalResourceId`.
|
2745
2821
|
#
|
2746
2822
|
# @option params [String] :logical_resource_id
|
@@ -2757,7 +2833,7 @@ module Aws::CloudFormation
|
|
2757
2833
|
# EC2 `InstanceId` to `DescribeStackResources` to find which stack the
|
2758
2834
|
# instance belongs to and what other resources are part of the stack.
|
2759
2835
|
#
|
2760
|
-
# Required: Conditional. If you
|
2836
|
+
# Required: Conditional. If you don't specify `PhysicalResourceId`, you
|
2761
2837
|
# must specify `StackName`.
|
2762
2838
|
#
|
2763
2839
|
# Default: There is no default value.
|
@@ -2969,13 +3045,13 @@ module Aws::CloudFormation
|
|
2969
3045
|
# Returns the description for the specified stack; if no stack name was
|
2970
3046
|
# specified, then it returns the description for all the stacks created.
|
2971
3047
|
#
|
2972
|
-
# <note markdown="1"> If the stack
|
3048
|
+
# <note markdown="1"> If the stack doesn't exist, an `ValidationError` is returned.
|
2973
3049
|
#
|
2974
3050
|
# </note>
|
2975
3051
|
#
|
2976
3052
|
# @option params [String] :stack_name
|
2977
|
-
# The name or the unique stack ID that
|
2978
|
-
# which
|
3053
|
+
# The name or the unique stack ID that's associated with the stack,
|
3054
|
+
# which aren't always interchangeable:
|
2979
3055
|
#
|
2980
3056
|
# * Running stacks: You can specify either the stack's name or its
|
2981
3057
|
# unique stack ID.
|
@@ -3136,7 +3212,7 @@ module Aws::CloudFormation
|
|
3136
3212
|
# @example Request syntax with placeholder values
|
3137
3213
|
#
|
3138
3214
|
# resp = client.describe_type({
|
3139
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
3215
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
3140
3216
|
# type_name: "TypeName",
|
3141
3217
|
# arn: "TypeArn",
|
3142
3218
|
# version_id: "TypeVersionId",
|
@@ -3147,7 +3223,7 @@ module Aws::CloudFormation
|
|
3147
3223
|
# @example Response structure
|
3148
3224
|
#
|
3149
3225
|
# resp.arn #=> String
|
3150
|
-
# resp.type #=> String, one of "RESOURCE", "MODULE"
|
3226
|
+
# resp.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
3151
3227
|
# resp.type_name #=> String
|
3152
3228
|
# resp.default_version_id #=> String
|
3153
3229
|
# resp.is_default_version #=> Boolean
|
@@ -3264,7 +3340,7 @@ module Aws::CloudFormation
|
|
3264
3340
|
# completed, use DescribeStackResourceDrifts to return drift information
|
3265
3341
|
# about the stack and its resources.
|
3266
3342
|
#
|
3267
|
-
# When detecting drift on a stack, CloudFormation
|
3343
|
+
# When detecting drift on a stack, CloudFormation doesn't detect drift
|
3268
3344
|
# on any nested stacks belonging to that stack. Perform
|
3269
3345
|
# `DetectStackDrift` directly on the nested stack itself.
|
3270
3346
|
#
|
@@ -3317,7 +3393,7 @@ module Aws::CloudFormation
|
|
3317
3393
|
# resources, or DetectStackDrift to detect drift on all resources in a
|
3318
3394
|
# given stack that support drift detection.
|
3319
3395
|
#
|
3320
|
-
# Resources that
|
3396
|
+
# Resources that don't currently support drift detection can't be
|
3321
3397
|
# checked. For a list of resources that support drift detection, see
|
3322
3398
|
# [Resources that Support Drift Detection][2].
|
3323
3399
|
#
|
@@ -3377,15 +3453,15 @@ module Aws::CloudFormation
|
|
3377
3453
|
# Detect drift on a stack set. When CloudFormation performs drift
|
3378
3454
|
# detection on a stack set, it performs drift detection on the stack
|
3379
3455
|
# associated with each stack instance in the stack set. For more
|
3380
|
-
# information, see [How CloudFormation
|
3381
|
-
#
|
3456
|
+
# information, see [How CloudFormation performs drift detection on a
|
3457
|
+
# stack set][1].
|
3382
3458
|
#
|
3383
3459
|
# `DetectStackSetDrift` returns the `OperationId` of the stack set drift
|
3384
3460
|
# detection operation. Use this operation id with `
|
3385
3461
|
# DescribeStackSetOperation ` to monitor the progress of the drift
|
3386
3462
|
# detection operation. The drift detection operation may take some time,
|
3387
3463
|
# depending on the number of stack instances included in the stack set,
|
3388
|
-
#
|
3464
|
+
# in addition to the number of resources included in each stack.
|
3389
3465
|
#
|
3390
3466
|
# Once the operation has completed, use the following actions to return
|
3391
3467
|
# drift information:
|
@@ -3393,7 +3469,7 @@ module Aws::CloudFormation
|
|
3393
3469
|
# * Use ` DescribeStackSet ` to return detailed information about the
|
3394
3470
|
# stack set, including detailed information about the last *completed*
|
3395
3471
|
# drift operation performed on the stack set. (Information about drift
|
3396
|
-
# operations that are in progress
|
3472
|
+
# operations that are in progress isn't included.)
|
3397
3473
|
#
|
3398
3474
|
# * Use ` ListStackInstances ` to return a list of stack instances
|
3399
3475
|
# belonging to the stack set, including the drift status and last
|
@@ -3404,7 +3480,7 @@ module Aws::CloudFormation
|
|
3404
3480
|
# time checked.
|
3405
3481
|
#
|
3406
3482
|
# For more information on performing a drift detection operation on a
|
3407
|
-
# stack set, see [Detecting
|
3483
|
+
# stack set, see [Detecting unmanaged changes in stack sets][1].
|
3408
3484
|
#
|
3409
3485
|
# You can only run a single drift detection operation on a given stack
|
3410
3486
|
# set at one time.
|
@@ -3510,7 +3586,7 @@ module Aws::CloudFormation
|
|
3510
3586
|
#
|
3511
3587
|
# @option params [String] :template_url
|
3512
3588
|
# Location of file containing the template body. The URL must point to a
|
3513
|
-
# template that
|
3589
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
3514
3590
|
# document. For more information, go to [Template Anatomy][1] in the
|
3515
3591
|
# CloudFormation User Guide.
|
3516
3592
|
#
|
@@ -3569,16 +3645,17 @@ module Aws::CloudFormation
|
|
3569
3645
|
# enforces the policy during the update. You can't specify a temporary
|
3570
3646
|
# stack policy that overrides the current policy.
|
3571
3647
|
#
|
3572
|
-
# To create a change set for the entire stack
|
3648
|
+
# To create a change set for the entire stack hierarchy,
|
3573
3649
|
# `IncludeNestedStacks` must have been set to `True`.
|
3574
3650
|
#
|
3575
3651
|
# @option params [required, String] :change_set_name
|
3576
|
-
# The name or ARN of the change set that you want
|
3577
|
-
# specified stack.
|
3652
|
+
# The name or Amazon Resource Name (ARN) of the change set that you want
|
3653
|
+
# use to update the specified stack.
|
3578
3654
|
#
|
3579
3655
|
# @option params [String] :stack_name
|
3580
3656
|
# If you specified the name of a change set, specify the stack name or
|
3581
|
-
#
|
3657
|
+
# Amazon Resource Name (ARN) that's associated with the change set you
|
3658
|
+
# want to execute.
|
3582
3659
|
#
|
3583
3660
|
# @option params [String] :client_request_token
|
3584
3661
|
# A unique identifier for this `ExecuteChangeSet` request. Specify this
|
@@ -3617,7 +3694,7 @@ module Aws::CloudFormation
|
|
3617
3694
|
# have a policy, a null value is returned.
|
3618
3695
|
#
|
3619
3696
|
# @option params [required, String] :stack_name
|
3620
|
-
# The name or unique stack ID that
|
3697
|
+
# The name or unique stack ID that's associated with the stack whose
|
3621
3698
|
# policy you want to get.
|
3622
3699
|
#
|
3623
3700
|
# @return [Types::GetStackPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3646,16 +3723,16 @@ module Aws::CloudFormation
|
|
3646
3723
|
# Returns the template body for a specified stack. You can get the
|
3647
3724
|
# template for running or deleted stacks.
|
3648
3725
|
#
|
3649
|
-
# For deleted stacks, GetTemplate returns the template for up to 90
|
3650
|
-
# 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.
|
3651
3728
|
#
|
3652
|
-
# <note markdown="1"> If the template
|
3729
|
+
# <note markdown="1"> If the template doesn't exist, a `ValidationError` is returned.
|
3653
3730
|
#
|
3654
3731
|
# </note>
|
3655
3732
|
#
|
3656
3733
|
# @option params [String] :stack_name
|
3657
|
-
# The name or the unique stack ID that
|
3658
|
-
# which
|
3734
|
+
# The name or the unique stack ID that's associated with the stack,
|
3735
|
+
# which aren't always interchangeable:
|
3659
3736
|
#
|
3660
3737
|
# * Running stacks: You can specify either the stack's name or its
|
3661
3738
|
# unique stack ID.
|
@@ -3718,12 +3795,12 @@ module Aws::CloudFormation
|
|
3718
3795
|
#
|
3719
3796
|
# For deleted stacks, `GetTemplateSummary` returns the template
|
3720
3797
|
# information for up to 90 days after the stack has been deleted. If the
|
3721
|
-
# template
|
3798
|
+
# template doesn't exist, a `ValidationError` is returned.
|
3722
3799
|
#
|
3723
3800
|
# @option params [String] :template_body
|
3724
3801
|
# Structure containing the template body with a minimum length of 1 byte
|
3725
3802
|
# and a maximum length of 51,200 bytes. For more information about
|
3726
|
-
# templates, see [Template
|
3803
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3727
3804
|
#
|
3728
3805
|
# Conditional: You must specify only one of the following parameters:
|
3729
3806
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3734,9 +3811,9 @@ module Aws::CloudFormation
|
|
3734
3811
|
#
|
3735
3812
|
# @option params [String] :template_url
|
3736
3813
|
# Location of file containing the template body. The URL must point to a
|
3737
|
-
# template (max size: 460,800 bytes) that
|
3814
|
+
# template (max size: 460,800 bytes) that's located in an Amazon S3
|
3738
3815
|
# bucket or a Systems Manager document. For more information about
|
3739
|
-
# templates, see [Template
|
3816
|
+
# templates, see [Template anatomy][1] in the CloudFormation User Guide.
|
3740
3817
|
#
|
3741
3818
|
# Conditional: You must specify only one of the following parameters:
|
3742
3819
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3746,10 +3823,10 @@ module Aws::CloudFormation
|
|
3746
3823
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
3747
3824
|
#
|
3748
3825
|
# @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.
|
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.
|
3753
3830
|
#
|
3754
3831
|
# Conditional: You must specify only one of the following parameters:
|
3755
3832
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3841,14 +3918,16 @@ module Aws::CloudFormation
|
|
3841
3918
|
req.send_request(options)
|
3842
3919
|
end
|
3843
3920
|
|
3844
|
-
#
|
3845
|
-
#
|
3846
|
-
#
|
3847
|
-
# and
|
3848
|
-
# import
|
3849
|
-
#
|
3850
|
-
#
|
3851
|
-
#
|
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>
|
3852
3931
|
#
|
3853
3932
|
# @option params [required, String] :stack_set_name
|
3854
3933
|
# The name of the stack set. The name must be unique in the Region where
|
@@ -3866,7 +3945,7 @@ module Aws::CloudFormation
|
|
3866
3945
|
# Specify either `StackIds` or `StackIdsUrl`.
|
3867
3946
|
#
|
3868
3947
|
# @option params [Array<String>] :organizational_unit_ids
|
3869
|
-
# The list of OU ID
|
3948
|
+
# The list of OU ID's to which the stacks being imported has to be
|
3870
3949
|
# mapped as deployment target.
|
3871
3950
|
#
|
3872
3951
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
@@ -3987,8 +4066,8 @@ module Aws::CloudFormation
|
|
3987
4066
|
# values that you can import into other stacks. To import values, use
|
3988
4067
|
# the [ `Fn::ImportValue` ][1] function.
|
3989
4068
|
#
|
3990
|
-
# For more information, see [ CloudFormation
|
3991
|
-
#
|
4069
|
+
# For more information, see [ CloudFormation export stack output
|
4070
|
+
# values][2].
|
3992
4071
|
#
|
3993
4072
|
#
|
3994
4073
|
#
|
@@ -4189,7 +4268,7 @@ module Aws::CloudFormation
|
|
4189
4268
|
#
|
4190
4269
|
# @option params [required, String] :stack_name
|
4191
4270
|
# The name or the unique stack ID that is associated with the stack,
|
4192
|
-
# which
|
4271
|
+
# which aren't always interchangeable:
|
4193
4272
|
#
|
4194
4273
|
# * Running stacks: You can specify either the stack's name or its
|
4195
4274
|
# unique stack ID.
|
@@ -4421,7 +4500,7 @@ module Aws::CloudFormation
|
|
4421
4500
|
# permissions in the management account.
|
4422
4501
|
#
|
4423
4502
|
# @option params [String] :next_token
|
4424
|
-
# If the previous paginated request didn't return all
|
4503
|
+
# If the previous paginated request didn't return all the remaining
|
4425
4504
|
# results, the response object's `NextToken` parameter value is set to
|
4426
4505
|
# a token. To retrieve the next set of results, call `ListStackSets`
|
4427
4506
|
# again and assign that token to the request object's `NextToken`
|
@@ -4586,7 +4665,7 @@ module Aws::CloudFormation
|
|
4586
4665
|
# request parameter to get the next set of results.
|
4587
4666
|
#
|
4588
4667
|
# @option params [String] :next_token
|
4589
|
-
# If the previous paginated request didn't return all
|
4668
|
+
# If the previous paginated request didn't return all the remaining
|
4590
4669
|
# results, the response object's `NextToken` parameter value is set to
|
4591
4670
|
# a token. To retrieve the next set of results, call this action again
|
4592
4671
|
# and assign that token to the request object's `NextToken` parameter.
|
@@ -4603,7 +4682,7 @@ module Aws::CloudFormation
|
|
4603
4682
|
# @example Request syntax with placeholder values
|
4604
4683
|
#
|
4605
4684
|
# resp = client.list_type_registrations({
|
4606
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4685
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4607
4686
|
# type_name: "TypeName",
|
4608
4687
|
# type_arn: "TypeArn",
|
4609
4688
|
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
|
@@ -4677,7 +4756,7 @@ module Aws::CloudFormation
|
|
4677
4756
|
# @option params [String] :publisher_id
|
4678
4757
|
# The publisher ID of the extension publisher.
|
4679
4758
|
#
|
4680
|
-
# Extensions published by Amazon
|
4759
|
+
# Extensions published by Amazon aren't assigned a publisher ID.
|
4681
4760
|
#
|
4682
4761
|
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4683
4762
|
#
|
@@ -4689,7 +4768,7 @@ module Aws::CloudFormation
|
|
4689
4768
|
# @example Request syntax with placeholder values
|
4690
4769
|
#
|
4691
4770
|
# resp = client.list_type_versions({
|
4692
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4771
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4693
4772
|
# type_name: "TypeName",
|
4694
4773
|
# arn: "TypeArn",
|
4695
4774
|
# max_results: 1,
|
@@ -4701,7 +4780,7 @@ module Aws::CloudFormation
|
|
4701
4780
|
# @example Response structure
|
4702
4781
|
#
|
4703
4782
|
# resp.type_version_summaries #=> Array
|
4704
|
-
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4783
|
+
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4705
4784
|
# resp.type_version_summaries[0].type_name #=> String
|
4706
4785
|
# resp.type_version_summaries[0].version_id #=> String
|
4707
4786
|
# resp.type_version_summaries[0].is_default_version #=> Boolean
|
@@ -4754,12 +4833,12 @@ module Aws::CloudFormation
|
|
4754
4833
|
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
4755
4834
|
# process updates to the type during stack update operations.
|
4756
4835
|
#
|
4757
|
-
# * `IMMUTABLE`\: The resource type
|
4758
|
-
# 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
|
4759
4838
|
# stack update operations.
|
4760
4839
|
#
|
4761
|
-
# * `NON_PROVISIONABLE`\: The resource type
|
4762
|
-
# 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
|
4763
4842
|
# provisioned.
|
4764
4843
|
#
|
4765
4844
|
# The default is `FULLY_MUTABLE`.
|
@@ -4814,7 +4893,7 @@ module Aws::CloudFormation
|
|
4814
4893
|
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
4815
4894
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
4816
4895
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4817
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4896
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4818
4897
|
# filters: {
|
4819
4898
|
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
4820
4899
|
# publisher_id: "PublisherId",
|
@@ -4827,7 +4906,7 @@ module Aws::CloudFormation
|
|
4827
4906
|
# @example Response structure
|
4828
4907
|
#
|
4829
4908
|
# resp.type_summaries #=> Array
|
4830
|
-
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE"
|
4909
|
+
# resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
|
4831
4910
|
# resp.type_summaries[0].type_name #=> String
|
4832
4911
|
# resp.type_summaries[0].default_version_id #=> String
|
4833
4912
|
# resp.type_summaries[0].type_arn #=> String
|
@@ -4890,7 +4969,7 @@ module Aws::CloudFormation
|
|
4890
4969
|
#
|
4891
4970
|
# For more information, see [Semantic Versioning 2.0.0][1].
|
4892
4971
|
#
|
4893
|
-
# If you
|
4972
|
+
# If you don't specify a version number, CloudFormation increments the
|
4894
4973
|
# version number by one minor version release.
|
4895
4974
|
#
|
4896
4975
|
# You cannot specify a version number the first time you publish a type.
|
@@ -4908,7 +4987,7 @@ module Aws::CloudFormation
|
|
4908
4987
|
# @example Request syntax with placeholder values
|
4909
4988
|
#
|
4910
4989
|
# resp = client.publish_type({
|
4911
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4990
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
4912
4991
|
# arn: "PrivateTypeArn",
|
4913
4992
|
# type_name: "TypeName",
|
4914
4993
|
# public_version_number: "PublicVersionNumber",
|
@@ -4929,7 +5008,7 @@ module Aws::CloudFormation
|
|
4929
5008
|
|
4930
5009
|
# Reports progress of a resource handler to CloudFormation.
|
4931
5010
|
#
|
4932
|
-
# Reserved for use by the [CloudFormation CLI][1].
|
5011
|
+
# Reserved for use by the [CloudFormation CLI][1]. Don't use this API
|
4933
5012
|
# in your code.
|
4934
5013
|
#
|
4935
5014
|
#
|
@@ -5075,15 +5154,15 @@ module Aws::CloudFormation
|
|
5075
5154
|
# extension makes it available for use in CloudFormation templates in
|
5076
5155
|
# your Amazon Web Services account, and includes:
|
5077
5156
|
#
|
5078
|
-
# * Validating the extension schema
|
5157
|
+
# * Validating the extension schema.
|
5079
5158
|
#
|
5080
5159
|
# * Determining which handlers, if any, have been specified for the
|
5081
|
-
# extension
|
5160
|
+
# extension.
|
5082
5161
|
#
|
5083
|
-
# * Making the extension available for use in your account
|
5162
|
+
# * Making the extension available for use in your account.
|
5084
5163
|
#
|
5085
5164
|
# For more information on how to develop extensions and ready them for
|
5086
|
-
#
|
5165
|
+
# registration, see [Creating Resource Providers][1] in the
|
5087
5166
|
# *CloudFormation CLI User Guide*.
|
5088
5167
|
#
|
5089
5168
|
# You can have a maximum of 50 resource extension versions registered at
|
@@ -5121,7 +5200,7 @@ module Aws::CloudFormation
|
|
5121
5200
|
# * For modules,
|
5122
5201
|
# *company\_or\_organization*\::*service*\::*type*\::MODULE.
|
5123
5202
|
#
|
5124
|
-
# <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
|
5125
5204
|
# in your extension names:
|
5126
5205
|
#
|
5127
5206
|
# * `Alexa`
|
@@ -5139,15 +5218,15 @@ module Aws::CloudFormation
|
|
5139
5218
|
# </note>
|
5140
5219
|
#
|
5141
5220
|
# @option params [required, String] :schema_handler_package
|
5142
|
-
# A
|
5143
|
-
# 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.
|
5144
5223
|
#
|
5145
5224
|
# For information on generating a schema handler package for the
|
5146
5225
|
# extension you want to register, see [submit][1] in the *CloudFormation
|
5147
5226
|
# CLI User Guide*.
|
5148
5227
|
#
|
5149
5228
|
# <note markdown="1"> The user registering the extension must be able to access the package
|
5150
|
-
# in the S3 bucket. That
|
5229
|
+
# in the S3 bucket. That's, the user needs to have [GetObject][2]
|
5151
5230
|
# permissions for the schema handler package. For more information, see
|
5152
5231
|
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
5153
5232
|
# *Identity and Access Management User Guide*.
|
@@ -5189,7 +5268,7 @@ module Aws::CloudFormation
|
|
5189
5268
|
# A unique identifier that acts as an idempotency key for this
|
5190
5269
|
# registration request. Specifying a client request token prevents
|
5191
5270
|
# CloudFormation from generating more than one version of an extension
|
5192
|
-
# from the same
|
5271
|
+
# from the same registration request, even if the request is submitted
|
5193
5272
|
# multiple times.
|
5194
5273
|
#
|
5195
5274
|
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5199,7 +5278,7 @@ module Aws::CloudFormation
|
|
5199
5278
|
# @example Request syntax with placeholder values
|
5200
5279
|
#
|
5201
5280
|
# resp = client.register_type({
|
5202
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5281
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5203
5282
|
# type_name: "TypeName", # required
|
5204
5283
|
# schema_handler_package: "S3Url", # required
|
5205
5284
|
# logging_config: {
|
@@ -5225,7 +5304,7 @@ module Aws::CloudFormation
|
|
5225
5304
|
|
5226
5305
|
# When specifying `RollbackStack`, you preserve the state of previously
|
5227
5306
|
# provisioned resources when an operation fails. You can check the
|
5228
|
-
# status of the stack through the DescribeStacks
|
5307
|
+
# status of the stack through the DescribeStacks operation.
|
5229
5308
|
#
|
5230
5309
|
# Rolls back the specified stack to the last known stable state from
|
5231
5310
|
# `CREATE_FAILED` or `UPDATE_FAILED` stack statuses.
|
@@ -5245,7 +5324,7 @@ module Aws::CloudFormation
|
|
5245
5324
|
# * `IMPORT_ROLLBACK_COMPLETE`
|
5246
5325
|
#
|
5247
5326
|
# @option params [required, String] :stack_name
|
5248
|
-
# The name that
|
5327
|
+
# The name that's associated with the stack.
|
5249
5328
|
#
|
5250
5329
|
# @option params [String] :role_arn
|
5251
5330
|
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
@@ -5286,7 +5365,7 @@ module Aws::CloudFormation
|
|
5286
5365
|
#
|
5287
5366
|
# @option params [String] :stack_policy_body
|
5288
5367
|
# Structure containing the stack policy body. For more information, go
|
5289
|
-
# to [ Prevent
|
5368
|
+
# to [ Prevent updates to stack resources][1] in the CloudFormation User
|
5290
5369
|
# Guide. You can specify either the `StackPolicyBody` or the
|
5291
5370
|
# `StackPolicyURL` parameter, but not both.
|
5292
5371
|
#
|
@@ -5296,9 +5375,9 @@ module Aws::CloudFormation
|
|
5296
5375
|
#
|
5297
5376
|
# @option params [String] :stack_policy_url
|
5298
5377
|
# 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.
|
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.
|
5302
5381
|
#
|
5303
5382
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5304
5383
|
#
|
@@ -5328,7 +5407,7 @@ module Aws::CloudFormation
|
|
5328
5407
|
# For more information, see [Configuring extensions at the account
|
5329
5408
|
# level][1] in the *CloudFormation User Guide*.
|
5330
5409
|
#
|
5331
|
-
# It
|
5410
|
+
# It's strongly recommended that you use dynamic references to restrict
|
5332
5411
|
# sensitive configuration definitions, such as third-party credentials.
|
5333
5412
|
# For more details on dynamic references, see [Using dynamic references
|
5334
5413
|
# to specify template values][2] in the *CloudFormation User Guide*.
|
@@ -5398,7 +5477,7 @@ module Aws::CloudFormation
|
|
5398
5477
|
# configuration: "TypeConfiguration", # required
|
5399
5478
|
# configuration_alias: "TypeConfigurationAlias",
|
5400
5479
|
# type_name: "TypeName",
|
5401
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5480
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5402
5481
|
# })
|
5403
5482
|
#
|
5404
5483
|
# @example Response structure
|
@@ -5444,7 +5523,7 @@ module Aws::CloudFormation
|
|
5444
5523
|
#
|
5445
5524
|
# resp = client.set_type_default_version({
|
5446
5525
|
# arn: "PrivateTypeArn",
|
5447
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5526
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5448
5527
|
# type_name: "TypeName",
|
5449
5528
|
# version_id: "TypeVersionId",
|
5450
5529
|
# })
|
@@ -5459,12 +5538,12 @@ module Aws::CloudFormation
|
|
5459
5538
|
end
|
5460
5539
|
|
5461
5540
|
# 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.
|
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.
|
5468
5547
|
#
|
5469
5548
|
# @option params [required, String] :stack_name
|
5470
5549
|
# The stack name or unique stack ID that includes the resource that you
|
@@ -5507,7 +5586,8 @@ module Aws::CloudFormation
|
|
5507
5586
|
end
|
5508
5587
|
|
5509
5588
|
# Stops an in-progress operation on a stack set and its associated stack
|
5510
|
-
# instances.
|
5589
|
+
# instances. StackSets will cancel all the unstarted stack instance
|
5590
|
+
# deployments and wait for those are in-progress to complete.
|
5511
5591
|
#
|
5512
5592
|
# @option params [required, String] :stack_set_name
|
5513
5593
|
# The name or unique ID of the stack set that you want to stop the
|
@@ -5569,7 +5649,7 @@ module Aws::CloudFormation
|
|
5569
5649
|
# For more information, see [Testing your public extension prior to
|
5570
5650
|
# publishing][1] in the *CloudFormation CLI User Guide*.
|
5571
5651
|
#
|
5572
|
-
# If you
|
5652
|
+
# If you don't specify a version, CloudFormation uses the default
|
5573
5653
|
# version of the extension in your account and region for testing.
|
5574
5654
|
#
|
5575
5655
|
# To perform testing, CloudFormation assumes the execution role
|
@@ -5592,7 +5672,7 @@ module Aws::CloudFormation
|
|
5592
5672
|
# [3]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
|
5593
5673
|
#
|
5594
5674
|
# @option params [String] :arn
|
5595
|
-
# The Amazon Resource
|
5675
|
+
# The Amazon Resource Name (ARN) of the extension.
|
5596
5676
|
#
|
5597
5677
|
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5598
5678
|
#
|
@@ -5612,7 +5692,7 @@ module Aws::CloudFormation
|
|
5612
5692
|
# You can specify the version id with either `Arn`, or with `TypeName`
|
5613
5693
|
# and `Type`.
|
5614
5694
|
#
|
5615
|
-
# If you
|
5695
|
+
# If you don't specify a version, CloudFormation uses the default
|
5616
5696
|
# version of the extension in this account and region for testing.
|
5617
5697
|
#
|
5618
5698
|
# @option params [String] :log_delivery_bucket
|
@@ -5627,9 +5707,9 @@ module Aws::CloudFormation
|
|
5627
5707
|
# specified S3 bucket. Specifically, the user needs the following
|
5628
5708
|
# permissions:
|
5629
5709
|
#
|
5630
|
-
# * GetObject
|
5710
|
+
# * `GetObject`
|
5631
5711
|
#
|
5632
|
-
# * PutObject
|
5712
|
+
# * `PutObject`
|
5633
5713
|
#
|
5634
5714
|
# For more information, see [Actions, Resources, and Condition Keys for
|
5635
5715
|
# Amazon S3][1] in the *Amazon Web Services Identity and Access
|
@@ -5647,7 +5727,7 @@ module Aws::CloudFormation
|
|
5647
5727
|
#
|
5648
5728
|
# resp = client.test_type({
|
5649
5729
|
# arn: "TypeArn",
|
5650
|
-
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5730
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
|
5651
5731
|
# type_name: "TypeName",
|
5652
5732
|
# version_id: "TypeVersionId",
|
5653
5733
|
# log_delivery_bucket: "S3Bucket",
|
@@ -5668,7 +5748,7 @@ module Aws::CloudFormation
|
|
5668
5748
|
|
5669
5749
|
# Updates a stack as specified in the template. After the call completes
|
5670
5750
|
# successfully, the stack update starts. You can check the status of the
|
5671
|
-
# stack
|
5751
|
+
# stack through the DescribeStacks action.
|
5672
5752
|
#
|
5673
5753
|
# To get a copy of the template for an existing stack, you can use the
|
5674
5754
|
# GetTemplate action.
|
@@ -5699,7 +5779,7 @@ module Aws::CloudFormation
|
|
5699
5779
|
#
|
5700
5780
|
# @option params [String] :template_url
|
5701
5781
|
# Location of file containing the template body. The URL must point to a
|
5702
|
-
# template that
|
5782
|
+
# template that's located in an Amazon S3 bucket or a Systems Manager
|
5703
5783
|
# document. For more information, go to [Template Anatomy][1] in the
|
5704
5784
|
# CloudFormation User Guide.
|
5705
5785
|
#
|
@@ -5781,7 +5861,7 @@ module Aws::CloudFormation
|
|
5781
5861
|
#
|
5782
5862
|
# * [ AWS::IAM::Group][2]
|
5783
5863
|
#
|
5784
|
-
# * [
|
5864
|
+
# * [AWS::IAM::InstanceProfile][3]
|
5785
5865
|
#
|
5786
5866
|
# * [ AWS::IAM::Policy][4]
|
5787
5867
|
#
|
@@ -5789,7 +5869,7 @@ module Aws::CloudFormation
|
|
5789
5869
|
#
|
5790
5870
|
# * [ AWS::IAM::User][6]
|
5791
5871
|
#
|
5792
|
-
# * [
|
5872
|
+
# * [AWS::IAM::UserToGroupAddition][7]
|
5793
5873
|
#
|
5794
5874
|
# For more information, see [Acknowledging IAM Resources in
|
5795
5875
|
# CloudFormation Templates][8].
|
@@ -5859,7 +5939,7 @@ module Aws::CloudFormation
|
|
5859
5939
|
# (IAM) role that CloudFormation assumes to update the stack.
|
5860
5940
|
# CloudFormation uses the role's credentials to make calls on your
|
5861
5941
|
# behalf. CloudFormation always uses this role for all future operations
|
5862
|
-
# on the stack.
|
5942
|
+
# on the stack. Provided that users have permission to operate on the
|
5863
5943
|
# stack, CloudFormation uses this role even if the users don't have
|
5864
5944
|
# permission to pass it. Ensure that the role grants least privilege.
|
5865
5945
|
#
|
@@ -5878,7 +5958,7 @@ module Aws::CloudFormation
|
|
5878
5958
|
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
|
5879
5959
|
#
|
5880
5960
|
# 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
|
5961
|
+
# new resource that you created during a stack update. If you don't
|
5882
5962
|
# specify a stack policy, the current policy that is associated with the
|
5883
5963
|
# stack is unchanged.
|
5884
5964
|
#
|
@@ -5889,7 +5969,7 @@ module Aws::CloudFormation
|
|
5889
5969
|
# the `StackPolicyURL` parameter, but not both.
|
5890
5970
|
#
|
5891
5971
|
# 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
|
5972
|
+
# new resource that you created during a stack update. If you don't
|
5893
5973
|
# specify a stack policy, the current policy that is associated with the
|
5894
5974
|
# stack is unchanged.
|
5895
5975
|
#
|
@@ -5994,15 +6074,15 @@ module Aws::CloudFormation
|
|
5994
6074
|
end
|
5995
6075
|
|
5996
6076
|
# 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.
|
6077
|
+
# accounts, within the specified Amazon Web Services Regions. A stack
|
6078
|
+
# instance refers to a stack in a specific account and Region.
|
5999
6079
|
#
|
6000
|
-
# You can only update stack instances in
|
6001
|
-
# already exist; to create additional stack
|
6002
|
-
# [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].
|
6003
6083
|
#
|
6004
6084
|
# During stack set updates, any parameters overridden for a stack
|
6005
|
-
# instance
|
6085
|
+
# instance aren't updated, but retain their overridden value.
|
6006
6086
|
#
|
6007
6087
|
# You can only update the parameter *values* that are specified in the
|
6008
6088
|
# stack set; to add or delete a parameter itself, use
|
@@ -6027,7 +6107,8 @@ module Aws::CloudFormation
|
|
6027
6107
|
# \[Self-managed permissions\] The names of one or more Amazon Web
|
6028
6108
|
# Services accounts for which you want to update parameter values for
|
6029
6109
|
# stack instances. The overridden parameter values will be applied to
|
6030
|
-
# all stack instances in the specified accounts and
|
6110
|
+
# all stack instances in the specified accounts and Amazon Web Services
|
6111
|
+
# Regions.
|
6031
6112
|
#
|
6032
6113
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6033
6114
|
#
|
@@ -6042,35 +6123,36 @@ module Aws::CloudFormation
|
|
6042
6123
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
6043
6124
|
#
|
6044
6125
|
# @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
|
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.
|
6048
6130
|
#
|
6049
6131
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
6050
6132
|
# A list of input parameters whose values you want to update for the
|
6051
6133
|
# specified stack instances.
|
6052
6134
|
#
|
6053
6135
|
# 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:
|
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:
|
6057
6139
|
#
|
6058
6140
|
# * To override the current value for a parameter, include the parameter
|
6059
6141
|
# and specify its value.
|
6060
6142
|
#
|
6061
6143
|
# * To leave an overridden parameter set to its present value, include
|
6062
|
-
# the parameter and specify `UsePreviousValue` as `true`. (You
|
6144
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You can't
|
6063
6145
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
6064
6146
|
#
|
6065
6147
|
# * To set an overridden parameter back to the value specified in the
|
6066
|
-
# stack set, specify a parameter list but
|
6148
|
+
# stack set, specify a parameter list but don't include the parameter
|
6067
6149
|
# in the list.
|
6068
6150
|
#
|
6069
|
-
# * To leave all parameters set to their present values,
|
6151
|
+
# * To leave all parameters set to their present values, don't specify
|
6070
6152
|
# this property at all.
|
6071
6153
|
#
|
6072
6154
|
# During stack set updates, any parameter values overridden for a stack
|
6073
|
-
# instance
|
6155
|
+
# instance aren't updated, but retain their overridden value.
|
6074
6156
|
#
|
6075
6157
|
# You can only override the parameter *values* that are specified in the
|
6076
6158
|
# stack set; to add or delete a parameter itself, use `UpdateStackSet`
|
@@ -6175,7 +6257,7 @@ module Aws::CloudFormation
|
|
6175
6257
|
end
|
6176
6258
|
|
6177
6259
|
# Updates the stack set, and associated stack instances in the specified
|
6178
|
-
# accounts and Regions.
|
6260
|
+
# accounts and Amazon Web Services Regions.
|
6179
6261
|
#
|
6180
6262
|
# Even if the stack set operation created by updating the stack set
|
6181
6263
|
# fails (completely or partially, below or above a specified failure
|
@@ -6316,7 +6398,7 @@ module Aws::CloudFormation
|
|
6316
6398
|
#
|
6317
6399
|
# * If you specify *any* tags using this parameter, you must specify
|
6318
6400
|
# *all* the tags that you want associated with this stack set, even
|
6319
|
-
# tags you've
|
6401
|
+
# tags you've specified before (for example, when creating the stack
|
6320
6402
|
# set or during a previous update of the stack set.). Any tags that
|
6321
6403
|
# you don't include in the updated list of tags are removed from the
|
6322
6404
|
# stack set, and therefore from the stacks and resources as well.
|
@@ -6382,10 +6464,10 @@ module Aws::CloudFormation
|
|
6382
6464
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
6383
6465
|
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
6384
6466
|
# 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.
|
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.
|
6389
6471
|
#
|
6390
6472
|
# @option params [String] :permission_model
|
6391
6473
|
# Describes how the IAM roles required for stack set operations are
|
@@ -6411,7 +6493,7 @@ module Aws::CloudFormation
|
|
6411
6493
|
# automatically deploys to Organizations accounts that are added to a
|
6412
6494
|
# target organization or organizational unit (OU).
|
6413
6495
|
#
|
6414
|
-
# If you specify `AutoDeployment`,
|
6496
|
+
# If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
|
6415
6497
|
# `Regions`.
|
6416
6498
|
#
|
6417
6499
|
# @option params [String] :operation_id
|
@@ -6435,25 +6517,26 @@ module Aws::CloudFormation
|
|
6435
6517
|
# @option params [Array<String>] :accounts
|
6436
6518
|
# \[Self-managed permissions\] The accounts in which to update
|
6437
6519
|
# associated stack instances. If you specify accounts, you must also
|
6438
|
-
# specify the Regions in which to update stack set
|
6520
|
+
# specify the Amazon Web Services Regions in which to update stack set
|
6521
|
+
# instances.
|
6439
6522
|
#
|
6440
|
-
# To update *all* the stack instances associated with this stack set,
|
6441
|
-
#
|
6523
|
+
# To update *all* the stack instances associated with this stack set,
|
6524
|
+
# don't specify the `Accounts` or `Regions` properties.
|
6442
6525
|
#
|
6443
6526
|
# If the stack set update includes changes to the template (that is, if
|
6444
6527
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
6445
6528
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
6446
6529
|
# 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.
|
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.
|
6452
6535
|
#
|
6453
6536
|
# @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.
|
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.
|
6457
6540
|
#
|
6458
6541
|
# To update *all* the stack instances associated with this stack set, do
|
6459
6542
|
# not specify the `Accounts` or `Regions` properties.
|
@@ -6570,7 +6653,7 @@ module Aws::CloudFormation
|
|
6570
6653
|
# User Guide*.
|
6571
6654
|
#
|
6572
6655
|
# For [nested stacks][2], termination protection is set on the root
|
6573
|
-
# stack and
|
6656
|
+
# stack and can't be changed directly on the nested stack.
|
6574
6657
|
#
|
6575
6658
|
#
|
6576
6659
|
#
|
@@ -6689,7 +6772,7 @@ module Aws::CloudFormation
|
|
6689
6772
|
params: params,
|
6690
6773
|
config: config)
|
6691
6774
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
6692
|
-
context[:gem_version] = '1.
|
6775
|
+
context[:gem_version] = '1.66.0'
|
6693
6776
|
Seahorse::Client::Request.new(handlers, context)
|
6694
6777
|
end
|
6695
6778
|
|