1. Packages
  2. AWS
  3. API Docs
  4. cognito
  5. getUserPool
Viewing docs for AWS v6.83.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

aws.cognito.getUserPool

aws logo
Viewing docs for AWS v6.83.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

    Data source for managing an AWS Cognito User Pool.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.cognito.getUserPool({
    userPoolId: "us-west-2_aaaaaaaaa",
});

    import pulumi
import pulumi_aws as aws

example = aws.cognito.get_user_pool(user_pool_id="us-west-2_aaaaaaaaa")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cognito.LookupUserPool(ctx, &cognito.LookupUserPoolArgs{
			UserPoolId: "us-west-2_aaaaaaaaa",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Cognito.GetUserPool.Invoke(new()
    {
        UserPoolId = "us-west-2_aaaaaaaaa",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.CognitoFunctions;
import com.pulumi.aws.cognito.inputs.GetUserPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = CognitoFunctions.getUserPool(GetUserPoolArgs.builder()
            .userPoolId("us-west-2_aaaaaaaaa")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:cognito:getUserPool
      arguments:
        userPoolId: us-west-2_aaaaaaaaa

    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)
public static Output<GetUserPoolResult> getUserPool(GetUserPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:cognito/getUserPool:getUserPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    UserPoolId string
    The cognito pool ID
    UserPoolId string
    The cognito pool ID
    userPoolId String
    The cognito pool ID
    userPoolId string
    The cognito pool ID
    user_pool_id str
    The cognito pool ID
    userPoolId String
    The cognito pool ID

    getUserPool Result

    The following output properties are available:

    AccountRecoverySettings List<GetUserPoolAccountRecoverySetting>
    AdminCreateUserConfigs List<GetUserPoolAdminCreateUserConfig>
    Arn string
    ARN of the User Pool.

    • account_recovery_setting - 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.
    • admin_create_user_config - The configuration for AdminCreateUser requests.
    AutoVerifiedAttributes List<string>
    The attributes that are auto-verified in a user pool.
    CreationDate string
    The date and time, in ISO 8601 format, when the item was created.
    CustomDomain string
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
    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.

    • device_configuration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    DeviceConfigurations List<GetUserPoolDeviceConfiguration>
    Domain string
    The domain prefix, if the user pool has a domain associated with it.

    • email_configuration - 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.
    EmailConfigurations List<GetUserPoolEmailConfiguration>
    EstimatedNumberOfUsers int
    A number estimating the size of the user pool.

    • lambda_config - The AWS Lambda triggers associated with the user pool.
    Id string
    LambdaConfigs List<GetUserPoolLambdaConfig>
    LastModifiedDate string
    The date and time, in ISO 8601 format, when the item was modified.
    MfaConfiguration string
    Can be one of the following values: OFF | ON | OPTIONAL
    Name string
    • Name of the attribute.
    SchemaAttributes List<GetUserPoolSchemaAttribute>
    SmsAuthenticationMessage string
    The contents of the SMS authentication message.
    SmsConfigurationFailure string
    The reason why the SMS configuration can't send the messages to your users.
    SmsVerificationMessage string
    The contents of the SMS authentication message.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.

    • user_pool_add_ons - The user pool add-ons configuration.
    UserPoolAddOns List<GetUserPoolUserPoolAddOn>
    UserPoolId string
    UserPoolTags Dictionary<string, string>
    (Deprecated) Map of tags assigned to the resource.

    Deprecated: Use the attribute "tags" instead

    UsernameAttributes List<string>
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    AccountRecoverySettings []GetUserPoolAccountRecoverySetting
    AdminCreateUserConfigs []GetUserPoolAdminCreateUserConfig
    Arn string
    ARN of the User Pool.

    • account_recovery_setting - 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.
    • admin_create_user_config - The configuration for AdminCreateUser requests.
    AutoVerifiedAttributes []string
    The attributes that are auto-verified in a user pool.
    CreationDate string
    The date and time, in ISO 8601 format, when the item was created.
    CustomDomain string
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
    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.

    • device_configuration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    DeviceConfigurations []GetUserPoolDeviceConfiguration
    Domain string
    The domain prefix, if the user pool has a domain associated with it.

    • email_configuration - 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.
    EmailConfigurations []GetUserPoolEmailConfiguration
    EstimatedNumberOfUsers int
    A number estimating the size of the user pool.

    • lambda_config - The AWS Lambda triggers associated with the user pool.
    Id string
    LambdaConfigs []GetUserPoolLambdaConfig
    LastModifiedDate string
    The date and time, in ISO 8601 format, when the item was modified.
    MfaConfiguration string
    Can be one of the following values: OFF | ON | OPTIONAL
    Name string
    • Name of the attribute.
    SchemaAttributes []GetUserPoolSchemaAttribute
    SmsAuthenticationMessage string
    The contents of the SMS authentication message.
    SmsConfigurationFailure string
    The reason why the SMS configuration can't send the messages to your users.
    SmsVerificationMessage string
    The contents of the SMS authentication message.
    Tags map[string]string
    Map of tags assigned to the resource.

    • user_pool_add_ons - The user pool add-ons configuration.
    UserPoolAddOns []GetUserPoolUserPoolAddOn
    UserPoolId string
    UserPoolTags map[string]string
    (Deprecated) Map of tags assigned to the resource.

    Deprecated: Use the attribute "tags" instead

    UsernameAttributes []string
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    accountRecoverySettings List<GetUserPoolAccountRecoverySetting>
    adminCreateUserConfigs List<GetUserPoolAdminCreateUserConfig>
    arn String
    ARN of the User Pool.

    • account_recovery_setting - 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.
    • admin_create_user_config - The configuration for AdminCreateUser requests.
    autoVerifiedAttributes List<String>
    The attributes that are auto-verified in a user pool.
    creationDate String
    The date and time, in ISO 8601 format, when the item was created.
    customDomain String
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
    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.

    • device_configuration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    deviceConfigurations List<GetUserPoolDeviceConfiguration>
    domain String
    The domain prefix, if the user pool has a domain associated with it.

    • email_configuration - 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.
    emailConfigurations List<GetUserPoolEmailConfiguration>
    estimatedNumberOfUsers Integer
    A number estimating the size of the user pool.

    • lambda_config - The AWS Lambda triggers associated with the user pool.
    id String
    lambdaConfigs List<GetUserPoolLambdaConfig>
    lastModifiedDate String
    The date and time, in ISO 8601 format, when the item was modified.
    mfaConfiguration String
    Can be one of the following values: OFF | ON | OPTIONAL
    name String
    • Name of the attribute.
    schemaAttributes List<GetUserPoolSchemaAttribute>
    smsAuthenticationMessage String
    The contents of the SMS authentication message.
    smsConfigurationFailure String
    The reason why the SMS configuration can't send the messages to your users.
    smsVerificationMessage String
    The contents of the SMS authentication message.
    tags Map<String,String>
    Map of tags assigned to the resource.

    • user_pool_add_ons - The user pool add-ons configuration.
    userPoolAddOns List<GetUserPoolUserPoolAddOn>
    userPoolId String
    userPoolTags Map<String,String>
    (Deprecated) Map of tags assigned to the resource.

    Deprecated: Use the attribute "tags" instead

    usernameAttributes List<String>
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    accountRecoverySettings GetUserPoolAccountRecoverySetting[]
    adminCreateUserConfigs GetUserPoolAdminCreateUserConfig[]
    arn string
    ARN of the User Pool.

    • account_recovery_setting - 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.
    • admin_create_user_config - The configuration for AdminCreateUser requests.
    autoVerifiedAttributes string[]
    The attributes that are auto-verified in a user pool.
    creationDate string
    The date and time, in ISO 8601 format, when the item was created.
    customDomain string
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
    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.

    • device_configuration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    deviceConfigurations GetUserPoolDeviceConfiguration[]
    domain string
    The domain prefix, if the user pool has a domain associated with it.

    • email_configuration - 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.
    emailConfigurations GetUserPoolEmailConfiguration[]
    estimatedNumberOfUsers number
    A number estimating the size of the user pool.

    • lambda_config - The AWS Lambda triggers associated with the user pool.
    id string
    lambdaConfigs GetUserPoolLambdaConfig[]
    lastModifiedDate string
    The date and time, in ISO 8601 format, when the item was modified.
    mfaConfiguration string
    Can be one of the following values: OFF | ON | OPTIONAL
    name string
    • Name of the attribute.
    schemaAttributes GetUserPoolSchemaAttribute[]
    smsAuthenticationMessage string
    The contents of the SMS authentication message.
    smsConfigurationFailure string
    The reason why the SMS configuration can't send the messages to your users.
    smsVerificationMessage string
    The contents of the SMS authentication message.
    tags {[key: string]: string}
    Map of tags assigned to the resource.

    • user_pool_add_ons - The user pool add-ons configuration.
    userPoolAddOns GetUserPoolUserPoolAddOn[]
    userPoolId string
    userPoolTags {[key: string]: string}
    (Deprecated) Map of tags assigned to the resource.

    Deprecated: Use the attribute "tags" instead

    usernameAttributes string[]
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    account_recovery_settings Sequence[GetUserPoolAccountRecoverySetting]
    admin_create_user_configs Sequence[GetUserPoolAdminCreateUserConfig]
    arn str
    ARN of the User Pool.

    • account_recovery_setting - 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.
    • admin_create_user_config - The configuration for AdminCreateUser requests.
    auto_verified_attributes Sequence[str]
    The attributes that are auto-verified in a user pool.
    creation_date str
    The date and time, in ISO 8601 format, when the item was created.
    custom_domain str
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
    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 - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    device_configurations Sequence[GetUserPoolDeviceConfiguration]
    domain str
    The domain prefix, if the user pool has a domain associated with it.

    • email_configuration - 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_configurations Sequence[GetUserPoolEmailConfiguration]
    estimated_number_of_users int
    A number estimating the size of the user pool.

    • lambda_config - The AWS Lambda triggers associated with the user pool.
    id str
    lambda_configs Sequence[GetUserPoolLambdaConfig]
    last_modified_date str
    The date and time, in ISO 8601 format, when the item was modified.
    mfa_configuration str
    Can be one of the following values: OFF | ON | OPTIONAL
    name str
    • Name of the attribute.
    schema_attributes Sequence[GetUserPoolSchemaAttribute]
    sms_authentication_message str
    The contents of the SMS authentication message.
    sms_configuration_failure str
    The reason why the SMS configuration can't send the messages to your users.
    sms_verification_message str
    The contents of the SMS authentication message.
    tags Mapping[str, str]
    Map of tags assigned to the resource.

    • user_pool_add_ons - The user pool add-ons configuration.
    user_pool_add_ons Sequence[GetUserPoolUserPoolAddOn]
    user_pool_id str
    user_pool_tags Mapping[str, str]
    (Deprecated) Map of tags assigned to the resource.

    Deprecated: Use the attribute "tags" instead

    username_attributes Sequence[str]
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    accountRecoverySettings List<Property Map>
    adminCreateUserConfigs List<Property Map>
    arn String
    ARN of the User Pool.

    • account_recovery_setting - 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.
    • admin_create_user_config - The configuration for AdminCreateUser requests.
    autoVerifiedAttributes List<String>
    The attributes that are auto-verified in a user pool.
    creationDate String
    The date and time, in ISO 8601 format, when the item was created.
    customDomain String
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
    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.

    • device_configuration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    deviceConfigurations List<Property Map>
    domain String
    The domain prefix, if the user pool has a domain associated with it.

    • email_configuration - 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.
    emailConfigurations List<Property Map>
    estimatedNumberOfUsers Number
    A number estimating the size of the user pool.

    • lambda_config - The AWS Lambda triggers associated with the user pool.
    id String
    lambdaConfigs List<Property Map>
    lastModifiedDate String
    The date and time, in ISO 8601 format, when the item was modified.
    mfaConfiguration String
    Can be one of the following values: OFF | ON | OPTIONAL
    name String
    • Name of the attribute.
    schemaAttributes List<Property Map>
    smsAuthenticationMessage String
    The contents of the SMS authentication message.
    smsConfigurationFailure String
    The reason why the SMS configuration can't send the messages to your users.
    smsVerificationMessage String
    The contents of the SMS authentication message.
    tags Map<String>
    Map of tags assigned to the resource.

    • user_pool_add_ons - The user pool add-ons configuration.
    userPoolAddOns List<Property Map>
    userPoolId String
    userPoolTags Map<String>
    (Deprecated) Map of tags assigned to the resource.

    Deprecated: Use the attribute "tags" instead

    usernameAttributes List<String>
    Specifies whether a user can use an email address or phone number as a username when they sign up.

    Supporting Types

    GetUserPoolAccountRecoverySetting

    GetUserPoolAccountRecoverySettingRecoveryMechanism

    Name string
    • Name of the attribute.
    Priority int
    • Priority of this mechanism in the recovery process (lower numbers are higher priority).
    Name string
    • Name of the attribute.
    Priority int
    • Priority of this mechanism in the recovery process (lower numbers are higher priority).
    name String
    • Name of the attribute.
    priority Integer
    • Priority of this mechanism in the recovery process (lower numbers are higher priority).
    name string
    • Name of the attribute.
    priority number
    • Priority of this mechanism in the recovery process (lower numbers are higher priority).
    name str
    • Name of the attribute.
    priority int
    • Priority of this mechanism in the recovery process (lower numbers are higher priority).
    name String
    • Name of the attribute.
    priority Number
    • Priority of this mechanism in the recovery process (lower numbers are higher priority).

    GetUserPoolAdminCreateUserConfig

    AllowAdminCreateUserOnly bool
    • Whether only admins can create users.
    InviteMessageTemplates List<GetUserPoolAdminCreateUserConfigInviteMessageTemplate>
    UnusedAccountValidityDays int
    • Number of days an unconfirmed user account remains valid.
    • invite_message_template - Templates for invitation messages.
    AllowAdminCreateUserOnly bool
    • Whether only admins can create users.
    InviteMessageTemplates []GetUserPoolAdminCreateUserConfigInviteMessageTemplate
    UnusedAccountValidityDays int
    • Number of days an unconfirmed user account remains valid.
    • invite_message_template - Templates for invitation messages.
    allowAdminCreateUserOnly Boolean
    • Whether only admins can create users.
    inviteMessageTemplates List<GetUserPoolAdminCreateUserConfigInviteMessageTemplate>
    unusedAccountValidityDays Integer
    • Number of days an unconfirmed user account remains valid.
    • invite_message_template - Templates for invitation messages.
    allowAdminCreateUserOnly boolean
    • Whether only admins can create users.
    inviteMessageTemplates GetUserPoolAdminCreateUserConfigInviteMessageTemplate[]
    unusedAccountValidityDays number
    • Number of days an unconfirmed user account remains valid.
    • invite_message_template - Templates for invitation messages.
    allow_admin_create_user_only bool
    • Whether only admins can create users.
    invite_message_templates Sequence[GetUserPoolAdminCreateUserConfigInviteMessageTemplate]
    unused_account_validity_days int
    • Number of days an unconfirmed user account remains valid.
    • invite_message_template - Templates for invitation messages.
    allowAdminCreateUserOnly Boolean
    • Whether only admins can create users.
    inviteMessageTemplates List<Property Map>
    unusedAccountValidityDays Number
    • Number of days an unconfirmed user account remains valid.
    • invite_message_template - Templates for invitation messages.

    GetUserPoolAdminCreateUserConfigInviteMessageTemplate

    EmailMessage string
    • Email message content.
    EmailSubject string
    • Email message subject.
    SmsMessage string
    • SMS message content.
    EmailMessage string
    • Email message content.
    EmailSubject string
    • Email message subject.
    SmsMessage string
    • SMS message content.
    emailMessage String
    • Email message content.
    emailSubject String
    • Email message subject.
    smsMessage String
    • SMS message content.
    emailMessage string
    • Email message content.
    emailSubject string
    • Email message subject.
    smsMessage string
    • SMS message content.
    email_message str
    • Email message content.
    email_subject str
    • Email message subject.
    sms_message str
    • SMS message content.
    emailMessage String
    • Email message content.
    emailSubject String
    • Email message subject.
    smsMessage String
    • SMS message content.

    GetUserPoolDeviceConfiguration

    ChallengeRequiredOnNewDevice bool
    • Whether a challenge is required on new devices.
    DeviceOnlyRememberedOnUserPrompt bool
    • Whether devices are only remembered if the user prompts it.
    ChallengeRequiredOnNewDevice bool
    • Whether a challenge is required on new devices.
    DeviceOnlyRememberedOnUserPrompt bool
    • Whether devices are only remembered if the user prompts it.
    challengeRequiredOnNewDevice Boolean
    • Whether a challenge is required on new devices.
    deviceOnlyRememberedOnUserPrompt Boolean
    • Whether devices are only remembered if the user prompts it.
    challengeRequiredOnNewDevice boolean
    • Whether a challenge is required on new devices.
    deviceOnlyRememberedOnUserPrompt boolean
    • Whether devices are only remembered if the user prompts it.
    challenge_required_on_new_device bool
    • Whether a challenge is required on new devices.
    device_only_remembered_on_user_prompt bool
    • Whether devices are only remembered if the user prompts it.
    challengeRequiredOnNewDevice Boolean
    • Whether a challenge is required on new devices.
    deviceOnlyRememberedOnUserPrompt Boolean
    • Whether devices are only remembered if the user prompts it.

    GetUserPoolEmailConfiguration

    ConfigurationSet string
    • Configuration set used for sending emails.
    EmailSendingAccount string
    • Email sending account.
    From string
    • Email sender address.
    ReplyToEmailAddress string
    • Reply-to email address.
    SourceArn string
    • Source Amazon Resource Name (ARN) for emails.
    ConfigurationSet string
    • Configuration set used for sending emails.
    EmailSendingAccount string
    • Email sending account.
    From string
    • Email sender address.
    ReplyToEmailAddress string
    • Reply-to email address.
    SourceArn string
    • Source Amazon Resource Name (ARN) for emails.
    configurationSet String
    • Configuration set used for sending emails.
    emailSendingAccount String
    • Email sending account.
    from String
    • Email sender address.
    replyToEmailAddress String
    • Reply-to email address.
    sourceArn String
    • Source Amazon Resource Name (ARN) for emails.
    configurationSet string
    • Configuration set used for sending emails.
    emailSendingAccount string
    • Email sending account.
    from string
    • Email sender address.
    replyToEmailAddress string
    • Reply-to email address.
    sourceArn string
    • Source Amazon Resource Name (ARN) for emails.
    configuration_set str
    • Configuration set used for sending emails.
    email_sending_account str
    • Email sending account.
    from_ str
    • Email sender address.
    reply_to_email_address str
    • Reply-to email address.
    source_arn str
    • Source Amazon Resource Name (ARN) for emails.
    configurationSet String
    • Configuration set used for sending emails.
    emailSendingAccount String
    • Email sending account.
    from String
    • Email sender address.
    replyToEmailAddress String
    • Reply-to email address.
    sourceArn String
    • Source Amazon Resource Name (ARN) for emails.

    GetUserPoolLambdaConfig

    GetUserPoolLambdaConfigCustomEmailSender

    LambdaArn string
    • ARN of the Lambda function.
    LambdaVersion string
    • Version of the Lambda function.
    LambdaArn string
    • ARN of the Lambda function.
    LambdaVersion string
    • Version of the Lambda function.
    lambdaArn String
    • ARN of the Lambda function.
    lambdaVersion String
    • Version of the Lambda function.
    lambdaArn string
    • ARN of the Lambda function.
    lambdaVersion string
    • Version of the Lambda function.
    lambda_arn str
    • ARN of the Lambda function.
    lambda_version str
    • Version of the Lambda function.
    lambdaArn String
    • ARN of the Lambda function.
    lambdaVersion String
    • Version of the Lambda function.

    GetUserPoolLambdaConfigCustomSmsSender

    LambdaArn string
    • ARN of the Lambda function.
    LambdaVersion string
    • Version of the Lambda function.
    LambdaArn string
    • ARN of the Lambda function.
    LambdaVersion string
    • Version of the Lambda function.
    lambdaArn String
    • ARN of the Lambda function.
    lambdaVersion String
    • Version of the Lambda function.
    lambdaArn string
    • ARN of the Lambda function.
    lambdaVersion string
    • Version of the Lambda function.
    lambda_arn str
    • ARN of the Lambda function.
    lambda_version str
    • Version of the Lambda function.
    lambdaArn String
    • ARN of the Lambda function.
    lambdaVersion String
    • Version of the Lambda function.

    GetUserPoolLambdaConfigPreTokenGenerationConfig

    LambdaArn string
    • ARN of the Lambda function.
    LambdaVersion string
    • Version of the Lambda function.
    LambdaArn string
    • ARN of the Lambda function.
    LambdaVersion string
    • Version of the Lambda function.
    lambdaArn String
    • ARN of the Lambda function.
    lambdaVersion String
    • Version of the Lambda function.
    lambdaArn string
    • ARN of the Lambda function.
    lambdaVersion string
    • Version of the Lambda function.
    lambda_arn str
    • ARN of the Lambda function.
    lambda_version str
    • Version of the Lambda function.
    lambdaArn String
    • ARN of the Lambda function.
    lambdaVersion String
    • Version of the Lambda function.

    GetUserPoolSchemaAttribute

    AttributeDataType string
    • Data type of the attribute (e.g., string, number).
    DeveloperOnlyAttribute bool
    • Whether the attribute is for developer use only.
    Mutable bool
    • Whether the attribute can be changed after user creation.
    Name string
    • Name of the attribute.
    NumberAttributeConstraints List<GetUserPoolSchemaAttributeNumberAttributeConstraint>
    Required bool
    • Whether the attribute is required during user registration.
    • number_attribute_constraints - Constraints for numeric attributes.
    • string_attribute_constraints - Constraints for string attributes.
    StringAttributeConstraints List<GetUserPoolSchemaAttributeStringAttributeConstraint>
    AttributeDataType string
    • Data type of the attribute (e.g., string, number).
    DeveloperOnlyAttribute bool
    • Whether the attribute is for developer use only.
    Mutable bool
    • Whether the attribute can be changed after user creation.
    Name string
    • Name of the attribute.
    NumberAttributeConstraints []GetUserPoolSchemaAttributeNumberAttributeConstraint
    Required bool
    • Whether the attribute is required during user registration.
    • number_attribute_constraints - Constraints for numeric attributes.
    • string_attribute_constraints - Constraints for string attributes.
    StringAttributeConstraints []GetUserPoolSchemaAttributeStringAttributeConstraint
    attributeDataType String
    • Data type of the attribute (e.g., string, number).
    developerOnlyAttribute Boolean
    • Whether the attribute is for developer use only.
    mutable Boolean
    • Whether the attribute can be changed after user creation.
    name String
    • Name of the attribute.
    numberAttributeConstraints List<GetUserPoolSchemaAttributeNumberAttributeConstraint>
    required Boolean
    • Whether the attribute is required during user registration.
    • number_attribute_constraints - Constraints for numeric attributes.
    • string_attribute_constraints - Constraints for string attributes.
    stringAttributeConstraints List<GetUserPoolSchemaAttributeStringAttributeConstraint>
    attributeDataType string
    • Data type of the attribute (e.g., string, number).
    developerOnlyAttribute boolean
    • Whether the attribute is for developer use only.
    mutable boolean
    • Whether the attribute can be changed after user creation.
    name string
    • Name of the attribute.
    numberAttributeConstraints GetUserPoolSchemaAttributeNumberAttributeConstraint[]
    required boolean
    • Whether the attribute is required during user registration.
    • number_attribute_constraints - Constraints for numeric attributes.
    • string_attribute_constraints - Constraints for string attributes.
    stringAttributeConstraints GetUserPoolSchemaAttributeStringAttributeConstraint[]
    attribute_data_type str
    • Data type of the attribute (e.g., string, number).
    developer_only_attribute bool
    • Whether the attribute is for developer use only.
    mutable bool
    • Whether the attribute can be changed after user creation.
    name str
    • Name of the attribute.
    number_attribute_constraints Sequence[GetUserPoolSchemaAttributeNumberAttributeConstraint]
    required bool
    • Whether the attribute is required during user registration.
    • number_attribute_constraints - Constraints for numeric attributes.
    • string_attribute_constraints - Constraints for string attributes.
    string_attribute_constraints Sequence[GetUserPoolSchemaAttributeStringAttributeConstraint]
    attributeDataType String
    • Data type of the attribute (e.g., string, number).
    developerOnlyAttribute Boolean
    • Whether the attribute is for developer use only.
    mutable Boolean
    • Whether the attribute can be changed after user creation.
    name String
    • Name of the attribute.
    numberAttributeConstraints List<Property Map>
    required Boolean
    • Whether the attribute is required during user registration.
    • number_attribute_constraints - Constraints for numeric attributes.
    • string_attribute_constraints - Constraints for string attributes.
    stringAttributeConstraints List<Property Map>

    GetUserPoolSchemaAttributeNumberAttributeConstraint

    MaxValue string
    • Maximum allowed value.
    MinValue string
    • Minimum allowed value.
    MaxValue string
    • Maximum allowed value.
    MinValue string
    • Minimum allowed value.
    maxValue String
    • Maximum allowed value.
    minValue String
    • Minimum allowed value.
    maxValue string
    • Maximum allowed value.
    minValue string
    • Minimum allowed value.
    max_value str
    • Maximum allowed value.
    min_value str
    • Minimum allowed value.
    maxValue String
    • Maximum allowed value.
    minValue String
    • Minimum allowed value.

    GetUserPoolSchemaAttributeStringAttributeConstraint

    MaxLength string
    • Maximum allowed length.
    MinLength string
    • Minimum allowed length.
    MaxLength string
    • Maximum allowed length.
    MinLength string
    • Minimum allowed length.
    maxLength String
    • Maximum allowed length.
    minLength String
    • Minimum allowed length.
    maxLength string
    • Maximum allowed length.
    minLength string
    • Minimum allowed length.
    max_length str
    • Maximum allowed length.
    min_length str
    • Minimum allowed length.
    maxLength String
    • Maximum allowed length.
    minLength String
    • Minimum allowed length.

    GetUserPoolUserPoolAddOn

    AdvancedSecurityAdditionalFlows List<GetUserPoolUserPoolAddOnAdvancedSecurityAdditionalFlow>
    A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. Detailed below.
    AdvancedSecurityMode string
    Mode for advanced security.
    AdvancedSecurityAdditionalFlows []GetUserPoolUserPoolAddOnAdvancedSecurityAdditionalFlow
    A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. Detailed below.
    AdvancedSecurityMode string
    Mode for advanced security.
    advancedSecurityAdditionalFlows List<GetUserPoolUserPoolAddOnAdvancedSecurityAdditionalFlow>
    A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. Detailed below.
    advancedSecurityMode String
    Mode for advanced security.
    advancedSecurityAdditionalFlows GetUserPoolUserPoolAddOnAdvancedSecurityAdditionalFlow[]
    A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. Detailed below.
    advancedSecurityMode string
    Mode for advanced security.
    advanced_security_additional_flows Sequence[GetUserPoolUserPoolAddOnAdvancedSecurityAdditionalFlow]
    A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. Detailed below.
    advanced_security_mode str
    Mode for advanced security.
    advancedSecurityAdditionalFlows List<Property Map>
    A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. Detailed below.
    advancedSecurityMode String
    Mode for advanced security.

    GetUserPoolUserPoolAddOnAdvancedSecurityAdditionalFlow

    CustomAuthMode string
    Mode of threat protection operation in custom authentication.
    CustomAuthMode string
    Mode of threat protection operation in custom authentication.
    customAuthMode String
    Mode of threat protection operation in custom authentication.
    customAuthMode string
    Mode of threat protection operation in custom authentication.
    custom_auth_mode str
    Mode of threat protection operation in custom authentication.
    customAuthMode String
    Mode of threat protection operation in custom authentication.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v6.83.1 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.