Interface AddCustomAttributesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>, SdkBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AddCustomAttributesRequest

@Mutable
@NotThreadSafe
public static interface AddCustomAttributesRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>

Method Summary

Modifier and Type	Method	Description
AddCustomAttributesRequest.Builder	customAttributes(Collection<SchemaAttributeType> customAttributes)	An array of custom attribute names and other properties.
AddCustomAttributesRequest.Builder	customAttributes(Consumer<SchemaAttributeType.Builder>... customAttributes)	An array of custom attribute names and other properties.
AddCustomAttributesRequest.Builder	customAttributes(SchemaAttributeType... customAttributes)	An array of custom attribute names and other properties.
AddCustomAttributesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
AddCustomAttributesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
AddCustomAttributesRequest.Builder	userPoolId(String userPoolId)	The ID of the user pool where you want to add custom attributes.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

userPoolId

AddCustomAttributesRequest.Builder userPoolId(String userPoolId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

customAttributes

AddCustomAttributesRequest.Builder customAttributes(Collection<SchemaAttributeType> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

customAttributes

AddCustomAttributesRequest.Builder customAttributes(SchemaAttributeType... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

customAttributes

AddCustomAttributesRequest.Builder customAttributes(Consumer<SchemaAttributeType.Builder>... 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.

This is a convenience method that creates an instance of the SchemaAttributeType.Builder avoiding the need to create one manually via SchemaAttributeType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customAttributes(List<SchemaAttributeType>).

Parameters:

customAttributes - a consumer that will call methods on SchemaAttributeType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customAttributes(java.util.Collection<SchemaAttributeType>)

overrideConfiguration

AddCustomAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

AddCustomAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.