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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb

Overview

Information about a virtual interface.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

The address family for the BGP peer.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#amazon_addressString

The IP address assigned to the Amazon interface.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#amazon_side_asnInteger

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

Returns:

  • (Integer)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#asnInteger

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

The valid values are 1-2147483647.

Returns:

  • (Integer)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#auth_keyString

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#aws_device_v2String

The Direct Connect endpoint that terminates the physical connection.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#aws_logical_device_idString

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#bgp_peersArray<Types::BGPPeer>

The BGP peers configured on this virtual interface.

Returns:



3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#connection_idString

The ID of the connection.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#customer_addressString

The IP address assigned to the customer interface.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#customer_router_configString

The customer router configuration.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#direct_connect_gateway_idString

The ID of the Direct Connect gateway.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#jumbo_frame_capableBoolean

Indicates whether jumbo frames are supported.

Returns:

  • (Boolean)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#locationString

The location of the connection.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#mtuInteger

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

Returns:

  • (Integer)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#owner_accountString

The ID of the Amazon Web Services account that owns the virtual interface.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

The Amazon Web Services Region where the virtual interface is located.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#route_filter_prefixesArray<Types::RouteFilterPrefix>

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

Returns:



3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

Indicates whether SiteLink is enabled.

Returns:

  • (Boolean)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags associated with the virtual interface.

Returns:



3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_gateway_idString

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

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_interface_idString

The ID of the virtual interface.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_interface_nameString

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_interface_stateString

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.

  • unknown: The state of the virtual interface is not available.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_interface_typeString

The type of virtual interface. The possible values are private, public and transit.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#vlanInteger

The ID of the VLAN.

Returns:

  • (Integer)


3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3814

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,
  :aws_logical_device_id,
  :tags,
  :site_link_enabled)
  SENSITIVE = []
  include Aws::Structure
end