com.amazonaws.services.ec2.model

Class VpnConnection

java.lang.Object

com.amazonaws.services.ec2.model.VpnConnection

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VpnConnection
extends Object
implements Serializable, Cloneable

Describes a VPN connection.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
VpnConnection()

Method Summary

Modifier and Type	Method and Description
VpnConnection	clone()
boolean	equals(Object obj)
String	getCategory() The category of the VPN connection.
String	getCustomerGatewayConfiguration() The configuration information for the VPN connection's customer gateway (in the native XML format).
String	getCustomerGatewayId() The ID of the customer gateway at your end of the VPN connection.
VpnConnectionOptions	getOptions() The VPN connection options.
List<VpnStaticRoute>	getRoutes() The static routes associated with the VPN connection.
String	getState() The current state of the VPN connection.
List<Tag>	getTags() Any tags assigned to the VPN connection.
String	getType() The type of VPN connection.
List<VgwTelemetry>	getVgwTelemetry() Information about the VPN tunnel.
String	getVpnConnectionId() The ID of the VPN connection.
String	getVpnGatewayId() The ID of the virtual private gateway at the AWS side of the VPN connection.
int	hashCode()
void	setCategory(String category) The category of the VPN connection.
void	setCustomerGatewayConfiguration(String customerGatewayConfiguration) The configuration information for the VPN connection's customer gateway (in the native XML format).
void	setCustomerGatewayId(String customerGatewayId) The ID of the customer gateway at your end of the VPN connection.
void	setOptions(VpnConnectionOptions options) The VPN connection options.
void	setRoutes(Collection<VpnStaticRoute> routes) The static routes associated with the VPN connection.
void	setState(String state) The current state of the VPN connection.
void	setState(VpnState state) The current state of the VPN connection.
void	setTags(Collection<Tag> tags) Any tags assigned to the VPN connection.
void	setType(GatewayType type) The type of VPN connection.
void	setType(String type) The type of VPN connection.
void	setVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry) Information about the VPN tunnel.
void	setVpnConnectionId(String vpnConnectionId) The ID of the VPN connection.
void	setVpnGatewayId(String vpnGatewayId) The ID of the virtual private gateway at the AWS side of the VPN connection.
String	toString() Returns a string representation of this object; useful for testing and debugging.
VpnConnection	withCategory(String category) The category of the VPN connection.
VpnConnection	withCustomerGatewayConfiguration(String customerGatewayConfiguration) The configuration information for the VPN connection's customer gateway (in the native XML format).
VpnConnection	withCustomerGatewayId(String customerGatewayId) The ID of the customer gateway at your end of the VPN connection.
VpnConnection	withOptions(VpnConnectionOptions options) The VPN connection options.
VpnConnection	withRoutes(Collection<VpnStaticRoute> routes) The static routes associated with the VPN connection.
VpnConnection	withRoutes(VpnStaticRoute... routes) The static routes associated with the VPN connection.
VpnConnection	withState(String state) The current state of the VPN connection.
VpnConnection	withState(VpnState state) The current state of the VPN connection.
VpnConnection	withTags(Collection<Tag> tags) Any tags assigned to the VPN connection.
VpnConnection	withTags(Tag... tags) Any tags assigned to the VPN connection.
VpnConnection	withType(GatewayType type) The type of VPN connection.
VpnConnection	withType(String type) The type of VPN connection.
VpnConnection	withVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry) Information about the VPN tunnel.
VpnConnection	withVgwTelemetry(VgwTelemetry... vgwTelemetry) Information about the VPN tunnel.
VpnConnection	withVpnConnectionId(String vpnConnectionId) The ID of the VPN connection.
VpnConnection	withVpnGatewayId(String vpnGatewayId) The ID of the virtual private gateway at the AWS side of the VPN connection.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VpnConnection

public VpnConnection()

Method Detail

setCustomerGatewayConfiguration

public void setCustomerGatewayConfiguration(String customerGatewayConfiguration)

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Parameters:

customerGatewayConfiguration - The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

getCustomerGatewayConfiguration

public String getCustomerGatewayConfiguration()

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Returns:

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

withCustomerGatewayConfiguration

public VpnConnection withCustomerGatewayConfiguration(String customerGatewayConfiguration)

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Parameters:

customerGatewayConfiguration - The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Returns:

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

setCustomerGatewayId

public void setCustomerGatewayId(String customerGatewayId)

The ID of the customer gateway at your end of the VPN connection.

Parameters:

customerGatewayId - The ID of the customer gateway at your end of the VPN connection.

getCustomerGatewayId

public String getCustomerGatewayId()

The ID of the customer gateway at your end of the VPN connection.

Returns:

The ID of the customer gateway at your end of the VPN connection.

withCustomerGatewayId

public VpnConnection withCustomerGatewayId(String customerGatewayId)

The ID of the customer gateway at your end of the VPN connection.

Parameters:

customerGatewayId - The ID of the customer gateway at your end of the VPN connection.

Returns:

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

setCategory

public void setCategory(String category)

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

Parameters:

category - The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

getCategory

public String getCategory()

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

Returns:

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

withCategory

public VpnConnection withCategory(String category)

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

Parameters:

category - The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

Returns:

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

setState

public void setState(String state)

The current state of the VPN connection.

Parameters:

state - The current state of the VPN connection.

See Also:

VpnState

getState

public String getState()

The current state of the VPN connection.

Returns:

The current state of the VPN connection.

See Also:

VpnState

withState

public VpnConnection withState(String state)

The current state of the VPN connection.

Parameters:

state - The current state of the VPN connection.

Returns:

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

See Also:

VpnState

setState

public void setState(VpnState state)

The current state of the VPN connection.

Parameters:

state - The current state of the VPN connection.

See Also:

VpnState

withState

public VpnConnection withState(VpnState state)

The current state of the VPN connection.

Parameters:

state - The current state of the VPN connection.

Returns:

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

See Also:

VpnState

setType

public void setType(String type)

The type of VPN connection.

Parameters:

type - The type of VPN connection.

See Also:

GatewayType

getType

public String getType()

The type of VPN connection.

Returns:

The type of VPN connection.

See Also:

GatewayType

withType

public VpnConnection withType(String type)

The type of VPN connection.

Parameters:

type - The type of VPN connection.

Returns:

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

See Also:

GatewayType

setType

public void setType(GatewayType type)

The type of VPN connection.

Parameters:

type - The type of VPN connection.

See Also:

GatewayType

withType

public VpnConnection withType(GatewayType type)

The type of VPN connection.

Parameters:

type - The type of VPN connection.

Returns:

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

See Also:

GatewayType

setVpnConnectionId

public void setVpnConnectionId(String vpnConnectionId)

The ID of the VPN connection.

Parameters:

vpnConnectionId - The ID of the VPN connection.

getVpnConnectionId

public String getVpnConnectionId()

The ID of the VPN connection.

Returns:

The ID of the VPN connection.

withVpnConnectionId

public VpnConnection withVpnConnectionId(String vpnConnectionId)

The ID of the VPN connection.

Parameters:

vpnConnectionId - The ID of the VPN connection.

Returns:

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

setVpnGatewayId

public void setVpnGatewayId(String vpnGatewayId)

The ID of the virtual private gateway at the AWS side of the VPN connection.

Parameters:

vpnGatewayId - The ID of the virtual private gateway at the AWS side of the VPN connection.

getVpnGatewayId

public String getVpnGatewayId()

The ID of the virtual private gateway at the AWS side of the VPN connection.

Returns:

The ID of the virtual private gateway at the AWS side of the VPN connection.

withVpnGatewayId

public VpnConnection withVpnGatewayId(String vpnGatewayId)

The ID of the virtual private gateway at the AWS side of the VPN connection.

Parameters:

vpnGatewayId - The ID of the virtual private gateway at the AWS side of the VPN connection.

Returns:

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

setOptions

public void setOptions(VpnConnectionOptions options)

The VPN connection options.

Parameters:

options - The VPN connection options.

getOptions

public VpnConnectionOptions getOptions()

The VPN connection options.

Returns:

The VPN connection options.

withOptions

public VpnConnection withOptions(VpnConnectionOptions options)

The VPN connection options.

Parameters:

options - The VPN connection options.

Returns:

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

getRoutes

public List<VpnStaticRoute> getRoutes()

The static routes associated with the VPN connection.

Returns:

The static routes associated with the VPN connection.

setRoutes

public void setRoutes(Collection<VpnStaticRoute> routes)

The static routes associated with the VPN connection.

Parameters:

routes - The static routes associated with the VPN connection.

withRoutes

public VpnConnection withRoutes(VpnStaticRoute... routes)

The static routes associated with the VPN connection.

NOTE: This method appends the values to the existing list (if any). Use setRoutes(java.util.Collection) or withRoutes(java.util.Collection) if you want to override the existing values.

Parameters:

routes - The static routes associated with the VPN connection.

Returns:

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

withRoutes

public VpnConnection withRoutes(Collection<VpnStaticRoute> routes)

The static routes associated with the VPN connection.

Parameters:

routes - The static routes associated with the VPN connection.

Returns:

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

getTags

public List<Tag> getTags()

Any tags assigned to the VPN connection.

Returns:

Any tags assigned to the VPN connection.

setTags

public void setTags(Collection<Tag> tags)

Any tags assigned to the VPN connection.

Parameters:

tags - Any tags assigned to the VPN connection.

withTags

public VpnConnection withTags(Tag... tags)

Any tags assigned to the VPN connection.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Any tags assigned to the VPN connection.

Returns:

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

withTags

public VpnConnection withTags(Collection<Tag> tags)

Any tags assigned to the VPN connection.

Parameters:

tags - Any tags assigned to the VPN connection.

Returns:

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

getVgwTelemetry

public List<VgwTelemetry> getVgwTelemetry()

Information about the VPN tunnel.

Returns:

Information about the VPN tunnel.

setVgwTelemetry

public void setVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry)

Information about the VPN tunnel.

Parameters:

vgwTelemetry - Information about the VPN tunnel.

withVgwTelemetry

public VpnConnection withVgwTelemetry(VgwTelemetry... vgwTelemetry)

Information about the VPN tunnel.

NOTE: This method appends the values to the existing list (if any). Use setVgwTelemetry(java.util.Collection) or withVgwTelemetry(java.util.Collection) if you want to override the existing values.

Parameters:

vgwTelemetry - Information about the VPN tunnel.

Returns:

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

withVgwTelemetry

public VpnConnection withVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry)

Information about the VPN tunnel.

Parameters:

vgwTelemetry - Information about the VPN tunnel.

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 VpnConnection clone()

Overrides:

clone in class Object