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

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

Overview

The Stack data type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

The capabilities allowed in the stack.

Returns:

  • (Array<String>)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_idString

The unique ID of the change set.

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The time at which the stack was created.

Returns:

  • (Time)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_timeTime

The time the stack was deleted.

Returns:

  • (Time)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A user-defined description associated with the stack.

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#disable_rollbackBoolean

Boolean to enable or disable rollback on stack creation failures:

  • `true`: disable rollback

  • `false`: enable rollback

Returns:

  • (Boolean)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#drift_informationTypes::StackDriftInformation

Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see [Detecting Unregulated Configuration Changes to Stacks and Resources].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html


6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  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 *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html

Returns:

  • (Boolean)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  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)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arnsArray<String>

SNS topic ARNs to which stack related events are published.

Returns:

  • (Array<String>)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#outputsArray<Types::Output>

A list of output structures.

Returns:


6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#parametersArray<Types::Parameter>

A list of `Parameter` structures.

Returns:


6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  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 *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  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.


6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#root_idString

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

For more information, see [Working with Nested Stacks] in the *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

The name associated with the stack.

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#stack_statusString

Current status of the stack.

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#stack_status_reasonString

Success/failure message associated with the stack status.

Returns:

  • (String)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of `Tag`s that specify information about the stack.

Returns:


6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutesInteger

The amount of time within which stack creation should complete.

Returns:

  • (Integer)

6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
# File 'lib/aws-sdk-cloudformation/types.rb', line 6812

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,
  :drift_information)
  SENSITIVE = []
  include Aws::Structure
end