AWSCognitoIdentityProviderCreateUserPoolRequest Class Reference


                    
                    
                    accountRecoverySetting

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Starting February 1, 2020, the value of AccountRecoverySetting will default to verified_email first and verified_phone_number as the second option for newly created user pools if no value is provided.

Declaration

Objective-C

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

Swift

var accountRecoverySetting: AWSCognitoIdentityProviderAccountRecoverySettingType? { get set }


                    
                    
                    adminCreateUserConfig

The configuration for AdminCreateUser requests.

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic)
    NSArray<NSString *> *_Nullable autoVerifiedAttributes;

Swift

var autoVerifiedAttributes: [String]? { get set }


                    
                    
                    deviceConfiguration

The device configuration.

Declaration

Objective-C

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

Swift

var deviceConfiguration: AWSCognitoIdentityProviderDeviceConfigurationType? { get set }


                    
                    
                    emailConfiguration

The email configuration.

Declaration

Objective-C

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

Swift

var emailConfiguration: AWSCognitoIdentityProviderEmailConfigurationType? { get set }


                    
                    
                    emailVerificationMessage

A string representing the email verification message.

Declaration

Objective-C

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

Swift

var emailVerificationMessage: String? { get set }


                    
                    
                    emailVerificationSubject

A string representing the email verification subject.

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    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 will need to 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 AWS CLI, see add-permission .

Declaration

Objective-C

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

Swift

var lambdaConfig: AWSCognitoIdentityProviderLambdaConfigType? { get set }


                    
                    
                    mfaConfiguration

Specifies MFA configuration details.

Declaration

Objective-C

@property (assign, readwrite, nonatomic)
    AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;

Swift

var mfaConfiguration: AWSCognitoIdentityProviderUserPoolMfaType { get set }


                    
                    
                    policies

The policies associated with the new user pool.

Declaration

Objective-C

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

Swift

var policies: AWSCognitoIdentityProviderUserPoolPolicyType? { get set }


                    
                    
                    poolName

A string used to name the user pool.

Declaration

Objective-C

@property (readwrite, strong, nonatomic) 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 (readwrite, strong, nonatomic)
    NSArray<AWSCognitoIdentityProviderSchemaAttributeType *> *_Nullable schema;

Swift

var schema: [AWSCognitoIdentityProviderSchemaAttributeType]? { get set }


                    
                    
                    smsAuthenticationMessage

A string representing the SMS authentication message.

Declaration

Objective-C

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

Swift

var smsAuthenticationMessage: String? { get set }


                    
                    
                    smsConfiguration

The SMS configuration.

Declaration

Objective-C

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

Swift

var smsConfiguration: AWSCognitoIdentityProviderSmsConfigurationType? { get set }


                    
                    
                    smsVerificationMessage

A string representing the SMS verification message.

Declaration

Objective-C

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

Swift

var smsVerificationMessage: String? { get set }


                    
                    
                    userPoolAddOns

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value “AUDIT”.

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic)
    NSDictionary<NSString *, NSString *> *_Nullable userPoolTags;

Swift

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


                    
                    
                    usernameAttributes

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Declaration

Objective-C

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

Swift

var usernameAttributes: [String]? { get set }


                    
                    
                    usernameConfiguration

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either “username” or “Username”. This configuration is immutable once it has been set. For more information, see .

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic)
    AWSCognitoIdentityProviderVerificationMessageTemplateType
        *_Nullable verificationMessageTemplate;

Swift

var verificationMessageTemplate: AWSCognitoIdentityProviderVerificationMessageTemplateType? { get set }