Paws::CognitoIdp::CreateUserPool - Arguments for method CreateUserPool on Paws::CognitoIdp
This class represents the parameters used for calling the method CreateUserPool on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method CreateUserPool.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUserPool.
my $cognito-idp = Paws->service('CognitoIdp'); my $CreateUserPoolResponse = $cognito -idp->CreateUserPool( PoolName => 'MyUserPoolNameType', AdminCreateUserConfig => { AllowAdminCreateUserOnly => 1, # OPTIONAL InviteMessageTemplate => { EmailMessage => 'MyEmailVerificationMessageType', # min: 6, max: 20000; OPTIONAL EmailSubject => 'MyEmailVerificationSubjectType', # min: 1, max: 140; OPTIONAL SMSMessage => 'MySmsVerificationMessageType', # min: 6, max: 140; OPTIONAL }, # OPTIONAL UnusedAccountValidityDays => 1, # max: 365; OPTIONAL }, # OPTIONAL AliasAttributes => [ 'phone_number', ... # values: phone_number, email, preferred_username ], # OPTIONAL AutoVerifiedAttributes => [ 'phone_number', ... # values: phone_number, email ], # OPTIONAL DeviceConfiguration => { ChallengeRequiredOnNewDevice => 1, # OPTIONAL DeviceOnlyRememberedOnUserPrompt => 1, # OPTIONAL }, # OPTIONAL EmailConfiguration => { EmailSendingAccount => 'COGNITO_DEFAULT', # values: COGNITO_DEFAULT, DEVELOPER; OPTIONAL ReplyToEmailAddress => 'MyEmailAddressType', # OPTIONAL SourceArn => 'MyArnType', # min: 20, max: 2048; OPTIONAL }, # OPTIONAL EmailVerificationMessage => 'MyEmailVerificationMessageType', # OPTIONAL EmailVerificationSubject => 'MyEmailVerificationSubjectType', # OPTIONAL LambdaConfig => { CreateAuthChallenge => 'MyArnType', # min: 20, max: 2048; OPTIONAL CustomMessage => 'MyArnType', # min: 20, max: 2048; OPTIONAL DefineAuthChallenge => 'MyArnType', # min: 20, max: 2048; OPTIONAL PostAuthentication => 'MyArnType', # min: 20, max: 2048; OPTIONAL PostConfirmation => 'MyArnType', # min: 20, max: 2048; OPTIONAL PreAuthentication => 'MyArnType', # min: 20, max: 2048; OPTIONAL PreSignUp => 'MyArnType', # min: 20, max: 2048; OPTIONAL PreTokenGeneration => 'MyArnType', # min: 20, max: 2048; OPTIONAL UserMigration => 'MyArnType', # min: 20, max: 2048; OPTIONAL VerifyAuthChallengeResponse => 'MyArnType', # min: 20, max: 2048; OPTIONAL }, # OPTIONAL MfaConfiguration => 'OFF', # OPTIONAL Policies => { PasswordPolicy => { MinimumLength => 1, # min: 6, max: 99; OPTIONAL RequireLowercase => 1, # OPTIONAL RequireNumbers => 1, # OPTIONAL RequireSymbols => 1, # OPTIONAL RequireUppercase => 1, # OPTIONAL TemporaryPasswordValidityDays => 1, # max: 365; OPTIONAL }, # OPTIONAL }, # OPTIONAL Schema => [ { AttributeDataType => 'String', # values: String, Number, DateTime, Boolean; OPTIONAL DeveloperOnlyAttribute => 1, # OPTIONAL Mutable => 1, # OPTIONAL Name => 'MyCustomAttributeNameType', # min: 1, max: 20; OPTIONAL NumberAttributeConstraints => { MaxValue => 'MyStringType', # OPTIONAL MinValue => 'MyStringType', # OPTIONAL }, # OPTIONAL Required => 1, # OPTIONAL StringAttributeConstraints => { MaxLength => 'MyStringType', # OPTIONAL MinLength => 'MyStringType', # OPTIONAL }, # OPTIONAL }, ... ], # OPTIONAL SmsAuthenticationMessage => 'MySmsVerificationMessageType', # OPTIONAL SmsConfiguration => { SnsCallerArn => 'MyArnType', # min: 20, max: 2048; OPTIONAL ExternalId => 'MyStringType', # OPTIONAL }, # OPTIONAL SmsVerificationMessage => 'MySmsVerificationMessageType', # OPTIONAL UserPoolAddOns => { AdvancedSecurityMode => 'OFF', # values: OFF, AUDIT, ENFORCED }, # OPTIONAL UserPoolTags => { 'MyTagKeysType' => 'MyTagValueType', # key: min: 1, max: 128, value: max: 256 }, # OPTIONAL UsernameAttributes => [ 'phone_number', ... # values: phone_number, email ], # OPTIONAL VerificationMessageTemplate => { DefaultEmailOption => 'CONFIRM_WITH_LINK' , # values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE; OPTIONAL EmailMessage => 'MyEmailVerificationMessageType', # min: 6, max: 20000; OPTIONAL EmailMessageByLink => 'MyEmailVerificationMessageByLinkType', # min: 6, max: 20000; OPTIONAL EmailSubject => 'MyEmailVerificationSubjectType', # min: 1, max: 140; OPTIONAL EmailSubjectByLink => 'MyEmailVerificationSubjectByLinkType', # min: 1, max: 140; OPTIONAL SmsMessage => 'MySmsVerificationMessageType', # min: 6, max: 140; OPTIONAL }, # OPTIONAL ); # Results: my $UserPool = $CreateUserPoolResponse->UserPool; # Returns a L<Paws::CognitoIdp::CreateUserPoolResponse> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/CreateUserPool
The configuration for AdminCreateUser requests.
AdminCreateUser
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
The attributes to be auto-verified. Possible values: email, phone_number.
The device configuration.
The email configuration.
A string representing the email verification message.
A string representing the email verification subject.
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 (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html).
For adding permission using the AWS CLI, see add-permission (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html).
Specifies MFA configuration details.
Valid values are: "OFF", "ON", "OPTIONAL"
"OFF"
"ON"
"OPTIONAL"
The policies associated with the new user pool.
A string used to name the user pool.
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
A string representing the SMS authentication message.
The SMS configuration.
A string representing the SMS verification message.
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
AdvancedSecurityMode
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.
The template for the verification message that the user sees when the app requests permission to access the user's information.
This class forms part of Paws, documenting arguments for method CreateUserPool 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::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.