@Generated(value="software.amazon.awssdk:codegen") public final class CreateClientVpnEndpointRequest extends Ec2Request implements ToCopyableBuilder<CreateClientVpnEndpointRequest.Builder,CreateClientVpnEndpointRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateClientVpnEndpointRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<ClientVpnAuthenticationRequest> |
authenticationOptions()
Information about the authentication method to be used to authenticate clients.
|
static CreateClientVpnEndpointRequest.Builder |
builder() |
String |
clientCidrBlock()
The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
|
ClientConnectOptions |
clientConnectOptions()
The options for managing connection authorization for new client connections.
|
String |
clientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
ConnectionLogOptions |
connectionLogOptions()
Information about the client connection logging options.
|
String |
description()
A brief description of the Client VPN endpoint.
|
List<String> |
dnsServers()
Information about the DNS servers to be used for DNS resolution.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasAuthenticationOptions()
Returns true if the AuthenticationOptions property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasDnsServers()
Returns true if the DnsServers property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasSecurityGroupIds()
Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTagSpecifications()
Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
List<SdkField<?>> |
sdkFields() |
List<String> |
securityGroupIds()
The IDs of one or more security groups to apply to the target network.
|
SelfServicePortal |
selfServicePortal()
Specify whether to enable the self-service portal for the Client VPN endpoint.
|
String |
selfServicePortalAsString()
Specify whether to enable the self-service portal for the Client VPN endpoint.
|
static Class<? extends CreateClientVpnEndpointRequest.Builder> |
serializableBuilderClass() |
String |
serverCertificateArn()
The ARN of the server certificate.
|
Boolean |
splitTunnel()
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
|
List<TagSpecification> |
tagSpecifications()
The tags to apply to the Client VPN endpoint during creation.
|
CreateClientVpnEndpointRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
TransportProtocol |
transportProtocol()
The transport protocol to be used by the VPN session.
|
String |
transportProtocolAsString()
The transport protocol to be used by the VPN session.
|
String |
vpcId()
The ID of the VPC to associate with the Client VPN endpoint.
|
Integer |
vpnPort()
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
|
overrideConfiguration
copy
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. The CIDR block should be /22 or greater.
public final String serverCertificateArn()
The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
public final boolean hasAuthenticationOptions()
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.
You can use hasAuthenticationOptions()
to see if a value was sent in this field.
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
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
public final boolean hasDnsServers()
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.
You can use hasDnsServers()
to see if a value was sent in this field.
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()
.
Default value: udp
TransportProtocol
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()
.
Default value: udp
TransportProtocol
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
Valid Values: 443
| 1194
Default Value: 443
public final String description()
A brief description of the Client VPN endpoint.
public final Boolean splitTunnel()
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.
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.
public final boolean hasTagSpecifications()
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.
You can use hasTagSpecifications()
to see if a value was sent in this field.
public final boolean hasSecurityGroupIds()
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.
You can use hasSecurityGroupIds()
to see if a value was sent in this field.
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.
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()
.
Default Value: enabled
SelfServicePortal
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()
.
Default Value: enabled
SelfServicePortal
public final ClientConnectOptions clientConnectOptions()
The options for managing connection authorization for new client connections.
public CreateClientVpnEndpointRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateClientVpnEndpointRequest.Builder,CreateClientVpnEndpointRequest>
toBuilder
in class Ec2Request
public static CreateClientVpnEndpointRequest.Builder builder()
public static Class<? extends CreateClientVpnEndpointRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.