com.amazonaws.services.ec2.model

Class CreateVpnConnectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateVpnConnectionRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateVpnConnectionRequest>, java.io.Serializable, java.lang.Cloneable

public class CreateVpnConnectionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<CreateVpnConnectionRequest>

Container for the parameters to the CreateVpnConnection operation.

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1 .

The response includes information that you need to give to your network administrator to configure your customer gateway.

IMPORTANT: We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide .

See Also:

AmazonEC2.createVpnConnection(CreateVpnConnectionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateVpnConnectionRequest() Default constructor for a new CreateVpnConnectionRequest object.
CreateVpnConnectionRequest(java.lang.String type, java.lang.String customerGatewayId, java.lang.String vpnGatewayId) Constructs a new CreateVpnConnectionRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCustomerGatewayId() The ID of the customer gateway.
Request<CreateVpnConnectionRequest>	getDryRunRequest() This method is intended for internal use only.
VpnConnectionOptionsSpecification	getOptions() Indicates whether the VPN connection requires static routes.
java.lang.String	getType() The type of VPN connection (ipsec.1).
java.lang.String	getVpnGatewayId() The ID of the virtual private gateway.
int	hashCode()
void	setCustomerGatewayId(java.lang.String customerGatewayId) The ID of the customer gateway.
void	setOptions(VpnConnectionOptionsSpecification options) Indicates whether the VPN connection requires static routes.
void	setType(java.lang.String type) The type of VPN connection (ipsec.1).
void	setVpnGatewayId(java.lang.String vpnGatewayId) The ID of the virtual private gateway.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateVpnConnectionRequest	withCustomerGatewayId(java.lang.String customerGatewayId) The ID of the customer gateway.
CreateVpnConnectionRequest	withOptions(VpnConnectionOptionsSpecification options) Indicates whether the VPN connection requires static routes.
CreateVpnConnectionRequest	withType(java.lang.String type) The type of VPN connection (ipsec.1).
CreateVpnConnectionRequest	withVpnGatewayId(java.lang.String vpnGatewayId) The ID of the virtual private gateway.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVpnConnectionRequest

public CreateVpnConnectionRequest()

Default constructor for a new CreateVpnConnectionRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateVpnConnectionRequest

public CreateVpnConnectionRequest(java.lang.String type,
                                  java.lang.String customerGatewayId,
                                  java.lang.String vpnGatewayId)

Constructs a new CreateVpnConnectionRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

type - The type of VPN connection (ipsec.1).

customerGatewayId - The ID of the customer gateway.

vpnGatewayId - The ID of the virtual private gateway.

Method Detail

getType

public java.lang.String getType()

The type of VPN connection (ipsec.1).

Returns:

The type of VPN connection (ipsec.1).

setType

public void setType(java.lang.String type)

The type of VPN connection (ipsec.1).

Parameters:

type - The type of VPN connection (ipsec.1).

withType

public CreateVpnConnectionRequest withType(java.lang.String type)

The type of VPN connection (ipsec.1).

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

Parameters:

type - The type of VPN connection (ipsec.1).

Returns:

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

getCustomerGatewayId

public java.lang.String getCustomerGatewayId()

The ID of the customer gateway.

Returns:

The ID of the customer gateway.

setCustomerGatewayId

public void setCustomerGatewayId(java.lang.String customerGatewayId)

The ID of the customer gateway.

Parameters:

customerGatewayId - The ID of the customer gateway.

withCustomerGatewayId

public CreateVpnConnectionRequest withCustomerGatewayId(java.lang.String customerGatewayId)

The ID of the customer gateway.

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

Parameters:

customerGatewayId - The ID of the customer gateway.

Returns:

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

getVpnGatewayId

public java.lang.String getVpnGatewayId()

The ID of the virtual private gateway.

Returns:

The ID of the virtual private gateway.

setVpnGatewayId

public void setVpnGatewayId(java.lang.String vpnGatewayId)

The ID of the virtual private gateway.

Parameters:

vpnGatewayId - The ID of the virtual private gateway.

withVpnGatewayId

public CreateVpnConnectionRequest withVpnGatewayId(java.lang.String vpnGatewayId)

The ID of the virtual private gateway.

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

Parameters:

vpnGatewayId - The ID of the virtual private gateway.

Returns:

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

getOptions

public VpnConnectionOptionsSpecification getOptions()

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

Returns:

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

setOptions

public void setOptions(VpnConnectionOptionsSpecification options)

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

Parameters:

options - Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

withOptions

public CreateVpnConnectionRequest withOptions(VpnConnectionOptionsSpecification options)

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

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

Parameters:

options - Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

Returns:

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

getDryRunRequest

public Request<CreateVpnConnectionRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateVpnConnectionRequest>

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object