AWSCognitoIdentityProviderCreateUserPoolRequest
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolRequest
Swift
class AWSCognitoIdentityProviderCreateUserPoolRequest
Represents the request to create a user pool.
Required parameters: [PoolName]
-
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.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderAccountRecoverySettingType *_Nullable accountRecoverySetting;
Swift
var accountRecoverySetting: AWSCognitoIdentityProviderAccountRecoverySettingType? { get set }
-
The configuration for
AdminCreateUser
requests.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType *_Nullable adminCreateUserConfig;
Swift
var adminCreateUserConfig: AWSCognitoIdentityProviderAdminCreateUserConfigType? { get set }
-
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 }
-
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 }
-
The device configuration.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType *_Nullable deviceConfiguration;
Swift
var deviceConfiguration: AWSCognitoIdentityProviderDeviceConfigurationType? { get set }
-
The email configuration.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType *_Nullable emailConfiguration;
Swift
var emailConfiguration: AWSCognitoIdentityProviderEmailConfigurationType? { get set }
-
A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable emailVerificationMessage;
Swift
var emailVerificationMessage: String? { get set }
-
A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable emailVerificationSubject;
Swift
var emailVerificationSubject: String? { get set }
-
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 (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType *_Nullable lambdaConfig;
Swift
var lambdaConfig: AWSCognitoIdentityProviderLambdaConfigType? { get set }
-
Specifies MFA configuration details.
Declaration
Objective-C
@property (nonatomic) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;
Swift
var mfaConfiguration: AWSCognitoIdentityProviderUserPoolMfaType { get set }
-
The policies associated with the new user pool.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType *_Nullable policies;
Swift
var policies: AWSCognitoIdentityProviderUserPoolPolicyType? { get set }
-
A string used to name the user pool.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable poolName;
Swift
var poolName: String? { get set }
-
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 }
-
A string representing the SMS authentication message.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable smsAuthenticationMessage;
Swift
var smsAuthenticationMessage: String? { get set }
-
The SMS configuration.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType *_Nullable smsConfiguration;
Swift
var smsConfiguration: AWSCognitoIdentityProviderSmsConfigurationType? { get set }
-
A string representing the SMS verification message.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable smsVerificationMessage;
Swift
var smsVerificationMessage: String? { get set }
-
Used to enable advanced security risk detection. Set the key
AdvancedSecurityMode
to the value “AUDIT”.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType *_Nullable userPoolAddOns;
Swift
var userPoolAddOns: AWSCognitoIdentityProviderUserPoolAddOnsType? { get set }
-
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 }
-
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable usernameAttributes;
Swift
var usernameAttributes: [String]? { get set }
-
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 UsernameConfigurationType.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderUsernameConfigurationType *_Nullable usernameConfiguration;
Swift
var usernameConfiguration: AWSCognitoIdentityProviderUsernameConfigurationType? { get set }
-
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 }