aws-sdk-cloudformation 1.81.0 → 1.82.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 397f8e5ddd91bcc1f12777f1a80b5ab64b3c728c77829eb50b725528fc17e1e1
-  data.tar.gz: '0954042dd91671e4aced85cbfcf0b76abd1f9b8cdd109fcaf80585fc96ac2df8'
+  metadata.gz: 6c1b61c29a5e92b925e22fa501b58f6d8950b57489f169623e0abe789f1c8506
+  data.tar.gz: 39f30be6695ba96a646c295e13f6029431ab3f8cf639879a9add69259cc56c0b
 SHA512:
-  metadata.gz: cd9790ff2968a07a985861040e8e7ddfb23d5a1be3d552de4bfb44a1a213aaf8005532f2106b6efb38d144efd0563e5ea0500ddfc009d2df86bedf41d12adf8c
-  data.tar.gz: 70de0d5b3766e0d09dcb731a30bb97fd0e8e7d9bc1a61537f861602b495aef370b6d3e2f9460f4f25ac9aa658ee2dfa4339c212f34decf1243bc972b45d19480
+  metadata.gz: f89cda168a3f5339567f776057e5f57fb53a9114261ad960fd9b54c8f2b7ac96053ff4f7724b772b4e767c9d734324b9c38905bbaae6e0eedeb34d5682f2eb95
+  data.tar.gz: 74c935233c44b57139a1d9e6ec83d13718078cba923b867a0249ce65bdac0598b37d3f25a368bfa91da58520900fb288479a038e1b6565a55ed9fe52711d75db

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.82.0 (2023-06-19)
+------------------
+
+* Feature - Specify desired CloudFormation behavior in the event of ChangeSet execution failure using the CreateChangeSet OnStackFailure parameter
+
 1.81.0 (2023-06-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.81.0
+1.82.0

data/lib/aws-sdk-cloudformation/client.rb

@@ -977,6 +977,34 @@ module Aws::CloudFormation
     #   template. The default behavior of this action is set to `False`. To
     #   include nested sets in a change set, specify `True`.
     #
+    # @option params [String] :on_stack_failure
+    #   Determines what action will be taken if stack creation fails. If this
+    #   parameter is specified, the `DisableRollback` parameter to the
+    #   [ExecuteChangeSet][1] API operation must not be specified. This must
+    #   be one of these values:
+    #
+    #   * `DELETE` - Deletes the change set if the stack creation fails. This
+    #     is only valid when the `ChangeSetType` parameter is set to `CREATE`.
+    #     If the deletion of the stack fails, the status of the stack is
+    #     `DELETE_FAILED`.
+    #
+    #   * `DO_NOTHING` - if the stack creation fails, do nothing. This is
+    #     equivalent to specifying `true` for the `DisableRollback` parameter
+    #     to the [ExecuteChangeSet][1] API operation.
+    #
+    #   * `ROLLBACK` - if the stack creation fails, roll back the stack. This
+    #     is equivalent to specifying `false` for the `DisableRollback`
+    #     parameter to the [ExecuteChangeSet][1] API operation.
+    #
+    #   For nested stacks, when the `OnStackFailure` parameter is set to
+    #   `DELETE` for the change set for the parent stack, any failure in a
+    #   child stack will cause the parent stack creation to fail and all
+    #   stacks to be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html
+    #
     # @return [Types::CreateChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateChangeSetOutput#id #id} => String
@@ -1030,6 +1058,7 @@ module Aws::CloudFormation
     #       },
     #     ],
     #     include_nested_stacks: false,
+    #     on_stack_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
     #   })
     #
     # @example Response structure
@@ -2280,6 +2309,7 @@ module Aws::CloudFormation
     #   * {Types::DescribeChangeSetOutput#include_nested_stacks #include_nested_stacks} => Boolean
     #   * {Types::DescribeChangeSetOutput#parent_change_set_id #parent_change_set_id} => String
     #   * {Types::DescribeChangeSetOutput#root_change_set_id #root_change_set_id} => String
+    #   * {Types::DescribeChangeSetOutput#on_stack_failure #on_stack_failure} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -2340,6 +2370,7 @@ module Aws::CloudFormation
     #   resp.include_nested_stacks #=> Boolean
     #   resp.parent_change_set_id #=> String
     #   resp.root_change_set_id #=> String
+    #   resp.on_stack_failure #=> String, one of "DO_NOTHING", "ROLLBACK", "DELETE"
     #
     #
     # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -3807,10 +3838,24 @@ module Aws::CloudFormation
     #
     # @option params [Boolean] :disable_rollback
     #   Preserves the state of previously provisioned resources when an
-    #   operation fails.
+    #   operation fails. This parameter can't be specified when the
+    #   `OnStackFailure` parameter to the [CreateChangeSet][1] API operation
+    #   was specified.
+    #
+    #   * `True` - if the stack creation fails, do nothing. This is equivalent
+    #     to specifying `DO_NOTHING` for the `OnStackFailure` parameter to the
+    #     [CreateChangeSet][1] API operation.
+    #
+    #   * `False` - if the stack creation fails, roll back the stack. This is
+    #     equivalent to specifying `ROLLBACK` for the `OnStackFailure`
+    #     parameter to the [CreateChangeSet][1] API operation.
     #
     #   Default: `True`
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -6936,7 +6981,7 @@ module Aws::CloudFormation
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudformation'
-      context[:gem_version] = '1.81.0'
+      context[:gem_version] = '1.82.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudformation/client_api.rb

@@ -240,6 +240,7 @@ module Aws::CloudFormation
     NotificationARN = Shapes::StringShape.new(name: 'NotificationARN')
     NotificationARNs = Shapes::ListShape.new(name: 'NotificationARNs')
     OnFailure = Shapes::StringShape.new(name: 'OnFailure')
+    OnStackFailure = Shapes::StringShape.new(name: 'OnStackFailure')
     OperationIdAlreadyExistsException = Shapes::StructureShape.new(name: 'OperationIdAlreadyExistsException')
     OperationInProgressException = Shapes::StructureShape.new(name: 'OperationInProgressException')
     OperationNotFoundException = Shapes::StructureShape.new(name: 'OperationNotFoundException')
@@ -618,6 +619,7 @@ module Aws::CloudFormation
     CreateChangeSetInput.add_member(:change_set_type, Shapes::ShapeRef.new(shape: ChangeSetType, location_name: "ChangeSetType"))
     CreateChangeSetInput.add_member(:resources_to_import, Shapes::ShapeRef.new(shape: ResourcesToImport, location_name: "ResourcesToImport"))
     CreateChangeSetInput.add_member(:include_nested_stacks, Shapes::ShapeRef.new(shape: IncludeNestedStacks, location_name: "IncludeNestedStacks"))
+    CreateChangeSetInput.add_member(:on_stack_failure, Shapes::ShapeRef.new(shape: OnStackFailure, location_name: "OnStackFailure"))
     CreateChangeSetInput.struct_class = Types::CreateChangeSetInput
 
     CreateChangeSetOutput.add_member(:id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "Id"))
@@ -783,6 +785,7 @@ module Aws::CloudFormation
     DescribeChangeSetOutput.add_member(:include_nested_stacks, Shapes::ShapeRef.new(shape: IncludeNestedStacks, location_name: "IncludeNestedStacks"))
     DescribeChangeSetOutput.add_member(:parent_change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "ParentChangeSetId"))
     DescribeChangeSetOutput.add_member(:root_change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "RootChangeSetId"))
+    DescribeChangeSetOutput.add_member(:on_stack_failure, Shapes::ShapeRef.new(shape: OnStackFailure, location_name: "OnStackFailure"))
     DescribeChangeSetOutput.struct_class = Types::DescribeChangeSetOutput
 
     DescribeOrganizationsAccessInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))

data/lib/aws-sdk-cloudformation/types.rb

@@ -928,6 +928,35 @@ module Aws::CloudFormation
     #   include nested sets in a change set, specify `True`.
     #   @return [Boolean]
     #
+    # @!attribute [rw] on_stack_failure
+    #   Determines what action will be taken if stack creation fails. If
+    #   this parameter is specified, the `DisableRollback` parameter to the
+    #   [ExecuteChangeSet][1] API operation must not be specified. This must
+    #   be one of these values:
+    #
+    #   * `DELETE` - Deletes the change set if the stack creation fails.
+    #     This is only valid when the `ChangeSetType` parameter is set to
+    #     `CREATE`. If the deletion of the stack fails, the status of the
+    #     stack is `DELETE_FAILED`.
+    #
+    #   * `DO_NOTHING` - if the stack creation fails, do nothing. This is
+    #     equivalent to specifying `true` for the `DisableRollback`
+    #     parameter to the [ExecuteChangeSet][1] API operation.
+    #
+    #   * `ROLLBACK` - if the stack creation fails, roll back the stack.
+    #     This is equivalent to specifying `false` for the `DisableRollback`
+    #     parameter to the [ExecuteChangeSet][1] API operation.
+    #
+    #   For nested stacks, when the `OnStackFailure` parameter is set to
+    #   `DELETE` for the change set for the parent stack, any failure in a
+    #   child stack will cause the parent stack creation to fail and all
+    #   stacks to be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSetInput AWS API Documentation
     #
     class CreateChangeSetInput < Struct.new(
@@ -947,7 +976,8 @@ module Aws::CloudFormation
       :description,
       :change_set_type,
       :resources_to_import,
-      :include_nested_stacks)
+      :include_nested_stacks,
+      :on_stack_failure)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2337,6 +2367,30 @@ module Aws::CloudFormation
     #   nested change set hierarchy.
     #   @return [String]
     #
+    # @!attribute [rw] on_stack_failure
+    #   Determines what action will be taken if stack creation fails. When
+    #   this parameter is specified, the `DisableRollback` parameter to the
+    #   [ExecuteChangeSet][1] API operation must not be specified. This must
+    #   be one of these values:
+    #
+    #   * `DELETE` - Deletes the change set if the stack creation fails.
+    #     This is only valid when the `ChangeSetType` parameter is set to
+    #     `CREATE`. If the deletion of the stack fails, the status of the
+    #     stack is `DELETE_FAILED`.
+    #
+    #   * `DO_NOTHING` - if the stack creation fails, do nothing. This is
+    #     equivalent to specifying `true` for the `DisableRollback`
+    #     parameter to the [ExecuteChangeSet][1] API operation.
+    #
+    #   * `ROLLBACK` - if the stack creation fails, roll back the stack.
+    #     This is equivalent to specifying `false` for the `DisableRollback`
+    #     parameter to the [ExecuteChangeSet][1] API operation.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetOutput AWS API Documentation
     #
     class DescribeChangeSetOutput < Struct.new(
@@ -2358,7 +2412,8 @@ module Aws::CloudFormation
       :next_token,
       :include_nested_stacks,
       :parent_change_set_id,
-      :root_change_set_id)
+      :root_change_set_id,
+      :on_stack_failure)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3672,9 +3727,23 @@ module Aws::CloudFormation
     #
     # @!attribute [rw] disable_rollback
     #   Preserves the state of previously provisioned resources when an
-    #   operation fails.
+    #   operation fails. This parameter can't be specified when the
+    #   `OnStackFailure` parameter to the [CreateChangeSet][1] API operation
+    #   was specified.
+    #
+    #   * `True` - if the stack creation fails, do nothing. This is
+    #     equivalent to specifying `DO_NOTHING` for the `OnStackFailure`
+    #     parameter to the [CreateChangeSet][1] API operation.
+    #
+    #   * `False` - if the stack creation fails, roll back the stack. This
+    #     is equivalent to specifying `ROLLBACK` for the `OnStackFailure`
+    #     parameter to the [CreateChangeSet][1] API operation.
     #
     #   Default: `True`
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSetInput AWS API Documentation

data/lib/aws-sdk-cloudformation.rb

@@ -57,6 +57,6 @@ require_relative 'aws-sdk-cloudformation/customizations'
 # @!group service
 module Aws::CloudFormation
 
-  GEM_VERSION = '1.81.0'
+  GEM_VERSION = '1.82.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudformation
 version: !ruby/object:Gem::Version
-  version: 1.81.0
+  version: 1.82.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core