SDK for PHP 3.x

Client: Aws\DirectConnect\DirectConnectClient
Service ID: directconnect
Version: 2012-10-25

This page describes the parameters and results for the operations of the AWS Direct Connect (2012-10-25), and shows how to use the Aws\DirectConnect\DirectConnectClient object to call the described operations. This documentation is specific to the 2012-10-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptDirectConnectGatewayAssociationProposal ( array $params = [] )
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
AllocateConnectionOnInterconnect ( array $params = [] )
Deprecated.
AllocateHostedConnection ( array $params = [] )
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
AllocatePrivateVirtualInterface ( array $params = [] )
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
AllocatePublicVirtualInterface ( array $params = [] )
Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
AllocateTransitVirtualInterface ( array $params = [] )
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
AssociateConnectionWithLag ( array $params = [] )
Associates an existing connection with a link aggregation group (LAG).
AssociateHostedConnection ( array $params = [] )
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
AssociateMacSecKey ( array $params = [] )
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
AssociateVirtualInterface ( array $params = [] )
Associates a virtual interface with a specified link aggregation group (LAG) or connection.
ConfirmConnection ( array $params = [] )
Confirms the creation of the specified hosted connection on an interconnect.
ConfirmCustomerAgreement ( array $params = [] )
The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
ConfirmPrivateVirtualInterface ( array $params = [] )
Accepts ownership of a private virtual interface created by another Amazon Web Services account.
ConfirmPublicVirtualInterface ( array $params = [] )
Accepts ownership of a public virtual interface created by another Amazon Web Services account.
ConfirmTransitVirtualInterface ( array $params = [] )
Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
CreateBGPPeer ( array $params = [] )
Creates a BGP peer on the specified virtual interface.
CreateConnection ( array $params = [] )
Creates a connection between a customer network and a specific Direct Connect location.
CreateDirectConnectGateway ( array $params = [] )
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways.
CreateDirectConnectGatewayAssociation ( array $params = [] )
Creates an association between a Direct Connect gateway and a virtual private gateway.
CreateDirectConnectGatewayAssociationProposal ( array $params = [] )
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
CreateInterconnect ( array $params = [] )
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
CreateLag ( array $params = [] )
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location.
CreatePrivateVirtualInterface ( array $params = [] )
Creates a private virtual interface.
CreatePublicVirtualInterface ( array $params = [] )
Creates a public virtual interface.
CreateTransitVirtualInterface ( array $params = [] )
Creates a transit virtual interface.
DeleteBGPPeer ( array $params = [] )
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
DeleteConnection ( array $params = [] )
Deletes the specified connection.
DeleteDirectConnectGateway ( array $params = [] )
Deletes the specified Direct Connect gateway.
DeleteDirectConnectGatewayAssociation ( array $params = [] )
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
DeleteDirectConnectGatewayAssociationProposal ( array $params = [] )
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
DeleteInterconnect ( array $params = [] )
Deletes the specified interconnect.
DeleteLag ( array $params = [] )
Deletes the specified link aggregation group (LAG).
DeleteVirtualInterface ( array $params = [] )
Deletes a virtual interface.
DescribeConnectionLoa ( array $params = [] )
Deprecated.
DescribeConnections ( array $params = [] )
Displays the specified connection or all connections in this Region.
DescribeConnectionsOnInterconnect ( array $params = [] )
Deprecated.
DescribeCustomerMetadata ( array $params = [] )
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
DescribeDirectConnectGatewayAssociationProposals ( array $params = [] )
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
DescribeDirectConnectGatewayAssociations ( array $params = [] )
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways.
DescribeDirectConnectGatewayAttachments ( array $params = [] )
Lists the attachments between your Direct Connect gateways and virtual interfaces.
DescribeDirectConnectGateways ( array $params = [] )
Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
DescribeHostedConnections ( array $params = [] )
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
DescribeInterconnectLoa ( array $params = [] )
Deprecated.
DescribeInterconnects ( array $params = [] )
Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
DescribeLags ( array $params = [] )
Describes all your link aggregation groups (LAG) or the specified LAG.
DescribeLoa ( array $params = [] )
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
DescribeLocations ( array $params = [] )
Lists the Direct Connect locations in the current Amazon Web Services Region.
DescribeRouterConfiguration ( array $params = [] )
Details about the router.
DescribeTags ( array $params = [] )
Describes the tags associated with the specified Direct Connect resources.
DescribeVirtualGateways ( array $params = [] )
Deprecated.
DescribeVirtualInterfaces ( array $params = [] )
Displays all virtual interfaces for an Amazon Web Services account.
DisassociateConnectionFromLag ( array $params = [] )
Disassociates a connection from a link aggregation group (LAG).
DisassociateMacSecKey ( array $params = [] )
Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
ListVirtualInterfaceTestHistory ( array $params = [] )
Lists the virtual interface failover test history.
StartBgpFailoverTest ( array $params = [] )
Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state.
StopBgpFailoverTest ( array $params = [] )
Stops the virtual interface failover test.
TagResource ( array $params = [] )
Adds the specified tags to the specified Direct Connect resource.
UntagResource ( array $params = [] )
Removes one or more tags from the specified Direct Connect resource.
UpdateConnection ( array $params = [] )
Updates the Direct Connect dedicated connection configuration.
UpdateDirectConnectGateway ( array $params = [] )
Updates the name of a current Direct Connect gateway.
UpdateDirectConnectGatewayAssociation ( array $params = [] )
Updates the specified attributes of the Direct Connect gateway association.
UpdateLag ( array $params = [] )
Updates the attributes of the specified link aggregation group (LAG).
UpdateVirtualInterfaceAttributes ( array $params = [] )
Updates the specified attributes of the specified virtual private interface.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeConnections
DescribeConnectionsOnInterconnect
DescribeInterconnects
DescribeLocations
DescribeVirtualGateways
DescribeVirtualInterfaces

Operations

AcceptDirectConnectGatewayAssociationProposal

$result = $client->acceptDirectConnectGatewayAssociationProposal([/* ... */]);
$promise = $client->acceptDirectConnectGatewayAssociationProposalAsync([/* ... */]);

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

Parameter Syntax

$result = $client->acceptDirectConnectGatewayAssociationProposal([
    'associatedGatewayOwnerAccount' => '<string>', // REQUIRED
    'directConnectGatewayId' => '<string>', // REQUIRED
    'overrideAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'proposalId' => '<string>', // REQUIRED
]);

Parameter Details

Members
associatedGatewayOwnerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.

directConnectGatewayId
Required: Yes
Type: string

The ID of the Direct Connect gateway.

overrideAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

proposalId
Required: Yes
Type: string

The ID of the request proposal.

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Members
directConnectGatewayAssociation

Information about an association between a Direct Connect gateway and a virtual gateway or transit gateway.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocateConnectionOnInterconnect

$result = $client->allocateConnectionOnInterconnect([/* ... */]);
$promise = $client->allocateConnectionOnInterconnectAsync([/* ... */]);

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->allocateConnectionOnInterconnect([
    'bandwidth' => '<string>', // REQUIRED
    'connectionName' => '<string>', // REQUIRED
    'interconnectId' => '<string>', // REQUIRED
    'ownerAccount' => '<string>', // REQUIRED
    'vlan' => <integer>, // REQUIRED
]);

Parameter Details

Members
bandwidth
Required: Yes
Type: string

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

connectionName
Required: Yes
Type: string

The name of the provisioned connection.

interconnectId
Required: Yes
Type: string

The ID of the interconnect on which the connection will be provisioned.

ownerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.

vlan
Required: Yes
Type: int

The dedicated VLAN provisioned to the connection.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocateHostedConnection

$result = $client->allocateHostedConnection([/* ... */]);
$promise = $client->allocateHostedConnectionAsync([/* ... */]);

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->allocateHostedConnection([
    'bandwidth' => '<string>', // REQUIRED
    'connectionId' => '<string>', // REQUIRED
    'connectionName' => '<string>', // REQUIRED
    'ownerAccount' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>, // REQUIRED
]);

Parameter Details

Members
bandwidth
Required: Yes
Type: string

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection.

connectionId
Required: Yes
Type: string

The ID of the interconnect or LAG.

connectionName
Required: Yes
Type: string

The name of the hosted connection.

ownerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account ID of the customer for the connection.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Required: Yes
Type: int

The dedicated VLAN provisioned to the hosted connection.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocatePrivateVirtualInterface

$result = $client->allocatePrivateVirtualInterface([/* ... */]);
$promise = $client->allocatePrivateVirtualInterfaceAsync([/* ... */]);

Provisions a private virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

Parameter Syntax

$result = $client->allocatePrivateVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPrivateVirtualInterfaceAllocation' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
    'ownerAccount' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection on which the private virtual interface is provisioned.

newPrivateVirtualInterfaceAllocation
Required: Yes
Type: NewPrivateVirtualInterfaceAllocation structure

Information about the private virtual interface.

ownerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account that owns the virtual private interface.

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bgpPeers
Type: Array of BGPPeer structures

The BGP peers configured on this virtual interface.

connectionId
Type: string

The ID of the connection.

customerAddress
Type: string

The IP address assigned to the customer interface.

customerRouterConfig
Type: string

The customer router configuration.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

location
Type: string

The location of the connection.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

region
Type: string

The Amazon Web Services Region where the virtual interface is located.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

siteLinkEnabled
Type: boolean

Indicates whether SiteLink is enabled.

tags
Type: Array of Tag structures

The tags associated with the virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

virtualInterfaceType
Type: string

The type of virtual interface. The possible values are private, public and transit.

vlan
Type: int

The ID of the VLAN.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocatePublicVirtualInterface

$result = $client->allocatePublicVirtualInterface([/* ... */]);
$promise = $client->allocatePublicVirtualInterfaceAsync([/* ... */]);

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

Parameter Syntax

$result = $client->allocatePublicVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPublicVirtualInterfaceAllocation' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
    'ownerAccount' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection on which the public virtual interface is provisioned.

newPublicVirtualInterfaceAllocation
Required: Yes
Type: NewPublicVirtualInterfaceAllocation structure

Information about the public virtual interface.

ownerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account that owns the public virtual interface.

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bgpPeers
Type: Array of BGPPeer structures

The BGP peers configured on this virtual interface.

connectionId
Type: string

The ID of the connection.

customerAddress
Type: string

The IP address assigned to the customer interface.

customerRouterConfig
Type: string

The customer router configuration.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

location
Type: string

The location of the connection.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

region
Type: string

The Amazon Web Services Region where the virtual interface is located.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

siteLinkEnabled
Type: boolean

Indicates whether SiteLink is enabled.

tags
Type: Array of Tag structures

The tags associated with the virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

virtualInterfaceType
Type: string

The type of virtual interface. The possible values are private, public and transit.

vlan
Type: int

The ID of the VLAN.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocateTransitVirtualInterface

$result = $client->allocateTransitVirtualInterface([/* ... */]);
$promise = $client->allocateTransitVirtualInterfaceAsync([/* ... */]);

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

Parameter Syntax

$result = $client->allocateTransitVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newTransitVirtualInterfaceAllocation' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>,
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>',
        'vlan' => <integer>,
    ],
    'ownerAccount' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection on which the transit virtual interface is provisioned.

newTransitVirtualInterfaceAllocation
Required: Yes
Type: NewTransitVirtualInterfaceAllocation structure

Information about the transit virtual interface.

ownerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account that owns the transit virtual interface.

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Members
virtualInterface
Type: VirtualInterface structure

Information about the transit virtual interface.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateConnectionWithLag

$result = $client->associateConnectionWithLag([/* ... */]);
$promise = $client->associateConnectionWithLagAsync([/* ... */]);

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

Parameter Syntax

$result = $client->associateConnectionWithLag([
    'connectionId' => '<string>', // REQUIRED
    'lagId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

lagId
Required: Yes
Type: string

The ID of the LAG with which to associate the connection.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateHostedConnection

$result = $client->associateHostedConnection([/* ... */]);
$promise = $client->associateHostedConnectionAsync([/* ... */]);

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->associateHostedConnection([
    'connectionId' => '<string>', // REQUIRED
    'parentConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the hosted connection.

parentConnectionId
Required: Yes
Type: string

The ID of the interconnect or the LAG.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateMacSecKey

$result = $client->associateMacSecKey([/* ... */]);
$promise = $client->associateMacSecKeyAsync([/* ... */]);

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

Parameter Syntax

$result = $client->associateMacSecKey([
    'cak' => '<string>',
    'ckn' => '<string>',
    'connectionId' => '<string>', // REQUIRED
    'secretARN' => '<string>',
]);

Parameter Details

Members
cak
Type: string

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

ckn
Type: string

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

connectionId
Required: Yes
Type: string

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

secretARN
Type: string

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

Result Syntax

[
    'connectionId' => '<string>',
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
connectionId
Type: string

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

macSecKeys
Type: Array of MacSecKey structures

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

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateVirtualInterface

$result = $client->associateVirtualInterface([/* ... */]);
$promise = $client->associateVirtualInterfaceAsync([/* ... */]);

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

Parameter Syntax

$result = $client->associateVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the LAG or connection.

virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface.

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bgpPeers
Type: Array of BGPPeer structures

The BGP peers configured on this virtual interface.

connectionId
Type: string

The ID of the connection.

customerAddress
Type: string

The IP address assigned to the customer interface.

customerRouterConfig
Type: string

The customer router configuration.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

location
Type: string

The location of the connection.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

region
Type: string

The Amazon Web Services Region where the virtual interface is located.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

siteLinkEnabled
Type: boolean

Indicates whether SiteLink is enabled.

tags
Type: Array of Tag structures

The tags associated with the virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

virtualInterfaceType
Type: string

The type of virtual interface. The possible values are private, public and transit.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmConnection

$result = $client->confirmConnection([/* ... */]);
$promise = $client->confirmConnectionAsync([/* ... */]);

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.

Parameter Syntax

$result = $client->confirmConnection([
    'connectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the hosted connection.

Result Syntax

[
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Members
connectionState
Type: string

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.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmCustomerAgreement

$result = $client->confirmCustomerAgreement([/* ... */]);
$promise = $client->confirmCustomerAgreementAsync([/* ... */]);

The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).

Parameter Syntax

$result = $client->confirmCustomerAgreement([
    'agreementName' => '<string>',
]);

Parameter Details

Members
agreementName
Type: string

The name of the customer agreement.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members
status
Type: string

The status of the customer agreement when the connection was created. This will be either signed or unsigned.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmPrivateVirtualInterface

$result = $client->confirmPrivateVirtualInterface([/* ... */]);
$promise = $client->confirmPrivateVirtualInterfaceAsync([/* ... */]);

Accepts ownership of a private virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

Parameter Syntax

$result = $client->confirmPrivateVirtualInterface([
    'directConnectGatewayId' => '<string>',
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

virtualGatewayId
Type: string

The ID of the virtual private gateway.

virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Members
virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmPublicVirtualInterface

$result = $client->confirmPublicVirtualInterface([/* ... */]);
$promise = $client->confirmPublicVirtualInterfaceAsync([/* ... */]);

Accepts ownership of a public virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.

Parameter Syntax

$result = $client->confirmPublicVirtualInterface([
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Members
virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmTransitVirtualInterface

$result = $client->confirmTransitVirtualInterface([/* ... */]);
$promise = $client->confirmTransitVirtualInterfaceAsync([/* ... */]);

Accepts ownership of a transit virtual interface created by another Amazon Web Services account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

Parameter Syntax

$result = $client->confirmTransitVirtualInterface([
    'directConnectGatewayId' => '<string>', // REQUIRED
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
directConnectGatewayId
Required: Yes
Type: string

The ID of the Direct Connect gateway.

virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Members
virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateBGPPeer

$result = $client->createBGPPeer([/* ... */]);
$promise = $client->createBGPPeerAsync([/* ... */]);

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use the customer router peer IP address as the source and destination for traffic. Instead you should use RFC 1918 or other addressing, and specify the address yourself. For more information about RFC 1918 see Address Allocation for Private Internets.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

Parameter Syntax

$result = $client->createBGPPeer([
    'newBGPPeer' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>,
        'authKey' => '<string>',
        'customerAddress' => '<string>',
    ],
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Members
newBGPPeer
Type: NewBGPPeer structure

Information about the BGP peer.

virtualInterfaceId
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Members
virtualInterface
Type: VirtualInterface structure

The virtual interface.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateConnection

$result = $client->createConnection([/* ... */]);
$promise = $client->createConnectionAsync([/* ... */]);

Creates a connection between a customer network and a specific Direct Connect location.

A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.

To find the locations for your Region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

Parameter Syntax

$result = $client->createConnection([
    'bandwidth' => '<string>', // REQUIRED
    'connectionName' => '<string>', // REQUIRED
    'lagId' => '<string>',
    'location' => '<string>', // REQUIRED
    'providerName' => '<string>',
    'requestMACSec' => true || false,
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
bandwidth
Required: Yes
Type: string

The bandwidth of the connection.

connectionName
Required: Yes
Type: string

The name of the connection.

lagId
Type: string

The ID of the LAG.

location
Required: Yes
Type: string

The location of the connection.

providerName
Type: string

The name of the service provider associated with the requested connection.

requestMACSec
Type: boolean

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

tags
Type: Array of Tag structures

The tags to associate with the lag.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateDirectConnectGateway

$result = $client->createDirectConnectGateway([/* ... */]);
$promise = $client->createDirectConnectGatewayAsync([/* ... */]);

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

Parameter Syntax

$result = $client->createDirectConnectGateway([
    'amazonSideAsn' => <integer>,
    'directConnectGatewayName' => '<string>', // REQUIRED
]);

Parameter Details

Members
amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

directConnectGatewayName
Required: Yes
Type: string

The name of the Direct Connect gateway.

Result Syntax

[
    'directConnectGateway' => [
        'amazonSideAsn' => <integer>,
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayName' => '<string>',
        'directConnectGatewayState' => 'pending|available|deleting|deleted',
        'ownerAccount' => '<string>',
        'stateChangeError' => '<string>',
    ],
]

Result Details

Members
directConnectGateway
Type: DirectConnectGateway structure

The Direct Connect gateway.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateDirectConnectGatewayAssociation

$result = $client->createDirectConnectGatewayAssociation([/* ... */]);
$promise = $client->createDirectConnectGatewayAssociationAsync([/* ... */]);

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

Parameter Syntax

$result = $client->createDirectConnectGatewayAssociation([
    'addAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'directConnectGatewayId' => '<string>', // REQUIRED
    'gatewayId' => '<string>',
    'virtualGatewayId' => '<string>',
]);

Parameter Details

Members
addAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

directConnectGatewayId
Required: Yes
Type: string

The ID of the Direct Connect gateway.

gatewayId
Type: string

The ID of the virtual private gateway or transit gateway.

virtualGatewayId
Type: string

The ID of the virtual private gateway.

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Members
directConnectGatewayAssociation

The association to be created.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateDirectConnectGatewayAssociationProposal

$result = $client->createDirectConnectGatewayAssociationProposal([/* ... */]);
$promise = $client->createDirectConnectGatewayAssociationProposalAsync([/* ... */]);

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.

Parameter Syntax

$result = $client->createDirectConnectGatewayAssociationProposal([
    'addAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'directConnectGatewayId' => '<string>', // REQUIRED
    'directConnectGatewayOwnerAccount' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
    'removeAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
addAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

directConnectGatewayId
Required: Yes
Type: string

The ID of the Direct Connect gateway.

directConnectGatewayOwnerAccount
Required: Yes
Type: string

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

gatewayId
Required: Yes
Type: string

The ID of the virtual private gateway or transit gateway.

removeAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

Result Syntax

[
    'directConnectGatewayAssociationProposal' => [
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'existingAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'proposalId' => '<string>',
        'proposalState' => 'requested|accepted|deleted',
        'requestedAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
directConnectGatewayAssociationProposal

Information about the Direct Connect gateway proposal.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateInterconnect

$result = $client->createInterconnect([/* ... */]);
$promise = $client->createInterconnectAsync([/* ... */]);

Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->createInterconnect([
    'bandwidth' => '<string>', // REQUIRED
    'interconnectName' => '<string>', // REQUIRED
    'lagId' => '<string>',
    'location' => '<string>', // REQUIRED
    'providerName' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
bandwidth
Required: Yes
Type: string

The port bandwidth, in Gbps. The possible values are 1, 10, and 100.

interconnectName
Required: Yes
Type: string

The name of the interconnect.

lagId
Type: string

The ID of the LAG.

location
Required: Yes
Type: string

The location of the interconnect.

providerName
Type: string

The name of the service provider associated with the interconnect.

tags
Type: Array of Tag structures

The tags to associate with the interconnect.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'interconnectId' => '<string>',
    'interconnectName' => '<string>',
    'interconnectState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

hasLogicalRedundancy
Type: string

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

interconnectId
Type: string

The ID of the interconnect.

interconnectName
Type: string

The name of the interconnect.

interconnectState
Type: string

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

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

  • pending: The interconnect is approved, and is being initialized.

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

  • down: The network link is down.

  • deleting: The interconnect is being deleted.

  • deleted: The interconnect is deleted.

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

providerName
Type: string

The name of the service provider associated with the interconnect.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the interconnect.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateLag

$result = $client->createLag([/* ... */]);
$promise = $client->createLagAsync([/* ... */]);

Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (either 1Gbps, 10Gbps, 100Gbps, or 400Gbps) and must terminate at the same Direct Connect endpoint.

You can have up to 10 dedicated connections per location. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created..

You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

Parameter Syntax

$result = $client->createLag([
    'childConnectionTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'connectionsBandwidth' => '<string>', // REQUIRED
    'lagName' => '<string>', // REQUIRED
    'location' => '<string>', // REQUIRED
    'numberOfConnections' => <integer>, // REQUIRED
    'providerName' => '<string>',
    'requestMACSec' => true || false,
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
childConnectionTags
Type: Array of Tag structures

The tags to associate with the automtically created LAGs.

connectionId
Type: string

The ID of an existing dedicated connection to migrate to the LAG.

connectionsBandwidth
Required: Yes
Type: string

The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps.

lagName
Required: Yes
Type: string

The name of the LAG.

location
Required: Yes
Type: string

The location for the LAG.

numberOfConnections
Required: Yes
Type: int

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when the port speed is 100Gbps or 400Gbps.

providerName
Type: string

The name of the service provider associated with the LAG.

requestMACSec
Type: boolean

Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

tags
Type: Array of Tag structures

The tags to associate with the LAG.

Result Syntax

[
    'allowsHostedConnections' => true || false,
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
    'connectionsBandwidth' => '<string>',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'lagName' => '<string>',
    'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'minimumLinks' => <integer>,
    'numberOfConnections' => <integer>,
    'ownerAccount' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
allowsHostedConnections
Type: boolean

Indicates whether the LAG can host other connections.

awsDevice
Type: string

The Direct Connect endpoint that hosts the LAG.

awsDeviceV2
Type: string

The Direct Connect endpoint that hosts the LAG.

awsLogicalDeviceId
Type: string

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

connections
Type: Array of Connection structures

The connections bundled by the LAG.

connectionsBandwidth
Type: string

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

encryptionMode
Type: string

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

lagName
Type: string

The name of the LAG.

lagState
Type: string

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

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

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

  • available: The network link is established and the LAG is ready for use.

  • down: The network link is down.

  • deleting: The LAG is being deleted.

  • deleted: The LAG is deleted.

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

location
Type: string

The location of the LAG.

macSecCapable
Type: boolean

Indicates whether the LAG supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

minimumLinks
Type: int

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

numberOfConnections
Type: int

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the LAG.

providerName
Type: string

The name of the service provider associated with the LAG.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the LAG.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreatePrivateVirtualInterface

$result = $client->createPrivateVirtualInterface([/* ... */]);
$promise = $client->createPrivateVirtualInterfaceAsync([/* ... */]);

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Parameter Syntax

$result = $client->createPrivateVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPrivateVirtualInterface' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'directConnectGatewayId' => '<string>',
        'enableSiteLink' => true || false,
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

newPrivateVirtualInterface
Required: Yes
Type: NewPrivateVirtualInterface structure

Information about the private virtual interface.

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bgpPeers
Type: Array of BGPPeer structures

The BGP peers configured on this virtual interface.

connectionId
Type: string

The ID of the connection.

customerAddress
Type: string

The IP address assigned to the customer interface.

customerRouterConfig
Type: string

The customer router configuration.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

location
Type: string

The location of the connection.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

region
Type: string

The Amazon Web Services Region where the virtual interface is located.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

siteLinkEnabled
Type: boolean

Indicates whether SiteLink is enabled.

tags
Type: Array of Tag structures

The tags associated with the virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

virtualInterfaceType
Type: string

The type of virtual interface. The possible values are private, public and transit.

vlan
Type: int

The ID of the VLAN.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreatePublicVirtualInterface

$result = $client->createPublicVirtualInterface([/* ... */]);
$promise = $client->createPublicVirtualInterfaceAsync([/* ... */]);

Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

Parameter Syntax

$result = $client->createPublicVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPublicVirtualInterface' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

newPublicVirtualInterface
Required: Yes
Type: NewPublicVirtualInterface structure

Information about the public virtual interface.

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bgpPeers
Type: Array of BGPPeer structures

The BGP peers configured on this virtual interface.

connectionId
Type: string

The ID of the connection.

customerAddress
Type: string

The IP address assigned to the customer interface.

customerRouterConfig
Type: string

The customer router configuration.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

location
Type: string

The location of the connection.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

region
Type: string

The Amazon Web Services Region where the virtual interface is located.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

siteLinkEnabled
Type: boolean

Indicates whether SiteLink is enabled.

tags
Type: Array of Tag structures

The tags associated with the virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

virtualInterfaceType
Type: string

The type of virtual interface. The possible values are private, public and transit.

vlan
Type: int

The ID of the VLAN.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateTransitVirtualInterface

$result = $client->createTransitVirtualInterface([/* ... */]);
$promise = $client->createTransitVirtualInterfaceAsync([/* ... */]);

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Parameter Syntax

$result = $client->createTransitVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newTransitVirtualInterface' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>,
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'directConnectGatewayId' => '<string>',
        'enableSiteLink' => true || false,
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>',
        'vlan' => <integer>,
    ],
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

newTransitVirtualInterface
Required: Yes
Type: NewTransitVirtualInterface structure

Information about the transit virtual interface.

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Members
virtualInterface
Type: VirtualInterface structure

Information about a virtual interface.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteBGPPeer

$result = $client->deleteBGPPeer([/* ... */]);
$promise = $client->deleteBGPPeerAsync([/* ... */]);

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

Parameter Syntax

$result = $client->deleteBGPPeer([
    'asn' => <integer>,
    'bgpPeerId' => '<string>',
    'customerAddress' => '<string>',
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Members
asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgpPeerId
Type: string

The ID of the BGP peer.

customerAddress
Type: string

The IP address assigned to the customer interface.

virtualInterfaceId
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Members
virtualInterface
Type: VirtualInterface structure

The virtual interface.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteConnection

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

Deletes the specified connection.

Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.

Parameter Syntax

$result = $client->deleteConnection([
    'connectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteDirectConnectGateway

$result = $client->deleteDirectConnectGateway([/* ... */]);
$promise = $client->deleteDirectConnectGatewayAsync([/* ... */]);

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

Parameter Syntax

$result = $client->deleteDirectConnectGateway([
    'directConnectGatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Members
directConnectGatewayId
Required: Yes
Type: string

The ID of the Direct Connect gateway.

Result Syntax

[
    'directConnectGateway' => [
        'amazonSideAsn' => <integer>,
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayName' => '<string>',
        'directConnectGatewayState' => 'pending|available|deleting|deleted',
        'ownerAccount' => '<string>',
        'stateChangeError' => '<string>',
    ],
]

Result Details

Members
directConnectGateway
Type: DirectConnectGateway structure

The Direct Connect gateway.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteDirectConnectGatewayAssociation

$result = $client->deleteDirectConnectGatewayAssociation([/* ... */]);
$promise = $client->deleteDirectConnectGatewayAssociationAsync([/* ... */]);

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

Parameter Syntax

$result = $client->deleteDirectConnectGatewayAssociation([
    'associationId' => '<string>',
    'directConnectGatewayId' => '<string>',
    'virtualGatewayId' => '<string>',
]);

Parameter Details

Members
associationId
Type: string

The ID of the Direct Connect gateway association.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

virtualGatewayId
Type: string

The ID of the virtual private gateway.

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Members
directConnectGatewayAssociation

Information about the deleted association.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteDirectConnectGatewayAssociationProposal

$result = $client->deleteDirectConnectGatewayAssociationProposal([/* ... */]);
$promise = $client->deleteDirectConnectGatewayAssociationProposalAsync([/* ... */]);

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

Parameter Syntax

$result = $client->deleteDirectConnectGatewayAssociationProposal([
    'proposalId' => '<string>', // REQUIRED
]);

Parameter Details

Members
proposalId
Required: Yes
Type: string

The ID of the proposal.

Result Syntax

[
    'directConnectGatewayAssociationProposal' => [
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'existingAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'proposalId' => '<string>',
        'proposalState' => 'requested|accepted|deleted',
        'requestedAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
directConnectGatewayAssociationProposal

The ID of the associated gateway.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteInterconnect

$result = $client->deleteInterconnect([/* ... */]);
$promise = $client->deleteInterconnectAsync([/* ... */]);

Deletes the specified interconnect.

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->deleteInterconnect([
    'interconnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members
interconnectId
Required: Yes
Type: string

The ID of the interconnect.

Result Syntax

[
    'interconnectState' => 'requested|pending|available|down|deleting|deleted|unknown',
]

Result Details

Members
interconnectState
Type: string

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

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

  • pending: The interconnect is approved, and is being initialized.

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

  • down: The network link is down.

  • deleting: The interconnect is being deleted.

  • deleted: The interconnect is deleted.

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

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteLag

$result = $client->deleteLag([/* ... */]);
$promise = $client->deleteLagAsync([/* ... */]);

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

Parameter Syntax

$result = $client->deleteLag([
    'lagId' => '<string>', // REQUIRED
]);

Parameter Details

Members
lagId
Required: Yes
Type: string

The ID of the LAG.

Result Syntax

[
    'allowsHostedConnections' => true || false,
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
    'connectionsBandwidth' => '<string>',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'lagName' => '<string>',
    'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'minimumLinks' => <integer>,
    'numberOfConnections' => <integer>,
    'ownerAccount' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
allowsHostedConnections
Type: boolean

Indicates whether the LAG can host other connections.

awsDevice
Type: string

The Direct Connect endpoint that hosts the LAG.

awsDeviceV2
Type: string

The Direct Connect endpoint that hosts the LAG.

awsLogicalDeviceId
Type: string

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

connections
Type: Array of Connection structures

The connections bundled by the LAG.

connectionsBandwidth
Type: string

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

encryptionMode
Type: string

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

lagName
Type: string

The name of the LAG.

lagState
Type: string

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

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

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

  • available: The network link is established and the LAG is ready for use.

  • down: The network link is down.

  • deleting: The LAG is being deleted.

  • deleted: The LAG is deleted.

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

location
Type: string

The location of the LAG.

macSecCapable
Type: boolean

Indicates whether the LAG supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

minimumLinks
Type: int

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

numberOfConnections
Type: int

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the LAG.

providerName
Type: string

The name of the service provider associated with the LAG.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the LAG.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteVirtualInterface

$result = $client->deleteVirtualInterface([/* ... */]);
$promise = $client->deleteVirtualInterfaceAsync([/* ... */]);

Deletes a virtual interface.

Parameter Syntax

$result = $client->deleteVirtualInterface([
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Members
virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeConnectionLoa

$result = $client->describeConnectionLoa([/* ... */]);
$promise = $client->describeConnectionLoaAsync([/* ... */]);

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Parameter Syntax

$result = $client->describeConnectionLoa([
    'connectionId' => '<string>', // REQUIRED
    'loaContentType' => 'application/pdf',
    'providerName' => '<string>',
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

loaContentType
Type: string

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

providerName
Type: string

The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

Result Syntax

[
    'loa' => [
        'loaContent' => <string || resource || Psr\Http\Message\StreamInterface>,
        'loaContentType' => 'application/pdf',
    ],
]

Result Details

Members
loa
Type: Loa structure

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeConnections

$result = $client->describeConnections([/* ... */]);
$promise = $client->describeConnectionsAsync([/* ... */]);

Displays the specified connection or all connections in this Region.

Parameter Syntax

$result = $client->describeConnections([
    'connectionId' => '<string>',
]);

Parameter Details

Members
connectionId
Type: string

The ID of the connection.

Result Syntax

[
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
connections
Type: Array of Connection structures

The connections.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeConnectionsOnInterconnect

$result = $client->describeConnectionsOnInterconnect([/* ... */]);
$promise = $client->describeConnectionsOnInterconnectAsync([/* ... */]);

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->describeConnectionsOnInterconnect([
    'interconnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members
interconnectId
Required: Yes
Type: string

The ID of the interconnect.

Result Syntax

[
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
connections
Type: Array of Connection structures

The connections.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeCustomerMetadata

$result = $client->describeCustomerMetadata([/* ... */]);
$promise = $client->describeCustomerMetadataAsync([/* ... */]);

Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.

Parameter Syntax

$result = $client->describeCustomerMetadata([
]);

Parameter Details

Members

Result Syntax

[
    'agreements' => [
        [
            'agreementName' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nniPartnerType' => 'v1|v2|nonPartner',
]

Result Details

Members
agreements
Type: Array of CustomerAgreement structures

The list of customer agreements.

nniPartnerType
Type: string

The type of network-to-network interface (NNI) partner. The partner type will be one of the following:

  • V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.

  • V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.

  • nonPartner: The customer is not a partner.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGatewayAssociationProposals

$result = $client->describeDirectConnectGatewayAssociationProposals([/* ... */]);
$promise = $client->describeDirectConnectGatewayAssociationProposalsAsync([/* ... */]);

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Parameter Syntax

$result = $client->describeDirectConnectGatewayAssociationProposals([
    'associatedGatewayId' => '<string>',
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'proposalId' => '<string>',
]);

Parameter Details

Members
associatedGatewayId
Type: string

The ID of the associated gateway.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

maxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

nextToken
Type: string

The token for the next page of results.

proposalId
Type: string

The ID of the proposal.

Result Syntax

[
    'directConnectGatewayAssociationProposals' => [
        [
            'associatedGateway' => [
                'id' => '<string>',
                'ownerAccount' => '<string>',
                'region' => '<string>',
                'type' => 'virtualPrivateGateway|transitGateway',
            ],
            'directConnectGatewayId' => '<string>',
            'directConnectGatewayOwnerAccount' => '<string>',
            'existingAllowedPrefixesToDirectConnectGateway' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
            'proposalId' => '<string>',
            'proposalState' => 'requested|accepted|deleted',
            'requestedAllowedPrefixesToDirectConnectGateway' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
directConnectGatewayAssociationProposals
Type: Array of DirectConnectGatewayAssociationProposal structures

Describes the Direct Connect gateway association proposals.

nextToken
Type: string

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGatewayAssociations

$result = $client->describeDirectConnectGatewayAssociations([/* ... */]);
$promise = $client->describeDirectConnectGatewayAssociationsAsync([/* ... */]);

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

  • A Direct Connect gateway

    The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.

  • A virtual private gateway

    The response contains the Direct Connect gateway.

  • A transit gateway

    The response contains the Direct Connect gateway.

  • A Direct Connect gateway and a virtual private gateway

    The response contains the association between the Direct Connect gateway and virtual private gateway.

  • A Direct Connect gateway and a transit gateway

    The response contains the association between the Direct Connect gateway and transit gateway.

Parameter Syntax

$result = $client->describeDirectConnectGatewayAssociations([
    'associatedGatewayId' => '<string>',
    'associationId' => '<string>',
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'virtualGatewayId' => '<string>',
]);

Parameter Details

Members
associatedGatewayId
Type: string

The ID of the associated gateway.

associationId
Type: string

The ID of the Direct Connect gateway association.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

maxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

nextToken
Type: string

The token provided in the previous call to retrieve the next page.

virtualGatewayId
Type: string

The ID of the virtual private gateway or transit gateway.

Result Syntax

[
    'directConnectGatewayAssociations' => [
        [
            'allowedPrefixesToDirectConnectGateway' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
            'associatedGateway' => [
                'id' => '<string>',
                'ownerAccount' => '<string>',
                'region' => '<string>',
                'type' => 'virtualPrivateGateway|transitGateway',
            ],
            'associationId' => '<string>',
            'associationState' => 'associating|associated|disassociating|disassociated|updating',
            'directConnectGatewayId' => '<string>',
            'directConnectGatewayOwnerAccount' => '<string>',
            'stateChangeError' => '<string>',
            'virtualGatewayId' => '<string>',
            'virtualGatewayOwnerAccount' => '<string>',
            'virtualGatewayRegion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
directConnectGatewayAssociations
Type: Array of DirectConnectGatewayAssociation structures

Information about the associations.

nextToken
Type: string

The token to retrieve the next page.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGatewayAttachments

$result = $client->describeDirectConnectGatewayAttachments([/* ... */]);
$promise = $client->describeDirectConnectGatewayAttachmentsAsync([/* ... */]);

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

Parameter Syntax

$result = $client->describeDirectConnectGatewayAttachments([
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Members
directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

maxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

nextToken
Type: string

The token provided in the previous call to retrieve the next page.

virtualInterfaceId
Type: string

The ID of the virtual interface.

Result Syntax

[
    'directConnectGatewayAttachments' => [
        [
            'attachmentState' => 'attaching|attached|detaching|detached',
            'attachmentType' => 'TransitVirtualInterface|PrivateVirtualInterface',
            'directConnectGatewayId' => '<string>',
            'stateChangeError' => '<string>',
            'virtualInterfaceId' => '<string>',
            'virtualInterfaceOwnerAccount' => '<string>',
            'virtualInterfaceRegion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
directConnectGatewayAttachments
Type: Array of DirectConnectGatewayAttachment structures

The attachments.

nextToken
Type: string

The token to retrieve the next page.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGateways

$result = $client->describeDirectConnectGateways([/* ... */]);
$promise = $client->describeDirectConnectGatewaysAsync([/* ... */]);

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

Parameter Syntax

$result = $client->describeDirectConnectGateways([
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

maxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

nextToken
Type: string

The token provided in the previous call to retrieve the next page.

Result Syntax

[
    'directConnectGateways' => [
        [
            'amazonSideAsn' => <integer>,
            'directConnectGatewayId' => '<string>',
            'directConnectGatewayName' => '<string>',
            'directConnectGatewayState' => 'pending|available|deleting|deleted',
            'ownerAccount' => '<string>',
            'stateChangeError' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
directConnectGateways
Type: Array of DirectConnectGateway structures

The Direct Connect gateways.

nextToken
Type: string

The token to retrieve the next page.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeHostedConnections

$result = $client->describeHostedConnections([/* ... */]);
$promise = $client->describeHostedConnectionsAsync([/* ... */]);

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by Direct Connect Partners only.

Parameter Syntax

$result = $client->describeHostedConnections([
    'connectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the interconnect or LAG.

Result Syntax

[
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
connections
Type: Array of Connection structures

The connections.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeInterconnectLoa

$result = $client->describeInterconnectLoa([/* ... */]);
$promise = $client->describeInterconnectLoaAsync([/* ... */]);

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Parameter Syntax

$result = $client->describeInterconnectLoa([
    'interconnectId' => '<string>', // REQUIRED
    'loaContentType' => 'application/pdf',
    'providerName' => '<string>',
]);

Parameter Details

Members
interconnectId
Required: Yes
Type: string

The ID of the interconnect.

loaContentType
Type: string

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

providerName
Type: string

The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

Result Syntax

[
    'loa' => [
        'loaContent' => <string || resource || Psr\Http\Message\StreamInterface>,
        'loaContentType' => 'application/pdf',
    ],
]

Result Details

Members
loa
Type: Loa structure

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeInterconnects

$result = $client->describeInterconnects([/* ... */]);
$promise = $client->describeInterconnectsAsync([/* ... */]);

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

Parameter Syntax

$result = $client->describeInterconnects([
    'interconnectId' => '<string>',
]);

Parameter Details

Members
interconnectId
Type: string

The ID of the interconnect.

Result Syntax

[
    'interconnects' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'interconnectId' => '<string>',
            'interconnectName' => '<string>',
            'interconnectState' => 'requested|pending|available|down|deleting|deleted|unknown',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
interconnects
Type: Array of Interconnect structures

The interconnects.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeLags

$result = $client->describeLags([/* ... */]);
$promise = $client->describeLagsAsync([/* ... */]);

Describes all your link aggregation groups (LAG) or the specified LAG.

Parameter Syntax

$result = $client->describeLags([
    'lagId' => '<string>',
]);

Parameter Details

Members
lagId
Type: string

The ID of the LAG.

Result Syntax

[
    'lags' => [
        [
            'allowsHostedConnections' => true || false,
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'connections' => [
                [
                    'awsDevice' => '<string>',
                    'awsDeviceV2' => '<string>',
                    'awsLogicalDeviceId' => '<string>',
                    'bandwidth' => '<string>',
                    'connectionId' => '<string>',
                    'connectionName' => '<string>',
                    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
                    'encryptionMode' => '<string>',
                    'hasLogicalRedundancy' => 'unknown|yes|no',
                    'jumboFrameCapable' => true || false,
                    'lagId' => '<string>',
                    'loaIssueTime' => <DateTime>,
                    'location' => '<string>',
                    'macSecCapable' => true || false,
                    'macSecKeys' => [
                        [
                            'ckn' => '<string>',
                            'secretARN' => '<string>',
                            'startOn' => '<string>',
                            'state' => '<string>',
                        ],
                        // ...
                    ],
                    'ownerAccount' => '<string>',
                    'partnerName' => '<string>',
                    'portEncryptionStatus' => '<string>',
                    'providerName' => '<string>',
                    'region' => '<string>',
                    'tags' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'vlan' => <integer>,
                ],
                // ...
            ],
            'connectionsBandwidth' => '<string>',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'lagName' => '<string>',
            'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'minimumLinks' => <integer>,
            'numberOfConnections' => <integer>,
            'ownerAccount' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
lags
Type: Array of Lag structures

The LAGs.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeLoa

$result = $client->describeLoa([/* ... */]);
$promise = $client->describeLoaAsync([/* ... */]);

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Parameter Syntax

$result = $client->describeLoa([
    'connectionId' => '<string>', // REQUIRED
    'loaContentType' => 'application/pdf',
    'providerName' => '<string>',
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of a connection, LAG, or interconnect.

loaContentType
Type: string

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

providerName
Type: string

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

Result Syntax

[
    'loaContent' => <string || resource || Psr\Http\Message\StreamInterface>,
    'loaContentType' => 'application/pdf',
]

Result Details

Members
loaContent
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The binary contents of the LOA-CFA document.

loaContentType
Type: string

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeLocations

$result = $client->describeLocations([/* ... */]);
$promise = $client->describeLocationsAsync([/* ... */]);

Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.

Parameter Syntax

$result = $client->describeLocations([
]);

Parameter Details

Members

Result Syntax

[
    'locations' => [
        [
            'availableMacSecPortSpeeds' => ['<string>', ...],
            'availablePortSpeeds' => ['<string>', ...],
            'availableProviders' => ['<string>', ...],
            'locationCode' => '<string>',
            'locationName' => '<string>',
            'region' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
locations
Type: Array of Location structures

The locations.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeRouterConfiguration

$result = $client->describeRouterConfiguration([/* ... */]);
$promise = $client->describeRouterConfigurationAsync([/* ... */]);

Details about the router.

Parameter Syntax

$result = $client->describeRouterConfiguration([
    'routerTypeIdentifier' => '<string>',
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
routerTypeIdentifier
Type: string

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface.

Result Syntax

[
    'customerRouterConfig' => '<string>',
    'router' => [
        'platform' => '<string>',
        'routerTypeIdentifier' => '<string>',
        'software' => '<string>',
        'vendor' => '<string>',
        'xsltTemplateName' => '<string>',
        'xsltTemplateNameForMacSec' => '<string>',
    ],
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
]

Result Details

Members
customerRouterConfig
Type: string

The customer router configuration.

router
Type: RouterType structure

The details about the router.

virtualInterfaceId
Type: string

The ID assigned to the virtual interface.

virtualInterfaceName
Type: string

Provides the details about a virtual interface's router.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeTags

$result = $client->describeTags([/* ... */]);
$promise = $client->describeTagsAsync([/* ... */]);

Describes the tags associated with the specified Direct Connect resources.

Parameter Syntax

$result = $client->describeTags([
    'resourceArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArns
Required: Yes
Type: Array of strings

The Amazon Resource Names (ARNs) of the resources.

Result Syntax

[
    'resourceTags' => [
        [
            'resourceArn' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
resourceTags
Type: Array of ResourceTag structures

Information about the tags.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeVirtualGateways

$result = $client->describeVirtualGateways([/* ... */]);
$promise = $client->describeVirtualGatewaysAsync([/* ... */]);

Deprecated. Use DescribeVpnGateways instead. See DescribeVPNGateways in the Amazon Elastic Compute Cloud API Reference.

Lists the virtual private gateways owned by the Amazon Web Services account.

You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.

Parameter Syntax

$result = $client->describeVirtualGateways([
]);

Parameter Details

Members

Result Syntax

[
    'virtualGateways' => [
        [
            'virtualGatewayId' => '<string>',
            'virtualGatewayState' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
virtualGateways
Type: Array of VirtualGateway structures

The virtual private gateways.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeVirtualInterfaces

$result = $client->describeVirtualInterfaces([/* ... */]);
$promise = $client->describeVirtualInterfacesAsync([/* ... */]);

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

Parameter Syntax

$result = $client->describeVirtualInterfaces([
    'connectionId' => '<string>',
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Members
connectionId
Type: string

The ID of the connection.

virtualInterfaceId
Type: string

The ID of the virtual interface.

Result Syntax

[
    'virtualInterfaces' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'amazonSideAsn' => <integer>,
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeers' => [
                [
                    'addressFamily' => 'ipv4|ipv6',
                    'amazonAddress' => '<string>',
                    'asn' => <integer>,
                    'authKey' => '<string>',
                    'awsDeviceV2' => '<string>',
                    'awsLogicalDeviceId' => '<string>',
                    'bgpPeerId' => '<string>',
                    'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                    'bgpStatus' => 'up|down|unknown',
                    'customerAddress' => '<string>',
                ],
                // ...
            ],
            'connectionId' => '<string>',
            'customerAddress' => '<string>',
            'customerRouterConfig' => '<string>',
            'directConnectGatewayId' => '<string>',
            'jumboFrameCapable' => true || false,
            'location' => '<string>',
            'mtu' => <integer>,
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'routeFilterPrefixes' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
            'siteLinkEnabled' => true || false,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'virtualGatewayId' => '<string>',
            'virtualInterfaceId' => '<string>',
            'virtualInterfaceName' => '<string>',
            'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
            'virtualInterfaceType' => '<string>',
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
virtualInterfaces
Type: Array of VirtualInterface structures

The virtual interfaces

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DisassociateConnectionFromLag

$result = $client->disassociateConnectionFromLag([/* ... */]);
$promise = $client->disassociateConnectionFromLagAsync([/* ... */]);

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

Parameter Syntax

$result = $client->disassociateConnectionFromLag([
    'connectionId' => '<string>', // REQUIRED
    'lagId' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the connection.

lagId
Required: Yes
Type: string

The ID of the LAG.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DisassociateMacSecKey

$result = $client->disassociateMacSecKey([/* ... */]);
$promise = $client->disassociateMacSecKeyAsync([/* ... */]);

Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.

Parameter Syntax

$result = $client->disassociateMacSecKey([
    'connectionId' => '<string>', // REQUIRED
    'secretARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

secretARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

Result Syntax

[
    'connectionId' => '<string>',
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
connectionId
Type: string

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

macSecKeys
Type: Array of MacSecKey structures

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

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ListVirtualInterfaceTestHistory

$result = $client->listVirtualInterfaceTestHistory([/* ... */]);
$promise = $client->listVirtualInterfaceTestHistoryAsync([/* ... */]);

Lists the virtual interface failover test history.

Parameter Syntax

$result = $client->listVirtualInterfaceTestHistory([
    'bgpPeers' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => '<string>',
    'testId' => '<string>',
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Members
bgpPeers
Type: Array of strings

The BGP peers that were placed in the DOWN state during the virtual interface failover test.

maxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

nextToken
Type: string

The token for the next page of results.

status
Type: string

The status of the virtual interface failover test.

testId
Type: string

The ID of the virtual interface failover test.

virtualInterfaceId
Type: string

The ID of the virtual interface that was tested.

Result Syntax

[
    'nextToken' => '<string>',
    'virtualInterfaceTestHistory' => [
        [
            'bgpPeers' => ['<string>', ...],
            'endTime' => <DateTime>,
            'ownerAccount' => '<string>',
            'startTime' => <DateTime>,
            'status' => '<string>',
            'testDurationInMinutes' => <integer>,
            'testId' => '<string>',
            'virtualInterfaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

virtualInterfaceTestHistory
Type: Array of VirtualInterfaceTestHistory structures

The ID of the tested virtual interface.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

StartBgpFailoverTest

$result = $client->startBgpFailoverTest([/* ... */]);
$promise = $client->startBgpFailoverTestAsync([/* ... */]);

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

Parameter Syntax

$result = $client->startBgpFailoverTest([
    'bgpPeers' => ['<string>', ...],
    'testDurationInMinutes' => <integer>,
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
bgpPeers
Type: Array of strings

The BGP peers to place in the DOWN state.

testDurationInMinutes
Type: int

The time in minutes that the virtual interface failover test will last.

Maximum value: 4,320 minutes (72 hours).

Default: 180 minutes (3 hours).

virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface you want to test.

Result Syntax

[
    'virtualInterfaceTest' => [
        'bgpPeers' => ['<string>', ...],
        'endTime' => <DateTime>,
        'ownerAccount' => '<string>',
        'startTime' => <DateTime>,
        'status' => '<string>',
        'testDurationInMinutes' => <integer>,
        'testId' => '<string>',
        'virtualInterfaceId' => '<string>',
    ],
]

Result Details

Members
virtualInterfaceTest
Type: VirtualInterfaceTestHistory structure

Information about the virtual interface failover test.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

StopBgpFailoverTest

$result = $client->stopBgpFailoverTest([/* ... */]);
$promise = $client->stopBgpFailoverTestAsync([/* ... */]);

Stops the virtual interface failover test.

Parameter Syntax

$result = $client->stopBgpFailoverTest([
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual interface you no longer want to test.

Result Syntax

[
    'virtualInterfaceTest' => [
        'bgpPeers' => ['<string>', ...],
        'endTime' => <DateTime>,
        'ownerAccount' => '<string>',
        'startTime' => <DateTime>,
        'status' => '<string>',
        'testDurationInMinutes' => <integer>,
        'testId' => '<string>',
        'virtualInterfaceId' => '<string>',
    ],
]

Result Details

Members
virtualInterfaceTest
Type: VirtualInterfaceTestHistory structure

Information about the virtual interface failover test.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tags
Required: Yes
Type: Array of Tag structures

The tags to add.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified Direct Connect resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
Required: Yes
Type: Array of strings

The tag keys of the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

UpdateConnection

$result = $client->updateConnection([/* ... */]);
$promise = $client->updateConnectionAsync([/* ... */]);

Updates the Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

  • The connection name

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

Parameter Syntax

$result = $client->updateConnection([
    'connectionId' => '<string>', // REQUIRED
    'connectionName' => '<string>',
    'encryptionMode' => '<string>',
]);

Parameter Details

Members
connectionId
Required: Yes
Type: string

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

connectionName
Type: string

The name of the connection.

encryptionMode
Type: string

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Members
awsDevice
Type: string

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bandwidth
Type: string

The bandwidth of the connection.

connectionId
Type: string

The ID of the connection.

connectionName
Type: string

The name of the connection.

connectionState
Type: string

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.

encryptionMode
Type: string

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

loaIssueTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

location
Type: string

The location of the connection.

macSecCapable
Type: boolean

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the connection.

partnerName
Type: string

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

portEncryptionStatus
Type: string

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.

providerName
Type: string

The name of the service provider associated with the connection.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the connection.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

UpdateDirectConnectGateway

$result = $client->updateDirectConnectGateway([/* ... */]);
$promise = $client->updateDirectConnectGatewayAsync([/* ... */]);

Updates the name of a current Direct Connect gateway.

Parameter Syntax

$result = $client->updateDirectConnectGateway([
    'directConnectGatewayId' => '<string>', // REQUIRED
    'newDirectConnectGatewayName' => '<string>', // REQUIRED
]);

Parameter Details

Members
directConnectGatewayId
Required: Yes
Type: string

The ID of the Direct Connect gateway to update.

newDirectConnectGatewayName
Required: Yes
Type: string

The new name for the Direct Connect gateway.

Result Syntax

[
    'directConnectGateway' => [
        'amazonSideAsn' => <integer>,
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayName' => '<string>',
        'directConnectGatewayState' => 'pending|available|deleting|deleted',
        'ownerAccount' => '<string>',
        'stateChangeError' => '<string>',
    ],
]

Result Details

Members
directConnectGateway
Type: DirectConnectGateway structure

Informaiton about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateways or transit gateways.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

UpdateDirectConnectGatewayAssociation

$result = $client->updateDirectConnectGatewayAssociation([/* ... */]);
$promise = $client->updateDirectConnectGatewayAssociationAsync([/* ... */]);

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

Parameter Syntax

$result = $client->updateDirectConnectGatewayAssociation([
    'addAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'associationId' => '<string>',
    'removeAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
addAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

associationId
Type: string

The ID of the Direct Connect gateway association.

removeAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Members
directConnectGatewayAssociation

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

UpdateLag

$result = $client->updateLag([/* ... */]);
$promise = $client->updateLagAsync([/* ... */]);

Updates the attributes of the specified link aggregation group (LAG).

You can update the following LAG attributes:

  • The name of the LAG.

  • The value for the minimum number of connections that must be operational for the LAG itself to be operational.

  • The LAG's MACsec encryption mode.

    Amazon Web Services assigns this value to each connection which is part of the LAG.

  • The tags

If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.

Parameter Syntax

$result = $client->updateLag([
    'encryptionMode' => '<string>',
    'lagId' => '<string>', // REQUIRED
    'lagName' => '<string>',
    'minimumLinks' => <integer>,
]);

Parameter Details

Members
encryptionMode
Type: string

The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

lagId
Required: Yes
Type: string

The ID of the LAG.

lagName
Type: string

The name of the LAG.

minimumLinks
Type: int

The minimum number of physical connections that must be operational for the LAG itself to be operational.

Result Syntax

[
    'allowsHostedConnections' => true || false,
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
    'connectionsBandwidth' => '<string>',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'lagName' => '<string>',
    'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'minimumLinks' => <integer>,
    'numberOfConnections' => <integer>,
    'ownerAccount' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
allowsHostedConnections
Type: boolean

Indicates whether the LAG can host other connections.

awsDevice
Type: string

The Direct Connect endpoint that hosts the LAG.

awsDeviceV2
Type: string

The Direct Connect endpoint that hosts the LAG.

awsLogicalDeviceId
Type: string

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

connections
Type: Array of Connection structures

The connections bundled by the LAG.

connectionsBandwidth
Type: string

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

encryptionMode
Type: string

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
Type: string

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

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

lagId
Type: string

The ID of the LAG.

lagName
Type: string

The name of the LAG.

lagState
Type: string

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

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

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

  • available: The network link is established and the LAG is ready for use.

  • down: The network link is down.

  • deleting: The LAG is being deleted.

  • deleted: The LAG is deleted.

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

location
Type: string

The location of the LAG.

macSecCapable
Type: boolean

Indicates whether the LAG supports MAC Security (MACsec).

macSecKeys
Type: Array of MacSecKey structures

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

minimumLinks
Type: int

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

numberOfConnections
Type: int

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the LAG.

providerName
Type: string

The name of the service provider associated with the LAG.

region
Type: string

The Amazon Web Services Region where the connection is located.

tags
Type: Array of Tag structures

The tags associated with the LAG.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

UpdateVirtualInterfaceAttributes

$result = $client->updateVirtualInterfaceAttributes([/* ... */]);
$promise = $client->updateVirtualInterfaceAttributesAsync([/* ... */]);

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Parameter Syntax

$result = $client->updateVirtualInterfaceAttributes([
    'enableSiteLink' => true || false,
    'mtu' => <integer>,
    'virtualInterfaceId' => '<string>', // REQUIRED
    'virtualInterfaceName' => '<string>',
]);

Parameter Details

Members
enableSiteLink
Type: boolean

Indicates whether to enable or disable SiteLink.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

virtualInterfaceId
Required: Yes
Type: string

The ID of the virtual private interface.

virtualInterfaceName
Type: string

The name of the virtual private interface.

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
Type: string

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

bgpPeers
Type: Array of BGPPeer structures

The BGP peers configured on this virtual interface.

connectionId
Type: string

The ID of the connection.

customerAddress
Type: string

The IP address assigned to the customer interface.

customerRouterConfig
Type: string

The customer router configuration.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

jumboFrameCapable
Type: boolean

Indicates whether jumbo frames are supported.

location
Type: string

The location of the connection.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

region
Type: string

The Amazon Web Services Region where the virtual interface is located.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

siteLinkEnabled
Type: boolean

Indicates whether SiteLink is enabled.

tags
Type: Array of Tag structures

The tags associated with the virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterfaceState
Type: string

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

virtualInterfaceType
Type: string

The type of virtual interface. The possible values are private, public and transit.

vlan
Type: int

The ID of the VLAN.

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

Shapes

AssociatedGateway

Description

Information about the associated gateway.

Members
id
Type: string

The ID of the associated gateway.

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

region
Type: string

The Region where the associated gateway is located.

type
Type: string

The type of associated gateway.

BGPPeer

Description

Information about a BGP peer.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

awsDeviceV2
Type: string

The Direct Connect endpoint that terminates the BGP peer.

awsLogicalDeviceId
Type: string

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

bgpPeerId
Type: string

The ID of the BGP peer.

bgpPeerState
Type: string

The state of the BGP peer. The following are the possible values:

  • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

  • pending: The BGP peer is created, and remains in this state until it is ready to be established.

  • available: The BGP peer is ready to be established.

  • deleting: The BGP peer is being deleted.

  • deleted: The BGP peer is deleted and cannot be established.

bgpStatus
Type: string

The status of the BGP peer. The following are the possible values:

  • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

  • down: The BGP peer is down.

  • unknown: The BGP peer status is not available.

customerAddress
Type: string

The IP address assigned to the customer interface.

CustomerAgreement

Description

The name and status of a customer agreement.

Members
agreementName
Type: string

The name of the agreement.

status
Type: string

The status of the customer agreement. This will be either signed or unsigned

DirectConnectClientException

Description

One or more parameters are not valid.

Members
message
Type: string

DirectConnectGateway

Description

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

Members
amazonSideAsn
Type: long (int|float)

The autonomous system number (ASN) for the Amazon side of the connection.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

directConnectGatewayName
Type: string

The name of the Direct Connect gateway.

directConnectGatewayState
Type: string

The state of the Direct Connect gateway. The following are the possible values:

  • pending: The initial state after calling CreateDirectConnectGateway.

  • available: The Direct Connect gateway is ready for use.

  • deleting: The initial state after calling DeleteDirectConnectGateway.

  • deleted: The Direct Connect gateway is deleted and cannot pass traffic.

ownerAccount
Type: string

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

stateChangeError
Type: string

The error message if the state of an object failed to advance.

DirectConnectGatewayAssociation

Description

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

Members
allowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

associatedGateway
Type: AssociatedGateway structure

Information about the associated gateway.

associationId
Type: string

The ID of the Direct Connect gateway association.

associationState
Type: string

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

  • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

  • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

  • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

  • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

  • updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

directConnectGatewayOwnerAccount
Type: string

The ID of the Amazon Web Services account that owns the associated gateway.

stateChangeError
Type: string

The error message if the state of an object failed to advance.

virtualGatewayId
Type: string

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualGatewayOwnerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual private gateway.

virtualGatewayRegion
Type: string

The Amazon Web Services Region where the virtual private gateway is located.

DirectConnectGatewayAssociationProposal

Description

Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

Members
associatedGateway
Type: AssociatedGateway structure

Information about the associated gateway.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

directConnectGatewayOwnerAccount
Type: string

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

existingAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

proposalId
Type: string

The ID of the association proposal.

proposalState
Type: string

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

  • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

  • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

  • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

requestedAllowedPrefixesToDirectConnectGateway
Type: Array of RouteFilterPrefix structures

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

DirectConnectGatewayAttachment

Description

Information about an attachment between a Direct Connect gateway and a virtual interface.

Members
attachmentState
Type: string

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

  • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

  • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

  • detaching: The initial state after calling DeleteVirtualInterface.

  • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

attachmentType
Type: string

The type of attachment.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

stateChangeError
Type: string

The error message if the state of an object failed to advance.

virtualInterfaceId
Type: string

The ID of the virtual interface.

virtualInterfaceOwnerAccount
Type: string

The ID of the Amazon Web Services account that owns the virtual interface.

virtualInterfaceRegion
Type: string

The Amazon Web Services Region where the virtual interface is located.

DirectConnectServerException

Description

A server-side error occurred.

Members
message
Type: string

DuplicateTagKeysException

Description

A tag key was specified more than once.

Members

Location

Description

Information about an Direct Connect location.

Members
availableMacSecPortSpeeds
Type: Array of strings

The available MAC Security (MACsec) port speeds for the location.

availablePortSpeeds
Type: Array of strings

The available port speeds for the location.

availableProviders
Type: Array of strings

The name of the service provider for the location.

locationCode
Type: string

The code for the location.

locationName
Type: string

The name of the location. This includes the name of the colocation partner and the physical site of the building.

region
Type: string

The Amazon Web Services Region for the location.

MacSecKey

Description

Information about the MAC Security (MACsec) secret key.

Members
ckn
Type: string

The Connection Key Name (CKN) for the MAC Security secret key.

secretARN
Type: string

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

startOn
Type: string

The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

state
Type: string

The state of the MAC Security (MACsec) secret key.

The possible values are:

  • associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.

  • associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.

  • disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG

  • disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.

NewBGPPeer

Description

Information about a new BGP peer.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

NewPrivateVirtualInterface

Description

Information about a private virtual interface.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Required: Yes
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

enableSiteLink
Type: boolean

Indicates whether to enable or disable SiteLink.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

tags
Type: Array of Tag structures

The tags associated with the private virtual interface.

virtualGatewayId
Type: string

The ID of the virtual private gateway.

virtualInterfaceName
Required: Yes
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

vlan
Required: Yes
Type: int

The ID of the VLAN.

NewPrivateVirtualInterfaceAllocation

Description

Information about a private virtual interface to be provisioned on a connection.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Required: Yes
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

tags
Type: Array of Tag structures

The tags associated with the private virtual interface.

virtualInterfaceName
Required: Yes
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

vlan
Required: Yes
Type: int

The ID of the VLAN.

NewPublicVirtualInterface

Description

Information about a public virtual interface.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Required: Yes
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

tags
Type: Array of Tag structures

The tags associated with the public virtual interface.

virtualInterfaceName
Required: Yes
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

vlan
Required: Yes
Type: int

The ID of the VLAN.

NewPublicVirtualInterfaceAllocation

Description

Information about a public virtual interface to be provisioned on a connection.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Required: Yes
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

routeFilterPrefixes
Type: Array of RouteFilterPrefix structures

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

tags
Type: Array of Tag structures

The tags associated with the public virtual interface.

virtualInterfaceName
Required: Yes
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

vlan
Required: Yes
Type: int

The ID of the VLAN.

NewTransitVirtualInterface

Description

Information about a transit virtual interface.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

directConnectGatewayId
Type: string

The ID of the Direct Connect gateway.

enableSiteLink
Type: boolean

Indicates whether to enable or disable SiteLink.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

tags
Type: Array of Tag structures

The tags associated with the transitive virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

vlan
Type: int

The ID of the VLAN.

NewTransitVirtualInterfaceAllocation

Description

Information about a transit virtual interface to be provisioned on a connection.

Members
addressFamily
Type: string

The address family for the BGP peer.

amazonAddress
Type: string

The IP address assigned to the Amazon interface.

asn
Type: int

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

authKey
Type: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress
Type: string

The IP address assigned to the customer interface.

mtu
Type: int

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

tags
Type: Array of Tag structures

The tags associated with the transitive virtual interface.

virtualInterfaceName
Type: string

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

vlan
Type: int

The ID of the VLAN.

ResourceTag

Description

Information about a tag associated with an Direct Connect resource.

Members
resourceArn
Type: string

The Amazon Resource Name (ARN) of the resource.

tags
Type: Array of Tag structures

The tags.

RouteFilterPrefix

Description

Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

Members
cidr
Type: string

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

RouterType

Description

Information about the virtual router.

Members
platform
Type: string

The virtual interface router platform.

routerTypeIdentifier
Type: string

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

software
Type: string

The router software.

vendor
Type: string

The vendor for the virtual interface's router.

xsltTemplateName
Type: string

The template for the virtual interface's router.

xsltTemplateNameForMacSec
Type: string

The MAC Security (MACsec) template for the virtual interface's router.

Tag

Description

Information about a tag.

Members
key
Required: Yes
Type: string

The key.

value
Type: string

The value.

TooManyTagsException

Description

You have reached the limit on the number of tags that can be assigned.

Members

VirtualGateway

Description

Information about a virtual private gateway for a private virtual interface.

Members
virtualGatewayId
Type: string

The ID of the virtual private gateway.

virtualGatewayState
Type: string

The state of the virtual private gateway. The following are the possible values:

  • pending: Initial state after creating the virtual private gateway.

  • available: Ready for use by a private virtual interface.

  • deleting: Initial state after deleting the virtual private gateway.

  • deleted: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.

VirtualInterfaceTestHistory

Description

Information about the virtual interface failover test.

Members
bgpPeers
Type: Array of strings

The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the virtual interface moves out of the DOWN state.

ownerAccount
Type: string

The owner ID of the tested virtual interface.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the virtual interface moves to the DOWN state.

status
Type: string

The status of the virtual interface failover test.

testDurationInMinutes
Type: int

The time that the virtual interface failover test ran in minutes.

testId
Type: string

The ID of the virtual interface failover test.

virtualInterfaceId
Type: string

The ID of the tested virtual interface.