com.amazonaws.services.cognitoidentityprovider.model

Class AddCustomAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AddCustomAttributesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AddCustomAttributesRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AddCustomAttributesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<SchemaAttributeType>	getCustomAttributes() An array of custom attributes, such as Mutable and Name.
java.lang.String	getUserPoolId() The user pool ID for the user pool where you want to add custom attributes.
int	hashCode()
void	setCustomAttributes(java.util.Collection<SchemaAttributeType> customAttributes) An array of custom attributes, such as Mutable and Name.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool where you want to add custom attributes.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AddCustomAttributesRequest	withCustomAttributes(java.util.Collection<SchemaAttributeType> customAttributes) An array of custom attributes, such as Mutable and Name.
AddCustomAttributesRequest	withCustomAttributes(SchemaAttributeType... customAttributes) An array of custom attributes, such as Mutable and Name.
AddCustomAttributesRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool where you want to add custom attributes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddCustomAttributesRequest

public AddCustomAttributesRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

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

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

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

withUserPoolId

public AddCustomAttributesRequest withUserPoolId(java.lang.String userPoolId)

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

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getCustomAttributes

public java.util.List<SchemaAttributeType> getCustomAttributes()

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

Returns:

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

setCustomAttributes

public void setCustomAttributes(java.util.Collection<SchemaAttributeType> customAttributes)

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

Parameters:

customAttributes -

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

withCustomAttributes

public AddCustomAttributesRequest withCustomAttributes(SchemaAttributeType... customAttributes)

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

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

Parameters:

customAttributes -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withCustomAttributes

public AddCustomAttributesRequest withCustomAttributes(java.util.Collection<SchemaAttributeType> customAttributes)

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

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

Parameters:

customAttributes -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object