com.amazonaws.services.ec2.model

Class CreateCustomerGatewayRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateCustomerGatewayRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCustomerGatewayRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateCustomerGatewayRequest>

Contains the parameters for CreateCustomerGateway.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCustomerGatewayRequest() Default constructor for 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

Modifier and Type	Method and Description
CreateCustomerGatewayRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getBgpAsn() For customer gateway devices that support BGP, specify the device's ASN.
Long	getBgpAsnExtended() For customer gateway devices that support BGP, specify the device's ASN.
String	getCertificateArn() The Amazon Resource Name (ARN) for the customer gateway certificate.
String	getDeviceName() A name for the customer gateway device.
Request<CreateCustomerGatewayRequest>	getDryRunRequest() This method is intended for internal use only.
String	getIpAddress() IPv4 address for the customer gateway device's outside interface.
String	getPublicIp() This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface.
List<TagSpecification>	getTagSpecifications() The tags to apply to the customer gateway.
String	getType() The type of VPN connection that this customer gateway supports (ipsec.1).
int	hashCode()
void	setBgpAsn(Integer bgpAsn) For customer gateway devices that support BGP, specify the device's ASN.
void	setBgpAsnExtended(Long bgpAsnExtended) For customer gateway devices that support BGP, specify the device's ASN.
void	setCertificateArn(String certificateArn) The Amazon Resource Name (ARN) for the customer gateway certificate.
void	setDeviceName(String deviceName) A name for the customer gateway device.
void	setIpAddress(String ipAddress) IPv4 address for the customer gateway device's outside interface.
void	setPublicIp(String publicIp) This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the customer gateway.
void	setType(GatewayType type) The type of VPN connection that this customer gateway supports (ipsec.1).
void	setType(String type) The type of VPN connection that this customer gateway supports (ipsec.1).
String	toString() Returns a string representation of this object.
CreateCustomerGatewayRequest	withBgpAsn(Integer bgpAsn) For customer gateway devices that support BGP, specify the device's ASN.
CreateCustomerGatewayRequest	withBgpAsnExtended(Long bgpAsnExtended) For customer gateway devices that support BGP, specify the device's ASN.
CreateCustomerGatewayRequest	withCertificateArn(String certificateArn) The Amazon Resource Name (ARN) for the customer gateway certificate.
CreateCustomerGatewayRequest	withDeviceName(String deviceName) A name for the customer gateway device.
CreateCustomerGatewayRequest	withIpAddress(String ipAddress) IPv4 address for the customer gateway device's outside interface.
CreateCustomerGatewayRequest	withPublicIp(String publicIp) This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface.
CreateCustomerGatewayRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the customer gateway.
CreateCustomerGatewayRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the customer gateway.
CreateCustomerGatewayRequest	withType(GatewayType type) The type of VPN connection that this customer gateway supports (ipsec.1).
CreateCustomerGatewayRequest	withType(String type) The type of VPN connection that this customer gateway supports (ipsec.1).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCustomerGatewayRequest

public CreateCustomerGatewayRequest()

Default constructor for CreateCustomerGatewayRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 that this customer gateway supports (ipsec.1).

publicIp - This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

bgpAsn - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

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 that this customer gateway supports (ipsec.1).

publicIp - This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

bgpAsn - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Method Detail

setBgpAsn

public void setBgpAsn(Integer bgpAsn)

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Parameters:

bgpAsn - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

getBgpAsn

public Integer getBgpAsn()

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Returns:

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

withBgpAsn

public CreateCustomerGatewayRequest withBgpAsn(Integer bgpAsn)

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Parameters:

bgpAsn - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Returns:

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

setPublicIp

public void setPublicIp(String publicIp)

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Parameters:

publicIp - This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

getPublicIp

public String getPublicIp()

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Returns:

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

withPublicIp

public CreateCustomerGatewayRequest withPublicIp(String publicIp)

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Parameters:

publicIp - This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Returns:

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

setCertificateArn

public void setCertificateArn(String certificateArn)

The Amazon Resource Name (ARN) for the customer gateway certificate.

Parameters:

certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate.

getCertificateArn

public String getCertificateArn()

The Amazon Resource Name (ARN) for the customer gateway certificate.

Returns:

The Amazon Resource Name (ARN) for the customer gateway certificate.

withCertificateArn

public CreateCustomerGatewayRequest withCertificateArn(String certificateArn)

The Amazon Resource Name (ARN) for the customer gateway certificate.

Parameters:

certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate.

Returns:

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

setType

public void setType(String type)

The type of VPN connection that this customer gateway supports (ipsec.1).

Parameters:

type - The type of VPN connection that this customer gateway supports (ipsec.1).

See Also:

GatewayType

getType

public String getType()

The type of VPN connection that this customer gateway supports (ipsec.1).

Returns:

The type of VPN connection that this customer gateway supports (ipsec.1).

See Also:

GatewayType

withType

public CreateCustomerGatewayRequest withType(String type)

The type of VPN connection that this customer gateway supports (ipsec.1).

Parameters:

type - The type of VPN connection that this customer gateway supports (ipsec.1).

Returns:

Returns a reference to this 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 (ipsec.1).

Parameters:

type - The type of VPN connection that this customer gateway supports (ipsec.1).

See Also:

GatewayType

withType

public CreateCustomerGatewayRequest withType(GatewayType type)

The type of VPN connection that this customer gateway supports (ipsec.1).

Parameters:

type - The type of VPN connection that this customer gateway supports (ipsec.1).

Returns:

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

See Also:

GatewayType

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to apply to the customer gateway.

Returns:

The tags to apply to the customer gateway.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the customer gateway.

Parameters:

tagSpecifications - The tags to apply to the customer gateway.

withTagSpecifications

public CreateCustomerGatewayRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the customer gateway.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The tags to apply to the customer gateway.

Returns:

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

withTagSpecifications

public CreateCustomerGatewayRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the customer gateway.

Parameters:

tagSpecifications - The tags to apply to the customer gateway.

Returns:

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

setDeviceName

public void setDeviceName(String deviceName)

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Parameters:

deviceName - A name for the customer gateway device.

Length Constraints: Up to 255 characters.

getDeviceName

public String getDeviceName()

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Returns:

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

withDeviceName

public CreateCustomerGatewayRequest withDeviceName(String deviceName)

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Parameters:

deviceName - A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Returns:

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

setIpAddress

public void setIpAddress(String ipAddress)

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Parameters:

ipAddress - IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

getIpAddress

public String getIpAddress()

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Returns:

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

withIpAddress

public CreateCustomerGatewayRequest withIpAddress(String ipAddress)

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Parameters:

ipAddress - IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Returns:

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

setBgpAsnExtended

public void setBgpAsnExtended(Long bgpAsnExtended)

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Parameters:

bgpAsnExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

getBgpAsnExtended

public Long getBgpAsnExtended()

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Returns:

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

withBgpAsnExtended

public CreateCustomerGatewayRequest withBgpAsnExtended(Long bgpAsnExtended)

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Parameters:

bgpAsnExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Returns:

Returns a reference to this 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateCustomerGatewayRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()