Connection - AWS Direct Connect
ContentsSee Also

Connection

Information about an AWS Direct Connect connection.

Contents

awsDevice

This member has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

Type: String

Required: No

awsDeviceV2

The Direct Connect endpoint that terminates the physical connection.

Type: String

Required: No

awsLogicalDeviceId

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Type: String

Required: No

bandwidth

The bandwidth of the connection.

Type: String

Required: No

connectionId

The ID of the connection.

Type: String

Required: No

connectionName

The name of the connection.

Type: String

Required: No

connectionState

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

Type: String

Valid Values: ordering | requested | pending | available | down | deleting | deleted | rejected | unknown

Required: No

encryptionMode

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Type: String

Required: No

hasLogicalRedundancy

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

Type: String

Valid Values: unknown | yes | no

Required: No

jumboFrameCapable

Indicates whether jumbo frames are supported.

Type: Boolean

Required: No

lagId

The ID of the LAG.

Type: String

Required: No

loaIssueTime

The time of the most recent call to DescribeLoa for this connection.

Type: Timestamp

Required: No

location

The location of the connection.

Type: String

Required: No

macSecCapable

Indicates whether the connection supports MAC Security (MACsec).

Type: Boolean

Required: No

macSecKeys

The MAC Security (MACsec) security keys associated with the connection.

Type: Array of MacSecKey objects

Required: No

ownerAccount

The ID of the AWS account that owns the connection.

Type: String

Required: No

partnerName

The name of the AWS Direct Connect service provider associated with the connection.

Type: String

Required: No

portEncryptionStatus

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

Type: String

Required: No

providerName

The name of the service provider associated with the connection.

Type: String

Required: No

region

The AWS Region where the connection is located.

Type: String

Required: No

tags

The tags associated with the connection.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

vlan

The ID of the VLAN.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: