Skip to content

Tunnel

Source code in docs_src/capo_iotsecuretunneling/types/tunnel.py
class Tunnel(TypedDict, closed=True):
    tunnel_id: NotRequired["capo_iotsecuretunneling.types.tunnel_id.TunnelId"]
    """<p>A unique alpha-numeric ID that identifies a tunnel.</p>"""
    tunnel_arn: NotRequired["capo_iotsecuretunneling.types.tunnel_arn.TunnelArn"]
    """<p>The Amazon Resource Name (ARN) of a tunnel.</p>"""
    status: NotRequired["capo_iotsecuretunneling.types.tunnel_status.TunnelStatus"]
    """<p>The status of a tunnel. Valid values are: Open and Closed.</p>"""
    source_connection_state: NotRequired[
        "capo_iotsecuretunneling.types.connection_state.ConnectionState"
    ]
    """<p>The connection state of the source application.</p>"""
    destination_connection_state: NotRequired[
        "capo_iotsecuretunneling.types.connection_state.ConnectionState"
    ]
    """<p>The connection state of the destination application.</p>"""
    description: NotRequired["capo_iotsecuretunneling.types.description.Description"]
    """<p>A description of the tunnel.</p>"""
    destination_config: NotRequired[
        "capo_iotsecuretunneling.types.destination_config.DestinationConfig"
    ]
    """<p>The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.</p>"""
    timeout_config: NotRequired[
        "capo_iotsecuretunneling.types.timeout_config.TimeoutConfig"
    ]
    """<p>Timeout configuration for the tunnel.</p>"""
    tags: NotRequired["capo_iotsecuretunneling.types.tag_list.TagList"]
    """<p>A list of tag metadata associated with the secure tunnel.</p>"""
    created_at: NotRequired["capo_iotsecuretunneling.types.date_type.DateType"]
    """<p>The time when the tunnel was created.</p>"""
    last_updated_at: NotRequired["capo_iotsecuretunneling.types.date_type.DateType"]
    """<p>The last time the tunnel was updated.</p>"""

created_at instance-attribute

created_at: NotRequired[DateType]

The time when the tunnel was created.

description instance-attribute

description: NotRequired[Description]

A description of the tunnel.

destination_config instance-attribute

destination_config: NotRequired[DestinationConfig]

The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

destination_connection_state instance-attribute

destination_connection_state: NotRequired[ConnectionState]

The connection state of the destination application.

last_updated_at instance-attribute

last_updated_at: NotRequired[DateType]

The last time the tunnel was updated.

source_connection_state instance-attribute

source_connection_state: NotRequired[ConnectionState]

The connection state of the source application.

status instance-attribute

status: NotRequired[TunnelStatus]

The status of a tunnel. Valid values are: Open and Closed.

tags instance-attribute

tags: NotRequired[TagList]

A list of tag metadata associated with the secure tunnel.

timeout_config instance-attribute

timeout_config: NotRequired[TimeoutConfig]

Timeout configuration for the tunnel.

tunnel_arn instance-attribute

tunnel_arn: NotRequired[TunnelArn]

The Amazon Resource Name (ARN) of a tunnel.

tunnel_id instance-attribute

tunnel_id: NotRequired[TunnelId]

A unique alpha-numeric ID that identifies a tunnel.