com.amazonaws.services.ec2.model

Class CreateCustomerGatewayRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateCustomerGatewayRequest>, Serializable

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

Container for the parameters to the CreateCustomerGateway operation.

Provides information to AWS about your customer gateway device. The customer gateway is the appliance at your end of the VPN connection (compared to the VPN gateway, which is the device at the AWS side of the VPN connection). You can have a single active customer gateway per AWS account (active means that you've created a VPN connection to use with the customer gateway). AWS might delete any customer gateway that you create with this operation if you leave it inactive for an extended period of time.

You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static.

You must also provide the device's Border Gateway Protocol (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). For more information about ASNs, go to http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29 .

See Also:

AmazonEC2.createCustomerGateway(CreateCustomerGatewayRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateCustomerGatewayRequest() Default constructor for a new CreateCustomerGatewayRequest object.
CreateCustomerGatewayRequest(GatewayType type, String publicIp, Integer bgpAsn) Constructs a new CreateCustomerGatewayRequest object.
CreateCustomerGatewayRequest(String type, String publicIp, Integer bgpAsn) Constructs a new CreateCustomerGatewayRequest object.

Method Summary

Methods

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

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

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(String type,
                            String publicIp,
                            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 this customer gateway supports.

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

bgpAsn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

CreateCustomerGatewayRequest

public CreateCustomerGatewayRequest(GatewayType type,
                            String publicIp,
                            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 this customer gateway supports.

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

bgpAsn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Method Detail

getType

public String getType()

The type of VPN connection this customer gateway supports.

Constraints:
Allowed Values: ipsec.1

Returns:

The type of VPN connection this customer gateway supports.

See Also:

GatewayType

setType

public void setType(String type)

The type of VPN connection this customer gateway supports.

Constraints:
Allowed Values: ipsec.1

Parameters:

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

See Also:

GatewayType

withType

public CreateCustomerGatewayRequest withType(String type)

The type of VPN connection 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 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 this customer gateway supports.

Constraints:
Allowed Values: ipsec.1

Parameters:

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

See Also:

GatewayType

withType

public CreateCustomerGatewayRequest withType(GatewayType type)

The type of VPN connection 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 this customer gateway supports.

Returns:

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

See Also:

GatewayType

getPublicIp

public 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(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(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 Integer getBgpAsn()

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Returns:

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

setBgpAsn

public void setBgpAsn(Integer bgpAsn)

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Parameters:

bgpAsn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

withBgpAsn

public CreateCustomerGatewayRequest withBgpAsn(Integer bgpAsn)

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

Parameters:

bgpAsn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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