AddCustomAttributesRequest Class | AWS SDK for .NET V3

Container for the parameters to the AddCustomAttributes operation. 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.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.AddCustomAttributesRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class AddCustomAttributesRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The AddCustomAttributesRequest type exposes the following members

Constructors

	Name	Description
	AddCustomAttributesRequest()

Properties

Name Type Description

	Name	Type	Description
	CustomAttributes	System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.SchemaAttributeType>	Gets and sets the property CustomAttributes. 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.
	UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool where you want to add custom attributes.

CustomAttributes

System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.SchemaAttributeType>

Gets and sets the property CustomAttributes.

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.

UserPoolId

System.String

Gets and sets the property UserPoolId.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5