ICognitoIdentityProviderCreateUserPoolRequest

Interface in AWS.CognitoIdentityProvider

Interface for CreateUserPool requests.

Ancestors

• ICognitoIdentityProviderRequest

Properties

AccountRecoverySetting

property AccountRecoverySetting: ICognitoIdentityProviderAccountRecoverySettingType

Type: ICognitoIdentityProviderAccountRecoverySettingType

Specify the available verified methods a user can use to recover their password when they call ForgotPassword.

This can be used to define a preferred method when a user has more than one available. When not specified, Amazon Cognito uses the legacy behaviour to determine the recovery method where SMS is preferred through email.

AdminCreateUserConfig

property AdminCreateUserConfig: ICognitoIdentityProviderAdminCreateUserConfigType

Type: ICognitoIdentityProviderAdminCreateUserConfigType

Specify configuration for AdminCreateUser requests.

AliasAttributes

property AliasAttributes: TList<string>

Specify the attributes supported as an alias for the user pool.

Valid values: email | phone_number | preferred_username.

AutoVerifiedAttributes

property AutoVerifiedAttributes: TList<string>

Specify a list of attributes to be auto-verified.

Valid values: email | phone_number.

DeletionProtection

property DeletionProtection: string

Prevent accidental deletion of the user pool.

Valid values: ACTIVE | INACTIVE. Set to ACTIVE to prevent deletion of the user pool with DeleteUserPool. To delete a protected user pool, set this to inactive using UpdateUserPool before calling DeleteUserPool.

DeviceConfiguration

property DeviceConfiguration: ICognitoIdentityProviderDeviceConfigurationType

Type: ICognitoIdentityProviderDeviceConfigurationType

Specify the device-remembering configuration for a user pool. When not specified, device remembering is deactivated for a user pool.

EmailConfiguration

property EmailConfiguration: ICognitoIdentityProviderEmailConfigurationType

Type: ICognitoIdentityProviderEmailConfigurationType

Specify the email configuration of the user pool.

EmailVerificationMessage

property EmailVerificationMessage: string

No longer used. See VerificationMessageTemplate.

EmailVerificationSubject

property EmailVerificationSubject: string

No longer used. See VerificationMessageTemplate.

LambdaConfig

property LambdaConfig: ICognitoIdentityProviderLambdaConfigType

Type: ICognitoIdentityProviderLambdaConfigType

Specify the Lambda trigger configuration for the user pool.

MfaConfiguration

property MfaConfiguration: string

Specify the multi-factor authentication (MFA) configuration.

Valid values: - OFF: MFA will not be used. - ON: MFA is required for all users to sign in. - OPTIONAL: MFA is required for users who have activated an MFA option.

Policies

property Policies: ICognitoIdentityProviderUserPoolPolicyType

Type: ICognitoIdentityProviderUserPoolPolicyType

Specify policies to associate with the user pool.

PoolName

property PoolName: string

Specify a name for the user pool.

Schema

property Schema: TList<ICognitoIdentityProviderSchemaAttributeType>

Type: ICognitoIdentityProviderSchemaAttributeType

A list of schema attributes for the new user pool.

SmsAuthenticationMessage

property SmsAuthenticationMessage: string

Specify the SMS authentication message.

SmsConfiguration

property SmsConfiguration: ICognitoIdentityProviderSmsConfigurationType

Type: ICognitoIdentityProviderSmsConfigurationType

Specify 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).

SmsVerificationMessage

property SmsVerificationMessage: string

No longer used. See VerificationMessageTemplate.

UserAttributeUpdateSettings

property UserAttributeUpdateSettings: ICognitoIdentityProviderUserAttributeUpdateSettingsType

Type: ICognitoIdentityProviderUserAttributeUpdateSettingsType

Specify settings for updates to user attributes.

UsernameAttributes

property UsernameAttributes: TList<string>

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

Valid values: email | phone_number.

UsernameConfiguration

property UsernameConfiguration: ICognitoIdentityProviderUsernameConfigurationType

Type: ICognitoIdentityProviderUsernameConfigurationType

Specify configuration for usernames.

UserPoolAddOns

property UserPoolAddOns: ICognitoIdentityProviderUserPoolAddOnsType

Type: ICognitoIdentityProviderUserPoolAddOnsType

Enable or disable user pool add-ons such as advanced security risk detection.

UserPoolTags

property UserPoolTags: TDictionary<string, string>

Specify key-value pairs to assign to the user pool. Tags are labels used to categorize and manage user pools in different ways.

VerificationMessageTemplate

property VerificationMessageTemplate: ICognitoIdentityProviderVerificationMessageTemplateType

Type: ICognitoIdentityProviderVerificationMessageTemplateType

Specify a template for the verification message that users will receive when the app requests permission to access the user's information.

Methods

AddAliasAttribute

function AddAliasAttribute(const AAliasAttribute: string): Integer;

Add an alias attribute to AliasAttributes.

Parameters

Name	Description
AAliasAttribute	Specify the alias attribute to add to AliasAttributes. Valid values:||.

Returns

Returns the index of the added alias attribute.

AddAutoVerifiedAttribute

function AddAutoVerifiedAttribute(const AAutoVerifiedAttribute: string): Integer;

Add an attribute to AutoVerifiedAttributes.

Parameters

Name	Description
AAutoVerifiedAttribute	Speicfy an attribute to add to AutoVerifiedAttributes. Valid values:|.

Returns

Returns the index of the attribute.

AddSchemaAttribute

function AddSchemaAttribute(const ASchemaAttribute: ICognitoIdentityProviderSchemaAttributeType): Integer;

ICognitoIdentityProviderSchemaAttributeType

Add a schema attribute to Schema.

Parameters

Name	Description
ASchemaAttribute	Add a schema attribute to Schema.

Returns

Returns the index of the added schema attribute.

AddUsernameAttribute

function AddUsernameAttribute(const AUsernameAttribute: string): Integer;

Add a username attribute to UsernameAttributes.

Parameters

Name	Description
AUsernameAttribute	Specify a username attribute to add to UsernameAttributes. Valid values:|.

Returns

Returns the index of the username attribute added to UsernameAttributes.

AddUserPoolTag

procedure AddUserPoolTag(const AKey, AValue: string);

Add a key-value pair to UserPoolTags.

Parameters

Name	Description
AKey	Specify the key.
AValue	Specify the value.