com.amazonaws.services.ec2.model

Class CreateVpnConnectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateVpnConnectionRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateVpnConnectionRequest>, Serializable

public class CreateVpnConnectionRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<CreateVpnConnectionRequest>

Container for the parameters to the CreateVpnConnection operation.

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

The response includes information that you need to configure your customer gateway, in XML format. We recommend you use the command line version of this operation ( ec2-create-vpn-connection ), which takes an -f option (for format) and returns configuration information formatted as expected by the vendor you specified, or in a generic, human readable format. For information about the command, go to ec2-create-vpn-connection in the Amazon Virtual Private Cloud Command Line Reference.

IMPORTANT: We strongly recommend 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 then create a new one, you must re-configure your customer gateway with the new information returned from this call.

See Also:

AmazonEC2.createVpnConnection(CreateVpnConnectionRequest), Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, 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(String type,
                          String customerGatewayId,
                          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.

customerGatewayId - The ID of the customer gateway.

vpnGatewayId - The ID of the VPN gateway.

Method Detail

getType

public String getType()

The type of VPN connection.

Returns:

The type of VPN connection.

setType

public void setType(String type)

The type of VPN connection.

Parameters:

type - The type of VPN connection.

withType

public CreateVpnConnectionRequest withType(String type)

The type of VPN connection.

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

Parameters:

type - The type of VPN connection.

Returns:

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

getCustomerGatewayId

public String getCustomerGatewayId()

The ID of the customer gateway.

Returns:

The ID of the customer gateway.

setCustomerGatewayId

public void setCustomerGatewayId(String customerGatewayId)

The ID of the customer gateway.

Parameters:

customerGatewayId - The ID of the customer gateway.

withCustomerGatewayId

public CreateVpnConnectionRequest withCustomerGatewayId(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 String getVpnGatewayId()

The ID of the VPN gateway.

Returns:

The ID of the VPN gateway.

setVpnGatewayId

public void setVpnGatewayId(String vpnGatewayId)

The ID of the VPN gateway.

Parameters:

vpnGatewayId - The ID of the VPN gateway.

withVpnGatewayId

public CreateVpnConnectionRequest withVpnGatewayId(String vpnGatewayId)

The ID of the VPN gateway.

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

Parameters:

vpnGatewayId - The ID of the VPN gateway.

Returns:

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

getOptions

public VpnConnectionOptionsSpecification 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(VpnConnectionOptionsSpecification 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 CreateVpnConnectionRequest withOptions(VpnConnectionOptionsSpecification 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.

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