com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.CreateCustomerGatewayRequestMarshaller;
/**
*
* Contains the parameters for CreateCustomerGateway.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* 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
*
*/
private Integer bgpAsn;
/**
*
* This member has been deprecated. The Internet-routable IP address for the customer gateway's outside
* interface. The address must be static.
*
*/
private String publicIp;
/**
*
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*
*/
private String certificateArn;
/**
*
* The type of VPN connection that this customer gateway supports (ipsec.1).
*
*/
private String type;
/**
*
* The tags to apply to the customer gateway.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* A name for the customer gateway device.
*
*
* Length Constraints: Up to 255 characters.
*
*/
private String deviceName;
/**
*
* 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.
*
*/
private String ipAddress;
/**
*
* 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
*
*/
private Long bgpAsnExtended;
/**
* Default constructor for CreateCustomerGatewayRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public CreateCustomerGatewayRequest() {
}
/**
* Constructs a new CreateCustomerGatewayRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param type
* The type of VPN connection that this customer gateway supports (ipsec.1).
* @param publicIp
* This member has been deprecated. The Internet-routable IP address for the customer gateway's
* outside interface. The address must be static.
* @param 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
*/
public CreateCustomerGatewayRequest(String type, String publicIp, Integer bgpAsn) {
setType(type);
setPublicIp(publicIp);
setBgpAsn(bgpAsn);
}
/**
* Constructs a new CreateCustomerGatewayRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param type
* The type of VPN connection that this customer gateway supports (ipsec.1).
* @param publicIp
* This member has been deprecated. The Internet-routable IP address for the customer gateway's
* outside interface. The address must be static.
* @param 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
*/
public CreateCustomerGatewayRequest(GatewayType type, String publicIp, Integer bgpAsn) {
setType(type.toString());
setPublicIp(publicIp);
setBgpAsn(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
*
*
* @param 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
*/
public void setBgpAsn(Integer bgpAsn) {
this.bgpAsn = 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
*
*
* @return 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
*/
public Integer getBgpAsn() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withBgpAsn(Integer bgpAsn) {
setBgpAsn(bgpAsn);
return this;
}
/**
*
* This member has been deprecated. The Internet-routable IP address for the customer gateway's outside
* interface. The address must be static.
*
*
* @param publicIp
* This member has been deprecated. The Internet-routable IP address for the customer gateway's
* outside interface. The address must be static.
*/
public void setPublicIp(String publicIp) {
this.publicIp = publicIp;
}
/**
*
* This member has been deprecated. The Internet-routable IP address for the customer gateway's outside
* interface. The address must be static.
*
*
* @return This member has been deprecated. The Internet-routable IP address for the customer gateway's
* outside interface. The address must be static.
*/
public String getPublicIp() {
return this.publicIp;
}
/**
*
* This member has been deprecated. The Internet-routable IP address for the customer gateway's outside
* interface. The address must be static.
*
*
* @param publicIp
* This member has been deprecated. The Internet-routable IP address for the customer gateway's
* outside interface. The address must be static.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withPublicIp(String publicIp) {
setPublicIp(publicIp);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*
*
* @param certificateArn
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*/
public void setCertificateArn(String certificateArn) {
this.certificateArn = certificateArn;
}
/**
*
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*
*
* @return The Amazon Resource Name (ARN) for the customer gateway certificate.
*/
public String getCertificateArn() {
return this.certificateArn;
}
/**
*
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*
*
* @param certificateArn
* The Amazon Resource Name (ARN) for the customer gateway certificate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withCertificateArn(String certificateArn) {
setCertificateArn(certificateArn);
return this;
}
/**
*
* The type of VPN connection that this customer gateway supports (ipsec.1).
*
*
* @param type
* The type of VPN connection that this customer gateway supports (ipsec.1).
* @see GatewayType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of VPN connection that this customer gateway supports (ipsec.1).
*
*
* @return The type of VPN connection that this customer gateway supports (ipsec.1).
* @see GatewayType
*/
public String getType() {
return this.type;
}
/**
*
* The type of VPN connection that this customer gateway supports (ipsec.1).
*
*
* @param type
* The type of VPN connection that this customer gateway supports (ipsec.1).
* @return Returns a reference to this object so that method calls can be chained together.
* @see GatewayType
*/
public CreateCustomerGatewayRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The type of VPN connection that this customer gateway supports (ipsec.1).
*
*
* @param type
* The type of VPN connection that this customer gateway supports (ipsec.1).
* @see GatewayType
*/
public void setType(GatewayType type) {
withType(type);
}
/**
*
* The type of VPN connection that this customer gateway supports (ipsec.1).
*
*
* @param type
* The type of VPN connection that this customer gateway supports (ipsec.1).
* @return Returns a reference to this object so that method calls can be chained together.
* @see GatewayType
*/
public CreateCustomerGatewayRequest withType(GatewayType type) {
this.type = type.toString();
return this;
}
/**
*
* The tags to apply to the customer gateway.
*
*
* @return The tags to apply to the customer gateway.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to apply to the customer gateway.
*
*
* @param tagSpecifications
* The tags to apply to the customer gateway.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to apply to the customer gateway.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to apply to the customer gateway.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to apply to the customer gateway.
*
*
* @param tagSpecifications
* The tags to apply to the customer gateway.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* A name for the customer gateway device.
*
*
* Length Constraints: Up to 255 characters.
*
*
* @param deviceName
* A name for the customer gateway device.
*
* Length Constraints: Up to 255 characters.
*/
public void setDeviceName(String deviceName) {
this.deviceName = deviceName;
}
/**
*
* A name for the customer gateway device.
*
*
* Length Constraints: Up to 255 characters.
*
*
* @return A name for the customer gateway device.
*
* Length Constraints: Up to 255 characters.
*/
public String getDeviceName() {
return this.deviceName;
}
/**
*
* A name for the customer gateway device.
*
*
* Length Constraints: Up to 255 characters.
*
*
* @param deviceName
* A name for the customer gateway device.
*
* Length Constraints: Up to 255 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withDeviceName(String deviceName) {
setDeviceName(deviceName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setIpAddress(String ipAddress) {
this.ipAddress = 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.
*
*
* @return 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.
*/
public String getIpAddress() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withIpAddress(String ipAddress) {
setIpAddress(ipAddress);
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setBgpAsnExtended(Long bgpAsnExtended) {
this.bgpAsnExtended = 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
*
*
* @return 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
*/
public Long getBgpAsnExtended() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateCustomerGatewayRequest withBgpAsnExtended(Long bgpAsnExtended) {
setBgpAsnExtended(bgpAsnExtended);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new CreateCustomerGatewayRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBgpAsn() != null)
sb.append("BgpAsn: ").append(getBgpAsn()).append(",");
if (getPublicIp() != null)
sb.append("PublicIp: ").append(getPublicIp()).append(",");
if (getCertificateArn() != null)
sb.append("CertificateArn: ").append(getCertificateArn()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getDeviceName() != null)
sb.append("DeviceName: ").append(getDeviceName()).append(",");
if (getIpAddress() != null)
sb.append("IpAddress: ").append(getIpAddress()).append(",");
if (getBgpAsnExtended() != null)
sb.append("BgpAsnExtended: ").append(getBgpAsnExtended());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateCustomerGatewayRequest == false)
return false;
CreateCustomerGatewayRequest other = (CreateCustomerGatewayRequest) obj;
if (other.getBgpAsn() == null ^ this.getBgpAsn() == null)
return false;
if (other.getBgpAsn() != null && other.getBgpAsn().equals(this.getBgpAsn()) == false)
return false;
if (other.getPublicIp() == null ^ this.getPublicIp() == null)
return false;
if (other.getPublicIp() != null && other.getPublicIp().equals(this.getPublicIp()) == false)
return false;
if (other.getCertificateArn() == null ^ this.getCertificateArn() == null)
return false;
if (other.getCertificateArn() != null && other.getCertificateArn().equals(this.getCertificateArn()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getDeviceName() == null ^ this.getDeviceName() == null)
return false;
if (other.getDeviceName() != null && other.getDeviceName().equals(this.getDeviceName()) == false)
return false;
if (other.getIpAddress() == null ^ this.getIpAddress() == null)
return false;
if (other.getIpAddress() != null && other.getIpAddress().equals(this.getIpAddress()) == false)
return false;
if (other.getBgpAsnExtended() == null ^ this.getBgpAsnExtended() == null)
return false;
if (other.getBgpAsnExtended() != null && other.getBgpAsnExtended().equals(this.getBgpAsnExtended()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBgpAsn() == null) ? 0 : getBgpAsn().hashCode());
hashCode = prime * hashCode + ((getPublicIp() == null) ? 0 : getPublicIp().hashCode());
hashCode = prime * hashCode + ((getCertificateArn() == null) ? 0 : getCertificateArn().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getDeviceName() == null) ? 0 : getDeviceName().hashCode());
hashCode = prime * hashCode + ((getIpAddress() == null) ? 0 : getIpAddress().hashCode());
hashCode = prime * hashCode + ((getBgpAsnExtended() == null) ? 0 : getBgpAsnExtended().hashCode());
return hashCode;
}
@Override
public CreateCustomerGatewayRequest clone() {
return (CreateCustomerGatewayRequest) super.clone();
}
}