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

Class CreateVpnGatewayRequest

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.CreateVpnGatewayRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateVpnGatewayRequest.Builder,CreateVpnGatewayRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateVpnGatewayRequest extends Ec2Request implements ToCopyableBuilder<CreateVpnGatewayRequest.Builder,CreateVpnGatewayRequest>

Contains the parameters for CreateVpnGateway.

  • Method Details

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone for the virtual private gateway.

      Returns:
      The Availability Zone for the virtual private gateway.

    • type

      public final GatewayType type()

      The type of VPN connection this virtual private gateway supports.

      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 this virtual private gateway supports.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of VPN connection this virtual private gateway supports.

      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 this virtual private gateway supports.
      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 virtual private 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 virtual private gateway.

    • amazonSideAsn

      public final Long amazonSideAsn()

      A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

      Default: 64512

      Returns:
      A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

      Default: 64512

    • 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 CreateVpnGatewayRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateVpnGatewayRequest.Builder,CreateVpnGatewayRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static CreateVpnGatewayRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateVpnGatewayRequest.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