You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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",
  },
}

Contains information about the schema attribute.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_data_typeString

The attribute data type.

Returns:

  • (String)


7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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

#developer_only_attributeBoolean

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 the API but cannot be updated using the API.

Returns:

  • (Boolean)


7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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

#mutableBoolean

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.

Returns:

  • (Boolean)


7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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

#nameString

A schema attribute of the name type.

Returns:

  • (String)


7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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

#number_attribute_constraintsTypes::NumberAttributeConstraintsType

Specifies the constraints for an attribute of the number type.



7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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

#requiredBoolean

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.

Returns:

  • (Boolean)


7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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

#string_attribute_constraintsTypes::StringAttributeConstraintsType

Specifies the constraints for an attribute of the string type.



7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7318

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