You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DirectConnect::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::DirectConnect::Client

show all

Defined in:: (unknown)

Overview

An API client for AWS Direct Connect. To construct a client, you need to configure a :region and :credentials.

directconnect = Aws::DirectConnect::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::DirectConnect::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::DirectConnect::Client constructor
Constructs an API client.

API Operations collapse

#accept_direct_connect_gateway_association_proposal(options = {}) ⇒ Types::AcceptDirectConnectGatewayAssociationProposalResult
Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

.
#allocate_connection_on_interconnect(options = {}) ⇒ Types::Connection
Deprecated.
#allocate_hosted_connection(options = {}) ⇒ 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.
#allocate_private_virtual_interface(options = {}) ⇒ 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.
#allocate_public_virtual_interface(options = {}) ⇒ 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.
#allocate_transit_virtual_interface(options = {}) ⇒ Types::AllocateTransitVirtualInterfaceResult
Provisions a transit virtual interface to be owned by the specified AWS account.
#associate_connection_with_lag(options = {}) ⇒ Types::Connection
Associates an existing connection with a link aggregation group (LAG).
#associate_hosted_connection(options = {}) ⇒ Types::Connection
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
#associate_virtual_interface(options = {}) ⇒ Types::VirtualInterface
Associates a virtual interface with a specified link aggregation group (LAG) or connection.
#confirm_connection(options = {}) ⇒ 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.
.
#confirm_private_virtual_interface(options = {}) ⇒ 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.
.
#confirm_public_virtual_interface(options = {}) ⇒ 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.
.
#confirm_transit_virtual_interface(options = {}) ⇒ 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.
.
#create_bgp_peer(options = {}) ⇒ 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.
#create_connection(options = {}) ⇒ 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.
#create_direct_connect_gateway(options = {}) ⇒ 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(options = {}) ⇒ Types::CreateDirectConnectGatewayAssociationResult
Creates an association between a Direct Connect gateway and a virtual private gateway.
#create_direct_connect_gateway_association_proposal(options = {}) ⇒ 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.
#create_interconnect(options = {}) ⇒ 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.
#create_lag(options = {}) ⇒ 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(options = {}) ⇒ Types::VirtualInterface
Creates a private virtual interface.
#create_public_virtual_interface(options = {}) ⇒ Types::VirtualInterface
Creates a public virtual interface.
#create_transit_virtual_interface(options = {}) ⇒ Types::CreateTransitVirtualInterfaceResult
Creates a transit virtual interface.
#delete_bgp_peer(options = {}) ⇒ 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.
.
#delete_connection(options = {}) ⇒ Types::Connection
Deletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges.
#delete_direct_connect_gateway(options = {}) ⇒ Types::DeleteDirectConnectGatewayResult
Deletes the specified Direct Connect gateway.
#delete_direct_connect_gateway_association(options = {}) ⇒ 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.
#delete_direct_connect_gateway_association_proposal(options = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationProposalResult
Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

.
#delete_interconnect(options = {}) ⇒ Types::DeleteInterconnectResponse
Deletes the specified interconnect.

Intended for use by AWS Direct Connect Partners only.
.
#delete_lag(options = {}) ⇒ Types::Lag
Deletes the specified link aggregation group (LAG).
#delete_virtual_interface(options = {}) ⇒ Types::DeleteVirtualInterfaceResponse
Deletes a virtual interface.

.
#describe_connection_loa(options = {}) ⇒ Types::DescribeConnectionLoaResponse
Deprecated.
#describe_connections(options = {}) ⇒ Types::Connections
Displays the specified connection or all connections in this Region.

.
#describe_connections_on_interconnect(options = {}) ⇒ Types::Connections
Deprecated.
#describe_direct_connect_gateway_association_proposals(options = {}) ⇒ 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(options = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationsResult
Lists the associations between your Direct Connect gateways and virtual private gateways.
#describe_direct_connect_gateway_attachments(options = {}) ⇒ Types::DescribeDirectConnectGatewayAttachmentsResult
Lists the attachments between your Direct Connect gateways and virtual interfaces.
#describe_direct_connect_gateways(options = {}) ⇒ Types::DescribeDirectConnectGatewaysResult
Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
#describe_hosted_connections(options = {}) ⇒ Types::Connections
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by AWS Direct Connect Partners only.
.
#describe_interconnect_loa(options = {}) ⇒ Types::DescribeInterconnectLoaResponse
Deprecated.
#describe_interconnects(options = {}) ⇒ Types::Interconnects
Lists the interconnects owned by the AWS account or only the specified interconnect.

.
#describe_lags(options = {}) ⇒ Types::Lags
Describes all your link aggregation groups (LAG) or the specified LAG.

.
#describe_loa(options = {}) ⇒ 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.
#describe_locations(options = {}) ⇒ Types::Locations
Lists the AWS Direct Connect locations in the current AWS Region.
#describe_tags(options = {}) ⇒ Types::DescribeTagsResponse
Describes the tags associated with the specified AWS Direct Connect resources.

.
#describe_virtual_gateways(options = {}) ⇒ 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.
.
#describe_virtual_interfaces(options = {}) ⇒ Types::VirtualInterfaces
Displays all virtual interfaces for an AWS account.
#disassociate_connection_from_lag(options = {}) ⇒ Types::Connection
Disassociates a connection from a link aggregation group (LAG).
#list_virtual_interface_test_history(options = {}) ⇒ Types::ListVirtualInterfaceTestHistoryResponse
Lists the virtual interface failover test history.

.
#start_bgp_failover_test(options = {}) ⇒ 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(options = {}) ⇒ Types::StopBgpFailoverTestResponse
Stops the virtual interface failover test.

.
#tag_resource(options = {}) ⇒ Struct
Adds the specified tags to the specified AWS Direct Connect resource.
#untag_resource(options = {}) ⇒ Struct
Removes one or more tags from the specified AWS Direct Connect resource.

.
#update_direct_connect_gateway_association(options = {}) ⇒ Types::UpdateDirectConnectGatewayAssociationResult
Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.
.
#update_lag(options = {}) ⇒ 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.
#update_virtual_interface_attributes(options = {}) ⇒ 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.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::DirectConnect::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#accept_direct_connect_gateway_association_proposal(options = {}) ⇒ `Types::AcceptDirectConnectGatewayAssociationProposalResult`

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

Examples:

Request syntax with placeholder values


resp = client.accept_direct_connect_gateway_association_proposal({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
  proposal_id: "DirectConnectGatewayAssociationProposalId", # required
  associated_gateway_owner_account: "OwnerAccount", # required
  override_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association.direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association.virtual_gateway_owner_account #=> String

Options Hash (options):

:direct_connect_gateway_id (required, String) —
The ID of the Direct Connect gateway.
:proposal_id (required, String) —
The ID of the request proposal.
:associated_gateway_owner_account (required, String) —
The ID of the AWS account that owns the virtual private gateway or transit gateway.
:override_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>) —
Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

Returns:

(Types::AcceptDirectConnectGatewayAssociationProposalResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association => Types::DirectConnectGatewayAssociation

See Also:

AWS API Documentation

#allocate_connection_on_interconnect(options = {}) ⇒ `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.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.allocate_connection_on_interconnect({
  bandwidth: "Bandwidth", # required
  connection_name: "ConnectionName", # required
  owner_account: "OwnerAccount", # required
  interconnect_id: "InterconnectId", # required
  vlan: 1, # required
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:bandwidth (required, String) —
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
:connection_name (required, String) —
The name of the provisioned connection.
:owner_account (required, String) —
The ID of the AWS account of the customer for whom the connection will be provisioned.
:interconnect_id (required, String) —
The ID of the interconnect on which the connection will be provisioned.
:vlan (required, Integer) —
The dedicated VLAN provisioned to the connection.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#allocate_hosted_connection(options = {}) ⇒ `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.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.allocate_hosted_connection({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  bandwidth: "Bandwidth", # required
  connection_name: "ConnectionName", # required
  vlan: 1, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the interconnect or LAG.
:owner_account (required, String) —
The ID of the AWS account ID of the customer for the connection.
:bandwidth (required, String) —
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
:connection_name (required, String) —
The name of the hosted connection.
:vlan (required, Integer) —
The dedicated VLAN provisioned to the hosted connection.
:tags (Array<Types::Tag>) —
The tags associated with the connection.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#allocate_private_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.allocate_private_virtual_interface({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  new_private_virtual_interface_allocation: { # required
    virtual_interface_name: "VirtualInterfaceName", # required
    vlan: 1, # required
    asn: 1, # required
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    customer_address: "CustomerAddress",
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.owner_account #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> true/false
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection on which the private virtual interface is provisioned.
:owner_account (required, String) —
The ID of the AWS account that owns the virtual private interface.
:new_private_virtual_interface_allocation (required, Types::NewPrivateVirtualInterfaceAllocation) —
Information about the private virtual interface.

Returns:

(Types::VirtualInterface) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #virtual_interface_id => String
- #location => String
- #connection_id => String
- #virtual_interface_type => String
- #virtual_interface_name => String
- #vlan => Integer
- #asn => Integer
- #amazon_side_asn => Integer
- #auth_key => String
- #amazon_address => String
- #customer_address => String
- #address_family => String
- #virtual_interface_state => String
- #customer_router_config => String
- #mtu => Integer
- #jumbo_frame_capable => Boolean
- #virtual_gateway_id => String
- #direct_connect_gateway_id => String
- #route_filter_prefixes => Array<Types::RouteFilterPrefix>
- #bgp_peers => Array<Types::BGPPeer>
- #region => String
- #aws_device_v2 => String
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

#allocate_public_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.allocate_public_virtual_interface({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  new_public_virtual_interface_allocation: { # required
    virtual_interface_name: "VirtualInterfaceName", # required
    vlan: 1, # required
    asn: 1, # required
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    route_filter_prefixes: [
      {
        cidr: "CIDR",
      },
    ],
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.owner_account #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> true/false
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection on which the public virtual interface is provisioned.
:owner_account (required, String) —
The ID of the AWS account that owns the public virtual interface.
:new_public_virtual_interface_allocation (required, Types::NewPublicVirtualInterfaceAllocation) —
Information about the public virtual interface.

Returns:

(Types::VirtualInterface) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #virtual_interface_id => String
- #location => String
- #connection_id => String
- #virtual_interface_type => String
- #virtual_interface_name => String
- #vlan => Integer
- #asn => Integer
- #amazon_side_asn => Integer
- #auth_key => String
- #amazon_address => String
- #customer_address => String
- #address_family => String
- #virtual_interface_state => String
- #customer_router_config => String
- #mtu => Integer
- #jumbo_frame_capable => Boolean
- #virtual_gateway_id => String
- #direct_connect_gateway_id => String
- #route_filter_prefixes => Array<Types::RouteFilterPrefix>
- #bgp_peers => Array<Types::BGPPeer>
- #region => String
- #aws_device_v2 => String
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

#allocate_transit_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.allocate_transit_virtual_interface({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  new_transit_virtual_interface_allocation: { # required
    virtual_interface_name: "VirtualInterfaceName",
    vlan: 1,
    asn: 1,
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.virtual_interface.owner_account #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> true/false
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection on which the transit virtual interface is provisioned.
:owner_account (required, String) —
The ID of the AWS account that owns the transit virtual interface.
:new_transit_virtual_interface_allocation (required, Types::NewTransitVirtualInterfaceAllocation) —
Information about the transit virtual interface.

Returns:

(Types::AllocateTransitVirtualInterfaceResult) —
Returns a response object which responds to the following methods:
- #virtual_interface => Types::VirtualInterface

See Also:

AWS API Documentation

#associate_connection_with_lag(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.associate_connection_with_lag({
  connection_id: "ConnectionId", # required
  lag_id: "LagId", # required
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.
:lag_id (required, String) —
The ID of the LAG with which to associate the connection.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#associate_hosted_connection(options = {}) ⇒ `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.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.associate_hosted_connection({
  connection_id: "ConnectionId", # required
  parent_connection_id: "ConnectionId", # required
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the hosted connection.
:parent_connection_id (required, String) —
The ID of the interconnect or the LAG.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#associate_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.associate_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
  connection_id: "ConnectionId", # required
})

Response structure


resp.owner_account #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> true/false
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface.
:connection_id (required, String) —
The ID of the LAG or connection.

Returns:

(Types::VirtualInterface) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #virtual_interface_id => String
- #location => String
- #connection_id => String
- #virtual_interface_type => String
- #virtual_interface_name => String
- #vlan => Integer
- #asn => Integer
- #amazon_side_asn => Integer
- #auth_key => String
- #amazon_address => String
- #customer_address => String
- #address_family => String
- #virtual_interface_state => String
- #customer_router_config => String
- #mtu => Integer
- #jumbo_frame_capable => Boolean
- #virtual_gateway_id => String
- #direct_connect_gateway_id => String
- #route_filter_prefixes => Array<Types::RouteFilterPrefix>
- #bgp_peers => Array<Types::BGPPeer>
- #region => String
- #aws_device_v2 => String
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

#confirm_connection(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.confirm_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Options Hash (options):

:connection_id (required, String) —
The ID of the hosted connection.

Returns:

(Types::ConfirmConnectionResponse) —
Returns a response object which responds to the following methods:
- #connection_state => String

See Also:

AWS API Documentation

#confirm_private_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.confirm_private_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
  virtual_gateway_id: "VirtualGatewayId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface.
:virtual_gateway_id (String) —
The ID of the virtual private gateway.
:direct_connect_gateway_id (String) —
The ID of the Direct Connect gateway.

Returns:

(Types::ConfirmPrivateVirtualInterfaceResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_state => String

See Also:

AWS API Documentation

#confirm_public_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.confirm_public_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface.

Returns:

(Types::ConfirmPublicVirtualInterfaceResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_state => String

See Also:

AWS API Documentation

#confirm_transit_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.confirm_transit_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface.
:direct_connect_gateway_id (required, String) —
The ID of the Direct Connect gateway.

Returns:

(Types::ConfirmTransitVirtualInterfaceResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_state => String

See Also:

AWS API Documentation

#create_bgp_peer(options = {}) ⇒ `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 whitelisted for the virtual interface.

Examples:

Request syntax with placeholder values


resp = client.create_bgp_peer({
  virtual_interface_id: "VirtualInterfaceId",
  new_bgp_peer: {
    asn: 1,
    auth_key: "BGPAuthKey",
    address_family: "ipv4", # accepts ipv4, ipv6
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
  },
})

Response structure


resp.virtual_interface.owner_account #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> true/false
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Options Hash (options):

:virtual_interface_id (String) —
The ID of the virtual interface.
:new_bgp_peer (Types::NewBGPPeer) —
Information about the BGP peer.

Returns:

(Types::CreateBGPPeerResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface => Types::VirtualInterface

See Also:

AWS API Documentation

#create_connection(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  location: "LocationCode", # required
  bandwidth: "Bandwidth", # required
  connection_name: "ConnectionName", # required
  lag_id: "LagId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  provider_name: "ProviderName",
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:location (required, String) —
The location of the connection.
:bandwidth (required, String) —
The bandwidth of the connection.
:connection_name (required, String) —
The name of the connection.
:lag_id (String) —
The ID of the LAG.
:tags (Array<Types::Tag>) —
The tags to associate with the lag.
:provider_name (String) —
The name of the service provider associated with the requested connection.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#create_direct_connect_gateway(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_direct_connect_gateway({
  direct_connect_gateway_name: "DirectConnectGatewayName", # required
  amazon_side_asn: 1,
})

Response structure


resp.direct_connect_gateway.direct_connect_gateway_id #=> String
resp.direct_connect_gateway.direct_connect_gateway_name #=> String
resp.direct_connect_gateway.amazon_side_asn #=> Integer
resp.direct_connect_gateway.owner_account #=> String
resp.direct_connect_gateway.direct_connect_gateway_state #=> String, one of "pending", "available", "deleting", "deleted"
resp.direct_connect_gateway.state_change_error #=> String

Options Hash (options):

:direct_connect_gateway_name (required, String) —
The name of the Direct Connect gateway.
:amazon_side_asn (Integer) —
The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

Returns:

(Types::CreateDirectConnectGatewayResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway => Types::DirectConnectGateway

See Also:

AWS API Documentation

#create_direct_connect_gateway_association(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_direct_connect_gateway_association({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
  gateway_id: "GatewayIdToAssociate",
  add_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
  virtual_gateway_id: "VirtualGatewayId",
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association.direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association.virtual_gateway_owner_account #=> String

Options Hash (options):

:direct_connect_gateway_id (required, String) —
The ID of the Direct Connect gateway.
:gateway_id (String) —
The ID of the virtual private gateway or transit gateway.
:add_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>) —
The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
:virtual_gateway_id (String) —
The ID of the virtual private gateway.

Returns:

(Types::CreateDirectConnectGatewayAssociationResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association => Types::DirectConnectGatewayAssociation

See Also:

AWS API Documentation

#create_direct_connect_gateway_association_proposal(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_direct_connect_gateway_association_proposal({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
  direct_connect_gateway_owner_account: "OwnerAccount", # required
  gateway_id: "GatewayIdToAssociate", # required
  add_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
  remove_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
})

Response structure


resp.direct_connect_gateway_association_proposal.proposal_id #=> String
resp.direct_connect_gateway_association_proposal.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association_proposal.direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association_proposal.proposal_state #=> String, one of "requested", "accepted", "deleted"
resp.direct_connect_gateway_association_proposal.associated_gateway.id #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association_proposal.associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.region #=> String
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String

Options Hash (options):

:direct_connect_gateway_id (required, String) —
The ID of the Direct Connect gateway.
:direct_connect_gateway_owner_account (required, String) —
The ID of the AWS account that owns the Direct Connect gateway.
:gateway_id (required, String) —
The ID of the virtual private gateway or transit gateway.
:add_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>) —
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
:remove_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>) —
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

Returns:

(Types::CreateDirectConnectGatewayAssociationProposalResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association_proposal => Types::DirectConnectGatewayAssociationProposal

See Also:

AWS API Documentation

#create_interconnect(options = {}) ⇒ `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.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.create_interconnect({
  interconnect_name: "InterconnectName", # required
  bandwidth: "Bandwidth", # required
  location: "LocationCode", # required
  lag_id: "LagId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  provider_name: "ProviderName",
})

Response structure


resp.interconnect_id #=> String
resp.interconnect_name #=> String
resp.interconnect_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:interconnect_name (required, String) —
The name of the interconnect.
:bandwidth (required, String) —
The port bandwidth, in Gbps. The possible values are 1 and 10.
:location (required, String) —
The location of the interconnect.
:lag_id (String) —
The ID of the LAG.
:tags (Array<Types::Tag>) —
The tags to associate with the interconnect.
:provider_name (String) —
The name of the service provider associated with the interconnect.

Returns:

(Types::Interconnect) —
Returns a response object which responds to the following methods:
- #interconnect_id => String
- #interconnect_name => String
- #interconnect_state => String
- #region => String
- #location => String
- #bandwidth => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#create_lag(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_lag({
  number_of_connections: 1, # required
  location: "LocationCode", # required
  connections_bandwidth: "Bandwidth", # required
  lag_name: "LagName", # required
  connection_id: "ConnectionId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  child_connection_tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  provider_name: "ProviderName",
})

Response structure


resp.connections_bandwidth #=> String
resp.number_of_connections #=> Integer
resp.lag_id #=> String
resp.owner_account #=> String
resp.lag_name #=> String
resp.lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.location #=> String
resp.region #=> String
resp.minimum_links #=> Integer
resp.aws_device #=> String
resp.aws_device_v2 #=> String
resp.connections #=> Array
resp.connections[0].owner_account #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> true/false
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String
resp.allows_hosted_connections #=> true/false
resp.jumbo_frame_capable #=> true/false
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:number_of_connections (required, Integer) —
The number of physical dedicated connections initially provisioned and bundled by the LAG.
:location (required, String) —
The location for the LAG.
:connections_bandwidth (required, String) —
The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
:lag_name (required, String) —
The name of the LAG.
:connection_id (String) —
The ID of an existing dedicated connection to migrate to the LAG.
:tags (Array<Types::Tag>) —
The tags to associate with the LAG.
:child_connection_tags (Array<Types::Tag>) —
The tags to associate with the automtically created LAGs.
:provider_name (String) —
The name of the service provider associated with the LAG.

Returns:

(Types::Lag) —
Returns a response object which responds to the following methods:
- #connections_bandwidth => String
- #number_of_connections => Integer
- #lag_id => String
- #owner_account => String
- #lag_name => String
- #lag_state => String
- #location => String
- #region => String
- #minimum_links => Integer
- #aws_device => String
- #aws_device_v2 => String
- #connections => Array<Types::Connection>
- #allows_hosted_connections => Boolean
- #jumbo_frame_capable => Boolean
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#create_private_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_private_virtual_interface({
  connection_id: "ConnectionId", # required
  new_private_virtual_interface: { # required
    virtual_interface_name: "VirtualInterfaceName", # required
    vlan: 1, # required
    asn: 1, # required
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    virtual_gateway_id: "VirtualGatewayId",
    direct_connect_gateway_id: "DirectConnectGatewayId",
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.owner_account #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> true/false
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.
:new_private_virtual_interface (required, Types::NewPrivateVirtualInterface) —
Information about the private virtual interface.

Returns:

(Types::VirtualInterface) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #virtual_interface_id => String
- #location => String
- #connection_id => String
- #virtual_interface_type => String
- #virtual_interface_name => String
- #vlan => Integer
- #asn => Integer
- #amazon_side_asn => Integer
- #auth_key => String
- #amazon_address => String
- #customer_address => String
- #address_family => String
- #virtual_interface_state => String
- #customer_router_config => String
- #mtu => Integer
- #jumbo_frame_capable => Boolean
- #virtual_gateway_id => String
- #direct_connect_gateway_id => String
- #route_filter_prefixes => Array<Types::RouteFilterPrefix>
- #bgp_peers => Array<Types::BGPPeer>
- #region => String
- #aws_device_v2 => String
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

#create_public_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_public_virtual_interface({
  connection_id: "ConnectionId", # required
  new_public_virtual_interface: { # required
    virtual_interface_name: "VirtualInterfaceName", # required
    vlan: 1, # required
    asn: 1, # required
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    route_filter_prefixes: [
      {
        cidr: "CIDR",
      },
    ],
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.owner_account #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> true/false
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.
:new_public_virtual_interface (required, Types::NewPublicVirtualInterface) —
Information about the public virtual interface.

Returns:

(Types::VirtualInterface) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #virtual_interface_id => String
- #location => String
- #connection_id => String
- #virtual_interface_type => String
- #virtual_interface_name => String
- #vlan => Integer
- #asn => Integer
- #amazon_side_asn => Integer
- #auth_key => String
- #amazon_address => String
- #customer_address => String
- #address_family => String
- #virtual_interface_state => String
- #customer_router_config => String
- #mtu => Integer
- #jumbo_frame_capable => Boolean
- #virtual_gateway_id => String
- #direct_connect_gateway_id => String
- #route_filter_prefixes => Array<Types::RouteFilterPrefix>
- #bgp_peers => Array<Types::BGPPeer>
- #region => String
- #aws_device_v2 => String
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

#create_transit_virtual_interface(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.create_transit_virtual_interface({
  connection_id: "ConnectionId", # required
  new_transit_virtual_interface: { # required
    virtual_interface_name: "VirtualInterfaceName",
    vlan: 1,
    asn: 1,
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    direct_connect_gateway_id: "DirectConnectGatewayId",
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.virtual_interface.owner_account #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> true/false
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.
:new_transit_virtual_interface (required, Types::NewTransitVirtualInterface) —
Information about the transit virtual interface.

Returns:

(Types::CreateTransitVirtualInterfaceResult) —
Returns a response object which responds to the following methods:
- #virtual_interface => Types::VirtualInterface

See Also:

AWS API Documentation

#delete_bgp_peer(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.delete_bgp_peer({
  virtual_interface_id: "VirtualInterfaceId",
  asn: 1,
  customer_address: "CustomerAddress",
  bgp_peer_id: "BGPPeerId",
})

Response structure


resp.virtual_interface.owner_account #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> true/false
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Options Hash (options):

:virtual_interface_id (String) —
The ID of the virtual interface.
:asn (Integer) —
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
:customer_address (String) —
The IP address assigned to the customer interface.
:bgp_peer_id (String) —
The ID of the BGP peer.

Returns:

(Types::DeleteBGPPeerResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface => Types::VirtualInterface

See Also:

AWS API Documentation

#delete_connection(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#delete_direct_connect_gateway(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.delete_direct_connect_gateway({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
})

Response structure


resp.direct_connect_gateway.direct_connect_gateway_id #=> String
resp.direct_connect_gateway.direct_connect_gateway_name #=> String
resp.direct_connect_gateway.amazon_side_asn #=> Integer
resp.direct_connect_gateway.owner_account #=> String
resp.direct_connect_gateway.direct_connect_gateway_state #=> String, one of "pending", "available", "deleting", "deleted"
resp.direct_connect_gateway.state_change_error #=> String

Options Hash (options):

:direct_connect_gateway_id (required, String) —
The ID of the Direct Connect gateway.

Returns:

(Types::DeleteDirectConnectGatewayResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway => Types::DirectConnectGateway

See Also:

AWS API Documentation

#delete_direct_connect_gateway_association(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.delete_direct_connect_gateway_association({
  association_id: "DirectConnectGatewayAssociationId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
  virtual_gateway_id: "VirtualGatewayId",
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association.direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association.virtual_gateway_owner_account #=> String

Options Hash (options):

:association_id (String) —
The ID of the Direct Connect gateway association.
:direct_connect_gateway_id (String) —
The ID of the Direct Connect gateway.
:virtual_gateway_id (String) —
The ID of the virtual private gateway.

Returns:

(Types::DeleteDirectConnectGatewayAssociationResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association => Types::DirectConnectGatewayAssociation

See Also:

AWS API Documentation

#delete_direct_connect_gateway_association_proposal(options = {}) ⇒ `Types::DeleteDirectConnectGatewayAssociationProposalResult`

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

Examples:

Request syntax with placeholder values


resp = client.delete_direct_connect_gateway_association_proposal({
  proposal_id: "DirectConnectGatewayAssociationProposalId", # required
})

Response structure


resp.direct_connect_gateway_association_proposal.proposal_id #=> String
resp.direct_connect_gateway_association_proposal.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association_proposal.direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association_proposal.proposal_state #=> String, one of "requested", "accepted", "deleted"
resp.direct_connect_gateway_association_proposal.associated_gateway.id #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association_proposal.associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.region #=> String
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String

Options Hash (options):

:proposal_id (required, String) —
The ID of the proposal.

Returns:

(Types::DeleteDirectConnectGatewayAssociationProposalResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association_proposal => Types::DirectConnectGatewayAssociationProposal

See Also:

AWS API Documentation

#delete_interconnect(options = {}) ⇒ `Types::DeleteInterconnectResponse`

Deletes the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.delete_interconnect({
  interconnect_id: "InterconnectId", # required
})

Response structure


resp.interconnect_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"

Options Hash (options):

:interconnect_id (required, String) —
The ID of the interconnect.

Returns:

(Types::DeleteInterconnectResponse) —
Returns a response object which responds to the following methods:
- #interconnect_state => String

See Also:

AWS API Documentation

#delete_lag(options = {}) ⇒ `Types::Lag`

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

Examples:

Request syntax with placeholder values


resp = client.delete_lag({
  lag_id: "LagId", # required
})

Response structure


resp.connections_bandwidth #=> String
resp.number_of_connections #=> Integer
resp.lag_id #=> String
resp.owner_account #=> String
resp.lag_name #=> String
resp.lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.location #=> String
resp.region #=> String
resp.minimum_links #=> Integer
resp.aws_device #=> String
resp.aws_device_v2 #=> String
resp.connections #=> Array
resp.connections[0].owner_account #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> true/false
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String
resp.allows_hosted_connections #=> true/false
resp.jumbo_frame_capable #=> true/false
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:lag_id (required, String) —
The ID of the LAG.

Returns:

(Types::Lag) —
Returns a response object which responds to the following methods:
- #connections_bandwidth => String
- #number_of_connections => Integer
- #lag_id => String
- #owner_account => String
- #lag_name => String
- #lag_state => String
- #location => String
- #region => String
- #minimum_links => Integer
- #aws_device => String
- #aws_device_v2 => String
- #connections => Array<Types::Connection>
- #allows_hosted_connections => Boolean
- #jumbo_frame_capable => Boolean
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#delete_virtual_interface(options = {}) ⇒ `Types::DeleteVirtualInterfaceResponse`

Deletes a virtual interface.

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface.

Returns:

(Types::DeleteVirtualInterfaceResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_state => String

See Also:

AWS API Documentation

#describe_connection_loa(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_connection_loa({
  connection_id: "ConnectionId", # required
  provider_name: "ProviderName",
  loa_content_type: "application/pdf", # accepts application/pdf
})

Response structure


resp.loa.loa_content #=> IO
resp.loa.loa_content_type #=> String, one of "application/pdf"

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.
:provider_name (String) —
The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
:loa_content_type (String) —
The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Returns:

(Types::DescribeConnectionLoaResponse) —
Returns a response object which responds to the following methods:
- #loa => Types::Loa

See Also:

AWS API Documentation

#describe_connections(options = {}) ⇒ `Types::Connections`

Displays the specified connection or all connections in this Region.

Examples:

Request syntax with placeholder values


resp = client.describe_connections({
  connection_id: "ConnectionId",
})

Response structure


resp.connections #=> Array
resp.connections[0].owner_account #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> true/false
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String

Options Hash (options):

:connection_id (String) —
The ID of the connection.

Returns:

(Types::Connections) —
Returns a response object which responds to the following methods:
- #connections => Array<Types::Connection>

See Also:

AWS API Documentation

#describe_connections_on_interconnect(options = {}) ⇒ `Types::Connections`

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.describe_connections_on_interconnect({
  interconnect_id: "InterconnectId", # required
})

Response structure


resp.connections #=> Array
resp.connections[0].owner_account #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> true/false
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String

Options Hash (options):

:interconnect_id (required, String) —
The ID of the interconnect.

Returns:

(Types::Connections) —
Returns a response object which responds to the following methods:
- #connections => Array<Types::Connection>

See Also:

AWS API Documentation

#describe_direct_connect_gateway_association_proposals(options = {}) ⇒ `Types::DescribeDirectConnectGatewayAssociationProposalsResult`

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

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateway_association_proposals({
  direct_connect_gateway_id: "DirectConnectGatewayId",
  proposal_id: "DirectConnectGatewayAssociationProposalId",
  associated_gateway_id: "AssociatedGatewayId",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.direct_connect_gateway_association_proposals #=> Array
resp.direct_connect_gateway_association_proposals[0].proposal_id #=> String
resp.direct_connect_gateway_association_proposals[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association_proposals[0].direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association_proposals[0].proposal_state #=> String, one of "requested", "accepted", "deleted"
resp.direct_connect_gateway_association_proposals[0].associated_gateway.id #=> String
resp.direct_connect_gateway_association_proposals[0].associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association_proposals[0].associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association_proposals[0].associated_gateway.region #=> String
resp.direct_connect_gateway_association_proposals[0].existing_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposals[0].existing_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association_proposals[0].requested_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposals[0].requested_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.next_token #=> String

Options Hash (options):

:direct_connect_gateway_id (String) —
The ID of the Direct Connect gateway.
:proposal_id (String) —
The ID of the proposal.
:associated_gateway_id (String) —
The ID of the associated gateway.
:max_results (Integer) —
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
:next_token (String) —
The token for the next page of results.

Returns:

(Types::DescribeDirectConnectGatewayAssociationProposalsResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association_proposals => Array<Types::DirectConnectGatewayAssociationProposal>
- #next_token => String

See Also:

AWS API Documentation

#describe_direct_connect_gateway_associations(options = {}) ⇒ `Types::DescribeDirectConnectGatewayAssociationsResult`

Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateway_associations({
  association_id: "DirectConnectGatewayAssociationId",
  associated_gateway_id: "AssociatedGatewayId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
  max_results: 1,
  next_token: "PaginationToken",
  virtual_gateway_id: "VirtualGatewayId",
})

Response structure


resp.direct_connect_gateway_associations #=> Array
resp.direct_connect_gateway_associations[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateway_associations[0].direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_associations[0].association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_associations[0].state_change_error #=> String
resp.direct_connect_gateway_associations[0].associated_gateway.id #=> String
resp.direct_connect_gateway_associations[0].associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_associations[0].associated_gateway.owner_account #=> String
resp.direct_connect_gateway_associations[0].associated_gateway.region #=> String
resp.direct_connect_gateway_associations[0].association_id #=> String
resp.direct_connect_gateway_associations[0].allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_associations[0].allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_associations[0].virtual_gateway_id #=> String
resp.direct_connect_gateway_associations[0].virtual_gateway_region #=> String
resp.direct_connect_gateway_associations[0].virtual_gateway_owner_account #=> String
resp.next_token #=> String

Options Hash (options):

:association_id (String) —
The ID of the Direct Connect gateway association.
:associated_gateway_id (String) —
The ID of the associated gateway.
:direct_connect_gateway_id (String) —
The ID of the Direct Connect gateway.
:max_results (Integer) —
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
:next_token (String) —
The token provided in the previous call to retrieve the next page.
:virtual_gateway_id (String) —
The ID of the virtual private gateway.

Returns:

(Types::DescribeDirectConnectGatewayAssociationsResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_associations => Array<Types::DirectConnectGatewayAssociation>
- #next_token => String

See Also:

AWS API Documentation

#describe_direct_connect_gateway_attachments(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateway_attachments({
  direct_connect_gateway_id: "DirectConnectGatewayId",
  virtual_interface_id: "VirtualInterfaceId",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.direct_connect_gateway_attachments #=> Array
resp.direct_connect_gateway_attachments[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateway_attachments[0].virtual_interface_id #=> String
resp.direct_connect_gateway_attachments[0].virtual_interface_region #=> String
resp.direct_connect_gateway_attachments[0].virtual_interface_owner_account #=> String
resp.direct_connect_gateway_attachments[0].attachment_state #=> String, one of "attaching", "attached", "detaching", "detached"
resp.direct_connect_gateway_attachments[0].attachment_type #=> String, one of "TransitVirtualInterface", "PrivateVirtualInterface"
resp.direct_connect_gateway_attachments[0].state_change_error #=> String
resp.next_token #=> String

Options Hash (options):

:direct_connect_gateway_id (String) —
The ID of the Direct Connect gateway.
:virtual_interface_id (String) —
The ID of the virtual interface.
:max_results (Integer) —
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
:next_token (String) —
The token provided in the previous call to retrieve the next page.

Returns:

(Types::DescribeDirectConnectGatewayAttachmentsResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_attachments => Array<Types::DirectConnectGatewayAttachment>
- #next_token => String

See Also:

AWS API Documentation

#describe_direct_connect_gateways(options = {}) ⇒ `Types::DescribeDirectConnectGatewaysResult`

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

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateways({
  direct_connect_gateway_id: "DirectConnectGatewayId",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.direct_connect_gateways #=> Array
resp.direct_connect_gateways[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateways[0].direct_connect_gateway_name #=> String
resp.direct_connect_gateways[0].amazon_side_asn #=> Integer
resp.direct_connect_gateways[0].owner_account #=> String
resp.direct_connect_gateways[0].direct_connect_gateway_state #=> String, one of "pending", "available", "deleting", "deleted"
resp.direct_connect_gateways[0].state_change_error #=> String
resp.next_token #=> String

Options Hash (options):

:direct_connect_gateway_id (String) —
The ID of the Direct Connect gateway.
:max_results (Integer) —
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
:next_token (String) —
The token provided in the previous call to retrieve the next page.

Returns:

(Types::DescribeDirectConnectGatewaysResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateways => Array<Types::DirectConnectGateway>
- #next_token => String

See Also:

AWS API Documentation

#describe_hosted_connections(options = {}) ⇒ `Types::Connections`

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

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.describe_hosted_connections({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connections #=> Array
resp.connections[0].owner_account #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> true/false
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the interconnect or LAG.

Returns:

(Types::Connections) —
Returns a response object which responds to the following methods:
- #connections => Array<Types::Connection>

See Also:

AWS API Documentation

#describe_interconnect_loa(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_interconnect_loa({
  interconnect_id: "InterconnectId", # required
  provider_name: "ProviderName",
  loa_content_type: "application/pdf", # accepts application/pdf
})

Response structure


resp.loa.loa_content #=> IO
resp.loa.loa_content_type #=> String, one of "application/pdf"

Options Hash (options):

:interconnect_id (required, String) —
The ID of the interconnect.
:provider_name (String) —
The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
:loa_content_type (String) —
The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Returns:

(Types::DescribeInterconnectLoaResponse) —
Returns a response object which responds to the following methods:
- #loa => Types::Loa

See Also:

AWS API Documentation

#describe_interconnects(options = {}) ⇒ `Types::Interconnects`

Lists the interconnects owned by the AWS account or only the specified interconnect.

Examples:

Request syntax with placeholder values


resp = client.describe_interconnects({
  interconnect_id: "InterconnectId",
})

Response structure


resp.interconnects #=> Array
resp.interconnects[0].interconnect_id #=> String
resp.interconnects[0].interconnect_name #=> String
resp.interconnects[0].interconnect_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.interconnects[0].region #=> String
resp.interconnects[0].location #=> String
resp.interconnects[0].bandwidth #=> String
resp.interconnects[0].loa_issue_time #=> Time
resp.interconnects[0].lag_id #=> String
resp.interconnects[0].aws_device #=> String
resp.interconnects[0].jumbo_frame_capable #=> true/false
resp.interconnects[0].aws_device_v2 #=> String
resp.interconnects[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.interconnects[0].tags #=> Array
resp.interconnects[0].tags[0].key #=> String
resp.interconnects[0].tags[0].value #=> String
resp.interconnects[0].provider_name #=> String

Options Hash (options):

:interconnect_id (String) —
The ID of the interconnect.

Returns:

(Types::Interconnects) —
Returns a response object which responds to the following methods:
- #interconnects => Array<Types::Interconnect>

See Also:

AWS API Documentation

#describe_lags(options = {}) ⇒ `Types::Lags`

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

Examples:

Request syntax with placeholder values


resp = client.describe_lags({
  lag_id: "LagId",
})

Response structure


resp.lags #=> Array
resp.lags[0].connections_bandwidth #=> String
resp.lags[0].number_of_connections #=> Integer
resp.lags[0].lag_id #=> String
resp.lags[0].owner_account #=> String
resp.lags[0].lag_name #=> String
resp.lags[0].lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.lags[0].location #=> String
resp.lags[0].region #=> String
resp.lags[0].minimum_links #=> Integer
resp.lags[0].aws_device #=> String
resp.lags[0].aws_device_v2 #=> String
resp.lags[0].connections #=> Array
resp.lags[0].connections[0].owner_account #=> String
resp.lags[0].connections[0].connection_id #=> String
resp.lags[0].connections[0].connection_name #=> String
resp.lags[0].connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.lags[0].connections[0].region #=> String
resp.lags[0].connections[0].location #=> String
resp.lags[0].connections[0].bandwidth #=> String
resp.lags[0].connections[0].vlan #=> Integer
resp.lags[0].connections[0].partner_name #=> String
resp.lags[0].connections[0].loa_issue_time #=> Time
resp.lags[0].connections[0].lag_id #=> String
resp.lags[0].connections[0].aws_device #=> String
resp.lags[0].connections[0].jumbo_frame_capable #=> true/false
resp.lags[0].connections[0].aws_device_v2 #=> String
resp.lags[0].connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.lags[0].connections[0].tags #=> Array
resp.lags[0].connections[0].tags[0].key #=> String
resp.lags[0].connections[0].tags[0].value #=> String
resp.lags[0].connections[0].provider_name #=> String
resp.lags[0].allows_hosted_connections #=> true/false
resp.lags[0].jumbo_frame_capable #=> true/false
resp.lags[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.lags[0].tags #=> Array
resp.lags[0].tags[0].key #=> String
resp.lags[0].tags[0].value #=> String
resp.lags[0].provider_name #=> String

Options Hash (options):

:lag_id (String) —
The ID of the LAG.

Returns:

(Types::Lags) —
Returns a response object which responds to the following methods:
- #lags => Array<Types::Lag>

See Also:

AWS API Documentation

#describe_loa(options = {}) ⇒ `Types::Loa`

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

Examples:

Request syntax with placeholder values


resp = client.describe_loa({
  connection_id: "ConnectionId", # required
  provider_name: "ProviderName",
  loa_content_type: "application/pdf", # accepts application/pdf
})

Response structure


resp.loa_content #=> IO
resp.loa_content_type #=> String, one of "application/pdf"

Options Hash (options):

:connection_id (required, String) —
The ID of a connection, LAG, or interconnect.
:provider_name (String) —
The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
:loa_content_type (String) —
The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Returns:

(Types::Loa) —
Returns a response object which responds to the following methods:
- #loa_content => String
- #loa_content_type => String

See Also:

AWS API Documentation

#describe_locations(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_locations()

Response structure


resp.locations #=> Array
resp.locations[0].location_code #=> String
resp.locations[0].location_name #=> String
resp.locations[0].region #=> String
resp.locations[0].available_port_speeds #=> Array
resp.locations[0].available_port_speeds[0] #=> String
resp.locations[0].available_providers #=> Array
resp.locations[0].available_providers[0] #=> String

Returns:

(Types::Locations) —
Returns a response object which responds to the following methods:
- #locations => Array<Types::Location>

See Also:

AWS API Documentation

#describe_tags(options = {}) ⇒ `Types::DescribeTagsResponse`

Describes the tags associated with the specified AWS Direct Connect resources.

Examples:

Request syntax with placeholder values


resp = client.describe_tags({
  resource_arns: ["ResourceArn"], # required
})

Response structure


resp.resource_tags #=> Array
resp.resource_tags[0].resource_arn #=> String
resp.resource_tags[0].tags #=> Array
resp.resource_tags[0].tags[0].key #=> String
resp.resource_tags[0].tags[0].value #=> String

Options Hash (options):

:resource_arns (required, Array<String>) —
The Amazon Resource Names (ARNs) of the resources.

Returns:

(Types::DescribeTagsResponse) —
Returns a response object which responds to the following methods:
- #resource_tags => Array<Types::ResourceTag>

See Also:

AWS API Documentation

#describe_virtual_gateways(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_gateways()

Response structure


resp.virtual_gateways #=> Array
resp.virtual_gateways[0].virtual_gateway_id #=> String
resp.virtual_gateways[0].virtual_gateway_state #=> String

Returns:

(Types::VirtualGateways) —
Returns a response object which responds to the following methods:
- #virtual_gateways => Array<Types::VirtualGateway>

See Also:

AWS API Documentation

#describe_virtual_interfaces(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_interfaces({
  connection_id: "ConnectionId",
  virtual_interface_id: "VirtualInterfaceId",
})

Response structure


resp.virtual_interfaces #=> Array
resp.virtual_interfaces[0].owner_account #=> String
resp.virtual_interfaces[0].virtual_interface_id #=> String
resp.virtual_interfaces[0].location #=> String
resp.virtual_interfaces[0].connection_id #=> String
resp.virtual_interfaces[0].virtual_interface_type #=> String
resp.virtual_interfaces[0].virtual_interface_name #=> String
resp.virtual_interfaces[0].vlan #=> Integer
resp.virtual_interfaces[0].asn #=> Integer
resp.virtual_interfaces[0].amazon_side_asn #=> Integer
resp.virtual_interfaces[0].auth_key #=> String
resp.virtual_interfaces[0].amazon_address #=> String
resp.virtual_interfaces[0].customer_address #=> String
resp.virtual_interfaces[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interfaces[0].virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interfaces[0].customer_router_config #=> String
resp.virtual_interfaces[0].mtu #=> Integer
resp.virtual_interfaces[0].jumbo_frame_capable #=> true/false
resp.virtual_interfaces[0].virtual_gateway_id #=> String
resp.virtual_interfaces[0].direct_connect_gateway_id #=> String
resp.virtual_interfaces[0].route_filter_prefixes #=> Array
resp.virtual_interfaces[0].route_filter_prefixes[0].cidr #=> String
resp.virtual_interfaces[0].bgp_peers #=> Array
resp.virtual_interfaces[0].bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interfaces[0].bgp_peers[0].asn #=> Integer
resp.virtual_interfaces[0].bgp_peers[0].auth_key #=> String
resp.virtual_interfaces[0].bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interfaces[0].bgp_peers[0].amazon_address #=> String
resp.virtual_interfaces[0].bgp_peers[0].customer_address #=> String
resp.virtual_interfaces[0].bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interfaces[0].bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interfaces[0].bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interfaces[0].region #=> String
resp.virtual_interfaces[0].aws_device_v2 #=> String
resp.virtual_interfaces[0].tags #=> Array
resp.virtual_interfaces[0].tags[0].key #=> String
resp.virtual_interfaces[0].tags[0].value #=> String

Options Hash (options):

:connection_id (String) —
The ID of the connection.
:virtual_interface_id (String) —
The ID of the virtual interface.

Returns:

(Types::VirtualInterfaces) —
Returns a response object which responds to the following methods:
- #virtual_interfaces => Array<Types::VirtualInterface>

See Also:

AWS API Documentation

#disassociate_connection_from_lag(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_connection_from_lag({
  connection_id: "ConnectionId", # required
  lag_id: "LagId", # required
})

Response structure


resp.owner_account #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> true/false
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:connection_id (required, String) —
The ID of the connection.
:lag_id (required, String) —
The ID of the LAG.

Returns:

(Types::Connection) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #connection_id => String
- #connection_name => String
- #connection_state => String
- #region => String
- #location => String
- #bandwidth => String
- #vlan => Integer
- #partner_name => String
- #loa_issue_time => Time
- #lag_id => String
- #aws_device => String
- #jumbo_frame_capable => Boolean
- #aws_device_v2 => String
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#list_virtual_interface_test_history(options = {}) ⇒ `Types::ListVirtualInterfaceTestHistoryResponse`

Lists the virtual interface failover test history.

Examples:

Request syntax with placeholder values


resp = client.list_virtual_interface_test_history({
  test_id: "TestId",
  virtual_interface_id: "VirtualInterfaceId",
  bgp_peers: ["BGPPeerId"],
  status: "FailureTestHistoryStatus",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.virtual_interface_test_history #=> Array
resp.virtual_interface_test_history[0].test_id #=> String
resp.virtual_interface_test_history[0].virtual_interface_id #=> String
resp.virtual_interface_test_history[0].bgp_peers #=> Array
resp.virtual_interface_test_history[0].bgp_peers[0] #=> String
resp.virtual_interface_test_history[0].status #=> String
resp.virtual_interface_test_history[0].owner_account #=> String
resp.virtual_interface_test_history[0].test_duration_in_minutes #=> Integer
resp.virtual_interface_test_history[0].start_time #=> Time
resp.virtual_interface_test_history[0].end_time #=> Time
resp.next_token #=> String

Options Hash (options):

:test_id (String) —
The ID of the virtual interface failover test.
:virtual_interface_id (String) —
The ID of the virtual interface that was tested.
:bgp_peers (Array<String>) —
The BGP peers that were placed in the DOWN state during the virtual interface failover test.
:status (String) —
The status of the virtual interface failover test.
:max_results (Integer) —
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
:next_token (String) —
The token for the next page of results.

Returns:

(Types::ListVirtualInterfaceTestHistoryResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_test_history => Array<Types::VirtualInterfaceTestHistory>
- #next_token => String

See Also:

AWS API Documentation

#start_bgp_failover_test(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.start_bgp_failover_test({
  virtual_interface_id: "VirtualInterfaceId", # required
  bgp_peers: ["BGPPeerId"],
  test_duration_in_minutes: 1,
})

Response structure


resp.virtual_interface_test.test_id #=> String
resp.virtual_interface_test.virtual_interface_id #=> String
resp.virtual_interface_test.bgp_peers #=> Array
resp.virtual_interface_test.bgp_peers[0] #=> String
resp.virtual_interface_test.status #=> String
resp.virtual_interface_test.owner_account #=> String
resp.virtual_interface_test.test_duration_in_minutes #=> Integer
resp.virtual_interface_test.start_time #=> Time
resp.virtual_interface_test.end_time #=> Time

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface you want to test.
:bgp_peers (Array<String>) —
The BGP peers to place in the DOWN state.
:test_duration_in_minutes (Integer) —
The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

Returns:

(Types::StartBgpFailoverTestResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_test => Types::VirtualInterfaceTestHistory

See Also:

AWS API Documentation

#stop_bgp_failover_test(options = {}) ⇒ `Types::StopBgpFailoverTestResponse`

Stops the virtual interface failover test.

Examples:

Request syntax with placeholder values


resp = client.stop_bgp_failover_test({
  virtual_interface_id: "VirtualInterfaceId", # required
})

Response structure


resp.virtual_interface_test.test_id #=> String
resp.virtual_interface_test.virtual_interface_id #=> String
resp.virtual_interface_test.bgp_peers #=> Array
resp.virtual_interface_test.bgp_peers[0] #=> String
resp.virtual_interface_test.status #=> String
resp.virtual_interface_test.owner_account #=> String
resp.virtual_interface_test.test_duration_in_minutes #=> Integer
resp.virtual_interface_test.start_time #=> Time
resp.virtual_interface_test.end_time #=> Time

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual interface you no longer want to test.

Returns:

(Types::StopBgpFailoverTestResponse) —
Returns a response object which responds to the following methods:
- #virtual_interface_test => Types::VirtualInterfaceTestHistory

See Also:

AWS API Documentation

#tag_resource(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource.
:tags (required, Array<Types::Tag>) —
The tags to add.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#untag_resource(options = {}) ⇒ `Struct`

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

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the resource.
:tag_keys (required, Array<String>) —
The tag keys of the tags to remove.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#update_direct_connect_gateway_association(options = {}) ⇒ `Types::UpdateDirectConnectGatewayAssociationResult`

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

Examples:

Request syntax with placeholder values


resp = client.update_direct_connect_gateway_association({
  association_id: "DirectConnectGatewayAssociationId",
  add_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
  remove_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association.direct_connect_gateway_owner_account #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway.owner_account #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association.virtual_gateway_owner_account #=> String

Options Hash (options):

:association_id (String) —
The ID of the Direct Connect gateway association.
:add_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>) —
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
:remove_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>) —
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

Returns:

(Types::UpdateDirectConnectGatewayAssociationResult) —
Returns a response object which responds to the following methods:
- #direct_connect_gateway_association => Types::DirectConnectGatewayAssociation

See Also:

AWS API Documentation

#update_lag(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.update_lag({
  lag_id: "LagId", # required
  lag_name: "LagName",
  minimum_links: 1,
})

Response structure


resp.connections_bandwidth #=> String
resp.number_of_connections #=> Integer
resp.lag_id #=> String
resp.owner_account #=> String
resp.lag_name #=> String
resp.lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.location #=> String
resp.region #=> String
resp.minimum_links #=> Integer
resp.aws_device #=> String
resp.aws_device_v2 #=> String
resp.connections #=> Array
resp.connections[0].owner_account #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> true/false
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String
resp.allows_hosted_connections #=> true/false
resp.jumbo_frame_capable #=> true/false
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Options Hash (options):

:lag_id (required, String) —
The ID of the LAG.
:lag_name (String) —
The name of the LAG.
:minimum_links (Integer) —
The minimum number of physical connections that must be operational for the LAG itself to be operational.

Returns:

(Types::Lag) —
Returns a response object which responds to the following methods:
- #connections_bandwidth => String
- #number_of_connections => Integer
- #lag_id => String
- #owner_account => String
- #lag_name => String
- #lag_state => String
- #location => String
- #region => String
- #minimum_links => Integer
- #aws_device => String
- #aws_device_v2 => String
- #connections => Array<Types::Connection>
- #allows_hosted_connections => Boolean
- #jumbo_frame_capable => Boolean
- #has_logical_redundancy => String
- #tags => Array<Types::Tag>
- #provider_name => String

See Also:

AWS API Documentation

#update_virtual_interface_attributes(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.update_virtual_interface_attributes({
  virtual_interface_id: "VirtualInterfaceId", # required
  mtu: 1,
})

Response structure


resp.owner_account #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> true/false
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:virtual_interface_id (required, String) —
The ID of the virtual private interface.
:mtu (Integer) —
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Returns:

(Types::VirtualInterface) —
Returns a response object which responds to the following methods:
- #owner_account => String
- #virtual_interface_id => String
- #location => String
- #connection_id => String
- #virtual_interface_type => String
- #virtual_interface_name => String
- #vlan => Integer
- #asn => Integer
- #amazon_side_asn => Integer
- #auth_key => String
- #amazon_address => String
- #customer_address => String
- #address_family => String
- #virtual_interface_state => String
- #customer_router_config => String
- #mtu => Integer
- #jumbo_frame_capable => Boolean
- #virtual_gateway_id => String
- #direct_connect_gateway_id => String
- #route_filter_prefixes => Array<Types::RouteFilterPrefix>
- #bgp_peers => Array<Types::BGPPeer>
- #region => String
- #aws_device_v2 => String
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::DirectConnect::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::DirectConnect::Client

Instance Method Details

#accept_direct_connect_gateway_association_proposal(options = {}) ⇒ Types::AcceptDirectConnectGatewayAssociationProposalResult

#allocate_connection_on_interconnect(options = {}) ⇒ Types::Connection

#allocate_hosted_connection(options = {}) ⇒ Types::Connection

#allocate_private_virtual_interface(options = {}) ⇒ Types::VirtualInterface

#allocate_public_virtual_interface(options = {}) ⇒ Types::VirtualInterface

#allocate_transit_virtual_interface(options = {}) ⇒ Types::AllocateTransitVirtualInterfaceResult

#associate_connection_with_lag(options = {}) ⇒ Types::Connection

#associate_hosted_connection(options = {}) ⇒ Types::Connection

#associate_virtual_interface(options = {}) ⇒ Types::VirtualInterface

#confirm_connection(options = {}) ⇒ Types::ConfirmConnectionResponse

#confirm_private_virtual_interface(options = {}) ⇒ Types::ConfirmPrivateVirtualInterfaceResponse

#confirm_public_virtual_interface(options = {}) ⇒ Types::ConfirmPublicVirtualInterfaceResponse

#confirm_transit_virtual_interface(options = {}) ⇒ Types::ConfirmTransitVirtualInterfaceResponse

#create_bgp_peer(options = {}) ⇒ Types::CreateBGPPeerResponse

#create_connection(options = {}) ⇒ Types::Connection

#create_direct_connect_gateway(options = {}) ⇒ Types::CreateDirectConnectGatewayResult

#create_direct_connect_gateway_association(options = {}) ⇒ Types::CreateDirectConnectGatewayAssociationResult

#create_direct_connect_gateway_association_proposal(options = {}) ⇒ Types::CreateDirectConnectGatewayAssociationProposalResult

#create_interconnect(options = {}) ⇒ Types::Interconnect

#create_lag(options = {}) ⇒ Types::Lag

#create_private_virtual_interface(options = {}) ⇒ Types::VirtualInterface

#create_public_virtual_interface(options = {}) ⇒ Types::VirtualInterface

#create_transit_virtual_interface(options = {}) ⇒ Types::CreateTransitVirtualInterfaceResult

#delete_bgp_peer(options = {}) ⇒ Types::DeleteBGPPeerResponse

#delete_connection(options = {}) ⇒ Types::Connection

#delete_direct_connect_gateway(options = {}) ⇒ Types::DeleteDirectConnectGatewayResult

#delete_direct_connect_gateway_association(options = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationResult

#delete_direct_connect_gateway_association_proposal(options = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationProposalResult

#delete_interconnect(options = {}) ⇒ Types::DeleteInterconnectResponse

#delete_lag(options = {}) ⇒ Types::Lag

#delete_virtual_interface(options = {}) ⇒ Types::DeleteVirtualInterfaceResponse

#describe_connection_loa(options = {}) ⇒ Types::DescribeConnectionLoaResponse

#describe_connections(options = {}) ⇒ Types::Connections

#describe_connections_on_interconnect(options = {}) ⇒ Types::Connections

#describe_direct_connect_gateway_association_proposals(options = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationProposalsResult

#describe_direct_connect_gateway_associations(options = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationsResult

#describe_direct_connect_gateway_attachments(options = {}) ⇒ Types::DescribeDirectConnectGatewayAttachmentsResult

#describe_direct_connect_gateways(options = {}) ⇒ Types::DescribeDirectConnectGatewaysResult

#describe_hosted_connections(options = {}) ⇒ Types::Connections

#describe_interconnect_loa(options = {}) ⇒ Types::DescribeInterconnectLoaResponse

#describe_interconnects(options = {}) ⇒ Types::Interconnects

#describe_lags(options = {}) ⇒ Types::Lags

#describe_loa(options = {}) ⇒ Types::Loa

#describe_locations(options = {}) ⇒ Types::Locations

#describe_tags(options = {}) ⇒ Types::DescribeTagsResponse

#describe_virtual_gateways(options = {}) ⇒ Types::VirtualGateways

#describe_virtual_interfaces(options = {}) ⇒ Types::VirtualInterfaces

#disassociate_connection_from_lag(options = {}) ⇒ Types::Connection

#list_virtual_interface_test_history(options = {}) ⇒ Types::ListVirtualInterfaceTestHistoryResponse

#start_bgp_failover_test(options = {}) ⇒ Types::StartBgpFailoverTestResponse

#stop_bgp_failover_test(options = {}) ⇒ Types::StopBgpFailoverTestResponse

#tag_resource(options = {}) ⇒ Struct

#untag_resource(options = {}) ⇒ Struct

#update_direct_connect_gateway_association(options = {}) ⇒ Types::UpdateDirectConnectGatewayAssociationResult

#update_lag(options = {}) ⇒ Types::Lag

#update_virtual_interface_attributes(options = {}) ⇒ Types::VirtualInterface

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::DirectConnect::Client`

#accept_direct_connect_gateway_association_proposal(options = {}) ⇒ `Types::AcceptDirectConnectGatewayAssociationProposalResult`

#allocate_connection_on_interconnect(options = {}) ⇒ `Types::Connection`

#allocate_hosted_connection(options = {}) ⇒ `Types::Connection`

#allocate_private_virtual_interface(options = {}) ⇒ `Types::VirtualInterface`

#allocate_public_virtual_interface(options = {}) ⇒ `Types::VirtualInterface`

#allocate_transit_virtual_interface(options = {}) ⇒ `Types::AllocateTransitVirtualInterfaceResult`

#associate_connection_with_lag(options = {}) ⇒ `Types::Connection`

#associate_hosted_connection(options = {}) ⇒ `Types::Connection`

#associate_virtual_interface(options = {}) ⇒ `Types::VirtualInterface`

#confirm_connection(options = {}) ⇒ `Types::ConfirmConnectionResponse`

#confirm_private_virtual_interface(options = {}) ⇒ `Types::ConfirmPrivateVirtualInterfaceResponse`

#confirm_public_virtual_interface(options = {}) ⇒ `Types::ConfirmPublicVirtualInterfaceResponse`

#confirm_transit_virtual_interface(options = {}) ⇒ `Types::ConfirmTransitVirtualInterfaceResponse`

#create_bgp_peer(options = {}) ⇒ `Types::CreateBGPPeerResponse`

#create_connection(options = {}) ⇒ `Types::Connection`

#create_direct_connect_gateway(options = {}) ⇒ `Types::CreateDirectConnectGatewayResult`

#create_direct_connect_gateway_association(options = {}) ⇒ `Types::CreateDirectConnectGatewayAssociationResult`

#create_direct_connect_gateway_association_proposal(options = {}) ⇒ `Types::CreateDirectConnectGatewayAssociationProposalResult`

#create_interconnect(options = {}) ⇒ `Types::Interconnect`

#create_lag(options = {}) ⇒ `Types::Lag`

#create_private_virtual_interface(options = {}) ⇒ `Types::VirtualInterface`

#create_public_virtual_interface(options = {}) ⇒ `Types::VirtualInterface`

#create_transit_virtual_interface(options = {}) ⇒ `Types::CreateTransitVirtualInterfaceResult`

#delete_bgp_peer(options = {}) ⇒ `Types::DeleteBGPPeerResponse`

#delete_connection(options = {}) ⇒ `Types::Connection`

#delete_direct_connect_gateway(options = {}) ⇒ `Types::DeleteDirectConnectGatewayResult`

#delete_direct_connect_gateway_association(options = {}) ⇒ `Types::DeleteDirectConnectGatewayAssociationResult`

#delete_direct_connect_gateway_association_proposal(options = {}) ⇒ `Types::DeleteDirectConnectGatewayAssociationProposalResult`

#delete_interconnect(options = {}) ⇒ `Types::DeleteInterconnectResponse`

#delete_lag(options = {}) ⇒ `Types::Lag`

#delete_virtual_interface(options = {}) ⇒ `Types::DeleteVirtualInterfaceResponse`

#describe_connection_loa(options = {}) ⇒ `Types::DescribeConnectionLoaResponse`

#describe_connections(options = {}) ⇒ `Types::Connections`

#describe_connections_on_interconnect(options = {}) ⇒ `Types::Connections`

#describe_direct_connect_gateway_association_proposals(options = {}) ⇒ `Types::DescribeDirectConnectGatewayAssociationProposalsResult`

#describe_direct_connect_gateway_associations(options = {}) ⇒ `Types::DescribeDirectConnectGatewayAssociationsResult`

#describe_direct_connect_gateway_attachments(options = {}) ⇒ `Types::DescribeDirectConnectGatewayAttachmentsResult`

#describe_direct_connect_gateways(options = {}) ⇒ `Types::DescribeDirectConnectGatewaysResult`

#describe_hosted_connections(options = {}) ⇒ `Types::Connections`

#describe_interconnect_loa(options = {}) ⇒ `Types::DescribeInterconnectLoaResponse`

#describe_interconnects(options = {}) ⇒ `Types::Interconnects`

#describe_lags(options = {}) ⇒ `Types::Lags`

#describe_loa(options = {}) ⇒ `Types::Loa`

#describe_locations(options = {}) ⇒ `Types::Locations`

#describe_tags(options = {}) ⇒ `Types::DescribeTagsResponse`

#describe_virtual_gateways(options = {}) ⇒ `Types::VirtualGateways`

#describe_virtual_interfaces(options = {}) ⇒ `Types::VirtualInterfaces`

#disassociate_connection_from_lag(options = {}) ⇒ `Types::Connection`

#list_virtual_interface_test_history(options = {}) ⇒ `Types::ListVirtualInterfaceTestHistoryResponse`

#start_bgp_failover_test(options = {}) ⇒ `Types::StartBgpFailoverTestResponse`

#stop_bgp_failover_test(options = {}) ⇒ `Types::StopBgpFailoverTestResponse`

#tag_resource(options = {}) ⇒ `Struct`

#untag_resource(options = {}) ⇒ `Struct`

#update_direct_connect_gateway_association(options = {}) ⇒ `Types::UpdateDirectConnectGatewayAssociationResult`

#update_lag(options = {}) ⇒ `Types::Lag`

#update_virtual_interface_attributes(options = {}) ⇒ `Types::VirtualInterface`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`