Class: Aws::CloudFormation::Types::DescribeChangeSetOutput

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

Overview

The output for the DescribeChangeSet action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

Returns:

  • (Array<String>)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_idString

The Amazon Resource Name (ARN) of the change set.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_nameString

The name of the change set.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#changesArray<Types::Change>

A list of `Change` structures that describes the resources CloudFormation changes if you execute the change set.

Returns:


2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The start time when the change set was created, in UTC.

Returns:

  • (Time)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Information about the change set.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#execution_statusString

If the change set execution status is `AVAILABLE`, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an `UNAVAILABLE` state because CloudFormation is still creating it or in an `OBSOLETE` state because the stack was already updated.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#include_nested_stacksBoolean

Verifies if `IncludeNestedStacks` is set to `True`.

Returns:

  • (Boolean)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arnsArray<String>

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

Returns:

  • (Array<String>)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#parametersArray<Types::Parameter>

A list of `Parameter` structures that describes the input parameters and their values used to create the change set. For more information, see the [Parameter] data type.

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

Returns:


2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#parent_change_set_idString

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_configurationTypes::RollbackConfiguration

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.


2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#root_change_set_idString

Specifies the change set ID of the root change set in the current nested change set hierarchy.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_idString

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

The name of the stack that's associated with the change set.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the change set, such as `CREATE_IN_PROGRESS`, `CREATE_COMPLETE`, or `FAILED`.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

Returns:

  • (String)

2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

If you execute the change set, the tags that will be associated with the stack.

Returns:


2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/aws-sdk-cloudformation/types.rb', line 2309

class DescribeChangeSetOutput < Struct.new(
  :change_set_name,
  :change_set_id,
  :stack_id,
  :stack_name,
  :description,
  :parameters,
  :creation_time,
  :execution_status,
  :status,
  :status_reason,
  :notification_arns,
  :rollback_configuration,
  :capabilities,
  :tags,
  :changes,
  :next_token,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end