aws-sdk-cloudformation 1.87.0 → 1.89.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation/client.rb +50 -13
- data/lib/aws-sdk-cloudformation/client_api.rb +6 -0
- data/lib/aws-sdk-cloudformation/resource.rb +13 -2
- data/lib/aws-sdk-cloudformation/stack.rb +24 -0
- data/lib/aws-sdk-cloudformation/types.rb +69 -19
- data/lib/aws-sdk-cloudformation.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b613affeed5d4d7976aa33b943f2a3382fef0dfc2e965a7ec1f2ec0a94be9830
|
4
|
+
data.tar.gz: ad4a562426a19117bd8531bfb64c03ec4b98d3042bdca3a005a47614e3f4bb12
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2eaad6325fc781321ffd73462eaa2061d5c9ea94a45683408200a15ac356335bba8ea41a05a6478b61773b5b91eb88d309fb2dba16089078a464c1ce2250e4e9
|
7
|
+
data.tar.gz: 2248ef7b914a3e9ffa0e314571542d86ea77c52c5e61ddf07c2a3fcd52f0d41430eaf31a4e0ecab042300cd430c715e9c7ed334e35dada69dbb762f4e20c7bc8
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.89.0 (2023-09-14)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for AWS CloudFormation
|
8
|
+
|
9
|
+
1.88.0 (2023-07-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This SDK release is for the feature launch of AWS CloudFormation RetainExceptOnCreate. It adds a new parameter retainExceptOnCreate in the following APIs: CreateStack, UpdateStack, RollbackStack, ExecuteChangeSet.
|
13
|
+
|
4
14
|
1.87.0 (2023-07-24)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.89.0
|
@@ -1349,6 +1349,13 @@ module Aws::CloudFormation
|
|
1349
1349
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
|
1350
1350
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
|
1351
1351
|
#
|
1352
|
+
# @option params [Boolean] :retain_except_on_create
|
1353
|
+
# When set to `true`, newly created resources are deleted when the
|
1354
|
+
# operation rolls back. This includes newly created resources marked
|
1355
|
+
# with a deletion policy of `Retain`.
|
1356
|
+
#
|
1357
|
+
# Default: `false`
|
1358
|
+
#
|
1352
1359
|
# @return [Types::CreateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1353
1360
|
#
|
1354
1361
|
# * {Types::CreateStackOutput#stack_id #stack_id} => String
|
@@ -1393,6 +1400,7 @@ module Aws::CloudFormation
|
|
1393
1400
|
# ],
|
1394
1401
|
# client_request_token: "ClientRequestToken",
|
1395
1402
|
# enable_termination_protection: false,
|
1403
|
+
# retain_except_on_create: false,
|
1396
1404
|
# })
|
1397
1405
|
#
|
1398
1406
|
# @example Response structure
|
@@ -1684,10 +1692,10 @@ module Aws::CloudFormation
|
|
1684
1692
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
1685
1693
|
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
|
1686
1694
|
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
|
1687
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities
|
1688
|
-
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html
|
1689
|
-
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
1690
|
-
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html
|
1695
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
1696
|
+
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
1697
|
+
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
1698
|
+
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
1691
1699
|
#
|
1692
1700
|
# @option params [Array<Types::Tag>] :tags
|
1693
1701
|
# The key-value pairs to associate with this stack set and the stacks
|
@@ -1712,7 +1720,7 @@ module Aws::CloudFormation
|
|
1712
1720
|
#
|
1713
1721
|
#
|
1714
1722
|
#
|
1715
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html
|
1723
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
|
1716
1724
|
#
|
1717
1725
|
# @option params [String] :execution_role_name
|
1718
1726
|
# The name of the IAM execution role to use to create the stack set. If
|
@@ -3222,8 +3230,12 @@ module Aws::CloudFormation
|
|
3222
3230
|
#
|
3223
3231
|
# @option params [String] :stack_name
|
3224
3232
|
# <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
|
3225
|
-
# response that describes all resources in the account
|
3226
|
-
# `ListStacks` and `DescribeStacks`
|
3233
|
+
# response that describes all resources in the account, which can impact
|
3234
|
+
# performance. This requires `ListStacks` and `DescribeStacks`
|
3235
|
+
# permissions.
|
3236
|
+
#
|
3237
|
+
# Consider using the ListStacks API if you're not passing a parameter
|
3238
|
+
# to `StackName`.
|
3227
3239
|
#
|
3228
3240
|
# The IAM policy below can be added to IAM policies when you want to
|
3229
3241
|
# limit resource-level permissions and avoid returning a response when
|
@@ -3305,6 +3317,7 @@ module Aws::CloudFormation
|
|
3305
3317
|
# resp.stacks[0].root_id #=> String
|
3306
3318
|
# resp.stacks[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
|
3307
3319
|
# resp.stacks[0].drift_information.last_check_timestamp #=> Time
|
3320
|
+
# resp.stacks[0].retain_except_on_create #=> Boolean
|
3308
3321
|
# resp.next_token #=> String
|
3309
3322
|
#
|
3310
3323
|
#
|
@@ -3871,6 +3884,13 @@ module Aws::CloudFormation
|
|
3871
3884
|
#
|
3872
3885
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html
|
3873
3886
|
#
|
3887
|
+
# @option params [Boolean] :retain_except_on_create
|
3888
|
+
# When set to `true`, newly created resources are deleted when the
|
3889
|
+
# operation rolls back. This includes newly created resources marked
|
3890
|
+
# with a deletion policy of `Retain`.
|
3891
|
+
#
|
3892
|
+
# Default: `false`
|
3893
|
+
#
|
3874
3894
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3875
3895
|
#
|
3876
3896
|
# @example Request syntax with placeholder values
|
@@ -3880,6 +3900,7 @@ module Aws::CloudFormation
|
|
3880
3900
|
# stack_name: "StackNameOrId",
|
3881
3901
|
# client_request_token: "ClientRequestToken",
|
3882
3902
|
# disable_rollback: false,
|
3903
|
+
# retain_except_on_create: false,
|
3883
3904
|
# })
|
3884
3905
|
#
|
3885
3906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSet AWS API Documentation
|
@@ -5679,6 +5700,13 @@ module Aws::CloudFormation
|
|
5679
5700
|
# @option params [String] :client_request_token
|
5680
5701
|
# A unique identifier for this `RollbackStack` request.
|
5681
5702
|
#
|
5703
|
+
# @option params [Boolean] :retain_except_on_create
|
5704
|
+
# When set to `true`, newly created resources are deleted when the
|
5705
|
+
# operation rolls back. This includes newly created resources marked
|
5706
|
+
# with a deletion policy of `Retain`.
|
5707
|
+
#
|
5708
|
+
# Default: `false`
|
5709
|
+
#
|
5682
5710
|
# @return [Types::RollbackStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5683
5711
|
#
|
5684
5712
|
# * {Types::RollbackStackOutput#stack_id #stack_id} => String
|
@@ -5689,6 +5717,7 @@ module Aws::CloudFormation
|
|
5689
5717
|
# stack_name: "StackNameOrId", # required
|
5690
5718
|
# role_arn: "RoleARN",
|
5691
5719
|
# client_request_token: "ClientRequestToken",
|
5720
|
+
# retain_except_on_create: false,
|
5692
5721
|
# })
|
5693
5722
|
#
|
5694
5723
|
# @example Response structure
|
@@ -6363,6 +6392,13 @@ module Aws::CloudFormation
|
|
6363
6392
|
# token in the following format:
|
6364
6393
|
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
|
6365
6394
|
#
|
6395
|
+
# @option params [Boolean] :retain_except_on_create
|
6396
|
+
# When set to `true`, newly created resources are deleted when the
|
6397
|
+
# operation rolls back. This includes newly created resources marked
|
6398
|
+
# with a deletion policy of `Retain`.
|
6399
|
+
#
|
6400
|
+
# Default: `false`
|
6401
|
+
#
|
6366
6402
|
# @return [Types::UpdateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6367
6403
|
#
|
6368
6404
|
# * {Types::UpdateStackOutput#stack_id #stack_id} => String
|
@@ -6407,6 +6443,7 @@ module Aws::CloudFormation
|
|
6407
6443
|
# ],
|
6408
6444
|
# disable_rollback: false,
|
6409
6445
|
# client_request_token: "ClientRequestToken",
|
6446
|
+
# retain_except_on_create: false,
|
6410
6447
|
# })
|
6411
6448
|
#
|
6412
6449
|
# @example Response structure
|
@@ -6729,10 +6766,10 @@ module Aws::CloudFormation
|
|
6729
6766
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
6730
6767
|
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
|
6731
6768
|
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
|
6732
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities
|
6733
|
-
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html
|
6734
|
-
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
6735
|
-
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html
|
6769
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
6770
|
+
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
6771
|
+
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
6772
|
+
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
6736
6773
|
#
|
6737
6774
|
# @option params [Array<Types::Tag>] :tags
|
6738
6775
|
# The key-value pairs to associate with this stack set and the stacks
|
@@ -6785,7 +6822,7 @@ module Aws::CloudFormation
|
|
6785
6822
|
#
|
6786
6823
|
#
|
6787
6824
|
#
|
6788
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html
|
6825
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
|
6789
6826
|
#
|
6790
6827
|
# @option params [String] :execution_role_name
|
6791
6828
|
# The name of the IAM execution role to use to update the stack set. If
|
@@ -7123,7 +7160,7 @@ module Aws::CloudFormation
|
|
7123
7160
|
params: params,
|
7124
7161
|
config: config)
|
7125
7162
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
7126
|
-
context[:gem_version] = '1.
|
7163
|
+
context[:gem_version] = '1.89.0'
|
7127
7164
|
Seahorse::Client::Request.new(handlers, context)
|
7128
7165
|
end
|
7129
7166
|
|
@@ -329,6 +329,7 @@ module Aws::CloudFormation
|
|
329
329
|
ResourceTypes = Shapes::ListShape.new(name: 'ResourceTypes')
|
330
330
|
ResourcesToImport = Shapes::ListShape.new(name: 'ResourcesToImport')
|
331
331
|
ResourcesToSkip = Shapes::ListShape.new(name: 'ResourcesToSkip')
|
332
|
+
RetainExceptOnCreate = Shapes::BooleanShape.new(name: 'RetainExceptOnCreate')
|
332
333
|
RetainResources = Shapes::ListShape.new(name: 'RetainResources')
|
333
334
|
RetainStacks = Shapes::BooleanShape.new(name: 'RetainStacks')
|
334
335
|
RetainStacksNullable = Shapes::BooleanShape.new(name: 'RetainStacksNullable')
|
@@ -650,6 +651,7 @@ module Aws::CloudFormation
|
|
650
651
|
CreateStackInput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
651
652
|
CreateStackInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
652
653
|
CreateStackInput.add_member(:enable_termination_protection, Shapes::ShapeRef.new(shape: EnableTerminationProtection, location_name: "EnableTerminationProtection"))
|
654
|
+
CreateStackInput.add_member(:retain_except_on_create, Shapes::ShapeRef.new(shape: RetainExceptOnCreate, location_name: "RetainExceptOnCreate"))
|
653
655
|
CreateStackInput.struct_class = Types::CreateStackInput
|
654
656
|
|
655
657
|
CreateStackInstancesInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
|
@@ -968,6 +970,7 @@ module Aws::CloudFormation
|
|
968
970
|
ExecuteChangeSetInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
|
969
971
|
ExecuteChangeSetInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
970
972
|
ExecuteChangeSetInput.add_member(:disable_rollback, Shapes::ShapeRef.new(shape: DisableRollback, location_name: "DisableRollback"))
|
973
|
+
ExecuteChangeSetInput.add_member(:retain_except_on_create, Shapes::ShapeRef.new(shape: RetainExceptOnCreate, location_name: "RetainExceptOnCreate"))
|
971
974
|
ExecuteChangeSetInput.struct_class = Types::ExecuteChangeSetInput
|
972
975
|
|
973
976
|
ExecuteChangeSetOutput.struct_class = Types::ExecuteChangeSetOutput
|
@@ -1356,6 +1359,7 @@ module Aws::CloudFormation
|
|
1356
1359
|
RollbackStackInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, required: true, location_name: "StackName"))
|
1357
1360
|
RollbackStackInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleARN, location_name: "RoleARN"))
|
1358
1361
|
RollbackStackInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
1362
|
+
RollbackStackInput.add_member(:retain_except_on_create, Shapes::ShapeRef.new(shape: RetainExceptOnCreate, location_name: "RetainExceptOnCreate"))
|
1359
1363
|
RollbackStackInput.struct_class = Types::RollbackStackInput
|
1360
1364
|
|
1361
1365
|
RollbackStackOutput.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, location_name: "StackId"))
|
@@ -1420,6 +1424,7 @@ module Aws::CloudFormation
|
|
1420
1424
|
Stack.add_member(:parent_id, Shapes::ShapeRef.new(shape: StackId, location_name: "ParentId"))
|
1421
1425
|
Stack.add_member(:root_id, Shapes::ShapeRef.new(shape: StackId, location_name: "RootId"))
|
1422
1426
|
Stack.add_member(:drift_information, Shapes::ShapeRef.new(shape: StackDriftInformation, location_name: "DriftInformation"))
|
1427
|
+
Stack.add_member(:retain_except_on_create, Shapes::ShapeRef.new(shape: RetainExceptOnCreate, location_name: "RetainExceptOnCreate"))
|
1423
1428
|
Stack.struct_class = Types::Stack
|
1424
1429
|
|
1425
1430
|
StackDriftInformation.add_member(:stack_drift_status, Shapes::ShapeRef.new(shape: StackDriftStatus, required: true, location_name: "StackDriftStatus"))
|
@@ -1807,6 +1812,7 @@ module Aws::CloudFormation
|
|
1807
1812
|
UpdateStackInput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
1808
1813
|
UpdateStackInput.add_member(:disable_rollback, Shapes::ShapeRef.new(shape: DisableRollback, location_name: "DisableRollback"))
|
1809
1814
|
UpdateStackInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
1815
|
+
UpdateStackInput.add_member(:retain_except_on_create, Shapes::ShapeRef.new(shape: RetainExceptOnCreate, location_name: "RetainExceptOnCreate"))
|
1810
1816
|
UpdateStackInput.struct_class = Types::UpdateStackInput
|
1811
1817
|
|
1812
1818
|
UpdateStackInstancesInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetNameOrId, required: true, location_name: "StackSetName"))
|
@@ -75,6 +75,7 @@ module Aws::CloudFormation
|
|
75
75
|
# ],
|
76
76
|
# client_request_token: "ClientRequestToken",
|
77
77
|
# enable_termination_protection: false,
|
78
|
+
# retain_except_on_create: false,
|
78
79
|
# })
|
79
80
|
# @param [Hash] options ({})
|
80
81
|
# @option options [required, String] :stack_name
|
@@ -315,6 +316,12 @@ module Aws::CloudFormation
|
|
315
316
|
#
|
316
317
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
|
317
318
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
|
319
|
+
# @option options [Boolean] :retain_except_on_create
|
320
|
+
# When set to `true`, newly created resources are deleted when the
|
321
|
+
# operation rolls back. This includes newly created resources marked
|
322
|
+
# with a deletion policy of `Retain`.
|
323
|
+
#
|
324
|
+
# Default: `false`
|
318
325
|
# @return [Stack]
|
319
326
|
def create_stack(options = {})
|
320
327
|
Aws::Plugins::UserAgent.feature('resource') do
|
@@ -354,8 +361,12 @@ module Aws::CloudFormation
|
|
354
361
|
# @param [Hash] options ({})
|
355
362
|
# @option options [String] :stack_name
|
356
363
|
# <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
|
357
|
-
# response that describes all resources in the account
|
358
|
-
# `ListStacks` and `DescribeStacks`
|
364
|
+
# response that describes all resources in the account, which can impact
|
365
|
+
# performance. This requires `ListStacks` and `DescribeStacks`
|
366
|
+
# permissions.
|
367
|
+
#
|
368
|
+
# Consider using the ListStacks API if you're not passing a parameter
|
369
|
+
# to `StackName`.
|
359
370
|
#
|
360
371
|
# The IAM policy below can be added to IAM policies when you want to
|
361
372
|
# limit resource-level permissions and avoid returning a response when
|
@@ -208,6 +208,16 @@ module Aws::CloudFormation
|
|
208
208
|
data[:drift_information]
|
209
209
|
end
|
210
210
|
|
211
|
+
# When set to `true`, newly created resources are deleted when the
|
212
|
+
# operation rolls back. This includes newly created resources marked
|
213
|
+
# with a deletion policy of `Retain`.
|
214
|
+
#
|
215
|
+
# Default: `false`
|
216
|
+
# @return [Boolean]
|
217
|
+
def retain_except_on_create
|
218
|
+
data[:retain_except_on_create]
|
219
|
+
end
|
220
|
+
|
211
221
|
# @!endgroup
|
212
222
|
|
213
223
|
# @return [Client]
|
@@ -439,6 +449,7 @@ module Aws::CloudFormation
|
|
439
449
|
# ],
|
440
450
|
# client_request_token: "ClientRequestToken",
|
441
451
|
# enable_termination_protection: false,
|
452
|
+
# retain_except_on_create: false,
|
442
453
|
# })
|
443
454
|
# @param [Hash] options ({})
|
444
455
|
# @option options [String] :template_body
|
@@ -670,6 +681,12 @@ module Aws::CloudFormation
|
|
670
681
|
#
|
671
682
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
|
672
683
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
|
684
|
+
# @option options [Boolean] :retain_except_on_create
|
685
|
+
# When set to `true`, newly created resources are deleted when the
|
686
|
+
# operation rolls back. This includes newly created resources marked
|
687
|
+
# with a deletion policy of `Retain`.
|
688
|
+
#
|
689
|
+
# Default: `false`
|
673
690
|
# @return [Types::CreateStackOutput]
|
674
691
|
def create(options = {})
|
675
692
|
options = options.merge(stack_name: @name)
|
@@ -773,6 +790,7 @@ module Aws::CloudFormation
|
|
773
790
|
# ],
|
774
791
|
# disable_rollback: false,
|
775
792
|
# client_request_token: "ClientRequestToken",
|
793
|
+
# retain_except_on_create: false,
|
776
794
|
# })
|
777
795
|
# @param [Hash] options ({})
|
778
796
|
# @option options [String] :template_body
|
@@ -1009,6 +1027,12 @@ module Aws::CloudFormation
|
|
1009
1027
|
# stack using the console, each stack event would be assigned the same
|
1010
1028
|
# token in the following format:
|
1011
1029
|
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
|
1030
|
+
# @option options [Boolean] :retain_except_on_create
|
1031
|
+
# When set to `true`, newly created resources are deleted when the
|
1032
|
+
# operation rolls back. This includes newly created resources marked
|
1033
|
+
# with a deletion policy of `Retain`.
|
1034
|
+
#
|
1035
|
+
# Default: `false`
|
1012
1036
|
# @return [Types::UpdateStackOutput]
|
1013
1037
|
def update(options = {})
|
1014
1038
|
options = options.merge(stack_name: @name)
|
@@ -330,6 +330,7 @@ module Aws::CloudFormation
|
|
330
330
|
# An error occurred during a CloudFormation registry operation.
|
331
331
|
#
|
332
332
|
# @!attribute [rw] message
|
333
|
+
# An message with details about the error that occurred.
|
333
334
|
# @return [String]
|
334
335
|
#
|
335
336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CFNRegistryException AWS API Documentation
|
@@ -1278,6 +1279,14 @@ module Aws::CloudFormation
|
|
1278
1279
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
|
1279
1280
|
# @return [Boolean]
|
1280
1281
|
#
|
1282
|
+
# @!attribute [rw] retain_except_on_create
|
1283
|
+
# When set to `true`, newly created resources are deleted when the
|
1284
|
+
# operation rolls back. This includes newly created resources marked
|
1285
|
+
# with a deletion policy of `Retain`.
|
1286
|
+
#
|
1287
|
+
# Default: `false`
|
1288
|
+
# @return [Boolean]
|
1289
|
+
#
|
1281
1290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInput AWS API Documentation
|
1282
1291
|
#
|
1283
1292
|
class CreateStackInput < Struct.new(
|
@@ -1297,7 +1306,8 @@ module Aws::CloudFormation
|
|
1297
1306
|
:stack_policy_url,
|
1298
1307
|
:tags,
|
1299
1308
|
:client_request_token,
|
1300
|
-
:enable_termination_protection
|
1309
|
+
:enable_termination_protection,
|
1310
|
+
:retain_except_on_create)
|
1301
1311
|
SENSITIVE = []
|
1302
1312
|
include Aws::Structure
|
1303
1313
|
end
|
@@ -1579,10 +1589,10 @@ module Aws::CloudFormation
|
|
1579
1589
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
1580
1590
|
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
|
1581
1591
|
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
|
1582
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities
|
1583
|
-
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html
|
1584
|
-
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
1585
|
-
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html
|
1592
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
1593
|
+
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
1594
|
+
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
1595
|
+
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
1586
1596
|
# @return [Array<String>]
|
1587
1597
|
#
|
1588
1598
|
# @!attribute [rw] tags
|
@@ -1610,7 +1620,7 @@ module Aws::CloudFormation
|
|
1610
1620
|
#
|
1611
1621
|
#
|
1612
1622
|
#
|
1613
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html
|
1623
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
|
1614
1624
|
# @return [String]
|
1615
1625
|
#
|
1616
1626
|
# @!attribute [rw] execution_role_name
|
@@ -3004,8 +3014,12 @@ module Aws::CloudFormation
|
|
3004
3014
|
#
|
3005
3015
|
# @!attribute [rw] stack_name
|
3006
3016
|
# <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
|
3007
|
-
# response that describes all resources in the account
|
3008
|
-
# `ListStacks` and `DescribeStacks`
|
3017
|
+
# response that describes all resources in the account, which can
|
3018
|
+
# impact performance. This requires `ListStacks` and `DescribeStacks`
|
3019
|
+
# permissions.
|
3020
|
+
#
|
3021
|
+
# Consider using the ListStacks API if you're not passing a parameter
|
3022
|
+
# to `StackName`.
|
3009
3023
|
#
|
3010
3024
|
# The IAM policy below can be added to IAM policies when you want to
|
3011
3025
|
# limit resource-level permissions and avoid returning a response when
|
@@ -3746,13 +3760,22 @@ module Aws::CloudFormation
|
|
3746
3760
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html
|
3747
3761
|
# @return [Boolean]
|
3748
3762
|
#
|
3763
|
+
# @!attribute [rw] retain_except_on_create
|
3764
|
+
# When set to `true`, newly created resources are deleted when the
|
3765
|
+
# operation rolls back. This includes newly created resources marked
|
3766
|
+
# with a deletion policy of `Retain`.
|
3767
|
+
#
|
3768
|
+
# Default: `false`
|
3769
|
+
# @return [Boolean]
|
3770
|
+
#
|
3749
3771
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSetInput AWS API Documentation
|
3750
3772
|
#
|
3751
3773
|
class ExecuteChangeSetInput < Struct.new(
|
3752
3774
|
:change_set_name,
|
3753
3775
|
:stack_name,
|
3754
3776
|
:client_request_token,
|
3755
|
-
:disable_rollback
|
3777
|
+
:disable_rollback,
|
3778
|
+
:retain_except_on_create)
|
3756
3779
|
SENSITIVE = []
|
3757
3780
|
include Aws::Structure
|
3758
3781
|
end
|
@@ -6213,12 +6236,21 @@ module Aws::CloudFormation
|
|
6213
6236
|
# A unique identifier for this `RollbackStack` request.
|
6214
6237
|
# @return [String]
|
6215
6238
|
#
|
6239
|
+
# @!attribute [rw] retain_except_on_create
|
6240
|
+
# When set to `true`, newly created resources are deleted when the
|
6241
|
+
# operation rolls back. This includes newly created resources marked
|
6242
|
+
# with a deletion policy of `Retain`.
|
6243
|
+
#
|
6244
|
+
# Default: `false`
|
6245
|
+
# @return [Boolean]
|
6246
|
+
#
|
6216
6247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStackInput AWS API Documentation
|
6217
6248
|
#
|
6218
6249
|
class RollbackStackInput < Struct.new(
|
6219
6250
|
:stack_name,
|
6220
6251
|
:role_arn,
|
6221
|
-
:client_request_token
|
6252
|
+
:client_request_token,
|
6253
|
+
:retain_except_on_create)
|
6222
6254
|
SENSITIVE = []
|
6223
6255
|
include Aws::Structure
|
6224
6256
|
end
|
@@ -6606,6 +6638,14 @@ module Aws::CloudFormation
|
|
6606
6638
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
|
6607
6639
|
# @return [Types::StackDriftInformation]
|
6608
6640
|
#
|
6641
|
+
# @!attribute [rw] retain_except_on_create
|
6642
|
+
# When set to `true`, newly created resources are deleted when the
|
6643
|
+
# operation rolls back. This includes newly created resources marked
|
6644
|
+
# with a deletion policy of `Retain`.
|
6645
|
+
#
|
6646
|
+
# Default: `false`
|
6647
|
+
# @return [Boolean]
|
6648
|
+
#
|
6609
6649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Stack AWS API Documentation
|
6610
6650
|
#
|
6611
6651
|
class Stack < Struct.new(
|
@@ -6630,7 +6670,8 @@ module Aws::CloudFormation
|
|
6630
6670
|
:enable_termination_protection,
|
6631
6671
|
:parent_id,
|
6632
6672
|
:root_id,
|
6633
|
-
:drift_information
|
6673
|
+
:drift_information,
|
6674
|
+
:retain_except_on_create)
|
6634
6675
|
SENSITIVE = []
|
6635
6676
|
include Aws::Structure
|
6636
6677
|
end
|
@@ -7719,7 +7760,7 @@ module Aws::CloudFormation
|
|
7719
7760
|
#
|
7720
7761
|
#
|
7721
7762
|
#
|
7722
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html
|
7763
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
|
7723
7764
|
# @return [String]
|
7724
7765
|
#
|
7725
7766
|
# @!attribute [rw] execution_role_name
|
@@ -8010,7 +8051,7 @@ module Aws::CloudFormation
|
|
8010
8051
|
#
|
8011
8052
|
#
|
8012
8053
|
#
|
8013
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html
|
8054
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
|
8014
8055
|
# @return [String]
|
8015
8056
|
#
|
8016
8057
|
# @!attribute [rw] execution_role_name
|
@@ -9444,6 +9485,14 @@ module Aws::CloudFormation
|
|
9444
9485
|
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
|
9445
9486
|
# @return [String]
|
9446
9487
|
#
|
9488
|
+
# @!attribute [rw] retain_except_on_create
|
9489
|
+
# When set to `true`, newly created resources are deleted when the
|
9490
|
+
# operation rolls back. This includes newly created resources marked
|
9491
|
+
# with a deletion policy of `Retain`.
|
9492
|
+
#
|
9493
|
+
# Default: `false`
|
9494
|
+
# @return [Boolean]
|
9495
|
+
#
|
9447
9496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInput AWS API Documentation
|
9448
9497
|
#
|
9449
9498
|
class UpdateStackInput < Struct.new(
|
@@ -9463,7 +9512,8 @@ module Aws::CloudFormation
|
|
9463
9512
|
:notification_arns,
|
9464
9513
|
:tags,
|
9465
9514
|
:disable_rollback,
|
9466
|
-
:client_request_token
|
9515
|
+
:client_request_token,
|
9516
|
+
:retain_except_on_create)
|
9467
9517
|
SENSITIVE = []
|
9468
9518
|
include Aws::Structure
|
9469
9519
|
end
|
@@ -9752,10 +9802,10 @@ module Aws::CloudFormation
|
|
9752
9802
|
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
|
9753
9803
|
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
|
9754
9804
|
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
|
9755
|
-
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities
|
9756
|
-
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html
|
9757
|
-
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
9758
|
-
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html
|
9805
|
+
# [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
|
9806
|
+
# [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
|
9807
|
+
# [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
|
9808
|
+
# [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
|
9759
9809
|
# @return [Array<String>]
|
9760
9810
|
#
|
9761
9811
|
# @!attribute [rw] tags
|
@@ -9815,7 +9865,7 @@ module Aws::CloudFormation
|
|
9815
9865
|
#
|
9816
9866
|
#
|
9817
9867
|
#
|
9818
|
-
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html
|
9868
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
|
9819
9869
|
# @return [String]
|
9820
9870
|
#
|
9821
9871
|
# @!attribute [rw] execution_role_name
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudformation
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.89.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-09-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|