AWSEC2CreateClientVpnEndpointRequest

Objective-C

@interface AWSEC2CreateClientVpnEndpointRequest

Swift

class AWSEC2CreateClientVpnEndpointRequest

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2ClientVpnAuthenticationRequest *> *_Nullable authenticationOptions;

    Swift

    var authenticationOptions: [AWSEC2ClientVpnAuthenticationRequest]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientCidrBlock;

    Swift

    var clientCidrBlock: String? { get set }

  • The options for managing connection authorization for new client connections.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2ClientConnectOptions *_Nullable clientConnectOptions;

    Swift

    var clientConnectOptions: AWSEC2ClientConnectOptions? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2ClientLoginBannerOptions *_Nullable clientLoginBannerOptions;

    Swift

    var clientLoginBannerOptions: AWSEC2ClientLoginBannerOptions? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientToken;

    Swift

    var clientToken: String? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2ConnectionLogOptions *_Nullable connectionLogOptions;

    Swift

    var connectionLogOptions: AWSEC2ConnectionLogOptions? { get set }

  • A brief description of the Client VPN endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable dnsServers;

    Swift

    var dnsServers: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable securityGroupIds;

    Swift

    var securityGroupIds: [String]? { get set }

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

    Default Value: enabled

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2SelfServicePortal selfServicePortal;

    Swift

    var selfServicePortal: AWSEC2SelfServicePortal { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable serverCertificateArn;

    Swift

    var serverCertificateArn: String? { get set }

  • The maximum VPN session duration time in hours.

    Valid values: 8 | 10 | 12 | 24

    Default value: 24

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable sessionTimeoutHours;

    Swift

    var sessionTimeoutHours: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable splitTunnel;

    Swift

    var splitTunnel: NSNumber? { get set }

  • The tags to apply to the Client VPN endpoint during creation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;

    Swift

    var tagSpecifications: [AWSEC2TagSpecification]? { get set }

  • The transport protocol to be used by the VPN session.

    Default value: udp

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2TransportProtocol transportProtocol;

    Swift

    var transportProtocol: AWSEC2TransportProtocol { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable vpcId;

    Swift

    var vpcId: String? { get set }

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

    Valid Values: 443 | 1194

    Default Value: 443

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable vpnPort;

    Swift

    var vpnPort: NSNumber? { get set }