Amazon Direct Connect · JSON Structure
Amazon Direct Connect Connection Structure
Information about an Direct Connect connection.
Type: object
Properties: 22
Dedicated ConnectionDirect ConnectHybrid CloudNetworking
Connection is a JSON Structure definition published by Amazon Direct Connect, describing 22 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
ownerAccount
connectionId
connectionName
connectionState
region
location
bandwidth
vlan
partnerName
loaIssueTime
lagId
awsDevice
jumboFrameCapable
awsDeviceV2
awsLogicalDeviceId
hasLogicalRedundancy
tags
providerName
macSecCapable
portEncryptionStatus
encryptionMode
macSecKeys
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-direct-connect/refs/heads/main/json-structure/amazon-direct-connect-connection-structure.json",
"description": "Information about an Direct Connect connection.",
"type": "object",
"properties": {
"ownerAccount": {
"allOf": [
{
"$ref": "#/components/schemas/OwnerAccount"
},
{
"description": "The ID of the Amazon Web Services account that owns the connection."
}
]
},
"connectionId": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectionId"
},
{
"description": "The ID of the connection."
}
]
},
"connectionName": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectionName"
},
{
"description": "The name of the connection."
}
]
},
"connectionState": {
"allOf": [
{
"$ref": "#/components/schemas/ConnectionState"
},
{
"description": "<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: 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.</p> </li> <li> <p> <code>requested</code>: 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.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</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>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> <li> <p> <code>unknown</code>: The state of the connection is not available.</p> </li> </ul>"
}
]
},
"region": {
"allOf": [
{
"$ref": "#/components/schemas/Region"
},
{
"description": "The Amazon Web Services Region where the connection is located."
}
]
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/LocationCode"
},
{
"description": "The location of the connection."
}
]
},
"bandwidth": {
"allOf": [
{
"$ref": "#/components/schemas/Bandwidth"
},
{
"description": "The bandwidth of the connection."
}
]
},
"vlan": {
"allOf": [
{
"$ref": "#/components/schemas/VLAN"
},
{
"description": "The ID of the VLAN."
}
]
},
"partnerName": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerName"
},
{
"description": "The name of the Direct Connect service provider associated with the connection."
}
]
},
"loaIssueTime": {
"allOf": [
{
"$ref": "#/components/schemas/LoaIssueTime"
},
{
"description": "The time of the most recent call to <a>DescribeLoa</a> for this connection."
}
]
},
"lagId": {
"allOf": [
{
"$ref": "#/components/schemas/LagId"
},
{
"description": "The ID of the LAG."
}
]
},
"awsDevice": {
"allOf": [
{
"$ref": "#/components/schemas/AwsDevice"
},
{
"description": "The Direct Connect endpoint on which the physical connection terminates."
}
]
},
"jumboFrameCapable": {
"allOf": [
{
"$ref": "#/components/schemas/JumboFrameCapable"
},
{
"description": "Indicates whether jumbo frames (9001 MTU) are supported."
}
]
},
"awsDeviceV2": {
"allOf": [
{
"$ref": "#/components/schemas/AwsDeviceV2"
},
{
"description": "The Direct Connect endpoint that terminates the physical connection."
}
]
},
"awsLogicalDeviceId": {
"allOf": [
{
"$ref": "#/components/schemas/AwsLogicalDeviceId"
},
{
"description": "The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection."
}
]
},
"hasLogicalRedundancy": {
"allOf": [
{
"$ref": "#/components/schemas/HasLogicalRedundancy"
},
{
"description": "Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6)."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "The tags associated with the connection."
}
]
},
"providerName": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderName"
},
{
"description": "The name of the service provider associated with the connection."
}
]
},
"macSecCapable": {
"allOf": [
{
"$ref": "#/components/schemas/MacSecCapable"
},
{
"description": "Indicates whether the connection supports MAC Security (MACsec)."
}
]
},
"portEncryptionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/PortEncryptionStatus"
},
{
"description": "<p>The MAC Security (MACsec) port link status of the connection.</p> <p>The valid values are <code>Encryption Up</code>, which means that there is an active Connection Key Name, or <code>Encryption Down</code>.</p>"
}
]
},
"encryptionMode": {
"allOf": [
{
"$ref": "#/components/schemas/EncryptionMode"
},
{
"description": "<p>The MAC Security (MACsec) connection encryption mode.</p> <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>"
}
]
},
"macSecKeys": {
"allOf": [
{
"$ref": "#/components/schemas/MacSecKeyList"
},
{
"description": "The MAC Security (MACsec) security keys associated with the connection."
}
]
}
},
"name": "Connection"
}