AWS Native is in preview. AWS Classic is fully supported.
aws-native.cognito.UserPool
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::Cognito::UserPool
Create UserPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserPool(name: string, args?: UserPoolArgs, opts?: CustomResourceOptions);
@overload
def UserPool(resource_name: str,
args: Optional[UserPoolArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def UserPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_recovery_setting: Optional[UserPoolAccountRecoverySettingArgs] = None,
admin_create_user_config: Optional[UserPoolAdminCreateUserConfigArgs] = None,
alias_attributes: Optional[Sequence[str]] = None,
auto_verified_attributes: Optional[Sequence[str]] = None,
deletion_protection: Optional[str] = None,
device_configuration: Optional[UserPoolDeviceConfigurationArgs] = None,
email_configuration: Optional[UserPoolEmailConfigurationArgs] = None,
email_verification_message: Optional[str] = None,
email_verification_subject: Optional[str] = None,
enabled_mfas: Optional[Sequence[str]] = None,
lambda_config: Optional[UserPoolLambdaConfigArgs] = None,
mfa_configuration: Optional[str] = None,
policies: Optional[UserPoolPoliciesArgs] = None,
schema: Optional[Sequence[UserPoolSchemaAttributeArgs]] = None,
sms_authentication_message: Optional[str] = None,
sms_configuration: Optional[UserPoolSmsConfigurationArgs] = None,
sms_verification_message: Optional[str] = None,
user_attribute_update_settings: Optional[UserPoolUserAttributeUpdateSettingsArgs] = None,
user_pool_add_ons: Optional[UserPoolAddOnsArgs] = None,
user_pool_name: Optional[str] = None,
user_pool_tags: Optional[Mapping[str, str]] = None,
username_attributes: Optional[Sequence[str]] = None,
username_configuration: Optional[UserPoolUsernameConfigurationArgs] = None,
verification_message_template: Optional[UserPoolVerificationMessageTemplateArgs] = None)
func NewUserPool(ctx *Context, name string, args *UserPoolArgs, opts ...ResourceOption) (*UserPool, error)
public UserPool(string name, UserPoolArgs? args = null, CustomResourceOptions? opts = null)
public UserPool(String name, UserPoolArgs args)
public UserPool(String name, UserPoolArgs args, CustomResourceOptions options)
type: aws-native:cognito:UserPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UserPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UserPoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UserPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const userPoolResource = new aws_native.cognito.UserPool("userPoolResource", {
accountRecoverySetting: {
recoveryMechanisms: [{
name: "string",
priority: 0,
}],
},
adminCreateUserConfig: {
allowAdminCreateUserOnly: false,
inviteMessageTemplate: {
emailMessage: "string",
emailSubject: "string",
smsMessage: "string",
},
unusedAccountValidityDays: 0,
},
aliasAttributes: ["string"],
autoVerifiedAttributes: ["string"],
deletionProtection: "string",
deviceConfiguration: {
challengeRequiredOnNewDevice: false,
deviceOnlyRememberedOnUserPrompt: false,
},
emailConfiguration: {
configurationSet: "string",
emailSendingAccount: "string",
from: "string",
replyToEmailAddress: "string",
sourceArn: "string",
},
emailVerificationMessage: "string",
emailVerificationSubject: "string",
enabledMfas: ["string"],
lambdaConfig: {
createAuthChallenge: "string",
customEmailSender: {
lambdaArn: "string",
lambdaVersion: "string",
},
customMessage: "string",
customSmsSender: {
lambdaArn: "string",
lambdaVersion: "string",
},
defineAuthChallenge: "string",
kmsKeyId: "string",
postAuthentication: "string",
postConfirmation: "string",
preAuthentication: "string",
preSignUp: "string",
preTokenGeneration: "string",
preTokenGenerationConfig: {
lambdaArn: "string",
lambdaVersion: "string",
},
userMigration: "string",
verifyAuthChallengeResponse: "string",
},
mfaConfiguration: "string",
policies: {
passwordPolicy: {
minimumLength: 0,
requireLowercase: false,
requireNumbers: false,
requireSymbols: false,
requireUppercase: false,
temporaryPasswordValidityDays: 0,
},
},
schema: [{
attributeDataType: "string",
developerOnlyAttribute: false,
mutable: false,
name: "string",
numberAttributeConstraints: {
maxValue: "string",
minValue: "string",
},
required: false,
stringAttributeConstraints: {
maxLength: "string",
minLength: "string",
},
}],
smsAuthenticationMessage: "string",
smsConfiguration: {
externalId: "string",
snsCallerArn: "string",
snsRegion: "string",
},
smsVerificationMessage: "string",
userAttributeUpdateSettings: {
attributesRequireVerificationBeforeUpdate: ["string"],
},
userPoolAddOns: {
advancedSecurityMode: "string",
},
userPoolName: "string",
userPoolTags: {
string: "string",
},
usernameAttributes: ["string"],
usernameConfiguration: {
caseSensitive: false,
},
verificationMessageTemplate: {
defaultEmailOption: "string",
emailMessage: "string",
emailMessageByLink: "string",
emailSubject: "string",
emailSubjectByLink: "string",
smsMessage: "string",
},
});
Coming soon!
UserPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The UserPool resource accepts the following input properties:
- Account
Recovery Pulumi.Setting Aws Native. Cognito. Inputs. User Pool Account Recovery Setting - Admin
Create Pulumi.User Config Aws Native. Cognito. Inputs. User Pool Admin Create User Config - Alias
Attributes List<string> - Auto
Verified List<string>Attributes - Deletion
Protection string - Device
Configuration Pulumi.Aws Native. Cognito. Inputs. User Pool Device Configuration - Email
Configuration Pulumi.Aws Native. Cognito. Inputs. User Pool Email Configuration - Email
Verification stringMessage - Email
Verification stringSubject - Enabled
Mfas List<string> - Lambda
Config Pulumi.Aws Native. Cognito. Inputs. User Pool Lambda Config - Mfa
Configuration string - Policies
Pulumi.
Aws Native. Cognito. Inputs. User Pool Policies - Schema
List<Pulumi.
Aws Native. Cognito. Inputs. User Pool Schema Attribute> - Sms
Authentication stringMessage - Sms
Configuration Pulumi.Aws Native. Cognito. Inputs. User Pool Sms Configuration - Sms
Verification stringMessage - User
Attribute Pulumi.Update Settings Aws Native. Cognito. Inputs. User Pool User Attribute Update Settings - User
Pool Pulumi.Add Ons Aws Native. Cognito. Inputs. User Pool Add Ons - User
Pool stringName - Dictionary<string, string>
- Username
Attributes List<string> - Username
Configuration Pulumi.Aws Native. Cognito. Inputs. User Pool Username Configuration - Verification
Message Pulumi.Template Aws Native. Cognito. Inputs. User Pool Verification Message Template
- Account
Recovery UserSetting Pool Account Recovery Setting Args - Admin
Create UserUser Config Pool Admin Create User Config Args - Alias
Attributes []string - Auto
Verified []stringAttributes - Deletion
Protection string - Device
Configuration UserPool Device Configuration Args - Email
Configuration UserPool Email Configuration Args - Email
Verification stringMessage - Email
Verification stringSubject - Enabled
Mfas []string - Lambda
Config UserPool Lambda Config Args - Mfa
Configuration string - Policies
User
Pool Policies Args - Schema
[]User
Pool Schema Attribute Args - Sms
Authentication stringMessage - Sms
Configuration UserPool Sms Configuration Args - Sms
Verification stringMessage - User
Attribute UserUpdate Settings Pool User Attribute Update Settings Args - User
Pool UserAdd Ons Pool Add Ons Args - User
Pool stringName - map[string]string
- Username
Attributes []string - Username
Configuration UserPool Username Configuration Args - Verification
Message UserTemplate Pool Verification Message Template Args
- account
Recovery UserSetting Pool Account Recovery Setting - admin
Create UserUser Config Pool Admin Create User Config - alias
Attributes List<String> - auto
Verified List<String>Attributes - deletion
Protection String - device
Configuration UserPool Device Configuration - email
Configuration UserPool Email Configuration - email
Verification StringMessage - email
Verification StringSubject - enabled
Mfas List<String> - lambda
Config UserPool Lambda Config - mfa
Configuration String - policies
User
Pool Policies - schema
List<User
Pool Schema Attribute> - sms
Authentication StringMessage - sms
Configuration UserPool Sms Configuration - sms
Verification StringMessage - user
Attribute UserUpdate Settings Pool User Attribute Update Settings - user
Pool UserAdd Ons Pool Add Ons - user
Pool StringName - Map<String,String>
- username
Attributes List<String> - username
Configuration UserPool Username Configuration - verification
Message UserTemplate Pool Verification Message Template
- account
Recovery UserSetting Pool Account Recovery Setting - admin
Create UserUser Config Pool Admin Create User Config - alias
Attributes string[] - auto
Verified string[]Attributes - deletion
Protection string - device
Configuration UserPool Device Configuration - email
Configuration UserPool Email Configuration - email
Verification stringMessage - email
Verification stringSubject - enabled
Mfas string[] - lambda
Config UserPool Lambda Config - mfa
Configuration string - policies
User
Pool Policies - schema
User
Pool Schema Attribute[] - sms
Authentication stringMessage - sms
Configuration UserPool Sms Configuration - sms
Verification stringMessage - user
Attribute UserUpdate Settings Pool User Attribute Update Settings - user
Pool UserAdd Ons Pool Add Ons - user
Pool stringName - {[key: string]: string}
- username
Attributes string[] - username
Configuration UserPool Username Configuration - verification
Message UserTemplate Pool Verification Message Template
- account_
recovery_ Usersetting Pool Account Recovery Setting Args - admin_
create_ Useruser_ config Pool Admin Create User Config Args - alias_
attributes Sequence[str] - auto_
verified_ Sequence[str]attributes - deletion_
protection str - device_
configuration UserPool Device Configuration Args - email_
configuration UserPool Email Configuration Args - email_
verification_ strmessage - email_
verification_ strsubject - enabled_
mfas Sequence[str] - lambda_
config UserPool Lambda Config Args - mfa_
configuration str - policies
User
Pool Policies Args - schema
Sequence[User
Pool Schema Attribute Args] - sms_
authentication_ strmessage - sms_
configuration UserPool Sms Configuration Args - sms_
verification_ strmessage - user_
attribute_ Userupdate_ settings Pool User Attribute Update Settings Args - user_
pool_ Useradd_ ons Pool Add Ons Args - user_
pool_ strname - Mapping[str, str]
- username_
attributes Sequence[str] - username_
configuration UserPool Username Configuration Args - verification_
message_ Usertemplate Pool Verification Message Template Args
- account
Recovery Property MapSetting - admin
Create Property MapUser Config - alias
Attributes List<String> - auto
Verified List<String>Attributes - deletion
Protection String - device
Configuration Property Map - email
Configuration Property Map - email
Verification StringMessage - email
Verification StringSubject - enabled
Mfas List<String> - lambda
Config Property Map - mfa
Configuration String - policies Property Map
- schema List<Property Map>
- sms
Authentication StringMessage - sms
Configuration Property Map - sms
Verification StringMessage - user
Attribute Property MapUpdate Settings - user
Pool Property MapAdd Ons - user
Pool StringName - Map<String>
- username
Attributes List<String> - username
Configuration Property Map - verification
Message Property MapTemplate
Outputs
All input properties are implicitly available as output properties. Additionally, the UserPool resource produces the following output properties:
- Arn string
- Id string
- The provider-assigned unique ID for this managed resource.
- Provider
Name string - Provider
Url string - User
Pool stringId
- Arn string
- Id string
- The provider-assigned unique ID for this managed resource.
- Provider
Name string - Provider
Url string - User
Pool stringId
- arn String
- id String
- The provider-assigned unique ID for this managed resource.
- provider
Name String - provider
Url String - user
Pool StringId
- arn string
- id string
- The provider-assigned unique ID for this managed resource.
- provider
Name string - provider
Url string - user
Pool stringId
- arn str
- id str
- The provider-assigned unique ID for this managed resource.
- provider_
name str - provider_
url str - user_
pool_ strid
- arn String
- id String
- The provider-assigned unique ID for this managed resource.
- provider
Name String - provider
Url String - user
Pool StringId
Supporting Types
UserPoolAccountRecoverySetting, UserPoolAccountRecoverySettingArgs
UserPoolAddOns, UserPoolAddOnsArgs
- Advanced
Security stringMode
- Advanced
Security stringMode
- advanced
Security StringMode
- advanced
Security stringMode
- advanced
Security StringMode
UserPoolAdminCreateUserConfig, UserPoolAdminCreateUserConfigArgs
UserPoolCustomEmailSender, UserPoolCustomEmailSenderArgs
- Lambda
Arn string - Lambda
Version string
- Lambda
Arn string - Lambda
Version string
- lambda
Arn String - lambda
Version String
- lambda
Arn string - lambda
Version string
- lambda_
arn str - lambda_
version str
- lambda
Arn String - lambda
Version String
UserPoolCustomSmsSender, UserPoolCustomSmsSenderArgs
- Lambda
Arn string - Lambda
Version string
- Lambda
Arn string - Lambda
Version string
- lambda
Arn String - lambda
Version String
- lambda
Arn string - lambda
Version string
- lambda_
arn str - lambda_
version str
- lambda
Arn String - lambda
Version String
UserPoolDeviceConfiguration, UserPoolDeviceConfigurationArgs
- challenge
Required BooleanOn New Device - device
Only BooleanRemembered On User Prompt
- challenge
Required booleanOn New Device - device
Only booleanRemembered On User Prompt
- challenge
Required BooleanOn New Device - device
Only BooleanRemembered On User Prompt
UserPoolEmailConfiguration, UserPoolEmailConfigurationArgs
- Configuration
Set string - Email
Sending stringAccount - From string
- Reply
To stringEmail Address - Source
Arn string
- Configuration
Set string - Email
Sending stringAccount - From string
- Reply
To stringEmail Address - Source
Arn string
- configuration
Set String - email
Sending StringAccount - from String
- reply
To StringEmail Address - source
Arn String
- configuration
Set string - email
Sending stringAccount - from string
- reply
To stringEmail Address - source
Arn string
- configuration_
set str - email_
sending_ straccount - from_ str
- reply_
to_ stremail_ address - source_
arn str
- configuration
Set String - email
Sending StringAccount - from String
- reply
To StringEmail Address - source
Arn String
UserPoolInviteMessageTemplate, UserPoolInviteMessageTemplateArgs
- Email
Message string - Email
Subject string - Sms
Message string
- Email
Message string - Email
Subject string - Sms
Message string
- email
Message String - email
Subject String - sms
Message String
- email
Message string - email
Subject string - sms
Message string
- email_
message str - email_
subject str - sms_
message str
- email
Message String - email
Subject String - sms
Message String
UserPoolLambdaConfig, UserPoolLambdaConfigArgs
- Create
Auth stringChallenge - Custom
Email Pulumi.Sender Aws Native. Cognito. Inputs. User Pool Custom Email Sender - Custom
Message string - Custom
Sms Pulumi.Sender Aws Native. Cognito. Inputs. User Pool Custom Sms Sender - Define
Auth stringChallenge - Kms
Key stringId - Post
Authentication string - Post
Confirmation string - Pre
Authentication string - Pre
Sign stringUp - Pre
Token stringGeneration - Pre
Token Pulumi.Generation Config Aws Native. Cognito. Inputs. User Pool Pre Token Generation Config - User
Migration string - Verify
Auth stringChallenge Response
- Create
Auth stringChallenge - Custom
Email UserSender Pool Custom Email Sender - Custom
Message string - Custom
Sms UserSender Pool Custom Sms Sender - Define
Auth stringChallenge - Kms
Key stringId - Post
Authentication string - Post
Confirmation string - Pre
Authentication string - Pre
Sign stringUp - Pre
Token stringGeneration - Pre
Token UserGeneration Config Pool Pre Token Generation Config - User
Migration string - Verify
Auth stringChallenge Response
- create
Auth StringChallenge - custom
Email UserSender Pool Custom Email Sender - custom
Message String - custom
Sms UserSender Pool Custom Sms Sender - define
Auth StringChallenge - kms
Key StringId - post
Authentication String - post
Confirmation String - pre
Authentication String - pre
Sign StringUp - pre
Token StringGeneration - pre
Token UserGeneration Config Pool Pre Token Generation Config - user
Migration String - verify
Auth StringChallenge Response
- create
Auth stringChallenge - custom
Email UserSender Pool Custom Email Sender - custom
Message string - custom
Sms UserSender Pool Custom Sms Sender - define
Auth stringChallenge - kms
Key stringId - post
Authentication string - post
Confirmation string - pre
Authentication string - pre
Sign stringUp - pre
Token stringGeneration - pre
Token UserGeneration Config Pool Pre Token Generation Config - user
Migration string - verify
Auth stringChallenge Response
- create_
auth_ strchallenge - custom_
email_ Usersender Pool Custom Email Sender - custom_
message str - custom_
sms_ Usersender Pool Custom Sms Sender - define_
auth_ strchallenge - kms_
key_ strid - post_
authentication str - post_
confirmation str - pre_
authentication str - pre_
sign_ strup - pre_
token_ strgeneration - pre_
token_ Usergeneration_ config Pool Pre Token Generation Config - user_
migration str - verify_
auth_ strchallenge_ response
- create
Auth StringChallenge - custom
Email Property MapSender - custom
Message String - custom
Sms Property MapSender - define
Auth StringChallenge - kms
Key StringId - post
Authentication String - post
Confirmation String - pre
Authentication String - pre
Sign StringUp - pre
Token StringGeneration - pre
Token Property MapGeneration Config - user
Migration String - verify
Auth StringChallenge Response
UserPoolNumberAttributeConstraints, UserPoolNumberAttributeConstraintsArgs
UserPoolPasswordPolicy, UserPoolPasswordPolicyArgs
- Minimum
Length int - Require
Lowercase bool - Require
Numbers bool - Require
Symbols bool - Require
Uppercase bool - Temporary
Password intValidity Days
- Minimum
Length int - Require
Lowercase bool - Require
Numbers bool - Require
Symbols bool - Require
Uppercase bool - Temporary
Password intValidity Days
- minimum
Length Integer - require
Lowercase Boolean - require
Numbers Boolean - require
Symbols Boolean - require
Uppercase Boolean - temporary
Password IntegerValidity Days
- minimum
Length number - require
Lowercase boolean - require
Numbers boolean - require
Symbols boolean - require
Uppercase boolean - temporary
Password numberValidity Days
- minimum_
length int - require_
lowercase bool - require_
numbers bool - require_
symbols bool - require_
uppercase bool - temporary_
password_ intvalidity_ days
- minimum
Length Number - require
Lowercase Boolean - require
Numbers Boolean - require
Symbols Boolean - require
Uppercase Boolean - temporary
Password NumberValidity Days
UserPoolPolicies, UserPoolPoliciesArgs
UserPoolPreTokenGenerationConfig, UserPoolPreTokenGenerationConfigArgs
- Lambda
Arn string - Lambda
Version string
- Lambda
Arn string - Lambda
Version string
- lambda
Arn String - lambda
Version String
- lambda
Arn string - lambda
Version string
- lambda_
arn str - lambda_
version str
- lambda
Arn String - lambda
Version String
UserPoolRecoveryOption, UserPoolRecoveryOptionArgs
UserPoolSchemaAttribute, UserPoolSchemaAttributeArgs
- attribute
Data StringType - developer
Only BooleanAttribute - mutable Boolean
- name String
- number
Attribute Property MapConstraints - required Boolean
- string
Attribute Property MapConstraints
UserPoolSmsConfiguration, UserPoolSmsConfigurationArgs
- External
Id string - Sns
Caller stringArn - Sns
Region string
- External
Id string - Sns
Caller stringArn - Sns
Region string
- external
Id String - sns
Caller StringArn - sns
Region String
- external
Id string - sns
Caller stringArn - sns
Region string
- external_
id str - sns_
caller_ strarn - sns_
region str
- external
Id String - sns
Caller StringArn - sns
Region String
UserPoolStringAttributeConstraints, UserPoolStringAttributeConstraintsArgs
- max_
length str - min_
length str
UserPoolUserAttributeUpdateSettings, UserPoolUserAttributeUpdateSettingsArgs
- Attributes
Require List<string>Verification Before Update
- attributes
Require List<String>Verification Before Update
- attributes_
require_ Sequence[str]verification_ before_ update
- attributes
Require List<String>Verification Before Update
UserPoolUsernameConfiguration, UserPoolUsernameConfigurationArgs
- Case
Sensitive bool
- Case
Sensitive bool
- case
Sensitive Boolean
- case
Sensitive boolean
- case_
sensitive bool
- case
Sensitive Boolean
UserPoolVerificationMessageTemplate, UserPoolVerificationMessageTemplateArgs
- Default
Email stringOption - Email
Message string - Email
Message stringBy Link - Email
Subject string - Email
Subject stringBy Link - Sms
Message string
- Default
Email stringOption - Email
Message string - Email
Message stringBy Link - Email
Subject string - Email
Subject stringBy Link - Sms
Message string
- default
Email StringOption - email
Message String - email
Message StringBy Link - email
Subject String - email
Subject StringBy Link - sms
Message String
- default
Email stringOption - email
Message string - email
Message stringBy Link - email
Subject string - email
Subject stringBy Link - sms
Message string
- default
Email StringOption - email
Message String - email
Message StringBy Link - email
Subject String - email
Subject StringBy Link - sms
Message String
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.