com.amazonaws.services.directconnect.model
Class VirtualInterface

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

All Implemented Interfaces:

Serializable

public class VirtualInterface
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

VirtualInterface()

Method Summary

boolean	equals(Object obj)
String	getAmazonAddress() IP address assigned to the Amazon interface.
Integer	getAsn() Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration
String	getAuthKey() Authentication key for BGP configuration
String	getConnectionId() ID of the connection.
String	getCustomerAddress() IP address assigned to the customer interface.
String	getCustomerRouterConfig() Information for generating the customer router configuration.
String	getLocation() Where the AWS Direct Connect offering is located.
List<RouteFilterPrefix>	getRouteFilterPrefixes() A list of route filter prefixes.
String	getVirtualGatewayId() Virtual private gateway to a VPC.
String	getVirtualInterfaceId() ID of the virtual interface.
String	getVirtualInterfaceName() The name of the virtual interface assigned by the customer
String	getVirtualInterfaceState() State of the virtual interface.
String	getVirtualInterfaceType() The type of virtual interface
Integer	getVlan() VLAN ID
int	hashCode()
void	setAmazonAddress(String amazonAddress) IP address assigned to the Amazon interface.
void	setAsn(Integer asn) Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration
void	setAuthKey(String authKey) Authentication key for BGP configuration
void	setConnectionId(String connectionId) ID of the connection.
void	setCustomerAddress(String customerAddress) IP address assigned to the customer interface.
void	setCustomerRouterConfig(String customerRouterConfig) Information for generating the customer router configuration.
void	setLocation(String location) Where the AWS Direct Connect offering is located.
void	setRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes) A list of route filter prefixes.
void	setVirtualGatewayId(String virtualGatewayId) Virtual private gateway to a VPC.
void	setVirtualInterfaceId(String virtualInterfaceId) ID of the virtual interface.
void	setVirtualInterfaceName(String virtualInterfaceName) The name of the virtual interface assigned by the customer
void	setVirtualInterfaceState(String virtualInterfaceState) State of the virtual interface.
void	setVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState) State of the virtual interface.
void	setVirtualInterfaceType(String virtualInterfaceType) The type of virtual interface
void	setVlan(Integer vlan) VLAN ID
String	toString() Returns a string representation of this object; useful for testing and debugging.
VirtualInterface	withAmazonAddress(String amazonAddress) IP address assigned to the Amazon interface.
VirtualInterface	withAsn(Integer asn) Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration
VirtualInterface	withAuthKey(String authKey) Authentication key for BGP configuration
VirtualInterface	withConnectionId(String connectionId) ID of the connection.
VirtualInterface	withCustomerAddress(String customerAddress) IP address assigned to the customer interface.
VirtualInterface	withCustomerRouterConfig(String customerRouterConfig) Information for generating the customer router configuration.
VirtualInterface	withLocation(String location) Where the AWS Direct Connect offering is located.
VirtualInterface	withRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes) A list of route filter prefixes.
VirtualInterface	withRouteFilterPrefixes(RouteFilterPrefix... routeFilterPrefixes) A list of route filter prefixes.
VirtualInterface	withVirtualGatewayId(String virtualGatewayId) Virtual private gateway to a VPC.
VirtualInterface	withVirtualInterfaceId(String virtualInterfaceId) ID of the virtual interface.
VirtualInterface	withVirtualInterfaceName(String virtualInterfaceName) The name of the virtual interface assigned by the customer
VirtualInterface	withVirtualInterfaceState(String virtualInterfaceState) State of the virtual interface.
VirtualInterface	withVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState) State of the virtual interface.
VirtualInterface	withVirtualInterfaceType(String virtualInterfaceType) The type of virtual interface
VirtualInterface	withVlan(Integer vlan) VLAN ID

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VirtualInterface

public VirtualInterface()

Method Detail

getVirtualInterfaceId

public String getVirtualInterfaceId()

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Returns:

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

setVirtualInterfaceId

public void setVirtualInterfaceId(String virtualInterfaceId)

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Parameters:

virtualInterfaceId - ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

withVirtualInterfaceId

public VirtualInterface withVirtualInterfaceId(String virtualInterfaceId)

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Returns a reference to this object so that method calls can be chained together.

Parameters:

virtualInterfaceId - ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Returns:

A reference to this updated object so that method calls can be chained together.

getLocation

public String getLocation()

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Returns:

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

setLocation

public void setLocation(String location)

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Parameters:

location - Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

withLocation

public VirtualInterface withLocation(String location)

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Returns a reference to this object so that method calls can be chained together.

Parameters:

location - Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Returns:

A reference to this updated object so that method calls can be chained together.

getConnectionId

public String getConnectionId()

ID of the connection.

Example: dxcon-fg5678gh

Default: None

Returns:

ID of the connection.

Example: dxcon-fg5678gh

Default: None

setConnectionId

public void setConnectionId(String connectionId)

ID of the connection.

Example: dxcon-fg5678gh

Default: None

Parameters:

connectionId - ID of the connection.

Example: dxcon-fg5678gh

Default: None

withConnectionId

public VirtualInterface withConnectionId(String connectionId)

ID of the connection.

Example: dxcon-fg5678gh

Default: None

Returns a reference to this object so that method calls can be chained together.

Parameters:

connectionId - ID of the connection.

Example: dxcon-fg5678gh

Default: None

Returns:

A reference to this updated object so that method calls can be chained together.

getVirtualInterfaceType

public String getVirtualInterfaceType()

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

Returns:

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

setVirtualInterfaceType

public void setVirtualInterfaceType(String virtualInterfaceType)

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

Parameters:

virtualInterfaceType - The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

withVirtualInterfaceType

public VirtualInterface withVirtualInterfaceType(String virtualInterfaceType)

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

Returns a reference to this object so that method calls can be chained together.

Parameters:

virtualInterfaceType - The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

Returns:

A reference to this updated object so that method calls can be chained together.

getVirtualInterfaceName

public String getVirtualInterfaceName()

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

Returns:

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

setVirtualInterfaceName

public void setVirtualInterfaceName(String virtualInterfaceName)

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

Parameters:

virtualInterfaceName - The name of the virtual interface assigned by the customer

Example: "Dev VPC"

withVirtualInterfaceName

public VirtualInterface withVirtualInterfaceName(String virtualInterfaceName)

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

Returns a reference to this object so that method calls can be chained together.

Parameters:

virtualInterfaceName - The name of the virtual interface assigned by the customer

Example: "Dev VPC"

Returns:

A reference to this updated object so that method calls can be chained together.

getVlan

public Integer getVlan()

VLAN ID

Example: 101

Returns:

VLAN ID

Example: 101

setVlan

public void setVlan(Integer vlan)

VLAN ID

Example: 101

Parameters:

vlan - VLAN ID

Example: 101

withVlan

public VirtualInterface withVlan(Integer vlan)

VLAN ID

Example: 101

Returns a reference to this object so that method calls can be chained together.

Parameters:

vlan - VLAN ID

Example: 101

Returns:

A reference to this updated object so that method calls can be chained together.

getAsn

public Integer getAsn()

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

Returns:

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

setAsn

public void setAsn(Integer asn)

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

Parameters:

asn - Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

withAsn

public VirtualInterface withAsn(Integer asn)

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

Returns a reference to this object so that method calls can be chained together.

Parameters:

asn - Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

Returns:

A reference to this updated object so that method calls can be chained together.

getAuthKey

public String getAuthKey()

Authentication key for BGP configuration

Example: asdf34example

Returns:

Authentication key for BGP configuration

Example: asdf34example

setAuthKey

public void setAuthKey(String authKey)

Authentication key for BGP configuration

Example: asdf34example

Parameters:

authKey - Authentication key for BGP configuration

Example: asdf34example

withAuthKey

public VirtualInterface withAuthKey(String authKey)

Authentication key for BGP configuration

Example: asdf34example

Returns a reference to this object so that method calls can be chained together.

Parameters:

authKey - Authentication key for BGP configuration

Example: asdf34example

Returns:

A reference to this updated object so that method calls can be chained together.

getAmazonAddress

public String getAmazonAddress()

IP address assigned to the Amazon interface.

Example: 192.168.1.1

Returns:

IP address assigned to the Amazon interface.

Example: 192.168.1.1

setAmazonAddress

public void setAmazonAddress(String amazonAddress)

IP address assigned to the Amazon interface.

Example: 192.168.1.1

Parameters:

amazonAddress - IP address assigned to the Amazon interface.

Example: 192.168.1.1

withAmazonAddress

public VirtualInterface withAmazonAddress(String amazonAddress)

IP address assigned to the Amazon interface.

Example: 192.168.1.1

Returns a reference to this object so that method calls can be chained together.

Parameters:

amazonAddress - IP address assigned to the Amazon interface.

Example: 192.168.1.1

Returns:

A reference to this updated object so that method calls can be chained together.

getCustomerAddress

public String getCustomerAddress()

IP address assigned to the customer interface.

Example: 192.168.1.2

Returns:

IP address assigned to the customer interface.

Example: 192.168.1.2

setCustomerAddress

public void setCustomerAddress(String customerAddress)

IP address assigned to the customer interface.

Example: 192.168.1.2

Parameters:

customerAddress - IP address assigned to the customer interface.

Example: 192.168.1.2

withCustomerAddress

public VirtualInterface withCustomerAddress(String customerAddress)

IP address assigned to the customer interface.

Example: 192.168.1.2

Returns a reference to this object so that method calls can be chained together.

Parameters:

customerAddress - IP address assigned to the customer interface.

Example: 192.168.1.2

Returns:

A reference to this updated object so that method calls can be chained together.

getVirtualInterfaceState

public String getVirtualInterfaceState()

State of the virtual interface.

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

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

Returns:

State of the virtual interface.

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

See Also:

VirtualInterfaceState

setVirtualInterfaceState

public void setVirtualInterfaceState(String virtualInterfaceState)

State of the virtual interface.

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

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

Parameters:

virtualInterfaceState - State of the virtual interface.

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

See Also:

VirtualInterfaceState

withVirtualInterfaceState

public VirtualInterface withVirtualInterfaceState(String virtualInterfaceState)

State of the virtual interface.

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

Parameters:

virtualInterfaceState - State of the virtual interface.

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VirtualInterfaceState

setVirtualInterfaceState

public void setVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState)

State of the virtual interface.

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

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

Parameters:

virtualInterfaceState - State of the virtual interface.

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

See Also:

VirtualInterfaceState

withVirtualInterfaceState

public VirtualInterface withVirtualInterfaceState(VirtualInterfaceState virtualInterfaceState)

State of the virtual interface.

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

Parameters:

virtualInterfaceState - State of the virtual interface.

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VirtualInterfaceState

getCustomerRouterConfig

public String getCustomerRouterConfig()

Information for generating the customer router configuration.

Returns:

Information for generating the customer router configuration.

setCustomerRouterConfig

public void setCustomerRouterConfig(String customerRouterConfig)

Information for generating the customer router configuration.

Parameters:

customerRouterConfig - Information for generating the customer router configuration.

withCustomerRouterConfig

public VirtualInterface withCustomerRouterConfig(String customerRouterConfig)

Information for generating the customer router configuration.

Returns a reference to this object so that method calls can be chained together.

Parameters:

customerRouterConfig - Information for generating the customer router configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

getVirtualGatewayId

public String getVirtualGatewayId()

Virtual private gateway to a VPC.

Example: vgw-123er56

Returns:

Virtual private gateway to a VPC.

Example: vgw-123er56

setVirtualGatewayId

public void setVirtualGatewayId(String virtualGatewayId)

Virtual private gateway to a VPC.

Example: vgw-123er56

Parameters:

virtualGatewayId - Virtual private gateway to a VPC.

Example: vgw-123er56

withVirtualGatewayId

public VirtualInterface withVirtualGatewayId(String virtualGatewayId)

Virtual private gateway to a VPC.

Example: vgw-123er56

Returns a reference to this object so that method calls can be chained together.

Parameters:

virtualGatewayId - Virtual private gateway to a VPC.

Example: vgw-123er56

Returns:

A reference to this updated object so that method calls can be chained together.

getRouteFilterPrefixes

public List<RouteFilterPrefix> getRouteFilterPrefixes()

A list of route filter prefixes.

Returns:

A list of route filter prefixes.

setRouteFilterPrefixes

public void setRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)

A list of route filter prefixes.

Parameters:

routeFilterPrefixes - A list of route filter prefixes.

withRouteFilterPrefixes

public VirtualInterface withRouteFilterPrefixes(RouteFilterPrefix... routeFilterPrefixes)

A list of route filter prefixes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

routeFilterPrefixes - A list of route filter prefixes.

Returns:

A reference to this updated object so that method calls can be chained together.

withRouteFilterPrefixes

public VirtualInterface withRouteFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)

A list of route filter prefixes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

routeFilterPrefixes - A list of route filter prefixes.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object