Class: Aws::DirectConnect::Types::VirtualInterface

Inherits:

Struct

Object
Struct
Aws::DirectConnect::Types::VirtualInterface

show all

Includes:: Structure

Defined in:: lib/aws-sdk-directconnect/types.rb

Overview

Information about a virtual interface.

Instance Attribute Summary collapse

#address_family ⇒ String

The address family for the BGP peer.
#amazon_address ⇒ String

The IP address assigned to the Amazon interface.
#amazon_side_asn ⇒ Integer

The autonomous system number (ASN) for the Amazon side of the connection.
#asn ⇒ Integer

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
#auth_key ⇒ String

The authentication key for BGP configuration.
#aws_device_v2 ⇒ String

The Direct Connect endpoint on which the virtual interface terminates.
#bgp_peers ⇒ Array<Types::BGPPeer>

The BGP peers configured on this virtual interface.
#connection_id ⇒ String

The ID of the connection.
#customer_address ⇒ String

The IP address assigned to the customer interface.
#customer_router_config ⇒ String

The customer router configuration.
#direct_connect_gateway_id ⇒ String

The ID of the Direct Connect gateway.
#jumbo_frame_capable ⇒ Boolean

Indicates whether jumbo frames (9001 MTU) are supported.
#location ⇒ String

The location of the connection.
#mtu ⇒ Integer

The maximum transmission unit (MTU), in bytes.
#owner_account ⇒ String

The ID of the AWS account that owns the virtual interface.
#region ⇒ String

The AWS Region where the virtual interface is located.
#route_filter_prefixes ⇒ Array<Types::RouteFilterPrefix>

The routes to be advertised to the AWS network in this Region.
#virtual_gateway_id ⇒ String

The ID of the virtual private gateway.
#virtual_interface_id ⇒ String

The ID of the virtual interface.
#virtual_interface_name ⇒ String

The name of the virtual interface assigned by the customer network.
#virtual_interface_state ⇒ String

The state of the virtual interface.
#virtual_interface_type ⇒ String

The type of virtual interface.
#vlan ⇒ Integer

The ID of the VLAN.

Instance Attribute Details

#address_family ⇒ `String`

The address family for the BGP peer.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#amazon_address ⇒ `String`

The IP address assigned to the Amazon interface.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#amazon_side_asn ⇒ `Integer`

The autonomous system number (ASN) for the Amazon side of the connection.

Returns:

(Integer)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#asn ⇒ `Integer`

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Returns:

(Integer)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#auth_key ⇒ `String`

The authentication key for BGP configuration.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#aws_device_v2 ⇒ `String`

The Direct Connect endpoint on which the virtual interface terminates.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#bgp_peers ⇒ `Array<Types::BGPPeer>`

The BGP peers configured on this virtual interface.

Returns:

(Array<Types::BGPPeer>)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#connection_id ⇒ `String`

The ID of the connection.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#customer_address ⇒ `String`

The IP address assigned to the customer interface.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#customer_router_config ⇒ `String`

The customer router configuration.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#direct_connect_gateway_id ⇒ `String`

The ID of the Direct Connect gateway.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#jumbo_frame_capable ⇒ `Boolean`

Indicates whether jumbo frames (9001 MTU) are supported.

Returns:

(Boolean)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#location ⇒ `String`

The location of the connection.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#mtu ⇒ `Integer`

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Returns:

(Integer)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#owner_account ⇒ `String`

The ID of the AWS account that owns the virtual interface.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#region ⇒ `String`

The AWS Region where the virtual interface is located.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#route_filter_prefixes ⇒ `Array<Types::RouteFilterPrefix>`

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Returns:

(Array<Types::RouteFilterPrefix>)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#virtual_gateway_id ⇒ `String`

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#virtual_interface_id ⇒ `String`

The ID of the virtual interface.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#virtual_interface_name ⇒ `String`

The name of the virtual interface assigned by the customer network.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#virtual_interface_state ⇒ `String`

The state of the virtual interface. The following are the possible values:

‘confirming`: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
‘verifying`: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
‘pending`: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
‘available`: A virtual interface that is able to forward traffic.
‘down`: A virtual interface that is BGP down.
‘deleting`: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
‘deleted`: A virtual interface that cannot forward traffic.
‘rejected`: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the `Confirming` state is deleted by the virtual interface owner, the virtual interface enters the `Rejected` state.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#virtual_interface_type ⇒ `String`

The type of virtual interface. The possible values are ‘private` and `public`.

Returns:

(String)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

#vlan ⇒ `Integer`

The ID of the VLAN.

Returns:

(Integer)

# File 'lib/aws-sdk-directconnect/types.rb', line 2740

class VirtualInterface < Struct.new(
  :owner_account,
  :virtual_interface_id,
  :location,
  :connection_id,
  :virtual_interface_type,
  :virtual_interface_name,
  :vlan,
  :asn,
  :amazon_side_asn,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_interface_state,
  :customer_router_config,
  :mtu,
  :jumbo_frame_capable,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers,
  :region,
  :aws_device_v2)
  include Aws::Structure
end

Class: Aws::DirectConnect::Types::VirtualInterface

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#address_family ⇒ String

#amazon_address ⇒ String

#amazon_side_asn ⇒ Integer

#asn ⇒ Integer

#auth_key ⇒ String

#aws_device_v2 ⇒ String

#bgp_peers ⇒ Array<Types::BGPPeer>

#connection_id ⇒ String

#customer_address ⇒ String

#customer_router_config ⇒ String

#direct_connect_gateway_id ⇒ String

#jumbo_frame_capable ⇒ Boolean

#location ⇒ String

#mtu ⇒ Integer

#owner_account ⇒ String

#region ⇒ String

#route_filter_prefixes ⇒ Array<Types::RouteFilterPrefix>

#virtual_gateway_id ⇒ String

#virtual_interface_id ⇒ String

#virtual_interface_name ⇒ String

#virtual_interface_state ⇒ String

#virtual_interface_type ⇒ String

#vlan ⇒ Integer

#address_family ⇒ `String`

#amazon_address ⇒ `String`

#amazon_side_asn ⇒ `Integer`

#asn ⇒ `Integer`

#auth_key ⇒ `String`

#aws_device_v2 ⇒ `String`

#bgp_peers ⇒ `Array<Types::BGPPeer>`

#connection_id ⇒ `String`

#customer_address ⇒ `String`

#customer_router_config ⇒ `String`

#direct_connect_gateway_id ⇒ `String`

#jumbo_frame_capable ⇒ `Boolean`

#location ⇒ `String`

#mtu ⇒ `Integer`

#owner_account ⇒ `String`

#region ⇒ `String`

#route_filter_prefixes ⇒ `Array<Types::RouteFilterPrefix>`

#virtual_gateway_id ⇒ `String`

#virtual_interface_id ⇒ `String`

#virtual_interface_name ⇒ `String`

#virtual_interface_state ⇒ `String`

#virtual_interface_type ⇒ `String`

#vlan ⇒ `Integer`