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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

The address family for the BGP peer.

Possible values:

  • ipv4
  • ipv6

Returns:

  • (String)

    The address family for the BGP peer.

#amazon_addressString

The IP address assigned to the Amazon interface.

Returns:

  • (String)

    The IP address assigned to the Amazon interface.

#amazon_side_asnInteger

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

Returns:

  • (Integer)

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

#asnInteger

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

Returns:

  • (Integer)

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

#auth_keyString

The authentication key for BGP configuration.

Returns:

  • (String)

    The authentication key for BGP configuration.

#aws_device_v2String

The Direct Connect endpoint on which the virtual interface terminates.

Returns:

  • (String)

    The Direct Connect endpoint on which the virtual interface terminates.

#bgp_peersArray<Types::BGPPeer>

The BGP peers configured on this virtual interface.

Returns:

  • (Array<Types::BGPPeer>)

    The BGP peers configured on this virtual interface.

#connection_idString

The ID of the connection.

Returns:

  • (String)

    The ID of the connection.

#customer_addressString

The IP address assigned to the customer interface.

Returns:

  • (String)

    The IP address assigned to the customer interface.

#customer_router_configString

The customer router configuration.

Returns:

  • (String)

    The customer router configuration.

#direct_connect_gateway_idString

The ID of the Direct Connect gateway.

Returns:

  • (String)

    The ID of the Direct Connect gateway.

#jumbo_frame_capableBoolean

Indicates whether jumbo frames (9001 MTU) are supported.

Returns:

  • (Boolean)

    Indicates whether jumbo frames (9001 MTU) are supported.

#locationString

The location of the connection.

Returns:

  • (String)

    The location of the connection.

#mtuInteger

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

Returns:

  • (Integer)

    The maximum transmission unit (MTU), in bytes.

#owner_accountString

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

Returns:

  • (String)

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

#regionString

The AWS Region where the virtual interface is located.

Returns:

  • (String)

    The AWS Region where the virtual interface is located.

#route_filter_prefixesArray<Types::RouteFilterPrefix>

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

Returns:

#virtual_gateway_idString

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

Returns:

  • (String)

    The ID of the virtual private gateway.

#virtual_interface_idString

The ID of the virtual interface.

Returns:

  • (String)

    The ID of the virtual interface.

#virtual_interface_nameString

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

Returns:

  • (String)

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

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

    Possible values:

    • confirming
    • verifying
    • pending
    • available
    • down
    • deleting
    • deleted
    • rejected
    • unknown

Returns:

  • (String)

    The state of the virtual interface.

#virtual_interface_typeString

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

Returns:

  • (String)

    The type of virtual interface.

#vlanInteger

The ID of the VLAN.

Returns:

  • (Integer)

    The ID of the VLAN.