NAME

Paws::CognitoIdp::UserPoolType

USAGE

This class represents one of two things:

Arguments in a call to a service

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 => { AdminCreateUserConfig => $value, ..., UserPoolTags => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserPoolType object:

$result = $service_obj->Method(...);
$result->Att1->AdminCreateUserConfig

DESCRIPTION

A container for information about the user pool type.

ATTRIBUTES

AdminCreateUserConfig => Paws::CognitoIdp::AdminCreateUserConfigType

The configuration for C<AdminCreateUser> requests.

AliasAttributes => ArrayRef[Str|Undef]

Specifies the attributes that are aliased in a user pool.

AutoVerifiedAttributes => ArrayRef[Str|Undef]

Specifies the attributes that are auto-verified in a user pool.

CreationDate => Str

The date the user pool was created.

DeviceConfiguration => Paws::CognitoIdp::DeviceConfigurationType

The device configuration.

EmailConfiguration => Paws::CognitoIdp::EmailConfigurationType

The email configuration.

EmailConfigurationFailure => Str

The reason why the email configuration cannot send the messages to your
users.

EmailVerificationMessage => Str

The contents of the email verification message.

EmailVerificationSubject => Str

The subject of the email verification message.

EstimatedNumberOfUsers => Int

A number estimating the size of the user pool.

Id => Str

The ID of the user pool.

LambdaConfig => Paws::CognitoIdp::LambdaConfigType

A container for the AWS Lambda triggers associated with a user pool.

LastModifiedDate => Str

The date the user pool was last modified.

MfaConfiguration => Str

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.

Name => Str

The name of the user pool.

Policies => Paws::CognitoIdp::UserPoolPolicyType

A container for the policies associated with a user pool.

SchemaAttributes => ArrayRef[Paws::CognitoIdp::SchemaAttributeType]

A container with the schema attributes of a user pool.

SmsAuthenticationMessage => Str

The contents of the SMS authentication message.

SmsConfiguration => Paws::CognitoIdp::SmsConfigurationType

The SMS configuration.

SmsConfigurationFailure => Str

The reason why the SMS configuration cannot send the messages to your
users.

SmsVerificationMessage => Str

The contents of the SMS verification message.

Status => Str

The status of a user pool.

UserPoolTags => Paws::CognitoIdp::UserPoolTagsType

The cost allocation tags for the user pool. For more information, see
Adding Cost Allocation Tags to Your User Pool

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

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