AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cognito.getUserPool

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getUserPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUserPool(args: GetUserPoolArgs, opts?: InvokeOptions): Promise<GetUserPoolResult>
function getUserPoolOutput(args: GetUserPoolOutputArgs, opts?: InvokeOptions): Output<GetUserPoolResult>

def get_user_pool(user_pool_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUserPoolResult
def get_user_pool_output(user_pool_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolResult]

func LookupUserPool(ctx *Context, args *LookupUserPoolArgs, opts ...InvokeOption) (*LookupUserPoolResult, error)
func LookupUserPoolOutput(ctx *Context, args *LookupUserPoolOutputArgs, opts ...InvokeOption) LookupUserPoolResultOutput

> Note: This function is named LookupUserPool in the Go SDK.

public static class GetUserPool 
{
    public static Task<GetUserPoolResult> InvokeAsync(GetUserPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolResult> Invoke(GetUserPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUserPoolResult> getUserPool(GetUserPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:cognito:getUserPool
  arguments:
    # arguments dictionary

The following arguments are supported:

UserPoolId string: The ID of the user pool.

UserPoolId string: The ID of the user pool.

userPoolId String: The ID of the user pool.

userPoolId string: The ID of the user pool.

user_pool_id str: The ID of the user pool.

userPoolId String: The ID of the user pool.

getUserPool Result

The following output properties are available:

AccountRecoverySetting Pulumi.AwsNative.Cognito.Outputs.UserPoolAccountRecoverySetting

The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

AdminCreateUserConfig Pulumi.AwsNative.Cognito.Outputs.UserPoolAdminCreateUserConfig

The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

AliasAttributes List<string>

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

Arn string

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

AutoVerifiedAttributes List<string>

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

DeletionProtection string

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

DeviceConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolDeviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

EmailAuthenticationMessage string

EmailAuthenticationSubject string

EmailConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolEmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

EmailVerificationMessage string

This parameter is no longer used. See VerificationMessageTemplateType .

EmailVerificationSubject string

This parameter is no longer used. See VerificationMessageTemplateType .

LambdaConfig Pulumi.AwsNative.Cognito.Outputs.UserPoolLambdaConfig

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

MfaConfiguration string

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Policies Pulumi.AwsNative.Cognito.Outputs.UserPoolPolicies

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

ProviderName string

A friendly name for the IdP.

ProviderUrl string

The URL of the provider of the Amazon Cognito user pool, specified as a String .

Schema List<Pulumi.AwsNative.Cognito.Outputs.UserPoolSchemaAttribute>

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

SmsAuthenticationMessage string

The contents of the SMS authentication message.

SmsConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolSmsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account .

SmsVerificationMessage string

This parameter is no longer used. See VerificationMessageTemplateType .

UserAttributeUpdateSettings Pulumi.AwsNative.Cognito.Outputs.UserPoolUserAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

UserPoolAddOns Pulumi.AwsNative.Cognito.Outputs.UserPoolAddOns

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT . To configure automatic security responses to risky traffic to your user pool, set to ENFORCED .

For more information, see Adding advanced security to a user pool .

UserPoolId string

The ID of the user pool.

UserPoolName string

A string used to name the user pool.

UserPoolTags Dictionary<string, string>

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

UsernameAttributes List<string>

Specifies whether a user can use an email address or phone number as a username when they sign up.

UsernameConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolUsernameConfiguration

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

VerificationMessageTemplate Pulumi.AwsNative.Cognito.Outputs.UserPoolVerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK , specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE , specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

AccountRecoverySetting UserPoolAccountRecoverySetting

AdminCreateUserConfig UserPoolAdminCreateUserConfig

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

AliasAttributes []string

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

Arn string

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

AutoVerifiedAttributes []string

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

DeletionProtection string

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

DeviceConfiguration UserPoolDeviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

EmailAuthenticationMessage string

EmailAuthenticationSubject string

EmailConfiguration UserPoolEmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

EmailVerificationMessage string

This parameter is no longer used. See VerificationMessageTemplateType .

EmailVerificationSubject string

This parameter is no longer used. See VerificationMessageTemplateType .

LambdaConfig UserPoolLambdaConfig

MfaConfiguration string

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Policies UserPoolPolicies

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

ProviderName string

A friendly name for the IdP.

ProviderUrl string

The URL of the provider of the Amazon Cognito user pool, specified as a String .

Schema []UserPoolSchemaAttribute

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

SmsAuthenticationMessage string

The contents of the SMS authentication message.

SmsConfiguration UserPoolSmsConfiguration

SmsVerificationMessage string

This parameter is no longer used. See VerificationMessageTemplateType .

UserAttributeUpdateSettings UserPoolUserAttributeUpdateSettings

UserPoolAddOns UserPoolAddOns

For more information, see Adding advanced security to a user pool .

UserPoolId string

The ID of the user pool.

UserPoolName string

A string used to name the user pool.

UserPoolTags map[string]string

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

UsernameAttributes []string

Specifies whether a user can use an email address or phone number as a username when they sign up.

UsernameConfiguration UserPoolUsernameConfiguration

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

VerificationMessageTemplate UserPoolVerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

accountRecoverySetting UserPoolAccountRecoverySetting

adminCreateUserConfig UserPoolAdminCreateUserConfig

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

aliasAttributes List<String>

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

arn String

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

autoVerifiedAttributes List<String>

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

deletionProtection String

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

deviceConfiguration UserPoolDeviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

emailAuthenticationMessage String

emailAuthenticationSubject String

emailConfiguration UserPoolEmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

emailVerificationMessage String

This parameter is no longer used. See VerificationMessageTemplateType .

emailVerificationSubject String

This parameter is no longer used. See VerificationMessageTemplateType .

lambdaConfig UserPoolLambdaConfig

mfaConfiguration String

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

policies UserPoolPolicies

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

providerName String

A friendly name for the IdP.

providerUrl String

The URL of the provider of the Amazon Cognito user pool, specified as a String .

schema List<UserPoolSchemaAttribute>

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

smsAuthenticationMessage String

The contents of the SMS authentication message.

smsConfiguration UserPoolSmsConfiguration

smsVerificationMessage String

This parameter is no longer used. See VerificationMessageTemplateType .

userAttributeUpdateSettings UserPoolUserAttributeUpdateSettings

userPoolAddOns UserPoolAddOns

For more information, see Adding advanced security to a user pool .

userPoolId String

The ID of the user pool.

userPoolName String

A string used to name the user pool.

userPoolTags Map<String,String>

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

usernameAttributes List<String>

Specifies whether a user can use an email address or phone number as a username when they sign up.

usernameConfiguration UserPoolUsernameConfiguration

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

verificationMessageTemplate UserPoolVerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

accountRecoverySetting UserPoolAccountRecoverySetting

adminCreateUserConfig UserPoolAdminCreateUserConfig

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

aliasAttributes string[]

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

arn string

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

autoVerifiedAttributes string[]

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

deletionProtection string

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

deviceConfiguration UserPoolDeviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

emailAuthenticationMessage string

emailAuthenticationSubject string

emailConfiguration UserPoolEmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

emailVerificationMessage string

This parameter is no longer used. See VerificationMessageTemplateType .

emailVerificationSubject string

This parameter is no longer used. See VerificationMessageTemplateType .

lambdaConfig UserPoolLambdaConfig

mfaConfiguration string

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

policies UserPoolPolicies

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

providerName string

A friendly name for the IdP.

providerUrl string

The URL of the provider of the Amazon Cognito user pool, specified as a String .

schema UserPoolSchemaAttribute[]

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

smsAuthenticationMessage string

The contents of the SMS authentication message.

smsConfiguration UserPoolSmsConfiguration

smsVerificationMessage string

This parameter is no longer used. See VerificationMessageTemplateType .

userAttributeUpdateSettings UserPoolUserAttributeUpdateSettings

userPoolAddOns UserPoolAddOns

For more information, see Adding advanced security to a user pool .

userPoolId string

The ID of the user pool.

userPoolName string

A string used to name the user pool.

userPoolTags {[key: string]: string}

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

usernameAttributes string[]

Specifies whether a user can use an email address or phone number as a username when they sign up.

usernameConfiguration UserPoolUsernameConfiguration

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

verificationMessageTemplate UserPoolVerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

account_recovery_setting UserPoolAccountRecoverySetting

admin_create_user_config UserPoolAdminCreateUserConfig

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

alias_attributes Sequence[str]

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

arn str

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

auto_verified_attributes Sequence[str]

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

deletion_protection str

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

device_configuration UserPoolDeviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

email_authentication_message str

email_authentication_subject str

email_configuration UserPoolEmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

email_verification_message str

This parameter is no longer used. See VerificationMessageTemplateType .

email_verification_subject str

This parameter is no longer used. See VerificationMessageTemplateType .

lambda_config UserPoolLambdaConfig

mfa_configuration str

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

policies UserPoolPolicies

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

provider_name str

A friendly name for the IdP.

provider_url str

The URL of the provider of the Amazon Cognito user pool, specified as a String .

schema Sequence[UserPoolSchemaAttribute]

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

sms_authentication_message str

The contents of the SMS authentication message.

sms_configuration UserPoolSmsConfiguration

sms_verification_message str

This parameter is no longer used. See VerificationMessageTemplateType .

user_attribute_update_settings UserPoolUserAttributeUpdateSettings

user_pool_add_ons UserPoolAddOns

For more information, see Adding advanced security to a user pool .

user_pool_id str

The ID of the user pool.

user_pool_name str

A string used to name the user pool.

user_pool_tags Mapping[str, str]

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

username_attributes Sequence[str]

Specifies whether a user can use an email address or phone number as a username when they sign up.

username_configuration UserPoolUsernameConfiguration

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

verification_message_template UserPoolVerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

accountRecoverySetting Property Map

adminCreateUserConfig Property Map

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

aliasAttributes List<String>

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

arn String

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

autoVerifiedAttributes List<String>

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

deletionProtection String

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

deviceConfiguration Property Map

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

emailAuthenticationMessage String

emailAuthenticationSubject String

emailConfiguration Property Map

The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

emailVerificationMessage String

This parameter is no longer used. See VerificationMessageTemplateType .

emailVerificationSubject String

This parameter is no longer used. See VerificationMessageTemplateType .

lambdaConfig Property Map

mfaConfiguration String

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

policies Property Map

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

providerName String

A friendly name for the IdP.

providerUrl String

The URL of the provider of the Amazon Cognito user pool, specified as a String .

schema List<Property Map>

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

smsAuthenticationMessage String

The contents of the SMS authentication message.

smsConfiguration Property Map

smsVerificationMessage String

This parameter is no longer used. See VerificationMessageTemplateType .

userAttributeUpdateSettings Property Map

userPoolAddOns Property Map

For more information, see Adding advanced security to a user pool .

userPoolId String

The ID of the user pool.

userPoolName String

A string used to name the user pool.

userPoolTags Map<String>

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

usernameAttributes List<String>

Specifies whether a user can use an email address or phone number as a username when they sign up.

usernameConfiguration Property Map

This configuration is immutable after you set it. For more information, see UsernameConfigurationType .

verificationMessageTemplate Property Map

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Supporting Types

UserPoolAccountRecoverySetting

RecoveryMechanisms List<Pulumi.AwsNative.Cognito.Inputs.UserPoolRecoveryOption>: The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

RecoveryMechanisms []UserPoolRecoveryOption: The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

recoveryMechanisms List<UserPoolRecoveryOption>: The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

recoveryMechanisms UserPoolRecoveryOption[]: The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

recovery_mechanisms Sequence[UserPoolRecoveryOption]: The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

recoveryMechanisms List<Property Map>: The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

UserPoolAddOns

AdvancedSecurityAdditionalFlows Pulumi.AwsNative.Cognito.Inputs.UserPoolAdvancedSecurityAdditionalFlows
AdvancedSecurityMode string: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

AdvancedSecurityAdditionalFlows UserPoolAdvancedSecurityAdditionalFlows
AdvancedSecurityMode string: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

advancedSecurityAdditionalFlows UserPoolAdvancedSecurityAdditionalFlows
advancedSecurityMode String: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

advancedSecurityAdditionalFlows UserPoolAdvancedSecurityAdditionalFlows
advancedSecurityMode string: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

advanced_security_additional_flows UserPoolAdvancedSecurityAdditionalFlows
advanced_security_mode str: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

advancedSecurityAdditionalFlows Property Map
advancedSecurityMode String: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

UserPoolAdminCreateUserConfig

AllowAdminCreateUserOnly bool

The setting for allowing self-service sign-up. When true , only administrators can create new user profiles. When false , users can register themselves and create a new user profile with the SignUp operation.

InviteMessageTemplate Pulumi.AwsNative.Cognito.Inputs.UserPoolInviteMessageTemplate

The template for the welcome message to new users.

UnusedAccountValidityDays int

This parameter is no longer in use. Configure the duration of temporary passwords with the TemporaryPasswordValidityDays parameter of PasswordPolicyType . For older user pools that have a UnusedAccountValidityDays configuration, that value is effective until you set a value for TemporaryPasswordValidityDays .

The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. 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.

AllowAdminCreateUserOnly bool

InviteMessageTemplate UserPoolInviteMessageTemplate

The template for the welcome message to new users.

UnusedAccountValidityDays int

The default value for this parameter is 7.

allowAdminCreateUserOnly Boolean

inviteMessageTemplate UserPoolInviteMessageTemplate

The template for the welcome message to new users.

unusedAccountValidityDays Integer

The default value for this parameter is 7.

allowAdminCreateUserOnly boolean

inviteMessageTemplate UserPoolInviteMessageTemplate

The template for the welcome message to new users.

unusedAccountValidityDays number

The default value for this parameter is 7.

allow_admin_create_user_only bool

invite_message_template UserPoolInviteMessageTemplate

The template for the welcome message to new users.

unused_account_validity_days int

The default value for this parameter is 7.

allowAdminCreateUserOnly Boolean

inviteMessageTemplate Property Map

The template for the welcome message to new users.

unusedAccountValidityDays Number

The default value for this parameter is 7.

UserPoolAdvancedSecurityAdditionalFlows

CustomAuthMode string

CustomAuthMode string

customAuthMode String

customAuthMode string

custom_auth_mode str

customAuthMode String

UserPoolCustomEmailSender

LambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

LambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

LambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

LambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambdaArn String

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion String

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambda_arn str

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambda_version str

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambdaArn String

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion String

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

UserPoolCustomSmsSender

LambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

LambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

LambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

LambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambdaArn String

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion String

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambda_arn str

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambda_version str

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

lambdaArn String

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion String

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.

UserPoolDeviceConfiguration

ChallengeRequiredOnNewDevice bool

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.

DeviceOnlyRememberedOnUserPrompt bool

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice 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 API request.

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

ChallengeRequiredOnNewDevice bool

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.

DeviceOnlyRememberedOnUserPrompt bool

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

challengeRequiredOnNewDevice Boolean

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.

deviceOnlyRememberedOnUserPrompt Boolean

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

challengeRequiredOnNewDevice boolean

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.

deviceOnlyRememberedOnUserPrompt boolean

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

challenge_required_on_new_device bool

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.

device_only_remembered_on_user_prompt bool

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

challengeRequiredOnNewDevice Boolean

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.

deviceOnlyRememberedOnUserPrompt Boolean

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

UserPoolEmailConfiguration

ConfigurationSet string

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

Event publishing - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch
IP pool management - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

EmailSendingAccount string

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide .

The default FROM address is no-reply@verificationemail.com . To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role , which is a type of role in your AWS account . This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide .

From string

Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com> . This address appears before the body of the email.

ReplyToEmailAddress string

The destination to which the receiver of the email should reply.

SourceArn string

The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a SourceArn email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

The Region value of the SourceArn parameter must indicate a supported AWS Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide .

ConfigurationSet string

Event publishing - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch
IP pool management - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

EmailSendingAccount string

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide .

DEVELOPER - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

From string

ReplyToEmailAddress string

The destination to which the receiver of the email should reply.

SourceArn string

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

configurationSet String

Event publishing - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch
IP pool management - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

emailSendingAccount String

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide .

DEVELOPER - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

from String

replyToEmailAddress String

The destination to which the receiver of the email should reply.

sourceArn String

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

configurationSet string

Event publishing - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch
IP pool management - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

emailSendingAccount string

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide .

DEVELOPER - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

from string

replyToEmailAddress string

The destination to which the receiver of the email should reply.

sourceArn string

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

configuration_set str

Event publishing - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch
IP pool management - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

email_sending_account str

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide .

DEVELOPER - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

from_ str

reply_to_email_address str

The destination to which the receiver of the email should reply.

source_arn str

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

configurationSet String

Event publishing - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch
IP pool management - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

emailSendingAccount String

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide .

DEVELOPER - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

from String

replyToEmailAddress String

The destination to which the receiver of the email should reply.

sourceArn String

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

UserPoolInviteMessageTemplate

EmailMessage string: The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
EmailSubject string: The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
SmsMessage string: The message template for SMS messages.

EmailMessage string: The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
EmailSubject string: The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
SmsMessage string: The message template for SMS messages.

emailMessage String: The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
emailSubject String: The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
smsMessage String: The message template for SMS messages.

emailMessage string: The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
emailSubject string: The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
smsMessage string: The message template for SMS messages.

email_message str: The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
email_subject str: The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
sms_message str: The message template for SMS messages.

emailMessage String: The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
emailSubject String: The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
smsMessage String: The message template for SMS messages.

UserPoolLambdaConfig

CreateAuthChallenge string

The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

CustomEmailSender Pulumi.AwsNative.Cognito.Inputs.UserPoolCustomEmailSender

The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

CustomMessage string

A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.

CustomSmsSender Pulumi.AwsNative.Cognito.Inputs.UserPoolCustomSmsSender

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

DefineAuthChallenge string

The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

KmsKeyId string

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

PostAuthentication string

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

PostConfirmation string

The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

PreAuthentication string

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

PreSignUp string

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile , or block sign-up requests.

PreTokenGeneration string

The legacy configuration of a pre token generation Lambda trigger in a user pool.

Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig , its value must be identical to PreTokenGeneration . For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig .

PreTokenGenerationConfig Pulumi.AwsNative.Cognito.Inputs.UserPoolPreTokenGenerationConfig

The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

UserMigration string

The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

VerifyAuthChallengeResponse string

The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

CreateAuthChallenge string

The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

CustomEmailSender UserPoolCustomEmailSender

The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

CustomMessage string

CustomSmsSender UserPoolCustomSmsSender

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

DefineAuthChallenge string

The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

KmsKeyId string

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

PostAuthentication string

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

PostConfirmation string

The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

PreAuthentication string

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

PreSignUp string

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile , or block sign-up requests.

PreTokenGeneration string

The legacy configuration of a pre token generation Lambda trigger in a user pool.

PreTokenGenerationConfig UserPoolPreTokenGenerationConfig

The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

UserMigration string

The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

VerifyAuthChallengeResponse string

The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

createAuthChallenge String

The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

customEmailSender UserPoolCustomEmailSender

The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

customMessage String

customSmsSender UserPoolCustomSmsSender

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

defineAuthChallenge String

The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

kmsKeyId String

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

postAuthentication String

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

postConfirmation String

The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

preAuthentication String

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

preSignUp String

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile , or block sign-up requests.

preTokenGeneration String

The legacy configuration of a pre token generation Lambda trigger in a user pool.

preTokenGenerationConfig UserPoolPreTokenGenerationConfig

The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

userMigration String

The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

verifyAuthChallengeResponse String

The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

createAuthChallenge string

The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

customEmailSender UserPoolCustomEmailSender

The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

customMessage string

customSmsSender UserPoolCustomSmsSender

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

defineAuthChallenge string

The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

kmsKeyId string

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

postAuthentication string

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

postConfirmation string

The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

preAuthentication string

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

preSignUp string

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile , or block sign-up requests.

preTokenGeneration string

The legacy configuration of a pre token generation Lambda trigger in a user pool.

preTokenGenerationConfig UserPoolPreTokenGenerationConfig

The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

userMigration string

The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

verifyAuthChallengeResponse string

The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

create_auth_challenge str

The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

custom_email_sender UserPoolCustomEmailSender

The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

custom_message str

custom_sms_sender UserPoolCustomSmsSender

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

define_auth_challenge str

The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

kms_key_id str

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

post_authentication str

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

post_confirmation str

The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

pre_authentication str

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

pre_sign_up str

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile , or block sign-up requests.

pre_token_generation str

The legacy configuration of a pre token generation Lambda trigger in a user pool.

pre_token_generation_config UserPoolPreTokenGenerationConfig

The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

user_migration str

The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

verify_auth_challenge_response str

The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

createAuthChallenge String

The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

customEmailSender Property Map

The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

customMessage String

customSmsSender Property Map

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

defineAuthChallenge String

The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

kmsKeyId String

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

postAuthentication String

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

postConfirmation String

The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

preAuthentication String

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

preSignUp String

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile , or block sign-up requests.

preTokenGeneration String

The legacy configuration of a pre token generation Lambda trigger in a user pool.

preTokenGenerationConfig Property Map

The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

userMigration String

The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

verifyAuthChallengeResponse String

The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

UserPoolNumberAttributeConstraints

MaxValue string: The maximum length of a number attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
MinValue string: The minimum value of an attribute that is of the number data type.

MaxValue string: The maximum length of a number attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
MinValue string: The minimum value of an attribute that is of the number data type.

maxValue String: The maximum length of a number attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
minValue String: The minimum value of an attribute that is of the number data type.

maxValue string: The maximum length of a number attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
minValue string: The minimum value of an attribute that is of the number data type.

max_value str: The maximum length of a number attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
min_value str: The minimum value of an attribute that is of the number data type.

maxValue String: The maximum length of a number attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
minValue String: The minimum value of an attribute that is of the number data type.

UserPoolPasswordPolicy

MinimumLength int

The minimum length of the password in the policy that you have set. This value can't be less than 6.

PasswordHistorySize int

The 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 n previous passwords, where n is the value of PasswordHistorySize .

Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to 0 or don't provide it. To activate this setting, advanced security features must be active in your user pool.

RequireLowercase bool

The requirement in a password policy that users must include at least one lowercase letter in their password.

RequireNumbers bool

The requirement in a password policy that users must include at least one number in their password.

RequireSymbols bool

The requirement in a password policy that users must include at least one symbol in their password.

RequireUppercase bool

The requirement in a password policy that users must include at least one uppercase letter in their password.

TemporaryPasswordValidityDays int

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7 . If you submit a value of 0 , Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

MinimumLength int

The minimum length of the password in the policy that you have set. This value can't be less than 6.

PasswordHistorySize int

RequireLowercase bool

The requirement in a password policy that users must include at least one lowercase letter in their password.

RequireNumbers bool

The requirement in a password policy that users must include at least one number in their password.

RequireSymbols bool

The requirement in a password policy that users must include at least one symbol in their password.

RequireUppercase bool

The requirement in a password policy that users must include at least one uppercase letter in their password.

TemporaryPasswordValidityDays int

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

minimumLength Integer

The minimum length of the password in the policy that you have set. This value can't be less than 6.

passwordHistorySize Integer

requireLowercase Boolean

The requirement in a password policy that users must include at least one lowercase letter in their password.

requireNumbers Boolean

The requirement in a password policy that users must include at least one number in their password.

requireSymbols Boolean

The requirement in a password policy that users must include at least one symbol in their password.

requireUppercase Boolean

The requirement in a password policy that users must include at least one uppercase letter in their password.

temporaryPasswordValidityDays Integer

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

minimumLength number

The minimum length of the password in the policy that you have set. This value can't be less than 6.

passwordHistorySize number

requireLowercase boolean

The requirement in a password policy that users must include at least one lowercase letter in their password.

requireNumbers boolean

The requirement in a password policy that users must include at least one number in their password.

requireSymbols boolean

The requirement in a password policy that users must include at least one symbol in their password.

requireUppercase boolean

The requirement in a password policy that users must include at least one uppercase letter in their password.

temporaryPasswordValidityDays number

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

minimum_length int

The minimum length of the password in the policy that you have set. This value can't be less than 6.

password_history_size int

require_lowercase bool

The requirement in a password policy that users must include at least one lowercase letter in their password.

require_numbers bool

The requirement in a password policy that users must include at least one number in their password.

require_symbols bool

The requirement in a password policy that users must include at least one symbol in their password.

require_uppercase bool

The requirement in a password policy that users must include at least one uppercase letter in their password.

temporary_password_validity_days int

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

minimumLength Number

The minimum length of the password in the policy that you have set. This value can't be less than 6.

passwordHistorySize Number

requireLowercase Boolean

The requirement in a password policy that users must include at least one lowercase letter in their password.

requireNumbers Boolean

The requirement in a password policy that users must include at least one number in their password.

requireSymbols Boolean

The requirement in a password policy that users must include at least one symbol in their password.

requireUppercase Boolean

The requirement in a password policy that users must include at least one uppercase letter in their password.

temporaryPasswordValidityDays Number

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

UserPoolPolicies

PasswordPolicy Pulumi.AwsNative.Cognito.Inputs.UserPoolPasswordPolicy: The password policy settings for a user pool, including complexity, history, and length requirements.

PasswordPolicy UserPoolPasswordPolicy: The password policy settings for a user pool, including complexity, history, and length requirements.

passwordPolicy UserPoolPasswordPolicy: The password policy settings for a user pool, including complexity, history, and length requirements.

passwordPolicy UserPoolPasswordPolicy: The password policy settings for a user pool, including complexity, history, and length requirements.

password_policy UserPoolPasswordPolicy: The password policy settings for a user pool, including complexity, history, and length requirements.

passwordPolicy Property Map: The password policy settings for a user pool, including complexity, history, and length requirements.

UserPoolPreTokenGenerationConfig

LambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn .

LambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

LambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn .

LambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

lambdaArn String

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn .

lambdaVersion String

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

lambdaArn string

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn .

lambdaVersion string

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

lambda_arn str

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn .

lambda_version str

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

lambdaArn String

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn .

lambdaVersion String

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

UserPoolRecoveryOption

Name string: The recovery method that this object sets a recovery option for.
Priority int: Your priority preference for using the specified attribute in account recovery. The highest priority is 1 .

Name string: The recovery method that this object sets a recovery option for.
Priority int: Your priority preference for using the specified attribute in account recovery. The highest priority is 1 .

name String: The recovery method that this object sets a recovery option for.
priority Integer: Your priority preference for using the specified attribute in account recovery. The highest priority is 1 .

name string: The recovery method that this object sets a recovery option for.
priority number: Your priority preference for using the specified attribute in account recovery. The highest priority is 1 .

name str: The recovery method that this object sets a recovery option for.
priority int: Your priority preference for using the specified attribute in account recovery. The highest priority is 1 .

name String: The recovery method that this object sets a recovery option for.
priority Number: Your priority preference for using the specified attribute in account recovery. The highest priority is 1 .

UserPoolSchemaAttribute

AttributeDataType string

The data format of the values for your attribute. When you choose an AttributeDataType , Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example "custom:isMember" : "true" or "custom:YearsAsMember" : "12" .

DeveloperOnlyAttribute bool

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

Mutable bool

Specifies whether the value of the attribute can be changed.

Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true . Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .

Name string

The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a Name value of MyAttribute , Amazon Cognito creates the custom attribute custom:MyAttribute . When DeveloperOnlyAttribute is true , Amazon Cognito creates your attribute as dev:MyAttribute . In an operation that describes a user pool, Amazon Cognito returns this value as value for standard attributes, custom:value for custom attributes, and dev:value for developer-only attributes..

NumberAttributeConstraints Pulumi.AwsNative.Cognito.Inputs.UserPoolNumberAttributeConstraints

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 doesn't provide a value, registration or sign-in will fail.

StringAttributeConstraints Pulumi.AwsNative.Cognito.Inputs.UserPoolStringAttributeConstraints

Specifies the constraints for an attribute of the string type.

AttributeDataType string

DeveloperOnlyAttribute bool

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

Mutable bool

Specifies whether the value of the attribute can be changed.

Name string

NumberAttributeConstraints UserPoolNumberAttributeConstraints

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 doesn't provide a value, registration or sign-in will fail.

StringAttributeConstraints UserPoolStringAttributeConstraints

Specifies the constraints for an attribute of the string type.

attributeDataType String

developerOnlyAttribute Boolean

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

mutable Boolean

Specifies whether the value of the attribute can be changed.

name String

numberAttributeConstraints UserPoolNumberAttributeConstraints

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 doesn't provide a value, registration or sign-in will fail.

stringAttributeConstraints UserPoolStringAttributeConstraints

Specifies the constraints for an attribute of the string type.

attributeDataType string

developerOnlyAttribute boolean

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

mutable boolean

Specifies whether the value of the attribute can be changed.

name string

numberAttributeConstraints UserPoolNumberAttributeConstraints

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 doesn't provide a value, registration or sign-in will fail.

stringAttributeConstraints UserPoolStringAttributeConstraints

Specifies the constraints for an attribute of the string type.

attribute_data_type str

developer_only_attribute bool

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

mutable bool

Specifies whether the value of the attribute can be changed.

name str

number_attribute_constraints UserPoolNumberAttributeConstraints

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 doesn't provide a value, registration or sign-in will fail.

string_attribute_constraints UserPoolStringAttributeConstraints

Specifies the constraints for an attribute of the string type.

attributeDataType String

developerOnlyAttribute Boolean

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

mutable Boolean

Specifies whether the value of the attribute can be changed.

name String

numberAttributeConstraints Property Map

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 doesn't provide a value, registration or sign-in will fail.

stringAttributeConstraints Property Map

Specifies the constraints for an attribute of the string type.

UserPoolSmsConfiguration

ExternalId string

The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId , your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID . If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId .

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party .

SnsCallerArn string

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 .

SnsRegion string

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 .

ExternalId string

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party .

SnsCallerArn string

SnsRegion string

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 .

externalId String

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party .

snsCallerArn String

snsRegion String

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 .

externalId string

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party .

snsCallerArn string

snsRegion string

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 .

external_id str

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party .

sns_caller_arn str

sns_region str

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 .

externalId String

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party .

snsCallerArn String

snsRegion String

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 .

UserPoolStringAttributeConstraints

MaxLength string: The maximum length of a string attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
MinLength string: The minimum length of a string attribute value.

MaxLength string: The maximum length of a string attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
MinLength string: The minimum length of a string attribute value.

maxLength String: The maximum length of a string attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
minLength String: The minimum length of a string attribute value.

maxLength string: The maximum length of a string attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
minLength string: The minimum length of a string attribute value.

max_length str: The maximum length of a string attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
min_length str: The minimum length of a string attribute value.

maxLength String: The maximum length of a string attribute value. Must be a number less than or equal to 2^1023 , represented as a string with a length of 131072 characters or fewer.
minLength String: The minimum length of a string attribute value.

UserPoolUserAttributeUpdateSettings

AttributesRequireVerificationBeforeUpdate List<string>

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

AttributesRequireVerificationBeforeUpdate []string

attributesRequireVerificationBeforeUpdate List<String>

attributesRequireVerificationBeforeUpdate string[]

attributes_require_verification_before_update Sequence[str]

attributesRequireVerificationBeforeUpdate List<String>

UserPoolUsernameConfiguration

CaseSensitive bool

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.

Valid values include:

true - Enables case sensitivity for all username input. When this option is set to true , users must sign in using the exact capitalization of their given username, such as "UserName". This is the default value.
false - Enables case insensitivity for all username input. For example, when this option is set to false , users can sign in using username , USERNAME , or UserName . This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

CaseSensitive bool

Valid values include:

true - Enables case sensitivity for all username input. When this option is set to true , users must sign in using the exact capitalization of their given username, such as "UserName". This is the default value.
false - Enables case insensitivity for all username input. For example, when this option is set to false , users can sign in using username , USERNAME , or UserName . This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

caseSensitive Boolean

Valid values include:

true - Enables case sensitivity for all username input. When this option is set to true , users must sign in using the exact capitalization of their given username, such as "UserName". This is the default value.
false - Enables case insensitivity for all username input. For example, when this option is set to false , users can sign in using username , USERNAME , or UserName . This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

caseSensitive boolean

Valid values include:

true - Enables case sensitivity for all username input. When this option is set to true , users must sign in using the exact capitalization of their given username, such as "UserName". This is the default value.
false - Enables case insensitivity for all username input. For example, when this option is set to false , users can sign in using username , USERNAME , or UserName . This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

case_sensitive bool

Valid values include:

true - Enables case sensitivity for all username input. When this option is set to true , users must sign in using the exact capitalization of their given username, such as "UserName". This is the default value.
false - Enables case insensitivity for all username input. For example, when this option is set to false , users can sign in using username , USERNAME , or UserName . This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

caseSensitive Boolean

Valid values include:

true - Enables case sensitivity for all username input. When this option is set to true , users must sign in using the exact capitalization of their given username, such as "UserName". This is the default value.
false - Enables case insensitivity for all username input. For example, when this option is set to false , users can sign in using username , USERNAME , or UserName . This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

UserPoolVerificationMessageTemplate

DefaultEmailOption string

The configuration of verification emails to contain a clickable link or a verification code.

For link, your template body must contain link text in the format {##Click here##} . "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####} .

EmailMessage string

The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

EmailMessageByLink string

The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

EmailSubject string

The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

EmailSubjectByLink string

The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

SmsMessage string