com.amazonaws.services.ec2.model
Class CreateCustomerGatewayRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateCustomerGatewayRequest>, java.io.Serializable

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

Container for the parameters to the CreateCustomerGateway operation.

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

NOTE: Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

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

See Also:

AmazonEC2.createCustomerGateway(CreateCustomerGatewayRequest), Serialized Form

Constructor Summary

CreateCustomerGatewayRequest()
Default constructor for a new CreateCustomerGatewayRequest object.

CreateCustomerGatewayRequest(GatewayType type, java.lang.String publicIp, java.lang.Integer bgpAsn)
Constructs a new CreateCustomerGatewayRequest object.

CreateCustomerGatewayRequest(java.lang.String type, java.lang.String publicIp, java.lang.Integer bgpAsn)
Constructs a new CreateCustomerGatewayRequest object.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.Integer	getBgpAsn() For devices that support BGP, the customer gateway's BGP ASN.
Request<CreateCustomerGatewayRequest>	getDryRunRequest() This method is intended for internal use only.
java.lang.String	getPublicIp() The Internet-routable IP address for the customer gateway's outside interface.
java.lang.String	getType() The type of VPN connection that this customer gateway supports.
int	hashCode()
void	setBgpAsn(java.lang.Integer bgpAsn) For devices that support BGP, the customer gateway's BGP ASN.
void	setPublicIp(java.lang.String publicIp) The Internet-routable IP address for the customer gateway's outside interface.
void	setType(GatewayType type) The type of VPN connection that this customer gateway supports.
void	setType(java.lang.String type) The type of VPN connection that this customer gateway supports.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCustomerGatewayRequest	withBgpAsn(java.lang.Integer bgpAsn) For devices that support BGP, the customer gateway's BGP ASN.
CreateCustomerGatewayRequest	withPublicIp(java.lang.String publicIp) The Internet-routable IP address for the customer gateway's outside interface.
CreateCustomerGatewayRequest	withType(GatewayType type) The type of VPN connection that this customer gateway supports.
CreateCustomerGatewayRequest	withType(java.lang.String type) The type of VPN connection that this customer gateway supports.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCustomerGatewayRequest

public CreateCustomerGatewayRequest()

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

CreateCustomerGatewayRequest

public CreateCustomerGatewayRequest(java.lang.String type,
                                    java.lang.String publicIp,
                                    java.lang.Integer bgpAsn)

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

Parameters:

type - The type of VPN connection that this customer gateway supports.

publicIp - The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

bgpAsn - For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

CreateCustomerGatewayRequest

public CreateCustomerGatewayRequest(GatewayType type,
                                    java.lang.String publicIp,
                                    java.lang.Integer bgpAsn)

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

Parameters:

type - The type of VPN connection that this customer gateway supports.

publicIp - The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

bgpAsn - For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

Method Detail

getType

public java.lang.String getType()

The type of VPN connection that this customer gateway supports.

Constraints:
Allowed Values: ipsec.1

Returns:

The type of VPN connection that this customer gateway supports.

See Also:

GatewayType

setType

public void setType(java.lang.String type)

The type of VPN connection that this customer gateway supports.

Constraints:
Allowed Values: ipsec.1

Parameters:

type - The type of VPN connection that this customer gateway supports.

See Also:

GatewayType

withType

public CreateCustomerGatewayRequest withType(java.lang.String type)

The type of VPN connection that this customer gateway supports.

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

Constraints:
Allowed Values: ipsec.1

Parameters:

type - The type of VPN connection that this customer gateway supports.

Returns:

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

See Also:

GatewayType

setType

public void setType(GatewayType type)

The type of VPN connection that this customer gateway supports.

Constraints:
Allowed Values: ipsec.1

Parameters:

type - The type of VPN connection that this customer gateway supports.

See Also:

GatewayType

withType

public CreateCustomerGatewayRequest withType(GatewayType type)

The type of VPN connection that this customer gateway supports.

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

Constraints:
Allowed Values: ipsec.1

Parameters:

type - The type of VPN connection that this customer gateway supports.

Returns:

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

See Also:

GatewayType

getPublicIp

public java.lang.String getPublicIp()

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Returns:

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

setPublicIp

public void setPublicIp(java.lang.String publicIp)

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Parameters:

publicIp - The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

withPublicIp

public CreateCustomerGatewayRequest withPublicIp(java.lang.String publicIp)

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

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

Parameters:

publicIp - The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Returns:

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

getBgpAsn

public java.lang.Integer getBgpAsn()

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

Returns:

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

setBgpAsn

public void setBgpAsn(java.lang.Integer bgpAsn)

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

Parameters:

bgpAsn - For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

withBgpAsn

public CreateCustomerGatewayRequest withBgpAsn(java.lang.Integer bgpAsn)

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

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

Parameters:

bgpAsn - For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

Returns:

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

getDryRunRequest

public Request<CreateCustomerGatewayRequest> 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<CreateCustomerGatewayRequest>

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