1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. UserPool

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.cognito.UserPool

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    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:

    AccountRecoverySetting Pulumi.AwsNative.Cognito.Inputs.UserPoolAccountRecoverySetting
    AdminCreateUserConfig Pulumi.AwsNative.Cognito.Inputs.UserPoolAdminCreateUserConfig
    AliasAttributes List<string>
    AutoVerifiedAttributes List<string>
    DeletionProtection string
    DeviceConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolDeviceConfiguration
    EmailConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolEmailConfiguration
    EmailVerificationMessage string
    EmailVerificationSubject string
    EnabledMfas List<string>
    LambdaConfig Pulumi.AwsNative.Cognito.Inputs.UserPoolLambdaConfig
    MfaConfiguration string
    Policies Pulumi.AwsNative.Cognito.Inputs.UserPoolPolicies
    Schema List<Pulumi.AwsNative.Cognito.Inputs.UserPoolSchemaAttribute>
    SmsAuthenticationMessage string
    SmsConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolSmsConfiguration
    SmsVerificationMessage string
    UserAttributeUpdateSettings Pulumi.AwsNative.Cognito.Inputs.UserPoolUserAttributeUpdateSettings
    UserPoolAddOns Pulumi.AwsNative.Cognito.Inputs.UserPoolAddOns
    UserPoolName string
    UserPoolTags Dictionary<string, string>
    UsernameAttributes List<string>
    UsernameConfiguration Pulumi.AwsNative.Cognito.Inputs.UserPoolUsernameConfiguration
    VerificationMessageTemplate Pulumi.AwsNative.Cognito.Inputs.UserPoolVerificationMessageTemplate
    AccountRecoverySetting UserPoolAccountRecoverySettingArgs
    AdminCreateUserConfig UserPoolAdminCreateUserConfigArgs
    AliasAttributes []string
    AutoVerifiedAttributes []string
    DeletionProtection string
    DeviceConfiguration UserPoolDeviceConfigurationArgs
    EmailConfiguration UserPoolEmailConfigurationArgs
    EmailVerificationMessage string
    EmailVerificationSubject string
    EnabledMfas []string
    LambdaConfig UserPoolLambdaConfigArgs
    MfaConfiguration string
    Policies UserPoolPoliciesArgs
    Schema []UserPoolSchemaAttributeArgs
    SmsAuthenticationMessage string
    SmsConfiguration UserPoolSmsConfigurationArgs
    SmsVerificationMessage string
    UserAttributeUpdateSettings UserPoolUserAttributeUpdateSettingsArgs
    UserPoolAddOns UserPoolAddOnsArgs
    UserPoolName string
    UserPoolTags map[string]string
    UsernameAttributes []string
    UsernameConfiguration UserPoolUsernameConfigurationArgs
    VerificationMessageTemplate UserPoolVerificationMessageTemplateArgs
    accountRecoverySetting UserPoolAccountRecoverySetting
    adminCreateUserConfig UserPoolAdminCreateUserConfig
    aliasAttributes List<String>
    autoVerifiedAttributes List<String>
    deletionProtection String
    deviceConfiguration UserPoolDeviceConfiguration
    emailConfiguration UserPoolEmailConfiguration
    emailVerificationMessage String
    emailVerificationSubject String
    enabledMfas List<String>
    lambdaConfig UserPoolLambdaConfig
    mfaConfiguration String
    policies UserPoolPolicies
    schema List<UserPoolSchemaAttribute>
    smsAuthenticationMessage String
    smsConfiguration UserPoolSmsConfiguration
    smsVerificationMessage String
    userAttributeUpdateSettings UserPoolUserAttributeUpdateSettings
    userPoolAddOns UserPoolAddOns
    userPoolName String
    userPoolTags Map<String,String>
    usernameAttributes List<String>
    usernameConfiguration UserPoolUsernameConfiguration
    verificationMessageTemplate UserPoolVerificationMessageTemplate
    accountRecoverySetting UserPoolAccountRecoverySetting
    adminCreateUserConfig UserPoolAdminCreateUserConfig
    aliasAttributes string[]
    autoVerifiedAttributes string[]
    deletionProtection string
    deviceConfiguration UserPoolDeviceConfiguration
    emailConfiguration UserPoolEmailConfiguration
    emailVerificationMessage string
    emailVerificationSubject string
    enabledMfas string[]
    lambdaConfig UserPoolLambdaConfig
    mfaConfiguration string
    policies UserPoolPolicies
    schema UserPoolSchemaAttribute[]
    smsAuthenticationMessage string
    smsConfiguration UserPoolSmsConfiguration
    smsVerificationMessage string
    userAttributeUpdateSettings UserPoolUserAttributeUpdateSettings
    userPoolAddOns UserPoolAddOns
    userPoolName string
    userPoolTags {[key: string]: string}
    usernameAttributes string[]
    usernameConfiguration UserPoolUsernameConfiguration
    verificationMessageTemplate UserPoolVerificationMessageTemplate
    account_recovery_setting UserPoolAccountRecoverySettingArgs
    admin_create_user_config UserPoolAdminCreateUserConfigArgs
    alias_attributes Sequence[str]
    auto_verified_attributes Sequence[str]
    deletion_protection str
    device_configuration UserPoolDeviceConfigurationArgs
    email_configuration UserPoolEmailConfigurationArgs
    email_verification_message str
    email_verification_subject str
    enabled_mfas Sequence[str]
    lambda_config UserPoolLambdaConfigArgs
    mfa_configuration str
    policies UserPoolPoliciesArgs
    schema Sequence[UserPoolSchemaAttributeArgs]
    sms_authentication_message str
    sms_configuration UserPoolSmsConfigurationArgs
    sms_verification_message str
    user_attribute_update_settings UserPoolUserAttributeUpdateSettingsArgs
    user_pool_add_ons UserPoolAddOnsArgs
    user_pool_name str
    user_pool_tags Mapping[str, str]
    username_attributes Sequence[str]
    username_configuration UserPoolUsernameConfigurationArgs
    verification_message_template UserPoolVerificationMessageTemplateArgs

    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.
    ProviderName string
    ProviderUrl string
    UserPoolId string
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    ProviderName string
    ProviderUrl string
    UserPoolId string
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    providerName String
    providerUrl String
    userPoolId String
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    providerName string
    providerUrl string
    userPoolId string
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    provider_name str
    provider_url str
    user_pool_id str
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    providerName String
    providerUrl String
    userPoolId String

    Supporting Types

    UserPoolAccountRecoverySetting, UserPoolAccountRecoverySettingArgs

    UserPoolAddOns, UserPoolAddOnsArgs

    UserPoolAdminCreateUserConfig, UserPoolAdminCreateUserConfigArgs

    UserPoolCustomEmailSender, UserPoolCustomEmailSenderArgs

    UserPoolCustomSmsSender, UserPoolCustomSmsSenderArgs

    UserPoolDeviceConfiguration, UserPoolDeviceConfigurationArgs

    UserPoolEmailConfiguration, UserPoolEmailConfigurationArgs

    UserPoolInviteMessageTemplate, UserPoolInviteMessageTemplateArgs

    UserPoolLambdaConfig, UserPoolLambdaConfigArgs

    UserPoolNumberAttributeConstraints, UserPoolNumberAttributeConstraintsArgs

    MaxValue string
    MinValue string
    MaxValue string
    MinValue string
    maxValue String
    minValue String
    maxValue string
    minValue string
    maxValue String
    minValue String

    UserPoolPasswordPolicy, UserPoolPasswordPolicyArgs

    UserPoolPolicies, UserPoolPoliciesArgs

    UserPoolPreTokenGenerationConfig, UserPoolPreTokenGenerationConfigArgs

    UserPoolRecoveryOption, UserPoolRecoveryOptionArgs

    Name string
    Priority int
    Name string
    Priority int
    name String
    priority Integer
    name string
    priority number
    name str
    priority int
    name String
    priority Number

    UserPoolSchemaAttribute, UserPoolSchemaAttributeArgs

    UserPoolSmsConfiguration, UserPoolSmsConfigurationArgs

    ExternalId string
    SnsCallerArn string
    SnsRegion string
    ExternalId string
    SnsCallerArn string
    SnsRegion string
    externalId String
    snsCallerArn String
    snsRegion String
    externalId string
    snsCallerArn string
    snsRegion string
    externalId String
    snsCallerArn String
    snsRegion String

    UserPoolStringAttributeConstraints, UserPoolStringAttributeConstraintsArgs

    MaxLength string
    MinLength string
    MaxLength string
    MinLength string
    maxLength String
    minLength String
    maxLength string
    minLength string
    maxLength String
    minLength String

    UserPoolUserAttributeUpdateSettings, UserPoolUserAttributeUpdateSettingsArgs

    UserPoolUsernameConfiguration, UserPoolUsernameConfigurationArgs

    UserPoolVerificationMessageTemplate, UserPoolVerificationMessageTemplateArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi