Skip to content

Data Source: awsEc2ClientVpnEndpoint

Get information on an EC2 Client VPN endpoint.

Example Usage

By Filter

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsEc2ClientVpnEndpoint.DataAwsEc2ClientVpnEndpoint(
  this,
  "example",
  {
    filter: [
      {
        name: "tag:Name",
        values: ["ExampleVpn"],
      },
    ],
  }
);

By Identifier

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsEc2ClientVpnEndpoint.DataAwsEc2ClientVpnEndpoint(
  this,
  "example",
  {
    clientVpnEndpointId: "cvpn-endpoint-083cf50d6eb314f21",
  }
);

Argument Reference

The following arguments are supported:

  • clientVpnEndpointId - (Optional) ID of the Client VPN endpoint.
  • filter - (Optional) One or more configuration blocks containing name-values filters. Detailed below.
  • tags - (Optional) Map of tags, each pair of which must exactly match a pair on the desired endpoint.

filter

This block allows for complex filters. You can use one or more filter blocks.

The following arguments are required:

  • name - (Required) Name of the field to filter by, as defined by the underlying AWS API.
  • values - (Required) Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.

Attribute Reference

In addition to all arguments above, the following attributes are exported:

  • arn - The ARN of the Client VPN endpoint.
  • authenticationOptions - Information about the authentication method used by the Client VPN endpoint.
  • clientCidrBlock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
  • clientConnectOptions - The options for managing connection authorization for new client connections.
  • clientLoginBannerOptions - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
  • connectionLogOptions - Information about the client connection logging options for the Client VPN endpoint.
  • description - Brief description of the endpoint.
  • dnsName - DNS name to be used by clients when connecting to the Client VPN endpoint.
  • dnsServers - Information about the DNS servers to be used for DNS resolution.
  • securityGroupIds - IDs of the security groups for the target network associated with the Client VPN endpoint.
  • selfServicePortal - Whether the self-service portal for the Client VPN endpoint is enabled.
  • serverCertificateArn - The ARN of the server certificate.
  • sessionTimeoutHours - The maximum VPN session duration time in hours.
  • splitTunnel - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
  • transportProtocol - Transport protocol used by the Client VPN endpoint.
  • vpcId - ID of the VPC associated with the Client VPN endpoint.
  • vpnPort - Port number for the Client VPN endpoint.

Timeouts

Configuration options:

  • read - (Default 20M)