getEndpoint function

Future<GetEndpointResult> getEndpoint(
  1. GetEndpointArgs args, {
  2. InvokeOptions? options,
})

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"],
}])
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2clientvpn_getendpoint" "example" {
  filters {
    name   = "tag:Name"
    values = ["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 com.pulumi.aws.ec2clientvpn.inputs.GetEndpointFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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")
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2clientvpn_getendpoint" "example" {
  client_vpn_endpoint_id = "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.ArrayList;
import java.util.Arrays;
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

args Arguments passed to this invoke. Arguments for getEndpoint. options Invoke options controlling this call.

Implementation

Future<GetEndpointResult> getEndpoint(
  GetEndpointArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ec2clientvpn/getEndpoint:getEndpoint',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetEndpointResult.fromMap(result);
}