describe_stack_resource¶

CloudFormation.Client.describe_stack_resource(**kwargs)¶

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

See also: AWS API Documentation

Request Syntax

response = client.describe_stack_resource(
    StackName='string',
    LogicalResourceId='string'
)

Parameters

StackName (string) --
[REQUIRED]

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
LogicalResourceId (string) --
[REQUIRED]

The logical name of the resource as specified in the template.

Default: There is no default value.

Return type

dict

Returns

Response Syntax

{
    'StackResourceDetail': {
        'StackName': 'string',
        'StackId': 'string',
        'LogicalResourceId': 'string',
        'PhysicalResourceId': 'string',
        'ResourceType': 'string',
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE'|'IMPORT_FAILED'|'IMPORT_COMPLETE'|'IMPORT_IN_PROGRESS'|'IMPORT_ROLLBACK_IN_PROGRESS'|'IMPORT_ROLLBACK_FAILED'|'IMPORT_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
        'ResourceStatusReason': 'string',
        'Description': 'string',
        'Metadata': 'string',
        'DriftInformation': {
            'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
            'LastCheckTimestamp': datetime(2015, 1, 1)
        },
        'ModuleInfo': {
            'TypeHierarchy': 'string',
            'LogicalIdHierarchy': 'string'
        }
    }
}

Response Structure

(dict) --

The output for a DescribeStackResource action.
- StackResourceDetail (dict) --
  
  A StackResourceDetail structure containing the description of the specified resource in the specified stack.
  - StackName (string) --
    
    The name associated with the stack.
  - StackId (string) --
    
    Unique identifier of the stack.
  - LogicalResourceId (string) --
    
    The logical name of the resource specified in the template.
  - PhysicalResourceId (string) --
    
    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
  - ResourceType (string) --
    
    Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
  - LastUpdatedTimestamp (datetime) --
    
    Time the status was updated.
  - ResourceStatus (string) --
    
    Current status of the resource.
  - ResourceStatusReason (string) --
    
    Success/failure message associated with the resource.
  - Description (string) --
    
    User defined description associated with the resource.
  - Metadata (string) --
    
    The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.
  - DriftInformation (dict) --
    
    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.
    - StackResourceDriftStatus (string) --
      
      Status of the resource's actual configuration compared to its expected configuration
      - DELETED : The resource differs from its expected configuration in that it has been deleted.
      - MODIFIED : The resource differs from its expected configuration.
      - NOT_CHECKED : CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED . For more information, see Resources that Support Drift Detection.
      - IN_SYNC : The resource's actual configuration matches its expected configuration.
    - LastCheckTimestamp (datetime) --
      
      When CloudFormation last checked if the resource had drifted from its expected configuration.
  - ModuleInfo (dict) --
    
    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
    - TypeHierarchy (string) --
      
      A concatenated list of the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by / .
      
      In the following example, the resource was created from a module of type AWS::First::Example::MODULE , that's nested inside a parent module of type AWS::Second::Example::MODULE .
      
      AWS::First::Example::MODULE/AWS::Second::Example::MODULE
    - LogicalIdHierarchy (string) --
      
      A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by / .
      
      In the following example, the resource was created from a module, moduleA , that's nested inside a parent module, moduleB .
      
      moduleA/moduleB
      
      For more information, see Referencing resources in a module in the CloudFormation User Guide .

Table Of Contents

describe_stack_resource¶