com.pulumi.awsnative.cognito.kotlin.outputs.UserPoolSmsConfiguration.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.cognito.kotlin.outputs

import kotlin.String
import kotlin.Suppress

/**
 *
 * @property externalId The external ID is a value. We recommend you use `ExternalId` to add security to your IAM role, which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an `ExternalId` , the Cognito User Pool uses it when attempting to assume your IAM role. You can also set your roles trust policy to require the `ExternalID` . If you use the Cognito Management Console to create a role for SMS MFA, Cognito creates a role with the required permissions and a trust policy that uses `ExternalId` .
 * @property snsCallerArn The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a [spending limit](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html) .
 * @property snsRegion The AWS Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported *Legacy Amazon SNS alternate Region* .
 * Amazon Cognito resources in the Asia Pacific (Seoul) AWS Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see [SMS message settings for Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) .
 */
public data class UserPoolSmsConfiguration(
    public val externalId: String? = null,
    public val snsCallerArn: String? = null,
    public val snsRegion: String? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.cognito.outputs.UserPoolSmsConfiguration): UserPoolSmsConfiguration = UserPoolSmsConfiguration(
            externalId = javaType.externalId().map({ args0 -> args0 }).orElse(null),
            snsCallerArn = javaType.snsCallerArn().map({ args0 -> args0 }).orElse(null),
            snsRegion = javaType.snsRegion().map({ args0 -> args0 }).orElse(null),
        )
    }
}