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

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

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

import com.pulumi.awsnative.cognito.inputs.UserPoolDeviceConfigurationArgs.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.Suppress
import kotlin.jvm.JvmName

/**
 *
 * @property challengeRequiredOnNewDevice When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
 * > Whether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
 * @property deviceOnlyRememberedOnUserPrompt When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an [UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request.
 * When `DeviceOnlyRememberedOnUserPrompt` is `false` , Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request.
 */
public data class UserPoolDeviceConfigurationArgs(
    public val challengeRequiredOnNewDevice: Output? = null,
    public val deviceOnlyRememberedOnUserPrompt: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.cognito.inputs.UserPoolDeviceConfigurationArgs =
        com.pulumi.awsnative.cognito.inputs.UserPoolDeviceConfigurationArgs.builder()
            .challengeRequiredOnNewDevice(challengeRequiredOnNewDevice?.applyValue({ args0 -> args0 }))
            .deviceOnlyRememberedOnUserPrompt(
                deviceOnlyRememberedOnUserPrompt?.applyValue({ args0 ->
                    args0
                }),
            ).build()
}

/**
 * Builder for [UserPoolDeviceConfigurationArgs].
 */
@PulumiTagMarker
public class UserPoolDeviceConfigurationArgsBuilder internal constructor() {
    private var challengeRequiredOnNewDevice: Output? = null

    private var deviceOnlyRememberedOnUserPrompt: Output? = null

    /**
     * @param value When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
     * > Whether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
     */
    @JvmName("xmpcgvicbniasqef")
    public suspend fun challengeRequiredOnNewDevice(`value`: Output) {
        this.challengeRequiredOnNewDevice = value
    }

    /**
     * @param value When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an [UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request.
     * When `DeviceOnlyRememberedOnUserPrompt` is `false` , Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request.
     */
    @JvmName("kwifuadsqjjpqxxk")
    public suspend fun deviceOnlyRememberedOnUserPrompt(`value`: Output) {
        this.deviceOnlyRememberedOnUserPrompt = value
    }

    /**
     * @param value When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
     * > Whether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
     */
    @JvmName("ifxjxvouqdciipgk")
    public suspend fun challengeRequiredOnNewDevice(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.challengeRequiredOnNewDevice = mapped
    }

    /**
     * @param value When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an [UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request.
     * When `DeviceOnlyRememberedOnUserPrompt` is `false` , Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request.
     */
    @JvmName("mcuicbxhmjrsvtby")
    public suspend fun deviceOnlyRememberedOnUserPrompt(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.deviceOnlyRememberedOnUserPrompt = mapped
    }

    internal fun build(): UserPoolDeviceConfigurationArgs = UserPoolDeviceConfigurationArgs(
        challengeRequiredOnNewDevice = challengeRequiredOnNewDevice,
        deviceOnlyRememberedOnUserPrompt = deviceOnlyRememberedOnUserPrompt,
    )
}