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