View on GitHub
UserPoolType Structure Reference
UserPoolType
public struct UserPoolType : AWSShapeUndocumented
-
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? -
Specifies the attributes that are aliased in a user pool.
Declaration
Swift
public let aliasAttributes: [AliasAttributeType]? -
The Amazon Resource Name (ARN) for the user pool.
Declaration
Swift
public let arn: String? -
Specifies the attributes that are auto-verified in a user pool.
Declaration
Swift
public let autoVerifiedAttributes: [VerifiedAttributeType]? -
The date the user pool was created.
Declaration
Swift
public let creationDate: TimeStamp? -
A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
Declaration
Swift
public let customDomain: String? -
The device configuration.
Declaration
Swift
public let deviceConfiguration: DeviceConfigurationType? -
Holds the domain prefix if the user pool has a domain associated with it.
Declaration
Swift
public let domain: String? -
The email configuration.
Declaration
Swift
public let emailConfiguration: EmailConfigurationType? -
The reason why the email configuration cannot send the messages to your users.
Declaration
Swift
public let emailConfigurationFailure: String? -
The contents of the email verification message.
Declaration
Swift
public let emailVerificationMessage: String? -
The subject of the email verification message.
Declaration
Swift
public let emailVerificationSubject: String? -
A number estimating the size of the user pool.
Declaration
Swift
public let estimatedNumberOfUsers: Int? -
The ID of the user pool.
Declaration
Swift
public let id: String? -
The AWS Lambda triggers associated with the user pool.
Declaration
Swift
public let lambdaConfig: LambdaConfigType? -
The date the user pool was last modified.
Declaration
Swift
public let lastModifiedDate: TimeStamp? -
Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token.
Declaration
Swift
public let mfaConfiguration: UserPoolMfaType? -
The name of the user pool.
Declaration
Swift
public let name: String? -
The policies associated with the user pool.
Declaration
Swift
public let policies: UserPoolPolicyType? -
A container with the schema attributes of a user pool.
Declaration
Swift
public let schemaAttributes: [SchemaAttributeType]? -
The contents of the SMS authentication message.
Declaration
Swift
public let smsAuthenticationMessage: String? -
The SMS configuration.
Declaration
Swift
public let smsConfiguration: SmsConfigurationType? -
The reason why the SMS configuration cannot send the messages to your users.
Declaration
Swift
public let smsConfigurationFailure: String? -
The contents of the SMS verification message.
Declaration
Swift
public let smsVerificationMessage: String? -
The status of a user pool.
Declaration
Swift
public let status: StatusType? -
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 enable 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? -
The user pool add-ons.
Declaration
Swift
public let userPoolAddOns: UserPoolAddOnsType? -
The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
Declaration
Swift
public let userPoolTags: [String : String]? -
The template for verification messages.
Declaration
Swift
public let verificationMessageTemplate: VerificationMessageTemplateType? -
init(accountRecoverySetting:adminCreateUserConfig:aliasAttributes:arn:autoVerifiedAttributes:creationDate:customDomain:deviceConfiguration:domain:emailConfiguration:emailConfigurationFailure:emailVerificationMessage:emailVerificationSubject:estimatedNumberOfUsers:id:lambdaConfig:lastModifiedDate:mfaConfiguration:name:policies:schemaAttributes:smsAuthenticationMessage:smsConfiguration:smsConfigurationFailure:smsVerificationMessage:status:usernameAttributes:usernameConfiguration:userPoolAddOns:userPoolTags:verificationMessageTemplate:)Undocumented
Declaration
Swift
public init(accountRecoverySetting: AccountRecoverySettingType? = nil, adminCreateUserConfig: AdminCreateUserConfigType? = nil, aliasAttributes: [AliasAttributeType]? = nil, arn: String? = nil, autoVerifiedAttributes: [VerifiedAttributeType]? = nil, creationDate: TimeStamp? = nil, customDomain: String? = nil, deviceConfiguration: DeviceConfigurationType? = nil, domain: String? = nil, emailConfiguration: EmailConfigurationType? = nil, emailConfigurationFailure: String? = nil, emailVerificationMessage: String? = nil, emailVerificationSubject: String? = nil, estimatedNumberOfUsers: Int? = nil, id: String? = nil, lambdaConfig: LambdaConfigType? = nil, lastModifiedDate: TimeStamp? = nil, mfaConfiguration: UserPoolMfaType? = nil, name: String? = nil, policies: UserPoolPolicyType? = nil, schemaAttributes: [SchemaAttributeType]? = nil, smsAuthenticationMessage: String? = nil, smsConfiguration: SmsConfigurationType? = nil, smsConfigurationFailure: String? = nil, smsVerificationMessage: String? = nil, status: StatusType? = nil, usernameAttributes: [UsernameAttributeType]? = nil, usernameConfiguration: UsernameConfigurationType? = nil, userPoolAddOns: UserPoolAddOnsType? = nil, userPoolTags: [String : String]? = nil, verificationMessageTemplate: VerificationMessageTemplateType? = nil)