Skip to main content
Version: 2.1

ICognitoIdentityProviderUserPoolType

Interface in AWS.CognitoIdentityProvider

Interface for UserPoolType.

Properties​

AccountRecoverySetting​

property AccountRecoverySetting: ICognitoIdentityProviderAccountRecoverySettingType

Type: ICognitoIdentityProviderAccountRecoverySettingType

The verified methods a user can use to recover their password when they call ForgotPassword.

AdminCreateUserConfig​

property AdminCreateUserConfig: ICognitoIdentityProviderAdminCreateUserConfigType

Type: ICognitoIdentityProviderAdminCreateUserConfigType

The configuration for AdminCreateUser requests.

AliasAttributes​

property AliasAttributes: TList<string>

The attributes that are aliased in the user pool.

Arn​

property Arn: TARN

The Amazon Resource Name (ARN) of the user pool.

AutoVerifiedAttributes​

property AutoVerifiedAttributes: TList<string>

The attributes that are auto-verified by the user pool.

Valid values: email | phone_number.

CreationDate​

property CreationDate: TOptional<TDateTime>

The date and time when the user pool was created.

CustomDomain​

property CustomDomain: string

The custom domain name that you provided to Amazon Cognito.

DeletionProtection​

property DeletionProtection: string

Specifies whether the user pool as deletion protection enabled or not.

Valid values: ACTIVE | INACTIVE.

DeviceConfiguration​

property DeviceConfiguration: ICognitoIdentityProviderDeviceConfigurationType

Type: ICognitoIdentityProviderDeviceConfigurationType

The device-remembering configuration for the user pool.

Will be nil if deactivated.

Domain​

property Domain: string

The domain prefix.

Only if user pool is associated with a domain.

EmailConfiguration​

property EmailConfiguration: ICognitoIdentityProviderEmailConfigurationType

Type: ICognitoIdentityProviderEmailConfigurationType

The email configuration for the user pool.

EmailConfigurationFailure​

property EmailConfigurationFailure: string

Deprecated. Use AWS CloudTrail to inspect error codes from EventSource:cognito-idp.amazonaws.com to review error codes relating to the user pool.

EmailVerificationMessage​

property EmailVerificationMessage: string

No longer used. See VerificationMessageTemplate instead.

EmailVerificationSubject​

property EmailVerificationSubject: string

No longer used. See VerificationMessageTemplate instead.

EstimatedNumberOfUsers​

property EstimatedNumberOfUsers: TOptional<Integer>

The estimated size of the user pool.

Id​

property Id: string

The ID of the user pool.

LambdaConfig​

property LambdaConfig: ICognitoIdentityProviderLambdaConfigType

Type: ICognitoIdentityProviderLambdaConfigType

The AWS Lambda triggers associated with the user pool.

LastModifiedDate​

property LastModifiedDate: TOptional<TDateTime>

The date and time the user pool was last modified.

MfaConfiguration​

property MfaConfiguration: string

The Multi-Factor Authentication (MFA) configuration.

Name​

property Name: string

The name of the user pool.

Policies​

property Policies: ICognitoIdentityProviderUserPoolPolicyType

Type: ICognitoIdentityProviderUserPoolPolicyType

The policies associated with the user pool.

SchemaAttributes​

property SchemaAttributes: TList<ICognitoIdentityProviderSchemaAttributeType>

Type: ICognitoIdentityProviderSchemaAttributeType

The schema attributes of the user pool.

SmsAuthenticationMessage​

property SmsAuthenticationMessage: string

The content of the SMS authentication message.

SmsConfiguration​

property SmsConfiguration: ICognitoIdentityProviderSmsConfigurationType

Type: ICognitoIdentityProviderSmsConfigurationType

The SMS configuration with settings that your Amazon Cognito user pool uses to send SMS messages from your AWS account through Amazon Simple Notification Service (SNS).

SmsConfigurationFailure​

property SmsConfigurationFailure: string

The reason why the SMS configuration is unable to send messages to your users.

If the SMS configuration is unable to send messages, the value of this may contain the following values seperated by commas indicating the reason:

SmsVerificationMessage​

property SmsVerificationMessage: string

No longer used. See VerificationMessageTemplate instead.

Status​

property Status: string

The status of the user pool.

Valid values: Disabled | Enabled.

UserAttributeUpdateSettings​

property UserAttributeUpdateSettings: ICognitoIdentityProviderUserAttributeUpdateSettingsType

Type: ICognitoIdentityProviderUserAttributeUpdateSettingsType

Settings for updates to user attributes.

UsernameAttributes​

property UsernameAttributes: TList<string>

The attributes which can be used as a username when signing up.

Valid values: email | phone_number.

UsernameConfiguration​

property UsernameConfiguration: ICognitoIdentityProviderUsernameConfigurationType

Type: ICognitoIdentityProviderUsernameConfigurationType

Configuration for usernames.

UserPoolAddOns​

property UserPoolAddOns: ICognitoIdentityProviderUserPoolAddOnsType

Type: ICognitoIdentityProviderUserPoolAddOnsType

The user pool add-ons.

UserPoolTags​

property UserPoolTags: TDictionary<string, string>

Key-value pairs assigned to the user pool. Tags are labels used to categorize and manage user pools in different ways.

VerificationMessageTemplate​

property VerificationMessageTemplate: ICognitoIdentityProviderVerificationMessageTemplateType

Type: ICognitoIdentityProviderVerificationMessageTemplateType

The template for verification messages.