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)


4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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

Specifies whether the attribute type is developer only.

Returns:

  • (Boolean)


4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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 attribute can be changed once it has been created.

Returns:

  • (Boolean)


4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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)


4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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.



4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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)


4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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.



4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4521

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