Class: Aws::CognitoIdentityProvider::Types::SchemaAttributeType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::SchemaAttributeType
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
A list of the user attributes and their properties in your user pool.
The attribute schema contains standard attributes, custom attributes
with a custom:
prefix, and developer attributes with a dev:
prefix. For more information, see User pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attribute_data_type ⇒ String
The data format of the values for your attribute.
-
#developer_only_attribute ⇒ Boolean
You should use [WriteAttributes][1] in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute
. -
#mutable ⇒ Boolean
Specifies whether the value of the attribute can be changed.
-
#name ⇒ String
The name of your user pool attribute.
-
#number_attribute_constraints ⇒ Types::NumberAttributeConstraintsType
Specifies the constraints for an attribute of the number type.
-
#required ⇒ Boolean
Specifies whether a user pool attribute is required.
-
#string_attribute_constraints ⇒ Types::StringAttributeConstraintsType
Specifies the constraints for an attribute of the string type.
Instance Attribute Details
#attribute_data_type ⇒ String
The data format of the values for your attribute. When you choose an
AttributeDataType
, Amazon Cognito validates the input against the
data type. A custom attribute value in your user's ID token is
always a string, for example "custom:isMember" : "true"
or
"custom:YearsAsMember" : "12"
.
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |
#developer_only_attribute ⇒ Boolean
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.
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |
#mutable ⇒ Boolean
Specifies whether the value of the attribute can be changed.
Any user pool attribute whose value you map from an IdP attribute
must be mutable, with a parameter value of 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.
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of your user pool attribute. When you create or update a
user pool, adding a schema attribute creates a custom or
developer-only attribute. When you add an attribute with a Name
value of MyAttribute
, Amazon Cognito creates the custom attribute
custom:MyAttribute
. When DeveloperOnlyAttribute
is true
,
Amazon Cognito creates your attribute as dev:MyAttribute
. In an
operation that describes a user pool, Amazon Cognito returns this
value as value
for standard attributes, custom:value
for custom
attributes, and dev:value
for developer-only attributes..
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |
#number_attribute_constraints ⇒ Types::NumberAttributeConstraintsType
Specifies the constraints for an attribute of the number type.
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |
#required ⇒ Boolean
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.
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |
#string_attribute_constraints ⇒ Types::StringAttributeConstraintsType
Specifies the constraints for an attribute of the string type.
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7767 class SchemaAttributeType < Struct.new( :name, :attribute_data_type, :developer_only_attribute, :mutable, :required, :number_attribute_constraints, :string_attribute_constraints) SENSITIVE = [] include Aws::Structure end |