AWS v6.78.0, Apr 24 25

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

aws.cognito.getUserPool

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

Example Usage

Basic Usage

TypeScript
Python
Go
C#
Java
YAML

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.

TypeScript
Python
Go
C#
Java
YAML

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.

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

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.

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

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.

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

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.

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

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_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

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