pulumi-random-kotlin/com.pulumi.random.kotlin/RandomPasswordArgs

RandomPasswordArgs

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>

Identical to random_string. This resource does use a cryptographic random number generator.

Example Usage

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());
    }
}
Content copied to clipboard

Import

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

$ import random:index/randomPassword:RandomPassword newPassword supersecret
Content copied to clipboard

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.

Constructors

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

Functions

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

Properties

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 length: Output<Int>? = null

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

Link copied to clipboard
val lower: Output<Boolean>? = null

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

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

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

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

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

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

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

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

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

Link copied to clipboard
val number: Output<Boolean>? = null

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

Link copied to clipboard
val numeric: Output<Boolean>? = null

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

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

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.

Link copied to clipboard
val special: Output<Boolean>? = null

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

Link copied to clipboard
val upper: Output<Boolean>? = null

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