com.pulumi.awsnative.cognito.kotlin.inputs.UserPoolAdminCreateUserConfigArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-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: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.cognito.kotlin.inputs

import com.pulumi.awsnative.cognito.inputs.UserPoolAdminCreateUserConfigArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Int
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 *
 * @property allowAdminCreateUserOnly Set to `True` if only the administrator is allowed to create user profiles. Set to `False` if users can sign themselves up via an app.
 * @property inviteMessageTemplate The message template to be used for the welcome message to new users.
 * See also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) .
 * @property unusedAccountValidityDays The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `"RESEND"` for the `MessageAction` parameter. The default value for this parameter is 7.
 * > If you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy` , that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool.
 */
public data class UserPoolAdminCreateUserConfigArgs(
    public val allowAdminCreateUserOnly: Output? = null,
    public val inviteMessageTemplate: Output? = null,
    public val unusedAccountValidityDays: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.cognito.inputs.UserPoolAdminCreateUserConfigArgs =
        com.pulumi.awsnative.cognito.inputs.UserPoolAdminCreateUserConfigArgs.builder()
            .allowAdminCreateUserOnly(allowAdminCreateUserOnly?.applyValue({ args0 -> args0 }))
            .inviteMessageTemplate(
                inviteMessageTemplate?.applyValue({ args0 ->
                    args0.let({ args0 ->
                        args0.toJava()
                    })
                }),
            )
            .unusedAccountValidityDays(unusedAccountValidityDays?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [UserPoolAdminCreateUserConfigArgs].
 */
@PulumiTagMarker
public class UserPoolAdminCreateUserConfigArgsBuilder internal constructor() {
    private var allowAdminCreateUserOnly: Output? = null

    private var inviteMessageTemplate: Output? = null

    private var unusedAccountValidityDays: Output? = null

    /**
     * @param value Set to `True` if only the administrator is allowed to create user profiles. Set to `False` if users can sign themselves up via an app.
     */
    @JvmName("axgmubfwjhhtxtst")
    public suspend fun allowAdminCreateUserOnly(`value`: Output) {
        this.allowAdminCreateUserOnly = value
    }

    /**
     * @param value The message template to be used for the welcome message to new users.
     * See also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) .
     */
    @JvmName("yvluddxwxenfqxjj")
    public suspend fun inviteMessageTemplate(`value`: Output) {
        this.inviteMessageTemplate = value
    }

    /**
     * @param value The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `"RESEND"` for the `MessageAction` parameter. The default value for this parameter is 7.
     * > If you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy` , that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool.
     */
    @JvmName("wcgsglyrncbpjtve")
    public suspend fun unusedAccountValidityDays(`value`: Output) {
        this.unusedAccountValidityDays = value
    }

    /**
     * @param value Set to `True` if only the administrator is allowed to create user profiles. Set to `False` if users can sign themselves up via an app.
     */
    @JvmName("iqjdxppnvkkfhyss")
    public suspend fun allowAdminCreateUserOnly(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.allowAdminCreateUserOnly = mapped
    }

    /**
     * @param value The message template to be used for the welcome message to new users.
     * See also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) .
     */
    @JvmName("tlgxjxcdcdglokqi")
    public suspend fun inviteMessageTemplate(`value`: UserPoolInviteMessageTemplateArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.inviteMessageTemplate = mapped
    }

    /**
     * @param argument The message template to be used for the welcome message to new users.
     * See also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) .
     */
    @JvmName("gorwdmlpwttqhtqr")
    public suspend fun inviteMessageTemplate(argument: suspend UserPoolInviteMessageTemplateArgsBuilder.() -> Unit) {
        val toBeMapped = UserPoolInviteMessageTemplateArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.inviteMessageTemplate = mapped
    }

    /**
     * @param value The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `"RESEND"` for the `MessageAction` parameter. The default value for this parameter is 7.
     * > If you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy` , that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool.
     */
    @JvmName("xmysidfqgvfryutb")
    public suspend fun unusedAccountValidityDays(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.unusedAccountValidityDays = mapped
    }

    internal fun build(): UserPoolAdminCreateUserConfigArgs = UserPoolAdminCreateUserConfigArgs(
        allowAdminCreateUserOnly = allowAdminCreateUserOnly,
        inviteMessageTemplate = inviteMessageTemplate,
        unusedAccountValidityDays = unusedAccountValidityDays,
    )
}