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


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#change_set_idString

The unique ID of the change set.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#creation_timeTime

The time at which the stack was created.

Returns:

  • (Time)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#descriptionString

A user-defined description associated with the stack.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#disable_rollbackBoolean

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

Returns:

  • (Boolean)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :last_updated_time,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags)
  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)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#notification_arnsArray<String>

SNS topic ARNs to which stack related events are published.

Returns:

  • (Array<String>)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#outputsArray<Types::Output>

A list of output structures.

Returns:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#parametersArray<Types::Parameter>

A list of Parameter structures.

Returns:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

class Stack < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :description,
  :parameters,
  :creation_time,
  :last_updated_time,
  :stack_status,
  :stack_status_reason,
  :disable_rollback,
  :notification_arns,
  :timeout_in_minutes,
  :capabilities,
  :outputs,
  :role_arn,
  :tags)
  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)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#stack_nameString

The name associated with the stack.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#stack_statusString

Current status of the stack.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#stack_status_reasonString

Success/failure message associated with the stack status.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#tagsArray<Types::Tag>

A list of Tags that specify information about the stack.

Returns:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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

#timeout_in_minutesInteger

The amount of time within which stack creation should complete.

Returns:

  • (Integer)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3132

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