Skip to content

Connection

Source code in docs_src/capo_interconnect/types/connection.py
class Connection(TypedDict, closed=True):
    id: "capo_interconnect.types.connection_id.ConnectionId"
    """<p>The short identifier of the connection object.</p>"""
    arn: "capo_interconnect.types.amazon_resource_name.AmazonResourceName"
    """<p>An ARN of a <a>Connection</a> object.</p>"""
    description: "capo_interconnect.types.connection_description.ConnectionDescription"
    """<p>A descriptive name for the connection.</p>"""
    bandwidth: "capo_interconnect.types.connection_bandwidth.ConnectionBandwidth"
    """<p>The specific selected bandwidth of this connection.</p>"""
    attach_point: "capo_interconnect.types.attach_point.AttachPoint"
    """<p>The Attach Point to which the connection should be associated."</p>"""
    environment_id: "capo_interconnect.types.environment_id.EnvironmentId"
    """<p>The specific <a>Environment</a> this connection is placed upon.</p>"""
    provider: "capo_interconnect.types.provider.Provider"
    """<p>The provider on the remote side of this <a>Connection</a>.</p>"""
    location: "capo_interconnect.types.location.Location"
    """<p>The provider specific location on the remote side of this <a>Connection</a> </p>"""
    type: "capo_interconnect.types.product_type.ProductType"
    """<p>The specific product type of this <a>Connection</a>.</p>"""
    state: "capo_interconnect.types.connection_state.ConnectionState"
    """<ul> <li> <p> <code>requested</code>: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.</p> </li> <li> <p> <code>pending</code>: The connection has been accepted and is being provisioned between AWS and the Partner.</p> </li> <li> <p> <code>available</code>: The connection has been fully provisioned between AWS and the Partner.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>failed</code>: The connection has failed to be created.</p> </li> <li> <p> <code>updating</code>: The connection is being updated.</p> </li> </ul>"""
    shared_id: "capo_interconnect.types.connection_shared_id.ConnectionSharedId"
    """<p>An identifier used by both AWS and the remote partner to identify the specific connection.</p>"""
    billing_tier: NotRequired["capo_interconnect.types.billing_tier.BillingTier"]
    """<p>The billing tier this connection is currently assigned.</p>"""
    owner_account: "capo_interconnect.types.owner_account_id.OwnerAccountId"
    """<p>The account that owns this <a>Connection</a> </p>"""
    activation_key: "capo_interconnect.types.activation_key.ActivationKey"
    """<p>The Activation Key associated to this connection.</p>"""
    tags: NotRequired["capo_interconnect.types.tag_map.TagMap"]
    """<p>The tags on the <a>Connection</a> </p>"""

activation_key instance-attribute

activation_key: ActivationKey

The Activation Key associated to this connection.

arn instance-attribute

An ARN of a Connection object.

attach_point instance-attribute

attach_point: AttachPoint

The Attach Point to which the connection should be associated."

bandwidth instance-attribute

The specific selected bandwidth of this connection.

billing_tier instance-attribute

billing_tier: NotRequired[BillingTier]

The billing tier this connection is currently assigned.

description instance-attribute

description: ConnectionDescription

A descriptive name for the connection.

environment_id instance-attribute

environment_id: EnvironmentId

The specific Environment this connection is placed upon.

id instance-attribute

The short identifier of the connection object.

location instance-attribute

location: Location

The provider specific location on the remote side of this Connection

owner_account instance-attribute

owner_account: OwnerAccountId

The account that owns this Connection

provider instance-attribute

provider: Provider

The provider on the remote side of this Connection.

shared_id instance-attribute

shared_id: ConnectionSharedId

An identifier used by both AWS and the remote partner to identify the specific connection.

state instance-attribute

  • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

  • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

  • available: The connection has been fully provisioned between AWS and the Partner.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • failed: The connection has failed to be created.

  • updating: The connection is being updated.

tags instance-attribute

tags: NotRequired[TagMap]

The tags on the Connection

type instance-attribute

The specific product type of this Connection.