com.amazonaws.services.directconnect.AmazonDirectConnect Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.directconnect;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.directconnect.model.*;
/**
* Interface for accessing AWS Direct Connect.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.directconnect.AbstractAmazonDirectConnect} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDirectConnect {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "directconnect";
/**
* Overrides the default endpoint for this client ("https://directconnect.us-east-1.amazonaws.com/"). Callers can
* use this method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "directconnect.us-east-1.amazonaws.com/") or a full URL, including the
* protocol (ex: "https://directconnect.us-east-1.amazonaws.com/"). If the protocol is not specified here, the
* default protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "directconnect.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex:
* "https://directconnect.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will
* communicate with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonDirectConnect#setEndpoint(String)}, sets the regional endpoint for this client's
* service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
*
*
* @param acceptDirectConnectGatewayAssociationProposalRequest
* @return Result of the AcceptDirectConnectGatewayAssociationProposal operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AcceptDirectConnectGatewayAssociationProposal
* @see AWS API Documentation
*/
AcceptDirectConnectGatewayAssociationProposalResult acceptDirectConnectGatewayAssociationProposal(
AcceptDirectConnectGatewayAssociationProposalRequest acceptDirectConnectGatewayAssociationProposalRequest);
/**
*
*
* 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.
*
*
*
* @param allocateConnectionOnInterconnectRequest
* @return Result of the AllocateConnectionOnInterconnect operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AllocateConnectionOnInterconnect
* @see AWS API Documentation
*/
@Deprecated
AllocateConnectionOnInterconnectResult allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest allocateConnectionOnInterconnectRequest);
/**
*
* 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.
*
*
*
* @param allocateHostedConnectionRequest
* @return Result of the AllocateHostedConnection operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AllocateHostedConnection
* @see AWS API Documentation
*/
AllocateHostedConnectionResult allocateHostedConnection(AllocateHostedConnectionRequest allocateHostedConnectionRequest);
/**
*
* 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.
*
*
* @param allocatePrivateVirtualInterfaceRequest
* @return Result of the AllocatePrivateVirtualInterface operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AllocatePrivateVirtualInterface
* @see AWS API Documentation
*/
AllocatePrivateVirtualInterfaceResult allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest allocatePrivateVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param allocatePublicVirtualInterfaceRequest
* @return Result of the AllocatePublicVirtualInterface operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AllocatePublicVirtualInterface
* @see AWS API Documentation
*/
AllocatePublicVirtualInterfaceResult allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest allocatePublicVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param allocateTransitVirtualInterfaceRequest
* @return Result of the AllocateTransitVirtualInterface operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AllocateTransitVirtualInterface
* @see AWS API Documentation
*/
AllocateTransitVirtualInterfaceResult allocateTransitVirtualInterface(AllocateTransitVirtualInterfaceRequest allocateTransitVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param associateConnectionWithLagRequest
* @return Result of the AssociateConnectionWithLag operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AssociateConnectionWithLag
* @see AWS API Documentation
*/
AssociateConnectionWithLagResult associateConnectionWithLag(AssociateConnectionWithLagRequest associateConnectionWithLagRequest);
/**
*
* 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.
*
*
*
* @param associateHostedConnectionRequest
* @return Result of the AssociateHostedConnection operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AssociateHostedConnection
* @see AWS API Documentation
*/
AssociateHostedConnectionResult associateHostedConnection(AssociateHostedConnectionRequest associateHostedConnectionRequest);
/**
*
* 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.
*
*
* @param associateMacSecKeyRequest
* @return Result of the AssociateMacSecKey operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AssociateMacSecKey
* @see AWS API Documentation
*/
AssociateMacSecKeyResult associateMacSecKey(AssociateMacSecKeyRequest associateMacSecKeyRequest);
/**
*
* 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.
*
*
* @param associateVirtualInterfaceRequest
* @return Result of the AssociateVirtualInterface operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.AssociateVirtualInterface
* @see AWS API Documentation
*/
AssociateVirtualInterfaceResult associateVirtualInterface(AssociateVirtualInterfaceRequest associateVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param confirmConnectionRequest
* @return Result of the ConfirmConnection operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.ConfirmConnection
* @see AWS API Documentation
*/
ConfirmConnectionResult confirmConnection(ConfirmConnectionRequest confirmConnectionRequest);
/**
*
* The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
*
*
* @param confirmCustomerAgreementRequest
* @return Result of the ConfirmCustomerAgreement operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.ConfirmCustomerAgreement
* @see AWS API Documentation
*/
ConfirmCustomerAgreementResult confirmCustomerAgreement(ConfirmCustomerAgreementRequest confirmCustomerAgreementRequest);
/**
*
* 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.
*
*
* @param confirmPrivateVirtualInterfaceRequest
* @return Result of the ConfirmPrivateVirtualInterface operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.ConfirmPrivateVirtualInterface
* @see AWS API Documentation
*/
ConfirmPrivateVirtualInterfaceResult confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest confirmPrivateVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param confirmPublicVirtualInterfaceRequest
* @return Result of the ConfirmPublicVirtualInterface operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.ConfirmPublicVirtualInterface
* @see AWS API Documentation
*/
ConfirmPublicVirtualInterfaceResult confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest confirmPublicVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param confirmTransitVirtualInterfaceRequest
* @return Result of the ConfirmTransitVirtualInterface operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.ConfirmTransitVirtualInterface
* @see AWS API Documentation
*/
ConfirmTransitVirtualInterfaceResult confirmTransitVirtualInterface(ConfirmTransitVirtualInterfaceRequest confirmTransitVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param createBGPPeerRequest
* @return Result of the CreateBGPPeer operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateBGPPeer
* @see AWS
* API Documentation
*/
CreateBGPPeerResult createBGPPeer(CreateBGPPeerRequest createBGPPeerRequest);
/**
*
* 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.
*
*
* @param createConnectionRequest
* @return Result of the CreateConnection operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateConnection
* @see AWS
* API Documentation
*/
CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest);
/**
*
* 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.
*
*
* @param createDirectConnectGatewayRequest
* @return Result of the CreateDirectConnectGateway operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateDirectConnectGateway
* @see AWS API Documentation
*/
CreateDirectConnectGatewayResult createDirectConnectGateway(CreateDirectConnectGatewayRequest createDirectConnectGatewayRequest);
/**
*
* 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.
*
*
* @param createDirectConnectGatewayAssociationRequest
* @return Result of the CreateDirectConnectGatewayAssociation operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateDirectConnectGatewayAssociation
* @see AWS API Documentation
*/
CreateDirectConnectGatewayAssociationResult createDirectConnectGatewayAssociation(
CreateDirectConnectGatewayAssociationRequest createDirectConnectGatewayAssociationRequest);
/**
*
* 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.
*
*
* @param createDirectConnectGatewayAssociationProposalRequest
* @return Result of the CreateDirectConnectGatewayAssociationProposal operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateDirectConnectGatewayAssociationProposal
* @see AWS API Documentation
*/
CreateDirectConnectGatewayAssociationProposalResult createDirectConnectGatewayAssociationProposal(
CreateDirectConnectGatewayAssociationProposalRequest createDirectConnectGatewayAssociationProposalRequest);
/**
*
* 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.
*
*
*
* @param createInterconnectRequest
* @return Result of the CreateInterconnect operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateInterconnect
* @see AWS API Documentation
*/
CreateInterconnectResult createInterconnect(CreateInterconnectRequest createInterconnectRequest);
/**
*
* 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.
*
*
* @param createLagRequest
* @return Result of the CreateLag operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateLag
* @see AWS API
* Documentation
*/
CreateLagResult createLag(CreateLagRequest createLagRequest);
/**
*
* 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.
*
*
* @param createPrivateVirtualInterfaceRequest
* @return Result of the CreatePrivateVirtualInterface operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreatePrivateVirtualInterface
* @see AWS API Documentation
*/
CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param createPublicVirtualInterfaceRequest
* @return Result of the CreatePublicVirtualInterface operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreatePublicVirtualInterface
* @see AWS API Documentation
*/
CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param createTransitVirtualInterfaceRequest
* @return Result of the CreateTransitVirtualInterface operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.CreateTransitVirtualInterface
* @see AWS API Documentation
*/
CreateTransitVirtualInterfaceResult createTransitVirtualInterface(CreateTransitVirtualInterfaceRequest createTransitVirtualInterfaceRequest);
/**
*
* 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.
*
*
* @param deleteBGPPeerRequest
* @return Result of the DeleteBGPPeer operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteBGPPeer
* @see AWS
* API Documentation
*/
DeleteBGPPeerResult deleteBGPPeer(DeleteBGPPeerRequest deleteBGPPeerRequest);
/**
*
* 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.
*
*
* @param deleteConnectionRequest
* @return Result of the DeleteConnection operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteConnection
* @see AWS
* API Documentation
*/
DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest);
/**
*
* 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.
*
*
* @param deleteDirectConnectGatewayRequest
* @return Result of the DeleteDirectConnectGateway operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteDirectConnectGateway
* @see AWS API Documentation
*/
DeleteDirectConnectGatewayResult deleteDirectConnectGateway(DeleteDirectConnectGatewayRequest deleteDirectConnectGatewayRequest);
/**
*
* 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.
*
*
* @param deleteDirectConnectGatewayAssociationRequest
* @return Result of the DeleteDirectConnectGatewayAssociation operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteDirectConnectGatewayAssociation
* @see AWS API Documentation
*/
DeleteDirectConnectGatewayAssociationResult deleteDirectConnectGatewayAssociation(
DeleteDirectConnectGatewayAssociationRequest deleteDirectConnectGatewayAssociationRequest);
/**
*
* Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway
* or transit gateway.
*
*
* @param deleteDirectConnectGatewayAssociationProposalRequest
* @return Result of the DeleteDirectConnectGatewayAssociationProposal operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteDirectConnectGatewayAssociationProposal
* @see AWS API Documentation
*/
DeleteDirectConnectGatewayAssociationProposalResult deleteDirectConnectGatewayAssociationProposal(
DeleteDirectConnectGatewayAssociationProposalRequest deleteDirectConnectGatewayAssociationProposalRequest);
/**
*
* Deletes the specified interconnect.
*
*
*
* Intended for use by Direct Connect Partners only.
*
*
*
* @param deleteInterconnectRequest
* @return Result of the DeleteInterconnect operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteInterconnect
* @see AWS API Documentation
*/
DeleteInterconnectResult deleteInterconnect(DeleteInterconnectRequest deleteInterconnectRequest);
/**
*
* Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces
* or hosted connections.
*
*
* @param deleteLagRequest
* @return Result of the DeleteLag operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteLag
* @see AWS API
* Documentation
*/
DeleteLagResult deleteLag(DeleteLagRequest deleteLagRequest);
/**
*
* Deletes a virtual interface.
*
*
* @param deleteVirtualInterfaceRequest
* @return Result of the DeleteVirtualInterface operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DeleteVirtualInterface
* @see AWS API Documentation
*/
DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest);
/**
*
*
* 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.
*
*
* @param describeConnectionLoaRequest
* @return Result of the DescribeConnectionLoa operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeConnectionLoa
* @see AWS API Documentation
*/
@Deprecated
DescribeConnectionLoaResult describeConnectionLoa(DescribeConnectionLoaRequest describeConnectionLoaRequest);
/**
*
* Displays the specified connection or all connections in this Region.
*
*
* @param describeConnectionsRequest
* @return Result of the DescribeConnections operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeConnections
* @see AWS API Documentation
*/
DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest);
/**
* Simplified method form for invoking the DescribeConnections operation.
*
* @see #describeConnections(DescribeConnectionsRequest)
*/
DescribeConnectionsResult describeConnections();
/**
*
*
* Deprecated. Use DescribeHostedConnections instead.
*
*
*
* Lists the connections that have been provisioned on the specified interconnect.
*
*
*
* Intended for use by Direct Connect Partners only.
*
*
*
* @param describeConnectionsOnInterconnectRequest
* @return Result of the DescribeConnectionsOnInterconnect operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeConnectionsOnInterconnect
* @see AWS API Documentation
*/
@Deprecated
DescribeConnectionsOnInterconnectResult describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest describeConnectionsOnInterconnectRequest);
/**
*
* Get and view a list of customer agreements, along with their signed status and whether the customer is an
* NNIPartner, NNIPartnerV2, or a nonPartner.
*
*
* @param describeCustomerMetadataRequest
* @return Result of the DescribeCustomerMetadata operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeCustomerMetadata
* @see AWS API Documentation
*/
DescribeCustomerMetadataResult describeCustomerMetadata(DescribeCustomerMetadataRequest describeCustomerMetadataRequest);
/**
*
* Describes one or more association proposals for connection between a virtual private gateway or transit gateway
* and a Direct Connect gateway.
*
*
* @param describeDirectConnectGatewayAssociationProposalsRequest
* @return Result of the DescribeDirectConnectGatewayAssociationProposals operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeDirectConnectGatewayAssociationProposals
* @see AWS API Documentation
*/
DescribeDirectConnectGatewayAssociationProposalsResult describeDirectConnectGatewayAssociationProposals(
DescribeDirectConnectGatewayAssociationProposalsRequest describeDirectConnectGatewayAssociationProposalsRequest);
/**
*
* 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.
*
*
*
*
* @param describeDirectConnectGatewayAssociationsRequest
* @return Result of the DescribeDirectConnectGatewayAssociations operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeDirectConnectGatewayAssociations
* @see AWS API Documentation
*/
DescribeDirectConnectGatewayAssociationsResult describeDirectConnectGatewayAssociations(
DescribeDirectConnectGatewayAssociationsRequest describeDirectConnectGatewayAssociationsRequest);
/**
*
* 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.
*
*
* @param describeDirectConnectGatewayAttachmentsRequest
* @return Result of the DescribeDirectConnectGatewayAttachments operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeDirectConnectGatewayAttachments
* @see AWS API Documentation
*/
DescribeDirectConnectGatewayAttachmentsResult describeDirectConnectGatewayAttachments(
DescribeDirectConnectGatewayAttachmentsRequest describeDirectConnectGatewayAttachmentsRequest);
/**
*
* Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect
* gateways are not returned.
*
*
* @param describeDirectConnectGatewaysRequest
* @return Result of the DescribeDirectConnectGateways operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeDirectConnectGateways
* @see AWS API Documentation
*/
DescribeDirectConnectGatewaysResult describeDirectConnectGateways(DescribeDirectConnectGatewaysRequest describeDirectConnectGatewaysRequest);
/**
*
* 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.
*
*
*
* @param describeHostedConnectionsRequest
* @return Result of the DescribeHostedConnections operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeHostedConnections
* @see AWS API Documentation
*/
DescribeHostedConnectionsResult describeHostedConnections(DescribeHostedConnectionsRequest describeHostedConnectionsRequest);
/**
*
*
* 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.
*
*
* @param describeInterconnectLoaRequest
* @return Result of the DescribeInterconnectLoa operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeInterconnectLoa
* @see AWS API Documentation
*/
@Deprecated
DescribeInterconnectLoaResult describeInterconnectLoa(DescribeInterconnectLoaRequest describeInterconnectLoaRequest);
/**
*
* Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
*
*
* @param describeInterconnectsRequest
* @return Result of the DescribeInterconnects operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeInterconnects
* @see AWS API Documentation
*/
DescribeInterconnectsResult describeInterconnects(DescribeInterconnectsRequest describeInterconnectsRequest);
/**
* Simplified method form for invoking the DescribeInterconnects operation.
*
* @see #describeInterconnects(DescribeInterconnectsRequest)
*/
DescribeInterconnectsResult describeInterconnects();
/**
*
* Describes all your link aggregation groups (LAG) or the specified LAG.
*
*
* @param describeLagsRequest
* @return Result of the DescribeLags operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeLags
* @see AWS API
* Documentation
*/
DescribeLagsResult describeLags(DescribeLagsRequest describeLagsRequest);
/**
*
* 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.
*
*
* @param describeLoaRequest
* @return Result of the DescribeLoa operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeLoa
* @see AWS API
* Documentation
*/
DescribeLoaResult describeLoa(DescribeLoaRequest describeLoaRequest);
/**
*
* 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.
*
*
* @param describeLocationsRequest
* @return Result of the DescribeLocations operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeLocations
* @see AWS API Documentation
*/
DescribeLocationsResult describeLocations(DescribeLocationsRequest describeLocationsRequest);
/**
* Simplified method form for invoking the DescribeLocations operation.
*
* @see #describeLocations(DescribeLocationsRequest)
*/
DescribeLocationsResult describeLocations();
/**
*
* Details about the router.
*
*
* @param describeRouterConfigurationRequest
* Provides the details about a virtual interface's router.
* @return Result of the DescribeRouterConfiguration operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeRouterConfiguration
* @see AWS API Documentation
*/
DescribeRouterConfigurationResult describeRouterConfiguration(DescribeRouterConfigurationRequest describeRouterConfigurationRequest);
/**
*
* Describes the tags associated with the specified Direct Connect resources.
*
*
* @param describeTagsRequest
* @return Result of the DescribeTags operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeTags
* @see AWS API
* Documentation
*/
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest);
/**
*
*
* 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.
*
*
* @param describeVirtualGatewaysRequest
* @return Result of the DescribeVirtualGateways operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeVirtualGateways
* @see AWS API Documentation
*/
DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest);
/**
* Simplified method form for invoking the DescribeVirtualGateways operation.
*
* @see #describeVirtualGateways(DescribeVirtualGatewaysRequest)
*/
DescribeVirtualGatewaysResult describeVirtualGateways();
/**
*
* 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.
*
*
* @param describeVirtualInterfacesRequest
* @return Result of the DescribeVirtualInterfaces operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DescribeVirtualInterfaces
* @see AWS API Documentation
*/
DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest);
/**
* Simplified method form for invoking the DescribeVirtualInterfaces operation.
*
* @see #describeVirtualInterfaces(DescribeVirtualInterfacesRequest)
*/
DescribeVirtualInterfacesResult describeVirtualInterfaces();
/**
*
* 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.
*
*
* @param disassociateConnectionFromLagRequest
* @return Result of the DisassociateConnectionFromLag operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DisassociateConnectionFromLag
* @see AWS API Documentation
*/
DisassociateConnectionFromLagResult disassociateConnectionFromLag(DisassociateConnectionFromLagRequest disassociateConnectionFromLagRequest);
/**
*
* Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
*
*
* @param disassociateMacSecKeyRequest
* @return Result of the DisassociateMacSecKey operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.DisassociateMacSecKey
* @see AWS API Documentation
*/
DisassociateMacSecKeyResult disassociateMacSecKey(DisassociateMacSecKeyRequest disassociateMacSecKeyRequest);
/**
*
* Lists the virtual interface failover test history.
*
*
* @param listVirtualInterfaceTestHistoryRequest
* @return Result of the ListVirtualInterfaceTestHistory operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.ListVirtualInterfaceTestHistory
* @see AWS API Documentation
*/
ListVirtualInterfaceTestHistoryResult listVirtualInterfaceTestHistory(ListVirtualInterfaceTestHistoryRequest listVirtualInterfaceTestHistoryRequest);
/**
*
* 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.
*
*
* @param startBgpFailoverTestRequest
* @return Result of the StartBgpFailoverTest operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.StartBgpFailoverTest
* @see AWS API Documentation
*/
StartBgpFailoverTestResult startBgpFailoverTest(StartBgpFailoverTestRequest startBgpFailoverTestRequest);
/**
*
* Stops the virtual interface failover test.
*
*
* @param stopBgpFailoverTestRequest
* @return Result of the StopBgpFailoverTest operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.StopBgpFailoverTest
* @see AWS API Documentation
*/
StopBgpFailoverTestResult stopBgpFailoverTest(StopBgpFailoverTestRequest stopBgpFailoverTestRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You have reached the limit on the number of tags that can be assigned.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes one or more tags from the specified Direct Connect resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
*
*
* @param updateConnectionRequest
* @return Result of the UpdateConnection operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.UpdateConnection
* @see AWS
* API Documentation
*/
UpdateConnectionResult updateConnection(UpdateConnectionRequest updateConnectionRequest);
/**
*
* Updates the name of a current Direct Connect gateway.
*
*
* @param updateDirectConnectGatewayRequest
* @return Result of the UpdateDirectConnectGateway operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.UpdateDirectConnectGateway
* @see AWS API Documentation
*/
UpdateDirectConnectGatewayResult updateDirectConnectGateway(UpdateDirectConnectGatewayRequest updateDirectConnectGatewayRequest);
/**
*
* Updates the specified attributes of the Direct Connect gateway association.
*
*
* Add or remove prefixes from the association.
*
*
* @param updateDirectConnectGatewayAssociationRequest
* @return Result of the UpdateDirectConnectGatewayAssociation operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.UpdateDirectConnectGatewayAssociation
* @see AWS API Documentation
*/
UpdateDirectConnectGatewayAssociationResult updateDirectConnectGatewayAssociation(
UpdateDirectConnectGatewayAssociationRequest updateDirectConnectGatewayAssociationRequest);
/**
*
* 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.
*
*
*
* @param updateLagRequest
* @return Result of the UpdateLag operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.UpdateLag
* @see AWS API
* Documentation
*/
UpdateLagResult updateLag(UpdateLagRequest updateLagRequest);
/**
*
* 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.
*
*
* @param updateVirtualInterfaceAttributesRequest
* @return Result of the UpdateVirtualInterfaceAttributes operation returned by the service.
* @throws DirectConnectServerException
* A server-side error occurred.
* @throws DirectConnectClientException
* One or more parameters are not valid.
* @sample AmazonDirectConnect.UpdateVirtualInterfaceAttributes
* @see AWS API Documentation
*/
UpdateVirtualInterfaceAttributesResult updateVirtualInterfaceAttributes(UpdateVirtualInterfaceAttributesRequest updateVirtualInterfaceAttributesRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}