Class Endpoint

Provides an AWS Client VPN endpoint for OpenVPN clients. For more information on usage, please see the AWS Client VPN Administrator's Guide.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Ec2ClientVpn.Endpoint("example", new Aws.Ec2ClientVpn.EndpointArgs
    {
        AuthenticationOptions = 
        {
            new Aws.Ec2ClientVpn.Inputs.EndpointAuthenticationOptionArgs
            {
                RootCertificateChainArn = aws_acm_certificate.Root_cert.Arn,
                Type = "certificate-authentication",
            },
        },
        ClientCidrBlock = "10.0.0.0/16",
        ConnectionLogOptions = new Aws.Ec2ClientVpn.Inputs.EndpointConnectionLogOptionsArgs
        {
            CloudwatchLogGroup = aws_cloudwatch_log_group.Lg.Name,
            CloudwatchLogStream = aws_cloudwatch_log_stream.Ls.Name,
            Enabled = true,
        },
        Description = "clientvpn-example",
        ServerCertificateArn = aws_acm_certificate.Cert.Arn,
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Endpoint
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Ec2ClientVpn
Assembly: Pulumi.Aws.dll
Syntax
public class Endpoint : CustomResource

Constructors

View Source

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration
public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
EndpointArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AuthenticationOptions

Information about the authentication method to be used to authenticate clients.

Declaration
public Output<ImmutableArray<EndpointAuthenticationOption>> AuthenticationOptions { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<EndpointAuthenticationOption>>
View Source

ClientCidrBlock

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

Declaration
public Output<string> ClientCidrBlock { get; }
Property Value
Type Description
Output<System.String>
View Source

ConnectionLogOptions

Information about the client connection logging options.

Declaration
public Output<EndpointConnectionLogOptions> ConnectionLogOptions { get; }
Property Value
Type Description
Output<EndpointConnectionLogOptions>
View Source

Description

Name of the repository.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

DnsName

The DNS name to be used by clients when establishing their VPN session.

Declaration
public Output<string> DnsName { get; }
Property Value
Type Description
Output<System.String>
View Source

DnsServers

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

Declaration
public Output<ImmutableArray<string>> DnsServers { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

ServerCertificateArn

The ARN of the ACM server certificate.

Declaration
public Output<string> ServerCertificateArn { get; }
Property Value
Type Description
Output<System.String>
View Source

SplitTunnel

Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false.

Declaration
public Output<bool?> SplitTunnel { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Status

The current state of the Client VPN endpoint.

Declaration
public Output<string> Status { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

A map of tags to assign to the resource.

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

TransportProtocol

The transport protocol to be used by the VPN session. Default value is udp.

Declaration
public Output<string> TransportProtocol { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, EndpointState, CustomResourceOptions)

Get an existing Endpoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
EndpointState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Endpoint