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

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

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 AddCustomAttributesRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  custom_attributes: [ # required
    {
      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",
      },
    },
  ],
}

Represents the request to add custom attributes.

Instance Attribute Summary collapse

Instance Attribute Details

#custom_attributesArray<Types::SchemaAttributeType>

An array of custom attributes, such as Mutable and Name.

Returns:



48
49
50
51
52
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 48

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

#user_pool_idString

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

Returns:

  • (String)


48
49
50
51
52
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 48

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