libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

Description

 
Synopsis

Documentation

data SchemaAttributeType Source #

Contains information about the schema attribute.

See: newSchemaAttributeType smart constructor.

Constructors

SchemaAttributeType' 

Fields

Instances

Instances details
Eq SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

Read SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

Show SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

Generic SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

Associated Types

type Rep SchemaAttributeType :: Type -> Type #

NFData SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

Methods

rnf :: SchemaAttributeType -> () #

Hashable SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

ToJSON SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

FromJSON SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

type Rep SchemaAttributeType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType

type Rep SchemaAttributeType = D1 ('MetaData "SchemaAttributeType" "Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "SchemaAttributeType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "numberAttributeConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumberAttributeConstraintsType)) :*: (S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "attributeDataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeDataType)))) :*: ((S1 ('MetaSel ('Just "stringAttributeConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StringAttributeConstraintsType)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "developerOnlyAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "mutable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newSchemaAttributeType :: SchemaAttributeType Source #

Create a value of SchemaAttributeType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:numberAttributeConstraints:SchemaAttributeType', schemaAttributeType_numberAttributeConstraints - Specifies the constraints for an attribute of the number type.

$sel:required:SchemaAttributeType', schemaAttributeType_required - 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.

$sel:attributeDataType:SchemaAttributeType', schemaAttributeType_attributeDataType - The attribute data type.

$sel:stringAttributeConstraints:SchemaAttributeType', schemaAttributeType_stringAttributeConstraints - Specifies the constraints for an attribute of the string type.

$sel:name:SchemaAttributeType', schemaAttributeType_name - A schema attribute of the name type.

$sel:developerOnlyAttribute:SchemaAttributeType', schemaAttributeType_developerOnlyAttribute - We recommend that you use 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.

$sel:mutable:SchemaAttributeType', schemaAttributeType_mutable - 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.

schemaAttributeType_required :: Lens' SchemaAttributeType (Maybe Bool) Source #

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.

schemaAttributeType_name :: Lens' SchemaAttributeType (Maybe Text) Source #

A schema attribute of the name type.

schemaAttributeType_developerOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool) Source #

We recommend that you use 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.

schemaAttributeType_mutable :: Lens' SchemaAttributeType (Maybe Bool) Source #

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.