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

Class CreateClientVpnEndpointRequest

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

  • Method Details

    • clientCidrBlock

      public final String clientCidrBlock()

      The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.

      Returns:
      The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.

    • serverCertificateArn

      public final String serverCertificateArn()

      The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

      Returns:
      The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

    • hasAuthenticationOptions

      public final boolean hasAuthenticationOptions()
      For responses, this returns true if the service returned a value for the AuthenticationOptions 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.

    • authenticationOptions

      public final List<ClientVpnAuthenticationRequest> authenticationOptions()

      Information about the authentication method to be used to authenticate clients.

      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 hasAuthenticationOptions() method.

      Returns:
      Information about the authentication method to be used to authenticate clients.

    • connectionLogOptions

      public final ConnectionLogOptions connectionLogOptions()

      Information about the client connection logging options.

      If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

      • Client connection requests

      • Client connection results (successful and unsuccessful)

      • Reasons for unsuccessful client connection requests

      • Client connection termination time

      Returns:
      Information about the client connection logging options.

      If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

      • Client connection requests

      • Client connection results (successful and unsuccessful)

      • Reasons for unsuccessful client connection requests

      • Client connection termination time

    • hasDnsServers

      public final boolean hasDnsServers()
      For responses, this returns true if the service returned a value for the DnsServers 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.

    • dnsServers

      public final List<String> dnsServers()

      Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

      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 hasDnsServers() method.

      Returns:
      Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

    • transportProtocol

      public final TransportProtocol transportProtocol()

      The transport protocol to be used by the VPN session.

      Default value: udp

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

      Returns:
      The transport protocol to be used by the VPN session.

      Default value: udp

      See Also:

    • transportProtocolAsString

      public final String transportProtocolAsString()

      The transport protocol to be used by the VPN session.

      Default value: udp

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

      Returns:
      The transport protocol to be used by the VPN session.

      Default value: udp

      See Also:

    • vpnPort

      public final Integer vpnPort()

      The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

      Valid Values: 443 | 1194

      Default Value: 443

      Returns:
      The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

      Valid Values: 443 | 1194

      Default Value: 443

    • description

      public final String description()

      A brief description of the Client VPN endpoint.

      Returns:
      A brief description of the Client VPN endpoint.

    • splitTunnel

      public final Boolean splitTunnel()

      Indicates whether split-tunnel is enabled on the Client VPN endpoint.

      By default, split-tunnel on a VPN endpoint is disabled.

      For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

      Returns:
      Indicates whether split-tunnel is enabled on the Client VPN endpoint.

      By default, split-tunnel on a VPN endpoint is disabled.

      For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

    • 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.

    • clientToken

      public final String clientToken()

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

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

    • 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 Client VPN endpoint during creation.

      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 Client VPN endpoint during creation.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

    • securityGroupIds

      public final List<String> securityGroupIds()

      The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

      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 hasSecurityGroupIds() method.

      Returns:
      The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

    • vpcId

      public final String vpcId()

      The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

      Returns:
      The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

    • selfServicePortal

      public final SelfServicePortal selfServicePortal()

      Specify whether to enable the self-service portal for the Client VPN endpoint.

      Default Value: enabled

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

      Returns:
      Specify whether to enable the self-service portal for the Client VPN endpoint.

      Default Value: enabled

      See Also:

    • selfServicePortalAsString

      public final String selfServicePortalAsString()

      Specify whether to enable the self-service portal for the Client VPN endpoint.

      Default Value: enabled

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

      Returns:
      Specify whether to enable the self-service portal for the Client VPN endpoint.

      Default Value: enabled

      See Also:

    • clientConnectOptions

      public final ClientConnectOptions clientConnectOptions()

      The options for managing connection authorization for new client connections.

      Returns:
      The options for managing connection authorization for new client connections.

    • sessionTimeoutHours

      public final Integer sessionTimeoutHours()

      The maximum VPN session duration time in hours.

      Valid values: 8 | 10 | 12 | 24

      Default value: 24

      Returns:
      The maximum VPN session duration time in hours.

      Valid values: 8 | 10 | 12 | 24

      Default value: 24

    • clientLoginBannerOptions

      public final ClientLoginBannerOptions clientLoginBannerOptions()

      Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

      Returns:
      Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

    • toBuilder

      public CreateClientVpnEndpointRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateClientVpnEndpointRequest.Builder,CreateClientVpnEndpointRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static CreateClientVpnEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateClientVpnEndpointRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.