Package @pulumi/random

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-random repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-random repo.

var random = require("@pulumi/random");
import * as random from "@pulumi/random";

Resources

Others

Resources

Resource Provider

class Provider extends ProviderResource

The provider type for the random package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/index.html.markdown.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomId

class RandomId extends CustomResource

The resource random..RandomId generates random numbers that are intended to be used as unique identifiers for other resources.

This resource does use a cryptographic random number generator in order to minimize the chance of collisions, making the results of this resource when a 16-byte identifier is requested of equivalent uniqueness to a type-4 UUID.

This resource can be used in conjunction with resources that have the createBeforeDestroy lifecycle flag set to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

Example Usage

The following example shows how to generate a unique name for an AWS EC2 instance that changes each time a new AMI id is selected.

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

const serverRandomId = new random.RandomId("server", {
    byteLength: 8,
    keepers: {
        // Generate a new id each time we switch to a new AMI id
        ami_id: var_ami_id,
    },
});
const serverInstance = new aws.ec2.Instance("server", {
    ami: serverRandomId.keepers.apply(keepers => keepers.amiId),
    tags: {
        Name: pulumi.interpolate`web-server ${serverRandomId.hex}`,
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/id.html.markdown.

constructor

new RandomId(name: string, args: RandomIdArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomId resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomIdState, opts?: pulumi.CustomResourceOptions): RandomId

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomId. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property b64

public b64: pulumi.Output<string>;

property b64Std

public b64Std: pulumi.Output<string>;

The generated id presented in base64 without additional transformations.

property b64Url

public b64Url: pulumi.Output<string>;

The generated id presented in base64, using the URL-friendly character set: case-sensitive letters, digits and the characters _ and -.

property byteLength

public byteLength: pulumi.Output<number>;

The number of random bytes to produce. The minimum value is 1, which produces eight bits of randomness.

property dec

public dec: pulumi.Output<string>;

The generated id presented in non-padded decimal digits.

property hex

public hex: pulumi.Output<string>;

The generated id presented in padded hexadecimal digits. This result will always be twice as long as the requested byte length.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property prefix

public prefix: pulumi.Output<string | undefined>;

Arbitrary string to prefix the output value with. This string is supplied as-is, meaning it is not guaranteed to be URL-safe or base64 encoded.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomInteger

class RandomInteger extends CustomResource

The resource random..RandomInteger generates random values from a given range, described by the min and max attributes of a given resource.

This resource can be used in conjunction with resources that have the createBeforeDestroy lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

Example Usage

The following example shows how to generate a random priority between 1 and 50000 for a awsAlbListenerRule resource:

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

const priority = new random.RandomInteger("priority", {
    keepers: {
        // Generate a new integer each time we switch to a new listener ARN
        listener_arn: var_listener_arn,
    },
    max: 50000,
    min: 1,
});
const main = new aws.alb.ListenerRule("main", {
    actions: [{
        targetGroupArn: var_target_group_arn,
        type: "forward",
    }],
    listenerArn: var_listener_arn,
    priority: priority.result,
});

The result of the above will set a random priority.

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/integer.html.markdown.

constructor

new RandomInteger(name: string, args: RandomIntegerArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomInteger resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomIntegerState, opts?: pulumi.CustomResourceOptions): RandomInteger

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomInteger. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property max

public max: pulumi.Output<number>;

The maximum inclusive value of the range.

property min

public min: pulumi.Output<number>;

The minimum inclusive value of the range.

property result

public result: pulumi.Output<number>;

(int) The random Integer result.

property seed

public seed: pulumi.Output<string | undefined>;

A custom seed to always produce the same value.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomPassword

class RandomPassword extends CustomResource

Note: Requires random provider version >= 2.2.0

Identical to random..RandomString with the exception that the result is treated as sensitive and, thus, not displayed in console output.

Note: All attributes including the generated password will be stored in the raw state as plain-text. Read more about sensitive data in state.

This resource does use a cryptographic random number generator.

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/password.html.markdown.

constructor

new RandomPassword(name: string, args: RandomPasswordArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomPassword resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomPasswordState, opts?: pulumi.CustomResourceOptions): RandomPassword

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomPassword. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

property length

public length: pulumi.Output<number>;

property lower

public lower: pulumi.Output<boolean | undefined>;

property minLower

public minLower: pulumi.Output<number | undefined>;

property minNumeric

public minNumeric: pulumi.Output<number | undefined>;

property minSpecial

public minSpecial: pulumi.Output<number | undefined>;

property minUpper

public minUpper: pulumi.Output<number | undefined>;

property number

public number: pulumi.Output<boolean | undefined>;

property overrideSpecial

public overrideSpecial: pulumi.Output<string | undefined>;

property result

public result: pulumi.Output<string>;

property special

public special: pulumi.Output<boolean | undefined>;

property upper

public upper: pulumi.Output<boolean | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomPet

class RandomPet extends CustomResource

The resource random..RandomPet generates random pet names that are intended to be used as unique identifiers for other resources.

This resource can be used in conjunction with resources that have the createBeforeDestroy lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

Example Usage

The following example shows how to generate a unique pet name for an AWS EC2 instance that changes each time a new AMI id is selected.

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

const serverRandomPet = new random.RandomPet("server", {
    keepers: {
        // Generate a new pet name each time we switch to a new AMI id
        ami_id: var_ami_id,
    },
});
const serverInstance = new aws.ec2.Instance("server", {
    ami: serverRandomPet.keepers.apply(keepers => keepers.amiId),
    tags: {
        Name: pulumi.interpolate`web-server-${serverRandomPet.id}`,
    },
});

The result of the above will set the Name of the AWS Instance to web-server-simple-snake.

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/pet.html.markdown.

constructor

new RandomPet(name: string, args?: RandomPetArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomPet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomPetState, opts?: pulumi.CustomResourceOptions): RandomPet

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomPet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property length

public length: pulumi.Output<number | undefined>;

The length (in words) of the pet name.

property prefix

public prefix: pulumi.Output<string | undefined>;

A string to prefix the name with.

property separator

public separator: pulumi.Output<string | undefined>;

The character to separate words in the pet name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomShuffle

class RandomShuffle extends CustomResource

The resource random..RandomShuffle generates a random permutation of a list of strings given as an argument.

Example Usage

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

const az = new random.RandomShuffle("az", {
    inputs: [
        "us-west-1a",
        "us-west-1c",
        "us-west-1d",
        "us-west-1e",
    ],
    resultCount: 2,
});
const example = new aws.elb.LoadBalancer("example", {
    // Place the ELB in any two of the given availability zones, selected
    // at random.
    availabilityZones: az.results,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/shuffle.html.markdown.

constructor

new RandomShuffle(name: string, args: RandomShuffleArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomShuffle resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomShuffleState, opts?: pulumi.CustomResourceOptions): RandomShuffle

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomShuffle. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inputs

public inputs: pulumi.Output<string[]>;

The list of strings to shuffle.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property resultCount

public resultCount: pulumi.Output<number | undefined>;

The number of results to return. Defaults to the number of items in the input list. If fewer items are requested, some elements will be excluded from the result. If more items are requested, items will be repeated in the result but not more frequently than the number of items in the input list.

property results

public results: pulumi.Output<string[]>;

Random permutation of the list of strings given in input.

property seed

public seed: pulumi.Output<string | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomString

class RandomString extends CustomResource

The resource random..RandomString generates a random permutation of alphanumeric characters and optionally special characters.

This resource does use a cryptographic random number generator.

Historically this resource’s intended usage has been ambiguous as the original example used it in a password. For backwards compatibility it will continue to exist. For unique ids please use random_id, for sensitive random values please use random_password.

Example Usage

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

const randomRandomString = new random.RandomString("random", {
    length: 16,
    overrideSpecial: "/@£$",
    special: true,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/string.html.markdown.

constructor

new RandomString(name: string, args: RandomStringArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomString resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomStringState, opts?: pulumi.CustomResourceOptions): RandomString

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomString. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property length

public length: pulumi.Output<number>;

The length of the string desired

property lower

public lower: pulumi.Output<boolean | undefined>;

(default true) Include lowercase alphabet characters in random string.

property minLower

public minLower: pulumi.Output<number | undefined>;

(default 0) Minimum number of lowercase alphabet characters in random string.

property minNumeric

public minNumeric: pulumi.Output<number | undefined>;

(default 0) Minimum number of numeric characters in random string.

property minSpecial

public minSpecial: pulumi.Output<number | undefined>;

(default 0) Minimum number of special characters in random string.

property minUpper

public minUpper: pulumi.Output<number | undefined>;

(default 0) Minimum number of uppercase alphabet characters in random string.

property number

public number: pulumi.Output<boolean | undefined>;

(default true) Include numeric characters in random string.

property overrideSpecial

public overrideSpecial: pulumi.Output<string | undefined>;

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.

property result

public result: pulumi.Output<string>;

Random string generated.

property special

public special: pulumi.Output<boolean | undefined>;

(default true) Include special characters in random string. These are !@#$%&*()-_=+[]{}<>:?

property upper

public upper: pulumi.Output<boolean | undefined>;

(default true) Include uppercase alphabet characters in random string.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RandomUuid

class RandomUuid extends CustomResource

The resource random..RandomUuid generates random uuid string that is intended to be used as unique identifiers for other resources.

This resource uses the hashicorp/go-uuid to generate a UUID-formatted string for use with services needed a unique string identifier.

Example Usage

The following example shows how to generate a unique name for an Azure Resource Group.

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

const testRandomUuid = new random.RandomUuid("test", {});
const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "Central US",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-random/blob/master/website/docs/r/uuid.html.markdown.

constructor

new RandomUuid(name: string, args?: RandomUuidArgs, opts?: pulumi.CustomResourceOptions)

Create a RandomUuid resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RandomUuidState, opts?: pulumi.CustomResourceOptions): RandomUuid

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RandomUuid. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepers

public keepers: pulumi.Output<{[key: string]: any} | undefined>;

Arbitrary map of values that, when changed, will trigger a new uuid to be generated. See the main provider documentation for more information.

property result

public result: pulumi.Output<string>;

The generated uuid presented in string format.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

interface RandomIdArgs

interface RandomIdArgs

The set of arguments for constructing a RandomId resource.

property byteLength

byteLength: pulumi.Input<number>;

The number of random bytes to produce. The minimum value is 1, which produces eight bits of randomness.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property prefix

prefix?: pulumi.Input<string>;

Arbitrary string to prefix the output value with. This string is supplied as-is, meaning it is not guaranteed to be URL-safe or base64 encoded.

interface RandomIdState

interface RandomIdState

Input properties used for looking up and filtering RandomId resources.

property b64

b64?: pulumi.Input<string>;

property b64Std

b64Std?: pulumi.Input<string>;

The generated id presented in base64 without additional transformations.

property b64Url

b64Url?: pulumi.Input<string>;

The generated id presented in base64, using the URL-friendly character set: case-sensitive letters, digits and the characters _ and -.

property byteLength

byteLength?: pulumi.Input<number>;

The number of random bytes to produce. The minimum value is 1, which produces eight bits of randomness.

property dec

dec?: pulumi.Input<string>;

The generated id presented in non-padded decimal digits.

property hex

hex?: pulumi.Input<string>;

The generated id presented in padded hexadecimal digits. This result will always be twice as long as the requested byte length.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property prefix

prefix?: pulumi.Input<string>;

Arbitrary string to prefix the output value with. This string is supplied as-is, meaning it is not guaranteed to be URL-safe or base64 encoded.

interface RandomIntegerArgs

interface RandomIntegerArgs

The set of arguments for constructing a RandomInteger resource.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property max

max: pulumi.Input<number>;

The maximum inclusive value of the range.

property min

min: pulumi.Input<number>;

The minimum inclusive value of the range.

property seed

seed?: pulumi.Input<string>;

A custom seed to always produce the same value.

interface RandomIntegerState

interface RandomIntegerState

Input properties used for looking up and filtering RandomInteger resources.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property max

max?: pulumi.Input<number>;

The maximum inclusive value of the range.

property min

min?: pulumi.Input<number>;

The minimum inclusive value of the range.

property result

result?: pulumi.Input<number>;

(int) The random Integer result.

property seed

seed?: pulumi.Input<string>;

A custom seed to always produce the same value.

interface RandomPasswordArgs

interface RandomPasswordArgs

The set of arguments for constructing a RandomPassword resource.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

property length

length: pulumi.Input<number>;

property lower

lower?: pulumi.Input<boolean>;

property minLower

minLower?: pulumi.Input<number>;

property minNumeric

minNumeric?: pulumi.Input<number>;

property minSpecial

minSpecial?: pulumi.Input<number>;

property minUpper

minUpper?: pulumi.Input<number>;

property number

number?: pulumi.Input<boolean>;

property overrideSpecial

overrideSpecial?: pulumi.Input<string>;

property special

special?: pulumi.Input<boolean>;

property upper

upper?: pulumi.Input<boolean>;

interface RandomPasswordState

interface RandomPasswordState

Input properties used for looking up and filtering RandomPassword resources.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

property length

length?: pulumi.Input<number>;

property lower

lower?: pulumi.Input<boolean>;

property minLower

minLower?: pulumi.Input<number>;

property minNumeric

minNumeric?: pulumi.Input<number>;

property minSpecial

minSpecial?: pulumi.Input<number>;

property minUpper

minUpper?: pulumi.Input<number>;

property number

number?: pulumi.Input<boolean>;

property overrideSpecial

overrideSpecial?: pulumi.Input<string>;

property result

result?: pulumi.Input<string>;

property special

special?: pulumi.Input<boolean>;

property upper

upper?: pulumi.Input<boolean>;

interface RandomPetArgs

interface RandomPetArgs

The set of arguments for constructing a RandomPet resource.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property length

length?: pulumi.Input<number>;

The length (in words) of the pet name.

property prefix

prefix?: pulumi.Input<string>;

A string to prefix the name with.

property separator

separator?: pulumi.Input<string>;

The character to separate words in the pet name.

interface RandomPetState

interface RandomPetState

Input properties used for looking up and filtering RandomPet resources.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property length

length?: pulumi.Input<number>;

The length (in words) of the pet name.

property prefix

prefix?: pulumi.Input<string>;

A string to prefix the name with.

property separator

separator?: pulumi.Input<string>;

The character to separate words in the pet name.

interface RandomShuffleArgs

interface RandomShuffleArgs

The set of arguments for constructing a RandomShuffle resource.

property inputs

inputs: pulumi.Input<pulumi.Input<string>[]>;

The list of strings to shuffle.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property resultCount

resultCount?: pulumi.Input<number>;

The number of results to return. Defaults to the number of items in the input list. If fewer items are requested, some elements will be excluded from the result. If more items are requested, items will be repeated in the result but not more frequently than the number of items in the input list.

property seed

seed?: pulumi.Input<string>;

interface RandomShuffleState

interface RandomShuffleState

Input properties used for looking up and filtering RandomShuffle resources.

property inputs

inputs?: pulumi.Input<pulumi.Input<string>[]>;

The list of strings to shuffle.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property resultCount

resultCount?: pulumi.Input<number>;

The number of results to return. Defaults to the number of items in the input list. If fewer items are requested, some elements will be excluded from the result. If more items are requested, items will be repeated in the result but not more frequently than the number of items in the input list.

property results

results?: pulumi.Input<pulumi.Input<string>[]>;

Random permutation of the list of strings given in input.

property seed

seed?: pulumi.Input<string>;

interface RandomStringArgs

interface RandomStringArgs

The set of arguments for constructing a RandomString resource.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property length

length: pulumi.Input<number>;

The length of the string desired

property lower

lower?: pulumi.Input<boolean>;

(default true) Include lowercase alphabet characters in random string.

property minLower

minLower?: pulumi.Input<number>;

(default 0) Minimum number of lowercase alphabet characters in random string.

property minNumeric

minNumeric?: pulumi.Input<number>;

(default 0) Minimum number of numeric characters in random string.

property minSpecial

minSpecial?: pulumi.Input<number>;

(default 0) Minimum number of special characters in random string.

property minUpper

minUpper?: pulumi.Input<number>;

(default 0) Minimum number of uppercase alphabet characters in random string.

property number

number?: pulumi.Input<boolean>;

(default true) Include numeric characters in random string.

property overrideSpecial

overrideSpecial?: pulumi.Input<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.

property special

special?: pulumi.Input<boolean>;

(default true) Include special characters in random string. These are !@#$%&*()-_=+[]{}<>:?

property upper

upper?: pulumi.Input<boolean>;

(default true) Include uppercase alphabet characters in random string.

interface RandomStringState

interface RandomStringState

Input properties used for looking up and filtering RandomString resources.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new id to be generated. See the main provider documentation for more information.

property length

length?: pulumi.Input<number>;

The length of the string desired

property lower

lower?: pulumi.Input<boolean>;

(default true) Include lowercase alphabet characters in random string.

property minLower

minLower?: pulumi.Input<number>;

(default 0) Minimum number of lowercase alphabet characters in random string.

property minNumeric

minNumeric?: pulumi.Input<number>;

(default 0) Minimum number of numeric characters in random string.

property minSpecial

minSpecial?: pulumi.Input<number>;

(default 0) Minimum number of special characters in random string.

property minUpper

minUpper?: pulumi.Input<number>;

(default 0) Minimum number of uppercase alphabet characters in random string.

property number

number?: pulumi.Input<boolean>;

(default true) Include numeric characters in random string.

property overrideSpecial

overrideSpecial?: pulumi.Input<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.

property result

result?: pulumi.Input<string>;

Random string generated.

property special

special?: pulumi.Input<boolean>;

(default true) Include special characters in random string. These are !@#$%&*()-_=+[]{}<>:?

property upper

upper?: pulumi.Input<boolean>;

(default true) Include uppercase alphabet characters in random string.

interface RandomUuidArgs

interface RandomUuidArgs

The set of arguments for constructing a RandomUuid resource.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new uuid to be generated. See the main provider documentation for more information.

interface RandomUuidState

interface RandomUuidState

Input properties used for looking up and filtering RandomUuid resources.

property keepers

keepers?: pulumi.Input<{[key: string]: any}>;

Arbitrary map of values that, when changed, will trigger a new uuid to be generated. See the main provider documentation for more information.

property result

result?: pulumi.Input<string>;

The generated uuid presented in string format.