Skip to content

ResourceDetail

Source code in docs_src/capo_cloudformation/types/resource_detail.py
class ResourceDetail(TypedDict, closed=True):
    resource_type: NotRequired["capo_cloudformation.types.resource_type.ResourceType"]
    """<p>The type of the resource, such as <code>AWS::DynamoDB::Table</code>. For the list of supported resources, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a> In the <i>CloudFormation User Guide</i> </p>"""
    logical_resource_id: NotRequired[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ]
    """<p>The logical id for this resource in the final generated template.</p>"""
    resource_identifier: NotRequired[
        "capo_cloudformation.types.resource_identifier_properties.ResourceIdentifierProperties"
    ]
    """<p>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 <code>primaryIdentifier</code> list in the resource schema.) The value is the value of that primary identifier. For example, for a <code>AWS::DynamoDB::Table</code> resource, the primary identifiers is <code>TableName</code> so the key-value pair could be <code>"TableName": "MyDDBTable"</code>. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier">primaryIdentifier</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>"""
    resource_status: NotRequired[
        "capo_cloudformation.types.generated_template_resource_status.GeneratedTemplateResourceStatus"
    ]
    """<p>Status of the processing of a resource in a generated template.</p> <dl> <dt> InProgress </dt> <dd> <p>The resource processing is still in progress.</p> </dd> <dt> Complete </dt> <dd> <p>The resource processing is complete.</p> </dd> <dt> Pending </dt> <dd> <p>The resource processing is pending.</p> </dd> <dt> Failed </dt> <dd> <p>The resource processing has failed.</p> </dd> </dl>"""
    resource_status_reason: NotRequired[
        "capo_cloudformation.types.resource_status_reason.ResourceStatusReason"
    ]
    """<p>The reason for the resource detail, providing more information if a failure happened.</p>"""
    warnings: NotRequired["capo_cloudformation.types.warning_details.WarningDetails"]
    """<p>The warnings generated for this resource.</p>"""

logical_resource_id instance-attribute

logical_resource_id: NotRequired[LogicalResourceId]

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

resource_identifier instance-attribute

resource_identifier: NotRequired[ResourceIdentifierProperties]

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 (CLI) User Guide.

resource_status instance-attribute

resource_status: NotRequired[GeneratedTemplateResourceStatus]

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.

resource_status_reason instance-attribute

resource_status_reason: NotRequired[ResourceStatusReason]

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

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide

warnings instance-attribute

warnings: NotRequired[WarningDetails]

The warnings generated for this resource.