Skip to content

Host

Source code in docs_src/capo_codestar_connections/types/host.py
class Host(TypedDict, closed=True):
    name: NotRequired["capo_codestar_connections.types.host_name.HostName"]
    """<p>The name of the host.</p>"""
    host_arn: NotRequired["capo_codestar_connections.types.host_arn.HostArn"]
    """<p>The Amazon Resource Name (ARN) of the host.</p>"""
    provider_type: NotRequired[
        "capo_codestar_connections.types.provider_type.ProviderType"
    ]
    """<p>The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.</p>"""
    provider_endpoint: NotRequired["capo_codestar_connections.types.url.Url"]
    """<p>The endpoint of the infrastructure where your provider type is installed.</p>"""
    vpc_configuration: NotRequired[
        "capo_codestar_connections.types.vpc_configuration.VpcConfiguration"
    ]
    """<p>The VPC configuration provisioned for the host.</p>"""
    status: NotRequired["capo_codestar_connections.types.host_status.HostStatus"]
    """<p>The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.</p>"""
    status_message: NotRequired[
        "capo_codestar_connections.types.host_status_message.HostStatusMessage"
    ]
    """<p>The status description for the host.</p>"""

host_arn instance-attribute

host_arn: NotRequired[HostArn]

The Amazon Resource Name (ARN) of the host.

name instance-attribute

name: NotRequired[HostName]

The name of the host.

provider_endpoint instance-attribute

provider_endpoint: NotRequired[Url]

The endpoint of the infrastructure where your provider type is installed.

provider_type instance-attribute

provider_type: NotRequired[ProviderType]

The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

status instance-attribute

status: NotRequired[HostStatus]

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

status_message instance-attribute

status_message: NotRequired[HostStatusMessage]

The status description for the host.

vpc_configuration instance-attribute

vpc_configuration: NotRequired[VpcConfiguration]

The VPC configuration provisioned for the host.