AWSCognitoIdentityProviderUserPoolType

Objective-C

@interface AWSCognitoIdentityProviderUserPoolType

Swift

class AWSCognitoIdentityProviderUserPoolType

A container for information about the user pool.

  • The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn’t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through 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 }

  • The attributes that are aliased in a user pool.

    Declaration

    Objective-C

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

    Swift

    var aliasAttributes: [String]? { get set }
  • arn

    The Amazon Resource Name (ARN) for the user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable arn;

    Swift

    var arn: String? { get set }

  • The attributes that are auto-verified in a user pool.

    Declaration

    Objective-C

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

    Swift

    var autoVerifiedAttributes: [String]? { get set }

  • The date and time, in ISO 8601 format, when the item was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationDate;

    Swift

    var creationDate: Date? { get set }

  • 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. An example of a custom domain name might be 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable customDomain;

    Swift

    var customDomain: String? { get set }

  • When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderDeletionProtectionType deletionProtection;

    Swift

    var deletionProtection: AWSCognitoIdentityProviderDeletionProtectionType { get set }

  • The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

    Declaration

    Objective-C

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

    Swift

    var deviceConfiguration: AWSCognitoIdentityProviderDeviceConfigurationType? { get set }

  • The domain prefix, if the user pool has a domain associated with it.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable domain;

    Swift

    var domain: String? { get set }

  • The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

    Declaration

    Objective-C

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

    Swift

    var emailConfiguration: AWSCognitoIdentityProviderEmailConfigurationType? { get set }

  • Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable emailConfigurationFailure;

    Swift

    var emailConfigurationFailure: String? { get set }

  • This parameter is no longer used. See VerificationMessageTemplateType.

    Declaration

    Objective-C

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

    Swift

    var emailVerificationMessage: String? { get set }

  • This parameter is no longer used. See VerificationMessageTemplateType.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable emailVerificationSubject;

    Swift

    var emailVerificationSubject: String? { get set }

  • A number estimating the size of the user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable estimatedNumberOfUsers;

    Swift

    var estimatedNumberOfUsers: NSNumber? { get set }

  • The ID of the user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable identifier;

    Swift

    var identifier: String? { get set }

  • The Lambda triggers associated with the user pool.

    Declaration

    Objective-C

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

    Swift

    var lambdaConfig: AWSCognitoIdentityProviderLambdaConfigType? { get set }

  • The date and time, in ISO 8601 format, when the item was modified.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable lastModifiedDate;

    Swift

    var lastModifiedDate: Date? { get set }

  • Can be one of the following values:

    • OFF - MFA tokens aren’t required and can’t be specified during user registration.

    • ON - MFA tokens are required for all user registrations. You can only specify required when you’re initially creating a user pool.

    • OPTIONAL - Users have the option when registering to create an MFA token.

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration;

    Swift

    var mfaConfiguration: AWSCognitoIdentityProviderUserPoolMfaType { get set }

  • The name of the user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

  • The policies associated with the user pool.

    Declaration

    Objective-C

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

    Swift

    var policies: AWSCognitoIdentityProviderUserPoolPolicyType? { get set }

  • A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

    Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderSchemaAttributeType *> *_Nullable schemaAttributes;

    Swift

    var schemaAttributes: [AWSCognitoIdentityProviderSchemaAttributeType]? { get set }

  • The contents of the SMS authentication message.

    Declaration

    Objective-C

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

    Swift

    var smsAuthenticationMessage: String? { get set }

  • The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

    Declaration

    Objective-C

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

    Swift

    var smsConfiguration: AWSCognitoIdentityProviderSmsConfigurationType? { get set }

  • The reason why the SMS configuration can’t send the messages to your users.

    This message might include comma-separated values to describe why your SMS configuration can’t send messages to user pool end users.

    InvalidSmsRoleAccessPolicyException

    The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn’t properly configured. For more information, see SmsConfigurationType.

    SNSSandbox

    The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable smsConfigurationFailure;

    Swift

    var smsConfigurationFailure: String? { get set }

  • This parameter is no longer used. See VerificationMessageTemplateType.

    Declaration

    Objective-C

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

    Swift

    var smsVerificationMessage: String? { get set }

  • This parameter is no longer used.

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderStatusType status;

    Swift

    var status: AWSCognitoIdentityProviderStatusType { get set }

  • The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderUserAttributeUpdateSettingsType *_Nullable userAttributeUpdateSettings;

    Swift

    var userAttributeUpdateSettings: AWSCognitoIdentityProviderUserAttributeUpdateSettingsType? { get set }

  • User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

    For more information, see Adding advanced security to a user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolAddOnsType *_Nullable userPoolAddOns;

    Swift

    var userPoolAddOns: AWSCognitoIdentityProviderUserPoolAddOnsType? { get set }

  • 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

    Objective-C

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

    Swift

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

  • Specifies whether a user can use an email address or phone number as a username when they sign up.

    Declaration

    Objective-C

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

    Swift

    var usernameAttributes: [String]? { get set }

  • Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can 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 verification messages.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType *_Nullable verificationMessageTemplate;

    Swift

    var verificationMessageTemplate: AWSCognitoIdentityProviderVerificationMessageTemplateType? { get set }