aws-sdk-cloudformation 1.134.0 → 1.150.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 +80 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +775 -454
- data/lib/aws-sdk-cloudformation/client_api.rb +195 -3
- data/lib/aws-sdk-cloudformation/customizations.rb +0 -8
- data/lib/aws-sdk-cloudformation/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-cloudformation/errors.rb +0 -1
- data/lib/aws-sdk-cloudformation/event.rb +19 -6
- data/lib/aws-sdk-cloudformation/resource.rb +12 -11
- data/lib/aws-sdk-cloudformation/stack.rb +33 -17
- data/lib/aws-sdk-cloudformation/types.rb +1374 -692
- data/lib/aws-sdk-cloudformation.rb +1 -1
- data/sig/client.rbs +60 -10
- data/sig/event.rbs +6 -0
- data/sig/resource.rbs +1 -0
- data/sig/stack.rbs +3 -0
- data/sig/types.rbs +146 -11
- metadata +3 -3
|
@@ -95,8 +95,8 @@ module Aws::CloudFormation
|
|
|
95
95
|
# class name or an instance of a plugin class.
|
|
96
96
|
#
|
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
|
98
|
-
# Your AWS credentials. This can be
|
|
99
|
-
# following classes:
|
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
|
100
100
|
#
|
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
102
102
|
# credentials.
|
|
@@ -124,22 +124,24 @@ module Aws::CloudFormation
|
|
|
124
124
|
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
|
125
125
|
# from the Cognito Identity service.
|
|
126
126
|
#
|
|
127
|
-
# When `:credentials` are not configured directly, the following
|
|
128
|
-
# locations will be searched for credentials:
|
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
|
129
128
|
#
|
|
130
129
|
# * `Aws.config[:credentials]`
|
|
130
|
+
#
|
|
131
131
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
132
132
|
# `:account_id` options.
|
|
133
|
-
#
|
|
134
|
-
#
|
|
133
|
+
#
|
|
134
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
135
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
136
|
+
#
|
|
135
137
|
# * `~/.aws/credentials`
|
|
138
|
+
#
|
|
136
139
|
# * `~/.aws/config`
|
|
137
|
-
#
|
|
138
|
-
#
|
|
139
|
-
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
140
|
-
# enable retries and extended timeouts. Instance profile credential
|
|
141
|
-
#
|
|
142
|
-
# to true.
|
|
140
|
+
#
|
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
143
145
|
#
|
|
144
146
|
# @option options [required, String] :region
|
|
145
147
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -167,6 +169,11 @@ module Aws::CloudFormation
|
|
|
167
169
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
168
170
|
# not retry instead of sleeping.
|
|
169
171
|
#
|
|
172
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
173
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
174
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
175
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
176
|
+
#
|
|
170
177
|
# @option options [Boolean] :client_side_monitoring (false)
|
|
171
178
|
# When `true`, client-side metrics will be collected for all API requests from
|
|
172
179
|
# this client.
|
|
@@ -253,8 +260,8 @@ module Aws::CloudFormation
|
|
|
253
260
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
254
261
|
#
|
|
255
262
|
# @option options [String] :profile ("default")
|
|
256
|
-
# Used when loading credentials from the shared credentials file
|
|
257
|
-
#
|
|
263
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
264
|
+
# When not specified, 'default' is used.
|
|
258
265
|
#
|
|
259
266
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
260
267
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
@@ -367,8 +374,8 @@ module Aws::CloudFormation
|
|
|
367
374
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
368
375
|
#
|
|
369
376
|
# @option options [Aws::TokenProvider] :token_provider
|
|
370
|
-
#
|
|
371
|
-
# following classes:
|
|
377
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
378
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
372
379
|
#
|
|
373
380
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
374
381
|
# tokens.
|
|
@@ -484,17 +491,30 @@ module Aws::CloudFormation
|
|
|
484
491
|
req.send_request(options)
|
|
485
492
|
end
|
|
486
493
|
|
|
487
|
-
# Activates a public third-party extension,
|
|
488
|
-
#
|
|
489
|
-
#
|
|
490
|
-
#
|
|
491
|
-
#
|
|
492
|
-
#
|
|
494
|
+
# Activates a public third-party extension, such as a resource or
|
|
495
|
+
# module, to make it available for use in stack templates in your
|
|
496
|
+
# current account and Region. It can also create CloudFormation Hooks,
|
|
497
|
+
# which allow you to evaluate resource configurations before
|
|
498
|
+
# CloudFormation provisions them. Hooks integrate with both
|
|
499
|
+
# CloudFormation and Cloud Control API operations.
|
|
500
|
+
#
|
|
501
|
+
# After you activate an extension, you can use [SetTypeConfiguration][1]
|
|
502
|
+
# to set specific properties for the extension.
|
|
503
|
+
#
|
|
504
|
+
# To see which extensions have been activated, use [ListTypes][2]. To
|
|
505
|
+
# see configuration details for an extension, use [DescribeType][3].
|
|
506
|
+
#
|
|
507
|
+
# For more information, see [Activate a third-party public extension in
|
|
508
|
+
# your account][4] in the *CloudFormation User Guide*. For information
|
|
509
|
+
# about creating Hooks, see the [CloudFormation Hooks User Guide][5].
|
|
493
510
|
#
|
|
494
511
|
#
|
|
495
512
|
#
|
|
496
513
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
|
|
497
|
-
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/
|
|
514
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html
|
|
515
|
+
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
|
516
|
+
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public-activate-extension.html
|
|
517
|
+
# [5]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html
|
|
498
518
|
#
|
|
499
519
|
# @option params [String] :type
|
|
500
520
|
# The extension type.
|
|
@@ -521,11 +541,11 @@ module Aws::CloudFormation
|
|
|
521
541
|
# and `PublisherId`.
|
|
522
542
|
#
|
|
523
543
|
# @option params [String] :type_name_alias
|
|
524
|
-
# An alias to assign to the public extension
|
|
525
|
-
#
|
|
526
|
-
#
|
|
527
|
-
#
|
|
528
|
-
#
|
|
544
|
+
# An alias to assign to the public extension in this account and Region.
|
|
545
|
+
# If you specify an alias for the extension, CloudFormation treats the
|
|
546
|
+
# alias as the extension type name within this account and Region. You
|
|
547
|
+
# must use the alias to refer to the extension in your templates, API
|
|
548
|
+
# calls, and CloudFormation console.
|
|
529
549
|
#
|
|
530
550
|
# An extension alias must be unique within a given account and Region.
|
|
531
551
|
# You can activate the same public resource multiple times in the same
|
|
@@ -600,8 +620,8 @@ module Aws::CloudFormation
|
|
|
600
620
|
end
|
|
601
621
|
|
|
602
622
|
# Returns configuration data for the specified CloudFormation
|
|
603
|
-
# extensions, from the CloudFormation registry
|
|
604
|
-
# Region.
|
|
623
|
+
# extensions, from the CloudFormation registry in your current account
|
|
624
|
+
# and Region.
|
|
605
625
|
#
|
|
606
626
|
# For more information, see [Edit configuration data for extensions in
|
|
607
627
|
# your account][1] in the *CloudFormation User Guide*.
|
|
@@ -716,25 +736,29 @@ module Aws::CloudFormation
|
|
|
716
736
|
req.send_request(options)
|
|
717
737
|
end
|
|
718
738
|
|
|
719
|
-
#
|
|
720
|
-
#
|
|
721
|
-
#
|
|
722
|
-
#
|
|
723
|
-
#
|
|
724
|
-
#
|
|
725
|
-
#
|
|
739
|
+
# Continues rolling back a stack from `UPDATE_ROLLBACK_FAILED` to
|
|
740
|
+
# `UPDATE_ROLLBACK_COMPLETE` state. Depending on the cause of the
|
|
741
|
+
# failure, you can manually fix the error and continue the rollback. By
|
|
742
|
+
# continuing the rollback, you can return your stack to a working state
|
|
743
|
+
# (the `UPDATE_ROLLBACK_COMPLETE` state) and then try to update the
|
|
744
|
+
# stack again.
|
|
745
|
+
#
|
|
746
|
+
# A stack enters the `UPDATE_ROLLBACK_FAILED` state when CloudFormation
|
|
747
|
+
# can't roll back all changes after a failed stack update. For example,
|
|
748
|
+
# this might occur when a stack attempts to roll back to an old database
|
|
749
|
+
# that was deleted outside of CloudFormation. Because CloudFormation
|
|
750
|
+
# doesn't know the instance was deleted, it assumes the instance still
|
|
751
|
+
# exists and attempts to roll back to it, causing the update rollback to
|
|
752
|
+
# fail.
|
|
726
753
|
#
|
|
727
|
-
#
|
|
728
|
-
# CloudFormation
|
|
729
|
-
# update
|
|
730
|
-
# old database instance that was deleted outside of CloudFormation.
|
|
731
|
-
# Because CloudFormation doesn't know the database was deleted, it
|
|
732
|
-
# assumes that the database instance still exists and attempts to roll
|
|
733
|
-
# back to it, causing the update rollback to fail.
|
|
754
|
+
# For more information, see [Continue rolling back an update][1] in the
|
|
755
|
+
# *CloudFormation User Guide*. For information for troubleshooting a
|
|
756
|
+
# failed update rollback, see [Update rollback failed][2].
|
|
734
757
|
#
|
|
735
758
|
#
|
|
736
759
|
#
|
|
737
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
|
760
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html
|
|
761
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed
|
|
738
762
|
#
|
|
739
763
|
# @option params [required, String] :stack_name
|
|
740
764
|
# The name or the unique ID of the stack that you want to continue
|
|
@@ -872,7 +896,9 @@ module Aws::CloudFormation
|
|
|
872
896
|
# CloudFormation generates the change set by comparing this template
|
|
873
897
|
# with the template of the stack that you specified.
|
|
874
898
|
#
|
|
875
|
-
# Conditional: You must specify only
|
|
899
|
+
# Conditional: You must specify only one of the following parameters:
|
|
900
|
+
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
|
901
|
+
# `true`.
|
|
876
902
|
#
|
|
877
903
|
# @option params [String] :template_url
|
|
878
904
|
# The URL of the file that contains the revised template. The URL must
|
|
@@ -882,12 +908,28 @@ module Aws::CloudFormation
|
|
|
882
908
|
# specified. The location for an Amazon S3 bucket must start with
|
|
883
909
|
# `https://`. URLs from S3 static websites are not supported.
|
|
884
910
|
#
|
|
885
|
-
# Conditional: You must specify only
|
|
911
|
+
# Conditional: You must specify only one of the following parameters:
|
|
912
|
+
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
|
913
|
+
# `true`.
|
|
886
914
|
#
|
|
887
915
|
# @option params [Boolean] :use_previous_template
|
|
888
916
|
# Whether to reuse the template that's associated with the stack to
|
|
889
917
|
# create the change set.
|
|
890
918
|
#
|
|
919
|
+
# When using templates with the `AWS::LanguageExtensions` transform,
|
|
920
|
+
# provide the template instead of using `UsePreviousTemplate` to ensure
|
|
921
|
+
# new parameter values and Systems Manager parameter updates are applied
|
|
922
|
+
# correctly. For more information, see [AWS::LanguageExtensions
|
|
923
|
+
# transform][1].
|
|
924
|
+
#
|
|
925
|
+
# Conditional: You must specify only one of the following parameters:
|
|
926
|
+
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
|
927
|
+
# `true`.
|
|
928
|
+
#
|
|
929
|
+
#
|
|
930
|
+
#
|
|
931
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/transform-aws-languageextensions.html
|
|
932
|
+
#
|
|
891
933
|
# @option params [Array<Types::Parameter>] :parameters
|
|
892
934
|
# A list of `Parameter` structures that specify input parameters for the
|
|
893
935
|
# change set. For more information, see the Parameter data type.
|
|
@@ -900,7 +942,7 @@ module Aws::CloudFormation
|
|
|
900
942
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
901
943
|
#
|
|
902
944
|
# Some stack templates might include resources that can affect
|
|
903
|
-
# permissions in your Amazon Web Services account
|
|
945
|
+
# permissions in your Amazon Web Services account, for example, by
|
|
904
946
|
# creating new IAM users. For those stacks, you must explicitly
|
|
905
947
|
# acknowledge this by specifying one of these capabilities.
|
|
906
948
|
#
|
|
@@ -985,16 +1027,15 @@ module Aws::CloudFormation
|
|
|
985
1027
|
# [12]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
|
986
1028
|
#
|
|
987
1029
|
# @option params [Array<String>] :resource_types
|
|
988
|
-
#
|
|
989
|
-
#
|
|
990
|
-
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
|
1030
|
+
# Specifies which resource types you can work with, such as
|
|
1031
|
+
# `AWS::EC2::Instance` or `Custom::MyCustomInstance`.
|
|
991
1032
|
#
|
|
992
1033
|
# If the list of resource types doesn't include a resource type that
|
|
993
1034
|
# you're updating, the stack update fails. By default, CloudFormation
|
|
994
1035
|
# grants permissions to all resource types. IAM uses this parameter for
|
|
995
1036
|
# condition keys in IAM policies for CloudFormation. For more
|
|
996
|
-
# information, see [Control access with Identity and
|
|
997
|
-
# Management][1] in the *CloudFormation User Guide*.
|
|
1037
|
+
# information, see [Control CloudFormation access with Identity and
|
|
1038
|
+
# Access Management][1] in the *CloudFormation User Guide*.
|
|
998
1039
|
#
|
|
999
1040
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
|
1000
1041
|
# specified.
|
|
@@ -1122,6 +1163,24 @@ module Aws::CloudFormation
|
|
|
1122
1163
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/import-resources-automatically.html
|
|
1123
1164
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-name.html
|
|
1124
1165
|
#
|
|
1166
|
+
# @option params [String] :deployment_mode
|
|
1167
|
+
# Determines how CloudFormation handles configuration drift during
|
|
1168
|
+
# deployment.
|
|
1169
|
+
#
|
|
1170
|
+
# * `REVERT_DRIFT` – Creates a drift-aware change set that brings actual
|
|
1171
|
+
# resource states in line with template definitions. Provides a
|
|
1172
|
+
# three-way comparison between actual state, previous deployment
|
|
1173
|
+
# state, and desired state.
|
|
1174
|
+
#
|
|
1175
|
+
# ^
|
|
1176
|
+
#
|
|
1177
|
+
# For more information, see [Using drift-aware change sets][1] in the
|
|
1178
|
+
# *CloudFormation User Guide*.
|
|
1179
|
+
#
|
|
1180
|
+
#
|
|
1181
|
+
#
|
|
1182
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/drift-aware-change-sets.html
|
|
1183
|
+
#
|
|
1125
1184
|
# @return [Types::CreateChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1126
1185
|
#
|
|
1127
1186
|
# * {Types::CreateChangeSetOutput#id #id} => String
|
|
@@ -1177,6 +1236,7 @@ module Aws::CloudFormation
|
|
|
1177
1236
|
# include_nested_stacks: false,
|
|
1178
1237
|
# on_stack_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
|
|
1179
1238
|
# import_existing_resources: false,
|
|
1239
|
+
# deployment_mode: "REVERT_DRIFT", # accepts REVERT_DRIFT
|
|
1180
1240
|
# })
|
|
1181
1241
|
#
|
|
1182
1242
|
# @example Response structure
|
|
@@ -1445,22 +1505,15 @@ module Aws::CloudFormation
|
|
|
1445
1505
|
# [12]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
|
1446
1506
|
#
|
|
1447
1507
|
# @option params [Array<String>] :resource_types
|
|
1448
|
-
#
|
|
1449
|
-
#
|
|
1450
|
-
# or `Custom::MyCustomInstance`. Use the following syntax to describe
|
|
1451
|
-
# template resource types: `AWS::*` (for all Amazon Web Services
|
|
1452
|
-
# resources), `Custom::*` (for all custom resources),
|
|
1453
|
-
# `Custom::logical_ID ` (for a specific custom resource),
|
|
1454
|
-
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
|
1455
|
-
# Services service), and `AWS::service_name::resource_logical_ID ` (for
|
|
1456
|
-
# a specific Amazon Web Services resource).
|
|
1508
|
+
# Specifies which resource types you can work with, such as
|
|
1509
|
+
# `AWS::EC2::Instance` or `Custom::MyCustomInstance`.
|
|
1457
1510
|
#
|
|
1458
1511
|
# If the list of resource types doesn't include a resource that you're
|
|
1459
1512
|
# creating, the stack creation fails. By default, CloudFormation grants
|
|
1460
1513
|
# permissions to all resource types. IAM uses this parameter for
|
|
1461
1514
|
# CloudFormation-specific condition keys in IAM policies. For more
|
|
1462
|
-
# information, see [Control access with Identity and
|
|
1463
|
-
# Management][1].
|
|
1515
|
+
# information, see [Control CloudFormation access with Identity and
|
|
1516
|
+
# Access Management][1].
|
|
1464
1517
|
#
|
|
1465
1518
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
|
1466
1519
|
# specified.
|
|
@@ -1490,6 +1543,14 @@ module Aws::CloudFormation
|
|
|
1490
1543
|
# must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
|
|
1491
1544
|
# either `OnFailure` or `DisableRollback`, but not both.
|
|
1492
1545
|
#
|
|
1546
|
+
# <note markdown="1"> Although the default setting is `ROLLBACK`, there is one exception.
|
|
1547
|
+
# This exception occurs when a StackSet attempts to deploy a stack
|
|
1548
|
+
# instance and the stack instance fails to create successfully. In this
|
|
1549
|
+
# case, the `CreateStack` call overrides the default setting and sets
|
|
1550
|
+
# the value of `OnFailure` to `DELETE`.
|
|
1551
|
+
#
|
|
1552
|
+
# </note>
|
|
1553
|
+
#
|
|
1493
1554
|
# Default: `ROLLBACK`
|
|
1494
1555
|
#
|
|
1495
1556
|
# @option params [String] :stack_policy_body
|
|
@@ -1563,6 +1624,7 @@ module Aws::CloudFormation
|
|
|
1563
1624
|
# @return [Types::CreateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1564
1625
|
#
|
|
1565
1626
|
# * {Types::CreateStackOutput#stack_id #stack_id} => String
|
|
1627
|
+
# * {Types::CreateStackOutput#operation_id #operation_id} => String
|
|
1566
1628
|
#
|
|
1567
1629
|
# @example Request syntax with placeholder values
|
|
1568
1630
|
#
|
|
@@ -1610,6 +1672,7 @@ module Aws::CloudFormation
|
|
|
1610
1672
|
# @example Response structure
|
|
1611
1673
|
#
|
|
1612
1674
|
# resp.stack_id #=> String
|
|
1675
|
+
# resp.operation_id #=> String
|
|
1613
1676
|
#
|
|
1614
1677
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStack AWS API Documentation
|
|
1615
1678
|
#
|
|
@@ -1641,7 +1704,7 @@ module Aws::CloudFormation
|
|
|
1641
1704
|
# </note>
|
|
1642
1705
|
#
|
|
1643
1706
|
# @option params [required, String] :stack_set_name
|
|
1644
|
-
# The name or unique ID of the
|
|
1707
|
+
# The name or unique ID of the StackSet that you want to create stack
|
|
1645
1708
|
# instances from.
|
|
1646
1709
|
#
|
|
1647
1710
|
# @option params [Array<String>] :accounts
|
|
@@ -1652,9 +1715,8 @@ module Aws::CloudFormation
|
|
|
1652
1715
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
1653
1716
|
#
|
|
1654
1717
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
1655
|
-
# \[Service-managed permissions\] The Organizations accounts
|
|
1656
|
-
#
|
|
1657
|
-
# Regions.
|
|
1718
|
+
# \[Service-managed permissions\] The Organizations accounts in which to
|
|
1719
|
+
# create stack instances in the specified Amazon Web Services Regions.
|
|
1658
1720
|
#
|
|
1659
1721
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
1660
1722
|
#
|
|
@@ -1664,8 +1726,8 @@ module Aws::CloudFormation
|
|
|
1664
1726
|
# accounts.
|
|
1665
1727
|
#
|
|
1666
1728
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
|
1667
|
-
# A list of
|
|
1668
|
-
#
|
|
1729
|
+
# A list of StackSet parameters whose values you want to override in the
|
|
1730
|
+
# selected stack instances.
|
|
1669
1731
|
#
|
|
1670
1732
|
# Any overridden parameter values will be applied to all stack instances
|
|
1671
1733
|
# in the specified accounts and Amazon Web Services Regions. When
|
|
@@ -1680,39 +1742,39 @@ module Aws::CloudFormation
|
|
|
1680
1742
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
|
1681
1743
|
#
|
|
1682
1744
|
# * To set an overridden parameter back to the value specified in the
|
|
1683
|
-
#
|
|
1745
|
+
# StackSet, specify a parameter list but don't include the parameter
|
|
1684
1746
|
# in the list.
|
|
1685
1747
|
#
|
|
1686
1748
|
# * To leave all parameters set to their present values, don't specify
|
|
1687
1749
|
# this property at all.
|
|
1688
1750
|
#
|
|
1689
|
-
# During
|
|
1751
|
+
# During StackSet updates, any parameter values overridden for a stack
|
|
1690
1752
|
# instance aren't updated, but retain their overridden value.
|
|
1691
1753
|
#
|
|
1692
1754
|
# You can only override the parameter *values* that are specified in the
|
|
1693
|
-
#
|
|
1694
|
-
#
|
|
1755
|
+
# StackSet; to add or delete a parameter itself, use [UpdateStackSet][1]
|
|
1756
|
+
# to update the StackSet template.
|
|
1695
1757
|
#
|
|
1696
1758
|
#
|
|
1697
1759
|
#
|
|
1698
1760
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
|
1699
1761
|
#
|
|
1700
1762
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
1701
|
-
# Preferences for how CloudFormation performs this
|
|
1763
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
|
1702
1764
|
#
|
|
1703
1765
|
# @option params [String] :operation_id
|
|
1704
|
-
# The unique identifier for this
|
|
1766
|
+
# The unique identifier for this StackSet operation.
|
|
1705
1767
|
#
|
|
1706
1768
|
# The operation ID also functions as an idempotency token, to ensure
|
|
1707
|
-
# that CloudFormation performs the
|
|
1708
|
-
#
|
|
1769
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
|
1770
|
+
# you retry the request multiple times. You might retry StackSet
|
|
1709
1771
|
# operation requests to ensure that CloudFormation successfully received
|
|
1710
1772
|
# them.
|
|
1711
1773
|
#
|
|
1712
1774
|
# If you don't specify an operation ID, the SDK generates one
|
|
1713
1775
|
# automatically.
|
|
1714
1776
|
#
|
|
1715
|
-
# Repeating this
|
|
1777
|
+
# Repeating this StackSet operation with a new operation ID retries all
|
|
1716
1778
|
# stack instances whose status is `OUTDATED`.
|
|
1717
1779
|
#
|
|
1718
1780
|
# **A suitable default value is auto-generated.** You should normally
|
|
@@ -1723,7 +1785,7 @@ module Aws::CloudFormation
|
|
|
1723
1785
|
# account administrator in the organization's management account or as
|
|
1724
1786
|
# a delegated administrator in a member account.
|
|
1725
1787
|
#
|
|
1726
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
1788
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
1727
1789
|
# self-managed permissions.
|
|
1728
1790
|
#
|
|
1729
1791
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -1849,11 +1911,11 @@ module Aws::CloudFormation
|
|
|
1849
1911
|
req.send_request(options)
|
|
1850
1912
|
end
|
|
1851
1913
|
|
|
1852
|
-
# Creates a
|
|
1914
|
+
# Creates a StackSet.
|
|
1853
1915
|
#
|
|
1854
1916
|
# @option params [required, String] :stack_set_name
|
|
1855
|
-
# The name to associate with the
|
|
1856
|
-
# the Region where you create your
|
|
1917
|
+
# The name to associate with the StackSet. The name must be unique in
|
|
1918
|
+
# the Region where you create your StackSet.
|
|
1857
1919
|
#
|
|
1858
1920
|
# <note markdown="1"> A stack name can contain only alphanumeric characters (case-sensitive)
|
|
1859
1921
|
# and hyphens. It must start with an alphabetic character and can't be
|
|
@@ -1862,8 +1924,8 @@ module Aws::CloudFormation
|
|
|
1862
1924
|
# </note>
|
|
1863
1925
|
#
|
|
1864
1926
|
# @option params [String] :description
|
|
1865
|
-
# A description of the
|
|
1866
|
-
#
|
|
1927
|
+
# A description of the StackSet. You can use the description to identify
|
|
1928
|
+
# the StackSet's purpose or other important information.
|
|
1867
1929
|
#
|
|
1868
1930
|
# @option params [String] :template_body
|
|
1869
1931
|
# The structure that contains the template body, with a minimum length
|
|
@@ -1883,22 +1945,22 @@ module Aws::CloudFormation
|
|
|
1883
1945
|
# `TemplateURL` parameter, but not both.
|
|
1884
1946
|
#
|
|
1885
1947
|
# @option params [String] :stack_id
|
|
1886
|
-
# The stack ID you are importing into a new
|
|
1887
|
-
#
|
|
1948
|
+
# The stack ID you are importing into a new StackSet. Specify the Amazon
|
|
1949
|
+
# Resource Name (ARN) of the stack.
|
|
1888
1950
|
#
|
|
1889
1951
|
# @option params [Array<Types::Parameter>] :parameters
|
|
1890
|
-
# The input parameters for the
|
|
1952
|
+
# The input parameters for the StackSet template.
|
|
1891
1953
|
#
|
|
1892
1954
|
# @option params [Array<String>] :capabilities
|
|
1893
|
-
# In some cases, you must explicitly acknowledge that your
|
|
1955
|
+
# In some cases, you must explicitly acknowledge that your StackSet
|
|
1894
1956
|
# template contains certain capabilities in order for CloudFormation to
|
|
1895
|
-
# create the
|
|
1957
|
+
# create the StackSet and related stack instances.
|
|
1896
1958
|
#
|
|
1897
1959
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
1898
1960
|
#
|
|
1899
1961
|
# Some stack templates might include resources that can affect
|
|
1900
1962
|
# permissions in your Amazon Web Services account; for example, by
|
|
1901
|
-
# creating new IAM users. For those
|
|
1963
|
+
# creating new IAM users. For those StackSets, you must explicitly
|
|
1902
1964
|
# acknowledge this by specifying one of these capabilities.
|
|
1903
1965
|
#
|
|
1904
1966
|
# The following IAM resources require you to specify either the
|
|
@@ -1933,21 +1995,20 @@ module Aws::CloudFormation
|
|
|
1933
1995
|
#
|
|
1934
1996
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
1935
1997
|
#
|
|
1936
|
-
# Some templates reference macros. If your
|
|
1937
|
-
# references one or more macros, you must create the
|
|
1938
|
-
#
|
|
1939
|
-
#
|
|
1940
|
-
#
|
|
1941
|
-
#
|
|
1998
|
+
# Some templates reference macros. If your StackSet template
|
|
1999
|
+
# references one or more macros, you must create the StackSet directly
|
|
2000
|
+
# from the processed template, without first reviewing the resulting
|
|
2001
|
+
# changes in a change set. To create the StackSet directly, you must
|
|
2002
|
+
# acknowledge this capability. For more information, see [Perform
|
|
2003
|
+
# custom processing on CloudFormation templates with template
|
|
1942
2004
|
# macros][9].
|
|
1943
2005
|
#
|
|
1944
|
-
#
|
|
2006
|
+
# StackSets with service-managed permissions don't currently support
|
|
1945
2007
|
# the use of macros in templates. (This includes the
|
|
1946
2008
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
|
1947
2009
|
# macros hosted by CloudFormation.) Even if you specify this
|
|
1948
|
-
# capability for a
|
|
1949
|
-
# reference a macro in your template the
|
|
1950
|
-
# fail.
|
|
2010
|
+
# capability for a StackSet with service-managed permissions, if you
|
|
2011
|
+
# reference a macro in your template the StackSet operation will fail.
|
|
1951
2012
|
#
|
|
1952
2013
|
#
|
|
1953
2014
|
#
|
|
@@ -1964,7 +2025,7 @@ module Aws::CloudFormation
|
|
|
1964
2025
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
|
1965
2026
|
#
|
|
1966
2027
|
# @option params [Array<Types::Tag>] :tags
|
|
1967
|
-
# The key-value pairs to associate with this
|
|
2028
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
|
1968
2029
|
# created from it. CloudFormation also propagates these tags to
|
|
1969
2030
|
# supported resources that are created in the stacks. A maximum number
|
|
1970
2031
|
# of 50 tags can be specified.
|
|
@@ -1972,14 +2033,14 @@ module Aws::CloudFormation
|
|
|
1972
2033
|
# If you specify tags as part of a `CreateStackSet` action,
|
|
1973
2034
|
# CloudFormation checks to see if you have the required IAM permission
|
|
1974
2035
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
|
1975
|
-
# fails with an `access denied` error, and the
|
|
2036
|
+
# fails with an `access denied` error, and the StackSet is not created.
|
|
1976
2037
|
#
|
|
1977
2038
|
# @option params [String] :administration_role_arn
|
|
1978
2039
|
# The Amazon Resource Name (ARN) of the IAM role to use to create this
|
|
1979
|
-
#
|
|
2040
|
+
# StackSet.
|
|
1980
2041
|
#
|
|
1981
2042
|
# Specify an IAM role only if you are using customized administrator
|
|
1982
|
-
# roles to control which users or groups can manage specific
|
|
2043
|
+
# roles to control which users or groups can manage specific StackSets
|
|
1983
2044
|
# within the same administrator account. For more information, see
|
|
1984
2045
|
# [Grant self-managed permissions][1] in the *CloudFormation User
|
|
1985
2046
|
# Guide*.
|
|
@@ -1991,19 +2052,19 @@ module Aws::CloudFormation
|
|
|
1991
2052
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
|
|
1992
2053
|
#
|
|
1993
2054
|
# @option params [String] :execution_role_name
|
|
1994
|
-
# The name of the IAM execution role to use to create the
|
|
2055
|
+
# The name of the IAM execution role to use to create the StackSet. If
|
|
1995
2056
|
# you do not specify an execution role, CloudFormation uses the
|
|
1996
|
-
# `AWSCloudFormationStackSetExecutionRole` role for the
|
|
2057
|
+
# `AWSCloudFormationStackSetExecutionRole` role for the StackSet
|
|
1997
2058
|
# operation.
|
|
1998
2059
|
#
|
|
1999
2060
|
# Specify an IAM role only if you are using customized execution roles
|
|
2000
2061
|
# to control which stack resources users and groups can include in their
|
|
2001
|
-
#
|
|
2062
|
+
# StackSets.
|
|
2002
2063
|
#
|
|
2003
2064
|
# Valid only if the permissions model is `SELF_MANAGED`.
|
|
2004
2065
|
#
|
|
2005
2066
|
# @option params [String] :permission_model
|
|
2006
|
-
# Describes how the IAM roles required for
|
|
2067
|
+
# Describes how the IAM roles required for StackSet operations are
|
|
2007
2068
|
# created. By default, `SELF-MANAGED` is specified.
|
|
2008
2069
|
#
|
|
2009
2070
|
# * With `self-managed` permissions, you must create the administrator
|
|
@@ -2013,7 +2074,7 @@ module Aws::CloudFormation
|
|
|
2013
2074
|
# * With `service-managed` permissions, StackSets automatically creates
|
|
2014
2075
|
# the IAM roles required to deploy to accounts managed by
|
|
2015
2076
|
# Organizations. For more information, see [Activate trusted access
|
|
2016
|
-
# for
|
|
2077
|
+
# for StackSets with Organizations][2].
|
|
2017
2078
|
#
|
|
2018
2079
|
#
|
|
2019
2080
|
#
|
|
@@ -2023,9 +2084,9 @@ module Aws::CloudFormation
|
|
|
2023
2084
|
# @option params [Types::AutoDeployment] :auto_deployment
|
|
2024
2085
|
# Describes whether StackSets automatically deploys to Organizations
|
|
2025
2086
|
# accounts that are added to the target organization or organizational
|
|
2026
|
-
# unit (OU). For more information, see [
|
|
2027
|
-
#
|
|
2028
|
-
#
|
|
2087
|
+
# unit (OU). For more information, see [Enable or disable automatic
|
|
2088
|
+
# deployments for StackSets in Organizations][1] in the *CloudFormation
|
|
2089
|
+
# User Guide*.
|
|
2029
2090
|
#
|
|
2030
2091
|
# Required if the permissions model is `SERVICE_MANAGED`. (Not used with
|
|
2031
2092
|
# self-managed permissions.)
|
|
@@ -2039,21 +2100,21 @@ module Aws::CloudFormation
|
|
|
2039
2100
|
# organization's management account or as a delegated administrator in
|
|
2040
2101
|
# a member account.
|
|
2041
2102
|
#
|
|
2042
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
2103
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
2043
2104
|
# self-managed permissions.
|
|
2044
2105
|
#
|
|
2045
|
-
# * To create a
|
|
2106
|
+
# * To create a StackSet with service-managed permissions while signed
|
|
2046
2107
|
# in to the management account, specify `SELF`.
|
|
2047
2108
|
#
|
|
2048
|
-
# * To create a
|
|
2109
|
+
# * To create a StackSet with service-managed permissions while signed
|
|
2049
2110
|
# in to a delegated administrator account, specify `DELEGATED_ADMIN`.
|
|
2050
2111
|
#
|
|
2051
2112
|
# Your Amazon Web Services account must be registered as a delegated
|
|
2052
2113
|
# admin in the management account. For more information, see [Register
|
|
2053
2114
|
# a delegated administrator][1] in the *CloudFormation User Guide*.
|
|
2054
2115
|
#
|
|
2055
|
-
#
|
|
2056
|
-
# management account, including
|
|
2116
|
+
# StackSets with service-managed permissions are created in the
|
|
2117
|
+
# management account, including StackSets that are created by delegated
|
|
2057
2118
|
# administrators.
|
|
2058
2119
|
#
|
|
2059
2120
|
# Valid only if the permissions model is `SERVICE_MANAGED`.
|
|
@@ -2065,7 +2126,7 @@ module Aws::CloudFormation
|
|
|
2065
2126
|
# @option params [String] :client_request_token
|
|
2066
2127
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
|
2067
2128
|
# token if you plan to retry requests so that CloudFormation knows that
|
|
2068
|
-
# you're not attempting to create another
|
|
2129
|
+
# you're not attempting to create another StackSet with the same name.
|
|
2069
2130
|
# You might retry `CreateStackSet` requests to ensure that
|
|
2070
2131
|
# CloudFormation successfully received them.
|
|
2071
2132
|
#
|
|
@@ -2076,7 +2137,7 @@ module Aws::CloudFormation
|
|
|
2076
2137
|
# not need to pass this option.**
|
|
2077
2138
|
#
|
|
2078
2139
|
# @option params [Types::ManagedExecution] :managed_execution
|
|
2079
|
-
# Describes whether
|
|
2140
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
|
2080
2141
|
# concurrently and queues conflicting operations.
|
|
2081
2142
|
#
|
|
2082
2143
|
# @return [Types::CreateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -2112,6 +2173,7 @@ module Aws::CloudFormation
|
|
|
2112
2173
|
# auto_deployment: {
|
|
2113
2174
|
# enabled: false,
|
|
2114
2175
|
# retain_stacks_on_account_removal: false,
|
|
2176
|
+
# depends_on: ["StackSetARN"],
|
|
2115
2177
|
# },
|
|
2116
2178
|
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
|
2117
2179
|
# client_request_token: "ClientRequestToken",
|
|
@@ -2148,8 +2210,12 @@ module Aws::CloudFormation
|
|
|
2148
2210
|
req.send_request(options)
|
|
2149
2211
|
end
|
|
2150
2212
|
|
|
2151
|
-
# Deactivates a public extension
|
|
2152
|
-
#
|
|
2213
|
+
# Deactivates a public third-party extension, such as a resource or
|
|
2214
|
+
# module, or a CloudFormation Hook when you no longer use it.
|
|
2215
|
+
#
|
|
2216
|
+
# Deactivating an extension deletes the configuration details that are
|
|
2217
|
+
# associated with it. To temporarily disable a CloudFormation Hook
|
|
2218
|
+
# instead, you can use [SetTypeConfiguration][1].
|
|
2153
2219
|
#
|
|
2154
2220
|
# Once deactivated, an extension can't be used in any CloudFormation
|
|
2155
2221
|
# operation. This includes stack update operations where the stack
|
|
@@ -2157,8 +2223,15 @@ module Aws::CloudFormation
|
|
|
2157
2223
|
# the extension. In addition, deactivated extensions aren't
|
|
2158
2224
|
# automatically updated if a new version of the extension is released.
|
|
2159
2225
|
#
|
|
2226
|
+
# To see which extensions are currently activated, use [ListTypes][2].
|
|
2227
|
+
#
|
|
2228
|
+
#
|
|
2229
|
+
#
|
|
2230
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
|
|
2231
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html
|
|
2232
|
+
#
|
|
2160
2233
|
# @option params [String] :type_name
|
|
2161
|
-
# The type name of the extension
|
|
2234
|
+
# The type name of the extension in this account and Region. If you
|
|
2162
2235
|
# specified a type name alias when enabling the extension, use the type
|
|
2163
2236
|
# name alias.
|
|
2164
2237
|
#
|
|
@@ -2170,7 +2243,7 @@ module Aws::CloudFormation
|
|
|
2170
2243
|
# Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
|
|
2171
2244
|
#
|
|
2172
2245
|
# @option params [String] :arn
|
|
2173
|
-
# The Amazon Resource Name (ARN) for the extension
|
|
2246
|
+
# The Amazon Resource Name (ARN) for the extension in this account and
|
|
2174
2247
|
# Region.
|
|
2175
2248
|
#
|
|
2176
2249
|
# Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
|
|
@@ -2364,7 +2437,7 @@ module Aws::CloudFormation
|
|
|
2364
2437
|
# </note>
|
|
2365
2438
|
#
|
|
2366
2439
|
# @option params [required, String] :stack_set_name
|
|
2367
|
-
# The name or unique ID of the
|
|
2440
|
+
# The name or unique ID of the StackSet that you want to delete stack
|
|
2368
2441
|
# instances for.
|
|
2369
2442
|
#
|
|
2370
2443
|
# @option params [Array<String>] :accounts
|
|
@@ -2380,36 +2453,35 @@ module Aws::CloudFormation
|
|
|
2380
2453
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
2381
2454
|
#
|
|
2382
2455
|
# @option params [required, Array<String>] :regions
|
|
2383
|
-
# The Amazon Web Services Regions where you want to delete
|
|
2456
|
+
# The Amazon Web Services Regions where you want to delete StackSet
|
|
2384
2457
|
# instances.
|
|
2385
2458
|
#
|
|
2386
2459
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
2387
|
-
# Preferences for how CloudFormation performs this
|
|
2460
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
|
2388
2461
|
#
|
|
2389
2462
|
# @option params [required, Boolean] :retain_stacks
|
|
2390
|
-
# Removes the stack instances from the specified
|
|
2463
|
+
# Removes the stack instances from the specified StackSet, but doesn't
|
|
2391
2464
|
# delete the stacks. You can't reassociate a retained stack or add an
|
|
2392
2465
|
# existing, saved stack to a new stack set.
|
|
2393
2466
|
#
|
|
2394
|
-
# For more information, see [
|
|
2467
|
+
# For more information, see [StackSet operation options][1].
|
|
2395
2468
|
#
|
|
2396
2469
|
#
|
|
2397
2470
|
#
|
|
2398
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
|
2471
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
|
2399
2472
|
#
|
|
2400
2473
|
# @option params [String] :operation_id
|
|
2401
|
-
# The unique identifier for this
|
|
2474
|
+
# The unique identifier for this StackSet operation.
|
|
2402
2475
|
#
|
|
2403
2476
|
# If you don't specify an operation ID, the SDK generates one
|
|
2404
2477
|
# automatically.
|
|
2405
2478
|
#
|
|
2406
2479
|
# The operation ID also functions as an idempotency token, to ensure
|
|
2407
|
-
# that CloudFormation performs the
|
|
2408
|
-
#
|
|
2409
|
-
#
|
|
2410
|
-
# them.
|
|
2480
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
|
2481
|
+
# you retry the request multiple times. You can retry StackSet operation
|
|
2482
|
+
# requests to ensure that CloudFormation successfully received them.
|
|
2411
2483
|
#
|
|
2412
|
-
# Repeating this
|
|
2484
|
+
# Repeating this StackSet operation with a new operation ID retries all
|
|
2413
2485
|
# stack instances whose status is `OUTDATED`.
|
|
2414
2486
|
#
|
|
2415
2487
|
# **A suitable default value is auto-generated.** You should normally
|
|
@@ -2420,7 +2492,7 @@ module Aws::CloudFormation
|
|
|
2420
2492
|
# account administrator in the organization's management account or as
|
|
2421
2493
|
# a delegated administrator in a member account.
|
|
2422
2494
|
#
|
|
2423
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
2495
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
2424
2496
|
# self-managed permissions.
|
|
2425
2497
|
#
|
|
2426
2498
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -2480,12 +2552,12 @@ module Aws::CloudFormation
|
|
|
2480
2552
|
req.send_request(options)
|
|
2481
2553
|
end
|
|
2482
2554
|
|
|
2483
|
-
# Deletes a
|
|
2555
|
+
# Deletes a StackSet. Before you can delete a StackSet, all its member
|
|
2484
2556
|
# stack instances must be deleted. For more information about how to
|
|
2485
2557
|
# complete this, see DeleteStackInstances.
|
|
2486
2558
|
#
|
|
2487
2559
|
# @option params [required, String] :stack_set_name
|
|
2488
|
-
# The name or unique ID of the
|
|
2560
|
+
# The name or unique ID of the StackSet that you're deleting. You can
|
|
2489
2561
|
# obtain this value by running ListStackSets.
|
|
2490
2562
|
#
|
|
2491
2563
|
# @option params [String] :call_as
|
|
@@ -2493,7 +2565,7 @@ module Aws::CloudFormation
|
|
|
2493
2565
|
# account administrator in the organization's management account or as
|
|
2494
2566
|
# a delegated administrator in a member account.
|
|
2495
2567
|
#
|
|
2496
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
2568
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
2497
2569
|
# self-managed permissions.
|
|
2498
2570
|
#
|
|
2499
2571
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -2547,9 +2619,13 @@ module Aws::CloudFormation
|
|
|
2547
2619
|
# To view the deprecation status of an extension or extension version,
|
|
2548
2620
|
# use [DescribeType][1].
|
|
2549
2621
|
#
|
|
2622
|
+
# For more information, see [Remove third-party private extensions from
|
|
2623
|
+
# your account][2] in the *CloudFormation User Guide*.
|
|
2624
|
+
#
|
|
2550
2625
|
#
|
|
2551
2626
|
#
|
|
2552
2627
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
|
2628
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.html
|
|
2553
2629
|
#
|
|
2554
2630
|
# @option params [String] :arn
|
|
2555
2631
|
# The Amazon Resource Name (ARN) of the extension.
|
|
@@ -2601,8 +2677,8 @@ module Aws::CloudFormation
|
|
|
2601
2677
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html
|
|
2602
2678
|
#
|
|
2603
2679
|
# @option params [String] :next_token
|
|
2604
|
-
#
|
|
2605
|
-
#
|
|
2680
|
+
# The token for the next set of items to return. (You received this
|
|
2681
|
+
# token from a previous call.)
|
|
2606
2682
|
#
|
|
2607
2683
|
# @return [Types::DescribeAccountLimitsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2608
2684
|
#
|
|
@@ -2651,8 +2727,8 @@ module Aws::CloudFormation
|
|
|
2651
2727
|
# ID (ARN) of the change set you want to describe.
|
|
2652
2728
|
#
|
|
2653
2729
|
# @option params [String] :next_token
|
|
2654
|
-
#
|
|
2655
|
-
#
|
|
2730
|
+
# The token for the next set of items to return. (You received this
|
|
2731
|
+
# token from a previous call.)
|
|
2656
2732
|
#
|
|
2657
2733
|
# @option params [Boolean] :include_property_values
|
|
2658
2734
|
# If `true`, the returned changes include detailed changes in the
|
|
@@ -2670,6 +2746,7 @@ module Aws::CloudFormation
|
|
|
2670
2746
|
# * {Types::DescribeChangeSetOutput#execution_status #execution_status} => String
|
|
2671
2747
|
# * {Types::DescribeChangeSetOutput#status #status} => String
|
|
2672
2748
|
# * {Types::DescribeChangeSetOutput#status_reason #status_reason} => String
|
|
2749
|
+
# * {Types::DescribeChangeSetOutput#stack_drift_status #stack_drift_status} => String
|
|
2673
2750
|
# * {Types::DescribeChangeSetOutput#notification_arns #notification_arns} => Array<String>
|
|
2674
2751
|
# * {Types::DescribeChangeSetOutput#rollback_configuration #rollback_configuration} => Types::RollbackConfiguration
|
|
2675
2752
|
# * {Types::DescribeChangeSetOutput#capabilities #capabilities} => Array<String>
|
|
@@ -2681,6 +2758,9 @@ module Aws::CloudFormation
|
|
|
2681
2758
|
# * {Types::DescribeChangeSetOutput#root_change_set_id #root_change_set_id} => String
|
|
2682
2759
|
# * {Types::DescribeChangeSetOutput#on_stack_failure #on_stack_failure} => String
|
|
2683
2760
|
# * {Types::DescribeChangeSetOutput#import_existing_resources #import_existing_resources} => Boolean
|
|
2761
|
+
# * {Types::DescribeChangeSetOutput#deployment_mode #deployment_mode} => String
|
|
2762
|
+
#
|
|
2763
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2684
2764
|
#
|
|
2685
2765
|
# @example Request syntax with placeholder values
|
|
2686
2766
|
#
|
|
@@ -2707,6 +2787,7 @@ module Aws::CloudFormation
|
|
|
2707
2787
|
# resp.execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
|
|
2708
2788
|
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
|
|
2709
2789
|
# resp.status_reason #=> String
|
|
2790
|
+
# resp.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
|
2710
2791
|
# resp.notification_arns #=> Array
|
|
2711
2792
|
# resp.notification_arns[0] #=> String
|
|
2712
2793
|
# resp.rollback_configuration.rollback_triggers #=> Array
|
|
@@ -2722,13 +2803,17 @@ module Aws::CloudFormation
|
|
|
2722
2803
|
# resp.changes[0].type #=> String, one of "Resource"
|
|
2723
2804
|
# resp.changes[0].hook_invocation_count #=> Integer
|
|
2724
2805
|
# resp.changes[0].resource_change.policy_action #=> String, one of "Delete", "Retain", "Snapshot", "ReplaceAndDelete", "ReplaceAndRetain", "ReplaceAndSnapshot"
|
|
2725
|
-
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
|
2806
|
+
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic", "SyncWithActual"
|
|
2726
2807
|
# resp.changes[0].resource_change.logical_resource_id #=> String
|
|
2727
2808
|
# resp.changes[0].resource_change.physical_resource_id #=> String
|
|
2728
2809
|
# resp.changes[0].resource_change.resource_type #=> String
|
|
2729
2810
|
# resp.changes[0].resource_change.replacement #=> String, one of "True", "False", "Conditional"
|
|
2730
2811
|
# resp.changes[0].resource_change.scope #=> Array
|
|
2731
2812
|
# resp.changes[0].resource_change.scope[0] #=> String, one of "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "UpdateReplacePolicy", "Tags"
|
|
2813
|
+
# resp.changes[0].resource_change.resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
2814
|
+
# resp.changes[0].resource_change.resource_drift_ignored_attributes #=> Array
|
|
2815
|
+
# resp.changes[0].resource_change.resource_drift_ignored_attributes[0].path #=> String
|
|
2816
|
+
# resp.changes[0].resource_change.resource_drift_ignored_attributes[0].reason #=> String, one of "MANAGED_BY_AWS", "WRITE_ONLY_PROPERTY"
|
|
2732
2817
|
# resp.changes[0].resource_change.details #=> Array
|
|
2733
2818
|
# resp.changes[0].resource_change.details[0].target.attribute #=> String, one of "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "UpdateReplacePolicy", "Tags"
|
|
2734
2819
|
# resp.changes[0].resource_change.details[0].target.name #=> String
|
|
@@ -2736,21 +2821,28 @@ module Aws::CloudFormation
|
|
|
2736
2821
|
# resp.changes[0].resource_change.details[0].target.path #=> String
|
|
2737
2822
|
# resp.changes[0].resource_change.details[0].target.before_value #=> String
|
|
2738
2823
|
# resp.changes[0].resource_change.details[0].target.after_value #=> String
|
|
2739
|
-
# resp.changes[0].resource_change.details[0].target.
|
|
2824
|
+
# resp.changes[0].resource_change.details[0].target.before_value_from #=> String, one of "PREVIOUS_DEPLOYMENT_STATE", "ACTUAL_STATE"
|
|
2825
|
+
# resp.changes[0].resource_change.details[0].target.after_value_from #=> String, one of "TEMPLATE"
|
|
2826
|
+
# resp.changes[0].resource_change.details[0].target.drift.previous_value #=> String
|
|
2827
|
+
# resp.changes[0].resource_change.details[0].target.drift.actual_value #=> String
|
|
2828
|
+
# resp.changes[0].resource_change.details[0].target.drift.drift_detection_timestamp #=> Time
|
|
2829
|
+
# resp.changes[0].resource_change.details[0].target.attribute_change_type #=> String, one of "Add", "Remove", "Modify", "SyncWithActual"
|
|
2740
2830
|
# resp.changes[0].resource_change.details[0].evaluation #=> String, one of "Static", "Dynamic"
|
|
2741
|
-
# resp.changes[0].resource_change.details[0].change_source #=> String, one of "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic"
|
|
2831
|
+
# resp.changes[0].resource_change.details[0].change_source #=> String, one of "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic", "NoModification"
|
|
2742
2832
|
# resp.changes[0].resource_change.details[0].causing_entity #=> String
|
|
2743
2833
|
# resp.changes[0].resource_change.change_set_id #=> String
|
|
2744
2834
|
# resp.changes[0].resource_change.module_info.type_hierarchy #=> String
|
|
2745
2835
|
# resp.changes[0].resource_change.module_info.logical_id_hierarchy #=> String
|
|
2746
2836
|
# resp.changes[0].resource_change.before_context #=> String
|
|
2747
2837
|
# resp.changes[0].resource_change.after_context #=> String
|
|
2838
|
+
# resp.changes[0].resource_change.previous_deployment_context #=> String
|
|
2748
2839
|
# resp.next_token #=> String
|
|
2749
2840
|
# resp.include_nested_stacks #=> Boolean
|
|
2750
2841
|
# resp.parent_change_set_id #=> String
|
|
2751
2842
|
# resp.root_change_set_id #=> String
|
|
2752
2843
|
# resp.on_stack_failure #=> String, one of "DO_NOTHING", "ROLLBACK", "DELETE"
|
|
2753
2844
|
# resp.import_existing_resources #=> Boolean
|
|
2845
|
+
# resp.deployment_mode #=> String, one of "REVERT_DRIFT"
|
|
2754
2846
|
#
|
|
2755
2847
|
#
|
|
2756
2848
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
@@ -2766,7 +2858,7 @@ module Aws::CloudFormation
|
|
|
2766
2858
|
req.send_request(options)
|
|
2767
2859
|
end
|
|
2768
2860
|
|
|
2769
|
-
# Returns
|
|
2861
|
+
# Returns Hook-related information for the change set and a list of
|
|
2770
2862
|
# changes that CloudFormation makes when you run the change set.
|
|
2771
2863
|
#
|
|
2772
2864
|
# @option params [required, String] :change_set_name
|
|
@@ -2778,9 +2870,8 @@ module Aws::CloudFormation
|
|
|
2778
2870
|
# stack ID (ARN) of the change set you want to describe.
|
|
2779
2871
|
#
|
|
2780
2872
|
# @option params [String] :next_token
|
|
2781
|
-
#
|
|
2782
|
-
#
|
|
2783
|
-
# retrieve.
|
|
2873
|
+
# The token for the next set of items to return. (You received this
|
|
2874
|
+
# token from a previous call.)
|
|
2784
2875
|
#
|
|
2785
2876
|
# @option params [String] :logical_resource_id
|
|
2786
2877
|
# If specified, lists only the Hooks related to the specified
|
|
@@ -2818,7 +2909,7 @@ module Aws::CloudFormation
|
|
|
2818
2909
|
# resp.hooks[0].target_details.target_type #=> String, one of "RESOURCE"
|
|
2819
2910
|
# resp.hooks[0].target_details.resource_target_details.logical_resource_id #=> String
|
|
2820
2911
|
# resp.hooks[0].target_details.resource_target_details.resource_type #=> String
|
|
2821
|
-
# resp.hooks[0].target_details.resource_target_details.resource_action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
|
|
2912
|
+
# resp.hooks[0].target_details.resource_target_details.resource_action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic", "SyncWithActual"
|
|
2822
2913
|
# resp.status #=> String, one of "PLANNING", "PLANNED", "UNAVAILABLE"
|
|
2823
2914
|
# resp.next_token #=> String
|
|
2824
2915
|
# resp.stack_id #=> String
|
|
@@ -2833,6 +2924,112 @@ module Aws::CloudFormation
|
|
|
2833
2924
|
req.send_request(options)
|
|
2834
2925
|
end
|
|
2835
2926
|
|
|
2927
|
+
# Returns CloudFormation events based on flexible query criteria. Groups
|
|
2928
|
+
# events by operation ID, enabling you to focus on individual stack
|
|
2929
|
+
# operations during deployment.
|
|
2930
|
+
#
|
|
2931
|
+
# An operation is any action performed on a stack, including stack
|
|
2932
|
+
# lifecycle actions (Create, Update, Delete, Rollback), change set
|
|
2933
|
+
# creation, nested stack creation, and automatic rollbacks triggered by
|
|
2934
|
+
# failures. Each operation has a unique identifier (Operation ID) and
|
|
2935
|
+
# represents a discrete change attempt on the stack.
|
|
2936
|
+
#
|
|
2937
|
+
# Returns different types of events including:
|
|
2938
|
+
#
|
|
2939
|
+
# * **Progress events** - Status updates during stack operation
|
|
2940
|
+
# execution.
|
|
2941
|
+
#
|
|
2942
|
+
# * **Validation errors** - Failures from CloudFormation Early
|
|
2943
|
+
# Validations.
|
|
2944
|
+
#
|
|
2945
|
+
# * **Provisioning errors** - Resource creation and update failures.
|
|
2946
|
+
#
|
|
2947
|
+
# * **Hook invocation errors** - Failures from CloudFormation Hook
|
|
2948
|
+
# during stack operations.
|
|
2949
|
+
#
|
|
2950
|
+
# <note markdown="1"> One of `ChangeSetName`, `OperationId` or `StackName` must be specified
|
|
2951
|
+
# as input.
|
|
2952
|
+
#
|
|
2953
|
+
# </note>
|
|
2954
|
+
#
|
|
2955
|
+
# @option params [String] :stack_name
|
|
2956
|
+
# The name or unique stack ID for which you want to retrieve events.
|
|
2957
|
+
#
|
|
2958
|
+
# @option params [String] :change_set_name
|
|
2959
|
+
# The name or Amazon Resource Name (ARN) of the change set for which you
|
|
2960
|
+
# want to retrieve events.
|
|
2961
|
+
#
|
|
2962
|
+
# @option params [String] :operation_id
|
|
2963
|
+
# The unique identifier of the operation for which you want to retrieve
|
|
2964
|
+
# events.
|
|
2965
|
+
#
|
|
2966
|
+
# @option params [Types::EventFilter] :filters
|
|
2967
|
+
# Filters to apply when retrieving events.
|
|
2968
|
+
#
|
|
2969
|
+
# @option params [String] :next_token
|
|
2970
|
+
# The token for the next set of items to return. (You received this
|
|
2971
|
+
# token from a previous call.)
|
|
2972
|
+
#
|
|
2973
|
+
# @return [Types::DescribeEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2974
|
+
#
|
|
2975
|
+
# * {Types::DescribeEventsOutput#operation_events #operation_events} => Array<Types::OperationEvent>
|
|
2976
|
+
# * {Types::DescribeEventsOutput#next_token #next_token} => String
|
|
2977
|
+
#
|
|
2978
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2979
|
+
#
|
|
2980
|
+
# @example Request syntax with placeholder values
|
|
2981
|
+
#
|
|
2982
|
+
# resp = client.describe_events({
|
|
2983
|
+
# stack_name: "StackNameOrId",
|
|
2984
|
+
# change_set_name: "ChangeSetNameOrId",
|
|
2985
|
+
# operation_id: "OperationId",
|
|
2986
|
+
# filters: {
|
|
2987
|
+
# failed_events: false,
|
|
2988
|
+
# },
|
|
2989
|
+
# next_token: "NextToken",
|
|
2990
|
+
# })
|
|
2991
|
+
#
|
|
2992
|
+
# @example Response structure
|
|
2993
|
+
#
|
|
2994
|
+
# resp.operation_events #=> Array
|
|
2995
|
+
# resp.operation_events[0].event_id #=> String
|
|
2996
|
+
# resp.operation_events[0].stack_id #=> String
|
|
2997
|
+
# resp.operation_events[0].operation_id #=> String
|
|
2998
|
+
# resp.operation_events[0].operation_type #=> String, one of "CREATE_STACK", "UPDATE_STACK", "DELETE_STACK", "CONTINUE_ROLLBACK", "ROLLBACK", "CREATE_CHANGESET"
|
|
2999
|
+
# resp.operation_events[0].operation_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
3000
|
+
# resp.operation_events[0].event_type #=> String, one of "STACK_EVENT", "PROGRESS_EVENT", "VALIDATION_ERROR", "PROVISIONING_ERROR", "HOOK_INVOCATION_ERROR"
|
|
3001
|
+
# resp.operation_events[0].logical_resource_id #=> String
|
|
3002
|
+
# resp.operation_events[0].physical_resource_id #=> String
|
|
3003
|
+
# resp.operation_events[0].resource_type #=> String
|
|
3004
|
+
# resp.operation_events[0].timestamp #=> Time
|
|
3005
|
+
# resp.operation_events[0].start_time #=> Time
|
|
3006
|
+
# resp.operation_events[0].end_time #=> Time
|
|
3007
|
+
# resp.operation_events[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
|
|
3008
|
+
# resp.operation_events[0].resource_status_reason #=> String
|
|
3009
|
+
# resp.operation_events[0].resource_properties #=> String
|
|
3010
|
+
# resp.operation_events[0].client_request_token #=> String
|
|
3011
|
+
# resp.operation_events[0].hook_type #=> String
|
|
3012
|
+
# resp.operation_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
|
3013
|
+
# resp.operation_events[0].hook_status_reason #=> String
|
|
3014
|
+
# resp.operation_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
|
|
3015
|
+
# resp.operation_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
|
|
3016
|
+
# resp.operation_events[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
|
|
3017
|
+
# resp.operation_events[0].validation_failure_mode #=> String, one of "FAIL", "WARN"
|
|
3018
|
+
# resp.operation_events[0].validation_name #=> String
|
|
3019
|
+
# resp.operation_events[0].validation_status #=> String, one of "FAILED", "SKIPPED"
|
|
3020
|
+
# resp.operation_events[0].validation_status_reason #=> String
|
|
3021
|
+
# resp.operation_events[0].validation_path #=> String
|
|
3022
|
+
# resp.next_token #=> String
|
|
3023
|
+
#
|
|
3024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeEvents AWS API Documentation
|
|
3025
|
+
#
|
|
3026
|
+
# @overload describe_events(params = {})
|
|
3027
|
+
# @param [Hash] params ({})
|
|
3028
|
+
def describe_events(params = {}, options = {})
|
|
3029
|
+
req = build_request(:describe_events, params)
|
|
3030
|
+
req.send_request(options)
|
|
3031
|
+
end
|
|
3032
|
+
|
|
2836
3033
|
# Describes a generated template. The output includes details about the
|
|
2837
3034
|
# progress of the creation of a generated template started by a
|
|
2838
3035
|
# `CreateGeneratedTemplate` API action or the update of a generated
|
|
@@ -2903,7 +3100,7 @@ module Aws::CloudFormation
|
|
|
2903
3100
|
# resp.resources[0].resource_status #=> String, one of "PENDING", "IN_PROGRESS", "FAILED", "COMPLETE"
|
|
2904
3101
|
# resp.resources[0].resource_status_reason #=> String
|
|
2905
3102
|
# resp.resources[0].warnings #=> Array
|
|
2906
|
-
# resp.resources[0].warnings[0].type #=> String, one of "MUTUALLY_EXCLUSIVE_PROPERTIES", "UNSUPPORTED_PROPERTIES", "MUTUALLY_EXCLUSIVE_TYPES", "EXCLUDED_PROPERTIES"
|
|
3103
|
+
# resp.resources[0].warnings[0].type #=> String, one of "MUTUALLY_EXCLUSIVE_PROPERTIES", "UNSUPPORTED_PROPERTIES", "MUTUALLY_EXCLUSIVE_TYPES", "EXCLUDED_PROPERTIES", "EXCLUDED_RESOURCES"
|
|
2907
3104
|
# resp.resources[0].warnings[0].properties #=> Array
|
|
2908
3105
|
# resp.resources[0].warnings[0].properties[0].property_path #=> String
|
|
2909
3106
|
# resp.resources[0].warnings[0].properties[0].required #=> Boolean
|
|
@@ -3256,7 +3453,7 @@ module Aws::CloudFormation
|
|
|
3256
3453
|
#
|
|
3257
3454
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
|
|
3258
3455
|
#
|
|
3259
|
-
# @option params [String] :stack_name
|
|
3456
|
+
# @option params [required, String] :stack_name
|
|
3260
3457
|
# The name or the unique stack ID that's associated with the stack,
|
|
3261
3458
|
# which aren't always interchangeable:
|
|
3262
3459
|
#
|
|
@@ -3266,8 +3463,8 @@ module Aws::CloudFormation
|
|
|
3266
3463
|
# * Deleted stacks: You must specify the unique stack ID.
|
|
3267
3464
|
#
|
|
3268
3465
|
# @option params [String] :next_token
|
|
3269
|
-
#
|
|
3270
|
-
#
|
|
3466
|
+
# The token for the next set of items to return. (You received this
|
|
3467
|
+
# token from a previous call.)
|
|
3271
3468
|
#
|
|
3272
3469
|
# @return [Types::DescribeStackEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3273
3470
|
#
|
|
@@ -3279,7 +3476,7 @@ module Aws::CloudFormation
|
|
|
3279
3476
|
# @example Request syntax with placeholder values
|
|
3280
3477
|
#
|
|
3281
3478
|
# resp = client.describe_stack_events({
|
|
3282
|
-
# stack_name: "StackName",
|
|
3479
|
+
# stack_name: "StackName", # required
|
|
3283
3480
|
# next_token: "NextToken",
|
|
3284
3481
|
# })
|
|
3285
3482
|
#
|
|
@@ -3289,6 +3486,7 @@ module Aws::CloudFormation
|
|
|
3289
3486
|
# resp.stack_events[0].stack_id #=> String
|
|
3290
3487
|
# resp.stack_events[0].event_id #=> String
|
|
3291
3488
|
# resp.stack_events[0].stack_name #=> String
|
|
3489
|
+
# resp.stack_events[0].operation_id #=> String
|
|
3292
3490
|
# resp.stack_events[0].logical_resource_id #=> String
|
|
3293
3491
|
# resp.stack_events[0].physical_resource_id #=> String
|
|
3294
3492
|
# resp.stack_events[0].resource_type #=> String
|
|
@@ -3301,6 +3499,7 @@ module Aws::CloudFormation
|
|
|
3301
3499
|
# resp.stack_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
|
3302
3500
|
# resp.stack_events[0].hook_status_reason #=> String
|
|
3303
3501
|
# resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
|
|
3502
|
+
# resp.stack_events[0].hook_invocation_id #=> String
|
|
3304
3503
|
# resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
|
|
3305
3504
|
# resp.stack_events[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
|
|
3306
3505
|
# resp.next_token #=> String
|
|
@@ -3321,7 +3520,7 @@ module Aws::CloudFormation
|
|
|
3321
3520
|
# StackSet, use ListStackInstances.
|
|
3322
3521
|
#
|
|
3323
3522
|
# @option params [required, String] :stack_set_name
|
|
3324
|
-
# The name or the unique stack ID of the
|
|
3523
|
+
# The name or the unique stack ID of the StackSet that you want to get
|
|
3325
3524
|
# stack instance information for.
|
|
3326
3525
|
#
|
|
3327
3526
|
# @option params [required, String] :stack_instance_account
|
|
@@ -3336,7 +3535,7 @@ module Aws::CloudFormation
|
|
|
3336
3535
|
# account administrator in the organization's management account or as
|
|
3337
3536
|
# a delegated administrator in a member account.
|
|
3338
3537
|
#
|
|
3339
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
3538
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
3340
3539
|
# self-managed permissions.
|
|
3341
3540
|
#
|
|
3342
3541
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -3483,7 +3682,7 @@ module Aws::CloudFormation
|
|
|
3483
3682
|
# resp.stack_resource_detail.resource_status_reason #=> String
|
|
3484
3683
|
# resp.stack_resource_detail.description #=> String
|
|
3485
3684
|
# resp.stack_resource_detail.metadata #=> String
|
|
3486
|
-
# resp.stack_resource_detail.drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN"
|
|
3685
|
+
# resp.stack_resource_detail.drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
3487
3686
|
# resp.stack_resource_detail.drift_information.last_check_timestamp #=> Time
|
|
3488
3687
|
# resp.stack_resource_detail.module_info.type_hierarchy #=> String
|
|
3489
3688
|
# resp.stack_resource_detail.module_info.logical_id_hierarchy #=> String
|
|
@@ -3539,8 +3738,8 @@ module Aws::CloudFormation
|
|
|
3539
3738
|
# resource.
|
|
3540
3739
|
#
|
|
3541
3740
|
# @option params [String] :next_token
|
|
3542
|
-
#
|
|
3543
|
-
#
|
|
3741
|
+
# The token for the next set of items to return. (You received this
|
|
3742
|
+
# token from a previous call.)
|
|
3544
3743
|
#
|
|
3545
3744
|
# @option params [Integer] :max_results
|
|
3546
3745
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -3559,7 +3758,7 @@ module Aws::CloudFormation
|
|
|
3559
3758
|
#
|
|
3560
3759
|
# resp = client.describe_stack_resource_drifts({
|
|
3561
3760
|
# stack_name: "StackNameOrId", # required
|
|
3562
|
-
# stack_resource_drift_status_filters: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED, UNKNOWN
|
|
3761
|
+
# stack_resource_drift_status_filters: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED, UNKNOWN, UNSUPPORTED
|
|
3563
3762
|
# next_token: "NextToken",
|
|
3564
3763
|
# max_results: 1,
|
|
3565
3764
|
# })
|
|
@@ -3581,7 +3780,7 @@ module Aws::CloudFormation
|
|
|
3581
3780
|
# resp.stack_resource_drifts[0].property_differences[0].expected_value #=> String
|
|
3582
3781
|
# resp.stack_resource_drifts[0].property_differences[0].actual_value #=> String
|
|
3583
3782
|
# resp.stack_resource_drifts[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
|
|
3584
|
-
# resp.stack_resource_drifts[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN"
|
|
3783
|
+
# resp.stack_resource_drifts[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
3585
3784
|
# resp.stack_resource_drifts[0].timestamp #=> Time
|
|
3586
3785
|
# resp.stack_resource_drifts[0].module_info.type_hierarchy #=> String
|
|
3587
3786
|
# resp.stack_resource_drifts[0].module_info.logical_id_hierarchy #=> String
|
|
@@ -3677,7 +3876,7 @@ module Aws::CloudFormation
|
|
|
3677
3876
|
# resp.stack_resources[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
|
|
3678
3877
|
# resp.stack_resources[0].resource_status_reason #=> String
|
|
3679
3878
|
# resp.stack_resources[0].description #=> String
|
|
3680
|
-
# resp.stack_resources[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN"
|
|
3879
|
+
# resp.stack_resources[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
3681
3880
|
# resp.stack_resources[0].drift_information.last_check_timestamp #=> Time
|
|
3682
3881
|
# resp.stack_resources[0].module_info.type_hierarchy #=> String
|
|
3683
3882
|
# resp.stack_resources[0].module_info.logical_id_hierarchy #=> String
|
|
@@ -3699,14 +3898,14 @@ module Aws::CloudFormation
|
|
|
3699
3898
|
# </note>
|
|
3700
3899
|
#
|
|
3701
3900
|
# @option params [required, String] :stack_set_name
|
|
3702
|
-
# The name or unique ID of the
|
|
3901
|
+
# The name or unique ID of the StackSet whose description you want.
|
|
3703
3902
|
#
|
|
3704
3903
|
# @option params [String] :call_as
|
|
3705
3904
|
# \[Service-managed permissions\] Specifies whether you are acting as an
|
|
3706
3905
|
# account administrator in the organization's management account or as
|
|
3707
3906
|
# a delegated administrator in a member account.
|
|
3708
3907
|
#
|
|
3709
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
3908
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
3710
3909
|
# self-managed permissions.
|
|
3711
3910
|
#
|
|
3712
3911
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -3764,6 +3963,8 @@ module Aws::CloudFormation
|
|
|
3764
3963
|
# resp.stack_set.stack_set_drift_detection_details.failed_stack_instances_count #=> Integer
|
|
3765
3964
|
# resp.stack_set.auto_deployment.enabled #=> Boolean
|
|
3766
3965
|
# resp.stack_set.auto_deployment.retain_stacks_on_account_removal #=> Boolean
|
|
3966
|
+
# resp.stack_set.auto_deployment.depends_on #=> Array
|
|
3967
|
+
# resp.stack_set.auto_deployment.depends_on[0] #=> String
|
|
3767
3968
|
# resp.stack_set.permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
|
|
3768
3969
|
# resp.stack_set.organizational_unit_ids #=> Array
|
|
3769
3970
|
# resp.stack_set.organizational_unit_ids[0] #=> String
|
|
@@ -3788,18 +3989,18 @@ module Aws::CloudFormation
|
|
|
3788
3989
|
# </note>
|
|
3789
3990
|
#
|
|
3790
3991
|
# @option params [required, String] :stack_set_name
|
|
3791
|
-
# The name or the unique stack ID of the
|
|
3992
|
+
# The name or the unique stack ID of the StackSet for the stack
|
|
3792
3993
|
# operation.
|
|
3793
3994
|
#
|
|
3794
3995
|
# @option params [required, String] :operation_id
|
|
3795
|
-
# The unique ID of the
|
|
3996
|
+
# The unique ID of the StackSet operation.
|
|
3796
3997
|
#
|
|
3797
3998
|
# @option params [String] :call_as
|
|
3798
3999
|
# \[Service-managed permissions\] Specifies whether you are acting as an
|
|
3799
4000
|
# account administrator in the organization's management account or as
|
|
3800
4001
|
# a delegated administrator in a member account.
|
|
3801
4002
|
#
|
|
3802
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
4003
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
3803
4004
|
# self-managed permissions.
|
|
3804
4005
|
#
|
|
3805
4006
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -3915,8 +4116,8 @@ module Aws::CloudFormation
|
|
|
3915
4116
|
# * Deleted stacks: You must specify the unique stack ID.
|
|
3916
4117
|
#
|
|
3917
4118
|
# @option params [String] :next_token
|
|
3918
|
-
#
|
|
3919
|
-
#
|
|
4119
|
+
# The token for the next set of items to return. (You received this
|
|
4120
|
+
# token from a previous call.)
|
|
3920
4121
|
#
|
|
3921
4122
|
# @return [Types::DescribeStacksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3922
4123
|
#
|
|
@@ -3976,6 +4177,9 @@ module Aws::CloudFormation
|
|
|
3976
4177
|
# resp.stacks[0].retain_except_on_create #=> Boolean
|
|
3977
4178
|
# resp.stacks[0].deletion_mode #=> String, one of "STANDARD", "FORCE_DELETE_STACK"
|
|
3978
4179
|
# resp.stacks[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
|
|
4180
|
+
# resp.stacks[0].last_operations #=> Array
|
|
4181
|
+
# resp.stacks[0].last_operations[0].operation_type #=> String, one of "CREATE_STACK", "UPDATE_STACK", "DELETE_STACK", "CONTINUE_ROLLBACK", "ROLLBACK", "CREATE_CHANGESET"
|
|
4182
|
+
# resp.stacks[0].last_operations[0].operation_id #=> String
|
|
3979
4183
|
# resp.next_token #=> String
|
|
3980
4184
|
#
|
|
3981
4185
|
#
|
|
@@ -3997,13 +4201,20 @@ module Aws::CloudFormation
|
|
|
3997
4201
|
req.send_request(options)
|
|
3998
4202
|
end
|
|
3999
4203
|
|
|
4000
|
-
# Returns detailed information about an extension
|
|
4001
|
-
#
|
|
4204
|
+
# Returns detailed information about an extension from the
|
|
4205
|
+
# CloudFormation registry in your current account and Region.
|
|
4002
4206
|
#
|
|
4003
4207
|
# If you specify a `VersionId`, `DescribeType` returns information about
|
|
4004
4208
|
# that specific extension version. Otherwise, it returns information
|
|
4005
4209
|
# about the default extension version.
|
|
4006
4210
|
#
|
|
4211
|
+
# For more information, see [Edit configuration data for extensions in
|
|
4212
|
+
# your account][1] in the *CloudFormation User Guide*.
|
|
4213
|
+
#
|
|
4214
|
+
#
|
|
4215
|
+
#
|
|
4216
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html
|
|
4217
|
+
#
|
|
4007
4218
|
# @option params [String] :type
|
|
4008
4219
|
# The kind of extension.
|
|
4009
4220
|
#
|
|
@@ -4295,7 +4506,7 @@ module Aws::CloudFormation
|
|
|
4295
4506
|
# resp.stack_resource_drift.property_differences[0].expected_value #=> String
|
|
4296
4507
|
# resp.stack_resource_drift.property_differences[0].actual_value #=> String
|
|
4297
4508
|
# resp.stack_resource_drift.property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
|
|
4298
|
-
# resp.stack_resource_drift.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN"
|
|
4509
|
+
# resp.stack_resource_drift.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
4299
4510
|
# resp.stack_resource_drift.timestamp #=> Time
|
|
4300
4511
|
# resp.stack_resource_drift.module_info.type_hierarchy #=> String
|
|
4301
4512
|
# resp.stack_resource_drift.module_info.logical_id_hierarchy #=> String
|
|
@@ -4310,17 +4521,17 @@ module Aws::CloudFormation
|
|
|
4310
4521
|
req.send_request(options)
|
|
4311
4522
|
end
|
|
4312
4523
|
|
|
4313
|
-
# Detect drift on a
|
|
4314
|
-
# detection on a
|
|
4315
|
-
# associated with each stack instance in the
|
|
4524
|
+
# Detect drift on a StackSet. When CloudFormation performs drift
|
|
4525
|
+
# detection on a StackSet, it performs drift detection on the stack
|
|
4526
|
+
# associated with each stack instance in the StackSet. For more
|
|
4316
4527
|
# information, see [Performing drift detection on CloudFormation
|
|
4317
4528
|
# StackSets][1].
|
|
4318
4529
|
#
|
|
4319
|
-
# `DetectStackSetDrift` returns the `OperationId` of the
|
|
4530
|
+
# `DetectStackSetDrift` returns the `OperationId` of the StackSet drift
|
|
4320
4531
|
# detection operation. Use this operation id with
|
|
4321
4532
|
# DescribeStackSetOperation to monitor the progress of the drift
|
|
4322
4533
|
# detection operation. The drift detection operation may take some time,
|
|
4323
|
-
# depending on the number of stack instances included in the
|
|
4534
|
+
# depending on the number of stack instances included in the StackSet,
|
|
4324
4535
|
# in addition to the number of resources included in each stack.
|
|
4325
4536
|
#
|
|
4326
4537
|
# Once the operation has completed, use the following actions to return
|
|
@@ -4328,21 +4539,21 @@ module Aws::CloudFormation
|
|
|
4328
4539
|
#
|
|
4329
4540
|
# * Use DescribeStackSet to return detailed information about the stack
|
|
4330
4541
|
# set, including detailed information about the last *completed* drift
|
|
4331
|
-
# operation performed on the
|
|
4542
|
+
# operation performed on the StackSet. (Information about drift
|
|
4332
4543
|
# operations that are in progress isn't included.)
|
|
4333
4544
|
#
|
|
4334
4545
|
# * Use ListStackInstances to return a list of stack instances belonging
|
|
4335
|
-
# to the
|
|
4546
|
+
# to the StackSet, including the drift status and last drift time
|
|
4336
4547
|
# checked of each instance.
|
|
4337
4548
|
#
|
|
4338
4549
|
# * Use DescribeStackInstance to return detailed information about a
|
|
4339
4550
|
# specific stack instance, including its drift status and last drift
|
|
4340
4551
|
# time checked.
|
|
4341
4552
|
#
|
|
4342
|
-
# You can only run a single drift detection operation on a given
|
|
4343
|
-
#
|
|
4553
|
+
# You can only run a single drift detection operation on a given
|
|
4554
|
+
# StackSet at one time.
|
|
4344
4555
|
#
|
|
4345
|
-
# To stop a drift detection
|
|
4556
|
+
# To stop a drift detection StackSet operation, use
|
|
4346
4557
|
# StopStackSetOperation.
|
|
4347
4558
|
#
|
|
4348
4559
|
#
|
|
@@ -4350,22 +4561,22 @@ module Aws::CloudFormation
|
|
|
4350
4561
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
|
|
4351
4562
|
#
|
|
4352
4563
|
# @option params [required, String] :stack_set_name
|
|
4353
|
-
# The name of the
|
|
4564
|
+
# The name of the StackSet on which to perform the drift detection
|
|
4354
4565
|
# operation.
|
|
4355
4566
|
#
|
|
4356
4567
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
4357
|
-
# The user-specified preferences for how CloudFormation performs a
|
|
4358
|
-
#
|
|
4568
|
+
# The user-specified preferences for how CloudFormation performs a
|
|
4569
|
+
# StackSet operation.
|
|
4359
4570
|
#
|
|
4360
4571
|
# For more information about maximum concurrent accounts and failure
|
|
4361
|
-
# tolerance, see [
|
|
4572
|
+
# tolerance, see [StackSet operation options][1].
|
|
4362
4573
|
#
|
|
4363
4574
|
#
|
|
4364
4575
|
#
|
|
4365
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
|
4576
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
|
4366
4577
|
#
|
|
4367
4578
|
# @option params [String] :operation_id
|
|
4368
|
-
# *The ID of the
|
|
4579
|
+
# *The ID of the StackSet operation.*
|
|
4369
4580
|
#
|
|
4370
4581
|
# **A suitable default value is auto-generated.** You should normally
|
|
4371
4582
|
# not need to pass this option.**
|
|
@@ -4375,7 +4586,7 @@ module Aws::CloudFormation
|
|
|
4375
4586
|
# account administrator in the organization's management account or as
|
|
4376
4587
|
# a delegated administrator in a member account.
|
|
4377
4588
|
#
|
|
4378
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
4589
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
4379
4590
|
# self-managed permissions.
|
|
4380
4591
|
#
|
|
4381
4592
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -4662,6 +4873,84 @@ module Aws::CloudFormation
|
|
|
4662
4873
|
req.send_request(options)
|
|
4663
4874
|
end
|
|
4664
4875
|
|
|
4876
|
+
# Retrieves detailed information and remediation guidance for a Hook
|
|
4877
|
+
# invocation result.
|
|
4878
|
+
#
|
|
4879
|
+
# If the Hook uses a KMS key to encrypt annotations, callers of the
|
|
4880
|
+
# `GetHookResult` operation must have `kms:Decrypt` permissions. For
|
|
4881
|
+
# more information, see [KMS key policy and permissions for encrypting
|
|
4882
|
+
# CloudFormation Hooks results at rest][1] in the *CloudFormation Hooks
|
|
4883
|
+
# User Guide*.
|
|
4884
|
+
#
|
|
4885
|
+
#
|
|
4886
|
+
#
|
|
4887
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-kms-key-policy.html
|
|
4888
|
+
#
|
|
4889
|
+
# @option params [String] :hook_result_id
|
|
4890
|
+
# The unique identifier (ID) of the Hook invocation result that you want
|
|
4891
|
+
# details about. You can get the ID from the [ListHookResults][1]
|
|
4892
|
+
# operation.
|
|
4893
|
+
#
|
|
4894
|
+
#
|
|
4895
|
+
#
|
|
4896
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListHookResults.html
|
|
4897
|
+
#
|
|
4898
|
+
# @return [Types::GetHookResultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4899
|
+
#
|
|
4900
|
+
# * {Types::GetHookResultOutput#hook_result_id #hook_result_id} => String
|
|
4901
|
+
# * {Types::GetHookResultOutput#invocation_point #invocation_point} => String
|
|
4902
|
+
# * {Types::GetHookResultOutput#failure_mode #failure_mode} => String
|
|
4903
|
+
# * {Types::GetHookResultOutput#type_name #type_name} => String
|
|
4904
|
+
# * {Types::GetHookResultOutput#original_type_name #original_type_name} => String
|
|
4905
|
+
# * {Types::GetHookResultOutput#type_version_id #type_version_id} => String
|
|
4906
|
+
# * {Types::GetHookResultOutput#type_configuration_version_id #type_configuration_version_id} => String
|
|
4907
|
+
# * {Types::GetHookResultOutput#type_arn #type_arn} => String
|
|
4908
|
+
# * {Types::GetHookResultOutput#status #status} => String
|
|
4909
|
+
# * {Types::GetHookResultOutput#hook_status_reason #hook_status_reason} => String
|
|
4910
|
+
# * {Types::GetHookResultOutput#invoked_at #invoked_at} => Time
|
|
4911
|
+
# * {Types::GetHookResultOutput#target #target} => Types::HookTarget
|
|
4912
|
+
# * {Types::GetHookResultOutput#annotations #annotations} => Array<Types::Annotation>
|
|
4913
|
+
#
|
|
4914
|
+
# @example Request syntax with placeholder values
|
|
4915
|
+
#
|
|
4916
|
+
# resp = client.get_hook_result({
|
|
4917
|
+
# hook_result_id: "HookInvocationId",
|
|
4918
|
+
# })
|
|
4919
|
+
#
|
|
4920
|
+
# @example Response structure
|
|
4921
|
+
#
|
|
4922
|
+
# resp.hook_result_id #=> String
|
|
4923
|
+
# resp.invocation_point #=> String, one of "PRE_PROVISION"
|
|
4924
|
+
# resp.failure_mode #=> String, one of "FAIL", "WARN"
|
|
4925
|
+
# resp.type_name #=> String
|
|
4926
|
+
# resp.original_type_name #=> String
|
|
4927
|
+
# resp.type_version_id #=> String
|
|
4928
|
+
# resp.type_configuration_version_id #=> String
|
|
4929
|
+
# resp.type_arn #=> String
|
|
4930
|
+
# resp.status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
|
4931
|
+
# resp.hook_status_reason #=> String
|
|
4932
|
+
# resp.invoked_at #=> Time
|
|
4933
|
+
# resp.target.target_type #=> String, one of "RESOURCE"
|
|
4934
|
+
# resp.target.target_type_name #=> String
|
|
4935
|
+
# resp.target.target_id #=> String
|
|
4936
|
+
# resp.target.action #=> String, one of "CREATE", "UPDATE", "DELETE", "IMPORT"
|
|
4937
|
+
# resp.annotations #=> Array
|
|
4938
|
+
# resp.annotations[0].annotation_name #=> String
|
|
4939
|
+
# resp.annotations[0].status #=> String, one of "PASSED", "FAILED", "SKIPPED"
|
|
4940
|
+
# resp.annotations[0].status_message #=> String
|
|
4941
|
+
# resp.annotations[0].remediation_message #=> String
|
|
4942
|
+
# resp.annotations[0].remediation_link #=> String
|
|
4943
|
+
# resp.annotations[0].severity_level #=> String, one of "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL"
|
|
4944
|
+
#
|
|
4945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetHookResult AWS API Documentation
|
|
4946
|
+
#
|
|
4947
|
+
# @overload get_hook_result(params = {})
|
|
4948
|
+
# @param [Hash] params ({})
|
|
4949
|
+
def get_hook_result(params = {}, options = {})
|
|
4950
|
+
req = build_request(:get_hook_result, params)
|
|
4951
|
+
req.send_request(options)
|
|
4952
|
+
end
|
|
4953
|
+
|
|
4665
4954
|
# Returns the stack policy for a specified stack. If a stack doesn't
|
|
4666
4955
|
# have a policy, a null value is returned.
|
|
4667
4956
|
#
|
|
@@ -4757,10 +5046,10 @@ module Aws::CloudFormation
|
|
|
4757
5046
|
# Returns information about a new or existing template. The
|
|
4758
5047
|
# `GetTemplateSummary` action is useful for viewing parameter
|
|
4759
5048
|
# information, such as default parameter values and parameter types,
|
|
4760
|
-
# before you create or update a stack or
|
|
5049
|
+
# before you create or update a stack or StackSet.
|
|
4761
5050
|
#
|
|
4762
5051
|
# You can use the `GetTemplateSummary` action when you submit a
|
|
4763
|
-
# template, or you can get template information for a
|
|
5052
|
+
# template, or you can get template information for a StackSet, or a
|
|
4764
5053
|
# running or deleted stack.
|
|
4765
5054
|
#
|
|
4766
5055
|
# For deleted stacks, `GetTemplateSummary` returns the template
|
|
@@ -4793,7 +5082,7 @@ module Aws::CloudFormation
|
|
|
4793
5082
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
|
4794
5083
|
#
|
|
4795
5084
|
# @option params [String] :stack_set_name
|
|
4796
|
-
# The name or unique ID of the
|
|
5085
|
+
# The name or unique ID of the StackSet from which the stack was
|
|
4797
5086
|
# created.
|
|
4798
5087
|
#
|
|
4799
5088
|
# Conditional: You must specify only one of the following parameters:
|
|
@@ -4804,7 +5093,7 @@ module Aws::CloudFormation
|
|
|
4804
5093
|
# account administrator in the organization's management account or as
|
|
4805
5094
|
# a delegated administrator in a member account.
|
|
4806
5095
|
#
|
|
4807
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
5096
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
4808
5097
|
# self-managed permissions.
|
|
4809
5098
|
#
|
|
4810
5099
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -4888,19 +5177,19 @@ module Aws::CloudFormation
|
|
|
4888
5177
|
req.send_request(options)
|
|
4889
5178
|
end
|
|
4890
5179
|
|
|
4891
|
-
# Import existing stacks into a new
|
|
4892
|
-
# operation to import up to 10 stacks into a new
|
|
5180
|
+
# Import existing stacks into a new StackSets. Use the stack import
|
|
5181
|
+
# operation to import up to 10 stacks into a new StackSet in the same
|
|
4893
5182
|
# account as the source stack or in a different administrator account
|
|
4894
5183
|
# and Region, by specifying the stack ID of the stack you intend to
|
|
4895
5184
|
# import.
|
|
4896
5185
|
#
|
|
4897
5186
|
# @option params [required, String] :stack_set_name
|
|
4898
|
-
# The name of the
|
|
4899
|
-
# you create your
|
|
5187
|
+
# The name of the StackSet. The name must be unique in the Region where
|
|
5188
|
+
# you create your StackSet.
|
|
4900
5189
|
#
|
|
4901
5190
|
# @option params [Array<String>] :stack_ids
|
|
4902
|
-
# The IDs of the stacks you are importing into a
|
|
4903
|
-
#
|
|
5191
|
+
# The IDs of the stacks you are importing into a StackSet. You import up
|
|
5192
|
+
# to 10 stacks per StackSet at a time.
|
|
4904
5193
|
#
|
|
4905
5194
|
# Specify either `StackIds` or `StackIdsUrl`.
|
|
4906
5195
|
#
|
|
@@ -4910,33 +5199,33 @@ module Aws::CloudFormation
|
|
|
4910
5199
|
# Specify either `StackIds` or `StackIdsUrl`.
|
|
4911
5200
|
#
|
|
4912
5201
|
# @option params [Array<String>] :organizational_unit_ids
|
|
4913
|
-
# The list of OU ID's to which the stacks
|
|
4914
|
-
#
|
|
5202
|
+
# The list of OU ID's to which the imported stacks must be mapped as
|
|
5203
|
+
# deployment targets.
|
|
4915
5204
|
#
|
|
4916
5205
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
4917
|
-
# The user-specified preferences for how CloudFormation performs a
|
|
4918
|
-
#
|
|
5206
|
+
# The user-specified preferences for how CloudFormation performs a
|
|
5207
|
+
# StackSet operation.
|
|
4919
5208
|
#
|
|
4920
5209
|
# For more information about maximum concurrent accounts and failure
|
|
4921
|
-
# tolerance, see [
|
|
5210
|
+
# tolerance, see [StackSet operation options][1].
|
|
4922
5211
|
#
|
|
4923
5212
|
#
|
|
4924
5213
|
#
|
|
4925
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
|
|
5214
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
|
4926
5215
|
#
|
|
4927
5216
|
# @option params [String] :operation_id
|
|
4928
|
-
# A unique, user defined, identifier for the
|
|
5217
|
+
# A unique, user defined, identifier for the StackSet operation.
|
|
4929
5218
|
#
|
|
4930
5219
|
# **A suitable default value is auto-generated.** You should normally
|
|
4931
5220
|
# not need to pass this option.**
|
|
4932
5221
|
#
|
|
4933
5222
|
# @option params [String] :call_as
|
|
4934
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
5223
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
4935
5224
|
# self-managed permissions.
|
|
4936
5225
|
#
|
|
4937
5226
|
# * If you are signed in to the management account, specify `SELF`.
|
|
4938
5227
|
#
|
|
4939
|
-
# * For service managed
|
|
5228
|
+
# * For service managed StackSets, specify `DELEGATED_ADMIN`.
|
|
4940
5229
|
#
|
|
4941
5230
|
# @return [Types::ImportStacksToStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4942
5231
|
#
|
|
@@ -4984,8 +5273,8 @@ module Aws::CloudFormation
|
|
|
4984
5273
|
# want to list change sets.
|
|
4985
5274
|
#
|
|
4986
5275
|
# @option params [String] :next_token
|
|
4987
|
-
#
|
|
4988
|
-
#
|
|
5276
|
+
# The token for the next set of items to return. (You received this
|
|
5277
|
+
# token from a previous call.)
|
|
4989
5278
|
#
|
|
4990
5279
|
# @return [Types::ListChangeSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4991
5280
|
#
|
|
@@ -5038,12 +5327,12 @@ module Aws::CloudFormation
|
|
|
5038
5327
|
#
|
|
5039
5328
|
#
|
|
5040
5329
|
#
|
|
5041
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/
|
|
5330
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html
|
|
5042
5331
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html
|
|
5043
5332
|
#
|
|
5044
5333
|
# @option params [String] :next_token
|
|
5045
|
-
#
|
|
5046
|
-
#
|
|
5334
|
+
# The token for the next set of items to return. (You received this
|
|
5335
|
+
# token from a previous call.)
|
|
5047
5336
|
#
|
|
5048
5337
|
# @return [Types::ListExportsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5049
5338
|
#
|
|
@@ -5078,7 +5367,8 @@ module Aws::CloudFormation
|
|
|
5078
5367
|
# Lists your generated templates in this Region.
|
|
5079
5368
|
#
|
|
5080
5369
|
# @option params [String] :next_token
|
|
5081
|
-
#
|
|
5370
|
+
# The token for the next set of items to return. (You received this
|
|
5371
|
+
# token from a previous call.)
|
|
5082
5372
|
#
|
|
5083
5373
|
# @option params [Integer] :max_results
|
|
5084
5374
|
# If the number of available results exceeds this maximum, the response
|
|
@@ -5163,28 +5453,66 @@ module Aws::CloudFormation
|
|
|
5163
5453
|
req.send_request(options)
|
|
5164
5454
|
end
|
|
5165
5455
|
|
|
5166
|
-
# Returns summaries of invoked Hooks
|
|
5167
|
-
#
|
|
5456
|
+
# Returns summaries of invoked Hooks. For more information, see [View
|
|
5457
|
+
# invocation summaries for CloudFormation Hooks][1] in the
|
|
5458
|
+
# *CloudFormation Hooks User Guide*.
|
|
5168
5459
|
#
|
|
5169
|
-
#
|
|
5170
|
-
# The type of operation being targeted by the Hook.
|
|
5460
|
+
# This operation supports the following parameter combinations:
|
|
5171
5461
|
#
|
|
5172
|
-
#
|
|
5173
|
-
# The logical ID of the target the operation is acting on by the Hook.
|
|
5174
|
-
# If the target is a change set, it's the ARN of the change set.
|
|
5462
|
+
# * No parameters: Returns all Hook invocation summaries.
|
|
5175
5463
|
#
|
|
5176
|
-
#
|
|
5177
|
-
#
|
|
5178
|
-
#
|
|
5179
|
-
#
|
|
5464
|
+
# * `TypeArn` only: Returns summaries for a specific Hook.
|
|
5465
|
+
#
|
|
5466
|
+
# * `TypeArn` and `Status`: Returns summaries for a specific Hook
|
|
5467
|
+
# filtered by status.
|
|
5468
|
+
#
|
|
5469
|
+
# * `TargetId` and `TargetType`: Returns summaries for a specific Hook
|
|
5470
|
+
# invocation target.
|
|
5471
|
+
#
|
|
5472
|
+
#
|
|
5473
|
+
#
|
|
5474
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-view-invocations.html
|
|
5475
|
+
#
|
|
5476
|
+
# @option params [String] :target_type
|
|
5477
|
+
# Filters results by target type. Currently, only `CHANGE_SET` and
|
|
5478
|
+
# `CLOUD_CONTROL` are supported filter options.
|
|
5479
|
+
#
|
|
5480
|
+
# Required when `TargetId` is specified and cannot be used otherwise.
|
|
5481
|
+
#
|
|
5482
|
+
# @option params [String] :target_id
|
|
5483
|
+
# Filters results by the unique identifier of the target the Hook was
|
|
5484
|
+
# invoked against.
|
|
5485
|
+
#
|
|
5486
|
+
# For change sets, this is the change set ARN. When the target is a
|
|
5487
|
+
# Cloud Control API operation, this value must be the `HookRequestToken`
|
|
5488
|
+
# returned by the Cloud Control API request. For more information on the
|
|
5489
|
+
# `HookRequestToken`, see [ProgressEvent][1].
|
|
5490
|
+
#
|
|
5491
|
+
# Required when `TargetType` is specified and cannot be used otherwise.
|
|
5180
5492
|
#
|
|
5181
5493
|
#
|
|
5182
5494
|
#
|
|
5183
5495
|
# [1]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html
|
|
5184
5496
|
#
|
|
5497
|
+
# @option params [String] :type_arn
|
|
5498
|
+
# Filters results by the ARN of the Hook. Can be used alone or in
|
|
5499
|
+
# combination with `Status`.
|
|
5500
|
+
#
|
|
5501
|
+
# @option params [String] :status
|
|
5502
|
+
# Filters results by the status of Hook invocations. Can only be used in
|
|
5503
|
+
# combination with `TypeArn`. Valid values are:
|
|
5504
|
+
#
|
|
5505
|
+
# * `HOOK_IN_PROGRESS`: The Hook is currently running.
|
|
5506
|
+
#
|
|
5507
|
+
# * `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
|
|
5508
|
+
#
|
|
5509
|
+
# * `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
|
|
5510
|
+
#
|
|
5511
|
+
# * `HOOK_FAILED`: The Hook encountered an error during execution.
|
|
5512
|
+
#
|
|
5185
5513
|
# @option params [String] :next_token
|
|
5186
|
-
#
|
|
5187
|
-
#
|
|
5514
|
+
# The token for the next set of items to return. (You received this
|
|
5515
|
+
# token from a previous call.)
|
|
5188
5516
|
#
|
|
5189
5517
|
# @return [Types::ListHookResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5190
5518
|
#
|
|
@@ -5196,8 +5524,10 @@ module Aws::CloudFormation
|
|
|
5196
5524
|
# @example Request syntax with placeholder values
|
|
5197
5525
|
#
|
|
5198
5526
|
# resp = client.list_hook_results({
|
|
5199
|
-
# target_type: "CHANGE_SET", #
|
|
5200
|
-
# target_id: "HookResultId",
|
|
5527
|
+
# target_type: "CHANGE_SET", # accepts CHANGE_SET, STACK, RESOURCE, CLOUD_CONTROL
|
|
5528
|
+
# target_id: "HookResultId",
|
|
5529
|
+
# type_arn: "HookTypeArn",
|
|
5530
|
+
# status: "HOOK_IN_PROGRESS", # accepts HOOK_IN_PROGRESS, HOOK_COMPLETE_SUCCEEDED, HOOK_COMPLETE_FAILED, HOOK_FAILED
|
|
5201
5531
|
# next_token: "NextToken",
|
|
5202
5532
|
# })
|
|
5203
5533
|
#
|
|
@@ -5206,6 +5536,7 @@ module Aws::CloudFormation
|
|
|
5206
5536
|
# resp.target_type #=> String, one of "CHANGE_SET", "STACK", "RESOURCE", "CLOUD_CONTROL"
|
|
5207
5537
|
# resp.target_id #=> String
|
|
5208
5538
|
# resp.hook_results #=> Array
|
|
5539
|
+
# resp.hook_results[0].hook_result_id #=> String
|
|
5209
5540
|
# resp.hook_results[0].invocation_point #=> String, one of "PRE_PROVISION"
|
|
5210
5541
|
# resp.hook_results[0].failure_mode #=> String, one of "FAIL", "WARN"
|
|
5211
5542
|
# resp.hook_results[0].type_name #=> String
|
|
@@ -5213,6 +5544,11 @@ module Aws::CloudFormation
|
|
|
5213
5544
|
# resp.hook_results[0].type_configuration_version_id #=> String
|
|
5214
5545
|
# resp.hook_results[0].status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
|
|
5215
5546
|
# resp.hook_results[0].hook_status_reason #=> String
|
|
5547
|
+
# resp.hook_results[0].invoked_at #=> Time
|
|
5548
|
+
# resp.hook_results[0].target_type #=> String, one of "CHANGE_SET", "STACK", "RESOURCE", "CLOUD_CONTROL"
|
|
5549
|
+
# resp.hook_results[0].target_id #=> String
|
|
5550
|
+
# resp.hook_results[0].type_arn #=> String
|
|
5551
|
+
# resp.hook_results[0].hook_execution_target #=> String
|
|
5216
5552
|
# resp.next_token #=> String
|
|
5217
5553
|
#
|
|
5218
5554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListHookResults AWS API Documentation
|
|
@@ -5234,16 +5570,15 @@ module Aws::CloudFormation
|
|
|
5234
5570
|
#
|
|
5235
5571
|
#
|
|
5236
5572
|
#
|
|
5237
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/
|
|
5573
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html
|
|
5238
5574
|
#
|
|
5239
5575
|
# @option params [required, String] :export_name
|
|
5240
5576
|
# The name of the exported output value. CloudFormation returns the
|
|
5241
5577
|
# stack names that are importing this value.
|
|
5242
5578
|
#
|
|
5243
5579
|
# @option params [String] :next_token
|
|
5244
|
-
#
|
|
5245
|
-
#
|
|
5246
|
-
# output value.
|
|
5580
|
+
# The token for the next set of items to return. (You received this
|
|
5581
|
+
# token from a previous call.)
|
|
5247
5582
|
#
|
|
5248
5583
|
# @return [Types::ListImportsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5249
5584
|
#
|
|
@@ -5286,7 +5621,8 @@ module Aws::CloudFormation
|
|
|
5286
5621
|
# Up to 100 resources can be provided.
|
|
5287
5622
|
#
|
|
5288
5623
|
# @option params [String] :next_token
|
|
5289
|
-
#
|
|
5624
|
+
# The token for the next set of items to return. (You received this
|
|
5625
|
+
# token from a previous call.)
|
|
5290
5626
|
#
|
|
5291
5627
|
# @option params [Integer] :max_results
|
|
5292
5628
|
# If the number of available results exceeds this maximum, the response
|
|
@@ -5420,7 +5756,8 @@ module Aws::CloudFormation
|
|
|
5420
5756
|
# If specified, the returned resources will have a matching tag value.
|
|
5421
5757
|
#
|
|
5422
5758
|
# @option params [String] :next_token
|
|
5423
|
-
#
|
|
5759
|
+
# The token for the next set of items to return. (You received this
|
|
5760
|
+
# token from a previous call.)
|
|
5424
5761
|
#
|
|
5425
5762
|
# @option params [Integer] :max_results
|
|
5426
5763
|
# If the number of available results exceeds this maximum, the response
|
|
@@ -5531,7 +5868,8 @@ module Aws::CloudFormation
|
|
|
5531
5868
|
# return up to 10 resource scans.
|
|
5532
5869
|
#
|
|
5533
5870
|
# @option params [String] :next_token
|
|
5534
|
-
#
|
|
5871
|
+
# The token for the next set of items to return. (You received this
|
|
5872
|
+
# token from a previous call.)
|
|
5535
5873
|
#
|
|
5536
5874
|
# @option params [Integer] :max_results
|
|
5537
5875
|
# If the number of available results exceeds this maximum, the response
|
|
@@ -5615,16 +5953,12 @@ module Aws::CloudFormation
|
|
|
5615
5953
|
# </note>
|
|
5616
5954
|
#
|
|
5617
5955
|
# @option params [required, String] :stack_set_name
|
|
5618
|
-
# The name or unique ID of the
|
|
5956
|
+
# The name or unique ID of the StackSet that you want to list drifted
|
|
5619
5957
|
# resources for.
|
|
5620
5958
|
#
|
|
5621
5959
|
# @option params [String] :next_token
|
|
5622
|
-
#
|
|
5623
|
-
#
|
|
5624
|
-
# a token. To retrieve the next set of results, call this action again
|
|
5625
|
-
# and assign that token to the request object's `NextToken` parameter.
|
|
5626
|
-
# If there are no remaining results, the previous response object's
|
|
5627
|
-
# `NextToken` parameter is set to `null`.
|
|
5960
|
+
# The token for the next set of items to return. (You received this
|
|
5961
|
+
# token from a previous call.)
|
|
5628
5962
|
#
|
|
5629
5963
|
# @option params [Integer] :max_results
|
|
5630
5964
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -5661,7 +5995,7 @@ module Aws::CloudFormation
|
|
|
5661
5995
|
# account administrator in the organization's management account or as
|
|
5662
5996
|
# a delegated administrator in a member account.
|
|
5663
5997
|
#
|
|
5664
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
5998
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
5665
5999
|
# self-managed permissions.
|
|
5666
6000
|
#
|
|
5667
6001
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -5689,7 +6023,7 @@ module Aws::CloudFormation
|
|
|
5689
6023
|
# stack_set_name: "StackSetNameOrId", # required
|
|
5690
6024
|
# next_token: "NextToken",
|
|
5691
6025
|
# max_results: 1,
|
|
5692
|
-
# stack_instance_resource_drift_statuses: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED, UNKNOWN
|
|
6026
|
+
# stack_instance_resource_drift_statuses: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED, UNKNOWN, UNSUPPORTED
|
|
5693
6027
|
# stack_instance_account: "Account", # required
|
|
5694
6028
|
# stack_instance_region: "Region", # required
|
|
5695
6029
|
# operation_id: "ClientRequestToken", # required
|
|
@@ -5711,7 +6045,7 @@ module Aws::CloudFormation
|
|
|
5711
6045
|
# resp.summaries[0].property_differences[0].expected_value #=> String
|
|
5712
6046
|
# resp.summaries[0].property_differences[0].actual_value #=> String
|
|
5713
6047
|
# resp.summaries[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
|
|
5714
|
-
# resp.summaries[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN"
|
|
6048
|
+
# resp.summaries[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
5715
6049
|
# resp.summaries[0].timestamp #=> Time
|
|
5716
6050
|
# resp.next_token #=> String
|
|
5717
6051
|
#
|
|
@@ -5725,21 +6059,17 @@ module Aws::CloudFormation
|
|
|
5725
6059
|
end
|
|
5726
6060
|
|
|
5727
6061
|
# Returns summary information about stack instances that are associated
|
|
5728
|
-
# with the specified
|
|
6062
|
+
# with the specified StackSet. You can filter for stack instances that
|
|
5729
6063
|
# are associated with a specific Amazon Web Services account name or
|
|
5730
6064
|
# Region, or that have a specific status.
|
|
5731
6065
|
#
|
|
5732
6066
|
# @option params [required, String] :stack_set_name
|
|
5733
|
-
# The name or unique ID of the
|
|
6067
|
+
# The name or unique ID of the StackSet that you want to list stack
|
|
5734
6068
|
# instances for.
|
|
5735
6069
|
#
|
|
5736
6070
|
# @option params [String] :next_token
|
|
5737
|
-
#
|
|
5738
|
-
#
|
|
5739
|
-
# the next set of results, call `ListStackInstances` again and assign
|
|
5740
|
-
# that token to the request object's `NextToken` parameter. If there
|
|
5741
|
-
# are no remaining results, the previous response object's `NextToken`
|
|
5742
|
-
# parameter is set to `null`.
|
|
6071
|
+
# The token for the next set of items to return. (You received this
|
|
6072
|
+
# token from a previous call.)
|
|
5743
6073
|
#
|
|
5744
6074
|
# @option params [Integer] :max_results
|
|
5745
6075
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -5762,7 +6092,7 @@ module Aws::CloudFormation
|
|
|
5762
6092
|
# account administrator in the organization's management account or as
|
|
5763
6093
|
# a delegated administrator in a member account.
|
|
5764
6094
|
#
|
|
5765
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
6095
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
5766
6096
|
# self-managed permissions.
|
|
5767
6097
|
#
|
|
5768
6098
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -5836,11 +6166,8 @@ module Aws::CloudFormation
|
|
|
5836
6166
|
# CreateStackRefactor action.
|
|
5837
6167
|
#
|
|
5838
6168
|
# @option params [String] :next_token
|
|
5839
|
-
#
|
|
5840
|
-
#
|
|
5841
|
-
# action again and assign that token to the request object's
|
|
5842
|
-
# `NextToken` parameter. If the request returns all results, `NextToken`
|
|
5843
|
-
# is set to `null`.
|
|
6169
|
+
# The token for the next set of items to return. (You received this
|
|
6170
|
+
# token from a previous call.)
|
|
5844
6171
|
#
|
|
5845
6172
|
# @option params [Integer] :max_results
|
|
5846
6173
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -5901,11 +6228,8 @@ module Aws::CloudFormation
|
|
|
5901
6228
|
# status codes.
|
|
5902
6229
|
#
|
|
5903
6230
|
# @option params [String] :next_token
|
|
5904
|
-
#
|
|
5905
|
-
#
|
|
5906
|
-
# action again and assign that token to the request object's
|
|
5907
|
-
# `NextToken` parameter. If the request returns all results, `NextToken`
|
|
5908
|
-
# is set to `null`.
|
|
6231
|
+
# The token for the next set of items to return. (You received this
|
|
6232
|
+
# token from a previous call.)
|
|
5909
6233
|
#
|
|
5910
6234
|
# @option params [Integer] :max_results
|
|
5911
6235
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -5963,8 +6287,8 @@ module Aws::CloudFormation
|
|
|
5963
6287
|
# * Deleted stacks: You must specify the unique stack ID.
|
|
5964
6288
|
#
|
|
5965
6289
|
# @option params [String] :next_token
|
|
5966
|
-
#
|
|
5967
|
-
#
|
|
6290
|
+
# The token for the next set of items to return. (You received this
|
|
6291
|
+
# token from a previous call.)
|
|
5968
6292
|
#
|
|
5969
6293
|
# @return [Types::ListStackResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5970
6294
|
#
|
|
@@ -5989,7 +6313,7 @@ module Aws::CloudFormation
|
|
|
5989
6313
|
# resp.stack_resource_summaries[0].last_updated_timestamp #=> Time
|
|
5990
6314
|
# resp.stack_resource_summaries[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
|
|
5991
6315
|
# resp.stack_resource_summaries[0].resource_status_reason #=> String
|
|
5992
|
-
# resp.stack_resource_summaries[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN"
|
|
6316
|
+
# resp.stack_resource_summaries[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
|
|
5993
6317
|
# resp.stack_resource_summaries[0].drift_information.last_check_timestamp #=> Time
|
|
5994
6318
|
# resp.stack_resource_summaries[0].module_info.type_hierarchy #=> String
|
|
5995
6319
|
# resp.stack_resource_summaries[0].module_info.logical_id_hierarchy #=> String
|
|
@@ -6004,15 +6328,15 @@ module Aws::CloudFormation
|
|
|
6004
6328
|
req.send_request(options)
|
|
6005
6329
|
end
|
|
6006
6330
|
|
|
6007
|
-
# Returns summary information about deployment targets for a
|
|
6331
|
+
# Returns summary information about deployment targets for a StackSet.
|
|
6008
6332
|
#
|
|
6009
6333
|
# @option params [required, String] :stack_set_name
|
|
6010
|
-
# The name or unique ID of the
|
|
6334
|
+
# The name or unique ID of the StackSet that you want to get automatic
|
|
6011
6335
|
# deployment targets for.
|
|
6012
6336
|
#
|
|
6013
6337
|
# @option params [String] :next_token
|
|
6014
|
-
#
|
|
6015
|
-
#
|
|
6338
|
+
# The token for the next set of items to return. (You received this
|
|
6339
|
+
# token from a previous call.)
|
|
6016
6340
|
#
|
|
6017
6341
|
# @option params [Integer] :max_results
|
|
6018
6342
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -6073,8 +6397,7 @@ module Aws::CloudFormation
|
|
|
6073
6397
|
req.send_request(options)
|
|
6074
6398
|
end
|
|
6075
6399
|
|
|
6076
|
-
# Returns summary information about the results of a
|
|
6077
|
-
# operation.
|
|
6400
|
+
# Returns summary information about the results of a StackSet operation.
|
|
6078
6401
|
#
|
|
6079
6402
|
# <note markdown="1"> This API provides *eventually consistent* reads meaning it may take
|
|
6080
6403
|
# some time but will eventually return the most up-to-date data.
|
|
@@ -6082,19 +6405,15 @@ module Aws::CloudFormation
|
|
|
6082
6405
|
# </note>
|
|
6083
6406
|
#
|
|
6084
6407
|
# @option params [required, String] :stack_set_name
|
|
6085
|
-
# The name or unique ID of the
|
|
6408
|
+
# The name or unique ID of the StackSet that you want to get operation
|
|
6086
6409
|
# results for.
|
|
6087
6410
|
#
|
|
6088
6411
|
# @option params [required, String] :operation_id
|
|
6089
|
-
# The ID of the
|
|
6412
|
+
# The ID of the StackSet operation.
|
|
6090
6413
|
#
|
|
6091
6414
|
# @option params [String] :next_token
|
|
6092
|
-
#
|
|
6093
|
-
#
|
|
6094
|
-
# retrieve the next set of results, call `ListStackSetOperationResults`
|
|
6095
|
-
# again and assign that token to the request object's `NextToken`
|
|
6096
|
-
# parameter. If there are no remaining results, the previous response
|
|
6097
|
-
# object's `NextToken` parameter is set to `null`.
|
|
6415
|
+
# The token for the next set of items to return. (You received this
|
|
6416
|
+
# token from a previous call.)
|
|
6098
6417
|
#
|
|
6099
6418
|
# @option params [Integer] :max_results
|
|
6100
6419
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -6107,7 +6426,7 @@ module Aws::CloudFormation
|
|
|
6107
6426
|
# account administrator in the organization's management account or as
|
|
6108
6427
|
# a delegated administrator in a member account.
|
|
6109
6428
|
#
|
|
6110
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
6429
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
6111
6430
|
# self-managed permissions.
|
|
6112
6431
|
#
|
|
6113
6432
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -6171,7 +6490,7 @@ module Aws::CloudFormation
|
|
|
6171
6490
|
req.send_request(options)
|
|
6172
6491
|
end
|
|
6173
6492
|
|
|
6174
|
-
# Returns summary information about operations performed on a
|
|
6493
|
+
# Returns summary information about operations performed on a StackSet.
|
|
6175
6494
|
#
|
|
6176
6495
|
# <note markdown="1"> This API provides *eventually consistent* reads meaning it may take
|
|
6177
6496
|
# some time but will eventually return the most up-to-date data.
|
|
@@ -6179,17 +6498,12 @@ module Aws::CloudFormation
|
|
|
6179
6498
|
# </note>
|
|
6180
6499
|
#
|
|
6181
6500
|
# @option params [required, String] :stack_set_name
|
|
6182
|
-
# The name or unique ID of the
|
|
6501
|
+
# The name or unique ID of the StackSet that you want to get operation
|
|
6183
6502
|
# summaries for.
|
|
6184
6503
|
#
|
|
6185
6504
|
# @option params [String] :next_token
|
|
6186
|
-
#
|
|
6187
|
-
#
|
|
6188
|
-
# a token. To retrieve the next set of results, call
|
|
6189
|
-
# `ListStackSetOperations` again and assign that token to the request
|
|
6190
|
-
# object's `NextToken` parameter. If there are no remaining results,
|
|
6191
|
-
# the previous response object's `NextToken` parameter is set to
|
|
6192
|
-
# `null`.
|
|
6505
|
+
# The token for the next set of items to return. (You received this
|
|
6506
|
+
# token from a previous call.)
|
|
6193
6507
|
#
|
|
6194
6508
|
# @option params [Integer] :max_results
|
|
6195
6509
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -6202,7 +6516,7 @@ module Aws::CloudFormation
|
|
|
6202
6516
|
# account administrator in the organization's management account or as
|
|
6203
6517
|
# a delegated administrator in a member account.
|
|
6204
6518
|
#
|
|
6205
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
6519
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
6206
6520
|
# self-managed permissions.
|
|
6207
6521
|
#
|
|
6208
6522
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -6264,7 +6578,7 @@ module Aws::CloudFormation
|
|
|
6264
6578
|
req.send_request(options)
|
|
6265
6579
|
end
|
|
6266
6580
|
|
|
6267
|
-
# Returns summary information about
|
|
6581
|
+
# Returns summary information about StackSets that are associated with
|
|
6268
6582
|
# the user.
|
|
6269
6583
|
#
|
|
6270
6584
|
# <note markdown="1"> This API provides *strongly consistent* reads meaning it will always
|
|
@@ -6274,25 +6588,21 @@ module Aws::CloudFormation
|
|
|
6274
6588
|
#
|
|
6275
6589
|
# * \[Self-managed permissions\] If you set the `CallAs` parameter to
|
|
6276
6590
|
# `SELF` while signed in to your Amazon Web Services account,
|
|
6277
|
-
# `ListStackSets` returns all self-managed
|
|
6591
|
+
# `ListStackSets` returns all self-managed StackSets in your Amazon
|
|
6278
6592
|
# Web Services account.
|
|
6279
6593
|
#
|
|
6280
6594
|
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
|
6281
6595
|
# `SELF` while signed in to the organization's management account,
|
|
6282
|
-
# `ListStackSets` returns all
|
|
6596
|
+
# `ListStackSets` returns all StackSets in the management account.
|
|
6283
6597
|
#
|
|
6284
6598
|
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
|
6285
6599
|
# `DELEGATED_ADMIN` while signed in to your member account,
|
|
6286
|
-
# `ListStackSets` returns all
|
|
6600
|
+
# `ListStackSets` returns all StackSets with service-managed
|
|
6287
6601
|
# permissions in the management account.
|
|
6288
6602
|
#
|
|
6289
6603
|
# @option params [String] :next_token
|
|
6290
|
-
#
|
|
6291
|
-
#
|
|
6292
|
-
# a token. To retrieve the next set of results, call `ListStackSets`
|
|
6293
|
-
# again and assign that token to the request object's `NextToken`
|
|
6294
|
-
# parameter. If there are no remaining results, the previous response
|
|
6295
|
-
# object's `NextToken` parameter is set to `null`.
|
|
6604
|
+
# The token for the next set of items to return. (You received this
|
|
6605
|
+
# token from a previous call.)
|
|
6296
6606
|
#
|
|
6297
6607
|
# @option params [Integer] :max_results
|
|
6298
6608
|
# The maximum number of results to be returned with a single call. If
|
|
@@ -6301,7 +6611,7 @@ module Aws::CloudFormation
|
|
|
6301
6611
|
# request parameter to get the next set of results.
|
|
6302
6612
|
#
|
|
6303
6613
|
# @option params [String] :status
|
|
6304
|
-
# The status of the
|
|
6614
|
+
# The status of the StackSets that you want to get summary information
|
|
6305
6615
|
# about.
|
|
6306
6616
|
#
|
|
6307
6617
|
# @option params [String] :call_as
|
|
@@ -6309,7 +6619,7 @@ module Aws::CloudFormation
|
|
|
6309
6619
|
# account administrator in the management account or as a delegated
|
|
6310
6620
|
# administrator in a member account.
|
|
6311
6621
|
#
|
|
6312
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
6622
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
6313
6623
|
# self-managed permissions.
|
|
6314
6624
|
#
|
|
6315
6625
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -6351,6 +6661,8 @@ module Aws::CloudFormation
|
|
|
6351
6661
|
# resp.summaries[0].status #=> String, one of "ACTIVE", "DELETED"
|
|
6352
6662
|
# resp.summaries[0].auto_deployment.enabled #=> Boolean
|
|
6353
6663
|
# resp.summaries[0].auto_deployment.retain_stacks_on_account_removal #=> Boolean
|
|
6664
|
+
# resp.summaries[0].auto_deployment.depends_on #=> Array
|
|
6665
|
+
# resp.summaries[0].auto_deployment.depends_on[0] #=> String
|
|
6354
6666
|
# resp.summaries[0].permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
|
|
6355
6667
|
# resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
|
6356
6668
|
# resp.summaries[0].last_drift_check_timestamp #=> Time
|
|
@@ -6374,8 +6686,8 @@ module Aws::CloudFormation
|
|
|
6374
6686
|
# been deleted).
|
|
6375
6687
|
#
|
|
6376
6688
|
# @option params [String] :next_token
|
|
6377
|
-
#
|
|
6378
|
-
#
|
|
6689
|
+
# The token for the next set of items to return. (You received this
|
|
6690
|
+
# token from a previous call.)
|
|
6379
6691
|
#
|
|
6380
6692
|
# @option params [Array<String>] :stack_status_filter
|
|
6381
6693
|
# Stack status to use as a filter. Specify one or more stack status
|
|
@@ -6412,6 +6724,9 @@ module Aws::CloudFormation
|
|
|
6412
6724
|
# resp.stack_summaries[0].root_id #=> String
|
|
6413
6725
|
# resp.stack_summaries[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
|
6414
6726
|
# resp.stack_summaries[0].drift_information.last_check_timestamp #=> Time
|
|
6727
|
+
# resp.stack_summaries[0].last_operations #=> Array
|
|
6728
|
+
# resp.stack_summaries[0].last_operations[0].operation_type #=> String, one of "CREATE_STACK", "UPDATE_STACK", "DELETE_STACK", "CONTINUE_ROLLBACK", "ROLLBACK", "CREATE_CHANGESET"
|
|
6729
|
+
# resp.stack_summaries[0].last_operations[0].operation_id #=> String
|
|
6415
6730
|
# resp.next_token #=> String
|
|
6416
6731
|
#
|
|
6417
6732
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStacks AWS API Documentation
|
|
@@ -6452,12 +6767,8 @@ module Aws::CloudFormation
|
|
|
6452
6767
|
# request parameter to get the next set of results.
|
|
6453
6768
|
#
|
|
6454
6769
|
# @option params [String] :next_token
|
|
6455
|
-
#
|
|
6456
|
-
#
|
|
6457
|
-
# a token. To retrieve the next set of results, call this action again
|
|
6458
|
-
# and assign that token to the request object's `NextToken` parameter.
|
|
6459
|
-
# If there are no remaining results, the previous response object's
|
|
6460
|
-
# `NextToken` parameter is set to `null`.
|
|
6770
|
+
# The token for the next set of items to return. (You received this
|
|
6771
|
+
# token from a previous call.)
|
|
6461
6772
|
#
|
|
6462
6773
|
# @return [Types::ListTypeRegistrationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6463
6774
|
#
|
|
@@ -6518,12 +6829,8 @@ module Aws::CloudFormation
|
|
|
6518
6829
|
# request parameter to get the next set of results.
|
|
6519
6830
|
#
|
|
6520
6831
|
# @option params [String] :next_token
|
|
6521
|
-
#
|
|
6522
|
-
#
|
|
6523
|
-
# a token. To retrieve the next set of results, call this action again
|
|
6524
|
-
# and assign that token to the request object's `NextToken` parameter.
|
|
6525
|
-
# If there are no remaining results, the previous response object's
|
|
6526
|
-
# `NextToken` parameter is set to `null`.
|
|
6832
|
+
# The token for the next set of items to return. (You received this
|
|
6833
|
+
# token from a previous call.)
|
|
6527
6834
|
#
|
|
6528
6835
|
# @option params [String] :deprecated_status
|
|
6529
6836
|
# The deprecation status of the extension versions that you want to get
|
|
@@ -6586,8 +6893,9 @@ module Aws::CloudFormation
|
|
|
6586
6893
|
req.send_request(options)
|
|
6587
6894
|
end
|
|
6588
6895
|
|
|
6589
|
-
# Returns summary information about
|
|
6590
|
-
#
|
|
6896
|
+
# Returns summary information about all extensions, including your
|
|
6897
|
+
# private resource types, modules, and Hooks as well as all public
|
|
6898
|
+
# extensions from Amazon Web Services and third-party publishers.
|
|
6591
6899
|
#
|
|
6592
6900
|
# @option params [String] :visibility
|
|
6593
6901
|
# The scope at which the extensions are visible and usable in
|
|
@@ -6604,8 +6912,7 @@ module Aws::CloudFormation
|
|
|
6604
6912
|
# Region.
|
|
6605
6913
|
# * `PUBLIC`: Extensions that are publicly visible and available to be
|
|
6606
6914
|
# activated within any Amazon Web Services account. This includes
|
|
6607
|
-
# extensions from Amazon Web Services
|
|
6608
|
-
# publishers.
|
|
6915
|
+
# extensions from Amazon Web Services and third-party publishers.
|
|
6609
6916
|
#
|
|
6610
6917
|
# The default is `PRIVATE`.
|
|
6611
6918
|
#
|
|
@@ -6660,12 +6967,8 @@ module Aws::CloudFormation
|
|
|
6660
6967
|
# request parameter to get the next set of results.
|
|
6661
6968
|
#
|
|
6662
6969
|
# @option params [String] :next_token
|
|
6663
|
-
#
|
|
6664
|
-
#
|
|
6665
|
-
# a token. To retrieve the next set of results, call this action again
|
|
6666
|
-
# and assign that token to the request object's `NextToken` parameter.
|
|
6667
|
-
# If there are no remaining results, the previous response object's
|
|
6668
|
-
# `NextToken` parameter is set to `null`.
|
|
6970
|
+
# The token for the next set of items to return. (You received this
|
|
6971
|
+
# token from a previous call.)
|
|
6669
6972
|
#
|
|
6670
6973
|
# @return [Types::ListTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6671
6974
|
#
|
|
@@ -7139,6 +7442,7 @@ module Aws::CloudFormation
|
|
|
7139
7442
|
# @return [Types::RollbackStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7140
7443
|
#
|
|
7141
7444
|
# * {Types::RollbackStackOutput#stack_id #stack_id} => String
|
|
7445
|
+
# * {Types::RollbackStackOutput#operation_id #operation_id} => String
|
|
7142
7446
|
#
|
|
7143
7447
|
# @example Request syntax with placeholder values
|
|
7144
7448
|
#
|
|
@@ -7152,6 +7456,7 @@ module Aws::CloudFormation
|
|
|
7152
7456
|
# @example Response structure
|
|
7153
7457
|
#
|
|
7154
7458
|
# resp.stack_id #=> String
|
|
7459
|
+
# resp.operation_id #=> String
|
|
7155
7460
|
#
|
|
7156
7461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStack AWS API Documentation
|
|
7157
7462
|
#
|
|
@@ -7206,28 +7511,36 @@ module Aws::CloudFormation
|
|
|
7206
7511
|
req.send_request(options)
|
|
7207
7512
|
end
|
|
7208
7513
|
|
|
7209
|
-
# Specifies the configuration data for a
|
|
7210
|
-
#
|
|
7514
|
+
# Specifies the configuration data for a CloudFormation extension, such
|
|
7515
|
+
# as a resource or Hook, in the given account and Region.
|
|
7516
|
+
#
|
|
7517
|
+
# For more information, see [Edit configuration data for extensions in
|
|
7518
|
+
# your account][1] in the *CloudFormation User Guide*.
|
|
7211
7519
|
#
|
|
7212
7520
|
# To view the current configuration data for an extension, refer to the
|
|
7213
|
-
# `ConfigurationSchema` element of [DescribeType][
|
|
7214
|
-
# information, see [Edit configuration data for extensions in your
|
|
7215
|
-
# account][2] in the *CloudFormation User Guide*.
|
|
7521
|
+
# `ConfigurationSchema` element of [DescribeType][2].
|
|
7216
7522
|
#
|
|
7217
7523
|
# It's strongly recommended that you use dynamic references to restrict
|
|
7218
7524
|
# sensitive configuration definitions, such as third-party credentials.
|
|
7219
|
-
# For more
|
|
7220
|
-
#
|
|
7221
|
-
# User Guide*.
|
|
7525
|
+
# For more information, see [Specify values stored in other services
|
|
7526
|
+
# using dynamic references][3] in the *CloudFormation User Guide*.
|
|
7222
7527
|
#
|
|
7528
|
+
# For more information about setting the configuration data for resource
|
|
7529
|
+
# types, see [Defining the account-level configuration of an
|
|
7530
|
+
# extension][4] in the *CloudFormation Command Line Interface (CLI) User
|
|
7531
|
+
# Guide*. For more information about setting the configuration data for
|
|
7532
|
+
# Hooks, see the [CloudFormation Hooks User Guide][5].
|
|
7223
7533
|
#
|
|
7224
7534
|
#
|
|
7225
|
-
#
|
|
7226
|
-
# [
|
|
7535
|
+
#
|
|
7536
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html
|
|
7537
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
|
7227
7538
|
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html
|
|
7539
|
+
# [4]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
|
|
7540
|
+
# [5]: https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html
|
|
7228
7541
|
#
|
|
7229
7542
|
# @option params [String] :type_arn
|
|
7230
|
-
# The Amazon Resource Name (ARN) for the extension
|
|
7543
|
+
# The Amazon Resource Name (ARN) for the extension in this account and
|
|
7231
7544
|
# Region.
|
|
7232
7545
|
#
|
|
7233
7546
|
# For public extensions, this will be the ARN assigned when you call the
|
|
@@ -7245,18 +7558,15 @@ module Aws::CloudFormation
|
|
|
7245
7558
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
|
7246
7559
|
#
|
|
7247
7560
|
# @option params [required, String] :configuration
|
|
7248
|
-
# The configuration data for the extension
|
|
7561
|
+
# The configuration data for the extension in this account and Region.
|
|
7249
7562
|
#
|
|
7250
|
-
# The configuration data must be formatted as JSON
|
|
7251
|
-
# the schema returned in the `
|
|
7252
|
-
# [DescribeType][1].
|
|
7253
|
-
# account-level configuration of an extension][2] in the *CloudFormation
|
|
7254
|
-
# Command Line Interface (CLI) User Guide*.
|
|
7563
|
+
# The configuration data must be formatted as JSON and validate against
|
|
7564
|
+
# the extension's schema returned in the `Schema` response element of
|
|
7565
|
+
# [DescribeType][1].
|
|
7255
7566
|
#
|
|
7256
7567
|
#
|
|
7257
7568
|
#
|
|
7258
7569
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
|
7259
|
-
# [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
|
|
7260
7570
|
#
|
|
7261
7571
|
# @option params [String] :configuration_alias
|
|
7262
7572
|
# An alias by which to refer to this extension configuration data.
|
|
@@ -7365,10 +7675,10 @@ module Aws::CloudFormation
|
|
|
7365
7675
|
#
|
|
7366
7676
|
# @option params [required, String] :unique_id
|
|
7367
7677
|
# A unique ID of the signal. When you signal Amazon EC2 instances or
|
|
7368
|
-
# Auto Scaling groups, specify the instance ID that you are
|
|
7369
|
-
# the unique ID. If you send multiple signals to a single
|
|
7370
|
-
# as signaling a wait condition), each signal requires a
|
|
7371
|
-
# unique ID.
|
|
7678
|
+
# Amazon EC2 Auto Scaling groups, specify the instance ID that you are
|
|
7679
|
+
# signaling as the unique ID. If you send multiple signals to a single
|
|
7680
|
+
# resource (such as signaling a wait condition), each signal requires a
|
|
7681
|
+
# different unique ID.
|
|
7372
7682
|
#
|
|
7373
7683
|
# @option params [required, String] :status
|
|
7374
7684
|
# The status of the signal, which is either success or failure. A
|
|
@@ -7447,23 +7757,24 @@ module Aws::CloudFormation
|
|
|
7447
7757
|
req.send_request(options)
|
|
7448
7758
|
end
|
|
7449
7759
|
|
|
7450
|
-
# Stops an in-progress operation on a
|
|
7760
|
+
# Stops an in-progress operation on a StackSet and its associated stack
|
|
7451
7761
|
# instances. StackSets will cancel all the unstarted stack instance
|
|
7452
7762
|
# deployments and wait for those are in-progress to complete.
|
|
7453
7763
|
#
|
|
7454
7764
|
# @option params [required, String] :stack_set_name
|
|
7455
|
-
# The name or unique ID of the
|
|
7765
|
+
# The name or unique ID of the StackSet that you want to stop the
|
|
7456
7766
|
# operation for.
|
|
7457
7767
|
#
|
|
7458
7768
|
# @option params [required, String] :operation_id
|
|
7459
7769
|
# The ID of the stack operation.
|
|
7460
7770
|
#
|
|
7461
7771
|
# @option params [String] :call_as
|
|
7462
|
-
#
|
|
7463
|
-
#
|
|
7464
|
-
# a
|
|
7772
|
+
# Specifies whether you are acting as an account administrator in the
|
|
7773
|
+
# organization's management account or as a delegated administrator in
|
|
7774
|
+
# a member account. Valid only if the StackSet uses service-managed
|
|
7775
|
+
# permissions.
|
|
7465
7776
|
#
|
|
7466
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
7777
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
7467
7778
|
# self-managed permissions.
|
|
7468
7779
|
#
|
|
7469
7780
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -7779,10 +8090,20 @@ module Aws::CloudFormation
|
|
|
7779
8090
|
# Reuse the existing template that is associated with the stack that you
|
|
7780
8091
|
# are updating.
|
|
7781
8092
|
#
|
|
8093
|
+
# When using templates with the `AWS::LanguageExtensions` transform,
|
|
8094
|
+
# provide the template instead of using `UsePreviousTemplate` to ensure
|
|
8095
|
+
# new parameter values and Systems Manager parameter updates are applied
|
|
8096
|
+
# correctly. For more information, see [AWS::LanguageExtensions
|
|
8097
|
+
# transform][1].
|
|
8098
|
+
#
|
|
7782
8099
|
# Conditional: You must specify only one of the following parameters:
|
|
7783
8100
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
|
7784
8101
|
# `true`.
|
|
7785
8102
|
#
|
|
8103
|
+
#
|
|
8104
|
+
#
|
|
8105
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/transform-aws-languageextensions.html
|
|
8106
|
+
#
|
|
7786
8107
|
# @option params [String] :stack_policy_during_update_body
|
|
7787
8108
|
# Structure that contains the temporary overriding stack policy body.
|
|
7788
8109
|
# You can specify either the `StackPolicyDuringUpdateBody` or the
|
|
@@ -7911,16 +8232,15 @@ module Aws::CloudFormation
|
|
|
7911
8232
|
# [12]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
|
7912
8233
|
#
|
|
7913
8234
|
# @option params [Array<String>] :resource_types
|
|
7914
|
-
#
|
|
7915
|
-
#
|
|
7916
|
-
# or `Custom::MyCustomInstance`.
|
|
8235
|
+
# Specifies which resource types you can work with, such as
|
|
8236
|
+
# `AWS::EC2::Instance` or `Custom::MyCustomInstance`.
|
|
7917
8237
|
#
|
|
7918
8238
|
# If the list of resource types doesn't include a resource that you're
|
|
7919
8239
|
# updating, the stack update fails. By default, CloudFormation grants
|
|
7920
8240
|
# permissions to all resource types. IAM uses this parameter for
|
|
7921
8241
|
# CloudFormation-specific condition keys in IAM policies. For more
|
|
7922
|
-
# information, see [Control access with Identity and
|
|
7923
|
-
# Management][1].
|
|
8242
|
+
# information, see [Control CloudFormation access with Identity and
|
|
8243
|
+
# Access Management][1].
|
|
7924
8244
|
#
|
|
7925
8245
|
# <note markdown="1"> Only one of the `Capabilities` and `ResourceType` parameters can be
|
|
7926
8246
|
# specified.
|
|
@@ -8025,6 +8345,7 @@ module Aws::CloudFormation
|
|
|
8025
8345
|
# @return [Types::UpdateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8026
8346
|
#
|
|
8027
8347
|
# * {Types::UpdateStackOutput#stack_id #stack_id} => String
|
|
8348
|
+
# * {Types::UpdateStackOutput#operation_id #operation_id} => String
|
|
8028
8349
|
#
|
|
8029
8350
|
# @example Request syntax with placeholder values
|
|
8030
8351
|
#
|
|
@@ -8072,6 +8393,7 @@ module Aws::CloudFormation
|
|
|
8072
8393
|
# @example Response structure
|
|
8073
8394
|
#
|
|
8074
8395
|
# resp.stack_id #=> String
|
|
8396
|
+
# resp.operation_id #=> String
|
|
8075
8397
|
#
|
|
8076
8398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStack AWS API Documentation
|
|
8077
8399
|
#
|
|
@@ -8090,18 +8412,18 @@ module Aws::CloudFormation
|
|
|
8090
8412
|
# accounts where they already exist; to create additional stack
|
|
8091
8413
|
# instances, use [CreateStackInstances][1].
|
|
8092
8414
|
#
|
|
8093
|
-
# During
|
|
8415
|
+
# During StackSet updates, any parameters overridden for a stack
|
|
8094
8416
|
# instance aren't updated, but retain their overridden value.
|
|
8095
8417
|
#
|
|
8096
8418
|
# You can only update the parameter *values* that are specified in the
|
|
8097
|
-
#
|
|
8098
|
-
#
|
|
8099
|
-
#
|
|
8100
|
-
#
|
|
8101
|
-
#
|
|
8102
|
-
#
|
|
8103
|
-
#
|
|
8104
|
-
#
|
|
8419
|
+
# StackSet. To add or delete a parameter itself, use [UpdateStackSet][2]
|
|
8420
|
+
# to update the StackSet template. If you add a parameter to a template,
|
|
8421
|
+
# before you can override the parameter value specified in the StackSet
|
|
8422
|
+
# you must first use [UpdateStackSet][2] to update all stack instances
|
|
8423
|
+
# with the updated template and parameter value specified in the
|
|
8424
|
+
# StackSet. Once a stack instance has been updated with the new
|
|
8425
|
+
# parameter, you can then override the parameter value using
|
|
8426
|
+
# `UpdateStackInstances`.
|
|
8105
8427
|
#
|
|
8106
8428
|
# <note markdown="1"> The maximum number of organizational unit (OUs) supported by a
|
|
8107
8429
|
# `UpdateStackInstances` operation is 50.
|
|
@@ -8123,12 +8445,12 @@ module Aws::CloudFormation
|
|
|
8123
8445
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
|
8124
8446
|
#
|
|
8125
8447
|
# @option params [required, String] :stack_set_name
|
|
8126
|
-
# The name or unique ID of the
|
|
8448
|
+
# The name or unique ID of the StackSet associated with the stack
|
|
8127
8449
|
# instances.
|
|
8128
8450
|
#
|
|
8129
8451
|
# @option params [Array<String>] :accounts
|
|
8130
8452
|
# \[Self-managed permissions\] The account IDs of one or more Amazon Web
|
|
8131
|
-
# Services accounts
|
|
8453
|
+
# Services accounts in which you want to update parameter values for
|
|
8132
8454
|
# stack instances. The overridden parameter values will be applied to
|
|
8133
8455
|
# all stack instances in the specified accounts and Amazon Web Services
|
|
8134
8456
|
# Regions.
|
|
@@ -8136,7 +8458,7 @@ module Aws::CloudFormation
|
|
|
8136
8458
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
|
8137
8459
|
#
|
|
8138
8460
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
8139
|
-
# \[Service-managed permissions\] The Organizations accounts
|
|
8461
|
+
# \[Service-managed permissions\] The Organizations accounts in which
|
|
8140
8462
|
# you want to update parameter values for stack instances. If your
|
|
8141
8463
|
# update targets OUs, the overridden parameter values only apply to the
|
|
8142
8464
|
# accounts that are currently in the target OUs and their child OUs.
|
|
@@ -8168,22 +8490,22 @@ module Aws::CloudFormation
|
|
|
8168
8490
|
# specify both a value and set `UsePreviousValue` to `true`.)
|
|
8169
8491
|
#
|
|
8170
8492
|
# * To set an overridden parameter back to the value specified in the
|
|
8171
|
-
#
|
|
8493
|
+
# StackSet, specify a parameter list but don't include the parameter
|
|
8172
8494
|
# in the list.
|
|
8173
8495
|
#
|
|
8174
8496
|
# * To leave all parameters set to their present values, don't specify
|
|
8175
8497
|
# this property at all.
|
|
8176
8498
|
#
|
|
8177
|
-
# During
|
|
8499
|
+
# During StackSet updates, any parameter values overridden for a stack
|
|
8178
8500
|
# instance aren't updated, but retain their overridden value.
|
|
8179
8501
|
#
|
|
8180
8502
|
# You can only override the parameter *values* that are specified in the
|
|
8181
|
-
#
|
|
8182
|
-
#
|
|
8183
|
-
#
|
|
8184
|
-
#
|
|
8185
|
-
#
|
|
8186
|
-
#
|
|
8503
|
+
# StackSet. To add or delete a parameter itself, use `UpdateStackSet` to
|
|
8504
|
+
# update the StackSet template. If you add a parameter to a template,
|
|
8505
|
+
# before you can override the parameter value specified in the StackSet
|
|
8506
|
+
# you must first use [UpdateStackSet][1] to update all stack instances
|
|
8507
|
+
# with the updated template and parameter value specified in the
|
|
8508
|
+
# StackSet. Once a stack instance has been updated with the new
|
|
8187
8509
|
# parameter, you can then override the parameter value using
|
|
8188
8510
|
# `UpdateStackInstances`.
|
|
8189
8511
|
#
|
|
@@ -8192,14 +8514,14 @@ module Aws::CloudFormation
|
|
|
8192
8514
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
|
8193
8515
|
#
|
|
8194
8516
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
8195
|
-
# Preferences for how CloudFormation performs this
|
|
8517
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
|
8196
8518
|
#
|
|
8197
8519
|
# @option params [String] :operation_id
|
|
8198
|
-
# The unique identifier for this
|
|
8520
|
+
# The unique identifier for this StackSet operation.
|
|
8199
8521
|
#
|
|
8200
8522
|
# The operation ID also functions as an idempotency token, to ensure
|
|
8201
|
-
# that CloudFormation performs the
|
|
8202
|
-
#
|
|
8523
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
|
8524
|
+
# you retry the request multiple times. You might retry StackSet
|
|
8203
8525
|
# operation requests to ensure that CloudFormation successfully received
|
|
8204
8526
|
# them.
|
|
8205
8527
|
#
|
|
@@ -8214,7 +8536,7 @@ module Aws::CloudFormation
|
|
|
8214
8536
|
# account administrator in the organization's management account or as
|
|
8215
8537
|
# a delegated administrator in a member account.
|
|
8216
8538
|
#
|
|
8217
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
8539
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
8218
8540
|
# self-managed permissions.
|
|
8219
8541
|
#
|
|
8220
8542
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -8281,14 +8603,14 @@ module Aws::CloudFormation
|
|
|
8281
8603
|
req.send_request(options)
|
|
8282
8604
|
end
|
|
8283
8605
|
|
|
8284
|
-
# Updates the
|
|
8606
|
+
# Updates the StackSet and associated stack instances in the specified
|
|
8285
8607
|
# accounts and Amazon Web Services Regions.
|
|
8286
8608
|
#
|
|
8287
|
-
# Even if the
|
|
8288
|
-
#
|
|
8289
|
-
# tolerance), the
|
|
8290
|
-
# CreateStackInstances calls on the specified
|
|
8291
|
-
#
|
|
8609
|
+
# Even if the StackSet operation created by updating the StackSet fails
|
|
8610
|
+
# (completely or partially, below or above a specified failure
|
|
8611
|
+
# tolerance), the StackSet is updated with your changes. Subsequent
|
|
8612
|
+
# CreateStackInstances calls on the specified StackSet use the updated
|
|
8613
|
+
# StackSet.
|
|
8292
8614
|
#
|
|
8293
8615
|
# <note markdown="1"> The maximum number of organizational unit (OUs) supported by a
|
|
8294
8616
|
# `UpdateStackSet` operation is 50.
|
|
@@ -8305,7 +8627,7 @@ module Aws::CloudFormation
|
|
|
8305
8627
|
# </note>
|
|
8306
8628
|
#
|
|
8307
8629
|
# @option params [required, String] :stack_set_name
|
|
8308
|
-
# The name or unique ID of the
|
|
8630
|
+
# The name or unique ID of the StackSet that you want to update.
|
|
8309
8631
|
#
|
|
8310
8632
|
# @option params [String] :description
|
|
8311
8633
|
# A brief description of updates that you are making.
|
|
@@ -8328,19 +8650,19 @@ module Aws::CloudFormation
|
|
|
8328
8650
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
|
8329
8651
|
#
|
|
8330
8652
|
# @option params [Boolean] :use_previous_template
|
|
8331
|
-
# Use the existing template that's associated with the
|
|
8653
|
+
# Use the existing template that's associated with the StackSet that
|
|
8332
8654
|
# you're updating.
|
|
8333
8655
|
#
|
|
8334
8656
|
# Conditional: You must specify only one of the following parameters:
|
|
8335
8657
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
|
8336
8658
|
#
|
|
8337
8659
|
# @option params [Array<Types::Parameter>] :parameters
|
|
8338
|
-
# A list of input parameters for the
|
|
8660
|
+
# A list of input parameters for the StackSet template.
|
|
8339
8661
|
#
|
|
8340
8662
|
# @option params [Array<String>] :capabilities
|
|
8341
8663
|
# In some cases, you must explicitly acknowledge that your stack
|
|
8342
8664
|
# template contains certain capabilities in order for CloudFormation to
|
|
8343
|
-
# update the
|
|
8665
|
+
# update the StackSet and its associated stack instances.
|
|
8344
8666
|
#
|
|
8345
8667
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
|
8346
8668
|
#
|
|
@@ -8381,21 +8703,20 @@ module Aws::CloudFormation
|
|
|
8381
8703
|
#
|
|
8382
8704
|
# * `CAPABILITY_AUTO_EXPAND`
|
|
8383
8705
|
#
|
|
8384
|
-
# Some templates reference macros. If your
|
|
8385
|
-
# references one or more macros, you must update the
|
|
8386
|
-
#
|
|
8387
|
-
#
|
|
8388
|
-
#
|
|
8389
|
-
#
|
|
8706
|
+
# Some templates reference macros. If your StackSet template
|
|
8707
|
+
# references one or more macros, you must update the StackSet directly
|
|
8708
|
+
# from the processed template, without first reviewing the resulting
|
|
8709
|
+
# changes in a change set. To update the StackSet directly, you must
|
|
8710
|
+
# acknowledge this capability. For more information, see [Perform
|
|
8711
|
+
# custom processing on CloudFormation templates with template
|
|
8390
8712
|
# macros][9].
|
|
8391
8713
|
#
|
|
8392
|
-
#
|
|
8714
|
+
# StackSets with service-managed permissions do not currently support
|
|
8393
8715
|
# the use of macros in templates. (This includes the
|
|
8394
8716
|
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
|
8395
8717
|
# macros hosted by CloudFormation.) Even if you specify this
|
|
8396
|
-
# capability for a
|
|
8397
|
-
# reference a macro in your template the
|
|
8398
|
-
# fail.
|
|
8718
|
+
# capability for a StackSet with service-managed permissions, if you
|
|
8719
|
+
# reference a macro in your template the StackSet operation will fail.
|
|
8399
8720
|
#
|
|
8400
8721
|
#
|
|
8401
8722
|
#
|
|
@@ -8412,23 +8733,23 @@ module Aws::CloudFormation
|
|
|
8412
8733
|
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
|
8413
8734
|
#
|
|
8414
8735
|
# @option params [Array<Types::Tag>] :tags
|
|
8415
|
-
# The key-value pairs to associate with this
|
|
8736
|
+
# The key-value pairs to associate with this StackSet and the stacks
|
|
8416
8737
|
# created from it. CloudFormation also propagates these tags to
|
|
8417
8738
|
# supported resources that are created in the stacks. You can specify a
|
|
8418
8739
|
# maximum number of 50 tags.
|
|
8419
8740
|
#
|
|
8420
8741
|
# If you specify tags for this parameter, those tags replace any list of
|
|
8421
|
-
# tags that are currently associated with this
|
|
8742
|
+
# tags that are currently associated with this StackSet. This means:
|
|
8422
8743
|
#
|
|
8423
8744
|
# * If you don't specify this parameter, CloudFormation doesn't modify
|
|
8424
8745
|
# the stack's tags.
|
|
8425
8746
|
#
|
|
8426
8747
|
# * If you specify *any* tags using this parameter, you must specify
|
|
8427
|
-
# *all* the tags that you want associated with this
|
|
8428
|
-
# tags you've specified before (for example, when creating the
|
|
8429
|
-
#
|
|
8430
|
-
# you don't include in the updated list of tags are removed from
|
|
8431
|
-
#
|
|
8748
|
+
# *all* the tags that you want associated with this StackSet, even
|
|
8749
|
+
# tags you've specified before (for example, when creating the
|
|
8750
|
+
# StackSet or during a previous update of the StackSet.). Any tags
|
|
8751
|
+
# that you don't include in the updated list of tags are removed from
|
|
8752
|
+
# the StackSet, and therefore from the stacks and resources as well.
|
|
8432
8753
|
#
|
|
8433
8754
|
# * If you specify an empty value, CloudFormation removes all currently
|
|
8434
8755
|
# associated tags.
|
|
@@ -8436,28 +8757,28 @@ module Aws::CloudFormation
|
|
|
8436
8757
|
# If you specify new tags as part of an `UpdateStackSet` action,
|
|
8437
8758
|
# CloudFormation checks to see if you have the required IAM permission
|
|
8438
8759
|
# to tag resources. If you omit tags that are currently associated with
|
|
8439
|
-
# the
|
|
8440
|
-
#
|
|
8441
|
-
#
|
|
8442
|
-
#
|
|
8443
|
-
#
|
|
8760
|
+
# the StackSet from the list of tags you specify, CloudFormation assumes
|
|
8761
|
+
# that you want to remove those tags from the StackSet, and checks to
|
|
8762
|
+
# see if you have permission to untag resources. If you don't have the
|
|
8763
|
+
# necessary permission(s), the entire `UpdateStackSet` action fails with
|
|
8764
|
+
# an `access denied` error, and the StackSet is not updated.
|
|
8444
8765
|
#
|
|
8445
8766
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
|
8446
|
-
# Preferences for how CloudFormation performs this
|
|
8767
|
+
# Preferences for how CloudFormation performs this StackSet operation.
|
|
8447
8768
|
#
|
|
8448
8769
|
# @option params [String] :administration_role_arn
|
|
8449
8770
|
# \[Self-managed permissions\] The Amazon Resource Name (ARN) of the IAM
|
|
8450
|
-
# role to use to update this
|
|
8771
|
+
# role to use to update this StackSet.
|
|
8451
8772
|
#
|
|
8452
8773
|
# Specify an IAM role only if you are using customized administrator
|
|
8453
|
-
# roles to control which users or groups can manage specific
|
|
8774
|
+
# roles to control which users or groups can manage specific StackSets
|
|
8454
8775
|
# within the same administrator account. For more information, see
|
|
8455
8776
|
# [Grant self-managed permissions][1] in the *CloudFormation User
|
|
8456
8777
|
# Guide*.
|
|
8457
8778
|
#
|
|
8458
8779
|
# If you specified a customized administrator role when you created the
|
|
8459
|
-
#
|
|
8460
|
-
#
|
|
8780
|
+
# StackSet, you must specify a customized administrator role, even if it
|
|
8781
|
+
# is the same customized administrator role used with this StackSet
|
|
8461
8782
|
# previously.
|
|
8462
8783
|
#
|
|
8463
8784
|
#
|
|
@@ -8468,36 +8789,36 @@ module Aws::CloudFormation
|
|
|
8468
8789
|
# \[Self-managed permissions\] The name of the IAM execution role to use
|
|
8469
8790
|
# to update the stack set. If you do not specify an execution role,
|
|
8470
8791
|
# CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role
|
|
8471
|
-
# for the
|
|
8792
|
+
# for the StackSet operation.
|
|
8472
8793
|
#
|
|
8473
8794
|
# Specify an IAM role only if you are using customized execution roles
|
|
8474
8795
|
# to control which stack resources users and groups can include in their
|
|
8475
|
-
#
|
|
8796
|
+
# StackSets.
|
|
8476
8797
|
#
|
|
8477
8798
|
# If you specify a customized execution role, CloudFormation uses that
|
|
8478
8799
|
# role to update the stack. If you do not specify a customized execution
|
|
8479
8800
|
# role, CloudFormation performs the update using the role previously
|
|
8480
|
-
# associated with the
|
|
8481
|
-
# perform operations on the
|
|
8801
|
+
# associated with the StackSet, so long as you have permissions to
|
|
8802
|
+
# perform operations on the StackSet.
|
|
8482
8803
|
#
|
|
8483
8804
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
|
8484
8805
|
# \[Service-managed permissions\] The Organizations accounts in which to
|
|
8485
8806
|
# update associated stack instances.
|
|
8486
8807
|
#
|
|
8487
|
-
# To update all the stack instances associated with this
|
|
8808
|
+
# To update all the stack instances associated with this StackSet, do
|
|
8488
8809
|
# not specify `DeploymentTargets` or `Regions`.
|
|
8489
8810
|
#
|
|
8490
|
-
# If the
|
|
8811
|
+
# If the StackSet update includes changes to the template (that is, if
|
|
8491
8812
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
|
8492
8813
|
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
|
8493
8814
|
# prior to updating the stack instances in the specified accounts and
|
|
8494
|
-
# Amazon Web Services Regions. If the
|
|
8815
|
+
# Amazon Web Services Regions. If the StackSet update doesn't include
|
|
8495
8816
|
# changes to the template or parameters, CloudFormation updates the
|
|
8496
8817
|
# stack instances in the specified accounts and Regions, while leaving
|
|
8497
8818
|
# all other stack instances with their existing stack instance status.
|
|
8498
8819
|
#
|
|
8499
8820
|
# @option params [String] :permission_model
|
|
8500
|
-
# Describes how the IAM roles required for
|
|
8821
|
+
# Describes how the IAM roles required for StackSet operations are
|
|
8501
8822
|
# created. You cannot modify `PermissionModel` if there are stack
|
|
8502
8823
|
# instances associated with your stack set.
|
|
8503
8824
|
#
|
|
@@ -8508,7 +8829,7 @@ module Aws::CloudFormation
|
|
|
8508
8829
|
# * With `service-managed` permissions, StackSets automatically creates
|
|
8509
8830
|
# the IAM roles required to deploy to accounts managed by
|
|
8510
8831
|
# Organizations. For more information, see [Activate trusted access
|
|
8511
|
-
# for
|
|
8832
|
+
# for StackSets with Organizations][2].
|
|
8512
8833
|
#
|
|
8513
8834
|
#
|
|
8514
8835
|
#
|
|
@@ -8519,9 +8840,8 @@ module Aws::CloudFormation
|
|
|
8519
8840
|
# \[Service-managed permissions\] Describes whether StackSets
|
|
8520
8841
|
# automatically deploys to Organizations accounts that are added to a
|
|
8521
8842
|
# target organization or organizational unit (OU). For more information,
|
|
8522
|
-
# see [
|
|
8523
|
-
#
|
|
8524
|
-
# Guide*.
|
|
8843
|
+
# see [Enable or disable automatic deployments for StackSets in
|
|
8844
|
+
# Organizations][1] in the *CloudFormation User Guide*.
|
|
8525
8845
|
#
|
|
8526
8846
|
# If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
|
|
8527
8847
|
# `Regions`.
|
|
@@ -8531,18 +8851,18 @@ module Aws::CloudFormation
|
|
|
8531
8851
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html
|
|
8532
8852
|
#
|
|
8533
8853
|
# @option params [String] :operation_id
|
|
8534
|
-
# The unique ID for this
|
|
8854
|
+
# The unique ID for this StackSet operation.
|
|
8535
8855
|
#
|
|
8536
8856
|
# The operation ID also functions as an idempotency token, to ensure
|
|
8537
|
-
# that CloudFormation performs the
|
|
8538
|
-
#
|
|
8857
|
+
# that CloudFormation performs the StackSet operation only once, even if
|
|
8858
|
+
# you retry the request multiple times. You might retry StackSet
|
|
8539
8859
|
# operation requests to ensure that CloudFormation successfully received
|
|
8540
8860
|
# them.
|
|
8541
8861
|
#
|
|
8542
8862
|
# If you don't specify an operation ID, CloudFormation generates one
|
|
8543
8863
|
# automatically.
|
|
8544
8864
|
#
|
|
8545
|
-
# Repeating this
|
|
8865
|
+
# Repeating this StackSet operation with a new operation ID retries all
|
|
8546
8866
|
# stack instances whose status is `OUTDATED`.
|
|
8547
8867
|
#
|
|
8548
8868
|
# **A suitable default value is auto-generated.** You should normally
|
|
@@ -8551,17 +8871,17 @@ module Aws::CloudFormation
|
|
|
8551
8871
|
# @option params [Array<String>] :accounts
|
|
8552
8872
|
# \[Self-managed permissions\] The accounts in which to update
|
|
8553
8873
|
# associated stack instances. If you specify accounts, you must also
|
|
8554
|
-
# specify the Amazon Web Services Regions in which to update
|
|
8874
|
+
# specify the Amazon Web Services Regions in which to update StackSet
|
|
8555
8875
|
# instances.
|
|
8556
8876
|
#
|
|
8557
|
-
# To update *all* the stack instances associated with this
|
|
8877
|
+
# To update *all* the stack instances associated with this StackSet,
|
|
8558
8878
|
# don't specify the `Accounts` or `Regions` properties.
|
|
8559
8879
|
#
|
|
8560
|
-
# If the
|
|
8880
|
+
# If the StackSet update includes changes to the template (that is, if
|
|
8561
8881
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
|
8562
8882
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
|
8563
8883
|
# status of `OUTDATED` prior to updating the stack instances in the
|
|
8564
|
-
# specified accounts and Amazon Web Services Regions. If the
|
|
8884
|
+
# specified accounts and Amazon Web Services Regions. If the StackSet
|
|
8565
8885
|
# update does not include changes to the template or parameters,
|
|
8566
8886
|
# CloudFormation updates the stack instances in the specified accounts
|
|
8567
8887
|
# and Amazon Web Services Regions, while leaving all other stack
|
|
@@ -8570,16 +8890,16 @@ module Aws::CloudFormation
|
|
|
8570
8890
|
# @option params [Array<String>] :regions
|
|
8571
8891
|
# The Amazon Web Services Regions in which to update associated stack
|
|
8572
8892
|
# instances. If you specify Regions, you must also specify accounts in
|
|
8573
|
-
# which to update
|
|
8893
|
+
# which to update StackSet instances.
|
|
8574
8894
|
#
|
|
8575
|
-
# To update *all* the stack instances associated with this
|
|
8895
|
+
# To update *all* the stack instances associated with this StackSet, do
|
|
8576
8896
|
# not specify the `Accounts` or `Regions` properties.
|
|
8577
8897
|
#
|
|
8578
|
-
# If the
|
|
8898
|
+
# If the StackSet update includes changes to the template (that is, if
|
|
8579
8899
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
|
8580
8900
|
# `Parameters` property, CloudFormation marks all stack instances with a
|
|
8581
8901
|
# status of `OUTDATED` prior to updating the stack instances in the
|
|
8582
|
-
# specified accounts and Regions. If the
|
|
8902
|
+
# specified accounts and Regions. If the StackSet update does not
|
|
8583
8903
|
# include changes to the template or parameters, CloudFormation updates
|
|
8584
8904
|
# the stack instances in the specified accounts and Regions, while
|
|
8585
8905
|
# leaving all other stack instances with their existing stack instance
|
|
@@ -8590,7 +8910,7 @@ module Aws::CloudFormation
|
|
|
8590
8910
|
# account administrator in the organization's management account or as
|
|
8591
8911
|
# a delegated administrator in a member account.
|
|
8592
8912
|
#
|
|
8593
|
-
# By default, `SELF` is specified. Use `SELF` for
|
|
8913
|
+
# By default, `SELF` is specified. Use `SELF` for StackSets with
|
|
8594
8914
|
# self-managed permissions.
|
|
8595
8915
|
#
|
|
8596
8916
|
# * If you are signed in to the management account, specify `SELF`.
|
|
@@ -8608,7 +8928,7 @@ module Aws::CloudFormation
|
|
|
8608
8928
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
|
8609
8929
|
#
|
|
8610
8930
|
# @option params [Types::ManagedExecution] :managed_execution
|
|
8611
|
-
# Describes whether
|
|
8931
|
+
# Describes whether CloudFormation performs non-conflicting operations
|
|
8612
8932
|
# concurrently and queues conflicting operations.
|
|
8613
8933
|
#
|
|
8614
8934
|
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -8659,6 +8979,7 @@ module Aws::CloudFormation
|
|
|
8659
8979
|
# auto_deployment: {
|
|
8660
8980
|
# enabled: false,
|
|
8661
8981
|
# retain_stacks_on_account_removal: false,
|
|
8982
|
+
# depends_on: ["StackSetARN"],
|
|
8662
8983
|
# },
|
|
8663
8984
|
# operation_id: "ClientRequestToken",
|
|
8664
8985
|
# accounts: ["Account"],
|
|
@@ -8804,7 +9125,7 @@ module Aws::CloudFormation
|
|
|
8804
9125
|
tracer: tracer
|
|
8805
9126
|
)
|
|
8806
9127
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
|
8807
|
-
context[:gem_version] = '1.
|
|
9128
|
+
context[:gem_version] = '1.150.0'
|
|
8808
9129
|
Seahorse::Client::Request.new(handlers, context)
|
|
8809
9130
|
end
|
|
8810
9131
|
|