Skip to content

Describes one or more Client VPN endpoints in the account

Description

Describes one or more Client VPN endpoints in the account.

Usage

ec2_describe_client_vpn_endpoints(ClientVpnEndpointIds, MaxResults,
  NextToken, Filters, DryRun)

Arguments

  • ClientVpnEndpointIds

    The ID of the Client VPN endpoint.

  • MaxResults

    The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

  • NextToken

    The token to retrieve the next page of results.

  • Filters

    One or more filters. Filter names and values are case-sensitive.

    • endpoint-id - The ID of the Client VPN endpoint.
    • transport-protocol - The transport protocol (tcp | udp).

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

Value

A list with the following syntax:

list(
  ClientVpnEndpoints = list(
    list(
      ClientVpnEndpointId = "string",
      Description = "string",
      Status = list(
        Code = "pending-associate"|"available"|"deleting"|"deleted"|"pending",
        Message = "string"
      ),
      CreationTime = "string",
      DeletionTime = "string",
      DnsName = "string",
      ClientCidrBlock = "string",
      DnsServers = list(
        "string"
      ),
      SplitTunnel = TRUE|FALSE,
      VpnProtocol = "openvpn",
      TransportProtocol = "tcp"|"udp",
      VpnPort = 123,
      AssociatedTargetNetworks = list(
        list(
          NetworkId = "string",
          NetworkType = "vpc"
        )
      ),
      ServerCertificateArn = "string",
      AuthenticationOptions = list(
        list(
          Type = "certificate-authentication"|"directory-service-authentication"|"federated-authentication",
          ActiveDirectory = list(
            DirectoryId = "string"
          ),
          MutualAuthentication = list(
            ClientRootCertificateChain = "string"
          ),
          FederatedAuthentication = list(
            SamlProviderArn = "string",
            SelfServiceSamlProviderArn = "string"
          )
        )
      ),
      ConnectionLogOptions = list(
        Enabled = TRUE|FALSE,
        CloudwatchLogGroup = "string",
        CloudwatchLogStream = "string",
        IncludeAuthorizationPolicyContext = TRUE|FALSE
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      SecurityGroupIds = list(
        "string"
      ),
      VpcId = "string",
      SelfServicePortalUrl = "string",
      ClientConnectOptions = list(
        Enabled = TRUE|FALSE,
        LambdaFunctionArn = "string",
        Status = list(
          Code = "applying"|"applied",
          Message = "string"
        )
      ),
      SessionTimeoutHours = 123,
      ClientLoginBannerOptions = list(
        Enabled = TRUE|FALSE,
        BannerText = "string"
      ),
      ClientRouteEnforcementOptions = list(
        Enforced = TRUE|FALSE
      ),
      DisconnectOnSessionTimeout = TRUE|FALSE,
      EndpointIpAddressType = "ipv4"|"ipv6"|"dual-stack",
      TrafficIpAddressType = "ipv4"|"ipv6"|"dual-stack",
      TransitGatewayConfiguration = list(
        TransitGatewayId = "string",
        TransitGatewayAttachmentId = "string",
        AvailabilityZones = list(
          "string"
        ),
        AvailabilityZoneIds = list(
          "string"
        )
      ),
      DevicePostureOptions = list(
        TrustProviders = list(
          list(
            TrustProviderType = "crowdstrike"|"jamf"|"jumpcloud",
            TenantId = "string",
            PublicSigningKeyUrl = "string"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_client_vpn_endpoints(
  ClientVpnEndpointIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)