com.pulumi.aws.cognito.kotlin.inputs.UserPoolPasswordPolicyArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.57.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.cognito.kotlin.inputs

import com.pulumi.aws.cognito.inputs.UserPoolPasswordPolicyArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Int
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 *
 * @property minimumLength Minimum length of the password policy that you have set.
 * @property passwordHistorySize Number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of number of previous passwords specified by this argument. A value of 0 means that password history is not enforced. Valid values are between 0 and 24.
 * **Note:** This argument requires advanced security features to be active in the user pool.
 * @property requireLowercase Whether you have required users to use at least one lowercase letter in their password.
 * @property requireNumbers Whether you have required users to use at least one number in their password.
 * @property requireSymbols Whether you have required users to use at least one symbol in their password.
 * @property requireUppercase Whether you have required users to use at least one uppercase letter in their password.
 * @property temporaryPasswordValidityDays In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.
 */
public data class UserPoolPasswordPolicyArgs(
    public val minimumLength: Output? = null,
    public val passwordHistorySize: Output? = null,
    public val requireLowercase: Output? = null,
    public val requireNumbers: Output? = null,
    public val requireSymbols: Output? = null,
    public val requireUppercase: Output? = null,
    public val temporaryPasswordValidityDays: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.aws.cognito.inputs.UserPoolPasswordPolicyArgs =
        com.pulumi.aws.cognito.inputs.UserPoolPasswordPolicyArgs.builder()
            .minimumLength(minimumLength?.applyValue({ args0 -> args0 }))
            .passwordHistorySize(passwordHistorySize?.applyValue({ args0 -> args0 }))
            .requireLowercase(requireLowercase?.applyValue({ args0 -> args0 }))
            .requireNumbers(requireNumbers?.applyValue({ args0 -> args0 }))
            .requireSymbols(requireSymbols?.applyValue({ args0 -> args0 }))
            .requireUppercase(requireUppercase?.applyValue({ args0 -> args0 }))
            .temporaryPasswordValidityDays(
                temporaryPasswordValidityDays?.applyValue({ args0 ->
                    args0
                }),
            ).build()
}

/**
 * Builder for [UserPoolPasswordPolicyArgs].
 */
@PulumiTagMarker
public class UserPoolPasswordPolicyArgsBuilder internal constructor() {
    private var minimumLength: Output? = null

    private var passwordHistorySize: Output? = null

    private var requireLowercase: Output? = null

    private var requireNumbers: Output? = null

    private var requireSymbols: Output? = null

    private var requireUppercase: Output? = null

    private var temporaryPasswordValidityDays: Output? = null

    /**
     * @param value Minimum length of the password policy that you have set.
     */
    @JvmName("vfmeohwfqmuuknbj")
    public suspend fun minimumLength(`value`: Output) {
        this.minimumLength = value
    }

    /**
     * @param value Number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of number of previous passwords specified by this argument. A value of 0 means that password history is not enforced. Valid values are between 0 and 24.
     * **Note:** This argument requires advanced security features to be active in the user pool.
     */
    @JvmName("oajxtofffwnljrfa")
    public suspend fun passwordHistorySize(`value`: Output) {
        this.passwordHistorySize = value
    }

    /**
     * @param value Whether you have required users to use at least one lowercase letter in their password.
     */
    @JvmName("joroiklpnvupkfgi")
    public suspend fun requireLowercase(`value`: Output) {
        this.requireLowercase = value
    }

    /**
     * @param value Whether you have required users to use at least one number in their password.
     */
    @JvmName("wervfpktsgajcken")
    public suspend fun requireNumbers(`value`: Output) {
        this.requireNumbers = value
    }

    /**
     * @param value Whether you have required users to use at least one symbol in their password.
     */
    @JvmName("ghesodcwovawojaq")
    public suspend fun requireSymbols(`value`: Output) {
        this.requireSymbols = value
    }

    /**
     * @param value Whether you have required users to use at least one uppercase letter in their password.
     */
    @JvmName("oydngltghnrscnso")
    public suspend fun requireUppercase(`value`: Output) {
        this.requireUppercase = value
    }

    /**
     * @param value In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.
     */
    @JvmName("wwcfqppuinlsujqx")
    public suspend fun temporaryPasswordValidityDays(`value`: Output) {
        this.temporaryPasswordValidityDays = value
    }

    /**
     * @param value Minimum length of the password policy that you have set.
     */
    @JvmName("gawlqamisjtpqare")
    public suspend fun minimumLength(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.minimumLength = mapped
    }

    /**
     * @param value Number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of number of previous passwords specified by this argument. A value of 0 means that password history is not enforced. Valid values are between 0 and 24.
     * **Note:** This argument requires advanced security features to be active in the user pool.
     */
    @JvmName("jwbjgllvdqkiybde")
    public suspend fun passwordHistorySize(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.passwordHistorySize = mapped
    }

    /**
     * @param value Whether you have required users to use at least one lowercase letter in their password.
     */
    @JvmName("rjsvovinnyjijybp")
    public suspend fun requireLowercase(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.requireLowercase = mapped
    }

    /**
     * @param value Whether you have required users to use at least one number in their password.
     */
    @JvmName("iyhgyvpbsggjtrey")
    public suspend fun requireNumbers(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.requireNumbers = mapped
    }

    /**
     * @param value Whether you have required users to use at least one symbol in their password.
     */
    @JvmName("xgtialmhbbfpdwds")
    public suspend fun requireSymbols(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.requireSymbols = mapped
    }

    /**
     * @param value Whether you have required users to use at least one uppercase letter in their password.
     */
    @JvmName("eftghwfhwncfrrfa")
    public suspend fun requireUppercase(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.requireUppercase = mapped
    }

    /**
     * @param value In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.
     */
    @JvmName("dcvlrmrfummvfiuy")
    public suspend fun temporaryPasswordValidityDays(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.temporaryPasswordValidityDays = mapped
    }

    internal fun build(): UserPoolPasswordPolicyArgs = UserPoolPasswordPolicyArgs(
        minimumLength = minimumLength,
        passwordHistorySize = passwordHistorySize,
        requireLowercase = requireLowercase,
        requireNumbers = requireNumbers,
        requireSymbols = requireSymbols,
        requireUppercase = requireUppercase,
        temporaryPasswordValidityDays = temporaryPasswordValidityDays,
    )
}