Class: Aws::CloudFormation::Types::ResourceDetail

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

Overview

Details about a resource in a generated template

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#logical_resource_id ⇒ String

The logical id for this resource in the final generated template.

Returns:

  • (String) 


6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6879

class ResourceDetail < Struct.new(
  :resource_type,
  :logical_resource_id,
  :resource_identifier,
  :resource_status,
  :resource_status_reason,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier ⇒ Hash<String,String>

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the ‘primaryIdentifier` list in the resource schema.) The value is the value of that primary identifier. For example, for a `AWS::DynamoDB::Table` resource, the primary identifiers is `TableName` so the key-value pair could be `“TableName”: “MyDDBTable”`. For more information, see [primaryIdentifier] in the *CloudFormation Command Line Interface User guide for extension development*.

[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier

Returns:

  • (Hash<String,String>) 


6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6879

class ResourceDetail < Struct.new(
  :resource_type,
  :logical_resource_id,
  :resource_identifier,
  :resource_status,
  :resource_status_reason,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_status ⇒ String

Status of the processing of a resource in a generated template.

InProgress

: The resource processing is still in progress.

Complete

: The resource processing is complete.

Pending

: The resource processing is pending.

Failed

: The resource processing has failed.

Returns:

  • (String) 


6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6879

class ResourceDetail < Struct.new(
  :resource_type,
  :logical_resource_id,
  :resource_identifier,
  :resource_status,
  :resource_status_reason,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_status_reason ⇒ String

The reason for the resource detail, providing more information if a failure happened.

Returns:

  • (String) 


6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6879

class ResourceDetail < Struct.new(
  :resource_type,
  :logical_resource_id,
  :resource_identifier,
  :resource_status,
  :resource_status_reason,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of the resource, such as ‘AWS::DynamoDB::Table`. For the list of supported resources, see [IaC generator supported resource types] In the *CloudFormation User Guide*

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html

Returns:

  • (String) 


6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6879

class ResourceDetail < Struct.new(
  :resource_type,
  :logical_resource_id,
  :resource_identifier,
  :resource_status,
  :resource_status_reason,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warnings ⇒ Array<Types::WarningDetail>

The warnings generated for this resource.

Returns:



6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6879

class ResourceDetail < Struct.new(
  :resource_type,
  :logical_resource_id,
  :resource_identifier,
  :resource_status,
  :resource_status_reason,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end