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, ..., VerificationMessageTemplate => $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.

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.

Arn => Str

  The Amazon Resource Name (ARN) for the 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.

CustomDomain => Str

  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: C<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).

DeviceConfiguration => Paws::CognitoIdp::DeviceConfigurationType

  The device configuration.

Domain => Str

  Holds the domain prefix if the user pool has a domain associated with
it.

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

  The AWS Lambda triggers associated with the 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

  The policies associated with the 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.

UsernameAttributes => ArrayRef[Str|Undef]

  Specifies whether email addresses or phone numbers can be specified as
usernames when a user signs up.

UserPoolAddOns => Paws::CognitoIdp::UserPoolAddOnsType

  The user pool add-ons.

UserPoolTags => Paws::CognitoIdp::UserPoolTagsType

  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.

VerificationMessageTemplate => Paws::CognitoIdp::VerificationMessageTemplateType

  The template for verification messages.

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