You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

The output for the DescribeChangeSet action.

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>)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#change_set_idString

The ARN of the change set.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#change_set_nameString

The name of the change set.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#changesArray<Types::Change>

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

Returns:



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#creation_timeTime

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

Returns:

  • (Time)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#descriptionString

Information about the change set.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  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 AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  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)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  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>)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  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.

Returns:



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#stack_idString

The ARN of the stack that is associated with the change set.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#stack_nameString

The name of the stack that is associated with the change set.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  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, AWS CloudFormation shows the error message.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1416

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,
  :capabilities,
  :tags,
  :changes,
  :next_token)
  include Aws::Structure
end