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

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

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

Overview

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#amazon_addressString

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#amazon_side_asnInteger

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

Returns:

  • (Integer)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#asnInteger

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

Example: 65000

Returns:

  • (Integer)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#auth_keyString

The authentication key for BGP configuration.

Example: asdf34example

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#bgp_peersArray<Types::BGPPeer>

A list of the BGP peers configured on this virtual interface.

Returns:



3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#connection_idString

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).

Example: dxcon-fg5678gh

Default: None

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#customer_addressString

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#customer_router_configString

Information for generating the customer router configuration.

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#direct_connect_gateway_idString

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#locationString

Where the connection is located.

Example: EqSV5

Default: None

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#owner_accountString

The AWS account that will own the new virtual interface.

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#route_filter_prefixesArray<Types::RouteFilterPrefix>

A list of routes to be advertised to the AWS network in this region (public virtual interface).

Returns:



3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#virtual_gateway_idString

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#virtual_interface_idString

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#virtual_interface_nameString

The name of the virtual interface assigned by the customer.

Example: "My VPC"

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#virtual_interface_stateString

State of the virtual interface.

  • 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 will enter the 'Rejected' state.

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#virtual_interface_typeString

The type of virtual interface.

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end

#vlanInteger

The VLAN ID.

Example: 101

Returns:

  • (Integer)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3385

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,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :route_filter_prefixes,
  :bgp_peers)
  include Aws::Structure
end