/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CognitoIdp::SchemaAttributeType

NAME

Paws::CognitoIdp::SchemaAttributeType

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::SchemaAttributeType object:

$service_obj->Method(Att1 => { AttributeDataType => $value, ..., StringAttributeConstraints => $value  });

Results returned from an API call

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

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

DESCRIPTION

Contains information about the schema attribute.

ATTRIBUTES

AttributeDataType => Str

The attribute data type.

DeveloperOnlyAttribute => Bool

We recommend that you use WriteAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but cannot be updated using UpdateUserAttributes.

Mutable => Bool

Specifies whether the value of the attribute can be changed.

For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html).

Name => Str

A schema attribute of the name type.

NumberAttributeConstraints => Paws::CognitoIdp::NumberAttributeConstraintsType

Specifies the constraints for an attribute of the number type.

Required => Bool

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

StringAttributeConstraints => Paws::CognitoIdp::StringAttributeConstraintsType

Specifies the constraints for an attribute of the string type.

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