UpdateConnection - AWS Direct Connect
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

UpdateConnection

Updates the AWS Direct Connect connection configuration.

You can update the following parameters for a connection:

  • The connection name

  • The connection's MAC Security (MACsec) encryption mode.

Request Syntax

{
   "connectionId": "string",
   "connectionName": "string",
   "encryptionMode": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

connectionId

The ID of the connection.

You can use DescribeConnections to retrieve the connection ID.

Type: String

Required: Yes

connectionName

The name of the connection.

Type: String

Required: No

encryptionMode

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Type: String

Required: No

Response Syntax

{
   "awsDevice": "string",
   "awsDeviceV2": "string",
   "awsLogicalDeviceId": "string",
   "bandwidth": "string",
   "connectionId": "string",
   "connectionName": "string",
   "connectionState": "string",
   "encryptionMode": "string",
   "hasLogicalRedundancy": "string",
   "jumboFrameCapable": boolean,
   "lagId": "string",
   "loaIssueTime": number,
   "location": "string",
   "macSecCapable": boolean,
   "macSecKeys": [ 
      { 
         "ckn": "string",
         "secretARN": "string",
         "startOn": "string",
         "state": "string"
      }
   ],
   "ownerAccount": "string",
   "partnerInterconnectMacSecCapable": boolean,
   "partnerName": "string",
   "portEncryptionStatus": "string",
   "providerName": "string",
   "region": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "vlan": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

awsDevice

This parameter has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

Type: String

awsDeviceV2

The Direct Connect endpoint that terminates the physical connection.

Type: String

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

bandwidth

The bandwidth of the connection.

Type: String

connectionId

The ID of the connection.

Type: String

connectionName

The name of the connection.

Type: String

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

encryptionMode

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Type: String

hasLogicalRedundancy

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

Type: String

Valid Values: unknown | yes | no

jumboFrameCapable

Indicates whether jumbo frames are supported.

Type: Boolean

lagId

The ID of the LAG.

Type: String

loaIssueTime

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

Type: Timestamp

location

The location of the connection.

Type: String

macSecCapable

Indicates whether the connection supports MAC Security (MACsec).

Type: Boolean

macSecKeys

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

Type: Array of MacSecKey objects

ownerAccount

The ID of the AWS account that owns the connection.

Type: String

partnerInterconnectMacSecCapable

Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).

Type: Boolean

partnerName

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

Type: String

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

providerName

The name of the service provider associated with the connection.

Type: String

region

The AWS Region where the connection is located.

Type: String

tags

The tags associated with the connection.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

vlan

The ID of the VLAN.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

See Also

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