Skip to contents

Adds additional user attributes to the user pool schema

Source: R/cognitoidentityprovider_operations.R
cognitoidentityprovider_add_custom_attributes.Rd

Adds additional user attributes to the user pool schema. Custom attributes can be mutable or immutable and have a custom: or dev: prefix. For more information, see Custom attributes.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_add_custom_attributes/ for full documentation.

Usage

cognitoidentityprovider_add_custom_attributes(UserPoolId, CustomAttributes)

Arguments

UserPoolId

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

CustomAttributes

[required] 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.