Random
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 random = new random.RandomString("random", {
length: 16,
special: true,
overrideSpecial: "/@£$",
});import pulumi
import pulumi_random as random
random = random.RandomString("random",
length=16,
special=True,
override_special="/@£$")using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Random = Pulumi.Random;
return await Deployment.RunAsync(() =>
{
var random = new Random.RandomString("random", new()
{
Length = 16,
Special = true,
OverrideSpecial = "/@£$",
});
});package main
import (
"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 {
_, err := random.NewRandomString(ctx, "random", &random.RandomStringArgs{
Length: pulumi.Int(16),
Special: pulumi.Bool(true),
OverrideSpecial: pulumi.String("/@£$"),
})
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.RandomString;
import com.pulumi.random.RandomStringArgs;
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 random = new RandomString("random", RandomStringArgs.builder()
.length(16)
.special(true)
.overrideSpecial("/@£$")
.build());
}
}resources:
random:
type: random:RandomString
properties:
length: 16
special: true
overrideSpecial: /@£$Import
You can import external strings into your Pulumi programs as RandomString resources as follows:
$ import random:index/randomString:RandomString newString myspecialdata
<break>```
This command will encode the `myspecialdata` token in Pulumi state and generate a code suggestion to
include a new RandomString resource in your Pulumi program. Include the suggested code and do a
`pulumi up`. Your data is now stored in Pulumi, and you can reference it in your Pulumi program as
`newString.result`.
If the data needs to be stored securily as a secret, consider using the RandomPassword resource
instead.Constructors
Properties
Minimum number of numeric characters in the result. Default value is 0.
Minimum number of special characters in the result. Default value is 0.
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.