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

Class CreateClientVpnRouteRequest

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

  • Method Details

    • clientVpnEndpointId

      public final String clientVpnEndpointId()

      The ID of the Client VPN endpoint to which to add the route.

      Returns:
      The ID of the Client VPN endpoint to which to add the route.

    • destinationCidrBlock

      public final String destinationCidrBlock()

      The IPv4 address range, in CIDR notation, of the route destination. For example:

      • To add a route for Internet access, enter 0.0.0.0/0

      • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

      • To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range

      • To add a route for the local network, enter the client CIDR range

      Returns:
      The IPv4 address range, in CIDR notation, of the route destination. For example:

      • To add a route for Internet access, enter 0.0.0.0/0

      • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

      • To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range

      • To add a route for the local network, enter the client CIDR range

    • targetVpcSubnetId

      public final String targetVpcSubnetId()

      The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

      Alternatively, if you're adding a route for the local network, specify local.

      This parameter is required for VPC-based Client VPN endpoints. For Transit Gateway-based endpoints, this parameter is not required.

      Returns:
      The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

      Alternatively, if you're adding a route for the local network, specify local.

      This parameter is required for VPC-based Client VPN endpoints. For Transit Gateway-based endpoints, this parameter is not required.

    • description

      public final String description()

      A brief description of the route.

      Returns:
      A brief description of the route.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

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

    • builder

      public static CreateClientVpnRouteRequest.Builder builder()

    • serializableBuilderClass

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