JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.directconnect

Interface AmazonDirectConnect

  • All Known Subinterfaces:
    AmazonDirectConnectAsync
    All Known Implementing Classes:
    AbstractAmazonDirectConnect, AbstractAmazonDirectConnectAsync, AmazonDirectConnectAsyncClient, AmazonDirectConnectClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDirectConnect
    Interface for accessing AWS Direct Connect.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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.

    • Method Detail

      • setEndpoint

        @Deprecated
void setEndpoint(String endpoint)
        Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
        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 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.

        Parameters:
        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.

      • allocateHostedConnection

        AllocateHostedConnectionResult allocateHostedConnection(AllocateHostedConnectionRequest allocateHostedConnectionRequest)

        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.

        Parameters:
        allocateHostedConnectionRequest -
        Returns:
        Result of the AllocateHostedConnection operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • allocatePublicVirtualInterface

        AllocatePublicVirtualInterfaceResult allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest allocatePublicVirtualInterfaceRequest)

        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.

        Parameters:
        allocatePublicVirtualInterfaceRequest -
        Returns:
        Result of the AllocatePublicVirtualInterface operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • allocateTransitVirtualInterface

        AllocateTransitVirtualInterfaceResult allocateTransitVirtualInterface(AllocateTransitVirtualInterfaceRequest allocateTransitVirtualInterfaceRequest)

        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.

        Parameters:
        allocateTransitVirtualInterfaceRequest -
        Returns:
        Result of the AllocateTransitVirtualInterface operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • associateConnectionWithLag

        AssociateConnectionWithLagResult associateConnectionWithLag(AssociateConnectionWithLagRequest associateConnectionWithLagRequest)

        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.

        Parameters:
        associateConnectionWithLagRequest -
        Returns:
        Result of the AssociateConnectionWithLag operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • associateHostedConnection

        AssociateHostedConnectionResult associateHostedConnection(AssociateHostedConnectionRequest associateHostedConnectionRequest)

        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.

        Parameters:
        associateHostedConnectionRequest -
        Returns:
        Result of the AssociateHostedConnection operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • associateVirtualInterface

        AssociateVirtualInterfaceResult associateVirtualInterface(AssociateVirtualInterfaceRequest associateVirtualInterfaceRequest)

        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.

        Parameters:
        associateVirtualInterfaceRequest -
        Returns:
        Result of the AssociateVirtualInterface operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • confirmConnection

        ConfirmConnectionResult confirmConnection(ConfirmConnectionRequest confirmConnectionRequest)

        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.

        Parameters:
        confirmConnectionRequest -
        Returns:
        Result of the ConfirmConnection operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • confirmPrivateVirtualInterface

        ConfirmPrivateVirtualInterfaceResult confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest confirmPrivateVirtualInterfaceRequest)

        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.

        Parameters:
        confirmPrivateVirtualInterfaceRequest -
        Returns:
        Result of the ConfirmPrivateVirtualInterface operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • createBGPPeer

        CreateBGPPeerResult createBGPPeer(CreateBGPPeerRequest createBGPPeerRequest)

        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.

        Parameters:
        createBGPPeerRequest -
        Returns:
        Result of the CreateBGPPeer operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • createConnection

        CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest)

        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.

        Parameters:
        createConnectionRequest -
        Returns:
        Result of the CreateConnection operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createDirectConnectGateway

        CreateDirectConnectGatewayResult createDirectConnectGateway(CreateDirectConnectGatewayRequest createDirectConnectGatewayRequest)

        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.

        Parameters:
        createDirectConnectGatewayRequest -
        Returns:
        Result of the CreateDirectConnectGateway operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • createInterconnect

        CreateInterconnectResult createInterconnect(CreateInterconnectRequest createInterconnectRequest)

        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.

        Parameters:
        createInterconnectRequest -
        Returns:
        Result of the CreateInterconnect operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createLag

        CreateLagResult createLag(CreateLagRequest createLagRequest)

        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.

        Parameters:
        createLagRequest -
        Returns:
        Result of the CreateLag operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createPrivateVirtualInterface

        CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest)

        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.

        Parameters:
        createPrivateVirtualInterfaceRequest -
        Returns:
        Result of the CreatePrivateVirtualInterface operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createPublicVirtualInterface

        CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest)

        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.

        Parameters:
        createPublicVirtualInterfaceRequest -
        Returns:
        Result of the CreatePublicVirtualInterface operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createTransitVirtualInterface

        CreateTransitVirtualInterfaceResult createTransitVirtualInterface(CreateTransitVirtualInterfaceRequest createTransitVirtualInterfaceRequest)

        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.

        Parameters:
        createTransitVirtualInterfaceRequest -
        Returns:
        Result of the CreateTransitVirtualInterface operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • deleteConnection

        DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)

        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.

        Parameters:
        deleteConnectionRequest -
        Returns:
        Result of the DeleteConnection operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • deleteDirectConnectGatewayAssociation

        DeleteDirectConnectGatewayAssociationResult deleteDirectConnectGatewayAssociation(DeleteDirectConnectGatewayAssociationRequest deleteDirectConnectGatewayAssociationRequest)

        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.

        Parameters:
        deleteDirectConnectGatewayAssociationRequest -
        Returns:
        Result of the DeleteDirectConnectGatewayAssociation operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • describeDirectConnectGatewayAssociations

        DescribeDirectConnectGatewayAssociationsResult describeDirectConnectGatewayAssociations(DescribeDirectConnectGatewayAssociationsRequest describeDirectConnectGatewayAssociationsRequest)

        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.

        Parameters:
        describeDirectConnectGatewayAssociationsRequest -
        Returns:
        Result of the DescribeDirectConnectGatewayAssociations operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • describeDirectConnectGatewayAttachments

        DescribeDirectConnectGatewayAttachmentsResult describeDirectConnectGatewayAttachments(DescribeDirectConnectGatewayAttachmentsRequest describeDirectConnectGatewayAttachmentsRequest)

        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.

        Parameters:
        describeDirectConnectGatewayAttachmentsRequest -
        Returns:
        Result of the DescribeDirectConnectGatewayAttachments operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • describeVirtualInterfaces

        DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest)

        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.

        Parameters:
        describeVirtualInterfacesRequest -
        Returns:
        Result of the DescribeVirtualInterfaces operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • disassociateConnectionFromLag

        DisassociateConnectionFromLagResult disassociateConnectionFromLag(DisassociateConnectionFromLagRequest disassociateConnectionFromLagRequest)

        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.

        Parameters:
        disassociateConnectionFromLagRequest -
        Returns:
        Result of the DisassociateConnectionFromLag operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • startBgpFailoverTest

        StartBgpFailoverTestResult startBgpFailoverTest(StartBgpFailoverTestRequest startBgpFailoverTestRequest)

        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.

        Parameters:
        startBgpFailoverTestRequest -
        Returns:
        Result of the StartBgpFailoverTest operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • updateLag

        UpdateLagResult updateLag(UpdateLagRequest updateLagRequest)

        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.

        Parameters:
        updateLagRequest -
        Returns:
        Result of the UpdateLag operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • updateVirtualInterfaceAttributes

        UpdateVirtualInterfaceAttributesResult updateVirtualInterfaceAttributes(UpdateVirtualInterfaceAttributesRequest updateVirtualInterfaceAttributesRequest)

        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.

        Parameters:
        updateVirtualInterfaceAttributesRequest -
        Returns:
        Result of the UpdateVirtualInterfaceAttributes operation returned by the service.
        Throws:
        DirectConnectServerException - A server-side error occurred.
        DirectConnectClientException - One or more parameters are not valid.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        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.

      • getCachedResponseMetadata

        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. 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.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /