Add Custom Attributes

cognitoidentityprovider_add_custom_attributes

R Documentation

Adds additional user attributes to the user pool schema

Description

Adds additional user attributes to the user pool schema.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_add_custom_attributes(UserPoolId,
  CustomAttributes)

Arguments

UserPoolId

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

CustomAttributes

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

Value

An empty list.

Request syntax

svc$add_custom_attributes(
  UserPoolId = "string",
  CustomAttributes = list(
    list(
      Name = "string",
      AttributeDataType = "String"|"Number"|"DateTime"|"Boolean",
      DeveloperOnlyAttribute = TRUE|FALSE,
      Mutable = TRUE|FALSE,
      Required = TRUE|FALSE,
      NumberAttributeConstraints = list(
        MinValue = "string",
        MaxValue = "string"
      ),
      StringAttributeConstraints = list(
        MinLength = "string",
        MaxLength = "string"
      )
    )
  )
)