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

Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

Possible values:

  • ipv4
  • ipv6

Returns:

  • (String)

    Indicates the address family for the BGP peer.

    • ipv4: IPv4 address family

    • ipv6: IPv6 address family

    .

#amazon_addressString

IP address assigned to the Amazon interface.

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

Returns:

  • (String)

    IP address assigned to the Amazon interface.

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

    .

#asnInteger

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

Example: 65000

Returns:

  • (Integer)

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

    Example: 65000

    .

#auth_keyString

The authentication key for BGP configuration.

Example: asdf34example

Returns:

  • (String)

    The authentication key for BGP configuration.

    Example: asdf34example

    .

#bgp_peersArray<Types::BGPPeer>

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

Returns:

  • (Array<Types::BGPPeer>)

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

    .

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

    The ID of the connection.

#customer_addressString

IP address assigned to the customer interface.

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

Returns:

  • (String)

    IP address assigned to the customer interface.

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

    .

#customer_router_configString

Information for generating the customer router configuration.

Returns:

  • (String)

    Information for generating the customer router configuration.

#locationString

Where the connection is located.

Example: EqSV5

Default: None

Returns:

  • (String)

    Where the connection is located.

    Example: EqSV5

    Default: None

    .

#owner_accountString

The AWS account that will own the new virtual interface.

Returns:

  • (String)

    The AWS account that will own the new virtual interface.

#route_filter_prefixesArray<Types::RouteFilterPrefix>

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

Returns:

  • (Array<Types::RouteFilterPrefix>)

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

    .

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

    The ID of the virtual private gateway to a VPC.

#virtual_interface_idString

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Returns:

  • (String)

    The ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

    .

#virtual_interface_nameString

The name of the virtual interface assigned by the customer.

Example: "My VPC"

Returns:

  • (String)

    The name of the virtual interface assigned by the customer.

    Example: "My VPC"

    .

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

Possible values:

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

Returns:

  • (String)

    State of the virtual interface.

    • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner.

#virtual_interface_typeString

The type of virtual interface.

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

Returns:

  • (String)

    The type of virtual interface.

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

    .

#vlanInteger

The VLAN ID.

Example: 101

Returns:

  • (Integer)

    The VLAN ID.

    Example: 101

    .