Class: Aws::CloudFormation::Types::ExecuteChangeSetInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

The input for the ExecuteChangeSet action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_set_name ⇒ String

The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

Returns:

  • (String) 


4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4107

class ExecuteChangeSetInput < Struct.new(
  :change_set_name,
  :stack_name,
  :client_request_token,
  :disable_rollback,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

A unique identifier for this ‘ExecuteChangeSet` request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to execute a change set to update a stack with the same name. You might retry ‘ExecuteChangeSet` requests to ensure that CloudFormation successfully received them.

Returns:

  • (String) 


4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4107

class ExecuteChangeSetInput < Struct.new(
  :change_set_name,
  :stack_name,
  :client_request_token,
  :disable_rollback,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#disable_rollback ⇒ Boolean

Preserves the state of previously provisioned resources when an operation fails. This parameter can’t be specified when the ‘OnStackFailure` parameter to the [CreateChangeSet] 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] 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] API operation.

Default: ‘True`

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html

Returns:

  • (Boolean) 


4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4107

class ExecuteChangeSetInput < Struct.new(
  :change_set_name,
  :stack_name,
  :client_request_token,
  :disable_rollback,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#retain_except_on_create ⇒ Boolean

When set to ‘true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.

Default: ‘false`

Returns:

  • (Boolean) 


4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4107

class ExecuteChangeSetInput < Struct.new(
  :change_set_name,
  :stack_name,
  :client_request_token,
  :disable_rollback,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ String

If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that’s associated with the change set you want to execute.

Returns:

  • (String) 


4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4107

class ExecuteChangeSetInput < Struct.new(
  :change_set_name,
  :stack_name,
  :client_request_token,
  :disable_rollback,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end