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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SchemaAttributeType as input to an Aws::Client method, you can use a vanilla 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.

Possible values:

  • String
  • Number
  • DateTime
  • Boolean

Returns:

  • (String)

    The attribute data type.

#developer_only_attributeBoolean

Specifies whether the attribute type is developer only.

Returns:

  • (Boolean)

    Specifies whether the attribute type is developer only.

#mutableBoolean

Specifies whether the attribute can be changed once it has been created.

Returns:

  • (Boolean)

    Specifies whether the attribute can be changed once it has been created.

#nameString

A schema attribute of the name type.

Returns:

  • (String)

    A schema attribute of the name type.

#number_attribute_constraintsTypes::NumberAttributeConstraintsType

Specifies the constraints for an attribute of the number type.

Returns:

#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)

    Specifies whether a user pool attribute is required.

#string_attribute_constraintsTypes::StringAttributeConstraintsType

Specifies the constraints for an attribute of the string type.

Returns: