PhysicalResource ¶

Source code in docs_src/capo_resiliencehub/types/physical_resource.py

class PhysicalResource(TypedDict, closed=True):
    resource_name: NotRequired["capo_resiliencehub.types.entity_name.EntityName"]
    """<p>The name of the resource.</p>"""
    logical_resource_id: (
        "capo_resiliencehub.types.logical_resource_id.LogicalResourceId"
    )
    """<p>Logical identifier of the resource.</p>"""
    physical_resource_id: (
        "capo_resiliencehub.types.physical_resource_id.PhysicalResourceId"
    )
    """<p>Identifier of the physical resource.</p>"""
    resource_type: "capo_resiliencehub.types.string255.String255"
    """<p>Type of resource.</p>"""
    app_components: NotRequired[
        "capo_resiliencehub.types.app_component_list.AppComponentList"
    ]
    """<p>The application components that belong to this resource.</p>"""
    additional_info: NotRequired[
        "capo_resiliencehub.types.additional_info_map.AdditionalInfoMap"
    ]
    """<p>Additional configuration parameters for an Resilience Hub application. If you want to implement <code>additionalInfo</code> through the Resilience Hub console rather than using an API call, see <a href="https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html">Configure the application configuration parameters</a>.</p> <note> <p>Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.</p> <p>Key: <code>"failover-regions"</code> </p> <p>Value: <code>"[{"region":"&lt;REGION&gt;", "accounts":[{"id":"&lt;ACCOUNT_ID&gt;"}]}]"</code> </p> </note>"""
    excluded: NotRequired["capo_resiliencehub.types.boolean_optional.BooleanOptional"]
    """<p>Indicates if a resource is included or excluded from the assessment.</p>"""
    source_type: NotRequired[
        "capo_resiliencehub.types.resource_source_type.ResourceSourceType"
    ]
    """<p>Type of input source.</p>"""
    parent_resource_name: NotRequired["capo_resiliencehub.types.entity_name.EntityName"]
    """<p>Name of the parent resource.</p>"""

additional_info `instance-attribute` ¶

additional_info: NotRequired[AdditionalInfoMap]

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

app_components `instance-attribute` ¶

app_components: NotRequired[AppComponentList]

The application components that belong to this resource.

excluded `instance-attribute` ¶

excluded: NotRequired[BooleanOptional]

Indicates if a resource is included or excluded from the assessment.

logical_resource_id `instance-attribute` ¶

logical_resource_id: LogicalResourceId

Logical identifier of the resource.

parent_resource_name `instance-attribute` ¶

parent_resource_name: NotRequired[EntityName]

Name of the parent resource.