AWS v6.62.2 published on Tuesday, Dec 3, 2024 by Pulumi
aws.ec2clientvpn.getEndpoint
Explore with Pulumi AI
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:
- Client
Vpn stringEndpoint Id - ID of the Client VPN endpoint.
- Filters
List<Get
Endpoint Filter> - One or more configuration blocks containing name-values filters. Detailed below.
- Dictionary<string, string>
- Map of tags, each pair of which must exactly match a pair on the desired endpoint.
- Client
Vpn stringEndpoint Id - ID of the Client VPN endpoint.
- Filters
[]Get
Endpoint Filter - One or more configuration blocks containing name-values filters. Detailed below.
- map[string]string
- Map of tags, each pair of which must exactly match a pair on the desired endpoint.
- client
Vpn StringEndpoint Id - ID of the Client VPN endpoint.
- filters
List<Get
Endpoint Filter> - One or more configuration blocks containing name-values filters. Detailed below.
- Map<String,String>
- Map of tags, each pair of which must exactly match a pair on the desired endpoint.
- client
Vpn stringEndpoint Id - ID of the Client VPN endpoint.
- filters
Get
Endpoint Filter[] - One or more configuration blocks containing name-values filters. Detailed below.
- {[key: string]: string}
- Map of tags, each pair of which must exactly match a pair on the desired endpoint.
- client_
vpn_ strendpoint_ id - ID of the Client VPN endpoint.
- filters
Sequence[Get
Endpoint Filter] - One or more configuration blocks containing name-values filters. Detailed below.
- Mapping[str, str]
- Map of tags, each pair of which must exactly match a pair on the desired endpoint.
- client
Vpn StringEndpoint Id - ID of the Client VPN endpoint.
- filters List<Property Map>
- One or more configuration blocks containing name-values filters. Detailed below.
- 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.
- Authentication
Options List<GetEndpoint Authentication Option> - Information about the authentication method used by the Client VPN endpoint.
- Client
Cidr stringBlock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- Client
Connect List<GetOptions Endpoint Client Connect Option> - The options for managing connection authorization for new client connections.
- List<Get
Endpoint Client Login Banner Option> - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
- Client
Vpn stringEndpoint Id - Connection
Log List<GetOptions Endpoint Connection Log Option> - Information about the client connection logging options for the Client VPN endpoint.
- Description string
- Brief description of the endpoint.
- Dns
Name string - DNS name to be used by clients when connecting to the Client VPN endpoint.
- Dns
Servers List<string> - Information about the DNS servers to be used for DNS resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Security
Group List<string>Ids - IDs of the security groups for the target network associated with the Client VPN endpoint.
- Self
Service stringPortal - Whether the self-service portal for the Client VPN endpoint is enabled.
- Self
Service stringPortal Url - The URL of the self-service portal.
- Server
Certificate stringArn - The ARN of the server certificate.
- Session
Timeout intHours - The maximum VPN session duration time in hours.
- Split
Tunnel bool - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
- Dictionary<string, string>
- Transport
Protocol string - Transport protocol used by the Client VPN endpoint.
- Vpc
Id string - ID of the VPC associated with the Client VPN endpoint.
- Vpn
Port int - Port number for the Client VPN endpoint.
- Filters
List<Get
Endpoint Filter>
- Arn string
- The ARN of the Client VPN endpoint.
- Authentication
Options []GetEndpoint Authentication Option - Information about the authentication method used by the Client VPN endpoint.
- Client
Cidr stringBlock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- Client
Connect []GetOptions Endpoint Client Connect Option - The options for managing connection authorization for new client connections.
- []Get
Endpoint Client Login Banner Option - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
- Client
Vpn stringEndpoint Id - Connection
Log []GetOptions Endpoint Connection Log Option - Information about the client connection logging options for the Client VPN endpoint.
- Description string
- Brief description of the endpoint.
- Dns
Name string - DNS name to be used by clients when connecting to the Client VPN endpoint.
- Dns
Servers []string - Information about the DNS servers to be used for DNS resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Security
Group []stringIds - IDs of the security groups for the target network associated with the Client VPN endpoint.
- Self
Service stringPortal - Whether the self-service portal for the Client VPN endpoint is enabled.
- Self
Service stringPortal Url - The URL of the self-service portal.
- Server
Certificate stringArn - The ARN of the server certificate.
- Session
Timeout intHours - The maximum VPN session duration time in hours.
- Split
Tunnel bool - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
- map[string]string
- Transport
Protocol string - Transport protocol used by the Client VPN endpoint.
- Vpc
Id string - ID of the VPC associated with the Client VPN endpoint.
- Vpn
Port int - Port number for the Client VPN endpoint.
- Filters
[]Get
Endpoint Filter
- arn String
- The ARN of the Client VPN endpoint.
- authentication
Options List<GetEndpoint Authentication Option> - Information about the authentication method used by the Client VPN endpoint.
- client
Cidr StringBlock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- client
Connect List<GetOptions Endpoint Client Connect Option> - The options for managing connection authorization for new client connections.
- List<Get
Endpoint Client Login Banner Option> - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
- client
Vpn StringEndpoint Id - connection
Log List<GetOptions Endpoint Connection Log Option> - Information about the client connection logging options for the Client VPN endpoint.
- description String
- Brief description of the endpoint.
- dns
Name String - DNS name to be used by clients when connecting to the Client VPN endpoint.
- dns
Servers List<String> - Information about the DNS servers to be used for DNS resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- security
Group List<String>Ids - IDs of the security groups for the target network associated with the Client VPN endpoint.
- self
Service StringPortal - Whether the self-service portal for the Client VPN endpoint is enabled.
- self
Service StringPortal Url - The URL of the self-service portal.
- server
Certificate StringArn - The ARN of the server certificate.
- session
Timeout IntegerHours - The maximum VPN session duration time in hours.
- split
Tunnel Boolean - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
- Map<String,String>
- transport
Protocol String - Transport protocol used by the Client VPN endpoint.
- vpc
Id String - ID of the VPC associated with the Client VPN endpoint.
- vpn
Port Integer - Port number for the Client VPN endpoint.
- filters
List<Get
Endpoint Filter>
- arn string
- The ARN of the Client VPN endpoint.
- authentication
Options GetEndpoint Authentication Option[] - Information about the authentication method used by the Client VPN endpoint.
- client
Cidr stringBlock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- client
Connect GetOptions Endpoint Client Connect Option[] - The options for managing connection authorization for new client connections.
- Get
Endpoint Client Login Banner Option[] - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
- client
Vpn stringEndpoint Id - connection
Log GetOptions Endpoint Connection Log Option[] - Information about the client connection logging options for the Client VPN endpoint.
- description string
- Brief description of the endpoint.
- dns
Name string - DNS name to be used by clients when connecting to the Client VPN endpoint.
- dns
Servers string[] - Information about the DNS servers to be used for DNS resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- security
Group string[]Ids - IDs of the security groups for the target network associated with the Client VPN endpoint.
- self
Service stringPortal - Whether the self-service portal for the Client VPN endpoint is enabled.
- self
Service stringPortal Url - The URL of the self-service portal.
- server
Certificate stringArn - The ARN of the server certificate.
- session
Timeout numberHours - The maximum VPN session duration time in hours.
- split
Tunnel boolean - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
- {[key: string]: string}
- transport
Protocol string - Transport protocol used by the Client VPN endpoint.
- vpc
Id string - ID of the VPC associated with the Client VPN endpoint.
- vpn
Port number - Port number for the Client VPN endpoint.
- filters
Get
Endpoint Filter[]
- arn str
- The ARN of the Client VPN endpoint.
- authentication_
options Sequence[GetEndpoint Authentication Option] - Information about the authentication method used by the Client VPN endpoint.
- client_
cidr_ strblock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- client_
connect_ Sequence[Getoptions Endpoint Client Connect Option] - The options for managing connection authorization for new client connections.
- Sequence[Get
Endpoint Client Login Banner Option] - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
- client_
vpn_ strendpoint_ id - connection_
log_ Sequence[Getoptions Endpoint Connection Log Option] - 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_ Sequence[str]ids - IDs of the security groups for the target network associated with the Client VPN endpoint.
- self_
service_ strportal - Whether the self-service portal for the Client VPN endpoint is enabled.
- self_
service_ strportal_ url - The URL of the self-service portal.
- server_
certificate_ strarn - The ARN of the server certificate.
- session_
timeout_ inthours - The maximum VPN session duration time in hours.
- split_
tunnel bool - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
- 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[Get
Endpoint Filter]
- arn String
- The ARN of the Client VPN endpoint.
- authentication
Options List<Property Map> - Information about the authentication method used by the Client VPN endpoint.
- client
Cidr StringBlock - IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- client
Connect List<Property Map>Options - The options for managing connection authorization for new client connections.
- List<Property Map>
- Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
- client
Vpn StringEndpoint Id - connection
Log List<Property Map>Options - Information about the client connection logging options for the Client VPN endpoint.
- description String
- Brief description of the endpoint.
- dns
Name String - DNS name to be used by clients when connecting to the Client VPN endpoint.
- dns
Servers List<String> - Information about the DNS servers to be used for DNS resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- security
Group List<String>Ids - IDs of the security groups for the target network associated with the Client VPN endpoint.
- self
Service StringPortal - Whether the self-service portal for the Client VPN endpoint is enabled.
- self
Service StringPortal Url - The URL of the self-service portal.
- server
Certificate StringArn - The ARN of the server certificate.
- session
Timeout NumberHours - The maximum VPN session duration time in hours.
- split
Tunnel Boolean - Whether split-tunnel is enabled in the AWS Client VPN endpoint.
- Map<String>
- transport
Protocol String - Transport protocol used by the Client VPN endpoint.
- vpc
Id String - ID of the VPC associated with the Client VPN endpoint.
- vpn
Port Number - Port number for the Client VPN endpoint.
- filters List<Property Map>
Supporting Types
GetEndpointAuthenticationOption
- Active
Directory stringId - Root
Certificate stringChain Arn - Saml
Provider stringArn - Self
Service stringSaml Provider Arn - Type string
- Active
Directory stringId - Root
Certificate stringChain Arn - Saml
Provider stringArn - Self
Service stringSaml Provider Arn - Type string
- active
Directory StringId - root
Certificate StringChain Arn - saml
Provider StringArn - self
Service StringSaml Provider Arn - type String
- active
Directory stringId - root
Certificate stringChain Arn - saml
Provider stringArn - self
Service stringSaml Provider Arn - type string
- active
Directory StringId - root
Certificate StringChain Arn - saml
Provider StringArn - self
Service StringSaml Provider Arn - type String
GetEndpointClientConnectOption
- Enabled bool
- Lambda
Function stringArn
- Enabled bool
- Lambda
Function stringArn
- enabled Boolean
- lambda
Function StringArn
- enabled boolean
- lambda
Function stringArn
- enabled bool
- lambda_
function_ strarn
- enabled Boolean
- lambda
Function StringArn
GetEndpointClientLoginBannerOption
- string
- Enabled bool
- string
- Enabled bool
- String
- enabled Boolean
- string
- enabled boolean
- str
- enabled bool
- String
- enabled Boolean
GetEndpointConnectionLogOption
- Cloudwatch
Log stringGroup - Cloudwatch
Log stringStream - Enabled bool
- Cloudwatch
Log stringGroup - Cloudwatch
Log stringStream - Enabled bool
- cloudwatch
Log StringGroup - cloudwatch
Log StringStream - enabled Boolean
- cloudwatch
Log stringGroup - cloudwatch
Log stringStream - enabled boolean
- cloudwatch_
log_ strgroup - cloudwatch_
log_ strstream - enabled bool
- cloudwatch
Log StringGroup - cloudwatch
Log StringStream - enabled Boolean
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.