Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2clientvpn
  5. getEndpoint
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ec2clientvpn.getEndpoint

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Get information on an EC2 Client VPN endpoint.

    Example Usage

    By Filter

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2clientvpn.getEndpoint({
    filters: [{
        name: "tag:Name",
        values: ["ExampleVpn"],
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2clientvpn.get_endpoint(filters=[{
    "name": "tag:Name",
    "values": ["ExampleVpn"],
}])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2clientvpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2clientvpn.LookupEndpoint(ctx, &ec2clientvpn.LookupEndpointArgs{
			Filters: []ec2clientvpn.GetEndpointFilter{
				{
					Name: "tag:Name",
					Values: []string{
						"ExampleVpn",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2ClientVpn.GetEndpoint.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2ClientVpn.Inputs.GetEndpointFilterInputArgs
            {
                Name = "tag:Name",
                Values = new[]
                {
                    "ExampleVpn",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2clientvpn.Ec2clientvpnFunctions;
import com.pulumi.aws.ec2clientvpn.inputs.GetEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Ec2clientvpnFunctions.getEndpoint(GetEndpointArgs.builder()
            .filters(GetEndpointFilterArgs.builder()
                .name("tag:Name")
                .values("ExampleVpn")
                .build())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:ec2clientvpn:getEndpoint
      Arguments:
        filters:
          - name: tag:Name
            values:
              - ExampleVpn

    By Identifier

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2clientvpn.getEndpoint({
    clientVpnEndpointId: "cvpn-endpoint-083cf50d6eb314f21",
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2clientvpn.get_endpoint(client_vpn_endpoint_id="cvpn-endpoint-083cf50d6eb314f21")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2clientvpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2clientvpn.LookupEndpoint(ctx, &ec2clientvpn.LookupEndpointArgs{
			ClientVpnEndpointId: pulumi.StringRef("cvpn-endpoint-083cf50d6eb314f21"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2ClientVpn.GetEndpoint.Invoke(new()
    {
        ClientVpnEndpointId = "cvpn-endpoint-083cf50d6eb314f21",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2clientvpn.Ec2clientvpnFunctions;
import com.pulumi.aws.ec2clientvpn.inputs.GetEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Ec2clientvpnFunctions.getEndpoint(GetEndpointArgs.builder()
            .clientVpnEndpointId("cvpn-endpoint-083cf50d6eb314f21")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:ec2clientvpn:getEndpoint
      Arguments:
        clientVpnEndpointId: cvpn-endpoint-083cf50d6eb314f21

    Using getEndpoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>
    def get_endpoint(client_vpn_endpoint_id: Optional[str] = None,
                 filters: Optional[Sequence[GetEndpointFilter]] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(client_vpn_endpoint_id: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetEndpointFilterArgs]]]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]
    func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

    > Note: This function is named LookupEndpoint in the Go SDK.

    public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws:ec2clientvpn/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClientVpnEndpointId string
    ID of the Client VPN endpoint.
    Filters List<GetEndpointFilter>
    One or more configuration blocks containing name-values filters. Detailed below.
    Tags Dictionary<string, string>
    Map of tags, each pair of which must exactly match a pair on the desired endpoint.
    ClientVpnEndpointId string
    ID of the Client VPN endpoint.
    Filters []GetEndpointFilter
    One or more configuration blocks containing name-values filters. Detailed below.
    Tags map[string]string
    Map of tags, each pair of which must exactly match a pair on the desired endpoint.
    clientVpnEndpointId String
    ID of the Client VPN endpoint.
    filters List<GetEndpointFilter>
    One or more configuration blocks containing name-values filters. Detailed below.
    tags Map<String,String>
    Map of tags, each pair of which must exactly match a pair on the desired endpoint.
    clientVpnEndpointId string
    ID of the Client VPN endpoint.
    filters GetEndpointFilter[]
    One or more configuration blocks containing name-values filters. Detailed below.
    tags {[key: string]: string}
    Map of tags, each pair of which must exactly match a pair on the desired endpoint.
    client_vpn_endpoint_id str
    ID of the Client VPN endpoint.
    filters Sequence[GetEndpointFilter]
    One or more configuration blocks containing name-values filters. Detailed below.
    tags Mapping[str, str]
    Map of tags, each pair of which must exactly match a pair on the desired endpoint.
    clientVpnEndpointId String
    ID of the Client VPN endpoint.
    filters List<Property Map>
    One or more configuration blocks containing name-values filters. Detailed below.
    tags Map<String>
    Map of tags, each pair of which must exactly match a pair on the desired endpoint.

    getEndpoint Result

    The following output properties are available:

    Arn string
    The ARN of the Client VPN endpoint.
    AuthenticationOptions List<GetEndpointAuthenticationOption>
    Information about the authentication method used by the Client VPN endpoint.
    ClientCidrBlock string
    IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
    ClientConnectOptions List<GetEndpointClientConnectOption>
    The options for managing connection authorization for new client connections.
    ClientLoginBannerOptions List<GetEndpointClientLoginBannerOption>
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
    ClientVpnEndpointId string
    ConnectionLogOptions List<GetEndpointConnectionLogOption>
    Information about the client connection logging options for the Client VPN endpoint.
    Description string
    Brief description of the endpoint.
    DnsName string
    DNS name to be used by clients when connecting to the Client VPN endpoint.
    DnsServers List<string>
    Information about the DNS servers to be used for DNS resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroupIds List<string>
    IDs of the security groups for the target network associated with the Client VPN endpoint.
    SelfServicePortal string
    Whether the self-service portal for the Client VPN endpoint is enabled.
    SelfServicePortalUrl string
    The URL of the self-service portal.
    ServerCertificateArn string
    The ARN of the server certificate.
    SessionTimeoutHours int
    The maximum VPN session duration time in hours.
    SplitTunnel bool
    Whether split-tunnel is enabled in the AWS Client VPN endpoint.
    Tags Dictionary<string, string>
    TransportProtocol string
    Transport protocol used by the Client VPN endpoint.
    VpcId string
    ID of the VPC associated with the Client VPN endpoint.
    VpnPort int
    Port number for the Client VPN endpoint.
    Filters List<GetEndpointFilter>
    Arn string
    The ARN of the Client VPN endpoint.
    AuthenticationOptions []GetEndpointAuthenticationOption
    Information about the authentication method used by the Client VPN endpoint.
    ClientCidrBlock string
    IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
    ClientConnectOptions []GetEndpointClientConnectOption
    The options for managing connection authorization for new client connections.
    ClientLoginBannerOptions []GetEndpointClientLoginBannerOption
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
    ClientVpnEndpointId string
    ConnectionLogOptions []GetEndpointConnectionLogOption
    Information about the client connection logging options for the Client VPN endpoint.
    Description string
    Brief description of the endpoint.
    DnsName string
    DNS name to be used by clients when connecting to the Client VPN endpoint.
    DnsServers []string
    Information about the DNS servers to be used for DNS resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroupIds []string
    IDs of the security groups for the target network associated with the Client VPN endpoint.
    SelfServicePortal string
    Whether the self-service portal for the Client VPN endpoint is enabled.
    SelfServicePortalUrl string
    The URL of the self-service portal.
    ServerCertificateArn string
    The ARN of the server certificate.
    SessionTimeoutHours int
    The maximum VPN session duration time in hours.
    SplitTunnel bool
    Whether split-tunnel is enabled in the AWS Client VPN endpoint.
    Tags map[string]string
    TransportProtocol string
    Transport protocol used by the Client VPN endpoint.
    VpcId string
    ID of the VPC associated with the Client VPN endpoint.
    VpnPort int
    Port number for the Client VPN endpoint.
    Filters []GetEndpointFilter
    arn String
    The ARN of the Client VPN endpoint.
    authenticationOptions List<GetEndpointAuthenticationOption>
    Information about the authentication method used by the Client VPN endpoint.
    clientCidrBlock String
    IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
    clientConnectOptions List<GetEndpointClientConnectOption>
    The options for managing connection authorization for new client connections.
    clientLoginBannerOptions List<GetEndpointClientLoginBannerOption>
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
    clientVpnEndpointId String
    connectionLogOptions List<GetEndpointConnectionLogOption>
    Information about the client connection logging options for the Client VPN endpoint.
    description String
    Brief description of the endpoint.
    dnsName String
    DNS name to be used by clients when connecting to the Client VPN endpoint.
    dnsServers List<String>
    Information about the DNS servers to be used for DNS resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroupIds List<String>
    IDs of the security groups for the target network associated with the Client VPN endpoint.
    selfServicePortal String
    Whether the self-service portal for the Client VPN endpoint is enabled.
    selfServicePortalUrl String
    The URL of the self-service portal.
    serverCertificateArn String
    The ARN of the server certificate.
    sessionTimeoutHours Integer
    The maximum VPN session duration time in hours.
    splitTunnel Boolean
    Whether split-tunnel is enabled in the AWS Client VPN endpoint.
    tags Map<String,String>
    transportProtocol String
    Transport protocol used by the Client VPN endpoint.
    vpcId String
    ID of the VPC associated with the Client VPN endpoint.
    vpnPort Integer
    Port number for the Client VPN endpoint.
    filters List<GetEndpointFilter>
    arn string
    The ARN of the Client VPN endpoint.
    authenticationOptions GetEndpointAuthenticationOption[]
    Information about the authentication method used by the Client VPN endpoint.
    clientCidrBlock string
    IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
    clientConnectOptions GetEndpointClientConnectOption[]
    The options for managing connection authorization for new client connections.
    clientLoginBannerOptions GetEndpointClientLoginBannerOption[]
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
    clientVpnEndpointId string
    connectionLogOptions GetEndpointConnectionLogOption[]
    Information about the client connection logging options for the Client VPN endpoint.
    description string
    Brief description of the endpoint.
    dnsName string
    DNS name to be used by clients when connecting to the Client VPN endpoint.
    dnsServers string[]
    Information about the DNS servers to be used for DNS resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    securityGroupIds string[]
    IDs of the security groups for the target network associated with the Client VPN endpoint.
    selfServicePortal string
    Whether the self-service portal for the Client VPN endpoint is enabled.
    selfServicePortalUrl string
    The URL of the self-service portal.
    serverCertificateArn string
    The ARN of the server certificate.
    sessionTimeoutHours number
    The maximum VPN session duration time in hours.
    splitTunnel boolean
    Whether split-tunnel is enabled in the AWS Client VPN endpoint.
    tags {[key: string]: string}
    transportProtocol string
    Transport protocol used by the Client VPN endpoint.
    vpcId string
    ID of the VPC associated with the Client VPN endpoint.
    vpnPort number
    Port number for the Client VPN endpoint.
    filters GetEndpointFilter[]
    arn str
    The ARN of the Client VPN endpoint.
    authentication_options Sequence[GetEndpointAuthenticationOption]
    Information about the authentication method used by the Client VPN endpoint.
    client_cidr_block str
    IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
    client_connect_options Sequence[GetEndpointClientConnectOption]
    The options for managing connection authorization for new client connections.
    client_login_banner_options Sequence[GetEndpointClientLoginBannerOption]
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
    client_vpn_endpoint_id str
    connection_log_options Sequence[GetEndpointConnectionLogOption]
    Information about the client connection logging options for the Client VPN endpoint.
    description str
    Brief description of the endpoint.
    dns_name str
    DNS name to be used by clients when connecting to the Client VPN endpoint.
    dns_servers Sequence[str]
    Information about the DNS servers to be used for DNS resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    security_group_ids Sequence[str]
    IDs of the security groups for the target network associated with the Client VPN endpoint.
    self_service_portal str
    Whether the self-service portal for the Client VPN endpoint is enabled.
    self_service_portal_url str
    The URL of the self-service portal.
    server_certificate_arn str
    The ARN of the server certificate.
    session_timeout_hours int
    The maximum VPN session duration time in hours.
    split_tunnel bool
    Whether split-tunnel is enabled in the AWS Client VPN endpoint.
    tags Mapping[str, str]
    transport_protocol str
    Transport protocol used by the Client VPN endpoint.
    vpc_id str
    ID of the VPC associated with the Client VPN endpoint.
    vpn_port int
    Port number for the Client VPN endpoint.
    filters Sequence[GetEndpointFilter]
    arn String
    The ARN of the Client VPN endpoint.
    authenticationOptions List<Property Map>
    Information about the authentication method used by the Client VPN endpoint.
    clientCidrBlock String
    IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
    clientConnectOptions List<Property Map>
    The options for managing connection authorization for new client connections.
    clientLoginBannerOptions List<Property Map>
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
    clientVpnEndpointId String
    connectionLogOptions List<Property Map>
    Information about the client connection logging options for the Client VPN endpoint.
    description String
    Brief description of the endpoint.
    dnsName String
    DNS name to be used by clients when connecting to the Client VPN endpoint.
    dnsServers List<String>
    Information about the DNS servers to be used for DNS resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroupIds List<String>
    IDs of the security groups for the target network associated with the Client VPN endpoint.
    selfServicePortal String
    Whether the self-service portal for the Client VPN endpoint is enabled.
    selfServicePortalUrl String
    The URL of the self-service portal.
    serverCertificateArn String
    The ARN of the server certificate.
    sessionTimeoutHours Number
    The maximum VPN session duration time in hours.
    splitTunnel Boolean
    Whether split-tunnel is enabled in the AWS Client VPN endpoint.
    tags Map<String>
    transportProtocol String
    Transport protocol used by the Client VPN endpoint.
    vpcId String
    ID of the VPC associated with the Client VPN endpoint.
    vpnPort Number
    Port number for the Client VPN endpoint.
    filters List<Property Map>

    Supporting Types

    GetEndpointAuthenticationOption

    GetEndpointClientConnectOption

    GetEndpointClientLoginBannerOption

    BannerText string
    Enabled bool
    BannerText string
    Enabled bool
    bannerText String
    enabled Boolean
    bannerText string
    enabled boolean
    bannerText String
    enabled Boolean

    GetEndpointConnectionLogOption

    GetEndpointFilter

    Name string
    Name of the field to filter by, as defined by the underlying AWS API.
    Values List<string>
    Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.
    Name string
    Name of the field to filter by, as defined by the underlying AWS API.
    Values []string
    Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.
    name String
    Name of the field to filter by, as defined by the underlying AWS API.
    values List<String>
    Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.
    name string
    Name of the field to filter by, as defined by the underlying AWS API.
    values string[]
    Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.
    name str
    Name of the field to filter by, as defined by the underlying AWS API.
    values Sequence[str]
    Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.
    name String
    Name of the field to filter by, as defined by the underlying AWS API.
    values List<String>
    Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws