@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDirectConnectClient extends AmazonWebServiceClient implements AmazonDirectConnect
Direct Connect 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. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonDirectConnectClient()
Deprecated.
|
AmazonDirectConnectClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonDirectConnectClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonDirectConnectClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonDirectConnectClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AcceptDirectConnectGatewayAssociationProposalResult |
acceptDirectConnectGatewayAssociationProposal(AcceptDirectConnectGatewayAssociationProposalRequest request)
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
|
AllocateConnectionOnInterconnectResult |
allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest request)
Deprecated.
|
AllocateHostedConnectionResult |
allocateHostedConnection(AllocateHostedConnectionRequest request)
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
|
AllocatePrivateVirtualInterfaceResult |
allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest request)
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
|
AllocatePublicVirtualInterfaceResult |
allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest request)
Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
|
AllocateTransitVirtualInterfaceResult |
allocateTransitVirtualInterface(AllocateTransitVirtualInterfaceRequest request)
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
|
AssociateConnectionWithLagResult |
associateConnectionWithLag(AssociateConnectionWithLagRequest request)
Associates an existing connection with a link aggregation group (LAG).
|
AssociateHostedConnectionResult |
associateHostedConnection(AssociateHostedConnectionRequest request)
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
|
AssociateMacSecKeyResult |
associateMacSecKey(AssociateMacSecKeyRequest request)
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an
Direct Connect dedicated connection.
|
AssociateVirtualInterfaceResult |
associateVirtualInterface(AssociateVirtualInterfaceRequest request)
Associates a virtual interface with a specified link aggregation group (LAG) or connection.
|
static AmazonDirectConnectClientBuilder |
builder() |
ConfirmConnectionResult |
confirmConnection(ConfirmConnectionRequest request)
Confirms the creation of the specified hosted connection on an interconnect.
|
ConfirmCustomerAgreementResult |
confirmCustomerAgreement(ConfirmCustomerAgreementRequest request)
The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
|
ConfirmPrivateVirtualInterfaceResult |
confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest request)
Accepts ownership of a private virtual interface created by another Amazon Web Services account.
|
ConfirmPublicVirtualInterfaceResult |
confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest request)
Accepts ownership of a public virtual interface created by another Amazon Web Services account.
|
ConfirmTransitVirtualInterfaceResult |
confirmTransitVirtualInterface(ConfirmTransitVirtualInterfaceRequest request)
Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
|
CreateBGPPeerResult |
createBGPPeer(CreateBGPPeerRequest request)
Creates a BGP peer on the specified virtual interface.
|
CreateConnectionResult |
createConnection(CreateConnectionRequest request)
Creates a connection between a customer network and a specific Direct Connect location.
|
CreateDirectConnectGatewayResult |
createDirectConnectGateway(CreateDirectConnectGatewayRequest request)
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual
interfaces and virtual private gateways.
|
CreateDirectConnectGatewayAssociationResult |
createDirectConnectGatewayAssociation(CreateDirectConnectGatewayAssociationRequest request)
Creates an association between a Direct Connect gateway and a virtual private gateway.
|
CreateDirectConnectGatewayAssociationProposalResult |
createDirectConnectGatewayAssociationProposal(CreateDirectConnectGatewayAssociationProposalRequest request)
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified
Direct Connect gateway.
|
CreateInterconnectResult |
createInterconnect(CreateInterconnectRequest request)
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
|
CreateLagResult |
createLag(CreateLagRequest request)
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.
|
CreatePrivateVirtualInterfaceResult |
createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest request)
Creates a private virtual interface.
|
CreatePublicVirtualInterfaceResult |
createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest request)
Creates a public virtual interface.
|
CreateTransitVirtualInterfaceResult |
createTransitVirtualInterface(CreateTransitVirtualInterfaceRequest request)
Creates a transit virtual interface.
|
DeleteBGPPeerResult |
deleteBGPPeer(DeleteBGPPeerRequest request)
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
|
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest request)
Deletes the specified connection.
|
DeleteDirectConnectGatewayResult |
deleteDirectConnectGateway(DeleteDirectConnectGatewayRequest request)
Deletes the specified Direct Connect gateway.
|
DeleteDirectConnectGatewayAssociationResult |
deleteDirectConnectGatewayAssociation(DeleteDirectConnectGatewayAssociationRequest request)
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
|
DeleteDirectConnectGatewayAssociationProposalResult |
deleteDirectConnectGatewayAssociationProposal(DeleteDirectConnectGatewayAssociationProposalRequest request)
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway
or transit gateway.
|
DeleteInterconnectResult |
deleteInterconnect(DeleteInterconnectRequest request)
Deletes the specified interconnect.
|
DeleteLagResult |
deleteLag(DeleteLagRequest request)
Deletes the specified link aggregation group (LAG).
|
DeleteVirtualInterfaceResult |
deleteVirtualInterface(DeleteVirtualInterfaceRequest request)
Deletes a virtual interface.
|
DescribeConnectionLoaResult |
describeConnectionLoa(DescribeConnectionLoaRequest request)
Deprecated.
|
DescribeConnectionsResult |
describeConnections()
Simplified method form for invoking the DescribeConnections operation.
|
DescribeConnectionsResult |
describeConnections(DescribeConnectionsRequest request)
Displays the specified connection or all connections in this Region.
|
DescribeConnectionsOnInterconnectResult |
describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest request)
Deprecated.
|
DescribeCustomerMetadataResult |
describeCustomerMetadata(DescribeCustomerMetadataRequest request)
Get and view a list of customer agreements, along with their signed status and whether the customer is an
NNIPartner, NNIPartnerV2, or a nonPartner.
|
DescribeDirectConnectGatewayAssociationProposalsResult |
describeDirectConnectGatewayAssociationProposals(DescribeDirectConnectGatewayAssociationProposalsRequest request)
Describes one or more association proposals for connection between a virtual private gateway or transit gateway
and a Direct Connect gateway.
|
DescribeDirectConnectGatewayAssociationsResult |
describeDirectConnectGatewayAssociations(DescribeDirectConnectGatewayAssociationsRequest request)
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways.
|
DescribeDirectConnectGatewayAttachmentsResult |
describeDirectConnectGatewayAttachments(DescribeDirectConnectGatewayAttachmentsRequest request)
Lists the attachments between your Direct Connect gateways and virtual interfaces.
|
DescribeDirectConnectGatewaysResult |
describeDirectConnectGateways(DescribeDirectConnectGatewaysRequest request)
Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
|
DescribeHostedConnectionsResult |
describeHostedConnections(DescribeHostedConnectionsRequest request)
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group
(LAG).
|
DescribeInterconnectLoaResult |
describeInterconnectLoa(DescribeInterconnectLoaRequest request)
Deprecated.
|
DescribeInterconnectsResult |
describeInterconnects()
Simplified method form for invoking the DescribeInterconnects operation.
|
DescribeInterconnectsResult |
describeInterconnects(DescribeInterconnectsRequest request)
Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
|
DescribeLagsResult |
describeLags(DescribeLagsRequest request)
Describes all your link aggregation groups (LAG) or the specified LAG.
|
DescribeLoaResult |
describeLoa(DescribeLoaRequest request)
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
|
DescribeLocationsResult |
describeLocations()
Simplified method form for invoking the DescribeLocations operation.
|
DescribeLocationsResult |
describeLocations(DescribeLocationsRequest request)
Lists the Direct Connect locations in the current Amazon Web Services Region.
|
DescribeRouterConfigurationResult |
describeRouterConfiguration(DescribeRouterConfigurationRequest request)
Details about the router.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the tags associated with the specified Direct Connect resources.
|
DescribeVirtualGatewaysResult |
describeVirtualGateways()
Simplified method form for invoking the DescribeVirtualGateways operation.
|
DescribeVirtualGatewaysResult |
describeVirtualGateways(DescribeVirtualGatewaysRequest request)
|
DescribeVirtualInterfacesResult |
describeVirtualInterfaces()
Simplified method form for invoking the DescribeVirtualInterfaces operation.
|
DescribeVirtualInterfacesResult |
describeVirtualInterfaces(DescribeVirtualInterfacesRequest request)
Displays all virtual interfaces for an Amazon Web Services account.
|
DisassociateConnectionFromLagResult |
disassociateConnectionFromLag(DisassociateConnectionFromLagRequest request)
Disassociates a connection from a link aggregation group (LAG).
|
DisassociateMacSecKeyResult |
disassociateMacSecKey(DisassociateMacSecKeyRequest request)
Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ListVirtualInterfaceTestHistoryResult |
listVirtualInterfaceTestHistory(ListVirtualInterfaceTestHistoryRequest request)
Lists the virtual interface failover test history.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartBgpFailoverTestResult |
startBgpFailoverTest(StartBgpFailoverTestRequest request)
Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by
placing the BGP peering session in the DOWN state.
|
StopBgpFailoverTestResult |
stopBgpFailoverTest(StopBgpFailoverTestRequest request)
Stops the virtual interface failover test.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified Direct Connect resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified Direct Connect resource.
|
UpdateConnectionResult |
updateConnection(UpdateConnectionRequest request)
Updates the Direct Connect dedicated connection configuration.
|
UpdateDirectConnectGatewayResult |
updateDirectConnectGateway(UpdateDirectConnectGatewayRequest request)
Updates the name of a current Direct Connect gateway.
|
UpdateDirectConnectGatewayAssociationResult |
updateDirectConnectGatewayAssociation(UpdateDirectConnectGatewayAssociationRequest request)
Updates the specified attributes of the Direct Connect gateway association.
|
UpdateLagResult |
updateLag(UpdateLagRequest request)
Updates the attributes of the specified link aggregation group (LAG).
|
UpdateVirtualInterfaceAttributesResult |
updateVirtualInterfaceAttributes(UpdateVirtualInterfaceAttributesRequest request)
Updates the specified attributes of the specified virtual private interface.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonDirectConnectClient()
AmazonDirectConnectClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonDirectConnectClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to AWS Direct Connect (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonDirectConnectClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonDirectConnectClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonDirectConnectClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Direct Connect (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Direct Connect (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS Direct Connect (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonDirectConnectClientBuilder builder()
public AcceptDirectConnectGatewayAssociationProposalResult acceptDirectConnectGatewayAssociationProposal(AcceptDirectConnectGatewayAssociationProposalRequest request)
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
acceptDirectConnectGatewayAssociationProposal
in interface AmazonDirectConnect
acceptDirectConnectGatewayAssociationProposalRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.@Deprecated public AllocateConnectionOnInterconnectResult allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest request)
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.
allocateConnectionOnInterconnect
in interface AmazonDirectConnect
allocateConnectionOnInterconnectRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public AllocateHostedConnectionResult allocateHostedConnection(AllocateHostedConnectionRequest request)
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.
allocateHostedConnection
in interface AmazonDirectConnect
allocateHostedConnectionRequest
- 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.public AllocatePrivateVirtualInterfaceResult allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest request)
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.
allocatePrivateVirtualInterface
in interface AmazonDirectConnect
allocatePrivateVirtualInterfaceRequest
- 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.public AllocatePublicVirtualInterfaceResult allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest request)
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.
allocatePublicVirtualInterface
in interface AmazonDirectConnect
allocatePublicVirtualInterfaceRequest
- 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.public AllocateTransitVirtualInterfaceResult allocateTransitVirtualInterface(AllocateTransitVirtualInterfaceRequest request)
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.
allocateTransitVirtualInterface
in interface AmazonDirectConnect
allocateTransitVirtualInterfaceRequest
- 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.public AssociateConnectionWithLagResult associateConnectionWithLag(AssociateConnectionWithLagRequest request)
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.
associateConnectionWithLag
in interface AmazonDirectConnect
associateConnectionWithLagRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public AssociateHostedConnectionResult associateHostedConnection(AssociateHostedConnectionRequest request)
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.
associateHostedConnection
in interface AmazonDirectConnect
associateHostedConnectionRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public AssociateMacSecKeyResult associateMacSecKey(AssociateMacSecKeyRequest request)
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.
associateMacSecKey
in interface AmazonDirectConnect
associateMacSecKeyRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public AssociateVirtualInterfaceResult associateVirtualInterface(AssociateVirtualInterfaceRequest request)
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.
associateVirtualInterface
in interface AmazonDirectConnect
associateVirtualInterfaceRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ConfirmConnectionResult confirmConnection(ConfirmConnectionRequest request)
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.
confirmConnection
in interface AmazonDirectConnect
confirmConnectionRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ConfirmCustomerAgreementResult confirmCustomerAgreement(ConfirmCustomerAgreementRequest request)
The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
confirmCustomerAgreement
in interface AmazonDirectConnect
confirmCustomerAgreementRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ConfirmPrivateVirtualInterfaceResult confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest request)
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.
confirmPrivateVirtualInterface
in interface AmazonDirectConnect
confirmPrivateVirtualInterfaceRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ConfirmPublicVirtualInterfaceResult confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest request)
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.
confirmPublicVirtualInterface
in interface AmazonDirectConnect
confirmPublicVirtualInterfaceRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ConfirmTransitVirtualInterfaceResult confirmTransitVirtualInterface(ConfirmTransitVirtualInterfaceRequest request)
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.
confirmTransitVirtualInterface
in interface AmazonDirectConnect
confirmTransitVirtualInterfaceRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public CreateBGPPeerResult createBGPPeer(CreateBGPPeerRequest request)
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.
createBGPPeer
in interface AmazonDirectConnect
createBGPPeerRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public CreateConnectionResult createConnection(CreateConnectionRequest request)
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.
createConnection
in interface AmazonDirectConnect
createConnectionRequest
- 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.public CreateDirectConnectGatewayResult createDirectConnectGateway(CreateDirectConnectGatewayRequest request)
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.
createDirectConnectGateway
in interface AmazonDirectConnect
createDirectConnectGatewayRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public CreateDirectConnectGatewayAssociationResult createDirectConnectGatewayAssociation(CreateDirectConnectGatewayAssociationRequest request)
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.
createDirectConnectGatewayAssociation
in interface AmazonDirectConnect
createDirectConnectGatewayAssociationRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public CreateDirectConnectGatewayAssociationProposalResult createDirectConnectGatewayAssociationProposal(CreateDirectConnectGatewayAssociationProposalRequest request)
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.
createDirectConnectGatewayAssociationProposal
in interface AmazonDirectConnect
createDirectConnectGatewayAssociationProposalRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public CreateInterconnectResult createInterconnect(CreateInterconnectRequest request)
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.
createInterconnect
in interface AmazonDirectConnect
createInterconnectRequest
- 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.public CreateLagResult createLag(CreateLagRequest request)
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.
createLag
in interface AmazonDirectConnect
createLagRequest
- 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.public CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest request)
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.
createPrivateVirtualInterface
in interface AmazonDirectConnect
createPrivateVirtualInterfaceRequest
- 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.public CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest request)
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.
createPublicVirtualInterface
in interface AmazonDirectConnect
createPublicVirtualInterfaceRequest
- 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.public CreateTransitVirtualInterfaceResult createTransitVirtualInterface(CreateTransitVirtualInterfaceRequest request)
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.
createTransitVirtualInterface
in interface AmazonDirectConnect
createTransitVirtualInterfaceRequest
- 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.public DeleteBGPPeerResult deleteBGPPeer(DeleteBGPPeerRequest request)
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.
deleteBGPPeer
in interface AmazonDirectConnect
deleteBGPPeerRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
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.
deleteConnection
in interface AmazonDirectConnect
deleteConnectionRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteDirectConnectGatewayResult deleteDirectConnectGateway(DeleteDirectConnectGatewayRequest request)
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.
deleteDirectConnectGateway
in interface AmazonDirectConnect
deleteDirectConnectGatewayRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteDirectConnectGatewayAssociationResult deleteDirectConnectGatewayAssociation(DeleteDirectConnectGatewayAssociationRequest request)
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.
deleteDirectConnectGatewayAssociation
in interface AmazonDirectConnect
deleteDirectConnectGatewayAssociationRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteDirectConnectGatewayAssociationProposalResult deleteDirectConnectGatewayAssociationProposal(DeleteDirectConnectGatewayAssociationProposalRequest request)
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
deleteDirectConnectGatewayAssociationProposal
in interface AmazonDirectConnect
deleteDirectConnectGatewayAssociationProposalRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteInterconnectResult deleteInterconnect(DeleteInterconnectRequest request)
Deletes the specified interconnect.
Intended for use by Direct Connect Partners only.
deleteInterconnect
in interface AmazonDirectConnect
deleteInterconnectRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteLagResult deleteLag(DeleteLagRequest request)
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
deleteLag
in interface AmazonDirectConnect
deleteLagRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest request)
Deletes a virtual interface.
deleteVirtualInterface
in interface AmazonDirectConnect
deleteVirtualInterfaceRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.@Deprecated public DescribeConnectionLoaResult describeConnectionLoa(DescribeConnectionLoaRequest request)
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.
describeConnectionLoa
in interface AmazonDirectConnect
describeConnectionLoaRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
Displays the specified connection or all connections in this Region.
describeConnections
in interface AmazonDirectConnect
describeConnectionsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeConnectionsResult describeConnections()
AmazonDirectConnect
describeConnections
in interface AmazonDirectConnect
AmazonDirectConnect.describeConnections(DescribeConnectionsRequest)
@Deprecated public DescribeConnectionsOnInterconnectResult describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest request)
Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
Intended for use by Direct Connect Partners only.
describeConnectionsOnInterconnect
in interface AmazonDirectConnect
describeConnectionsOnInterconnectRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeCustomerMetadataResult describeCustomerMetadata(DescribeCustomerMetadataRequest request)
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
describeCustomerMetadata
in interface AmazonDirectConnect
describeCustomerMetadataRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeDirectConnectGatewayAssociationProposalsResult describeDirectConnectGatewayAssociationProposals(DescribeDirectConnectGatewayAssociationProposalsRequest request)
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
describeDirectConnectGatewayAssociationProposals
in interface AmazonDirectConnect
describeDirectConnectGatewayAssociationProposalsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeDirectConnectGatewayAssociationsResult describeDirectConnectGatewayAssociations(DescribeDirectConnectGatewayAssociationsRequest request)
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.
describeDirectConnectGatewayAssociations
in interface AmazonDirectConnect
describeDirectConnectGatewayAssociationsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeDirectConnectGatewayAttachmentsResult describeDirectConnectGatewayAttachments(DescribeDirectConnectGatewayAttachmentsRequest request)
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.
describeDirectConnectGatewayAttachments
in interface AmazonDirectConnect
describeDirectConnectGatewayAttachmentsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeDirectConnectGatewaysResult describeDirectConnectGateways(DescribeDirectConnectGatewaysRequest request)
Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
describeDirectConnectGateways
in interface AmazonDirectConnect
describeDirectConnectGatewaysRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeHostedConnectionsResult describeHostedConnections(DescribeHostedConnectionsRequest request)
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.
describeHostedConnections
in interface AmazonDirectConnect
describeHostedConnectionsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.@Deprecated public DescribeInterconnectLoaResult describeInterconnectLoa(DescribeInterconnectLoaRequest request)
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.
describeInterconnectLoa
in interface AmazonDirectConnect
describeInterconnectLoaRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeInterconnectsResult describeInterconnects(DescribeInterconnectsRequest request)
Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
describeInterconnects
in interface AmazonDirectConnect
describeInterconnectsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeInterconnectsResult describeInterconnects()
AmazonDirectConnect
describeInterconnects
in interface AmazonDirectConnect
AmazonDirectConnect.describeInterconnects(DescribeInterconnectsRequest)
public DescribeLagsResult describeLags(DescribeLagsRequest request)
Describes all your link aggregation groups (LAG) or the specified LAG.
describeLags
in interface AmazonDirectConnect
describeLagsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeLoaResult describeLoa(DescribeLoaRequest request)
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.
describeLoa
in interface AmazonDirectConnect
describeLoaRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeLocationsResult describeLocations(DescribeLocationsRequest request)
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.
describeLocations
in interface AmazonDirectConnect
describeLocationsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeLocationsResult describeLocations()
AmazonDirectConnect
describeLocations
in interface AmazonDirectConnect
AmazonDirectConnect.describeLocations(DescribeLocationsRequest)
public DescribeRouterConfigurationResult describeRouterConfiguration(DescribeRouterConfigurationRequest request)
Details about the router.
describeRouterConfiguration
in interface AmazonDirectConnect
describeRouterConfigurationRequest
- Provides the details about a virtual interface's router.DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeTagsResult describeTags(DescribeTagsRequest request)
Describes the tags associated with the specified Direct Connect resources.
describeTags
in interface AmazonDirectConnect
describeTagsRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest request)
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.
describeVirtualGateways
in interface AmazonDirectConnect
describeVirtualGatewaysRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeVirtualGatewaysResult describeVirtualGateways()
AmazonDirectConnect
describeVirtualGateways
in interface AmazonDirectConnect
AmazonDirectConnect.describeVirtualGateways(DescribeVirtualGatewaysRequest)
public DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest request)
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.
describeVirtualInterfaces
in interface AmazonDirectConnect
describeVirtualInterfacesRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DescribeVirtualInterfacesResult describeVirtualInterfaces()
AmazonDirectConnect
describeVirtualInterfaces
in interface AmazonDirectConnect
AmazonDirectConnect.describeVirtualInterfaces(DescribeVirtualInterfacesRequest)
public DisassociateConnectionFromLagResult disassociateConnectionFromLag(DisassociateConnectionFromLagRequest request)
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.
disassociateConnectionFromLag
in interface AmazonDirectConnect
disassociateConnectionFromLagRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public DisassociateMacSecKeyResult disassociateMacSecKey(DisassociateMacSecKeyRequest request)
Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
disassociateMacSecKey
in interface AmazonDirectConnect
disassociateMacSecKeyRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ListVirtualInterfaceTestHistoryResult listVirtualInterfaceTestHistory(ListVirtualInterfaceTestHistoryRequest request)
Lists the virtual interface failover test history.
listVirtualInterfaceTestHistory
in interface AmazonDirectConnect
listVirtualInterfaceTestHistoryRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public StartBgpFailoverTestResult startBgpFailoverTest(StartBgpFailoverTestRequest request)
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.
startBgpFailoverTest
in interface AmazonDirectConnect
startBgpFailoverTestRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public StopBgpFailoverTestResult stopBgpFailoverTest(StopBgpFailoverTestRequest request)
Stops the virtual interface failover test.
stopBgpFailoverTest
in interface AmazonDirectConnect
stopBgpFailoverTestRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonDirectConnect
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified Direct Connect resource.
untagResource
in interface AmazonDirectConnect
untagResourceRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public UpdateConnectionResult updateConnection(UpdateConnectionRequest request)
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.
updateConnection
in interface AmazonDirectConnect
updateConnectionRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public UpdateDirectConnectGatewayResult updateDirectConnectGateway(UpdateDirectConnectGatewayRequest request)
Updates the name of a current Direct Connect gateway.
updateDirectConnectGateway
in interface AmazonDirectConnect
updateDirectConnectGatewayRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public UpdateDirectConnectGatewayAssociationResult updateDirectConnectGatewayAssociation(UpdateDirectConnectGatewayAssociationRequest request)
Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
updateDirectConnectGatewayAssociation
in interface AmazonDirectConnect
updateDirectConnectGatewayAssociationRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public UpdateLagResult updateLag(UpdateLagRequest request)
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.
updateLag
in interface AmazonDirectConnect
updateLagRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public UpdateVirtualInterfaceAttributesResult updateVirtualInterfaceAttributes(UpdateVirtualInterfaceAttributesRequest request)
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.
updateVirtualInterfaceAttributes
in interface AmazonDirectConnect
updateVirtualInterfaceAttributesRequest
- DirectConnectServerException
- A server-side error occurred.DirectConnectClientException
- One or more parameters are not valid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonDirectConnect
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonDirectConnect
shutdown
in class AmazonWebServiceClient