You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::CreateClientVpnEndpointRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateClientVpnEndpointRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_cidr_block: "String", # required
  server_certificate_arn: "String", # required
  authentication_options: [ # required
    {
      type: "certificate-authentication", # accepts certificate-authentication, directory-service-authentication, federated-authentication
      active_directory: {
        directory_id: "String",
      },
      mutual_authentication: {
        client_root_certificate_chain_arn: "String",
      },
      federated_authentication: {
        saml_provider_arn: "String",
        self_service_saml_provider_arn: "String",
      },
    },
  ],
  connection_log_options: { # required
    enabled: false,
    cloudwatch_log_group: "String",
    cloudwatch_log_stream: "String",
  },
  dns_servers: ["String"],
  transport_protocol: "tcp", # accepts tcp, udp
  vpn_port: 1,
  description: "String",
  split_tunnel: false,
  dry_run: false,
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  security_group_ids: ["SecurityGroupId"],
  vpc_id: "VpcId",
  self_service_portal: "enabled", # accepts enabled, disabled
  client_connect_options: {
    enabled: false,
    lambda_function_arn: "String",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_options ⇒ Array<Types::ClientVpnAuthenticationRequest>

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

Returns:

#client_cidr_block ⇒ String

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.

Returns:

  • (String) —

    The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

#client_connect_options ⇒ Types::ClientConnectOptions

The options for managing connection authorization for new client connections.

Returns:

#client_token ⇒ String

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

Returns:

  • (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#connection_log_options ⇒ Types::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:

#description ⇒ String

A brief description of the Client VPN endpoint.

Returns:

  • (String) —

    A brief description of the Client VPN endpoint.

#dns_servers ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    Information about the DNS servers to be used for DNS resolution.

#dry_run ⇒ Boolean

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:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#security_group_ids ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    The IDs of one or more security groups to apply to the target network.

#self_service_portal ⇒ String

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

Default Value: enabled

Possible values:

  • enabled
  • disabled

Returns:

  • (String) —

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

#server_certificate_arn ⇒ String

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

Returns:

  • (String) —

    The ARN of the server certificate.

#split_tunnel ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#tag_specifications ⇒ Array<Types::TagSpecification>

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

Returns:

#transport_protocol ⇒ String

The transport protocol to be used by the VPN session.

Default value: udp

Possible values:

  • tcp
  • udp

Returns:

  • (String) —

    The transport protocol to be used by the VPN session.

#vpc_id ⇒ String

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:

  • (String) —

    The ID of the VPC to associate with the Client VPN endpoint.

#vpn_port ⇒ Integer

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

Valid Values: 443 | 1194

Default Value: 443

Returns:

  • (Integer) —

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