1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixAccountUser
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixAccountUser

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    The aviatrix_account_user resource allows the creation and management of Aviatrix user accounts.

    NOTE: With the release of Controller 5.4 (compatible with Aviatrix provider R2.13), Role-Based Access Control (RBAC) is now integrated into the Accounts workflow. Any aviatrix_account_user created in 5.3 by default will have admin privileges (attached to the ‘admin’ RBAC permission group). In 5.4, any new account users created will no longer have the option to specify an account_name, but rather have the option to attach the user to specific RBAC groups through the aviatrix_rbac_group_user_attachment resource for more granular security control. Account users created in 5.4 will have minimal access (read_only) unless otherwise specified in the RBAC group permissions that the users are attached to.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix User Account
        var testAccountuser = new Aviatrix.AviatrixAccountUser("testAccountuser", new()
        {
            Email = "username1@testdomain.com",
            Password = "passwordforuser1-1234",
            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.NewAviatrixAccountUser(ctx, "testAccountuser", &aviatrix.AviatrixAccountUserArgs{
    			Email:    pulumi.String("username1@testdomain.com"),
    			Password: pulumi.String("passwordforuser1-1234"),
    			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.AviatrixAccountUser;
    import com.pulumi.aviatrix.AviatrixAccountUserArgs;
    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 testAccountuser = new AviatrixAccountUser("testAccountuser", AviatrixAccountUserArgs.builder()        
                .email("username1@testdomain.com")
                .password("passwordforuser1-1234")
                .username("username1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix User Account
    test_accountuser = aviatrix.AviatrixAccountUser("testAccountuser",
        email="username1@testdomain.com",
        password="passwordforuser1-1234",
        username="username1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix User Account
    const testAccountuser = new aviatrix.AviatrixAccountUser("test_accountuser", {
        email: "username1@testdomain.com",
        password: "passwordforuser1-1234",
        username: "username1",
    });
    
    resources:
      # Create an Aviatrix User Account
      testAccountuser:
        type: aviatrix:AviatrixAccountUser
        properties:
          email: username1@testdomain.com
          password: passwordforuser1-1234
          username: username1
    

    Create AviatrixAccountUser Resource

    new AviatrixAccountUser(name: string, args: AviatrixAccountUserArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixAccountUser(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            email: Optional[str] = None,
                            password: Optional[str] = None,
                            username: Optional[str] = None)
    @overload
    def AviatrixAccountUser(resource_name: str,
                            args: AviatrixAccountUserArgs,
                            opts: Optional[ResourceOptions] = None)
    func NewAviatrixAccountUser(ctx *Context, name string, args AviatrixAccountUserArgs, opts ...ResourceOption) (*AviatrixAccountUser, error)
    public AviatrixAccountUser(string name, AviatrixAccountUserArgs args, CustomResourceOptions? opts = null)
    public AviatrixAccountUser(String name, AviatrixAccountUserArgs args)
    public AviatrixAccountUser(String name, AviatrixAccountUserArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixAccountUser
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AviatrixAccountUserArgs
    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 AviatrixAccountUserArgs
    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 AviatrixAccountUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAccountUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixAccountUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AviatrixAccountUser 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 AviatrixAccountUser resource accepts the following input properties:

    Email string
    Email of address of account user to be created.
    Password string
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    Username string
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    Email string
    Email of address of account user to be created.
    Password string
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    Username string
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email String
    Email of address of account user to be created.
    password String
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username String
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email string
    Email of address of account user to be created.
    password string
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username string
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email str
    Email of address of account user to be created.
    password str
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username str
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email String
    Email of address of account user to be created.
    password String
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username String
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AviatrixAccountUser 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 AviatrixAccountUser Resource

    Get an existing AviatrixAccountUser 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?: AviatrixAccountUserState, opts?: CustomResourceOptions): AviatrixAccountUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            password: Optional[str] = None,
            username: Optional[str] = None) -> AviatrixAccountUser
    func GetAviatrixAccountUser(ctx *Context, name string, id IDInput, state *AviatrixAccountUserState, opts ...ResourceOption) (*AviatrixAccountUser, error)
    public static AviatrixAccountUser Get(string name, Input<string> id, AviatrixAccountUserState? state, CustomResourceOptions? opts = null)
    public static AviatrixAccountUser get(String name, Output<String> id, AviatrixAccountUserState 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:
    Email string
    Email of address of account user to be created.
    Password string
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    Username string
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    Email string
    Email of address of account user to be created.
    Password string
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    Username string
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email String
    Email of address of account user to be created.
    password String
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username String
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email string
    Email of address of account user to be created.
    password string
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username string
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email str
    Email of address of account user to be created.
    password str
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username str
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.
    email String
    Email of address of account user to be created.
    password String
    Login password for the account user to be created. If password is changed, current account will be destroyed and a new account will be created.
    username String
    Name of account user to be created. It can only include alphanumeric characters(lower case only), hyphens, dots or underscores. 1 to 80 in length. No spaces are allowed.

    Import

    account_user can be imported using the username (when doing import, need to leave password argument blank), e.g.

     $ pulumi import aviatrix:index/aviatrixAccountUser:AviatrixAccountUser test username
    

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix