Docs Packages
  1. Packages
  2. Random
  3. API Docs
  4. RandomPassword
random v4.14.0 published on Saturday, Sep 16, 2023 by Pulumi
pulumi/pulumi-random

random.RandomPassword

Explore with Pulumi AI

random logo
random v4.14.0 published on Saturday, Sep 16, 2023 by Pulumi
pulumi/pulumi-random

    Identical to random_string.

    This resource does use a cryptographic random number generator.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var password = new Random.RandomPassword("password", new()
    {
        Length = 16,
        Special = true,
        OverrideSpecial = "!#$%&*()-_=+[]{}<>:?",
    });

    var example = new Aws.Rds.Instance("example", new()
    {
        InstanceClass = "db.t3.micro",
        AllocatedStorage = 64,
        Engine = "mysql",
        Username = "someone",
        Password = password.Result,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		password, err := random.NewRandomPassword(ctx, "password", &random.RandomPasswordArgs{
			Length:          pulumi.Int(16),
			Special:         pulumi.Bool(true),
			OverrideSpecial: pulumi.String("!#$%&*()-_=+[]{}<>:?"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			InstanceClass:    pulumi.String("db.t3.micro"),
			AllocatedStorage: pulumi.Int(64),
			Engine:           pulumi.String("mysql"),
			Username:         pulumi.String("someone"),
			Password:         password.Result,
		})
		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.random.RandomPassword;
import com.pulumi.random.RandomPasswordArgs;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
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 password = new RandomPassword("password", RandomPasswordArgs.builder()        
            .length(16)
            .special(true)
            .overrideSpecial("!#$%&*()-_=+[]{}<>:?")
            .build());

        var example = new Instance("example", InstanceArgs.builder()        
            .instanceClass("db.t3.micro")
            .allocatedStorage(64)
            .engine("mysql")
            .username("someone")
            .password(password.result())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws
import pulumi_random as random

password = random.RandomPassword("password",
    length=16,
    special=True,
    override_special="!#$%&*()-_=+[]{}<>:?")
example = aws.rds.Instance("example",
    instance_class="db.t3.micro",
    allocated_storage=64,
    engine="mysql",
    username="someone",
    password=password.result)

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as random from "@pulumi/random";

const password = new random.RandomPassword("password", {
    length: 16,
    special: true,
    overrideSpecial: "!#$%&*()-_=+[]{}<>:?",
});
const example = new aws.rds.Instance("example", {
    instanceClass: "db.t3.micro",
    allocatedStorage: 64,
    engine: "mysql",
    username: "someone",
    password: password.result,
});

    resources:
  password:
    type: random:RandomPassword
    properties:
      length: 16
      special: true
      overrideSpecial: '!#$%&*()-_=+[]{}<>:?'
  example:
    type: aws:rds:Instance
    properties:
      instanceClass: db.t3.micro
      allocatedStorage: 64
      engine: mysql
      username: someone
      password: ${password.result}

    Create RandomPassword Resource

    new RandomPassword(name: string, args: RandomPasswordArgs, opts?: CustomResourceOptions);
    @overload
def RandomPassword(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   keepers: Optional[Mapping[str, str]] = None,
                   length: Optional[int] = None,
                   lower: Optional[bool] = None,
                   min_lower: Optional[int] = None,
                   min_numeric: Optional[int] = None,
                   min_special: Optional[int] = None,
                   min_upper: Optional[int] = None,
                   number: Optional[bool] = None,
                   numeric: Optional[bool] = None,
                   override_special: Optional[str] = None,
                   special: Optional[bool] = None,
                   upper: Optional[bool] = None)
@overload
def RandomPassword(resource_name: str,
                   args: RandomPasswordArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewRandomPassword(ctx *Context, name string, args RandomPasswordArgs, opts ...ResourceOption) (*RandomPassword, error)
    public RandomPassword(string name, RandomPasswordArgs args, CustomResourceOptions? opts = null)
    public RandomPassword(String name, RandomPasswordArgs args)
public RandomPassword(String name, RandomPasswordArgs args, CustomResourceOptions options)

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

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

    Length int

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    Keepers Dictionary<string, string>

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    Lower bool

    Include lowercase alphabet characters in the result. Default value is true.

    MinLower int

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    MinNumeric int

    Minimum number of numeric characters in the result. Default value is 0.

    MinSpecial int

    Minimum number of special characters in the result. Default value is 0.

    MinUpper int

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    Number bool

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    Numeric bool

    Include numeric characters in the result. Default value is true.

    OverrideSpecial string

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    Special bool

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    Upper bool

    Include uppercase alphabet characters in the result. Default value is true.

    Length int

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    Keepers map[string]string

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    Lower bool

    Include lowercase alphabet characters in the result. Default value is true.

    MinLower int

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    MinNumeric int

    Minimum number of numeric characters in the result. Default value is 0.

    MinSpecial int

    Minimum number of special characters in the result. Default value is 0.

    MinUpper int

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    Number bool

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    Numeric bool

    Include numeric characters in the result. Default value is true.

    OverrideSpecial string

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    Special bool

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    Upper bool

    Include uppercase alphabet characters in the result. Default value is true.

    length Integer

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    keepers Map<String,String>

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    lower Boolean

    Include lowercase alphabet characters in the result. Default value is true.

    minLower Integer

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    minNumeric Integer

    Minimum number of numeric characters in the result. Default value is 0.

    minSpecial Integer

    Minimum number of special characters in the result. Default value is 0.

    minUpper Integer

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number Boolean

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric Boolean

    Include numeric characters in the result. Default value is true.

    overrideSpecial String

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    special Boolean

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper Boolean

    Include uppercase alphabet characters in the result. Default value is true.

    length number

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    keepers {[key: string]: string}

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    lower boolean

    Include lowercase alphabet characters in the result. Default value is true.

    minLower number

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    minNumeric number

    Minimum number of numeric characters in the result. Default value is 0.

    minSpecial number

    Minimum number of special characters in the result. Default value is 0.

    minUpper number

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number boolean

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric boolean

    Include numeric characters in the result. Default value is true.

    overrideSpecial string

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    special boolean

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper boolean

    Include uppercase alphabet characters in the result. Default value is true.

    length int

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    keepers Mapping[str, str]

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    lower bool

    Include lowercase alphabet characters in the result. Default value is true.

    min_lower int

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    min_numeric int

    Minimum number of numeric characters in the result. Default value is 0.

    min_special int

    Minimum number of special characters in the result. Default value is 0.

    min_upper int

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number bool

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric bool

    Include numeric characters in the result. Default value is true.

    override_special str

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    special bool

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper bool

    Include uppercase alphabet characters in the result. Default value is true.

    length Number

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    keepers Map<String>

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    lower Boolean

    Include lowercase alphabet characters in the result. Default value is true.

    minLower Number

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    minNumeric Number

    Minimum number of numeric characters in the result. Default value is 0.

    minSpecial Number

    Minimum number of special characters in the result. Default value is 0.

    minUpper Number

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number Boolean

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric Boolean

    Include numeric characters in the result. Default value is true.

    overrideSpecial String

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    special Boolean

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper Boolean

    Include uppercase alphabet characters in the result. Default value is true.

    Outputs

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

    BcryptHash string

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    Id string

    The provider-assigned unique ID for this managed resource.

    Result string

    The generated random string.

    BcryptHash string

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    Id string

    The provider-assigned unique ID for this managed resource.

    Result string

    The generated random string.

    bcryptHash String

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    id String

    The provider-assigned unique ID for this managed resource.

    result String

    The generated random string.

    bcryptHash string

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    id string

    The provider-assigned unique ID for this managed resource.

    result string

    The generated random string.

    bcrypt_hash str

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    id str

    The provider-assigned unique ID for this managed resource.

    result str

    The generated random string.

    bcryptHash String

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    id String

    The provider-assigned unique ID for this managed resource.

    result String

    The generated random string.

    Look up Existing RandomPassword Resource

    Get an existing RandomPassword 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?: RandomPasswordState, opts?: CustomResourceOptions): RandomPassword
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bcrypt_hash: Optional[str] = None,
        keepers: Optional[Mapping[str, str]] = None,
        length: Optional[int] = None,
        lower: Optional[bool] = None,
        min_lower: Optional[int] = None,
        min_numeric: Optional[int] = None,
        min_special: Optional[int] = None,
        min_upper: Optional[int] = None,
        number: Optional[bool] = None,
        numeric: Optional[bool] = None,
        override_special: Optional[str] = None,
        result: Optional[str] = None,
        special: Optional[bool] = None,
        upper: Optional[bool] = None) -> RandomPassword
    func GetRandomPassword(ctx *Context, name string, id IDInput, state *RandomPasswordState, opts ...ResourceOption) (*RandomPassword, error)
    public static RandomPassword Get(string name, Input<string> id, RandomPasswordState? state, CustomResourceOptions? opts = null)
    public static RandomPassword get(String name, Output<String> id, RandomPasswordState 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:
    BcryptHash string

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    Keepers Dictionary<string, string>

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    Length int

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    Lower bool

    Include lowercase alphabet characters in the result. Default value is true.

    MinLower int

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    MinNumeric int

    Minimum number of numeric characters in the result. Default value is 0.

    MinSpecial int

    Minimum number of special characters in the result. Default value is 0.

    MinUpper int

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    Number bool

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    Numeric bool

    Include numeric characters in the result. Default value is true.

    OverrideSpecial string

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    Result string

    The generated random string.

    Special bool

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    Upper bool

    Include uppercase alphabet characters in the result. Default value is true.

    BcryptHash string

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    Keepers map[string]string

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    Length int

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    Lower bool

    Include lowercase alphabet characters in the result. Default value is true.

    MinLower int

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    MinNumeric int

    Minimum number of numeric characters in the result. Default value is 0.

    MinSpecial int

    Minimum number of special characters in the result. Default value is 0.

    MinUpper int

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    Number bool

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    Numeric bool

    Include numeric characters in the result. Default value is true.

    OverrideSpecial string

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    Result string

    The generated random string.

    Special bool

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    Upper bool

    Include uppercase alphabet characters in the result. Default value is true.

    bcryptHash String

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    keepers Map<String,String>

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    length Integer

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    lower Boolean

    Include lowercase alphabet characters in the result. Default value is true.

    minLower Integer

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    minNumeric Integer

    Minimum number of numeric characters in the result. Default value is 0.

    minSpecial Integer

    Minimum number of special characters in the result. Default value is 0.

    minUpper Integer

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number Boolean

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric Boolean

    Include numeric characters in the result. Default value is true.

    overrideSpecial String

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    result String

    The generated random string.

    special Boolean

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper Boolean

    Include uppercase alphabet characters in the result. Default value is true.

    bcryptHash string

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    keepers {[key: string]: string}

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    length number

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    lower boolean

    Include lowercase alphabet characters in the result. Default value is true.

    minLower number

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    minNumeric number

    Minimum number of numeric characters in the result. Default value is 0.

    minSpecial number

    Minimum number of special characters in the result. Default value is 0.

    minUpper number

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number boolean

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric boolean

    Include numeric characters in the result. Default value is true.

    overrideSpecial string

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    result string

    The generated random string.

    special boolean

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper boolean

    Include uppercase alphabet characters in the result. Default value is true.

    bcrypt_hash str

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    keepers Mapping[str, str]

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    length int

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    lower bool

    Include lowercase alphabet characters in the result. Default value is true.

    min_lower int

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    min_numeric int

    Minimum number of numeric characters in the result. Default value is 0.

    min_special int

    Minimum number of special characters in the result. Default value is 0.

    min_upper int

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number bool

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric bool

    Include numeric characters in the result. Default value is true.

    override_special str

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    result str

    The generated random string.

    special bool

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper bool

    Include uppercase alphabet characters in the result. Default value is true.

    bcryptHash String

    A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcrypt_hash will contain a hash of the first 72 bytes.

    keepers Map<String>

    Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

    length Number

    The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

    lower Boolean

    Include lowercase alphabet characters in the result. Default value is true.

    minLower Number

    Minimum number of lowercase alphabet characters in the result. Default value is 0.

    minNumeric Number

    Minimum number of numeric characters in the result. Default value is 0.

    minSpecial Number

    Minimum number of special characters in the result. Default value is 0.

    minUpper Number

    Minimum number of uppercase alphabet characters in the result. Default value is 0.

    number Boolean

    Include numeric characters in the result. Default value is true. NOTE: This is deprecated, use numeric instead.

    Deprecated:

    NOTE: This is deprecated, use numeric instead.

    numeric Boolean

    Include numeric characters in the result. Default value is true.

    overrideSpecial String

    Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.

    result String

    The generated random string.

    special Boolean

    Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.

    upper Boolean

    Include uppercase alphabet characters in the result. Default value is true.

    Import

    You can import external passwords into your Pulumi programs as follows:

     $ import random:index/randomPassword:RandomPassword newPassword supersecret

    This command will encode the supersecret token in Pulumi state and generate a code suggestion to include a new RandomPassword resource in your Pulumi program. Include the suggested code and do a pulumi up. Your secret password is now securely stored in Pulumi, and you can reference it in your Pulumi program as newPassword.result.

    Package Details

    Repository
    random pulumi/pulumi-random
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the random Terraform Provider.

    random logo
    random v4.14.0 published on Saturday, Sep 16, 2023 by Pulumi
    pulumi/pulumi-random