directconnect/aws.sdk.kotlin.services.directconnect

Package-level declarations

Types

Link copied to clipboard
interface DirectConnectClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

inline suspend fun DirectConnectClient.acceptDirectConnectGatewayAssociationProposal(crossinline block: AcceptDirectConnectGatewayAssociationProposalRequest.Builder.() -> Unit): AcceptDirectConnectGatewayAssociationProposalResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.allocateConnectionOnInterconnect(crossinline block: AllocateConnectionOnInterconnectRequest.Builder.() -> Unit): AllocateConnectionOnInterconnectResponse

Deprecated. Use AllocateHostedConnection instead.

Link copied to clipboard
inline suspend fun DirectConnectClient.allocateHostedConnection(crossinline block: AllocateHostedConnectionRequest.Builder.() -> Unit): AllocateHostedConnectionResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.allocatePrivateVirtualInterface(crossinline block: AllocatePrivateVirtualInterfaceRequest.Builder.() -> Unit): AllocatePrivateVirtualInterfaceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.allocatePublicVirtualInterface(crossinline block: AllocatePublicVirtualInterfaceRequest.Builder.() -> Unit): AllocatePublicVirtualInterfaceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.allocateTransitVirtualInterface(crossinline block: AllocateTransitVirtualInterfaceRequest.Builder.() -> Unit): AllocateTransitVirtualInterfaceResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.associateConnectionWithLag(crossinline block: AssociateConnectionWithLagRequest.Builder.() -> Unit): AssociateConnectionWithLagResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.associateHostedConnection(crossinline block: AssociateHostedConnectionRequest.Builder.() -> Unit): AssociateHostedConnectionResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.associateMacSecKey(crossinline block: AssociateMacSecKeyRequest.Builder.() -> Unit): AssociateMacSecKeyResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.associateVirtualInterface(crossinline block: AssociateVirtualInterfaceRequest.Builder.() -> Unit): AssociateVirtualInterfaceResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.confirmConnection(crossinline block: ConfirmConnectionRequest.Builder.() -> Unit): ConfirmConnectionResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.confirmCustomerAgreement(crossinline block: ConfirmCustomerAgreementRequest.Builder.() -> Unit): ConfirmCustomerAgreementResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.confirmPrivateVirtualInterface(crossinline block: ConfirmPrivateVirtualInterfaceRequest.Builder.() -> Unit): ConfirmPrivateVirtualInterfaceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.confirmPublicVirtualInterface(crossinline block: ConfirmPublicVirtualInterfaceRequest.Builder.() -> Unit): ConfirmPublicVirtualInterfaceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.confirmTransitVirtualInterface(crossinline block: ConfirmTransitVirtualInterfaceRequest.Builder.() -> Unit): ConfirmTransitVirtualInterfaceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.createBgpPeer(crossinline block: CreateBgpPeerRequest.Builder.() -> Unit): CreateBgpPeerResponse

Creates a BGP peer on the specified virtual interface.

Link copied to clipboard
inline suspend fun DirectConnectClient.createConnection(crossinline block: CreateConnectionRequest.Builder.() -> Unit): CreateConnectionResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.createDirectConnectGateway(crossinline block: CreateDirectConnectGatewayRequest.Builder.() -> Unit): CreateDirectConnectGatewayResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.createDirectConnectGatewayAssociation(crossinline block: CreateDirectConnectGatewayAssociationRequest.Builder.() -> Unit): CreateDirectConnectGatewayAssociationResponse

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.

inline suspend fun DirectConnectClient.createDirectConnectGatewayAssociationProposal(crossinline block: CreateDirectConnectGatewayAssociationProposalRequest.Builder.() -> Unit): CreateDirectConnectGatewayAssociationProposalResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.createInterconnect(crossinline block: CreateInterconnectRequest.Builder.() -> Unit): CreateInterconnectResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.createLag(crossinline block: CreateLagRequest.Builder.() -> Unit): CreateLagResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.createPrivateVirtualInterface(crossinline block: CreatePrivateVirtualInterfaceRequest.Builder.() -> Unit): CreatePrivateVirtualInterfaceResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.createPublicVirtualInterface(crossinline block: CreatePublicVirtualInterfaceRequest.Builder.() -> Unit): CreatePublicVirtualInterfaceResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.createTransitVirtualInterface(crossinline block: CreateTransitVirtualInterfaceRequest.Builder.() -> Unit): CreateTransitVirtualInterfaceResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteBgpPeer(crossinline block: DeleteBgpPeerRequest.Builder.() -> Unit): DeleteBgpPeerResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteConnection(crossinline block: DeleteConnectionRequest.Builder.() -> Unit): DeleteConnectionResponse

Deletes the specified connection.

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteDirectConnectGateway(crossinline block: DeleteDirectConnectGatewayRequest.Builder.() -> Unit): DeleteDirectConnectGatewayResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteDirectConnectGatewayAssociation(crossinline block: DeleteDirectConnectGatewayAssociationRequest.Builder.() -> Unit): DeleteDirectConnectGatewayAssociationResponse

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

inline suspend fun DirectConnectClient.deleteDirectConnectGatewayAssociationProposal(crossinline block: DeleteDirectConnectGatewayAssociationProposalRequest.Builder.() -> Unit): DeleteDirectConnectGatewayAssociationProposalResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteInterconnect(crossinline block: DeleteInterconnectRequest.Builder.() -> Unit): DeleteInterconnectResponse

Deletes the specified interconnect.

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteLag(crossinline block: DeleteLagRequest.Builder.() -> Unit): DeleteLagResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.deleteVirtualInterface(crossinline block: DeleteVirtualInterfaceRequest.Builder.() -> Unit): DeleteVirtualInterfaceResponse

Deletes a virtual interface.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeConnectionLoa(crossinline block: DescribeConnectionLoaRequest.Builder.() -> Unit): DescribeConnectionLoaResponse

Deprecated. Use DescribeLoa instead.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeConnections(crossinline block: DescribeConnectionsRequest.Builder.() -> Unit): DescribeConnectionsResponse

Displays the specified connection or all connections in this Region.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeConnectionsOnInterconnect(crossinline block: DescribeConnectionsOnInterconnectRequest.Builder.() -> Unit): DescribeConnectionsOnInterconnectResponse

Deprecated. Use DescribeHostedConnections instead.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeCustomerMetadata(crossinline block: DescribeCustomerMetadataRequest.Builder.() -> Unit): DescribeCustomerMetadataResponse

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

inline suspend fun DirectConnectClient.describeDirectConnectGatewayAssociationProposals(crossinline block: DescribeDirectConnectGatewayAssociationProposalsRequest.Builder.() -> Unit): DescribeDirectConnectGatewayAssociationProposalsResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeDirectConnectGatewayAssociations(crossinline block: DescribeDirectConnectGatewayAssociationsRequest.Builder.() -> Unit): DescribeDirectConnectGatewayAssociationsResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeDirectConnectGatewayAttachments(crossinline block: DescribeDirectConnectGatewayAttachmentsRequest.Builder.() -> Unit): DescribeDirectConnectGatewayAttachmentsResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeDirectConnectGateways(crossinline block: DescribeDirectConnectGatewaysRequest.Builder.() -> Unit): DescribeDirectConnectGatewaysResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeHostedConnections(crossinline block: DescribeHostedConnectionsRequest.Builder.() -> Unit): DescribeHostedConnectionsResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeInterconnectLoa(crossinline block: DescribeInterconnectLoaRequest.Builder.() -> Unit): DescribeInterconnectLoaResponse

Deprecated. Use DescribeLoa instead.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeInterconnects(crossinline block: DescribeInterconnectsRequest.Builder.() -> Unit): DescribeInterconnectsResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeLags(crossinline block: DescribeLagsRequest.Builder.() -> Unit): DescribeLagsResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeLoa(crossinline block: DescribeLoaRequest.Builder.() -> Unit): DescribeLoaResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeLocations(crossinline block: DescribeLocationsRequest.Builder.() -> Unit): DescribeLocationsResponse

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.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DirectConnectClient.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

Describes the tags associated with the specified Direct Connect resources.

Link copied to clipboard
inline suspend fun DirectConnectClient.describeVirtualGateways(crossinline block: DescribeVirtualGatewaysRequest.Builder.() -> Unit): DescribeVirtualGatewaysResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.describeVirtualInterfaces(crossinline block: DescribeVirtualInterfacesRequest.Builder.() -> Unit): DescribeVirtualInterfacesResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.disassociateConnectionFromLag(crossinline block: DisassociateConnectionFromLagRequest.Builder.() -> Unit): DisassociateConnectionFromLagResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.disassociateMacSecKey(crossinline block: DisassociateMacSecKeyRequest.Builder.() -> Unit): DisassociateMacSecKeyResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.listVirtualInterfaceTestHistory(crossinline block: ListVirtualInterfaceTestHistoryRequest.Builder.() -> Unit): ListVirtualInterfaceTestHistoryResponse

Lists the virtual interface failover test history.

Link copied to clipboard
inline suspend fun DirectConnectClient.startBgpFailoverTest(crossinline block: StartBgpFailoverTestRequest.Builder.() -> Unit): StartBgpFailoverTestResponse

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.

Link copied to clipboard
inline suspend fun DirectConnectClient.stopBgpFailoverTest(crossinline block: StopBgpFailoverTestRequest.Builder.() -> Unit): StopBgpFailoverTestResponse

Stops the virtual interface failover test.

Link copied to clipboard
inline suspend fun DirectConnectClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.updateConnection(crossinline block: UpdateConnectionRequest.Builder.() -> Unit): UpdateConnectionResponse

Updates the Direct Connect dedicated connection configuration.

Link copied to clipboard
inline suspend fun DirectConnectClient.updateDirectConnectGateway(crossinline block: UpdateDirectConnectGatewayRequest.Builder.() -> Unit): UpdateDirectConnectGatewayResponse

Updates the name of a current Direct Connect gateway.

Link copied to clipboard
inline suspend fun DirectConnectClient.updateDirectConnectGatewayAssociation(crossinline block: UpdateDirectConnectGatewayAssociationRequest.Builder.() -> Unit): UpdateDirectConnectGatewayAssociationResponse

Updates the specified attributes of the Direct Connect gateway association.

Link copied to clipboard
inline suspend fun DirectConnectClient.updateLag(crossinline block: UpdateLagRequest.Builder.() -> Unit): UpdateLagResponse

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

Link copied to clipboard
inline suspend fun DirectConnectClient.updateVirtualInterfaceAttributes(crossinline block: UpdateVirtualInterfaceAttributesRequest.Builder.() -> Unit): UpdateVirtualInterfaceAttributesResponse

Updates the specified attributes of the specified virtual private interface.

Link copied to clipboard
fun DirectConnectClient.withConfig(block: DirectConnectClient.Config.Builder.() -> Unit): DirectConnectClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.