Package-level declarations

Types

Link copied to clipboard
class ProviderArgs : ConvertibleToJava<ProviderArgs>

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.

Link copied to clipboard
Link copied to clipboard
class RandomBytes : KotlinCustomResource

The resource random.RandomBytes generates random bytes that are intended to be used as a secret, or key. Use this in preference to random.RandomId when the output is considered sensitive, and should not be displayed in the CLI. This resource does use a cryptographic random number generator.

Link copied to clipboard
data class RandomBytesArgs(val keepers: Output<Map<String, String>>? = null, val length: Output<Int>? = null) : ConvertibleToJava<RandomBytesArgs>

The resource random.RandomBytes generates random bytes that are intended to be used as a secret, or key. Use this in preference to random.RandomId when the output is considered sensitive, and should not be displayed in the CLI. This resource does use a cryptographic random number generator.

Link copied to clipboard
Link copied to clipboard
object RandomBytesMapper : ResourceMapper<RandomBytes>
Link copied to clipboard
Link copied to clipboard
class RandomId : KotlinCustomResource

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.

Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard
object RandomIdMapper : ResourceMapper<RandomId>
Link copied to clipboard
Link copied to clipboard
class RandomInteger : KotlinCustomResource

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 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.

Link copied to clipboard
data class RandomIntegerArgs(val keepers: Output<Map<String, String>>? = null, val max: Output<Int>? = null, val min: Output<Int>? = null, val seed: Output<String>? = null) : ConvertibleToJava<RandomIntegerArgs>

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 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.

Link copied to clipboard
Link copied to clipboard
object RandomIntegerMapper : ResourceMapper<RandomInteger>
Link copied to clipboard
Link copied to clipboard
class RandomPassword : KotlinCustomResource
Link copied to clipboard
data class RandomPasswordArgs(val keepers: Output<Map<String, String>>? = null, val length: Output<Int>? = null, val lower: Output<Boolean>? = null, val minLower: Output<Int>? = null, val minNumeric: Output<Int>? = null, val minSpecial: Output<Int>? = null, val minUpper: Output<Int>? = null, val number: Output<Boolean>? = null, val numeric: Output<Boolean>? = null, val overrideSpecial: Output<String>? = null, val special: Output<Boolean>? = null, val upper: Output<Boolean>? = null) : ConvertibleToJava<RandomPasswordArgs>
Link copied to clipboard
Link copied to clipboard
object RandomPasswordMapper : ResourceMapper<RandomPassword>
Link copied to clipboard
class RandomPet : KotlinCustomResource

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 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.

Link copied to clipboard
data class RandomPetArgs(val keepers: Output<Map<String, String>>? = null, val length: Output<Int>? = null, val prefix: Output<String>? = null, val separator: Output<String>? = null) : ConvertibleToJava<RandomPetArgs>

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 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.

Link copied to clipboard
Link copied to clipboard
object RandomPetMapper : ResourceMapper<RandomPet>
Link copied to clipboard
Link copied to clipboard
class RandomProvider : KotlinProviderResource

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.

Link copied to clipboard
object RandomProviderMapper : ResourceMapper<RandomProvider>
Link copied to clipboard
class RandomShuffle : KotlinCustomResource

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

Link copied to clipboard
data class RandomShuffleArgs(val inputs: Output<List<String>>? = null, val keepers: Output<Map<String, String>>? = null, val resultCount: Output<Int>? = null, val seed: Output<String>? = null) : ConvertibleToJava<RandomShuffleArgs>

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

Link copied to clipboard
Link copied to clipboard
object RandomShuffleMapper : ResourceMapper<RandomShuffle>
Link copied to clipboard
Link copied to clipboard
class RandomString : KotlinCustomResource

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.

Link copied to clipboard
data class RandomStringArgs(val keepers: Output<Map<String, String>>? = null, val length: Output<Int>? = null, val lower: Output<Boolean>? = null, val minLower: Output<Int>? = null, val minNumeric: Output<Int>? = null, val minSpecial: Output<Int>? = null, val minUpper: Output<Int>? = null, val number: Output<Boolean>? = null, val numeric: Output<Boolean>? = null, val overrideSpecial: Output<String>? = null, val special: Output<Boolean>? = null, val upper: Output<Boolean>? = null) : ConvertibleToJava<RandomStringArgs>

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.

Link copied to clipboard
Link copied to clipboard
object RandomStringMapper : ResourceMapper<RandomString>
Link copied to clipboard
Link copied to clipboard
class RandomUuid : KotlinCustomResource
Link copied to clipboard
data class RandomUuidArgs(val keepers: Output<Map<String, String>>? = null) : ConvertibleToJava<RandomUuidArgs>
Link copied to clipboard
Link copied to clipboard
object RandomUuidMapper : ResourceMapper<RandomUuid>
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun randomBytes(name: String, block: suspend RandomBytesResourceBuilder.() -> Unit): RandomBytes
Link copied to clipboard
suspend fun randomId(name: String, block: suspend RandomIdResourceBuilder.() -> Unit): RandomId
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun randomPet(name: String, block: suspend RandomPetResourceBuilder.() -> Unit): RandomPet
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun randomUuid(name: String, block: suspend RandomUuidResourceBuilder.() -> Unit): RandomUuid