lib/aws-sdk-directconnect/client.rb in aws-sdk-directconnect-1.5.0 vs lib/aws-sdk-directconnect/client.rb in aws-sdk-directconnect-1.6.0
- old
+ new
@@ -184,59 +184,39 @@
super
end
# @!group API Operations
- # Deprecated in favor of AllocateHostedConnection.
+ # 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 given interconnect.
+ # a hosted connection on the specified interconnect.
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :bandwidth
- # Bandwidth of the connection.
+ # The bandwidth of the connection, in Mbps. The possible values are
+ # 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, and 500Mbps.
#
- # Example: "*500Mbps*"
- #
- # Default: None
- #
- # Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps
- #
# @option params [required, String] :connection_name
- # Name of the provisioned connection.
+ # The name of the provisioned connection.
#
- # Example: "*500M Connection to AWS*"
- #
- # Default: None
- #
# @option params [required, String] :owner_account
- # Numeric account Id of the customer for whom the connection will be
- # provisioned.
+ # The ID of the AWS account of the customer for whom the connection will
+ # be provisioned.
#
- # Example: 123443215678
- #
- # Default: None
- #
# @option params [required, String] :interconnect_id
- # ID of the interconnect on which the connection will be provisioned.
+ # The ID of the interconnect on which the connection will be
+ # provisioned. For example, dxcon-456abc78.
#
- # Example: dxcon-456abc78
- #
- # Default: None
- #
# @option params [required, Integer] :vlan
# The dedicated VLAN provisioned to the connection.
#
- # Example: 101
- #
- # Default: None
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -247,10 +227,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.allocate_connection_on_interconnect({
@@ -273,10 +254,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/AllocateConnectionOnInterconnect AWS API Documentation
#
# @overload allocate_connection_on_interconnect(params = {})
@@ -284,59 +266,36 @@
def allocate_connection_on_interconnect(params = {}, options = {})
req = build_request(:allocate_connection_on_interconnect, params)
req.send_request(options)
end
- # Creates a hosted connection on an interconnect or a link aggregation
- # group (LAG).
+ # Creates a hosted connection on the specified interconnect or a link
+ # aggregation group (LAG).
#
# Allocates a VLAN number and a specified amount of bandwidth for use by
- # a hosted connection on the given interconnect or LAG.
+ # a hosted connection on the specified interconnect or LAG.
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :connection_id
- # The ID of the interconnect or LAG on which the connection will be
- # provisioned.
+ # The ID of the interconnect or LAG.
#
- # Example: dxcon-456abc78 or dxlag-abc123
- #
- # Default: None
- #
# @option params [required, String] :owner_account
- # The numeric account ID of the customer for whom the connection will be
- # provisioned.
+ # The ID of the AWS account ID of the customer for the connection.
#
- # Example: 123443215678
- #
- # Default: None
- #
# @option params [required, String] :bandwidth
- # The bandwidth of the connection.
+ # The bandwidth of the hosted connection, in Mbps. The possible values
+ # are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, and 500Mbps.
#
- # Example: `500Mbps`
- #
- # Default: None
- #
- # Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps
- #
# @option params [required, String] :connection_name
- # The name of the provisioned connection.
+ # The name of the hosted connection.
#
- # Example: "`500M Connection to AWS`"
- #
- # Default: None
- #
# @option params [required, Integer] :vlan
# The dedicated VLAN provisioned to the hosted connection.
#
- # Example: 101
- #
- # Default: None
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -347,10 +306,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.allocate_hosted_connection({
@@ -373,10 +333,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/AllocateHostedConnection AWS API Documentation
#
# @overload allocate_hosted_connection(params = {})
@@ -384,35 +345,28 @@
def allocate_hosted_connection(params = {}, options = {})
req = build_request(:allocate_hosted_connection, params)
req.send_request(options)
end
- # Provisions a private virtual interface to be owned by another AWS
- # customer.
+ # Provisions a private virtual interface to be owned by the specified
+ # AWS account.
#
# Virtual interfaces created using this action must be confirmed by the
- # virtual interface owner by using the ConfirmPrivateVirtualInterface
- # action. Until then, the virtual interface will be in 'Confirming'
- # state, and will not be available for handling traffic.
+ # owner using ConfirmPrivateVirtualInterface. Until then, the virtual
+ # interface is in the `Confirming` state and is not available to handle
+ # traffic.
#
# @option params [required, String] :connection_id
- # The connection ID on which the private virtual interface is
+ # The ID of the connection on which the private virtual interface is
# provisioned.
#
- # Default: None
- #
# @option params [required, String] :owner_account
- # The AWS account that will own the new private virtual interface.
+ # The ID of the AWS account that owns the virtual private interface.
#
- # Default: None
- #
# @option params [required, Types::NewPrivateVirtualInterfaceAllocation] :new_private_virtual_interface_allocation
- # Detailed information for the private virtual interface to be
- # provisioned.
+ # Information about the private virtual interface.
#
- # Default: None
- #
# @return [Types::VirtualInterface] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualInterface#owner_account #owner_account} => String
# * {Types::VirtualInterface#virtual_interface_id #virtual_interface_id} => String
# * {Types::VirtualInterface#location #location} => String
@@ -426,10 +380,12 @@
# * {Types::VirtualInterface#amazon_address #amazon_address} => String
# * {Types::VirtualInterface#customer_address #customer_address} => String
# * {Types::VirtualInterface#address_family #address_family} => String
# * {Types::VirtualInterface#virtual_interface_state #virtual_interface_state} => String
# * {Types::VirtualInterface#customer_router_config #customer_router_config} => String
+ # * {Types::VirtualInterface#mtu #mtu} => Integer
+ # * {Types::VirtualInterface#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::VirtualInterface#virtual_gateway_id #virtual_gateway_id} => String
# * {Types::VirtualInterface#direct_connect_gateway_id #direct_connect_gateway_id} => String
# * {Types::VirtualInterface#route_filter_prefixes #route_filter_prefixes} => Array<Types::RouteFilterPrefix>
# * {Types::VirtualInterface#bgp_peers #bgp_peers} => Array<Types::BGPPeer>
# * {Types::VirtualInterface#region #region} => String
@@ -442,10 +398,11 @@
# 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",
# },
@@ -466,10 +423,12 @@
# 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"
# resp.customer_router_config #=> String
+ # resp.mtu #=> Integer
+ # resp.jumbo_frame_capable #=> Boolean
# 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
@@ -491,43 +450,36 @@
def allocate_private_virtual_interface(params = {}, options = {})
req = build_request(:allocate_private_virtual_interface, params)
req.send_request(options)
end
- # Provisions a public virtual interface to be owned by a different
- # customer.
+ # 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 which will be owned by another AWS customer.
+ # virtual interface to be owned by the specified AWS account.
#
# Virtual interfaces created using this function must be confirmed by
- # the virtual interface owner by calling ConfirmPublicVirtualInterface.
- # Until this step has been completed, the virtual interface will be in
- # 'Confirming' state, and will not be available for handling traffic.
+ # 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 (addressFamily is
- # 'ipv6'), the customer and amazon address fields should be left blank
- # to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently
- # not supported.
+ # 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.
#
# @option params [required, String] :connection_id
- # The connection ID on which the public virtual interface is
+ # The ID of the connection on which the public virtual interface is
# provisioned.
#
- # Default: None
- #
# @option params [required, String] :owner_account
- # The AWS account that will own the new public virtual interface.
+ # The ID of the AWS account that owns the public virtual interface.
#
- # Default: None
- #
# @option params [required, Types::NewPublicVirtualInterfaceAllocation] :new_public_virtual_interface_allocation
- # Detailed information for the public virtual interface to be
- # provisioned.
+ # Information about the public virtual interface.
#
- # Default: None
- #
# @return [Types::VirtualInterface] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualInterface#owner_account #owner_account} => String
# * {Types::VirtualInterface#virtual_interface_id #virtual_interface_id} => String
# * {Types::VirtualInterface#location #location} => String
@@ -541,10 +493,12 @@
# * {Types::VirtualInterface#amazon_address #amazon_address} => String
# * {Types::VirtualInterface#customer_address #customer_address} => String
# * {Types::VirtualInterface#address_family #address_family} => String
# * {Types::VirtualInterface#virtual_interface_state #virtual_interface_state} => String
# * {Types::VirtualInterface#customer_router_config #customer_router_config} => String
+ # * {Types::VirtualInterface#mtu #mtu} => Integer
+ # * {Types::VirtualInterface#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::VirtualInterface#virtual_gateway_id #virtual_gateway_id} => String
# * {Types::VirtualInterface#direct_connect_gateway_id #direct_connect_gateway_id} => String
# * {Types::VirtualInterface#route_filter_prefixes #route_filter_prefixes} => Array<Types::RouteFilterPrefix>
# * {Types::VirtualInterface#bgp_peers #bgp_peers} => Array<Types::BGPPeer>
# * {Types::VirtualInterface#region #region} => String
@@ -586,10 +540,12 @@
# 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"
# resp.customer_router_config #=> String
+ # resp.mtu #=> Integer
+ # resp.jumbo_frame_capable #=> Boolean
# 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
@@ -613,15 +569,15 @@
req.send_request(options)
end
# 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 will be interrupted). The connection must be
+ # 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 reassociate a
+ # 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 will cause the original LAG to fall below
+ # 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
@@ -632,23 +588,16 @@
# re-associated with the LAG. If the interconnect was originally
# associated with a different LAG, the hosted connections remain
# associated with the original LAG.
#
# @option params [required, String] :connection_id
- # The ID of the connection.
+ # The ID of the connection. For example, dxcon-abc123.
#
- # Example: dxcon-abc123
- #
- # Default: None
- #
# @option params [required, String] :lag_id
- # The ID of the LAG with which to associate the connection.
+ # The ID of the LAG with which to associate the connection. For example,
+ # dxlag-abc123.
#
- # Example: dxlag-abc123
- #
- # Default: None
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -659,10 +608,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.associate_connection_with_lag({
@@ -682,10 +632,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/AssociateConnectionWithLag AWS API Documentation
#
# @overload associate_connection_with_lag(params = {})
@@ -699,28 +650,20 @@
# 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.
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :connection_id
# The ID of the hosted connection.
#
- # Example: dxcon-abc123
- #
- # Default: None
- #
# @option params [required, String] :parent_connection_id
# The ID of the interconnect or the LAG.
#
- # Example: dxcon-abc123 or dxlag-abc123
- #
- # Default: None
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -731,10 +674,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.associate_hosted_connection({
@@ -754,10 +698,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/AssociateHostedConnection AWS API Documentation
#
# @overload associate_hosted_connection(params = {})
@@ -775,31 +720,22 @@
#
# 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.
#
- # In order to reassociate a virtual interface to a new connection or
- # LAG, the requester must own either the virtual interface itself or the
+ # 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 to which
- # the virtual interface will be newly associated.
+ # Additionally, the requester must own the connection or LAG for the
+ # association.
#
# @option params [required, String] :virtual_interface_id
# The ID of the virtual interface.
#
- # Example: dxvif-123dfg56
- #
- # Default: None
- #
# @option params [required, String] :connection_id
- # The ID of the LAG or connection with which to associate the virtual
- # interface.
+ # The ID of the LAG or connection.
#
- # Example: dxlag-abc123 or dxcon-abc123
- #
- # Default: None
- #
# @return [Types::VirtualInterface] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualInterface#owner_account #owner_account} => String
# * {Types::VirtualInterface#virtual_interface_id #virtual_interface_id} => String
# * {Types::VirtualInterface#location #location} => String
@@ -813,10 +749,12 @@
# * {Types::VirtualInterface#amazon_address #amazon_address} => String
# * {Types::VirtualInterface#customer_address #customer_address} => String
# * {Types::VirtualInterface#address_family #address_family} => String
# * {Types::VirtualInterface#virtual_interface_state #virtual_interface_state} => String
# * {Types::VirtualInterface#customer_router_config #customer_router_config} => String
+ # * {Types::VirtualInterface#mtu #mtu} => Integer
+ # * {Types::VirtualInterface#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::VirtualInterface#virtual_gateway_id #virtual_gateway_id} => String
# * {Types::VirtualInterface#direct_connect_gateway_id #direct_connect_gateway_id} => String
# * {Types::VirtualInterface#route_filter_prefixes #route_filter_prefixes} => Array<Types::RouteFilterPrefix>
# * {Types::VirtualInterface#bgp_peers #bgp_peers} => Array<Types::BGPPeer>
# * {Types::VirtualInterface#region #region} => String
@@ -844,10 +782,12 @@
# 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"
# resp.customer_router_config #=> String
+ # resp.mtu #=> Integer
+ # resp.jumbo_frame_capable #=> Boolean
# 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
@@ -869,25 +809,20 @@
def associate_virtual_interface(params = {}, options = {})
req = build_request(:associate_virtual_interface, params)
req.send_request(options)
end
- # Confirm the creation of a hosted connection on an interconnect.
+ # Confirms the creation of the specified hosted connection on an
+ # interconnect.
#
- # Upon creation, the hosted connection is initially in the 'Ordering'
- # state, and will remain in this state until the owner calls
- # ConfirmConnection to confirm creation of the hosted connection.
+ # 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.
#
# @option params [required, String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the hosted connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @return [Types::ConfirmConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ConfirmConnectionResponse#connection_state #connection_state} => String
#
# @example Request syntax with placeholder values
@@ -907,47 +842,27 @@
def confirm_connection(params = {}, options = {})
req = build_request(:confirm_connection, params)
req.send_request(options)
end
- # Accept ownership of a private virtual interface created by another
- # customer.
+ # Accepts ownership of a private virtual interface created by another
+ # AWS account.
#
- # After the virtual interface owner calls this function, the virtual
- # interface will be created and attached to the given virtual private
- # gateway or direct connect gateway, and will be available for handling
+ # 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.
#
# @option params [required, String] :virtual_interface_id
# The ID of the virtual interface.
#
- # Example: dxvif-123dfg56
- #
- # Default: None
- #
# @option params [String] :virtual_gateway_id
- # ID of the virtual private gateway that will be attached to the virtual
- # interface.
+ # The ID of the virtual private gateway.
#
- # A virtual private gateway can be managed via the Amazon Virtual
- # Private Cloud (VPC) console or the [EC2 CreateVpnGateway][1] action.
- #
- # Default: None
- #
- #
- #
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html
- #
# @option params [String] :direct_connect_gateway_id
- # ID of the direct connect gateway that will be attached to the virtual
- # interface.
+ # The ID of the Direct Connect gateway.
#
- # A direct connect gateway can be managed via the AWS Direct Connect
- # console or the CreateDirectConnectGateway action.
- #
- # Default: None
- #
# @return [Types::ConfirmPrivateVirtualInterfaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ConfirmPrivateVirtualInterfaceResponse#virtual_interface_state #virtual_interface_state} => String
#
# @example Request syntax with placeholder values
@@ -969,24 +884,19 @@
def confirm_private_virtual_interface(params = {}, options = {})
req = build_request(:confirm_private_virtual_interface, params)
req.send_request(options)
end
- # Accept ownership of a public virtual interface created by another
- # customer.
+ # Accepts ownership of a public virtual interface created by another AWS
+ # account.
#
- # After the virtual interface owner calls this function, the specified
- # virtual interface will be created and made available for handling
- # traffic.
+ # After the virtual interface owner makes this call, the specified
+ # virtual interface is created and made available to handle traffic.
#
# @option params [required, String] :virtual_interface_id
# The ID of the virtual interface.
#
- # Example: dxvif-123dfg56
- #
- # Default: None
- #
# @return [Types::ConfirmPublicVirtualInterfaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ConfirmPublicVirtualInterfaceResponse#virtual_interface_state #virtual_interface_state} => String
#
# @example Request syntax with placeholder values
@@ -1006,38 +916,31 @@
def confirm_public_virtual_interface(params = {}, options = {})
req = build_request(:confirm_public_virtual_interface, params)
req.send_request(options)
end
- # Creates a new BGP peer on a specified virtual interface. The BGP peer
- # cannot be in the same address family (IPv4/IPv6) of an existing BGP
- # peer on the virtual interface.
+ # Creates a BGP peer on the specified virtual interface.
#
+ # The BGP peer cannot be in the same address family (IPv4/IPv6) of an
+ # existing BGP peer on the virtual interface.
+ #
# You must create a BGP peer for the corresponding address family in
# order to access AWS resources that also use that address family.
#
- # When creating a IPv6 BGP peer, the Amazon address and customer address
- # fields must be left blank. IPv6 addresses are automatically assigned
- # from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6
- # addresses.
+ # 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.
#
# @option params [String] :virtual_interface_id
- # The ID of the virtual interface on which the BGP peer will be
- # provisioned.
+ # The ID of the virtual interface.
#
- # Example: dxvif-456abc78
- #
- # Default: None
- #
# @option params [Types::NewBGPPeer] :new_bgp_peer
- # Detailed information for the BGP peer to be created.
+ # Information about the BGP peer.
#
- # Default: None
- #
# @return [Types::CreateBGPPeerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateBGPPeerResponse#virtual_interface #virtual_interface} => Types::VirtualInterface
#
# @example Request syntax with placeholder values
@@ -1068,10 +971,12 @@
# 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"
# resp.virtual_interface.customer_router_config #=> String
+ # resp.virtual_interface.mtu #=> Integer
+ # resp.virtual_interface.jumbo_frame_capable #=> Boolean
# 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
@@ -1093,56 +998,38 @@
def create_bgp_peer(params = {}, options = {})
req = build_request(:create_bgp_peer, params)
req.send_request(options)
end
- # Creates a new connection between the customer network and a specific
- # AWS Direct Connect location.
+ # 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 1 gigabit or 10 gigabit Ethernet fiber-optic
- # cable. One end of the cable is connected to your router, the other to
- # an AWS Direct Connect router. An AWS Direct Connect location provides
- # access to Amazon Web Services in the region it is associated with. You
- # can establish connections with AWS Direct Connect locations in
- # multiple regions, but a connection in one region does not provide
- # connectivity to other regions.
+ # 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.
+ # 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 will be created.
+ # on the endpoint, the request fails and no connection is created.
#
# @option params [required, String] :location
- # Where the connection is located.
+ # The location of the connection.
#
- # Example: EqSV5
- #
- # Default: None
- #
# @option params [required, String] :bandwidth
- # Bandwidth of the connection.
+ # The bandwidth of the connection.
#
- # Example: 1Gbps
- #
- # Default: None
- #
# @option params [required, String] :connection_name
# The name of the connection.
#
- # Example: "*My Connection to AWS*"
- #
- # Default: None
- #
# @option params [String] :lag_id
# The ID of the LAG.
#
- # Example: dxlag-fg5678gh
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -1153,10 +1040,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_connection({
@@ -1178,10 +1066,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/CreateConnection AWS API Documentation
#
# @overload create_connection(params = {})
@@ -1189,37 +1078,28 @@
def create_connection(params = {}, options = {})
req = build_request(:create_connection, params)
req.send_request(options)
end
- # Creates a new direct connect gateway. A direct connect gateway is an
- # intermediate object that enables you to connect a set of virtual
- # interfaces and virtual private gateways. direct connect gateways are
- # global and visible in any AWS region after they are created. The
- # virtual interfaces and virtual private gateways that are connected
- # through a direct connect gateway can be in different 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.
+ # 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.
#
# @option params [required, String] :direct_connect_gateway_name
- # The name of the direct connect gateway.
+ # The name of the Direct Connect gateway.
#
- # Example: "My direct connect gateway"
- #
- # Default: None
- #
# @option params [Integer] :amazon_side_asn
# 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
+ # 4,294,967,294. The default is 64512.
#
- # Example: 65200
- #
- # Default: 64512
- #
# @return [Types::CreateDirectConnectGatewayResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDirectConnectGatewayResult#direct_connect_gateway #direct_connect_gateway} => Types::DirectConnectGateway
#
# @example Request syntax with placeholder values
@@ -1245,28 +1125,20 @@
def create_direct_connect_gateway(params = {}, options = {})
req = build_request(:create_direct_connect_gateway, params)
req.send_request(options)
end
- # Creates an association between a direct connect gateway and a virtual
- # private gateway (VGW). The VGW must be attached to a VPC and must not
- # be associated with another direct connect gateway.
+ # 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.
#
# @option params [required, String] :direct_connect_gateway_id
- # The ID of the direct connect gateway.
+ # The ID of the Direct Connect gateway.
#
- # Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
- #
- # Default: None
- #
# @option params [required, String] :virtual_gateway_id
# The ID of the virtual private gateway.
#
- # Example: "vgw-abc123ef"
- #
- # Default: None
- #
# @return [Types::CreateDirectConnectGatewayAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDirectConnectGatewayAssociationResult#direct_connect_gateway_association #direct_connect_gateway_association} => Types::DirectConnectGatewayAssociation
#
# @example Request syntax with placeholder values
@@ -1292,67 +1164,49 @@
def create_direct_connect_gateway_association(params = {}, options = {})
req = build_request(:create_direct_connect_gateway_association, params)
req.send_request(options)
end
- # Creates a new interconnect between a AWS Direct Connect partner's
+ # Creates an interconnect between an AWS Direct Connect partner's
# network and a specific AWS Direct Connect location.
#
# An interconnect is a connection which is capable of hosting other
- # connections. The AWS Direct Connect partner can use an interconnect to
- # provide sub-1Gbps AWS Direct Connect service to tier 2 customers who
- # do not have their own connections. Like a standard connection, an
- # interconnect links the AWS Direct Connect partner's network to an AWS
- # Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet
- # fiber-optic cable. One end is connected to the partner's router, the
- # other to an AWS Direct Connect router.
+ # connections. The partner can use an interconnect to provide sub-1Gbps
+ # AWS Direct Connect service to tier 2 customers who do not have their
+ # own connections. 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 will be
- # created.
+ # 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
# AllocateConnectionOnInterconnect. 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.
+ # using the VLAN assigned to them by the partner.
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :interconnect_name
# The name of the interconnect.
#
- # Example: "*1G Interconnect to AWS*"
- #
- # Default: None
- #
# @option params [required, String] :bandwidth
- # The port bandwidth
+ # The port bandwidth, in Gbps. The possible values are 1 and 10.
#
- # Example: 1Gbps
- #
- # Default: None
- #
- # Available values: 1Gbps,10Gbps
- #
# @option params [required, String] :location
- # Where the interconnect is located
+ # The location of the interconnect.
#
- # Example: EqSV5
- #
- # Default: None
- #
# @option params [String] :lag_id
# The ID of the LAG.
#
- # Example: dxlag-fg5678gh
- #
# @return [Types::Interconnect] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Interconnect#interconnect_id #interconnect_id} => String
# * {Types::Interconnect#interconnect_name #interconnect_name} => String
# * {Types::Interconnect#interconnect_state #interconnect_state} => String
@@ -1360,10 +1214,11 @@
# * {Types::Interconnect#location #location} => String
# * {Types::Interconnect#bandwidth #bandwidth} => String
# * {Types::Interconnect#loa_issue_time #loa_issue_time} => Time
# * {Types::Interconnect#lag_id #lag_id} => String
# * {Types::Interconnect#aws_device #aws_device} => String
+ # * {Types::Interconnect#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Interconnect#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_interconnect({
@@ -1382,10 +1237,11 @@
# resp.location #=> String
# resp.bandwidth #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/CreateInterconnect AWS API Documentation
#
# @overload create_interconnect(params = {})
@@ -1393,19 +1249,18 @@
def create_interconnect(params = {}, options = {})
req = build_request(:create_interconnect, params)
req.send_request(options)
end
- # Creates a new link aggregation group (LAG) with the specified number
- # of bundled physical connections between the customer network and a
+ # Creates a link aggregation group (LAG) with the specified number of
+ # bundled physical 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 1 gigabit or 10 gigabit interfaces, allowing you to treat
- # them as a single interface.
+ # multiple interfaces, enabling you to treat them as a single interface.
#
- # All connections in a LAG must use the same bandwidth (for example, 10
- # Gbps), and must terminate at the same AWS Direct Connect endpoint.
+ # All connections in a LAG must use the same bandwidth and must
+ # terminate at the same AWS Direct Connect endpoint.
#
# You can have up to 10 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.
#
@@ -1425,39 +1280,23 @@
#
# @option params [required, Integer] :number_of_connections
# The number of physical connections initially provisioned and bundled
# by the LAG.
#
- # Default: None
- #
# @option params [required, String] :location
- # The AWS Direct Connect location in which the LAG should be allocated.
+ # The location for the LAG.
#
- # Example: EqSV5
- #
- # Default: None
- #
# @option params [required, String] :connections_bandwidth
# The bandwidth of the individual physical connections bundled by the
- # LAG.
+ # LAG. The possible values are 1Gbps and 10Gbps.
#
- # Default: None
- #
- # Available values: 1Gbps, 10Gbps
- #
# @option params [required, String] :lag_name
# The name of the LAG.
#
- # Example: "`3x10G LAG to AWS`"
- #
- # Default: None
- #
# @option params [String] :connection_id
# The ID of an existing connection to migrate to the LAG.
#
- # Default: None
- #
# @return [Types::Lag] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Lag#connections_bandwidth #connections_bandwidth} => String
# * {Types::Lag#number_of_connections #number_of_connections} => Integer
# * {Types::Lag#lag_id #lag_id} => String
@@ -1469,10 +1308,11 @@
# * {Types::Lag#minimum_links #minimum_links} => Integer
# * {Types::Lag#aws_device #aws_device} => String
# * {Types::Lag#aws_device_v2 #aws_device_v2} => String
# * {Types::Lag#connections #connections} => Array<Types::Connection>
# * {Types::Lag#allows_hosted_connections #allows_hosted_connections} => Boolean
+ # * {Types::Lag#jumbo_frame_capable #jumbo_frame_capable} => Boolean
#
# @example Request syntax with placeholder values
#
# resp = client.create_lag({
# number_of_connections: 1, # required
@@ -1506,41 +1346,39 @@
# 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 #=> Boolean
# resp.connections[0].aws_device_v2 #=> String
# resp.allows_hosted_connections #=> Boolean
+ # resp.jumbo_frame_capable #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/CreateLag AWS API Documentation
#
# @overload create_lag(params = {})
# @param [Hash] params ({})
def create_lag(params = {}, options = {})
req = build_request(:create_lag, params)
req.send_request(options)
end
- # Creates a new private virtual interface. A virtual interface is the
- # VLAN that transports AWS Direct Connect traffic. A private virtual
- # interface supports sending traffic to a single virtual private cloud
- # (VPC).
+ # 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.
#
# @option params [required, String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @option params [required, Types::NewPrivateVirtualInterface] :new_private_virtual_interface
- # Detailed information for the private virtual interface to be created.
+ # Information about the private virtual interface.
#
- # Default: None
- #
# @return [Types::VirtualInterface] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualInterface#owner_account #owner_account} => String
# * {Types::VirtualInterface#virtual_interface_id #virtual_interface_id} => String
# * {Types::VirtualInterface#location #location} => String
@@ -1554,10 +1392,12 @@
# * {Types::VirtualInterface#amazon_address #amazon_address} => String
# * {Types::VirtualInterface#customer_address #customer_address} => String
# * {Types::VirtualInterface#address_family #address_family} => String
# * {Types::VirtualInterface#virtual_interface_state #virtual_interface_state} => String
# * {Types::VirtualInterface#customer_router_config #customer_router_config} => String
+ # * {Types::VirtualInterface#mtu #mtu} => Integer
+ # * {Types::VirtualInterface#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::VirtualInterface#virtual_gateway_id #virtual_gateway_id} => String
# * {Types::VirtualInterface#direct_connect_gateway_id #direct_connect_gateway_id} => String
# * {Types::VirtualInterface#route_filter_prefixes #route_filter_prefixes} => Array<Types::RouteFilterPrefix>
# * {Types::VirtualInterface#bgp_peers #bgp_peers} => Array<Types::BGPPeer>
# * {Types::VirtualInterface#region #region} => String
@@ -1569,10 +1409,11 @@
# 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",
@@ -1595,10 +1436,12 @@
# 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"
# resp.customer_router_config #=> String
+ # resp.mtu #=> Integer
+ # resp.jumbo_frame_capable #=> Boolean
# 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
@@ -1620,34 +1463,24 @@
def create_private_virtual_interface(params = {}, options = {})
req = build_request(:create_private_virtual_interface, params)
req.send_request(options)
end
- # Creates a new 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 Simple Storage Service (Amazon S3).
+ # 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'), the customer and amazon address fields should be left blank
- # to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently
- # not supported.
+ # 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.
#
# @option params [required, String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @option params [required, Types::NewPublicVirtualInterface] :new_public_virtual_interface
- # Detailed information for the public virtual interface to be created.
+ # Information about the public virtual interface.
#
- # Default: None
- #
# @return [Types::VirtualInterface] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualInterface#owner_account #owner_account} => String
# * {Types::VirtualInterface#virtual_interface_id #virtual_interface_id} => String
# * {Types::VirtualInterface#location #location} => String
@@ -1661,10 +1494,12 @@
# * {Types::VirtualInterface#amazon_address #amazon_address} => String
# * {Types::VirtualInterface#customer_address #customer_address} => String
# * {Types::VirtualInterface#address_family #address_family} => String
# * {Types::VirtualInterface#virtual_interface_state #virtual_interface_state} => String
# * {Types::VirtualInterface#customer_router_config #customer_router_config} => String
+ # * {Types::VirtualInterface#mtu #mtu} => Integer
+ # * {Types::VirtualInterface#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::VirtualInterface#virtual_gateway_id #virtual_gateway_id} => String
# * {Types::VirtualInterface#direct_connect_gateway_id #direct_connect_gateway_id} => String
# * {Types::VirtualInterface#route_filter_prefixes #route_filter_prefixes} => Array<Types::RouteFilterPrefix>
# * {Types::VirtualInterface#bgp_peers #bgp_peers} => Array<Types::BGPPeer>
# * {Types::VirtualInterface#region #region} => String
@@ -1705,10 +1540,12 @@
# 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"
# resp.customer_router_config #=> String
+ # resp.mtu #=> Integer
+ # resp.jumbo_frame_capable #=> Boolean
# 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
@@ -1730,33 +1567,25 @@
def create_public_virtual_interface(params = {}, options = {})
req = build_request(:create_public_virtual_interface, params)
req.send_request(options)
end
- # Deletes a BGP peer on the specified virtual interface that matches the
- # specified customer address and ASN. You cannot delete the last BGP
- # peer from a virtual interface.
+ # Deletes the 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.
+ #
# @option params [String] :virtual_interface_id
- # The ID of the virtual interface from which the BGP peer will be
- # deleted.
+ # The ID of the virtual interface.
#
- # Example: dxvif-456abc78
- #
- # Default: None
- #
# @option params [Integer] :asn
# The autonomous system (AS) number for Border Gateway Protocol (BGP)
# configuration.
#
- # Example: 65000
- #
# @option params [String] :customer_address
- # IP address assigned to the customer interface.
+ # The IP address assigned to the customer interface.
#
- # Example: 192.168.1.2/30 or 2001:db8::2/125
- #
# @return [Types::DeleteBGPPeerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteBGPPeerResponse#virtual_interface #virtual_interface} => Types::VirtualInterface
#
# @example Request syntax with placeholder values
@@ -1782,10 +1611,12 @@
# 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"
# resp.virtual_interface.customer_router_config #=> String
+ # resp.virtual_interface.mtu #=> Integer
+ # resp.virtual_interface.jumbo_frame_capable #=> Boolean
# 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
@@ -1807,26 +1638,20 @@
def delete_bgp_peer(params = {}, options = {})
req = build_request(:delete_bgp_peer, params)
req.send_request(options)
end
- # Deletes the connection.
+ # Deletes the specified connection.
#
# Deleting a connection only stops the AWS Direct Connect port hour and
- # data transfer charges. You need to cancel separately with the
- # providers any services or charges for cross-connects or network
- # circuits that connect you to the AWS Direct Connect location.
+ # 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.
#
# @option params [required, String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -1837,10 +1662,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.delete_connection({
@@ -1859,10 +1685,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DeleteConnection AWS API Documentation
#
# @overload delete_connection(params = {})
@@ -1870,22 +1697,18 @@
def delete_connection(params = {}, options = {})
req = build_request(:delete_connection, params)
req.send_request(options)
end
- # Deletes a direct connect gateway. You must first delete all virtual
- # interfaces that are attached to the direct connect gateway and
- # disassociate all virtual private gateways that are associated with the
- # direct connect gateway.
+ # 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 that are associated with
+ # the Direct Connect gateway.
#
# @option params [required, String] :direct_connect_gateway_id
- # The ID of the direct connect gateway.
+ # The ID of the Direct Connect gateway.
#
- # Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
- #
- # Default: None
- #
# @return [Types::DeleteDirectConnectGatewayResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteDirectConnectGatewayResult#direct_connect_gateway #direct_connect_gateway} => Types::DirectConnectGateway
#
# @example Request syntax with placeholder values
@@ -1910,27 +1733,19 @@
def delete_direct_connect_gateway(params = {}, options = {})
req = build_request(:delete_direct_connect_gateway, params)
req.send_request(options)
end
- # Deletes the association between a direct connect gateway and a virtual
- # private gateway.
+ # Deletes the association between the specified Direct Connect gateway
+ # and virtual private gateway.
#
# @option params [required, String] :direct_connect_gateway_id
- # The ID of the direct connect gateway.
+ # The ID of the Direct Connect gateway.
#
- # Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
- #
- # Default: None
- #
# @option params [required, String] :virtual_gateway_id
# The ID of the virtual private gateway.
#
- # Example: "vgw-abc123ef"
- #
- # Default: None
- #
# @return [Types::DeleteDirectConnectGatewayAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteDirectConnectGatewayAssociationResult#direct_connect_gateway_association #direct_connect_gateway_association} => Types::DirectConnectGatewayAssociation
#
# @example Request syntax with placeholder values
@@ -1958,19 +1773,17 @@
req.send_request(options)
end
# Deletes the specified interconnect.
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :interconnect_id
# The ID of the interconnect.
#
- # Example: dxcon-abc123
- #
# @return [Types::DeleteInterconnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteInterconnectResponse#interconnect_state #interconnect_state} => String
#
# @example Request syntax with placeholder values
@@ -1990,20 +1803,16 @@
def delete_interconnect(params = {}, options = {})
req = build_request(:delete_interconnect, params)
req.send_request(options)
end
- # Deletes a link aggregation group (LAG). You cannot delete a LAG if it
- # has active virtual interfaces or hosted connections.
+ # Deletes the specified link aggregation group (LAG). You cannot delete
+ # a LAG if it has active virtual interfaces or hosted connections.
#
# @option params [required, String] :lag_id
- # The ID of the LAG to delete.
+ # The ID of the LAG.
#
- # Example: dxlag-abc123
- #
- # Default: None
- #
# @return [Types::Lag] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Lag#connections_bandwidth #connections_bandwidth} => String
# * {Types::Lag#number_of_connections #number_of_connections} => Integer
# * {Types::Lag#lag_id #lag_id} => String
@@ -2015,10 +1824,11 @@
# * {Types::Lag#minimum_links #minimum_links} => Integer
# * {Types::Lag#aws_device #aws_device} => String
# * {Types::Lag#aws_device_v2 #aws_device_v2} => String
# * {Types::Lag#connections #connections} => Array<Types::Connection>
# * {Types::Lag#allows_hosted_connections #allows_hosted_connections} => Boolean
+ # * {Types::Lag#jumbo_frame_capable #jumbo_frame_capable} => Boolean
#
# @example Request syntax with placeholder values
#
# resp = client.delete_lag({
# lag_id: "LagId", # required
@@ -2048,12 +1858,14 @@
# 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 #=> Boolean
# resp.connections[0].aws_device_v2 #=> String
# resp.allows_hosted_connections #=> Boolean
+ # resp.jumbo_frame_capable #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DeleteLag AWS API Documentation
#
# @overload delete_lag(params = {})
# @param [Hash] params ({})
@@ -2065,14 +1877,10 @@
# Deletes a virtual interface.
#
# @option params [required, String] :virtual_interface_id
# The ID of the virtual interface.
#
- # Example: dxvif-123dfg56
- #
- # Default: None
- #
# @return [Types::DeleteVirtualInterfaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteVirtualInterfaceResponse#virtual_interface_state #virtual_interface_state} => String
#
# @example Request syntax with placeholder values
@@ -2092,47 +1900,37 @@
def delete_virtual_interface(params = {}, options = {})
req = build_request(:delete_virtual_interface, params)
req.send_request(options)
end
- # Deprecated in favor of DescribeLoa.
+ # Deprecated. Use DescribeLoa instead.
#
- # Returns the LOA-CFA for a Connection.
+ # 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][1] in the AWS Direct Connect user guide.
+ # Locations][1] in the *AWS Direct Connect User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html
#
# @option params [required, String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @option params [String] :provider_name
# The name of the APN partner or 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.
+ # 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.
#
- # Default: None
- #
# @option params [String] :loa_content_type
- # A standard media type indicating the content type of the LOA-CFA
- # document. Currently, the only supported value is "application/pdf".
+ # The standard media type for the LOA-CFA document. The only supported
+ # value is application/pdf.
#
- # Default: application/pdf
- #
# @return [Types::DescribeConnectionLoaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeConnectionLoaResponse#loa #loa} => Types::Loa
#
# @example Request syntax with placeholder values
@@ -2155,24 +1953,15 @@
def describe_connection_loa(params = {}, options = {})
req = build_request(:describe_connection_loa, params)
req.send_request(options)
end
- # Displays all connections in this region.
+ # Displays the specified connection or all connections in this Region.
#
- # If a connection ID is provided, the call returns only that particular
- # connection.
- #
# @option params [String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @return [Types::Connections] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connections#connections #connections} => Array<Types::Connection>
#
# @example Request syntax with placeholder values
@@ -2194,10 +1983,11 @@
# 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 #=> Boolean
# resp.connections[0].aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeConnections AWS API Documentation
#
# @overload describe_connections(params = {})
@@ -2205,26 +1995,22 @@
def describe_connections(params = {}, options = {})
req = build_request(:describe_connections, params)
req.send_request(options)
end
- # Deprecated in favor of DescribeHostedConnections.
+ # Deprecated. Use DescribeHostedConnections instead.
#
- # Returns a list of connections that have been provisioned on the given
+ # Lists the connections that have been provisioned on the specified
# interconnect.
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :interconnect_id
- # ID of the interconnect on which a list of connection is provisioned.
+ # The ID of the interconnect.
#
- # Example: dxcon-abc123
- #
- # Default: None
- #
# @return [Types::Connections] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connections#connections #connections} => Array<Types::Connection>
#
# @example Request syntax with placeholder values
@@ -2246,10 +2032,11 @@
# 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 #=> Boolean
# resp.connections[0].aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeConnectionsOnInterconnect AWS API Documentation
#
# @overload describe_connections_on_interconnect(params = {})
@@ -2257,47 +2044,32 @@
def describe_connections_on_interconnect(params = {}, options = {})
req = build_request(:describe_connections_on_interconnect, params)
req.send_request(options)
end
- # Returns a list of all direct connect gateway and virtual private
- # gateway (VGW) associations. Either a direct connect gateway ID or a
- # VGW ID must be provided in the request. If a direct connect gateway ID
- # is provided, the response returns all VGWs associated with the direct
- # connect gateway. If a VGW ID is provided, the response returns all
- # direct connect gateways associated with the VGW. If both are provided,
- # the response only returns the association that matches both the direct
- # connect gateway and the VGW.
+ # 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.
#
# @option params [String] :direct_connect_gateway_id
- # The ID of the direct connect gateway.
+ # The ID of the Direct Connect gateway.
#
- # Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
- #
- # Default: None
- #
# @option params [String] :virtual_gateway_id
# The ID of the virtual private gateway.
#
- # Example: "vgw-abc123ef"
- #
- # Default: None
- #
# @option params [Integer] :max_results
- # The maximum number of direct connect gateway associations to return
- # per page.
+ # The maximum number of associations to return per page.
#
- # Example: 15
- #
- # Default: None
- #
# @option params [String] :next_token
- # The token provided in the previous describe result to retrieve the
- # next page of the result.
+ # The token provided in the previous call to retrieve the next page.
#
- # Default: None
- #
# @return [Types::DescribeDirectConnectGatewayAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeDirectConnectGatewayAssociationsResult#direct_connect_gateway_associations #direct_connect_gateway_associations} => Array<Types::DirectConnectGatewayAssociation>
# * {Types::DescribeDirectConnectGatewayAssociationsResult#next_token #next_token} => String
#
@@ -2328,47 +2100,31 @@
def describe_direct_connect_gateway_associations(params = {}, options = {})
req = build_request(:describe_direct_connect_gateway_associations, params)
req.send_request(options)
end
- # Returns a list of all direct connect gateway and virtual interface
- # (VIF) attachments. Either a direct connect gateway ID or a VIF ID must
- # be provided in the request. If a direct connect gateway ID is
- # provided, the response returns all VIFs attached to the direct connect
- # gateway. If a VIF ID is provided, the response returns all direct
- # connect gateways attached to the VIF. If both are provided, the
- # response only returns the attachment that matches both the direct
- # connect gateway and the VIF.
+ # 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.
#
# @option params [String] :direct_connect_gateway_id
- # The ID of the direct connect gateway.
+ # The ID of the Direct Connect gateway.
#
- # Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
- #
- # Default: None
- #
# @option params [String] :virtual_interface_id
# The ID of the virtual interface.
#
- # Example: "dxvif-abc123ef"
- #
- # Default: None
- #
# @option params [Integer] :max_results
- # The maximum number of direct connect gateway attachments to return per
- # page.
+ # The maximum number of attachments to return per page.
#
- # Example: 15
- #
- # Default: None
- #
# @option params [String] :next_token
- # The token provided in the previous describe result to retrieve the
- # next page of the result.
+ # The token provided in the previous call to retrieve the next page.
#
- # Default: None
- #
# @return [Types::DescribeDirectConnectGatewayAttachmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeDirectConnectGatewayAttachmentsResult#direct_connect_gateway_attachments #direct_connect_gateway_attachments} => Array<Types::DirectConnectGatewayAttachment>
# * {Types::DescribeDirectConnectGatewayAttachmentsResult#next_token #next_token} => String
#
@@ -2399,37 +2155,22 @@
def describe_direct_connect_gateway_attachments(params = {}, options = {})
req = build_request(:describe_direct_connect_gateway_attachments, params)
req.send_request(options)
end
- # Returns a list of direct connect gateways in your account. Deleted
- # direct connect gateways are not returned. You can provide a direct
- # connect gateway ID in the request to return information about the
- # specific direct connect gateway only. Otherwise, if a direct connect
- # gateway ID is not provided, information about all of your direct
- # connect gateways is returned.
+ # Lists all your Direct Connect gateways or only the specified Direct
+ # Connect gateway. Deleted Direct Connect gateways are not returned.
#
# @option params [String] :direct_connect_gateway_id
- # The ID of the direct connect gateway.
+ # The ID of the Direct Connect gateway.
#
- # Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
- #
- # Default: None
- #
# @option params [Integer] :max_results
- # The maximum number of direct connect gateways to return per page.
+ # The maximum number of Direct Connect gateways to return per page.
#
- # Example: 15
- #
- # Default: None
- #
# @option params [String] :next_token
- # The token provided in the previous describe result to retrieve the
- # next page of the result.
+ # The token provided in the previous call to retrieve the next page.
#
- # Default: None
- #
# @return [Types::DescribeDirectConnectGatewaysResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeDirectConnectGatewaysResult#direct_connect_gateways #direct_connect_gateways} => Array<Types::DirectConnectGateway>
# * {Types::DescribeDirectConnectGatewaysResult#next_token #next_token} => String
#
@@ -2459,25 +2200,20 @@
def describe_direct_connect_gateways(params = {}, options = {})
req = build_request(:describe_direct_connect_gateways, params)
req.send_request(options)
end
- # Returns a list of hosted connections that have been provisioned on the
- # given interconnect or link aggregation group (LAG).
+ # Lists the hosted connections that have been provisioned on the
+ # specified interconnect or link aggregation group (LAG).
#
- # <note markdown="1"> This is intended for use by AWS Direct Connect partners only.
+ # <note markdown="1"> Intended for use by AWS Direct Connect partners only.
#
# </note>
#
# @option params [required, String] :connection_id
- # The ID of the interconnect or LAG on which the hosted connections are
- # provisioned.
+ # The ID of the interconnect or LAG.
#
- # Example: dxcon-abc123 or dxlag-abc123
- #
- # Default: None
- #
# @return [Types::Connections] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connections#connections #connections} => Array<Types::Connection>
#
# @example Request syntax with placeholder values
@@ -2499,10 +2235,11 @@
# 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 #=> Boolean
# resp.connections[0].aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeHostedConnections AWS API Documentation
#
# @overload describe_hosted_connections(params = {})
@@ -2510,43 +2247,37 @@
def describe_hosted_connections(params = {}, options = {})
req = build_request(:describe_hosted_connections, params)
req.send_request(options)
end
- # Deprecated in favor of DescribeLoa.
+ # Deprecated. Use DescribeLoa instead.
#
- # Returns the LOA-CFA for an Interconnect.
+ # 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][1] in the AWS Direct
- # Connect user guide.
+ # Cross Connects at AWS Direct Connect Locations][1] in the *AWS Direct
+ # Connect User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html
#
# @option params [required, String] :interconnect_id
# The ID of the interconnect.
#
- # Example: dxcon-abc123
- #
# @option params [String] :provider_name
# 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.
#
- # Default: None
- #
# @option params [String] :loa_content_type
- # A standard media type indicating the content type of the LOA-CFA
- # document. Currently, the only supported value is "application/pdf".
+ # The standard media type for the LOA-CFA document. The only supported
+ # value is application/pdf.
#
- # Default: application/pdf
- #
# @return [Types::DescribeInterconnectLoaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeInterconnectLoaResponse#loa #loa} => Types::Loa
#
# @example Request syntax with placeholder values
@@ -2569,20 +2300,16 @@
def describe_interconnect_loa(params = {}, options = {})
req = build_request(:describe_interconnect_loa, params)
req.send_request(options)
end
- # Returns a list of interconnects owned by the AWS account.
- #
- # If an interconnect ID is provided, it will only return this particular
+ # Lists the interconnects owned by the AWS account or only the specified
# interconnect.
#
# @option params [String] :interconnect_id
# The ID of the interconnect.
#
- # Example: dxcon-abc123
- #
# @return [Types::Interconnects] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Interconnects#interconnects #interconnects} => Array<Types::Interconnect>
#
# @example Request syntax with placeholder values
@@ -2601,10 +2328,11 @@
# 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 #=> Boolean
# resp.interconnects[0].aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeInterconnects AWS API Documentation
#
# @overload describe_interconnects(params = {})
@@ -2612,22 +2340,15 @@
def describe_interconnects(params = {}, options = {})
req = build_request(:describe_interconnects, params)
req.send_request(options)
end
- # Describes the link aggregation groups (LAGs) in your account.
+ # Describes all your link aggregation groups (LAG) or the specified LAG.
#
- # If a LAG ID is provided, only information about the specified LAG is
- # returned.
- #
# @option params [String] :lag_id
# The ID of the LAG.
#
- # Example: dxlag-abc123
- #
- # Default: None
- #
# @return [Types::Lags] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Lags#lags #lags} => Array<Types::Lag>
#
# @example Request syntax with placeholder values
@@ -2661,57 +2382,50 @@
# 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 #=> Boolean
# resp.lags[0].connections[0].aws_device_v2 #=> String
# resp.lags[0].allows_hosted_connections #=> Boolean
+ # resp.lags[0].jumbo_frame_capable #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeLags AWS API Documentation
#
# @overload describe_lags(params = {})
# @param [Hash] params ({})
def describe_lags(params = {}, options = {})
req = build_request(:describe_lags, params)
req.send_request(options)
end
- # Returns the LOA-CFA for a connection, interconnect, or link
- # aggregation group (LAG).
+ # Gets the LOA-CFA for a connection, interconnect, or link aggregation
+ # group (LAG).
#
# The Letter of Authorization - Connecting Facility Assignment (LOA-CFA)
# is a document that is used when establishing your cross connect to AWS
# at the colocation facility. For more information, see [Requesting
- # Cross Connects at AWS Direct Connect Locations][1] in the AWS Direct
- # Connect user guide.
+ # Cross Connects at AWS Direct Connect Locations][1] in the *AWS Direct
+ # Connect User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html
#
# @option params [required, String] :connection_id
- # The ID of a connection, LAG, or interconnect for which to get the
- # LOA-CFA information.
+ # The ID of a connection, LAG, or interconnect.
#
- # Example: dxcon-abc123 or dxlag-abc123
- #
- # Default: None
- #
# @option params [String] :provider_name
# The name of the service provider who establishes connectivity on your
- # behalf. If you supply this parameter, the LOA-CFA lists the provider
+ # behalf. If you specify this parameter, the LOA-CFA lists the provider
# name alongside your company name as the requester of the cross
# connect.
#
- # Default: None
- #
# @option params [String] :loa_content_type
- # A standard media type indicating the content type of the LOA-CFA
- # document. Currently, the only supported value is "application/pdf".
+ # The standard media type for the LOA-CFA document. The only supported
+ # value is application/pdf.
#
- # Default: application/pdf
- #
# @return [Types::Loa] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Loa#loa_content #loa_content} => String
# * {Types::Loa#loa_content_type #loa_content_type} => String
#
@@ -2735,12 +2449,12 @@
def describe_loa(params = {}, options = {})
req = build_request(:describe_loa, params)
req.send_request(options)
end
- # Returns the list of AWS Direct Connect locations in the current AWS
- # region. These are the locations that may be selected when calling
+ # Lists the AWS Direct Connect locations in the current AWS Region.
+ # These are the locations that can be selected when calling
# CreateConnection or CreateInterconnect.
#
# @return [Types::Locations] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Locations#locations #locations} => Array<Types::Location>
@@ -2759,15 +2473,15 @@
def describe_locations(params = {}, options = {})
req = build_request(:describe_locations, params)
req.send_request(options)
end
- # Describes the tags associated with the specified Direct Connect
+ # Describes the tags associated with the specified AWS Direct Connect
# resources.
#
# @option params [required, Array<String>] :resource_arns
- # The Amazon Resource Names (ARNs) of the Direct Connect resources.
+ # The Amazon Resource Names (ARNs) of the resources.
#
# @return [Types::DescribeTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeTagsResponse#resource_tags #resource_tags} => Array<Types::ResourceTag>
#
@@ -2792,21 +2506,15 @@
def describe_tags(params = {}, options = {})
req = build_request(:describe_tags, params)
req.send_request(options)
end
- # Returns a list of virtual private gateways owned by the AWS account.
+ # Lists the virtual private gateways owned by the AWS account.
#
# You can create one or more AWS Direct Connect private virtual
- # interfaces linking to a virtual private gateway. A virtual private
- # gateway can be managed via Amazon Virtual Private Cloud (VPC) console
- # or the [EC2 CreateVpnGateway][1] action.
+ # interfaces linked to a virtual private gateway.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html
- #
# @return [Types::VirtualGateways] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualGateways#virtual_gateways #virtual_gateways} => Array<Types::VirtualGateway>
#
# @example Response structure
@@ -2829,28 +2537,18 @@
# 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.
+ # Direct Connect location and the customer network.
#
# @option params [String] :connection_id
- # The ID of the connection. This field is also used as the ID type for
- # operations that use multiple connection types (LAG, interconnect,
- # and/or connection).
+ # The ID of the connection.
#
- # Example: dxcon-fg5678gh
- #
- # Default: None
- #
# @option params [String] :virtual_interface_id
# The ID of the virtual interface.
#
- # Example: dxvif-123dfg56
- #
- # Default: None
- #
# @return [Types::VirtualInterfaces] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VirtualInterfaces#virtual_interfaces #virtual_interfaces} => Array<Types::VirtualInterface>
#
# @example Request syntax with placeholder values
@@ -2876,10 +2574,12 @@
# 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"
# resp.virtual_interfaces[0].customer_router_config #=> String
+ # resp.virtual_interfaces[0].mtu #=> Integer
+ # resp.virtual_interfaces[0].jumbo_frame_capable #=> Boolean
# 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
@@ -2909,30 +2609,22 @@
# 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 will cause the LAG to fall below its
+ # 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.
#
# @option params [required, String] :connection_id
- # The ID of the connection to disassociate from the LAG.
+ # The ID of the connection. For example, dxcon-abc123.
#
- # Example: dxcon-abc123
- #
- # Default: None
- #
# @option params [required, String] :lag_id
- # The ID of the LAG.
+ # The ID of the LAG. For example, dxlag-abc123.
#
- # Example: dxlag-abc123
- #
- # Default: None
- #
# @return [Types::Connection] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Connection#owner_account #owner_account} => String
# * {Types::Connection#connection_id #connection_id} => String
# * {Types::Connection#connection_name #connection_name} => String
@@ -2943,10 +2635,11 @@
# * {Types::Connection#vlan #vlan} => Integer
# * {Types::Connection#partner_name #partner_name} => String
# * {Types::Connection#loa_issue_time #loa_issue_time} => Time
# * {Types::Connection#lag_id #lag_id} => String
# * {Types::Connection#aws_device #aws_device} => String
+ # * {Types::Connection#jumbo_frame_capable #jumbo_frame_capable} => Boolean
# * {Types::Connection#aws_device_v2 #aws_device_v2} => String
#
# @example Request syntax with placeholder values
#
# resp = client.disassociate_connection_from_lag({
@@ -2966,10 +2659,11 @@
# resp.vlan #=> Integer
# resp.partner_name #=> String
# resp.loa_issue_time #=> Time
# resp.lag_id #=> String
# resp.aws_device #=> String
+ # resp.jumbo_frame_capable #=> Boolean
# resp.aws_device_v2 #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DisassociateConnectionFromLag AWS API Documentation
#
# @overload disassociate_connection_from_lag(params = {})
@@ -2977,25 +2671,22 @@
def disassociate_connection_from_lag(params = {}, options = {})
req = build_request(:disassociate_connection_from_lag, params)
req.send_request(options)
end
- # Adds the specified tags to the specified Direct Connect resource. Each
- # Direct Connect resource can have a maximum of 50 tags.
+ # 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 Direct Connect resource, this
- # action updates its value.
+ # same key is already associated with the resource, this action updates
+ # its value.
#
# @option params [required, String] :resource_arn
- # The Amazon Resource Name (ARN) of the Direct Connect resource.
+ # The Amazon Resource Name (ARN) of the resource.
#
- # Example:
- # arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-fg5678gh
- #
# @option params [required, Array<Types::Tag>] :tags
- # The list of tags to add.
+ # The tags to add.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -3016,17 +2707,18 @@
def tag_resource(params = {}, options = {})
req = build_request(:tag_resource, params)
req.send_request(options)
end
- # Removes one or more tags from the specified Direct Connect resource.
+ # Removes one or more tags from the specified AWS Direct Connect
+ # resource.
#
# @option params [required, String] :resource_arn
- # The Amazon Resource Name (ARN) of the Direct Connect resource.
+ # The Amazon Resource Name (ARN) of the resource.
#
# @option params [required, Array<String>] :tag_keys
- # The list of tag keys to remove.
+ # The tag keys of the tags to remove.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -3042,47 +2734,37 @@
def untag_resource(params = {}, options = {})
req = build_request(:untag_resource, params)
req.send_request(options)
end
- # Updates the attributes of a link aggregation group (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
+ # operational connections is zero (0). If you update this value and the
# number of operational connections falls below the specified value, the
- # LAG will automatically go down to avoid overutilization of the
- # remaining connections. Adjusting this value should be done with care
- # as it could force the LAG down if the value is set higher than the
- # current number of operational connections.
+ # 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.
#
# @option params [required, String] :lag_id
- # The ID of the LAG to update.
+ # The ID of the LAG.
#
- # Example: dxlag-abc123
- #
- # Default: None
- #
# @option params [String] :lag_name
- # The name for the LAG.
+ # The name of the LAG.
#
- # Example: "`3x10G LAG to AWS`"
- #
- # Default: None
- #
# @option params [Integer] :minimum_links
# The minimum number of physical connections that must be operational
# for the LAG itself to be operational.
#
- # Default: None
- #
# @return [Types::Lag] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Lag#connections_bandwidth #connections_bandwidth} => String
# * {Types::Lag#number_of_connections #number_of_connections} => Integer
# * {Types::Lag#lag_id #lag_id} => String
@@ -3094,10 +2776,11 @@
# * {Types::Lag#minimum_links #minimum_links} => Integer
# * {Types::Lag#aws_device #aws_device} => String
# * {Types::Lag#aws_device_v2 #aws_device_v2} => String
# * {Types::Lag#connections #connections} => Array<Types::Connection>
# * {Types::Lag#allows_hosted_connections #allows_hosted_connections} => Boolean
+ # * {Types::Lag#jumbo_frame_capable #jumbo_frame_capable} => Boolean
#
# @example Request syntax with placeholder values
#
# resp = client.update_lag({
# lag_id: "LagId", # required
@@ -3129,22 +2812,120 @@
# 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 #=> Boolean
# resp.connections[0].aws_device_v2 #=> String
# resp.allows_hosted_connections #=> Boolean
+ # resp.jumbo_frame_capable #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/UpdateLag AWS API Documentation
#
# @overload update_lag(params = {})
# @param [Hash] params ({})
def update_lag(params = {}, options = {})
req = build_request(:update_lag, params)
req.send_request(options)
end
+ # 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 interface supports jumbo frames, call
+ # DescribeVirtualInterfaces.
+ #
+ # @option params [required, String] :virtual_interface_id
+ # The ID of the virtual private interface.
+ #
+ # @option params [Integer] :mtu
+ # The maximum transmission unit (MTU), in bytes. The supported values
+ # are 1500 and 9001. The default value is 1500.
+ #
+ # @return [Types::VirtualInterface] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::VirtualInterface#owner_account #owner_account} => String
+ # * {Types::VirtualInterface#virtual_interface_id #virtual_interface_id} => String
+ # * {Types::VirtualInterface#location #location} => String
+ # * {Types::VirtualInterface#connection_id #connection_id} => String
+ # * {Types::VirtualInterface#virtual_interface_type #virtual_interface_type} => String
+ # * {Types::VirtualInterface#virtual_interface_name #virtual_interface_name} => String
+ # * {Types::VirtualInterface#vlan #vlan} => Integer
+ # * {Types::VirtualInterface#asn #asn} => Integer
+ # * {Types::VirtualInterface#amazon_side_asn #amazon_side_asn} => Integer
+ # * {Types::VirtualInterface#auth_key #auth_key} => String
+ # * {Types::VirtualInterface#amazon_address #amazon_address} => String
+ # * {Types::VirtualInterface#customer_address #customer_address} => String
+ # * {Types::VirtualInterface#address_family #address_family} => String
+ # * {Types::VirtualInterface#virtual_interface_state #virtual_interface_state} => String
+ # * {Types::VirtualInterface#customer_router_config #customer_router_config} => String
+ # * {Types::VirtualInterface#mtu #mtu} => Integer
+ # * {Types::VirtualInterface#jumbo_frame_capable #jumbo_frame_capable} => Boolean
+ # * {Types::VirtualInterface#virtual_gateway_id #virtual_gateway_id} => String
+ # * {Types::VirtualInterface#direct_connect_gateway_id #direct_connect_gateway_id} => String
+ # * {Types::VirtualInterface#route_filter_prefixes #route_filter_prefixes} => Array<Types::RouteFilterPrefix>
+ # * {Types::VirtualInterface#bgp_peers #bgp_peers} => Array<Types::BGPPeer>
+ # * {Types::VirtualInterface#region #region} => String
+ # * {Types::VirtualInterface#aws_device_v2 #aws_device_v2} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.update_virtual_interface_attributes({
+ # virtual_interface_id: "VirtualInterfaceId", # required
+ # mtu: 1,
+ # })
+ #
+ # @example 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"
+ # resp.customer_router_config #=> String
+ # resp.mtu #=> Integer
+ # resp.jumbo_frame_capable #=> Boolean
+ # 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].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"
+ # resp.bgp_peers[0].aws_device_v2 #=> String
+ # resp.region #=> String
+ # resp.aws_device_v2 #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes AWS API Documentation
+ #
+ # @overload update_virtual_interface_attributes(params = {})
+ # @param [Hash] params ({})
+ def update_virtual_interface_attributes(params = {}, options = {})
+ req = build_request(:update_virtual_interface_attributes, params)
+ req.send_request(options)
+ end
+
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
@@ -3154,10 +2935,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-directconnect'
- context[:gem_version] = '1.5.0'
+ context[:gem_version] = '1.6.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated