Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.CognitoIdentityProvider.Types.SchemaAttributeType
Description
Synopsis
- data SchemaAttributeType = SchemaAttributeType' {}
- newSchemaAttributeType :: SchemaAttributeType
- schemaAttributeType_attributeDataType :: Lens' SchemaAttributeType (Maybe AttributeDataType)
- schemaAttributeType_developerOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool)
- schemaAttributeType_mutable :: Lens' SchemaAttributeType (Maybe Bool)
- schemaAttributeType_name :: Lens' SchemaAttributeType (Maybe Text)
- schemaAttributeType_numberAttributeConstraints :: Lens' SchemaAttributeType (Maybe NumberAttributeConstraintsType)
- schemaAttributeType_required :: Lens' SchemaAttributeType (Maybe Bool)
- schemaAttributeType_stringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType)
Documentation
data SchemaAttributeType Source #
Contains information about the schema attribute.
See: newSchemaAttributeType
smart constructor.
Constructors
SchemaAttributeType' | |
Fields
|
Instances
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:attributeDataType:SchemaAttributeType'
, schemaAttributeType_attributeDataType
- The attribute data type.
$sel:developerOnlyAttribute:SchemaAttributeType'
, schemaAttributeType_developerOnlyAttribute
- You should 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 won't be able to modify
this attribute using their access token. For example,
DeveloperOnlyAttribute
can be modified using AdminUpdateUserAttributes
but can't 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 is mapped to an IdP attribute, you must
set this parameter to true
. Amazon Cognito updates mapped attributes
when users sign in to your application through an IdP. 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.
$sel:name:SchemaAttributeType'
, schemaAttributeType_name
- A schema attribute of the name type.
$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 doesn't provide a value, registration or sign-in
will fail.
$sel:stringAttributeConstraints:SchemaAttributeType'
, schemaAttributeType_stringAttributeConstraints
- Specifies the constraints for an attribute of the string type.
schemaAttributeType_attributeDataType :: Lens' SchemaAttributeType (Maybe AttributeDataType) Source #
The attribute data type.
schemaAttributeType_developerOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool) Source #
You should 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 won't be able to modify
this attribute using their access token. For example,
DeveloperOnlyAttribute
can be modified using AdminUpdateUserAttributes
but can't 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 is mapped to an IdP attribute, you must
set this parameter to true
. Amazon Cognito updates mapped attributes
when users sign in to your application through an IdP. 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_name :: Lens' SchemaAttributeType (Maybe Text) Source #
A schema attribute of the name type.
schemaAttributeType_numberAttributeConstraints :: Lens' SchemaAttributeType (Maybe NumberAttributeConstraintsType) Source #
Specifies the constraints for an attribute of the number type.
schemaAttributeType_required :: Lens' SchemaAttributeType (Maybe Bool) Source #
Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
schemaAttributeType_stringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType) Source #
Specifies the constraints for an attribute of the string type.