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

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.getUserPool

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

    Using getUserPool

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

    function getUserPool(args: GetUserPoolArgs, opts?: InvokeOptions): Promise<GetUserPoolResult>
    function getUserPoolOutput(args: GetUserPoolOutputArgs, opts?: InvokeOptions): Output<GetUserPoolResult>
    def get_user_pool(user_pool_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetUserPoolResult
    def get_user_pool_output(user_pool_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolResult]
    func LookupUserPool(ctx *Context, args *LookupUserPoolArgs, opts ...InvokeOption) (*LookupUserPoolResult, error)
    func LookupUserPoolOutput(ctx *Context, args *LookupUserPoolOutputArgs, opts ...InvokeOption) LookupUserPoolResultOutput

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

    public static class GetUserPool 
    {
        public static Task<GetUserPoolResult> InvokeAsync(GetUserPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetUserPoolResult> Invoke(GetUserPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserPoolResult> getUserPool(GetUserPoolArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cognito:getUserPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UserPoolId string
    UserPoolId string
    userPoolId String
    userPoolId string
    userPoolId String

    getUserPool Result

    The following output properties are available:

    AccountRecoverySetting Pulumi.AwsNative.Cognito.Outputs.UserPoolAccountRecoverySetting
    AdminCreateUserConfig Pulumi.AwsNative.Cognito.Outputs.UserPoolAdminCreateUserConfig
    AliasAttributes List<string>
    Arn string
    AutoVerifiedAttributes List<string>
    DeletionProtection string
    DeviceConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolDeviceConfiguration
    EmailConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolEmailConfiguration
    EmailVerificationMessage string
    EmailVerificationSubject string
    LambdaConfig Pulumi.AwsNative.Cognito.Outputs.UserPoolLambdaConfig
    MfaConfiguration string
    Policies Pulumi.AwsNative.Cognito.Outputs.UserPoolPolicies
    ProviderName string
    ProviderUrl string
    Schema List<Pulumi.AwsNative.Cognito.Outputs.UserPoolSchemaAttribute>
    SmsAuthenticationMessage string
    SmsConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolSmsConfiguration
    SmsVerificationMessage string
    UserAttributeUpdateSettings Pulumi.AwsNative.Cognito.Outputs.UserPoolUserAttributeUpdateSettings
    UserPoolAddOns Pulumi.AwsNative.Cognito.Outputs.UserPoolAddOns
    UserPoolId string
    UserPoolName string
    UserPoolTags Dictionary<string, string>
    UsernameAttributes List<string>
    UsernameConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolUsernameConfiguration
    VerificationMessageTemplate Pulumi.AwsNative.Cognito.Outputs.UserPoolVerificationMessageTemplate
    AccountRecoverySetting UserPoolAccountRecoverySetting
    AdminCreateUserConfig UserPoolAdminCreateUserConfig
    AliasAttributes []string
    Arn string
    AutoVerifiedAttributes []string
    DeletionProtection string
    DeviceConfiguration UserPoolDeviceConfiguration
    EmailConfiguration UserPoolEmailConfiguration
    EmailVerificationMessage string
    EmailVerificationSubject string
    LambdaConfig UserPoolLambdaConfig
    MfaConfiguration string
    Policies UserPoolPolicies
    ProviderName string
    ProviderUrl string
    Schema []UserPoolSchemaAttribute
    SmsAuthenticationMessage string
    SmsConfiguration UserPoolSmsConfiguration
    SmsVerificationMessage string
    UserAttributeUpdateSettings UserPoolUserAttributeUpdateSettings
    UserPoolAddOns UserPoolAddOns
    UserPoolId string
    UserPoolName string
    UserPoolTags map[string]string
    UsernameAttributes []string
    UsernameConfiguration UserPoolUsernameConfiguration
    VerificationMessageTemplate UserPoolVerificationMessageTemplate
    accountRecoverySetting UserPoolAccountRecoverySetting
    adminCreateUserConfig UserPoolAdminCreateUserConfig
    aliasAttributes List<String>
    arn String
    autoVerifiedAttributes List<String>
    deletionProtection String
    deviceConfiguration UserPoolDeviceConfiguration
    emailConfiguration UserPoolEmailConfiguration
    emailVerificationMessage String
    emailVerificationSubject String
    lambdaConfig UserPoolLambdaConfig
    mfaConfiguration String
    policies UserPoolPolicies
    providerName String
    providerUrl String
    schema List<UserPoolSchemaAttribute>
    smsAuthenticationMessage String
    smsConfiguration UserPoolSmsConfiguration
    smsVerificationMessage String
    userAttributeUpdateSettings UserPoolUserAttributeUpdateSettings
    userPoolAddOns UserPoolAddOns
    userPoolId String
    userPoolName String
    userPoolTags Map<String,String>
    usernameAttributes List<String>
    usernameConfiguration UserPoolUsernameConfiguration
    verificationMessageTemplate UserPoolVerificationMessageTemplate
    accountRecoverySetting UserPoolAccountRecoverySetting
    adminCreateUserConfig UserPoolAdminCreateUserConfig
    aliasAttributes string[]
    arn string
    autoVerifiedAttributes string[]
    deletionProtection string
    deviceConfiguration UserPoolDeviceConfiguration
    emailConfiguration UserPoolEmailConfiguration
    emailVerificationMessage string
    emailVerificationSubject string
    lambdaConfig UserPoolLambdaConfig
    mfaConfiguration string
    policies UserPoolPolicies
    providerName string
    providerUrl string
    schema UserPoolSchemaAttribute[]
    smsAuthenticationMessage string
    smsConfiguration UserPoolSmsConfiguration
    smsVerificationMessage string
    userAttributeUpdateSettings UserPoolUserAttributeUpdateSettings
    userPoolAddOns UserPoolAddOns
    userPoolId string
    userPoolName string
    userPoolTags {[key: string]: string}
    usernameAttributes string[]
    usernameConfiguration UserPoolUsernameConfiguration
    verificationMessageTemplate UserPoolVerificationMessageTemplate
    account_recovery_setting UserPoolAccountRecoverySetting
    admin_create_user_config UserPoolAdminCreateUserConfig
    alias_attributes Sequence[str]
    arn str
    auto_verified_attributes Sequence[str]
    deletion_protection str
    device_configuration UserPoolDeviceConfiguration
    email_configuration UserPoolEmailConfiguration
    email_verification_message str
    email_verification_subject str
    lambda_config UserPoolLambdaConfig
    mfa_configuration str
    policies UserPoolPolicies
    provider_name str
    provider_url str
    schema Sequence[UserPoolSchemaAttribute]
    sms_authentication_message str
    sms_configuration UserPoolSmsConfiguration
    sms_verification_message str
    user_attribute_update_settings UserPoolUserAttributeUpdateSettings
    user_pool_add_ons UserPoolAddOns
    user_pool_id str
    user_pool_name str
    user_pool_tags Mapping[str, str]
    username_attributes Sequence[str]
    username_configuration UserPoolUsernameConfiguration
    verification_message_template UserPoolVerificationMessageTemplate

    Supporting Types

    UserPoolAccountRecoverySetting

    UserPoolAddOns

    UserPoolAdminCreateUserConfig

    UserPoolCustomEmailSender

    UserPoolCustomSmsSender

    UserPoolDeviceConfiguration

    UserPoolEmailConfiguration

    UserPoolInviteMessageTemplate

    UserPoolLambdaConfig

    UserPoolNumberAttributeConstraints

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

    UserPoolPasswordPolicy

    UserPoolPolicies

    UserPoolPreTokenGenerationConfig

    UserPoolRecoveryOption

    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

    UserPoolSmsConfiguration

    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

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

    UserPoolUserAttributeUpdateSettings

    UserPoolUsernameConfiguration

    UserPoolVerificationMessageTemplate

    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