Skip to content

StackResource

Source code in docs_src/capo_cloudformation/types/stack_resource.py
class StackResource(TypedDict, closed=True):
    stack_name: NotRequired["capo_cloudformation.types.stack_name.StackName"]
    """<p>The name associated with the stack.</p>"""
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>Unique identifier of the stack.</p>"""
    logical_resource_id: NotRequired[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ]
    """<p>The logical name of the resource specified in the template.</p>"""
    physical_resource_id: NotRequired[
        "capo_cloudformation.types.physical_resource_id.PhysicalResourceId"
    ]
    """<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>"""
    resource_type: NotRequired["capo_cloudformation.types.resource_type.ResourceType"]
    """<p>Type of resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>"""
    timestamp: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>Time the status was updated.</p>"""
    resource_status: NotRequired[
        "capo_cloudformation.types.resource_status.ResourceStatus"
    ]
    """<p>Current status of the resource.</p>"""
    resource_status_reason: NotRequired[
        "capo_cloudformation.types.resource_status_reason.ResourceStatusReason"
    ]
    """<p>Success/failure message associated with the resource.</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>User defined description associated with the resource.</p>"""
    drift_information: NotRequired[
        "capo_cloudformation.types.stack_resource_drift_information.StackResourceDriftInformation"
    ]
    """<p>Information about whether the resource's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>"""
    module_info: NotRequired["capo_cloudformation.types.module_info.ModuleInfo"]
    """<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>"""

description instance-attribute

description: NotRequired[Description]

User defined description associated with the resource.

drift_information instance-attribute

drift_information: NotRequired[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. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

logical_resource_id instance-attribute

logical_resource_id: NotRequired[LogicalResourceId]

The logical name of the resource specified in the template.

module_info instance-attribute

module_info: NotRequired[ModuleInfo]

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

physical_resource_id instance-attribute

physical_resource_id: NotRequired[PhysicalResourceId]

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

resource_status instance-attribute

resource_status: NotRequired[ResourceStatus]

Current status of the resource.

resource_status_reason instance-attribute

resource_status_reason: NotRequired[ResourceStatusReason]

Success/failure message associated with the resource.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

stack_id instance-attribute

stack_id: NotRequired[StackId]

Unique identifier of the stack.

stack_name instance-attribute

stack_name: NotRequired[StackName]

The name associated with the stack.

timestamp instance-attribute

timestamp: NotRequired[Timestamp]

Time the status was updated.