com.pulumi.random.inputs.RandomPasswordState Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of random Show documentation
A Pulumi package to safely use randomness in Pulumi programs.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.random.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class RandomPasswordState extends com.pulumi.resources.ResourceArgs {

    public static final RandomPasswordState Empty = new RandomPasswordState();

    /**
     * A bcrypt hash of the generated random string. **NOTE**: If the generated random string is greater than 72 bytes in length, `bcrypt_hash` will contain a hash of the first 72 bytes.
     * 
     */
    @Import(name="bcryptHash")
    private @Nullable Output bcryptHash;

    /**
     * @return A bcrypt hash of the generated random string. **NOTE**: If the generated random string is greater than 72 bytes in length, `bcrypt_hash` will contain a hash of the first 72 bytes.
     * 
     */
    public Optional> bcryptHash() {
        return Optional.ofNullable(this.bcryptHash);
    }

    /**
     * Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.
     * 
     */
    @Import(name="keepers")
    private @Nullable Output> keepers;

    /**
     * @return Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.
     * 
     */
    public Optional>> keepers() {
        return Optional.ofNullable(this.keepers);
    }

    /**
     * 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`).
     * 
     */
    @Import(name="length")
    private @Nullable Output length;

    /**
     * @return 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`).
     * 
     */
    public Optional> length() {
        return Optional.ofNullable(this.length);
    }

    /**
     * Include lowercase alphabet characters in the result. Default value is `true`.
     * 
     */
    @Import(name="lower")
    private @Nullable Output lower;

    /**
     * @return Include lowercase alphabet characters in the result. Default value is `true`.
     * 
     */
    public Optional> lower() {
        return Optional.ofNullable(this.lower);
    }

    /**
     * Minimum number of lowercase alphabet characters in the result. Default value is `0`.
     * 
     */
    @Import(name="minLower")
    private @Nullable Output minLower;

    /**
     * @return Minimum number of lowercase alphabet characters in the result. Default value is `0`.
     * 
     */
    public Optional> minLower() {
        return Optional.ofNullable(this.minLower);
    }

    /**
     * Minimum number of numeric characters in the result. Default value is `0`.
     * 
     */
    @Import(name="minNumeric")
    private @Nullable Output minNumeric;

    /**
     * @return Minimum number of numeric characters in the result. Default value is `0`.
     * 
     */
    public Optional> minNumeric() {
        return Optional.ofNullable(this.minNumeric);
    }

    /**
     * Minimum number of special characters in the result. Default value is `0`.
     * 
     */
    @Import(name="minSpecial")
    private @Nullable Output minSpecial;

    /**
     * @return Minimum number of special characters in the result. Default value is `0`.
     * 
     */
    public Optional> minSpecial() {
        return Optional.ofNullable(this.minSpecial);
    }

    /**
     * Minimum number of uppercase alphabet characters in the result. Default value is `0`.
     * 
     */
    @Import(name="minUpper")
    private @Nullable Output minUpper;

    /**
     * @return Minimum number of uppercase alphabet characters in the result. Default value is `0`.
     * 
     */
    public Optional> minUpper() {
        return Optional.ofNullable(this.minUpper);
    }

    /**
     * Include numeric characters in the result. Default value is `true`. If `number`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`. **NOTE**: This is deprecated, use `numeric` instead.
     * 
     * @deprecated
     * **NOTE**: This is deprecated, use `numeric` instead.
     * 
     */
    @Deprecated /* **NOTE**: This is deprecated, use `numeric` instead. */
    @Import(name="number")
    private @Nullable Output number;

    /**
     * @return Include numeric characters in the result. Default value is `true`. If `number`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`. **NOTE**: This is deprecated, use `numeric` instead.
     * 
     * @deprecated
     * **NOTE**: This is deprecated, use `numeric` instead.
     * 
     */
    @Deprecated /* **NOTE**: This is deprecated, use `numeric` instead. */
    public Optional> number() {
        return Optional.ofNullable(this.number);
    }

    /**
     * Include numeric characters in the result. Default value is `true`. If `numeric`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`.
     * 
     */
    @Import(name="numeric")
    private @Nullable Output numeric;

    /**
     * @return Include numeric characters in the result. Default value is `true`. If `numeric`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`.
     * 
     */
    public Optional> numeric() {
        return Optional.ofNullable(this.numeric);
    }

    /**
     * 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.
     * 
     */
    @Import(name="overrideSpecial")
    private @Nullable Output overrideSpecial;

    /**
     * @return 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.
     * 
     */
    public Optional> overrideSpecial() {
        return Optional.ofNullable(this.overrideSpecial);
    }

    /**
     * The generated random string.
     * 
     */
    @Import(name="result")
    private @Nullable Output result;

    /**
     * @return The generated random string.
     * 
     */
    public Optional> result() {
        return Optional.ofNullable(this.result);
    }

    /**
     * Include special characters in the result. These are `!{@literal @}#$%&*()-_=+[]{}<>:?`. Default value is `true`.
     * 
     */
    @Import(name="special")
    private @Nullable Output special;

    /**
     * @return Include special characters in the result. These are `!{@literal @}#$%&*()-_=+[]{}<>:?`. Default value is `true`.
     * 
     */
    public Optional> special() {
        return Optional.ofNullable(this.special);
    }

    /**
     * Include uppercase alphabet characters in the result. Default value is `true`.
     * 
     */
    @Import(name="upper")
    private @Nullable Output upper;

    /**
     * @return Include uppercase alphabet characters in the result. Default value is `true`.
     * 
     */
    public Optional> upper() {
        return Optional.ofNullable(this.upper);
    }

    private RandomPasswordState() {}

    private RandomPasswordState(RandomPasswordState $) {
        this.bcryptHash = $.bcryptHash;
        this.keepers = $.keepers;
        this.length = $.length;
        this.lower = $.lower;
        this.minLower = $.minLower;
        this.minNumeric = $.minNumeric;
        this.minSpecial = $.minSpecial;
        this.minUpper = $.minUpper;
        this.number = $.number;
        this.numeric = $.numeric;
        this.overrideSpecial = $.overrideSpecial;
        this.result = $.result;
        this.special = $.special;
        this.upper = $.upper;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(RandomPasswordState defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private RandomPasswordState $;

        public Builder() {
            $ = new RandomPasswordState();
        }

        public Builder(RandomPasswordState defaults) {
            $ = new RandomPasswordState(Objects.requireNonNull(defaults));
        }

        /**
         * @param bcryptHash A bcrypt hash of the generated random string. **NOTE**: If the generated random string is greater than 72 bytes in length, `bcrypt_hash` will contain a hash of the first 72 bytes.
         * 
         * @return builder
         * 
         */
        public Builder bcryptHash(@Nullable Output bcryptHash) {
            $.bcryptHash = bcryptHash;
            return this;
        }

        /**
         * @param bcryptHash A bcrypt hash of the generated random string. **NOTE**: If the generated random string is greater than 72 bytes in length, `bcrypt_hash` will contain a hash of the first 72 bytes.
         * 
         * @return builder
         * 
         */
        public Builder bcryptHash(String bcryptHash) {
            return bcryptHash(Output.of(bcryptHash));
        }

        /**
         * @param keepers Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.
         * 
         * @return builder
         * 
         */
        public Builder keepers(@Nullable Output> keepers) {
            $.keepers = keepers;
            return this;
        }

        /**
         * @param keepers Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.
         * 
         * @return builder
         * 
         */
        public Builder keepers(Map keepers) {
            return keepers(Output.of(keepers));
        }

        /**
         * @param length 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`).
         * 
         * @return builder
         * 
         */
        public Builder length(@Nullable Output length) {
            $.length = length;
            return this;
        }

        /**
         * @param length 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`).
         * 
         * @return builder
         * 
         */
        public Builder length(Integer length) {
            return length(Output.of(length));
        }

        /**
         * @param lower Include lowercase alphabet characters in the result. Default value is `true`.
         * 
         * @return builder
         * 
         */
        public Builder lower(@Nullable Output lower) {
            $.lower = lower;
            return this;
        }

        /**
         * @param lower Include lowercase alphabet characters in the result. Default value is `true`.
         * 
         * @return builder
         * 
         */
        public Builder lower(Boolean lower) {
            return lower(Output.of(lower));
        }

        /**
         * @param minLower Minimum number of lowercase alphabet characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minLower(@Nullable Output minLower) {
            $.minLower = minLower;
            return this;
        }

        /**
         * @param minLower Minimum number of lowercase alphabet characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minLower(Integer minLower) {
            return minLower(Output.of(minLower));
        }

        /**
         * @param minNumeric Minimum number of numeric characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minNumeric(@Nullable Output minNumeric) {
            $.minNumeric = minNumeric;
            return this;
        }

        /**
         * @param minNumeric Minimum number of numeric characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minNumeric(Integer minNumeric) {
            return minNumeric(Output.of(minNumeric));
        }

        /**
         * @param minSpecial Minimum number of special characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minSpecial(@Nullable Output minSpecial) {
            $.minSpecial = minSpecial;
            return this;
        }

        /**
         * @param minSpecial Minimum number of special characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minSpecial(Integer minSpecial) {
            return minSpecial(Output.of(minSpecial));
        }

        /**
         * @param minUpper Minimum number of uppercase alphabet characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minUpper(@Nullable Output minUpper) {
            $.minUpper = minUpper;
            return this;
        }

        /**
         * @param minUpper Minimum number of uppercase alphabet characters in the result. Default value is `0`.
         * 
         * @return builder
         * 
         */
        public Builder minUpper(Integer minUpper) {
            return minUpper(Output.of(minUpper));
        }

        /**
         * @param number Include numeric characters in the result. Default value is `true`. If `number`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`. **NOTE**: This is deprecated, use `numeric` instead.
         * 
         * @return builder
         * 
         * @deprecated
         * **NOTE**: This is deprecated, use `numeric` instead.
         * 
         */
        @Deprecated /* **NOTE**: This is deprecated, use `numeric` instead. */
        public Builder number(@Nullable Output number) {
            $.number = number;
            return this;
        }

        /**
         * @param number Include numeric characters in the result. Default value is `true`. If `number`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`. **NOTE**: This is deprecated, use `numeric` instead.
         * 
         * @return builder
         * 
         * @deprecated
         * **NOTE**: This is deprecated, use `numeric` instead.
         * 
         */
        @Deprecated /* **NOTE**: This is deprecated, use `numeric` instead. */
        public Builder number(Boolean number) {
            return number(Output.of(number));
        }

        /**
         * @param numeric Include numeric characters in the result. Default value is `true`. If `numeric`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`.
         * 
         * @return builder
         * 
         */
        public Builder numeric(@Nullable Output numeric) {
            $.numeric = numeric;
            return this;
        }

        /**
         * @param numeric Include numeric characters in the result. Default value is `true`. If `numeric`, `upper`, `lower`, and `special` are all configured, at least one of them must be set to `true`.
         * 
         * @return builder
         * 
         */
        public Builder numeric(Boolean numeric) {
            return numeric(Output.of(numeric));
        }

        /**
         * @param overrideSpecial 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.
         * 
         * @return builder
         * 
         */
        public Builder overrideSpecial(@Nullable Output overrideSpecial) {
            $.overrideSpecial = overrideSpecial;
            return this;
        }

        /**
         * @param overrideSpecial 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.
         * 
         * @return builder
         * 
         */
        public Builder overrideSpecial(String overrideSpecial) {
            return overrideSpecial(Output.of(overrideSpecial));
        }

        /**
         * @param result The generated random string.
         * 
         * @return builder
         * 
         */
        public Builder result(@Nullable Output result) {
            $.result = result;
            return this;
        }

        /**
         * @param result The generated random string.
         * 
         * @return builder
         * 
         */
        public Builder result(String result) {
            return result(Output.of(result));
        }

        /**
         * @param special Include special characters in the result. These are `!{@literal @}#$%&*()-_=+[]{}<>:?`. Default value is `true`.
         * 
         * @return builder
         * 
         */
        public Builder special(@Nullable Output special) {
            $.special = special;
            return this;
        }

        /**
         * @param special Include special characters in the result. These are `!{@literal @}#$%&*()-_=+[]{}<>:?`. Default value is `true`.
         * 
         * @return builder
         * 
         */
        public Builder special(Boolean special) {
            return special(Output.of(special));
        }

        /**
         * @param upper Include uppercase alphabet characters in the result. Default value is `true`.
         * 
         * @return builder
         * 
         */
        public Builder upper(@Nullable Output upper) {
            $.upper = upper;
            return this;
        }

        /**
         * @param upper Include uppercase alphabet characters in the result. Default value is `true`.
         * 
         * @return builder
         * 
         */
        public Builder upper(Boolean upper) {
            return upper(Output.of(upper));
        }

        public RandomPasswordState build() {
            return $;
        }
    }

}