Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. LocalUser
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.LocalUser

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a config item.

    Example Usage

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

const example = new scm.LocalUser("example", {
    folder: "Shared",
    name: "user1",
    password: "secret",
});

    import pulumi
import pulumi_scm as scm

example = scm.LocalUser("example",
    folder="Shared",
    name="user1",
    password="secret")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.NewLocalUser(ctx, "example", &scm.LocalUserArgs{
			Folder:   pulumi.String("Shared"),
			Name:     pulumi.String("user1"),
			Password: pulumi.String("secret"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = new Scm.LocalUser("example", new()
    {
        Folder = "Shared",
        Name = "user1",
        Password = "secret",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.LocalUser;
import com.pulumi.scm.LocalUserArgs;
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 example = new LocalUser("example", LocalUserArgs.builder()
            .folder("Shared")
            .name("user1")
            .password("secret")
            .build());

    }
}

    resources:
  example:
    type: scm:LocalUser
    properties:
      folder: Shared
      name: user1
      password: secret

    Create LocalUser Resource

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

    Constructor syntax

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

@overload
def LocalUser(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              device: Optional[str] = None,
              disabled: Optional[bool] = None,
              folder: Optional[str] = None,
              name: Optional[str] = None,
              password: Optional[str] = None,
              snippet: Optional[str] = None)
    func NewLocalUser(ctx *Context, name string, args *LocalUserArgs, opts ...ResourceOption) (*LocalUser, error)
    public LocalUser(string name, LocalUserArgs? args = null, CustomResourceOptions? opts = null)
    public LocalUser(String name, LocalUserArgs args)
public LocalUser(String name, LocalUserArgs args, CustomResourceOptions options)

    type: scm:LocalUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LocalUserArgs
    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 LocalUserArgs
    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 LocalUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocalUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocalUserArgs
    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 localUserResource = new Scm.LocalUser("localUserResource", new()
{
    Device = "string",
    Disabled = false,
    Folder = "string",
    Name = "string",
    Password = "string",
    Snippet = "string",
});

    example, err := scm.NewLocalUser(ctx, "localUserResource", &scm.LocalUserArgs{
	Device:   pulumi.String("string"),
	Disabled: pulumi.Bool(false),
	Folder:   pulumi.String("string"),
	Name:     pulumi.String("string"),
	Password: pulumi.String("string"),
	Snippet:  pulumi.String("string"),
})

    var localUserResource = new LocalUser("localUserResource", LocalUserArgs.builder()
    .device("string")
    .disabled(false)
    .folder("string")
    .name("string")
    .password("string")
    .snippet("string")
    .build());

    local_user_resource = scm.LocalUser("localUserResource",
    device="string",
    disabled=False,
    folder="string",
    name="string",
    password="string",
    snippet="string")

    const localUserResource = new scm.LocalUser("localUserResource", {
    device: "string",
    disabled: false,
    folder: "string",
    name: "string",
    password: "string",
    snippet: "string",
});

    type: scm:LocalUser
properties:
    device: string
    disabled: false
    folder: string
    name: string
    password: string
    snippet: string

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

    Device string
    The Device param.
    Disabled bool
    The Disabled param.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 31 characters.
    Password string
    The Password param. String length must not exceed 63 characters.
    Snippet string
    The Snippet param.
    Device string
    The Device param.
    Disabled bool
    The Disabled param.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 31 characters.
    Password string
    The Password param. String length must not exceed 63 characters.
    Snippet string
    The Snippet param.
    device String
    The Device param.
    disabled Boolean
    The Disabled param.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 31 characters.
    password String
    The Password param. String length must not exceed 63 characters.
    snippet String
    The Snippet param.
    device string
    The Device param.
    disabled boolean
    The Disabled param.
    folder string
    The Folder param.
    name string
    The Name param. String length must not exceed 31 characters.
    password string
    The Password param. String length must not exceed 63 characters.
    snippet string
    The Snippet param.
    device str
    The Device param.
    disabled bool
    The Disabled param.
    folder str
    The Folder param.
    name str
    The Name param. String length must not exceed 31 characters.
    password str
    The Password param. String length must not exceed 63 characters.
    snippet str
    The Snippet param.
    device String
    The Device param.
    disabled Boolean
    The Disabled param.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 31 characters.
    password String
    The Password param. String length must not exceed 63 characters.
    snippet String
    The Snippet param.

    Outputs

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

    EncryptedValues Dictionary<string, string>
    (Internal use) Encrypted values returned from the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    EncryptedValues map[string]string
    (Internal use) Encrypted values returned from the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    encryptedValues Map<String,String>
    (Internal use) Encrypted values returned from the API.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    encryptedValues {[key: string]: string}
    (Internal use) Encrypted values returned from the API.
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    encrypted_values Mapping[str, str]
    (Internal use) Encrypted values returned from the API.
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    encryptedValues Map<String>
    (Internal use) Encrypted values returned from the API.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String

    Look up Existing LocalUser Resource

    Get an existing LocalUser 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?: LocalUserState, opts?: CustomResourceOptions): LocalUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        disabled: Optional[bool] = None,
        encrypted_values: Optional[Mapping[str, str]] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None) -> LocalUser
    func GetLocalUser(ctx *Context, name string, id IDInput, state *LocalUserState, opts ...ResourceOption) (*LocalUser, error)
    public static LocalUser Get(string name, Input<string> id, LocalUserState? state, CustomResourceOptions? opts = null)
    public static LocalUser get(String name, Output<String> id, LocalUserState 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:
    Device string
    The Device param.
    Disabled bool
    The Disabled param.
    EncryptedValues Dictionary<string, string>
    (Internal use) Encrypted values returned from the API.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 31 characters.
    Password string
    The Password param. String length must not exceed 63 characters.
    Snippet string
    The Snippet param.
    Tfid string
    Device string
    The Device param.
    Disabled bool
    The Disabled param.
    EncryptedValues map[string]string
    (Internal use) Encrypted values returned from the API.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 31 characters.
    Password string
    The Password param. String length must not exceed 63 characters.
    Snippet string
    The Snippet param.
    Tfid string
    device String
    The Device param.
    disabled Boolean
    The Disabled param.
    encryptedValues Map<String,String>
    (Internal use) Encrypted values returned from the API.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 31 characters.
    password String
    The Password param. String length must not exceed 63 characters.
    snippet String
    The Snippet param.
    tfid String
    device string
    The Device param.
    disabled boolean
    The Disabled param.
    encryptedValues {[key: string]: string}
    (Internal use) Encrypted values returned from the API.
    folder string
    The Folder param.
    name string
    The Name param. String length must not exceed 31 characters.
    password string
    The Password param. String length must not exceed 63 characters.
    snippet string
    The Snippet param.
    tfid string
    device str
    The Device param.
    disabled bool
    The Disabled param.
    encrypted_values Mapping[str, str]
    (Internal use) Encrypted values returned from the API.
    folder str
    The Folder param.
    name str
    The Name param. String length must not exceed 31 characters.
    password str
    The Password param. String length must not exceed 63 characters.
    snippet str
    The Snippet param.
    tfid str
    device String
    The Device param.
    disabled Boolean
    The Disabled param.
    encryptedValues Map<String>
    (Internal use) Encrypted values returned from the API.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 31 characters.
    password String
    The Password param. String length must not exceed 63 characters.
    snippet String
    The Snippet param.
    tfid String

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm