AWSCognitoIdentityProviderCreateUserPoolRequest Class Reference


                    
                    
                    accountRecoverySetting

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.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderAccountRecoverySettingType *_Nullable accountRecoverySetting;

Swift

var accountRecoverySetting: AWSCognitoIdentityProviderAccountRecoverySettingType? { get set }


                    
                    
                    adminCreateUserConfig

The configuration for AdminCreateUser requests.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType *_Nullable adminCreateUserConfig;

Swift

var adminCreateUserConfig: AWSCognitoIdentityProviderAdminCreateUserConfigType? { get set }


                    
                    
                    aliasAttributes

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<NSString *> *_Nullable aliasAttributes;

Swift

var aliasAttributes: [String]? { get set }


                    
                    
                    autoVerifiedAttributes

The attributes to be auto-verified. Possible values: email, phone_number.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<NSString *> *_Nullable autoVerifiedAttributes;

Swift

var autoVerifiedAttributes: [String]? { get set }


                    
                    
                    deletionProtection

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.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

Declaration

Objective-C

@property (nonatomic) AWSCognitoIdentityProviderDeletionProtectionType deletionProtection;

Swift

var deletionProtection: AWSCognitoIdentityProviderDeletionProtectionType { get set }


                    
                    
                    deviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType *_Nullable deviceConfiguration;

Swift

var deviceConfiguration: AWSCognitoIdentityProviderDeviceConfigurationType? { get set }


                    
                    
                    emailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType *_Nullable emailConfiguration;

Swift

var emailConfiguration: AWSCognitoIdentityProviderEmailConfigurationType? { get set }


                    
                    
                    emailVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable emailVerificationMessage;

Swift

var emailVerificationMessage: String? { get set }


                    
                    
                    emailVerificationSubject

This parameter is no longer used. See VerificationMessageTemplateType.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable emailVerificationSubject;

Swift

var emailVerificationSubject: String? { get set }


                    
                    
                    lambdaConfig

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the CLI, see add-permission .

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType *_Nullable lambdaConfig;

Swift

var lambdaConfig: AWSCognitoIdentityProviderLambdaConfigType? { get set }


                    
                    
                    mfaConfiguration

Specifies MFA configuration details.

Declaration

Objective-C

@property (nonatomic) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;

Swift

var mfaConfiguration: AWSCognitoIdentityProviderUserPoolMfaType { get set }


                    
                    
                    policies

The policies associated with the new user pool.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType *_Nullable policies;

Swift

var policies: AWSCognitoIdentityProviderUserPoolPolicyType? { get set }


                    
                    
                    poolName

A string used to name the user pool.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable poolName;

Swift

var poolName: String? { get set }


                    
                    
                    schema

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderSchemaAttributeType *> *_Nullable schema;

Swift

var schema: [AWSCognitoIdentityProviderSchemaAttributeType]? { get set }


                    
                    
                    smsAuthenticationMessage

A string representing the SMS authentication message.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable smsAuthenticationMessage;

Swift

var smsAuthenticationMessage: String? { get set }


                    
                    
                    smsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType *_Nullable smsConfiguration;

Swift

var smsConfiguration: AWSCognitoIdentityProviderSmsConfigurationType? { get set }


                    
                    
                    smsVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable smsVerificationMessage;

Swift

var smsVerificationMessage: String? { get set }


                    
                    
                    userAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderUserAttributeUpdateSettingsType *_Nullable userAttributeUpdateSettings;

Swift

var userAttributeUpdateSettings: AWSCognitoIdentityProviderUserAttributeUpdateSettingsType? { get set }


                    
                    
                    userPoolAddOns

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType *_Nullable userPoolAddOns;

Swift

var userPoolAddOns: AWSCognitoIdentityProviderUserPoolAddOnsType? { get set }


                    
                    
                    userPoolTags

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Declaration

Objective-C

@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable userPoolTags;

Swift

var userPoolTags: [String : String]? { get set }


                    
                    
                    usernameAttributes

Specifies whether a user can use an email address or phone number as a username when they sign up.

Declaration

Objective-C

@property (nonatomic, strong) NSArray<NSString *> *_Nullable usernameAttributes;

Swift

var usernameAttributes: [String]? { get set }


                    
                    
                    usernameConfiguration

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderUsernameConfigurationType *_Nullable usernameConfiguration;

Swift

var usernameConfiguration: AWSCognitoIdentityProviderUsernameConfigurationType? { get set }


                    
                    
                    verificationMessageTemplate

The template for the verification message that the user sees when the app requests permission to access the user’s information.

Declaration

Objective-C

@property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType *_Nullable verificationMessageTemplate;

Swift

var verificationMessageTemplate: AWSCognitoIdentityProviderVerificationMessageTemplateType? { get set }