class Aws::DirectConnect::Types::VirtualInterface

Information about a virtual interface.

@!attribute [rw] owner_account

The ID of the account that owns the virtual interface.
@return [String]

@!attribute [rw] virtual_interface_id

The ID of the virtual interface.
@return [String]

@!attribute [rw] location

The location of the connection.
@return [String]

@!attribute [rw] connection_id

The ID of the connection.
@return [String]

@!attribute [rw] virtual_interface_type

The type of virtual interface. The possible values are `private` and
`public`.
@return [String]

@!attribute [rw] virtual_interface_name

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 (-).
@return [String]

@!attribute [rw] vlan

The ID of the VLAN.
@return [Integer]

@!attribute [rw] asn

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

The valid values are 1-2147483647.
@return [Integer]

@!attribute [rw] amazon_side_asn

The autonomous system number (ASN) for the Amazon side of the
connection.
@return [Integer]

@!attribute [rw] auth_key

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

@!attribute [rw] amazon_address

The IP address assigned to the Amazon interface.
@return [String]

@!attribute [rw] customer_address

The IP address assigned to the customer interface.
@return [String]

@!attribute [rw] address_family

The address family for the BGP peer.
@return [String]

@!attribute [rw] virtual_interface_state

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.
@return [String]

@!attribute [rw] customer_router_config

The customer router configuration.
@return [String]

@!attribute [rw] mtu

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

@!attribute [rw] jumbo_frame_capable

Indicates whether jumbo frames (9001 MTU) are supported.
@return [Boolean]

@!attribute [rw] virtual_gateway_id

The ID of the virtual private gateway. Applies only to private
virtual interfaces.
@return [String]

@!attribute [rw] direct_connect_gateway_id

The ID of the Direct Connect gateway.
@return [String]

@!attribute [rw] route_filter_prefixes

The routes to be advertised to the Amazon Web Services network in
this Region. Applies to public virtual interfaces.
@return [Array<Types::RouteFilterPrefix>]

@!attribute [rw] bgp_peers

The BGP peers configured on this virtual interface.
@return [Array<Types::BGPPeer>]

@!attribute [rw] region

The Region where the virtual interface is located.
@return [String]

@!attribute [rw] aws_device_v2

The Direct Connect endpoint that terminates the physical connection.
@return [String]

@!attribute [rw] aws_logical_device_id

The Direct Connect endpoint that terminates the logical connection.
This device might be different than the device that terminates the
physical connection.
@return [String]

@!attribute [rw] tags

The tags associated with the virtual interface.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/VirtualInterface AWS API Documentation

Constants

SENSITIVE