Paws::CognitoIdp::UserPoolType
This class represents one of two things:
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CognitoIdp::UserPoolType object:
$service_obj->Method(Att1 => { AccountRecoverySetting => $value, ..., VerificationMessageTemplate => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserPoolType object:
$result = $service_obj->Method(...); $result->Att1->AccountRecoverySetting
A container for information about the user pool.
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.
ForgotPassword
The configuration for AdminCreateUser requests.
AdminCreateUser
Specifies the attributes that are aliased in a user pool.
The Amazon Resource Name (ARN) for the user pool.
Specifies the attributes that are auto-verified in a user pool.
The date the user pool was created.
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.
auth.example.com
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).
The device configuration.
Holds the domain prefix if the user pool has a domain associated with it.
The email configuration.
The reason why the email configuration cannot send the messages to your users.
The contents of the email verification message.
The subject of the email verification message.
A number estimating the size of the user pool.
The ID of the user pool.
The AWS Lambda triggers associated with the user pool.
The date the user pool was last modified.
Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
OFF
ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
ON
OPTIONAL - Users have the option when registering to create an MFA token.
OPTIONAL
The name of the user pool.
The policies associated with the user pool.
A container with the schema attributes of a user pool.
The contents of the SMS authentication message.
The SMS configuration.
The reason why the SMS configuration cannot 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 IAM role which Cognito uses to send SMS messages is not properly configured. For more information, see SmsConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html).
SNSSandbox - The AWS account is in SNS Sandbox and messages won’t reach unverified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your AWS account out of the sandbox, see Moving out of the SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html).
The contents of the SMS verification message.
The status of a user pool.
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
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 (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html).
False
The user pool add-ons.
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.
The template for verification messages.
This class forms part of Paws, describing an object used in Paws::CognitoIdp
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.