Class: Aws::DirectConnect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DirectConnect::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb
Overview
An API client for DirectConnect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DirectConnect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::AcceptDirectConnectGatewayAssociationProposalResult
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
-
#allocate_connection_on_interconnect(params = {}) ⇒ Types::Connection
Deprecated.
-
#allocate_hosted_connection(params = {}) ⇒ Types::Connection
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
-
#allocate_private_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Provisions a private virtual interface to be owned by the specified AWS account.
-
#allocate_public_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Provisions a public virtual interface to be owned by the specified AWS account.
-
#allocate_transit_virtual_interface(params = {}) ⇒ Types::AllocateTransitVirtualInterfaceResult
Provisions a transit virtual interface to be owned by the specified AWS account.
-
#associate_connection_with_lag(params = {}) ⇒ Types::Connection
Associates an existing connection with a link aggregation group (LAG).
-
#associate_hosted_connection(params = {}) ⇒ Types::Connection
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
-
#associate_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Associates a virtual interface with a specified link aggregation group (LAG) or connection.
-
#confirm_connection(params = {}) ⇒ Types::ConfirmConnectionResponse
Confirms the creation of the specified hosted connection on an interconnect.
-
#confirm_private_virtual_interface(params = {}) ⇒ Types::ConfirmPrivateVirtualInterfaceResponse
Accepts ownership of a private virtual interface created by another AWS account.
-
#confirm_public_virtual_interface(params = {}) ⇒ Types::ConfirmPublicVirtualInterfaceResponse
Accepts ownership of a public virtual interface created by another AWS account.
-
#confirm_transit_virtual_interface(params = {}) ⇒ Types::ConfirmTransitVirtualInterfaceResponse
Accepts ownership of a transit virtual interface created by another AWS account.
-
#create_bgp_peer(params = {}) ⇒ Types::CreateBGPPeerResponse
Creates a BGP peer on the specified virtual interface.
-
#create_connection(params = {}) ⇒ Types::Connection
Creates a connection between a customer network and a specific AWS Direct Connect location.
-
#create_direct_connect_gateway(params = {}) ⇒ Types::CreateDirectConnectGatewayResult
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways.
-
#create_direct_connect_gateway_association(params = {}) ⇒ Types::CreateDirectConnectGatewayAssociationResult
Creates an association between a Direct Connect gateway and a virtual private gateway.
-
#create_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::CreateDirectConnectGatewayAssociationProposalResult
Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
-
#create_interconnect(params = {}) ⇒ Types::Interconnect
Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
-
#create_lag(params = {}) ⇒ Types::Lag
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific AWS Direct Connect location.
-
#create_private_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Creates a private virtual interface.
-
#create_public_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Creates a public virtual interface.
-
#create_transit_virtual_interface(params = {}) ⇒ Types::CreateTransitVirtualInterfaceResult
Creates a transit virtual interface.
-
#delete_bgp_peer(params = {}) ⇒ Types::DeleteBGPPeerResponse
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
-
#delete_connection(params = {}) ⇒ Types::Connection
Deletes the specified connection.
-
#delete_direct_connect_gateway(params = {}) ⇒ Types::DeleteDirectConnectGatewayResult
Deletes the specified Direct Connect gateway.
-
#delete_direct_connect_gateway_association(params = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationResult
Deletes the association between the specified Direct Connect gateway and virtual private gateway.
-
#delete_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationProposalResult
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
-
#delete_interconnect(params = {}) ⇒ Types::DeleteInterconnectResponse
Deletes the specified interconnect.
-
#delete_lag(params = {}) ⇒ Types::Lag
Deletes the specified link aggregation group (LAG).
-
#delete_virtual_interface(params = {}) ⇒ Types::DeleteVirtualInterfaceResponse
Deletes a virtual interface.
-
#describe_connection_loa(params = {}) ⇒ Types::DescribeConnectionLoaResponse
Deprecated.
-
#describe_connections(params = {}) ⇒ Types::Connections
Displays the specified connection or all connections in this Region.
-
#describe_connections_on_interconnect(params = {}) ⇒ Types::Connections
Deprecated.
-
#describe_direct_connect_gateway_association_proposals(params = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationProposalsResult
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
-
#describe_direct_connect_gateway_associations(params = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationsResult
Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways.
-
#describe_direct_connect_gateway_attachments(params = {}) ⇒ Types::DescribeDirectConnectGatewayAttachmentsResult
Lists the attachments between your Direct Connect gateways and virtual interfaces.
-
#describe_direct_connect_gateways(params = {}) ⇒ Types::DescribeDirectConnectGatewaysResult
Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
-
#describe_hosted_connections(params = {}) ⇒ Types::Connections
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
-
#describe_interconnect_loa(params = {}) ⇒ Types::DescribeInterconnectLoaResponse
Deprecated.
-
#describe_interconnects(params = {}) ⇒ Types::Interconnects
Lists the interconnects owned by the AWS account or only the specified interconnect.
-
#describe_lags(params = {}) ⇒ Types::Lags
Describes all your link aggregation groups (LAG) or the specified LAG.
-
#describe_loa(params = {}) ⇒ Types::Loa
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
-
#describe_locations(params = {}) ⇒ Types::Locations
Lists the AWS Direct Connect locations in the current AWS Region.
-
#describe_tags(params = {}) ⇒ Types::DescribeTagsResponse
Describes the tags associated with the specified AWS Direct Connect resources.
-
#describe_virtual_gateways(params = {}) ⇒ Types::VirtualGateways
Lists the virtual private gateways owned by the AWS account.
-
#describe_virtual_interfaces(params = {}) ⇒ Types::VirtualInterfaces
Displays all virtual interfaces for an AWS account.
-
#disassociate_connection_from_lag(params = {}) ⇒ Types::Connection
Disassociates a connection from a link aggregation group (LAG).
-
#list_virtual_interface_test_history(params = {}) ⇒ Types::ListVirtualInterfaceTestHistoryResponse
Lists the virtual interface failover test history.
-
#start_bgp_failover_test(params = {}) ⇒ Types::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.
-
#stop_bgp_failover_test(params = {}) ⇒ Types::StopBgpFailoverTestResponse
Stops the virtual interface failover test.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified AWS Direct Connect resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified AWS Direct Connect resource.
-
#update_direct_connect_gateway_association(params = {}) ⇒ Types::UpdateDirectConnectGatewayAssociationResult
Updates the specified attributes of the Direct Connect gateway association.
-
#update_lag(params = {}) ⇒ Types::Lag
Updates the attributes of the specified link aggregation group (LAG).
-
#update_virtual_interface_attributes(params = {}) ⇒ Types::VirtualInterface
Updates the specified attributes of the specified virtual private interface.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#accept_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::AcceptDirectConnectGatewayAssociationProposalResult
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
402 403 404 405 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 402 def accept_direct_connect_gateway_association_proposal(params = {}, = {}) req = build_request(:accept_direct_connect_gateway_association_proposal, params) req.send_request() end |
#allocate_connection_on_interconnect(params = {}) ⇒ Types::Connection
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.
495 496 497 498 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 495 def allocate_connection_on_interconnect(params = {}, = {}) req = build_request(:allocate_connection_on_interconnect, params) req.send_request() end |
#allocate_hosted_connection(params = {}) ⇒ Types::Connection
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. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.
597 598 599 600 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 597 def allocate_hosted_connection(params = {}, = {}) req = build_request(:allocate_hosted_connection, params) req.send_request() end |
#allocate_private_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Provisions a private virtual interface to be owned by the specified AWS 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.
713 714 715 716 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 713 def allocate_private_virtual_interface(params = {}, = {}) req = build_request(:allocate_private_virtual_interface, params) req.send_request() end |
#allocate_public_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Provisions a public virtual interface to be owned by the specified AWS account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS 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.
841 842 843 844 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 841 def allocate_public_virtual_interface(params = {}, = {}) req = build_request(:allocate_public_virtual_interface, params) req.send_request() end |
#allocate_transit_virtual_interface(params = {}) ⇒ Types::AllocateTransitVirtualInterfaceResult
Provisions a transit virtual interface to be owned by the specified AWS 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 AWS 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.
938 939 940 941 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 938 def allocate_transit_virtual_interface(params = {}, = {}) req = build_request(:allocate_transit_virtual_interface, params) req.send_request() end |
#associate_connection_with_lag(params = {}) ⇒ Types::Connection
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 AWS is interrupted). The connection must be hosted on the same AWS 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.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1022 def associate_connection_with_lag(params = {}, = {}) req = build_request(:associate_connection_with_lag, params) req.send_request() end |
#associate_hosted_connection(params = {}) ⇒ Types::Connection
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 AWS as it is being migrated.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1096 def associate_hosted_connection(params = {}, = {}) req = build_request(:associate_hosted_connection, params) req.send_request() end |
#associate_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS 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.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1200 def associate_virtual_interface(params = {}, = {}) req = build_request(:associate_virtual_interface, params) req.send_request() end |
#confirm_connection(params = {}) ⇒ Types::ConfirmConnectionResponse
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.
1233 1234 1235 1236 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1233 def confirm_connection(params = {}, = {}) req = build_request(:confirm_connection, params) req.send_request() end |
#confirm_private_virtual_interface(params = {}) ⇒ Types::ConfirmPrivateVirtualInterfaceResponse
Accepts ownership of a private virtual interface created by another AWS 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.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1275 def confirm_private_virtual_interface(params = {}, = {}) req = build_request(:confirm_private_virtual_interface, params) req.send_request() end |
#confirm_public_virtual_interface(params = {}) ⇒ Types::ConfirmPublicVirtualInterfaceResponse
Accepts ownership of a public virtual interface created by another AWS account.
After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1307 def confirm_public_virtual_interface(params = {}, = {}) req = build_request(:confirm_public_virtual_interface, params) req.send_request() end |
#confirm_transit_virtual_interface(params = {}) ⇒ Types::ConfirmTransitVirtualInterfaceResponse
Accepts ownership of a transit virtual interface created by another AWS 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.
1344 1345 1346 1347 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1344 def confirm_transit_virtual_interface(params = {}, = {}) req = build_request(:confirm_transit_virtual_interface, params) req.send_request() end |
#create_bgp_peer(params = {}) ⇒ Types::CreateBGPPeerResponse
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 AWS 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.
For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1433 def create_bgp_peer(params = {}, = {}) req = build_request(:create_bgp_peer, params) req.send_request() end |
#create_connection(params = {}) ⇒ Types::Connection
Creates a connection between a customer network and a specific AWS Direct Connect location.
A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS 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 AWS 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.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1535 def create_connection(params = {}, = {}) req = build_request(:create_connection, params) req.send_request() end |
#create_direct_connect_gateway(params = {}) ⇒ Types::CreateDirectConnectGatewayResult
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 AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS 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.
1582 1583 1584 1585 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1582 def create_direct_connect_gateway(params = {}, = {}) req = build_request(:create_direct_connect_gateway, params) req.send_request() end |
#create_direct_connect_gateway_association(params = {}) ⇒ Types::CreateDirectConnectGatewayAssociationResult
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.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1651 def create_direct_connect_gateway_association(params = {}, = {}) req = build_request(:create_direct_connect_gateway_association, params) req.send_request() end |
#create_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::CreateDirectConnectGatewayAssociationProposalResult
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 AWS account.
1719 1720 1721 1722 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1719 def create_direct_connect_gateway_association_proposal(params = {}, = {}) req = build_request(:create_direct_connect_gateway_association_proposal, params) req.send_request() end |
#create_interconnect(params = {}) ⇒ Types::Interconnect
Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS 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 AWS 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 AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1826 def create_interconnect(params = {}, = {}) req = build_request(:create_interconnect, params) req.send_request() end |
#create_lag(params = {}) ⇒ Types::Lag
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific AWS 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 or 10Gbps) and must terminate at the same AWS Direct Connect endpoint.
You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS 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 AWS 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 AWS account used to create a LAG is a registered AWS 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.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1974 def create_lag(params = {}, = {}) req = build_request(:create_lag, params) req.send_request() end |
#create_private_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Creates a private virtual interface. A virtual interface is the VLAN that transports AWS 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 AWS 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 9001 (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.
2097 2098 2099 2100 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2097 def create_private_virtual_interface(params = {}, = {}) req = build_request(:create_private_virtual_interface, params) req.send_request() end |
#create_public_virtual_interface(params = {}) ⇒ Types::VirtualInterface
Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS 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.
2212 2213 2214 2215 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2212 def create_public_virtual_interface(params = {}, = {}) req = build_request(:create_public_virtual_interface, params) req.send_request() end |
#create_transit_virtual_interface(params = {}) ⇒ Types::CreateTransitVirtualInterfaceResult
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.
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.
2314 2315 2316 2317 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2314 def create_transit_virtual_interface(params = {}, = {}) req = build_request(:create_transit_virtual_interface, params) req.send_request() end |
#delete_bgp_peer(params = {}) ⇒ Types::DeleteBGPPeerResponse
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.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2393 def delete_bgp_peer(params = {}, = {}) req = build_request(:delete_bgp_peer, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Types::Connection
Deletes the specified connection.
Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.
2460 2461 2462 2463 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2460 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() end |
#delete_direct_connect_gateway(params = {}) ⇒ Types::DeleteDirectConnectGatewayResult
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.
2496 2497 2498 2499 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2496 def delete_direct_connect_gateway(params = {}, = {}) req = build_request(:delete_direct_connect_gateway, params) req.send_request() end |
#delete_direct_connect_gateway_association(params = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationResult
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.
2551 2552 2553 2554 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2551 def delete_direct_connect_gateway_association(params = {}, = {}) req = build_request(:delete_direct_connect_gateway_association, params) req.send_request() end |
#delete_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationProposalResult
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
2591 2592 2593 2594 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2591 def delete_direct_connect_gateway_association_proposal(params = {}, = {}) req = build_request(:delete_direct_connect_gateway_association_proposal, params) req.send_request() end |
#delete_interconnect(params = {}) ⇒ Types::DeleteInterconnectResponse
Deletes the specified interconnect.
2623 2624 2625 2626 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2623 def delete_interconnect(params = {}, = {}) req = build_request(:delete_interconnect, params) req.send_request() end |
#delete_lag(params = {}) ⇒ Types::Lag
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
2705 2706 2707 2708 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2705 def delete_lag(params = {}, = {}) req = build_request(:delete_lag, params) req.send_request() end |
#delete_virtual_interface(params = {}) ⇒ Types::DeleteVirtualInterfaceResponse
Deletes a virtual interface.
2733 2734 2735 2736 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2733 def delete_virtual_interface(params = {}, = {}) req = build_request(:delete_virtual_interface, params) req.send_request() end |
#describe_connection_loa(params = {}) ⇒ Types::DescribeConnectionLoaResponse
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 AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
2786 2787 2788 2789 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2786 def describe_connection_loa(params = {}, = {}) req = build_request(:describe_connection_loa, params) req.send_request() end |
#describe_connections(params = {}) ⇒ Types::Connections
Displays the specified connection or all connections in this Region.
2833 2834 2835 2836 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2833 def describe_connections(params = {}, = {}) req = build_request(:describe_connections, params) req.send_request() end |
#describe_connections_on_interconnect(params = {}) ⇒ Types::Connections
Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
2887 2888 2889 2890 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2887 def describe_connections_on_interconnect(params = {}, = {}) req = build_request(:describe_connections_on_interconnect, params) req.send_request() end |
#describe_direct_connect_gateway_association_proposals(params = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationProposalsResult
Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2952 def describe_direct_connect_gateway_association_proposals(params = {}, = {}) req = build_request(:describe_direct_connect_gateway_association_proposals, params) req.send_request() end |
#describe_direct_connect_gateway_associations(params = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationsResult
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.
3046 3047 3048 3049 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3046 def describe_direct_connect_gateway_associations(params = {}, = {}) req = build_request(:describe_direct_connect_gateway_associations, params) req.send_request() end |
#describe_direct_connect_gateway_attachments(params = {}) ⇒ Types::DescribeDirectConnectGatewayAttachmentsResult
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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3107 def (params = {}, = {}) req = build_request(:describe_direct_connect_gateway_attachments, params) req.send_request() end |
#describe_direct_connect_gateways(params = {}) ⇒ Types::DescribeDirectConnectGatewaysResult
Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
3157 3158 3159 3160 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3157 def describe_direct_connect_gateways(params = {}, = {}) req = build_request(:describe_direct_connect_gateways, params) req.send_request() end |
#describe_hosted_connections(params = {}) ⇒ Types::Connections
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
3209 3210 3211 3212 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3209 def describe_hosted_connections(params = {}, = {}) req = build_request(:describe_hosted_connections, params) req.send_request() end |
#describe_interconnect_loa(params = {}) ⇒ Types::DescribeInterconnectLoaResponse
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 AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
3262 3263 3264 3265 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3262 def describe_interconnect_loa(params = {}, = {}) req = build_request(:describe_interconnect_loa, params) req.send_request() end |
#describe_interconnects(params = {}) ⇒ Types::Interconnects
Lists the interconnects owned by the AWS account or only the specified interconnect.
3307 3308 3309 3310 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3307 def describe_interconnects(params = {}, = {}) req = build_request(:describe_interconnects, params) req.send_request() end |
#describe_lags(params = {}) ⇒ Types::Lags
Describes all your link aggregation groups (LAG) or the specified LAG.
3373 3374 3375 3376 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3373 def describe_lags(params = {}, = {}) req = build_request(:describe_lags, params) req.send_request() end |
#describe_loa(params = {}) ⇒ Types::Loa
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 AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
3426 3427 3428 3429 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3426 def describe_loa(params = {}, = {}) req = build_request(:describe_loa, params) req.send_request() end |
#describe_locations(params = {}) ⇒ Types::Locations
Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
3454 3455 3456 3457 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3454 def describe_locations(params = {}, = {}) req = build_request(:describe_locations, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::DescribeTagsResponse
Describes the tags associated with the specified AWS Direct Connect resources.
3487 3488 3489 3490 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3487 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_virtual_gateways(params = {}) ⇒ Types::VirtualGateways
Lists the virtual private gateways owned by the AWS account.
You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.
3511 3512 3513 3514 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3511 def describe_virtual_gateways(params = {}, = {}) req = build_request(:describe_virtual_gateways, params) req.send_request() end |
#describe_virtual_interfaces(params = {}) ⇒ Types::VirtualInterfaces
Displays all virtual interfaces for an AWS 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 AWS Direct Connect location and the customer network.
3586 3587 3588 3589 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3586 def describe_virtual_interfaces(params = {}, = {}) req = build_request(:describe_virtual_interfaces, params) req.send_request() end |
#disassociate_connection_from_lag(params = {}) ⇒ Types::Connection
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 AWS 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.
3664 3665 3666 3667 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3664 def disassociate_connection_from_lag(params = {}, = {}) req = build_request(:disassociate_connection_from_lag, params) req.send_request() end |
#list_virtual_interface_test_history(params = {}) ⇒ Types::ListVirtualInterfaceTestHistoryResponse
Lists the virtual interface failover test history.
3729 3730 3731 3732 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3729 def list_virtual_interface_test_history(params = {}, = {}) req = build_request(:list_virtual_interface_test_history, params) req.send_request() end |
#start_bgp_failover_test(params = {}) ⇒ Types::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.
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.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3795 def start_bgp_failover_test(params = {}, = {}) req = build_request(:start_bgp_failover_test, params) req.send_request() end |
#stop_bgp_failover_test(params = {}) ⇒ Types::StopBgpFailoverTestResponse
Stops the virtual interface failover test.
3831 3832 3833 3834 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3831 def stop_bgp_failover_test(params = {}, = {}) req = build_request(:stop_bgp_failover_test, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified AWS 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.
3867 3868 3869 3870 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3867 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified AWS Direct Connect resource.
3894 3895 3896 3897 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3894 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_direct_connect_gateway_association(params = {}) ⇒ Types::UpdateDirectConnectGatewayAssociationResult
Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
3955 3956 3957 3958 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3955 def update_direct_connect_gateway_association(params = {}, = {}) req = build_request(:update_direct_connect_gateway_association, params) req.send_request() end |
#update_lag(params = {}) ⇒ Types::Lag
Updates the attributes of the specified link aggregation group (LAG).
You can update the following 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.
When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 4060 def update_lag(params = {}, = {}) req = build_request(:update_lag, params) req.send_request() end |
#update_virtual_interface_attributes(params = {}) ⇒ Types::VirtualInterface
Updates the specified attributes of the specified virtual private interface.
Setting the MTU of a virtual interface to 9001 (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 q interface supports jumbo frames, call DescribeVirtualInterfaces.
4161 4162 4163 4164 |
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 4161 def update_virtual_interface_attributes(params = {}, = {}) req = build_request(:update_virtual_interface_attributes, params) req.send_request() end |