Docs Packages
  1. Pulumi Registry
  2. Aviatrix
  3. API Docs
  4. AviatrixVpnUser
aviatrix logo
Aviatrix v0.0.10, Jan 21 23

aviatrix.AviatrixVpnUser

Explore with Pulumi AI

The aviatrix_vpn_user resource creates and manages Aviatrix VPN users.

NOTE: As of R2.15, management of user/profile attachment can be set using manage_user_attachment. This argument must be to true in either aviatrix_vpn_user or aviatrix_vpn_profile. If attachment is managed in the aviatrix_vpn_user (set to true), it must be set to false in the aviatrix_vpn_profile resource and vice versa.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix VPN User
    var testVpnUser = new Aviatrix.AviatrixVpnUser("testVpnUser", new()
    {
        GwName = "gw1",
        UserEmail = "user@aviatrix.com",
        UserName = "username1",
        VpcId = "vpc-abcd1234",
    });

});

package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixVpnUser(ctx, "testVpnUser", &aviatrix.AviatrixVpnUserArgs{
			GwName:    pulumi.String("gw1"),
			UserEmail: pulumi.String("user@aviatrix.com"),
			UserName:  pulumi.String("username1"),
			VpcId:     pulumi.String("vpc-abcd1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixVpnUser;
import com.pulumi.aviatrix.AviatrixVpnUserArgs;
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) {
        var testVpnUser = new AviatrixVpnUser("testVpnUser", AviatrixVpnUserArgs.builder()        
            .gwName("gw1")
            .userEmail("user@aviatrix.com")
            .userName("username1")
            .vpcId("vpc-abcd1234")
            .build());

    }
}

import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix VPN User
test_vpn_user = aviatrix.AviatrixVpnUser("testVpnUser",
    gw_name="gw1",
    user_email="user@aviatrix.com",
    user_name="username1",
    vpc_id="vpc-abcd1234")

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

// Create an Aviatrix VPN User
const testVpnUser = new aviatrix.AviatrixVpnUser("test_vpn_user", {
    gwName: "gw1",
    userEmail: "user@aviatrix.com",
    userName: "username1",
    vpcId: "vpc-abcd1234",
});

resources:
  # Create an Aviatrix VPN User
  testVpnUser:
    type: aviatrix:AviatrixVpnUser
    properties:
      gwName: gw1
      userEmail: user@aviatrix.com
      userName: username1
      vpcId: vpc-abcd1234

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix VPN User under Geo VPN
    var testVpnUser = new Aviatrix.AviatrixVpnUser("testVpnUser", new()
    {
        DnsName = "vpn.testuser.com",
        UserEmail = "user@aviatrix.com",
        UserName = "username1",
    });

});

package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixVpnUser(ctx, "testVpnUser", &aviatrix.AviatrixVpnUserArgs{
			DnsName:   pulumi.String("vpn.testuser.com"),
			UserEmail: pulumi.String("user@aviatrix.com"),
			UserName:  pulumi.String("username1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixVpnUser;
import com.pulumi.aviatrix.AviatrixVpnUserArgs;
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) {
        var testVpnUser = new AviatrixVpnUser("testVpnUser", AviatrixVpnUserArgs.builder()        
            .dnsName("vpn.testuser.com")
            .userEmail("user@aviatrix.com")
            .userName("username1")
            .build());

    }
}

import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix VPN User under Geo VPN
test_vpn_user = aviatrix.AviatrixVpnUser("testVpnUser",
    dns_name="vpn.testuser.com",
    user_email="user@aviatrix.com",
    user_name="username1")

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

// Create an Aviatrix VPN User under Geo VPN
const testVpnUser = new aviatrix.AviatrixVpnUser("test_vpn_user", {
    dnsName: "vpn.testuser.com",
    userEmail: "user@aviatrix.com",
    userName: "username1",
});

resources:
  # Create an Aviatrix VPN User under Geo VPN
  testVpnUser:
    type: aviatrix:AviatrixVpnUser
    properties:
      dnsName: vpn.testuser.com
      userEmail: user@aviatrix.com
      userName: username1

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix VPN User on GCP
    // See note below about vpc_id formatting for GCP
    var testVpnUser = new Aviatrix.AviatrixVpnUser("testVpnUser", new()
    {
        GwName = "gw1",
        UserEmail = "user@aviatrix.com",
        UserName = "username1",
        VpcId = $"{aviatrix_vpc.Test_vpc.Vpc_id}~-~{aviatrix_account.Test_account.Gcloud_project_id}",
    });

});

package main

import (
	"fmt"

	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixVpnUser(ctx, "testVpnUser", &aviatrix.AviatrixVpnUserArgs{
			GwName:    pulumi.String("gw1"),
			UserEmail: pulumi.String("user@aviatrix.com"),
			UserName:  pulumi.String("username1"),
			VpcId:     pulumi.String(fmt.Sprintf("%v~-~%v", aviatrix_vpc.Test_vpc.Vpc_id, aviatrix_account.Test_account.Gcloud_project_id)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixVpnUser;
import com.pulumi.aviatrix.AviatrixVpnUserArgs;
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) {
        var testVpnUser = new AviatrixVpnUser("testVpnUser", AviatrixVpnUserArgs.builder()        
            .gwName("gw1")
            .userEmail("user@aviatrix.com")
            .userName("username1")
            .vpcId(String.format("%s~-~%s", aviatrix_vpc.test_vpc().vpc_id(),aviatrix_account.test_account().gcloud_project_id()))
            .build());

    }
}

import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix VPN User on GCP
# See note below about vpc_id formatting for GCP
test_vpn_user = aviatrix.AviatrixVpnUser("testVpnUser",
    gw_name="gw1",
    user_email="user@aviatrix.com",
    user_name="username1",
    vpc_id=f"{aviatrix_vpc['test_vpc']['vpc_id']}~-~{aviatrix_account['test_account']['gcloud_project_id']}")

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

// Create an Aviatrix VPN User on GCP
// See note below about vpc_id formatting for GCP
const testVpnUser = new aviatrix.AviatrixVpnUser("test_vpn_user", {
    gwName: "gw1",
    userEmail: "user@aviatrix.com",
    userName: "username1",
    vpcId: pulumi.interpolate`${aviatrix_vpc_test_vpc.vpcId}~-~${aviatrix_account_test_account.gcloudProjectId}`,
});

resources:
  # Create an Aviatrix VPN User on GCP
  # // See note below about vpc_id formatting for GCP
  testVpnUser:
    type: aviatrix:AviatrixVpnUser
    properties:
      gwName: gw1
      userEmail: user@aviatrix.com
      userName: username1
      vpcId: ${aviatrix_vpc.test_vpc.vpc_id}~-~${aviatrix_account.test_account.gcloud_project_id}

Create AviatrixVpnUser Resource

new AviatrixVpnUser(name: string, args: AviatrixVpnUserArgs, opts?: CustomResourceOptions);
@overload
def AviatrixVpnUser(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dns_name: Optional[str] = None,
                    gw_name: Optional[str] = None,
                    manage_user_attachment: Optional[bool] = None,
                    profiles: Optional[Sequence[str]] = None,
                    saml_endpoint: Optional[str] = None,
                    user_email: Optional[str] = None,
                    user_name: Optional[str] = None,
                    vpc_id: Optional[str] = None)
@overload
def AviatrixVpnUser(resource_name: str,
                    args: AviatrixVpnUserArgs,
                    opts: Optional[ResourceOptions] = None)
func NewAviatrixVpnUser(ctx *Context, name string, args AviatrixVpnUserArgs, opts ...ResourceOption) (*AviatrixVpnUser, error)
public AviatrixVpnUser(string name, AviatrixVpnUserArgs args, CustomResourceOptions? opts = null)
public AviatrixVpnUser(String name, AviatrixVpnUserArgs args)
public AviatrixVpnUser(String name, AviatrixVpnUserArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixVpnUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AviatrixVpnUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AviatrixVpnUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AviatrixVpnUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AviatrixVpnUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AviatrixVpnUserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AviatrixVpnUser Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AviatrixVpnUser resource accepts the following input properties:

UserName string

VPN user name. Example: "user".

DnsName string

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

GwName string

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

ManageUserAttachment bool

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

Profiles List<string>

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

SamlEndpoint string

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

UserEmail string

VPN user's email. Example: "abc@xyz.com".

VpcId string

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

UserName string

VPN user name. Example: "user".

DnsName string

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

GwName string

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

ManageUserAttachment bool

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

Profiles []string

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

SamlEndpoint string

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

UserEmail string

VPN user's email. Example: "abc@xyz.com".

VpcId string

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

userName String

VPN user name. Example: "user".

dnsName String

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gwName String

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manageUserAttachment Boolean

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles List<String>

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

samlEndpoint String

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

userEmail String

VPN user's email. Example: "abc@xyz.com".

vpcId String

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

userName string

VPN user name. Example: "user".

dnsName string

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gwName string

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manageUserAttachment boolean

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles string[]

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

samlEndpoint string

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

userEmail string

VPN user's email. Example: "abc@xyz.com".

vpcId string

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

user_name str

VPN user name. Example: "user".

dns_name str

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gw_name str

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manage_user_attachment bool

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles Sequence[str]

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

saml_endpoint str

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

user_email str

VPN user's email. Example: "abc@xyz.com".

vpc_id str

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

userName String

VPN user name. Example: "user".

dnsName String

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gwName String

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manageUserAttachment Boolean

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles List<String>

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

samlEndpoint String

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

userEmail String

VPN user's email. Example: "abc@xyz.com".

vpcId String

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixVpnUser resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing AviatrixVpnUser Resource

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

public static get(name: string, id: Input<ID>, state?: AviatrixVpnUserState, opts?: CustomResourceOptions): AviatrixVpnUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_name: Optional[str] = None,
        gw_name: Optional[str] = None,
        manage_user_attachment: Optional[bool] = None,
        profiles: Optional[Sequence[str]] = None,
        saml_endpoint: Optional[str] = None,
        user_email: Optional[str] = None,
        user_name: Optional[str] = None,
        vpc_id: Optional[str] = None) -> AviatrixVpnUser
func GetAviatrixVpnUser(ctx *Context, name string, id IDInput, state *AviatrixVpnUserState, opts ...ResourceOption) (*AviatrixVpnUser, error)
public static AviatrixVpnUser Get(string name, Input<string> id, AviatrixVpnUserState? state, CustomResourceOptions? opts = null)
public static AviatrixVpnUser get(String name, Output<String> id, AviatrixVpnUserState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DnsName string

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

GwName string

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

ManageUserAttachment bool

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

Profiles List<string>

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

SamlEndpoint string

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

UserEmail string

VPN user's email. Example: "abc@xyz.com".

UserName string

VPN user name. Example: "user".

VpcId string

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

DnsName string

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

GwName string

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

ManageUserAttachment bool

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

Profiles []string

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

SamlEndpoint string

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

UserEmail string

VPN user's email. Example: "abc@xyz.com".

UserName string

VPN user name. Example: "user".

VpcId string

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

dnsName String

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gwName String

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manageUserAttachment Boolean

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles List<String>

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

samlEndpoint String

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

userEmail String

VPN user's email. Example: "abc@xyz.com".

userName String

VPN user name. Example: "user".

vpcId String

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

dnsName string

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gwName string

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manageUserAttachment boolean

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles string[]

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

samlEndpoint string

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

userEmail string

VPN user's email. Example: "abc@xyz.com".

userName string

VPN user name. Example: "user".

vpcId string

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

dns_name str

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gw_name str

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manage_user_attachment bool

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles Sequence[str]

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

saml_endpoint str

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

user_email str

VPN user's email. Example: "abc@xyz.com".

user_name str

VPN user name. Example: "user".

vpc_id str

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

dnsName String

FQDN of a DNS based VPN service such as GeoVPN or UDP load balancer. Example: "vpn.testuser.com".

gwName String

If ELB is enabled, this will be the name of the ELB, else it will be the name of the Aviatrix VPN gateway. Used together with vpc_id. Example: "gw1".

manageUserAttachment Boolean

This parameter is a switch to determine whether or not to manage VPN user attachments to the VPN profile using this resource. If this is set to false, attachment must be managed using the aviatrix_vpn_profile resource. Valid values: true, false. Default value: false.

profiles List<String>

List of VPN profiles for user to attach to. This should be set to null if manage_user_attachment is set to false.

samlEndpoint String

This is the name of the SAML endpoint to which the user is to be associated. This is required if adding user to a SAML gateway/LB.

userEmail String

VPN user's email. Example: "abc@xyz.com".

userName String

VPN user name. Example: "user".

vpcId String

VPC ID of Aviatrix VPN gateway. Used together with gw_name. Example: "vpc-abcd1234".

Import

vpn_user can be imported using the user_name, e.g.

 $ pulumi import aviatrix:index/aviatrixVpnUser:AviatrixVpnUser test user_name

Package Details

Repository
aviatrix astipkovits/pulumi-aviatrix
License
Apache-2.0
Notes

This Pulumi package is based on the aviatrix Terraform Provider.