CreateUserPoolRequest
public struct CreateUserPoolRequest : AWSShape
Undocumented
-
Declaration
Swift
public static var _members: [AWSShapeMember]
-
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
Swift
public let accountRecoverySetting: AccountRecoverySettingType?
-
The configuration for AdminCreateUser requests.
Declaration
Swift
public let adminCreateUserConfig: AdminCreateUserConfigType?
-
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
Declaration
Swift
public let aliasAttributes: [AliasAttributeType]?
-
The attributes to be auto-verified. Possible values: email, phone_number.
Declaration
Swift
public let autoVerifiedAttributes: [VerifiedAttributeType]?
-
The device configuration.
Declaration
Swift
public let deviceConfiguration: DeviceConfigurationType?
-
The email configuration.
Declaration
Swift
public let emailConfiguration: EmailConfigurationType?
-
A string representing the email verification message.
Declaration
Swift
public let emailVerificationMessage: String?
-
A string representing the email verification subject.
Declaration
Swift
public let emailVerificationSubject: String?
-
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
Swift
public let lambdaConfig: LambdaConfigType?
-
Specifies MFA configuration details.
Declaration
Swift
public let mfaConfiguration: UserPoolMfaType?
-
The policies associated with the new user pool.
Declaration
Swift
public let policies: UserPoolPolicyType?
-
A string used to name the user pool.
Declaration
Swift
public let poolName: String
-
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
Declaration
Swift
public let schema: [SchemaAttributeType]?
-
A string representing the SMS authentication message.
Declaration
Swift
public let smsAuthenticationMessage: String?
-
The SMS configuration.
Declaration
Swift
public let smsConfiguration: SmsConfigurationType?
-
A string representing the SMS verification message.
Declaration
Swift
public let smsVerificationMessage: String?
-
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Declaration
Swift
public let usernameAttributes: [UsernameAttributeType]?
-
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
Swift
public let usernameConfiguration: UsernameConfigurationType?
-
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value “AUDIT”.
Declaration
Swift
public let userPoolAddOns: UserPoolAddOnsType?
-
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
Swift
public let userPoolTags: [String : String]?
-
The template for the verification message that the user sees when the app requests permission to access the user’s information.
Declaration
Swift
public let verificationMessageTemplate: VerificationMessageTemplateType?
-
init(accountRecoverySetting:adminCreateUserConfig:aliasAttributes:autoVerifiedAttributes:deviceConfiguration:emailConfiguration:emailVerificationMessage:emailVerificationSubject:lambdaConfig:mfaConfiguration:policies:poolName:schema:smsAuthenticationMessage:smsConfiguration:smsVerificationMessage:usernameAttributes:usernameConfiguration:userPoolAddOns:userPoolTags:verificationMessageTemplate:)
Undocumented
Declaration
Swift
public init(accountRecoverySetting: AccountRecoverySettingType? = nil, adminCreateUserConfig: AdminCreateUserConfigType? = nil, aliasAttributes: [AliasAttributeType]? = nil, autoVerifiedAttributes: [VerifiedAttributeType]? = nil, deviceConfiguration: DeviceConfigurationType? = nil, emailConfiguration: EmailConfigurationType? = nil, emailVerificationMessage: String? = nil, emailVerificationSubject: String? = nil, lambdaConfig: LambdaConfigType? = nil, mfaConfiguration: UserPoolMfaType? = nil, policies: UserPoolPolicyType? = nil, poolName: String, schema: [SchemaAttributeType]? = nil, smsAuthenticationMessage: String? = nil, smsConfiguration: SmsConfigurationType? = nil, smsVerificationMessage: String? = nil, usernameAttributes: [UsernameAttributeType]? = nil, usernameConfiguration: UsernameConfigurationType? = nil, userPoolAddOns: UserPoolAddOnsType? = nil, userPoolTags: [String : String]? = nil, verificationMessageTemplate: VerificationMessageTemplateType? = nil)
-
Declaration
Swift
public func validate(name: String) throws