AWSCognitoIdentityProviderCreateUserPoolRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

Represents the request to create a user pool.

Required parameters: [PoolName]

  adminCreateUserConfig

The configuration for AdminCreateUser requests.

@property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType *adminCreateUserConfig

Declared In

AWSCognitoIdentityProviderModel.h

  aliasAttributes

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

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

Declared In

AWSCognitoIdentityProviderModel.h

  autoVerifiedAttributes

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

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

Declared In

AWSCognitoIdentityProviderModel.h

  deviceConfiguration

The device configuration.

@property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType *deviceConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  emailConfiguration

The email configuration.

@property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType *emailConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  emailVerificationMessage

A string representing the email verification message.

@property (nonatomic, strong) NSString *emailVerificationMessage

Declared In

AWSCognitoIdentityProviderModel.h

  emailVerificationSubject

A string representing the email verification subject.

@property (nonatomic, strong) NSString *emailVerificationSubject

Declared In

AWSCognitoIdentityProviderModel.h

  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 .

@property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType *lambdaConfig

Declared In

AWSCognitoIdentityProviderModel.h

  mfaConfiguration

Specifies MFA configuration details.

@property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  policies

The policies associated with the new user pool.

@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType *policies

Declared In

AWSCognitoIdentityProviderModel.h

  poolName

A string used to name the user pool.

@property (nonatomic, strong) NSString *poolName

Declared In

AWSCognitoIdentityProviderModel.h

  schema

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

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

Declared In

AWSCognitoIdentityProviderModel.h

  smsAuthenticationMessage

A string representing the SMS authentication message.

@property (nonatomic, strong) NSString *smsAuthenticationMessage

Declared In

AWSCognitoIdentityProviderModel.h

  smsConfiguration

The SMS configuration.

@property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType *smsConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  smsVerificationMessage

A string representing the SMS verification message.

@property (nonatomic, strong) NSString *smsVerificationMessage

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolAddOns

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

@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType *userPoolAddOns

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolTags

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

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

Declared In

AWSCognitoIdentityProviderModel.h

  usernameAttributes

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

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

Declared In

AWSCognitoIdentityProviderModel.h

  verificationMessageTemplate

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

@property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType *verificationMessageTemplate

Declared In

AWSCognitoIdentityProviderModel.h