VpnConnection (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.VpnConnection

All Implemented Interfaces:

Serializable
```
public class VpnConnection
extends Object
implements Serializable
```
The VpnConnection data type.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

VpnConnection()

Constructors
Constructor and Description
`VpnConnection()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getCustomerGatewayConfiguration()` Contains configuration information in the native XML format for the VPN connection's customer gateway.
`String`	`getCustomerGatewayId()` Specifies ID of the customer gateway at the end of the VPN connection.
`VpnConnectionOptions`	`getOptions()` Returns the value of the Options property for this object.
`List<VpnStaticRoute>`	`getRoutes()` Returns the value of the Routes property for this object.
`String`	`getState()` Describes the current state of the VPN connection.
`List<Tag>`	`getTags()` A list of tags for the VpnConnection.
`String`	`getType()` Specifies the type of VPN connection.
`List<VgwTelemetry>`	`getVgwTelemetry()` Returns the value of the VgwTelemetry property for this object.
`String`	`getVpnConnectionId()` Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
`String`	`getVpnGatewayId()` Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
`int`	`hashCode()`
`void`	`setCustomerGatewayConfiguration(String customerGatewayConfiguration)` Contains configuration information in the native XML format for the VPN connection's customer gateway.
`void`	`setCustomerGatewayId(String customerGatewayId)` Specifies ID of the customer gateway at the end of the VPN connection.
`void`	`setOptions(VpnConnectionOptions options)` Sets the value of the Options property for this object.
`void`	`setRoutes(Collection<VpnStaticRoute> routes)` Sets the value of the Routes property for this object.
`void`	`setState(String state)` Describes the current state of the VPN connection.
`void`	`setState(VpnState state)` Describes the current state of the VPN connection.
`void`	`setTags(Collection<Tag> tags)` A list of tags for the VpnConnection.
`void`	`setType(GatewayType type)` Specifies the type of VPN connection.
`void`	`setType(String type)` Specifies the type of VPN connection.
`void`	`setVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry)` Sets the value of the VgwTelemetry property for this object.
`void`	`setVpnConnectionId(String vpnConnectionId)` Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
`void`	`setVpnGatewayId(String vpnGatewayId)` Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`VpnConnection`	`withCustomerGatewayConfiguration(String customerGatewayConfiguration)` Contains configuration information in the native XML format for the VPN connection's customer gateway.
`VpnConnection`	`withCustomerGatewayId(String customerGatewayId)` Specifies ID of the customer gateway at the end of the VPN connection.
`VpnConnection`	`withOptions(VpnConnectionOptions options)` Sets the value of the Options property for this object.
`VpnConnection`	`withRoutes(Collection<VpnStaticRoute> routes)` Sets the value of the Routes property for this object.
`VpnConnection`	`withRoutes(VpnStaticRoute... routes)` Sets the value of the Routes property for this object.
`VpnConnection`	`withState(String state)` Describes the current state of the VPN connection.
`VpnConnection`	`withState(VpnState state)` Describes the current state of the VPN connection.
`VpnConnection`	`withTags(Collection<Tag> tags)` A list of tags for the VpnConnection.
`VpnConnection`	`withTags(Tag... tags)` A list of tags for the VpnConnection.
`VpnConnection`	`withType(GatewayType type)` Specifies the type of VPN connection.
`VpnConnection`	`withType(String type)` Specifies the type of VPN connection.
`VpnConnection`	`withVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry)` Sets the value of the VgwTelemetry property for this object.
`VpnConnection`	`withVgwTelemetry(VgwTelemetry... vgwTelemetry)` Sets the value of the VgwTelemetry property for this object.
`VpnConnection`	`withVpnConnectionId(String vpnConnectionId)` Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
`VpnConnection`	`withVpnGatewayId(String vpnGatewayId)` Specfies the ID of the VPN gateway at the VPC end of the VPN connection.

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

- Constructor Detail
  - VpnConnection
```
public VpnConnection()
```
- Method Detail
  - getVpnConnectionId
```
public String getVpnConnectionId()
```
    Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
    
    Returns:
    Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
  - setVpnConnectionId
```
public void setVpnConnectionId(String vpnConnectionId)
```
    Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
    
    Parameters:
    vpnConnectionId - Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
  - withVpnConnectionId
```
public VpnConnection withVpnConnectionId(String vpnConnectionId)
```
    Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vpnConnectionId - Specifies the ID of the VPN gateway at the VPC end of the VPN connection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getState
```
public String getState()
```
    Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    Constraints:
    Allowed Values: pending, available, deleting, deleted
    
    Returns:
    Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    See Also:
    VpnState
  - setState
```
public void setState(String state)
```
    Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    Constraints:
    Allowed Values: pending, available, deleting, deleted
    
    Parameters:
    state - Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    See Also:
    VpnState
  - withState
```
public VpnConnection withState(String state)
```
    Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: pending, available, deleting, deleted
    
    Parameters:
    state - Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    VpnState
  - setState
```
public void setState(VpnState state)
```
    Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    Constraints:
    Allowed Values: pending, available, deleting, deleted
    
    Parameters:
    state - Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    See Also:
    VpnState
  - withState
```
public VpnConnection withState(VpnState state)
```
    Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: pending, available, deleting, deleted
    
    Parameters:
    state - Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    VpnState
  - getCustomerGatewayConfiguration
```
public String getCustomerGatewayConfiguration()
```
    Contains configuration information in the native XML format for the VPN connection's customer gateway.
    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:
    Contains configuration information in the native XML format for the VPN connection's customer gateway.
    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.
  - setCustomerGatewayConfiguration
```
public void setCustomerGatewayConfiguration(String customerGatewayConfiguration)
```
    Contains configuration information in the native XML format for the VPN connection's customer gateway.
    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 - Contains configuration information in the native XML format for the VPN connection's customer gateway.
    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)
```
    Contains configuration information in the native XML format for the VPN connection's customer gateway.
    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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    customerGatewayConfiguration - Contains configuration information in the native XML format for the VPN connection's customer gateway.
    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:
    A reference to this updated object so that method calls can be chained together.
  - getType
```
public String getType()
```
    Specifies the type of VPN connection.
    Constraints:
    Allowed Values: ipsec.1
    
    Returns:
    Specifies the type of VPN connection.
    See Also:
    GatewayType
  - setType
```
public void setType(String type)
```
    Specifies the type of VPN connection.
    Constraints:
    Allowed Values: ipsec.1
    
    Parameters:
    type - Specifies the type of VPN connection.
    See Also:
    GatewayType
  - withType
```
public VpnConnection withType(String type)
```
    Specifies the type of VPN connection.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ipsec.1
    
    Parameters:
    type - Specifies the type of VPN connection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    GatewayType
  - setType
```
public void setType(GatewayType type)
```
    Specifies the type of VPN connection.
    Constraints:
    Allowed Values: ipsec.1
    
    Parameters:
    type - Specifies the type of VPN connection.
    See Also:
    GatewayType
  - withType
```
public VpnConnection withType(GatewayType type)
```
    Specifies the type of VPN connection.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ipsec.1
    
    Parameters:
    type - Specifies the type of VPN connection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    GatewayType
  - getCustomerGatewayId
```
public String getCustomerGatewayId()
```
    Specifies ID of the customer gateway at the end of the VPN connection.
    
    Returns:
    Specifies ID of the customer gateway at the end of the VPN connection.
  - setCustomerGatewayId
```
public void setCustomerGatewayId(String customerGatewayId)
```
    Specifies ID of the customer gateway at the end of the VPN connection.
    
    Parameters:
    customerGatewayId - Specifies ID of the customer gateway at the end of the VPN connection.
  - withCustomerGatewayId
```
public VpnConnection withCustomerGatewayId(String customerGatewayId)
```
    Specifies ID of the customer gateway at the end of the VPN connection.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    customerGatewayId - Specifies ID of the customer gateway at the end of the VPN connection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVpnGatewayId
```
public String getVpnGatewayId()
```
    Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
    
    Returns:
    Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
  - setVpnGatewayId
```
public void setVpnGatewayId(String vpnGatewayId)
```
    Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
    
    Parameters:
    vpnGatewayId - Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
  - withVpnGatewayId
```
public VpnConnection withVpnGatewayId(String vpnGatewayId)
```
    Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vpnGatewayId - Specfies the ID of the VPN gateway at the VPC end of the VPN connection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags for the VpnConnection.
    
    Returns:
    A list of tags for the VpnConnection.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags for the VpnConnection.
    
    Parameters:
    tags - A list of tags for the VpnConnection.
  - withTags
```
public VpnConnection withTags(Tag... tags)
```
    A list of tags for the VpnConnection.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of tags for the VpnConnection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public VpnConnection withTags(Collection<Tag> tags)
```
    A list of tags for the VpnConnection.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of tags for the VpnConnection.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVgwTelemetry
```
public List<VgwTelemetry> getVgwTelemetry()
```
    Returns the value of the VgwTelemetry property for this object.
    
    Returns:
    The value of the VgwTelemetry property for this object.
  - setVgwTelemetry
```
public void setVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry)
```
    Sets the value of the VgwTelemetry property for this object.
    
    Parameters:
    vgwTelemetry - The new value for the VgwTelemetry property for this object.
  - withVgwTelemetry
```
public VpnConnection withVgwTelemetry(VgwTelemetry... vgwTelemetry)
```
    Sets the value of the VgwTelemetry property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vgwTelemetry - The new value for the VgwTelemetry property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withVgwTelemetry
```
public VpnConnection withVgwTelemetry(Collection<VgwTelemetry> vgwTelemetry)
```
    Sets the value of the VgwTelemetry property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vgwTelemetry - The new value for the VgwTelemetry property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOptions
```
public VpnConnectionOptions getOptions()
```
    Returns the value of the Options property for this object.
    
    Returns:
    The value of the Options property for this object.
  - setOptions
```
public void setOptions(VpnConnectionOptions options)
```
    Sets the value of the Options property for this object.
    
    Parameters:
    options - The new value for the Options property for this object.
  - withOptions
```
public VpnConnection withOptions(VpnConnectionOptions options)
```
    Sets the value of the Options property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    options - The new value for the Options property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRoutes
```
public List<VpnStaticRoute> getRoutes()
```
    Returns the value of the Routes property for this object.
    
    Returns:
    The value of the Routes property for this object.
  - setRoutes
```
public void setRoutes(Collection<VpnStaticRoute> routes)
```
    Sets the value of the Routes property for this object.
    
    Parameters:
    routes - The new value for the Routes property for this object.
  - withRoutes
```
public VpnConnection withRoutes(VpnStaticRoute... routes)
```
    Sets the value of the Routes property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    routes - The new value for the Routes property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withRoutes
```
public VpnConnection withRoutes(Collection<VpnStaticRoute> routes)
```
    Sets the value of the Routes property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    routes - The new value for the Routes property for this object.
    
    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

Did this page help you?

Class VpnConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VpnConnection

Method Detail

getVpnConnectionId

setVpnConnectionId

withVpnConnectionId

getState

setState

withState

setState

withState

getCustomerGatewayConfiguration

setCustomerGatewayConfiguration

withCustomerGatewayConfiguration

getType

setType

withType

setType

withType

getCustomerGatewayId

setCustomerGatewayId

withCustomerGatewayId

getVpnGatewayId

setVpnGatewayId

withVpnGatewayId

getTags

setTags

withTags

withTags

getVgwTelemetry

setVgwTelemetry

withVgwTelemetry

withVgwTelemetry

getOptions

setOptions

withOptions

getRoutes

setRoutes

withRoutes

withRoutes

toString

hashCode

equals