Package software.amazon.awssdk.services.ec2.model

Class CreateCustomerGatewayRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.CreateCustomerGatewayRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCustomerGatewayRequest extends Ec2Request implements ToCopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>

Contains the parameters for CreateCustomerGateway.

  • Method Details

    • bgpAsn

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

      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

    • publicIp

      public final String publicIp()

      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.

    • certificateArn

      public final String certificateArn()

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

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

    • type

      public final GatewayType type()

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

      If the service returns an enum value that is not available in the current SDK version, type will return GatewayType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of VPN connection that this customer gateway supports (ipsec.1).
      See Also:

    • typeAsString

      public final String typeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, type will return GatewayType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of VPN connection that this customer gateway supports (ipsec.1).
      See Also:

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to apply to the customer gateway.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

      Returns:
      The tags to apply to the customer gateway.

    • deviceName

      public final String deviceName()

      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.

    • ipAddress

      public final String ipAddress()

      The IP 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 Ipv6, you can use an IPv6 address.

      Returns:
      The IP 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 Ipv6, you can use an IPv6 address.

    • bgpAsnExtended

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

      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

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • toBuilder

      public CreateCustomerGatewayRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static CreateCustomerGatewayRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCustomerGatewayRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo