Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Freebox
  4. API Docs
  5. vpn
  6. User
Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien
Schema (JSON)
OlivierPaquien/pulumi-freebox

freebox.vpn.User

freebox logo
Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien
Schema (JSON)
OlivierPaquien/pulumi-freebox

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         login: Optional[str] = None,
         password: Optional[str] = None,
         description: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: freebox:vpn:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "freebox_vpn_user" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Freebox.Vpn.User("userResource", new()
{
    Login = "string",
    Password = "string",
    Description = "string",
});

    example, err := vpn.NewUser(ctx, "userResource", &vpn.UserArgs{
	Login:       pulumi.String("string"),
	Password:    pulumi.String("string"),
	Description: pulumi.String("string"),
})

    resource "freebox_vpn_user" "userResource" {
  login       = "string"
  password    = "string"
  description = "string"
}

    var userResource = new User("userResource", UserArgs.builder()
    .login("string")
    .password("string")
    .description("string")
    .build());

    user_resource = freebox.vpn.User("userResource",
    login="string",
    password="string",
    description="string")

    const userResource = new freebox.vpn.User("userResource", {
    login: "string",
    password: "string",
    description: "string",
});

    type: freebox:vpn:User
properties:
    description: string
    login: string
    password: string

    User Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Login string
    Password string
    Description string
    Login string
    Password string
    Description string
    login string
    password string
    description string
    login String
    password String
    description String
    login string
    password string
    description string
    login String
    password String
    description String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OvpnConfig string
    Id string
    The provider-assigned unique ID for this managed resource.
    OvpnConfig string
    id string
    The provider-assigned unique ID for this managed resource.
    ovpn_config string
    id String
    The provider-assigned unique ID for this managed resource.
    ovpnConfig String
    id string
    The provider-assigned unique ID for this managed resource.
    ovpnConfig string
    id str
    The provider-assigned unique ID for this managed resource.
    ovpn_config str
    id String
    The provider-assigned unique ID for this managed resource.
    ovpnConfig String

    Package Details

    Repository
    freebox
    License
    freebox logo
    Viewing docs for Freebox v0.3.11
    published on Friday, Jul 3, 2026 by OlivierPaquien
    Schema (JSON)
    OlivierPaquien/pulumi-freebox

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial