Class: Aws::CognitoIdentityProvider::Types::SchemaAttributeType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 ‘dev:` attributes are a legacy feature of user pools, and 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.

This data type is a request and response parameter of

CreateUserPool][2

and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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”`.

Returns:

  • (String) 


9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

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

<note markdown=“1”> You should use [WriteAttributes] 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 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.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes

Returns:

  • (Boolean) 


9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html

Returns:

  • (Boolean) 


9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

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..

Returns:

  • (String) 


9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

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.

Returns:



9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

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.

Returns:

  • (Boolean) 


9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

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.

Returns:



9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9656

class SchemaAttributeType < Struct.new(
  :name,
  :attribute_data_type,
  :developer_only_attribute,
  :mutable,
  :required,
  :number_attribute_constraints,
  :string_attribute_constraints)
  SENSITIVE = []
  include Aws::Structure
end