RandomIdArgs

data class RandomIdArgs(val byteLength: Output<Int>? = null, val keepers: Output<Map<String, String>>? = null, val prefix: Output<String>? = null) : ConvertibleToJava<RandomIdArgs>

The resource random.RandomId generates random numbers that are intended to be used as unique identifiers for other resources. If the output is considered sensitive, and should not be displayed in the CLI, use random.RandomBytes instead. 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 create_before_destroy lifecycle flag set to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.RandomId;
import com.pulumi.random.RandomIdArgs;
import com.pulumi.aws.ec2.Instance;
import com.pulumi.aws.ec2.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 serverRandomId = new RandomId("serverRandomId", RandomIdArgs.builder()
.keepers(Map.of("ami_id", var_.ami_id()))
.byteLength(8)
.build());
var serverInstance = new Instance("serverInstance", InstanceArgs.builder()
.tags(Map.of("Name", serverRandomId.hex().applyValue(hex -> String.format("web-server %s", hex))))
.ami(serverRandomId.keepers().applyValue(keepers -> keepers.amiId()))
.build());
}
}

Import

Random IDs can be imported using the b64_url with an optional prefix. This can be used to replace a config value with a value interpolated from the random provider without experiencing diffs. Example with no prefix

$ pulumi import random:index/randomId:RandomId server p-9hUg

Example with prefix (prefix is separated by a ,)

$ pulumi import random:index/randomId:RandomId server my-prefix-,p-9hUg

Constructors

Link copied to clipboard
fun RandomIdArgs(byteLength: Output<Int>? = null, keepers: Output<Map<String, String>>? = null, prefix: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): RandomIdArgs

Properties

Link copied to clipboard
val byteLength: Output<Int>? = null

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

Link copied to clipboard
val keepers: Output<Map<String, String>>? = null

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

Link copied to clipboard
val prefix: Output<String>? = null

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.