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

Class: Aws::CloudFormation::Types::Stack

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

Overview

The Stack data type.

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

The capabilities allowed in the stack.

Returns:

  • (Array<String>)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#change_set_idString

The unique ID of the change set.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#creation_timeTime

The time at which the stack was created.

Returns:

  • (Time)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#deletion_timeTime

The time the stack was deleted.

Returns:

  • (Time)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#descriptionString

A user-defined description associated with the stack.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#disable_rollbackBoolean

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

Returns:

  • (Boolean)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#enable_termination_protectionBoolean

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.

Returns:

  • (Boolean)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#last_updated_timeTime

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Returns:

  • (Time)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#notification_arnsArray<String>

SNS topic ARNs to which stack related events are published.

Returns:

  • (Array<String>)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#outputsArray<Types::Output>

A list of output structures.

Returns:



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#parametersArray<Types::Parameter>

A list of Parameter structures.

Returns:



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#parent_idString

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#rollback_configurationTypes::RollbackConfiguration

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



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#root_idString

For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#stack_nameString

The name associated with the stack.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#stack_statusString

Current status of the stack.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#stack_status_reasonString

Success/failure message associated with the stack status.

Returns:

  • (String)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of Tags that specify information about the stack.

Returns:



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end

#timeout_in_minutesInteger

The amount of time within which stack creation should complete.

Returns:

  • (Integer)


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3412

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :deletion_time,
  :last_updated_time,
  :rollback_configuration,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags,
  :enable_termination_protection,
  :parent_id,
  :root_id)
  include Aws::Structure
end