VirtualInterface (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.directconnect.model.VirtualInterface

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VirtualInterface
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VirtualInterface()

Constructors
Constructor and Description
`VirtualInterface()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VirtualInterface`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAddressFamily()`
`String`	`getAmazonAddress()`
`Long`	`getAmazonSideAsn()` The autonomous system number (ASN) for the Amazon side of the connection.
`Integer`	`getAsn()`
`String`	`getAuthKey()`
`String`	`getAwsDeviceV2()` The Direct Connection endpoint which the virtual interface terminates on.
`List<BGPPeer>`	`getBgpPeers()`
`String`	`getConnectionId()`
`String`	`getCustomerAddress()`
`String`	`getCustomerRouterConfig()` Information for generating the customer router configuration.
`String`	`getDirectConnectGatewayId()`
`String`	`getLocation()`
`String`	`getOwnerAccount()` The AWS account that will own the new virtual interface.
`String`	`getRegion()` The AWS region where the virtual interface is located.
`List<RouteFilterPrefix>`	`getRouteFilterPrefixes()`
`String`	`getVirtualGatewayId()`
`String`	`getVirtualInterfaceId()`
`String`	`getVirtualInterfaceName()`
`String`	`getVirtualInterfaceState()`
`String`	`getVirtualInterfaceType()`
`Integer`	`getVlan()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddressFamily(AddressFamily addressFamily)`
`void`	`setAddressFamily(String addressFamily)`
`void`	`setAmazonAddress(String amazonAddress)`
`void`	`setAmazonSideAsn(Long amazonSideAsn)` The autonomous system number (ASN) for the Amazon side of the connection.
`void`	`setAsn(Integer asn)`
`void`	`setAuthKey(String authKey)`
`void`	`setAwsDeviceV2(String awsDeviceV2)` The Direct Connection endpoint which the virtual interface terminates on.
`void`	`setBgpPeers(Collection<BGPPeer> bgpPeers)`
`void`	`setConnectionId(String connectionId)`
`void`	`setCustomerAddress(String customerAddress)`
`void`	`setCustomerRouterConfig(String customerRouterConfig)` Information for generating the customer router configuration.
`void`	`setDirectConnectGatewayId(String directConnectGatewayId)`
`void`	`setLocation(String location)`
`void`	`setOwnerAccount(String ownerAccount)` The AWS account that will own the new virtual interface.
`void`	`setRegion(String region)` The AWS region where the virtual interface is located.
`void`	`setRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)`
`void`	`setVirtualGatewayId(String virtualGatewayId)`
`void`	`setVirtualInterfaceId(String virtualInterfaceId)`
`void`	`setVirtualInterfaceName(String virtualInterfaceName)`
`void`	`setVirtualInterfaceState(String virtualInterfaceState)`
`void`	`setVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState)`
`void`	`setVirtualInterfaceType(String virtualInterfaceType)`
`void`	`setVlan(Integer vlan)`
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`VirtualInterface`	`withAddressFamily(AddressFamily addressFamily)`
`VirtualInterface`	`withAddressFamily(String addressFamily)`
`VirtualInterface`	`withAmazonAddress(String amazonAddress)`
`VirtualInterface`	`withAmazonSideAsn(Long amazonSideAsn)` The autonomous system number (ASN) for the Amazon side of the connection.
`VirtualInterface`	`withAsn(Integer asn)`
`VirtualInterface`	`withAuthKey(String authKey)`
`VirtualInterface`	`withAwsDeviceV2(String awsDeviceV2)` The Direct Connection endpoint which the virtual interface terminates on.
`VirtualInterface`	`withBgpPeers(BGPPeer... bgpPeers)` NOTE: This method appends the values to the existing list (if any).
`VirtualInterface`	`withBgpPeers(Collection<BGPPeer> bgpPeers)`
`VirtualInterface`	`withConnectionId(String connectionId)`
`VirtualInterface`	`withCustomerAddress(String customerAddress)`
`VirtualInterface`	`withCustomerRouterConfig(String customerRouterConfig)` Information for generating the customer router configuration.
`VirtualInterface`	`withDirectConnectGatewayId(String directConnectGatewayId)`
`VirtualInterface`	`withLocation(String location)`
`VirtualInterface`	`withOwnerAccount(String ownerAccount)` The AWS account that will own the new virtual interface.
`VirtualInterface`	`withRegion(String region)` The AWS region where the virtual interface is located.
`VirtualInterface`	`withRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)`
`VirtualInterface`	`withRouteFilterPrefixes(RouteFilterPrefix... routeFilterPrefixes)` NOTE: This method appends the values to the existing list (if any).
`VirtualInterface`	`withVirtualGatewayId(String virtualGatewayId)`
`VirtualInterface`	`withVirtualInterfaceId(String virtualInterfaceId)`
`VirtualInterface`	`withVirtualInterfaceName(String virtualInterfaceName)`
`VirtualInterface`	`withVirtualInterfaceState(String virtualInterfaceState)`
`VirtualInterface`	`withVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState)`
`VirtualInterface`	`withVirtualInterfaceType(String virtualInterfaceType)`
`VirtualInterface`	`withVlan(Integer vlan)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VirtualInterface
```
public VirtualInterface()
```
- Method Detail
  - setOwnerAccount
```
public void setOwnerAccount(String ownerAccount)
```
    The AWS account that will own the new virtual interface.
    
    Parameters:
    
    ownerAccount - The AWS account that will own the new virtual interface.
  - getOwnerAccount
```
public String getOwnerAccount()
```
    The AWS account that will own the new virtual interface.
    
    Returns:
    
    The AWS account that will own the new virtual interface.
  - withOwnerAccount
```
public VirtualInterface withOwnerAccount(String ownerAccount)
```
    The AWS account that will own the new virtual interface.
    
    Parameters:
    
    ownerAccount - The AWS account that will own the new virtual interface.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVirtualInterfaceId
```
public void setVirtualInterfaceId(String virtualInterfaceId)
```
    Parameters:
    
    virtualInterfaceId -
  - getVirtualInterfaceId
```
public String getVirtualInterfaceId()
```
    Returns:
  - withVirtualInterfaceId
```
public VirtualInterface withVirtualInterfaceId(String virtualInterfaceId)
```
    Parameters:
    
    virtualInterfaceId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(String location)
```
    Parameters:
    
    location -
  - getLocation
```
public String getLocation()
```
    Returns:
  - withLocation
```
public VirtualInterface withLocation(String location)
```
    Parameters:
    
    location -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionId
```
public void setConnectionId(String connectionId)
```
    Parameters:
    
    connectionId -
  - getConnectionId
```
public String getConnectionId()
```
    Returns:
  - withConnectionId
```
public VirtualInterface withConnectionId(String connectionId)
```
    Parameters:
    
    connectionId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVirtualInterfaceType
```
public void setVirtualInterfaceType(String virtualInterfaceType)
```
    Parameters:
    
    virtualInterfaceType -
  - getVirtualInterfaceType
```
public String getVirtualInterfaceType()
```
    Returns:
  - withVirtualInterfaceType
```
public VirtualInterface withVirtualInterfaceType(String virtualInterfaceType)
```
    Parameters:
    
    virtualInterfaceType -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVirtualInterfaceName
```
public void setVirtualInterfaceName(String virtualInterfaceName)
```
    Parameters:
    
    virtualInterfaceName -
  - getVirtualInterfaceName
```
public String getVirtualInterfaceName()
```
    Returns:
  - withVirtualInterfaceName
```
public VirtualInterface withVirtualInterfaceName(String virtualInterfaceName)
```
    Parameters:
    
    virtualInterfaceName -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVlan
```
public void setVlan(Integer vlan)
```
    Parameters:
    
    vlan -
  - getVlan
```
public Integer getVlan()
```
    Returns:
  - withVlan
```
public VirtualInterface withVlan(Integer vlan)
```
    Parameters:
    
    vlan -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAsn
```
public void setAsn(Integer asn)
```
    Parameters:
    
    asn -
  - getAsn
```
public Integer getAsn()
```
    Returns:
  - withAsn
```
public VirtualInterface withAsn(Integer asn)
```
    Parameters:
    
    asn -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAmazonSideAsn
```
public void setAmazonSideAsn(Long amazonSideAsn)
```
    The autonomous system number (ASN) for the Amazon side of the connection.
    
    Parameters:
    
    amazonSideAsn - The autonomous system number (ASN) for the Amazon side of the connection.
  - getAmazonSideAsn
```
public Long getAmazonSideAsn()
```
    The autonomous system number (ASN) for the Amazon side of the connection.
    
    Returns:
    
    The autonomous system number (ASN) for the Amazon side of the connection.
  - withAmazonSideAsn
```
public VirtualInterface withAmazonSideAsn(Long amazonSideAsn)
```
    The autonomous system number (ASN) for the Amazon side of the connection.
    
    Parameters:
    
    amazonSideAsn - The autonomous system number (ASN) for the Amazon side of the connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthKey
```
public void setAuthKey(String authKey)
```
    Parameters:
    
    authKey -
  - getAuthKey
```
public String getAuthKey()
```
    Returns:
  - withAuthKey
```
public VirtualInterface withAuthKey(String authKey)
```
    Parameters:
    
    authKey -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAmazonAddress
```
public void setAmazonAddress(String amazonAddress)
```
    Parameters:
    
    amazonAddress -
  - getAmazonAddress
```
public String getAmazonAddress()
```
    Returns:
  - withAmazonAddress
```
public VirtualInterface withAmazonAddress(String amazonAddress)
```
    Parameters:
    
    amazonAddress -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerAddress
```
public void setCustomerAddress(String customerAddress)
```
    Parameters:
    
    customerAddress -
  - getCustomerAddress
```
public String getCustomerAddress()
```
    Returns:
  - withCustomerAddress
```
public VirtualInterface withCustomerAddress(String customerAddress)
```
    Parameters:
    
    customerAddress -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAddressFamily
```
public void setAddressFamily(String addressFamily)
```
    Parameters:
    
    addressFamily -
    
    See Also:
    
    AddressFamily
  - getAddressFamily
```
public String getAddressFamily()
```
    Returns:
    
    See Also:
    
    AddressFamily
  - withAddressFamily
```
public VirtualInterface withAddressFamily(String addressFamily)
```
    Parameters:
    
    addressFamily -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AddressFamily
  - setAddressFamily
```
public void setAddressFamily(AddressFamily addressFamily)
```
    Parameters:
    
    addressFamily -
    
    See Also:
    
    AddressFamily
  - withAddressFamily
```
public VirtualInterface withAddressFamily(AddressFamily addressFamily)
```
    Parameters:
    
    addressFamily -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AddressFamily
  - setVirtualInterfaceState
```
public void setVirtualInterfaceState(String virtualInterfaceState)
```
    Parameters:
    
    virtualInterfaceState -
    
    See Also:
    
    VirtualInterfaceState
  - getVirtualInterfaceState
```
public String getVirtualInterfaceState()
```
    Returns:
    
    See Also:
    
    VirtualInterfaceState
  - withVirtualInterfaceState
```
public VirtualInterface withVirtualInterfaceState(String virtualInterfaceState)
```
    Parameters:
    
    virtualInterfaceState -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VirtualInterfaceState
  - setVirtualInterfaceState
```
public void setVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState)
```
    Parameters:
    
    virtualInterfaceState -
    
    See Also:
    
    VirtualInterfaceState
  - withVirtualInterfaceState
```
public VirtualInterface withVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState)
```
    Parameters:
    
    virtualInterfaceState -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VirtualInterfaceState
  - setCustomerRouterConfig
```
public void setCustomerRouterConfig(String customerRouterConfig)
```
    Information for generating the customer router configuration.
    
    Parameters:
    
    customerRouterConfig - Information for generating the customer router configuration.
  - getCustomerRouterConfig
```
public String getCustomerRouterConfig()
```
    Information for generating the customer router configuration.
    
    Returns:
    
    Information for generating the customer router configuration.
  - withCustomerRouterConfig
```
public VirtualInterface withCustomerRouterConfig(String customerRouterConfig)
```
    Information for generating the customer router configuration.
    
    Parameters:
    
    customerRouterConfig - Information for generating the customer router configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVirtualGatewayId
```
public void setVirtualGatewayId(String virtualGatewayId)
```
    Parameters:
    
    virtualGatewayId -
  - getVirtualGatewayId
```
public String getVirtualGatewayId()
```
    Returns:
  - withVirtualGatewayId
```
public VirtualInterface withVirtualGatewayId(String virtualGatewayId)
```
    Parameters:
    
    virtualGatewayId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDirectConnectGatewayId
```
public void setDirectConnectGatewayId(String directConnectGatewayId)
```
    Parameters:
    
    directConnectGatewayId -
  - getDirectConnectGatewayId
```
public String getDirectConnectGatewayId()
```
    Returns:
  - withDirectConnectGatewayId
```
public VirtualInterface withDirectConnectGatewayId(String directConnectGatewayId)
```
    Parameters:
    
    directConnectGatewayId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRouteFilterPrefixes
```
public List<RouteFilterPrefix> getRouteFilterPrefixes()
```
    Returns:
  - setRouteFilterPrefixes
```
public void setRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)
```
    Parameters:
    
    routeFilterPrefixes -
  - withRouteFilterPrefixes
```
public VirtualInterface withRouteFilterPrefixes(RouteFilterPrefix... routeFilterPrefixes)
```
    NOTE: This method appends the values to the existing list (if any). Use setRouteFilterPrefixes(java.util.Collection) or withRouteFilterPrefixes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    routeFilterPrefixes -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRouteFilterPrefixes
```
public VirtualInterface withRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)
```
    Parameters:
    
    routeFilterPrefixes -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBgpPeers
```
public List<BGPPeer> getBgpPeers()
```
    Returns:
  - setBgpPeers
```
public void setBgpPeers(Collection<BGPPeer> bgpPeers)
```
    Parameters:
    
    bgpPeers -
  - withBgpPeers
```
public VirtualInterface withBgpPeers(BGPPeer... bgpPeers)
```
    NOTE: This method appends the values to the existing list (if any). Use setBgpPeers(java.util.Collection) or withBgpPeers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    bgpPeers -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBgpPeers
```
public VirtualInterface withBgpPeers(Collection<BGPPeer> bgpPeers)
```
    Parameters:
    
    bgpPeers -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegion
```
public void setRegion(String region)
```
    The AWS region where the virtual interface is located.
    
    Example: us-east-1
    
    Default: None
    
    Parameters:
    
    region - The AWS region where the virtual interface is located.
    
    Example: us-east-1
    
    Default: None
  - getRegion
```
public String getRegion()
```
    The AWS region where the virtual interface is located.
    
    Example: us-east-1
    
    Default: None
    
    Returns:
    
    The AWS region where the virtual interface is located.
    
    Example: us-east-1
    
    Default: None
  - withRegion
```
public VirtualInterface withRegion(String region)
```
    The AWS region where the virtual interface is located.
    
    Example: us-east-1
    
    Default: None
    
    Parameters:
    
    region - The AWS region where the virtual interface is located.
    
    Example: us-east-1
    
    Default: None
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAwsDeviceV2
```
public void setAwsDeviceV2(String awsDeviceV2)
```
    The Direct Connection endpoint which the virtual interface terminates on.
    
    Parameters:
    
    awsDeviceV2 - The Direct Connection endpoint which the virtual interface terminates on.
  - getAwsDeviceV2
```
public String getAwsDeviceV2()
```
    The Direct Connection endpoint which the virtual interface terminates on.
    
    Returns:
    
    The Direct Connection endpoint which the virtual interface terminates on.
  - withAwsDeviceV2
```
public VirtualInterface withAwsDeviceV2(String awsDeviceV2)
```
    The Direct Connection endpoint which the virtual interface terminates on.
    
    Parameters:
    
    awsDeviceV2 - The Direct Connection endpoint which the virtual interface terminates on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VirtualInterface clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class VirtualInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualInterface

Method Detail

setOwnerAccount

getOwnerAccount

withOwnerAccount

setVirtualInterfaceId

getVirtualInterfaceId

withVirtualInterfaceId

setLocation

getLocation

withLocation

setConnectionId

getConnectionId

withConnectionId

setVirtualInterfaceType

getVirtualInterfaceType

withVirtualInterfaceType

setVirtualInterfaceName

getVirtualInterfaceName

withVirtualInterfaceName

setVlan

getVlan

withVlan

setAsn

getAsn

withAsn

setAmazonSideAsn

getAmazonSideAsn

withAmazonSideAsn

setAuthKey

getAuthKey

withAuthKey

setAmazonAddress

getAmazonAddress

withAmazonAddress

setCustomerAddress

getCustomerAddress

withCustomerAddress

setAddressFamily

getAddressFamily

withAddressFamily

setAddressFamily

withAddressFamily

setVirtualInterfaceState

getVirtualInterfaceState

withVirtualInterfaceState

setVirtualInterfaceState

withVirtualInterfaceState

setCustomerRouterConfig

getCustomerRouterConfig

withCustomerRouterConfig

setVirtualGatewayId

getVirtualGatewayId

withVirtualGatewayId

setDirectConnectGatewayId

getDirectConnectGatewayId

withDirectConnectGatewayId

getRouteFilterPrefixes

setRouteFilterPrefixes

withRouteFilterPrefixes

withRouteFilterPrefixes

getBgpPeers

setBgpPeers

withBgpPeers

withBgpPeers

setRegion

getRegion

withRegion

setAwsDeviceV2

getAwsDeviceV2

withAwsDeviceV2

toString

equals

hashCode