Class: Aws::CognitoIdentityProvider::Types::AddCustomAttributesRequest

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::AddCustomAttributesRequest

show all

Defined in:: gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to add custom attributes.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#custom_attributes ⇒ Array<Types::SchemaAttributeType>
An array of custom attribute names and other properties.
#user_pool_id ⇒ String
The ID of the user pool where you want to add custom attributes.

Instance Attribute Details

#custom_attributes ⇒ `Array<Types::SchemaAttributeType>`

An array of custom attribute names and other properties. Sets the following characteristics:

AttributeDataType: The expected data type. Can be a string, a number, a date and time, or a boolean.
Mutable: If true, you can grant app clients write access to the attribute value. If false, the attribute value can only be set up on sign-up or administrator creation of users.
Name: The attribute name. For an attribute like custom:myAttribute, enter myAttribute for this field.
Required: When true, users who sign up or are created must set a value for the attribute.
NumberAttributeConstraints: The minimum and maximum length of accepted values for a Number-type attribute.
StringAttributeConstraints: The minimum and maximum length of accepted values for a String-type attribute.
DeveloperOnlyAttribute: This legacy option creates an attribute with a dev: prefix. You can only set the value of a developer-only attribute with administrative IAM credentials.

Returns:

(Array<Types::SchemaAttributeType>)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 210

class AddCustomAttributesRequest < Struct.new(
  :user_pool_id,
  :custom_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ `String`

The ID of the user pool where you want to add custom attributes.