class Aws::CognitoIdentityProvider::Types::SchemaAttributeType
Contains information about the schema attribute.
@note When making an API call, you may pass SchemaAttributeType
data as a hash: { name: "CustomAttributeNameType", attribute_data_type: "String", # accepts String, Number, DateTime, Boolean developer_only_attribute: false, mutable: false, required: false, number_attribute_constraints: { min_value: "StringType", max_value: "StringType", }, string_attribute_constraints: { min_length: "StringType", max_length: "StringType", }, }
@!attribute [rw] name
A schema attribute of the name type. @return [String]
@!attribute [rw] attribute_data_type
The attribute data type. @return [String]
@!attribute [rw] developer_only_attribute
<note markdown="1"> We recommend that you use [WriteAttributes][1] in the user pool client to control how attributes can be mutated for new use cases instead of using `DeveloperOnlyAttribute`. </note> 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. [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes @return [Boolean]
@!attribute [rw] 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][1]. [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html @return [Boolean]
@!attribute [rw] 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. @return [Boolean]
@!attribute [rw] number_attribute_constraints
Specifies the constraints for an attribute of the number type. @return [Types::NumberAttributeConstraintsType]
@!attribute [rw] string_attribute_constraints
Specifies the constraints for an attribute of the string type. @return [Types::StringAttributeConstraintsType]
@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SchemaAttributeType AWS API Documentation
Constants
- SENSITIVE