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

Class: Aws::CloudFormation::StackResource

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(stack_name, logical_id, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(stack_name, logical_id, options = {}) ⇒ Object

    Parameters:

    • stack_name (String)
    • logical_id (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :stack_name (required, String)
    • :logical_id (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#descriptionString (readonly)

User defined description associated with the resource.

Returns:

  • (String)

    User defined description associated with the resource.

#drift_informationTypes::StackResourceDriftInformation (readonly)

Information about whether the resource\'s actual configuration differs, or has drifted, from its 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.

Returns:

  • (Types::StackResourceDriftInformation)

    Information about whether the resource\'s actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.

#last_updated_timestampTime (readonly)

Time the status was updated.

Returns:

  • (Time)

    Time the status was updated.

#logical_idString (readonly)

Returns:

  • (String)

#logical_resource_idString (readonly)

The logical name of the resource specified in the template.

Returns:

  • (String)

    The logical name of the resource specified in the template.

#metadataString (readonly)

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.

Returns:

  • (String)

    The content of the Metadata attribute declared for the resource.

#physical_resource_idString (readonly)

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

Returns:

  • (String)

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

#resource_statusString (readonly)

Current status of the resource.

Possible values:

  • CREATE_IN_PROGRESS
  • CREATE_FAILED
  • CREATE_COMPLETE
  • DELETE_IN_PROGRESS
  • DELETE_FAILED
  • DELETE_COMPLETE
  • DELETE_SKIPPED
  • UPDATE_IN_PROGRESS
  • UPDATE_FAILED
  • UPDATE_COMPLETE

Returns:

  • (String)

    Current status of the resource.

#resource_status_reasonString (readonly)

Success/failure message associated with the resource.

Returns:

  • (String)

    Success/failure message associated with the resource.

#resource_typeString (readonly)

Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Returns:

  • (String)

    Type of resource.

#stack_idString (readonly)

Unique identifier of the stack.

Returns:

  • (String)

    Unique identifier of the stack.

#stack_nameString (readonly)

Returns:

  • (String)

Instance Method Details

#stackStack

Returns: