1. Docs
  2. Reference
  3. API
  4. AWS
  5. cognito
  6. UserPool

UserPool

Provides a Cognito User Pool resource.

Example Usage

Basic configuration

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var pool = new Aws.Cognito.UserPool("pool", new Aws.Cognito.UserPoolArgs
        {
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/cognito"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := cognito.NewUserPool(ctx, "pool", nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

pool = aws.cognito.UserPool("pool")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const pool = new aws.cognito.UserPool("pool", {});

Enabling SMS and Software Token Multi-Factor Authentication

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        // ... other configuration ...
        var example = new Aws.Cognito.UserPool("example", new Aws.Cognito.UserPoolArgs
        {
            MfaConfiguration = "ON",
            SmsAuthenticationMessage = "Your code is {####}",
            SmsConfiguration = new Aws.Cognito.Inputs.UserPoolSmsConfigurationArgs
            {
                ExternalId = "example",
                SnsCallerArn = aws_iam_role.Example.Arn,
            },
            SoftwareTokenMfaConfiguration = new Aws.Cognito.Inputs.UserPoolSoftwareTokenMfaConfigurationArgs
            {
                Enabled = true,
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/cognito"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
            MfaConfiguration:         pulumi.String("ON"),
            SmsAuthenticationMessage: pulumi.String("Your code is {####}"),
            SmsConfiguration: &cognito.UserPoolSmsConfigurationArgs{
                ExternalId:   pulumi.String("example"),
                SnsCallerArn: pulumi.String(aws_iam_role.Example.Arn),
            },
            SoftwareTokenMfaConfiguration: &cognito.UserPoolSoftwareTokenMfaConfigurationArgs{
                Enabled: pulumi.Bool(true),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

# ... other configuration ...
example = aws.cognito.UserPool("example",
    mfa_configuration="ON",
    sms_authentication_message="Your code is {####}",
    sms_configuration={
        "external_id": "example",
        "snsCallerArn": aws_iam_role["example"]["arn"],
    },
    software_token_mfa_configuration={
        "enabled": True,
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// ... other configuration ...
const example = new aws.cognito.UserPool("example", {
    mfaConfiguration: "ON",
    smsAuthenticationMessage: "Your code is {####}",
    smsConfiguration: {
        externalId: "example",
        snsCallerArn: aws_iam_role.example.arn,
    },
    softwareTokenMfaConfiguration: {
        enabled: true,
    },
});

Create a UserPool Resource

new UserPool(name: string, args?: UserPoolArgs, opts?: CustomResourceOptions);
def UserPool(resource_name, opts=None, admin_create_user_config=None, alias_attributes=None, auto_verified_attributes=None, device_configuration=None, email_configuration=None, email_verification_message=None, email_verification_subject=None, lambda_config=None, mfa_configuration=None, name=None, password_policy=None, schemas=None, sms_authentication_message=None, sms_configuration=None, sms_verification_message=None, software_token_mfa_configuration=None, tags=None, user_pool_add_ons=None, username_attributes=None, username_configuration=None, verification_message_template=None, __props__=None);
func NewUserPool(ctx *Context, name string, args *UserPoolArgs, opts ...ResourceOption) (*UserPool, error)
public UserPool(string name, UserPoolArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args UserPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args UserPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

UserPool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The UserPool resource accepts the following input properties:

AdminCreateUserConfig UserPoolAdminCreateUserConfigArgs

The configuration for AdminCreateUser requests.

AliasAttributes List<string>

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

AutoVerifiedAttributes List<string>

The attributes to be auto-verified. Possible values: email, phone_number.

DeviceConfiguration UserPoolDeviceConfigurationArgs

The configuration for the user pool’s device tracking.

EmailConfiguration UserPoolEmailConfigurationArgs

The Email Configuration.

EmailVerificationMessage string

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

EmailVerificationSubject string

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

LambdaConfig UserPoolLambdaConfigArgs

A container for the AWS Lambda triggers associated with the user pool.

MfaConfiguration string

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

Name string

The name of the attribute.

PasswordPolicy UserPoolPasswordPolicyArgs

A container for information about the user pool password policy.

Schemas List<UserPoolSchemaArgs>

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

SmsAuthenticationMessage string

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

SmsConfiguration UserPoolSmsConfigurationArgs

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

SmsVerificationMessage string

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfigurationArgs

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

Tags Dictionary<string, string>

A map of tags to assign to the User Pool.

UserPoolAddOns UserPoolUserPoolAddOnsArgs

Configuration block for user pool add-ons to enable user pool advanced security mode features.

UsernameAttributes List<string>

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

UsernameConfiguration UserPoolUsernameConfigurationArgs

The Username Configuration.

VerificationMessageTemplate UserPoolVerificationMessageTemplateArgs

The verification message templates configuration.

AdminCreateUserConfig UserPoolAdminCreateUserConfig

The configuration for AdminCreateUser requests.

AliasAttributes []string

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

AutoVerifiedAttributes []string

The attributes to be auto-verified. Possible values: email, phone_number.

DeviceConfiguration UserPoolDeviceConfiguration

The configuration for the user pool’s device tracking.

EmailConfiguration UserPoolEmailConfiguration

The Email Configuration.

EmailVerificationMessage string

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

EmailVerificationSubject string

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

LambdaConfig UserPoolLambdaConfig

A container for the AWS Lambda triggers associated with the user pool.

MfaConfiguration string

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

Name string

The name of the attribute.

PasswordPolicy UserPoolPasswordPolicy

A container for information about the user pool password policy.

Schemas []UserPoolSchema

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

SmsAuthenticationMessage string

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

SmsConfiguration UserPoolSmsConfiguration

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

SmsVerificationMessage string

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfiguration

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

Tags map[string]string

A map of tags to assign to the User Pool.

UserPoolAddOns UserPoolUserPoolAddOns

Configuration block for user pool add-ons to enable user pool advanced security mode features.

UsernameAttributes []string

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

UsernameConfiguration UserPoolUsernameConfiguration

The Username Configuration.

VerificationMessageTemplate UserPoolVerificationMessageTemplate

The verification message templates configuration.

adminCreateUserConfig UserPoolAdminCreateUserConfig

The configuration for AdminCreateUser requests.

aliasAttributes string[]

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

autoVerifiedAttributes string[]

The attributes to be auto-verified. Possible values: email, phone_number.

deviceConfiguration UserPoolDeviceConfiguration

The configuration for the user pool’s device tracking.

emailConfiguration UserPoolEmailConfiguration

The Email Configuration.

emailVerificationMessage string

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

emailVerificationSubject string

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

lambdaConfig UserPoolLambdaConfig

A container for the AWS Lambda triggers associated with the user pool.

mfaConfiguration string

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

name string

The name of the attribute.

passwordPolicy UserPoolPasswordPolicy

A container for information about the user pool password policy.

schemas UserPoolSchema[]

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

smsAuthenticationMessage string

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

smsConfiguration UserPoolSmsConfiguration

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

smsVerificationMessage string

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

softwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfiguration

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

tags {[key: string]: string}

A map of tags to assign to the User Pool.

userPoolAddOns UserPoolUserPoolAddOns

Configuration block for user pool add-ons to enable user pool advanced security mode features.

usernameAttributes string[]

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

usernameConfiguration UserPoolUsernameConfiguration

The Username Configuration.

verificationMessageTemplate UserPoolVerificationMessageTemplate

The verification message templates configuration.

admin_create_user_config Dict[UserPoolAdminCreateUserConfig]

The configuration for AdminCreateUser requests.

alias_attributes List[str]

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

auto_verified_attributes List[str]

The attributes to be auto-verified. Possible values: email, phone_number.

device_configuration Dict[UserPoolDeviceConfiguration]

The configuration for the user pool’s device tracking.

email_configuration Dict[UserPoolEmailConfiguration]

The Email Configuration.

email_verification_message str

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

email_verification_subject str

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

lambda_config Dict[UserPoolLambdaConfig]

A container for the AWS Lambda triggers associated with the user pool.

mfa_configuration str

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

name str

The name of the attribute.

password_policy Dict[UserPoolPasswordPolicy]

A container for information about the user pool password policy.

schemas List[UserPoolSchema]

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

sms_authentication_message str

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

sms_configuration Dict[UserPoolSmsConfiguration]

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

sms_verification_message str

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

software_token_mfa_configuration Dict[UserPoolSoftwareTokenMfaConfiguration]

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

tags Dict[str, str]

A map of tags to assign to the User Pool.

user_pool_add_ons Dict[UserPoolUserPoolAddOns]

Configuration block for user pool add-ons to enable user pool advanced security mode features.

username_attributes List[str]

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

username_configuration Dict[UserPoolUsernameConfiguration]

The Username Configuration.

verification_message_template Dict[UserPoolVerificationMessageTemplate]

The verification message templates configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPool resource produces the following output properties:

Arn string

The ARN of the user pool.

CreationDate string

The date the user pool was created.

Endpoint string

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

Id string
The provider-assigned unique ID for this managed resource.
LastModifiedDate string

The date the user pool was last modified.

Arn string

The ARN of the user pool.

CreationDate string

The date the user pool was created.

Endpoint string

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

Id string
The provider-assigned unique ID for this managed resource.
LastModifiedDate string

The date the user pool was last modified.

arn string

The ARN of the user pool.

creationDate string

The date the user pool was created.

endpoint string

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

id string
The provider-assigned unique ID for this managed resource.
lastModifiedDate string

The date the user pool was last modified.

arn str

The ARN of the user pool.

creation_date str

The date the user pool was created.

endpoint str

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

id str
The provider-assigned unique ID for this managed resource.
last_modified_date str

The date the user pool was last modified.

Look up an Existing UserPool Resource

Get an existing UserPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserPoolState, opts?: CustomResourceOptions): UserPool
static get(resource_name, id, opts=None, admin_create_user_config=None, alias_attributes=None, arn=None, auto_verified_attributes=None, creation_date=None, device_configuration=None, email_configuration=None, email_verification_message=None, email_verification_subject=None, endpoint=None, lambda_config=None, last_modified_date=None, mfa_configuration=None, name=None, password_policy=None, schemas=None, sms_authentication_message=None, sms_configuration=None, sms_verification_message=None, software_token_mfa_configuration=None, tags=None, user_pool_add_ons=None, username_attributes=None, username_configuration=None, verification_message_template=None, __props__=None);
func GetUserPool(ctx *Context, name string, id IDInput, state *UserPoolState, opts ...ResourceOption) (*UserPool, error)
public static UserPool Get(string name, Input<string> id, UserPoolState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AdminCreateUserConfig UserPoolAdminCreateUserConfigArgs

The configuration for AdminCreateUser requests.

AliasAttributes List<string>

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

Arn string

The ARN of the user pool.

AutoVerifiedAttributes List<string>

The attributes to be auto-verified. Possible values: email, phone_number.

CreationDate string

The date the user pool was created.

DeviceConfiguration UserPoolDeviceConfigurationArgs

The configuration for the user pool’s device tracking.

EmailConfiguration UserPoolEmailConfigurationArgs

The Email Configuration.

EmailVerificationMessage string

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

EmailVerificationSubject string

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

Endpoint string

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

LambdaConfig UserPoolLambdaConfigArgs

A container for the AWS Lambda triggers associated with the user pool.

LastModifiedDate string

The date the user pool was last modified.

MfaConfiguration string

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

Name string

The name of the attribute.

PasswordPolicy UserPoolPasswordPolicyArgs

A container for information about the user pool password policy.

Schemas List<UserPoolSchemaArgs>

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

SmsAuthenticationMessage string

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

SmsConfiguration UserPoolSmsConfigurationArgs

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

SmsVerificationMessage string

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfigurationArgs

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

Tags Dictionary<string, string>

A map of tags to assign to the User Pool.

UserPoolAddOns UserPoolUserPoolAddOnsArgs

Configuration block for user pool add-ons to enable user pool advanced security mode features.

UsernameAttributes List<string>

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

UsernameConfiguration UserPoolUsernameConfigurationArgs

The Username Configuration.

VerificationMessageTemplate UserPoolVerificationMessageTemplateArgs

The verification message templates configuration.

AdminCreateUserConfig UserPoolAdminCreateUserConfig

The configuration for AdminCreateUser requests.

AliasAttributes []string

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

Arn string

The ARN of the user pool.

AutoVerifiedAttributes []string

The attributes to be auto-verified. Possible values: email, phone_number.

CreationDate string

The date the user pool was created.

DeviceConfiguration UserPoolDeviceConfiguration

The configuration for the user pool’s device tracking.

EmailConfiguration UserPoolEmailConfiguration

The Email Configuration.

EmailVerificationMessage string

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

EmailVerificationSubject string

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

Endpoint string

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

LambdaConfig UserPoolLambdaConfig

A container for the AWS Lambda triggers associated with the user pool.

LastModifiedDate string

The date the user pool was last modified.

MfaConfiguration string

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

Name string

The name of the attribute.

PasswordPolicy UserPoolPasswordPolicy

A container for information about the user pool password policy.

Schemas []UserPoolSchema

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

SmsAuthenticationMessage string

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

SmsConfiguration UserPoolSmsConfiguration

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

SmsVerificationMessage string

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

SoftwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfiguration

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

Tags map[string]string

A map of tags to assign to the User Pool.

UserPoolAddOns UserPoolUserPoolAddOns

Configuration block for user pool add-ons to enable user pool advanced security mode features.

UsernameAttributes []string

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

UsernameConfiguration UserPoolUsernameConfiguration

The Username Configuration.

VerificationMessageTemplate UserPoolVerificationMessageTemplate

The verification message templates configuration.

adminCreateUserConfig UserPoolAdminCreateUserConfig

The configuration for AdminCreateUser requests.

aliasAttributes string[]

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

arn string

The ARN of the user pool.

autoVerifiedAttributes string[]

The attributes to be auto-verified. Possible values: email, phone_number.

creationDate string

The date the user pool was created.

deviceConfiguration UserPoolDeviceConfiguration

The configuration for the user pool’s device tracking.

emailConfiguration UserPoolEmailConfiguration

The Email Configuration.

emailVerificationMessage string

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

emailVerificationSubject string

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

endpoint string

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

lambdaConfig UserPoolLambdaConfig

A container for the AWS Lambda triggers associated with the user pool.

lastModifiedDate string

The date the user pool was last modified.

mfaConfiguration string

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

name string

The name of the attribute.

passwordPolicy UserPoolPasswordPolicy

A container for information about the user pool password policy.

schemas UserPoolSchema[]

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

smsAuthenticationMessage string

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

smsConfiguration UserPoolSmsConfiguration

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

smsVerificationMessage string

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

softwareTokenMfaConfiguration UserPoolSoftwareTokenMfaConfiguration

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

tags {[key: string]: string}

A map of tags to assign to the User Pool.

userPoolAddOns UserPoolUserPoolAddOns

Configuration block for user pool add-ons to enable user pool advanced security mode features.

usernameAttributes string[]

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

usernameConfiguration UserPoolUsernameConfiguration

The Username Configuration.

verificationMessageTemplate UserPoolVerificationMessageTemplate

The verification message templates configuration.

admin_create_user_config Dict[UserPoolAdminCreateUserConfig]

The configuration for AdminCreateUser requests.

alias_attributes List[str]

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. Conflicts with username_attributes.

arn str

The ARN of the user pool.

auto_verified_attributes List[str]

The attributes to be auto-verified. Possible values: email, phone_number.

creation_date str

The date the user pool was created.

device_configuration Dict[UserPoolDeviceConfiguration]

The configuration for the user pool’s device tracking.

email_configuration Dict[UserPoolEmailConfiguration]

The Email Configuration.

email_verification_message str

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

email_verification_subject str

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

endpoint str

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

lambda_config Dict[UserPoolLambdaConfig]

A container for the AWS Lambda triggers associated with the user pool.

last_modified_date str

The date the user pool was last modified.

mfa_configuration str

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

name str

The name of the attribute.

password_policy Dict[UserPoolPasswordPolicy]

A container for information about the user pool password policy.

schemas List[UserPoolSchema]

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

sms_authentication_message str

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

sms_configuration Dict[UserPoolSmsConfiguration]

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use –replace.

sms_verification_message str

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

software_token_mfa_configuration Dict[UserPoolSoftwareTokenMfaConfiguration]

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

tags Dict[str, str]

A map of tags to assign to the User Pool.

user_pool_add_ons Dict[UserPoolUserPoolAddOns]

Configuration block for user pool add-ons to enable user pool advanced security mode features.

username_attributes List[str]

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with alias_attributes.

username_configuration Dict[UserPoolUsernameConfiguration]

The Username Configuration.

verification_message_template Dict[UserPoolVerificationMessageTemplate]

The verification message templates configuration.

Supporting Types

UserPoolAdminCreateUserConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AllowAdminCreateUserOnly bool

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.

InviteMessageTemplate UserPoolAdminCreateUserConfigInviteMessageTemplateArgs

The invite message template structure.

UnusedAccountValidityDays int

DEPRECATED Use password_policy.temporary_password_validity_days instead - The user account expiration limit, in days, after which the account is no longer usable.

Deprecated: Use password_policy.temporary_password_validity_days instead

AllowAdminCreateUserOnly bool

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.

InviteMessageTemplate UserPoolAdminCreateUserConfigInviteMessageTemplate

The invite message template structure.

UnusedAccountValidityDays int

DEPRECATED Use password_policy.temporary_password_validity_days instead - The user account expiration limit, in days, after which the account is no longer usable.

Deprecated: Use password_policy.temporary_password_validity_days instead

allowAdminCreateUserOnly boolean

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.

inviteMessageTemplate UserPoolAdminCreateUserConfigInviteMessageTemplate

The invite message template structure.

unusedAccountValidityDays number

DEPRECATED Use password_policy.temporary_password_validity_days instead - The user account expiration limit, in days, after which the account is no longer usable.

Deprecated: Use password_policy.temporary_password_validity_days instead

allowAdminCreateUserOnly bool

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.

inviteMessageTemplate Dict[UserPoolAdminCreateUserConfigInviteMessageTemplate]

The invite message template structure.

unusedAccountValidityDays float

DEPRECATED Use password_policy.temporary_password_validity_days instead - The user account expiration limit, in days, after which the account is no longer usable.

Deprecated: Use password_policy.temporary_password_validity_days instead

UserPoolAdminCreateUserConfigInviteMessageTemplate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

EmailMessage string

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

EmailSubject string

The subject line for the email message template. Conflicts with email_verification_subject argument.

SmsMessage string

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

EmailMessage string

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

EmailSubject string

The subject line for the email message template. Conflicts with email_verification_subject argument.

SmsMessage string

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

emailMessage string

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

emailSubject string

The subject line for the email message template. Conflicts with email_verification_subject argument.

smsMessage string

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

emailMessage str

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

emailSubject str

The subject line for the email message template. Conflicts with email_verification_subject argument.

smsMessage str

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

UserPoolDeviceConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ChallengeRequiredOnNewDevice bool

Indicates whether a challenge is required on a new device. Only applicable to a new device.

DeviceOnlyRememberedOnUserPrompt bool

If true, a device is only remembered on user prompt.

ChallengeRequiredOnNewDevice bool

Indicates whether a challenge is required on a new device. Only applicable to a new device.

DeviceOnlyRememberedOnUserPrompt bool

If true, a device is only remembered on user prompt.

challengeRequiredOnNewDevice boolean

Indicates whether a challenge is required on a new device. Only applicable to a new device.

deviceOnlyRememberedOnUserPrompt boolean

If true, a device is only remembered on user prompt.

challengeRequiredOnNewDevice bool

Indicates whether a challenge is required on a new device. Only applicable to a new device.

deviceOnlyRememberedOnUserPrompt bool

If true, a device is only remembered on user prompt.

UserPoolEmailConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

EmailSendingAccount string

The email delivery method to use. COGNITO_DEFAULT for the default email functionality built into Cognito or DEVELOPER to use your Amazon SES configuration.

FromEmailAddress string

Sender’s email address or sender’s display name with their email address (e.g. john@example.com, John Smith <john@example.com> or \"John Smith Ph.D.\" <john@example.com>). Escaped double quotes are required around display names that contain certain characters as specified in RFC 5322.

ReplyToEmailAddress string

The REPLY-TO email address.

SourceArn string

The ARN of the SES verified email identity to to use. Required if email_sending_account is set to DEVELOPER.

EmailSendingAccount string

The email delivery method to use. COGNITO_DEFAULT for the default email functionality built into Cognito or DEVELOPER to use your Amazon SES configuration.

FromEmailAddress string

Sender’s email address or sender’s display name with their email address (e.g. john@example.com, John Smith <john@example.com> or \"John Smith Ph.D.\" <john@example.com>). Escaped double quotes are required around display names that contain certain characters as specified in RFC 5322.

ReplyToEmailAddress string

The REPLY-TO email address.

SourceArn string

The ARN of the SES verified email identity to to use. Required if email_sending_account is set to DEVELOPER.

emailSendingAccount string

The email delivery method to use. COGNITO_DEFAULT for the default email functionality built into Cognito or DEVELOPER to use your Amazon SES configuration.

fromEmailAddress string

Sender’s email address or sender’s display name with their email address (e.g. john@example.com, John Smith <john@example.com> or \"John Smith Ph.D.\" <john@example.com>). Escaped double quotes are required around display names that contain certain characters as specified in RFC 5322.

replyToEmailAddress string

The REPLY-TO email address.

sourceArn string

The ARN of the SES verified email identity to to use. Required if email_sending_account is set to DEVELOPER.

emailSendingAccount str

The email delivery method to use. COGNITO_DEFAULT for the default email functionality built into Cognito or DEVELOPER to use your Amazon SES configuration.

fromEmailAddress str

Sender’s email address or sender’s display name with their email address (e.g. john@example.com, John Smith <john@example.com> or \"John Smith Ph.D.\" <john@example.com>). Escaped double quotes are required around display names that contain certain characters as specified in RFC 5322.

replyToEmailAddress str

The REPLY-TO email address.

source_arn str

The ARN of the SES verified email identity to to use. Required if email_sending_account is set to DEVELOPER.

UserPoolLambdaConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CreateAuthChallenge string

The ARN of the lambda creating an authentication challenge.

CustomMessage string

A custom Message AWS Lambda trigger.

DefineAuthChallenge string

Defines the authentication challenge.

PostAuthentication string

A post-authentication AWS Lambda trigger.

PostConfirmation string

A post-confirmation AWS Lambda trigger.

PreAuthentication string

A pre-authentication AWS Lambda trigger.

PreSignUp string

A pre-registration AWS Lambda trigger.

PreTokenGeneration string

Allow to customize identity token claims before token generation.

UserMigration string

The user migration Lambda config type.

VerifyAuthChallengeResponse string

Verifies the authentication challenge response.

CreateAuthChallenge string

The ARN of the lambda creating an authentication challenge.

CustomMessage string

A custom Message AWS Lambda trigger.

DefineAuthChallenge string

Defines the authentication challenge.

PostAuthentication string

A post-authentication AWS Lambda trigger.

PostConfirmation string

A post-confirmation AWS Lambda trigger.

PreAuthentication string

A pre-authentication AWS Lambda trigger.

PreSignUp string

A pre-registration AWS Lambda trigger.

PreTokenGeneration string

Allow to customize identity token claims before token generation.

UserMigration string

The user migration Lambda config type.

VerifyAuthChallengeResponse string

Verifies the authentication challenge response.

createAuthChallenge string

The ARN of the lambda creating an authentication challenge.

customMessage string

A custom Message AWS Lambda trigger.

defineAuthChallenge string

Defines the authentication challenge.

postAuthentication string

A post-authentication AWS Lambda trigger.

postConfirmation string

A post-confirmation AWS Lambda trigger.

preAuthentication string

A pre-authentication AWS Lambda trigger.

preSignUp string

A pre-registration AWS Lambda trigger.

preTokenGeneration string

Allow to customize identity token claims before token generation.

userMigration string

The user migration Lambda config type.

verifyAuthChallengeResponse string

Verifies the authentication challenge response.

createAuthChallenge str

The ARN of the lambda creating an authentication challenge.

customMessage str

A custom Message AWS Lambda trigger.

defineAuthChallenge str

Defines the authentication challenge.

postAuthentication str

A post-authentication AWS Lambda trigger.

postConfirmation str

A post-confirmation AWS Lambda trigger.

preAuthentication str

A pre-authentication AWS Lambda trigger.

preSignUp str

A pre-registration AWS Lambda trigger.

preTokenGeneration str

Allow to customize identity token claims before token generation.

userMigration str

The user migration Lambda config type.

verifyAuthChallengeResponse str

Verifies the authentication challenge response.

UserPoolPasswordPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

MinimumLength int

The minimum length of the password policy that you have set.

RequireLowercase bool

Whether you have required users to use at least one lowercase letter in their password.

RequireNumbers bool

Whether you have required users to use at least one number in their password.

RequireSymbols bool

Whether you have required users to use at least one symbol in their password.

RequireUppercase bool

Whether you have required users to use at least one uppercase letter in their password.

TemporaryPasswordValidityDays int

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.

MinimumLength int

The minimum length of the password policy that you have set.

RequireLowercase bool

Whether you have required users to use at least one lowercase letter in their password.

RequireNumbers bool

Whether you have required users to use at least one number in their password.

RequireSymbols bool

Whether you have required users to use at least one symbol in their password.

RequireUppercase bool

Whether you have required users to use at least one uppercase letter in their password.

TemporaryPasswordValidityDays int

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.

minimumLength number

The minimum length of the password policy that you have set.

requireLowercase boolean

Whether you have required users to use at least one lowercase letter in their password.

requireNumbers boolean

Whether you have required users to use at least one number in their password.

requireSymbols boolean

Whether you have required users to use at least one symbol in their password.

requireUppercase boolean

Whether you have required users to use at least one uppercase letter in their password.

temporaryPasswordValidityDays number

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.

minimumLength float

The minimum length of the password policy that you have set.

requireLowercase bool

Whether you have required users to use at least one lowercase letter in their password.

requireUppercase bool

Whether you have required users to use at least one uppercase letter in their password.

require_numbers bool

Whether you have required users to use at least one number in their password.

require_symbols bool

Whether you have required users to use at least one symbol in their password.

temporaryPasswordValidityDays float

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.

UserPoolSchema

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AttributeDataType string

The attribute data type. Must be one of Boolean, Number, String, DateTime.

Name string

The name of the attribute.

DeveloperOnlyAttribute bool

Specifies whether the attribute type is developer only.

Mutable bool

Specifies whether the attribute can be changed once it has been created.

NumberAttributeConstraints UserPoolSchemaNumberAttributeConstraintsArgs

Specifies the constraints for an attribute of the number type.

Required bool

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

StringAttributeConstraints UserPoolSchemaStringAttributeConstraintsArgs

-Specifies the constraints for an attribute of the string type.

AttributeDataType string

The attribute data type. Must be one of Boolean, Number, String, DateTime.

Name string

The name of the attribute.

DeveloperOnlyAttribute bool

Specifies whether the attribute type is developer only.

Mutable bool

Specifies whether the attribute can be changed once it has been created.

NumberAttributeConstraints UserPoolSchemaNumberAttributeConstraints

Specifies the constraints for an attribute of the number type.

Required bool

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

StringAttributeConstraints UserPoolSchemaStringAttributeConstraints

-Specifies the constraints for an attribute of the string type.

attributeDataType string

The attribute data type. Must be one of Boolean, Number, String, DateTime.

name string

The name of the attribute.

developerOnlyAttribute boolean

Specifies whether the attribute type is developer only.

mutable boolean

Specifies whether the attribute can be changed once it has been created.

numberAttributeConstraints UserPoolSchemaNumberAttributeConstraints

Specifies the constraints for an attribute of the number type.

required boolean

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

stringAttributeConstraints UserPoolSchemaStringAttributeConstraints

-Specifies the constraints for an attribute of the string type.

attributeDataType str

The attribute data type. Must be one of Boolean, Number, String, DateTime.

name str

The name of the attribute.

developerOnlyAttribute bool

Specifies whether the attribute type is developer only.

mutable bool

Specifies whether the attribute can be changed once it has been created.

numberAttributeConstraints Dict[UserPoolSchemaNumberAttributeConstraints]

Specifies the constraints for an attribute of the number type.

required bool

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

stringAttributeConstraints Dict[UserPoolSchemaStringAttributeConstraints]

-Specifies the constraints for an attribute of the string type.

UserPoolSchemaNumberAttributeConstraints

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

MaxValue string

The maximum value of an attribute that is of the number data type.

MinValue string

The minimum value of an attribute that is of the number data type.

MaxValue string

The maximum value of an attribute that is of the number data type.

MinValue string

The minimum value of an attribute that is of the number data type.

maxValue string

The maximum value of an attribute that is of the number data type.

minValue string

The minimum value of an attribute that is of the number data type.

maxValue str

The maximum value of an attribute that is of the number data type.

minValue str

The minimum value of an attribute that is of the number data type.

UserPoolSchemaStringAttributeConstraints

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

MaxLength string

The maximum length of an attribute value of the string type.

MinLength string

The minimum length of an attribute value of the string type.

MaxLength string

The maximum length of an attribute value of the string type.

MinLength string

The minimum length of an attribute value of the string type.

maxLength string

The maximum length of an attribute value of the string type.

minLength string

The minimum length of an attribute value of the string type.

maxLength str

The maximum length of an attribute value of the string type.

minLength str

The minimum length of an attribute value of the string type.

UserPoolSmsConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ExternalId string

The external ID used in IAM role trust relationships. For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party.

SnsCallerArn string

The ARN of the Amazon SNS caller. This is usually the IAM role that you’ve given Cognito permission to assume.

ExternalId string

The external ID used in IAM role trust relationships. For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party.

SnsCallerArn string

The ARN of the Amazon SNS caller. This is usually the IAM role that you’ve given Cognito permission to assume.

externalId string

The external ID used in IAM role trust relationships. For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party.

snsCallerArn string

The ARN of the Amazon SNS caller. This is usually the IAM role that you’ve given Cognito permission to assume.

externalId str

The external ID used in IAM role trust relationships. For more information about using external IDs, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party.

snsCallerArn str

The ARN of the Amazon SNS caller. This is usually the IAM role that you’ve given Cognito permission to assume.

UserPoolSoftwareTokenMfaConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled bool

Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA when sms_configuration is not present, the mfa_configuration argument must be set to OFF and the software_token_mfa_configuration configuration block must be fully removed.

Enabled bool

Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA when sms_configuration is not present, the mfa_configuration argument must be set to OFF and the software_token_mfa_configuration configuration block must be fully removed.

enabled boolean

Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA when sms_configuration is not present, the mfa_configuration argument must be set to OFF and the software_token_mfa_configuration configuration block must be fully removed.

enabled bool

Boolean whether to enable software token Multi-Factor (MFA) tokens, such as Time-based One-Time Password (TOTP). To disable software token MFA when sms_configuration is not present, the mfa_configuration argument must be set to OFF and the software_token_mfa_configuration configuration block must be fully removed.

UserPoolUserPoolAddOns

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AdvancedSecurityMode string

The mode for advanced security, must be one of OFF, AUDIT or ENFORCED.

AdvancedSecurityMode string

The mode for advanced security, must be one of OFF, AUDIT or ENFORCED.

advancedSecurityMode string

The mode for advanced security, must be one of OFF, AUDIT or ENFORCED.

advancedSecurityMode str

The mode for advanced security, must be one of OFF, AUDIT or ENFORCED.

UserPoolUsernameConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CaseSensitive bool

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

CaseSensitive bool

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

caseSensitive boolean

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

caseSensitive bool

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

UserPoolVerificationMessageTemplate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DefaultEmailOption string

The default email option. Must be either CONFIRM_WITH_CODE or CONFIRM_WITH_LINK. Defaults to CONFIRM_WITH_CODE.

EmailMessage string

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

EmailMessageByLink string

The email message template for sending a confirmation link to the user, it must contain the {##Click Here##} placeholder.

EmailSubject string

The subject line for the email message template. Conflicts with email_verification_subject argument.

EmailSubjectByLink string

The subject line for the email message template for sending a confirmation link to the user.

SmsMessage string

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

DefaultEmailOption string

The default email option. Must be either CONFIRM_WITH_CODE or CONFIRM_WITH_LINK. Defaults to CONFIRM_WITH_CODE.

EmailMessage string

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

EmailMessageByLink string

The email message template for sending a confirmation link to the user, it must contain the {##Click Here##} placeholder.

EmailSubject string

The subject line for the email message template. Conflicts with email_verification_subject argument.

EmailSubjectByLink string

The subject line for the email message template for sending a confirmation link to the user.

SmsMessage string

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

defaultEmailOption string

The default email option. Must be either CONFIRM_WITH_CODE or CONFIRM_WITH_LINK. Defaults to CONFIRM_WITH_CODE.

emailMessage string

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

emailMessageByLink string

The email message template for sending a confirmation link to the user, it must contain the {##Click Here##} placeholder.

emailSubject string

The subject line for the email message template. Conflicts with email_verification_subject argument.

emailSubjectByLink string

The subject line for the email message template for sending a confirmation link to the user.

smsMessage string

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

defaultEmailOption str

The default email option. Must be either CONFIRM_WITH_CODE or CONFIRM_WITH_LINK. Defaults to CONFIRM_WITH_CODE.

emailMessage str

The email message template. Must contain the {####} placeholder. Conflicts with email_verification_message argument.

emailMessageByLink str

The email message template for sending a confirmation link to the user, it must contain the {##Click Here##} placeholder.

emailSubject str

The subject line for the email message template. Conflicts with email_verification_subject argument.

emailSubjectByLink str

The subject line for the email message template for sending a confirmation link to the user.

smsMessage str

The SMS message template. Must contain the {####} placeholder. Conflicts with sms_verification_message argument.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.