public class SignUpRequest extends AmazonWebServiceRequest implements Serializable
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Constructor and Description |
---|
SignUpRequest() |
Modifier and Type | Method and Description |
---|---|
SignUpRequest |
addClientMetadataEntry(String key,
String value)
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
SignUpRequest |
clearClientMetadataEntries()
Removes all the entries added into ClientMetadata.
|
boolean |
equals(Object obj) |
AnalyticsMetadataType |
getAnalyticsMetadata()
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp calls. |
String |
getClientId()
The ID of the client associated with the user pool.
|
Map<String,String> |
getClientMetadata()
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
String |
getPassword()
The password of the user you wish to register.
|
String |
getSecretHash()
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
List<AttributeType> |
getUserAttributes()
An array of name-value pairs representing user attributes.
|
UserContextDataType |
getUserContextData()
Contextual data such as the user's device fingerprint, IP address, or
location used for evaluating the risk of an unexpected event by Amazon
Cognito advanced security.
|
String |
getUsername()
The user name of the user you wish to register.
|
List<AttributeType> |
getValidationData()
The validation data in the request to register a user.
|
int |
hashCode() |
void |
setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp calls. |
void |
setClientId(String clientId)
The ID of the client associated with the user pool.
|
void |
setClientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
void |
setPassword(String password)
The password of the user you wish to register.
|
void |
setSecretHash(String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
void |
setUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
|
void |
setUserContextData(UserContextDataType userContextData)
Contextual data such as the user's device fingerprint, IP address, or
location used for evaluating the risk of an unexpected event by Amazon
Cognito advanced security.
|
void |
setUsername(String username)
The user name of the user you wish to register.
|
void |
setValidationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SignUpRequest |
withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp calls. |
SignUpRequest |
withClientId(String clientId)
The ID of the client associated with the user pool.
|
SignUpRequest |
withClientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
SignUpRequest |
withPassword(String password)
The password of the user you wish to register.
|
SignUpRequest |
withSecretHash(String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
|
SignUpRequest |
withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest |
withUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest |
withUserContextData(UserContextDataType userContextData)
Contextual data such as the user's device fingerprint, IP address, or
location used for evaluating the risk of an unexpected event by Amazon
Cognito advanced security.
|
SignUpRequest |
withUsername(String username)
The user name of the user you wish to register.
|
SignUpRequest |
withValidationData(AttributeType... validationData)
The validation data in the request to register a user.
|
SignUpRequest |
withValidationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getClientId()
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
The ID of the client associated with the user pool.
public void setClientId(String clientId)
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId
- The ID of the client associated with the user pool.
public SignUpRequest withClientId(String clientId)
The ID of the client associated with the user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId
- The ID of the client associated with the user pool.
public String getSecretHash()
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
public void setSecretHash(String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
secretHash
- A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
public SignUpRequest withSecretHash(String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
secretHash
- A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
public String getUsername()
The user name of the user you wish to register.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
The user name of the user you wish to register.
public void setUsername(String username)
The user name of the user you wish to register.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
username
- The user name of the user you wish to register.
public SignUpRequest withUsername(String username)
The user name of the user you wish to register.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
username
- The user name of the user you wish to register.
public String getPassword()
The password of the user you wish to register.
Constraints:
Length: 6 - 256
Pattern: [\S]+
The password of the user you wish to register.
public void setPassword(String password)
The password of the user you wish to register.
Constraints:
Length: 6 - 256
Pattern: [\S]+
password
- The password of the user you wish to register.
public SignUpRequest withPassword(String password)
The password of the user you wish to register.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 6 - 256
Pattern: [\S]+
password
- The password of the user you wish to register.
public List<AttributeType> getUserAttributes()
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix
to the attribute name.
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
public void setUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix
to the attribute name.
userAttributes
- An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.
public SignUpRequest withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix
to the attribute name.
Returns a reference to this object so that method calls can be chained together.
userAttributes
- An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.
public SignUpRequest withUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix
to the attribute name.
Returns a reference to this object so that method calls can be chained together.
userAttributes
- An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.
public List<AttributeType> getValidationData()
The validation data in the request to register a user.
The validation data in the request to register a user.
public void setValidationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
validationData
- The validation data in the request to register a user.
public SignUpRequest withValidationData(AttributeType... validationData)
The validation data in the request to register a user.
Returns a reference to this object so that method calls can be chained together.
validationData
- The validation data in the request to register a user.
public SignUpRequest withValidationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
Returns a reference to this object so that method calls can be chained together.
validationData
- The validation data in the request to register a user.
public AnalyticsMetadataType getAnalyticsMetadata()
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp
calls.
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp
calls.
analyticsMetadata
-
The Amazon Pinpoint analytics metadata for collecting metrics
for SignUp
calls.
public SignUpRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp
calls.
Returns a reference to this object so that method calls can be chained together.
analyticsMetadata
-
The Amazon Pinpoint analytics metadata for collecting metrics
for SignUp
calls.
public UserContextDataType getUserContextData()
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
public void setUserContextData(UserContextDataType userContextData)
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
userContextData
- Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
public SignUpRequest withUserContextData(UserContextDataType userContextData)
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Returns a reference to this object so that method calls can be chained together.
userContextData
- Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
public Map<String,String> getClientMetadata()
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user
pool triggers. When you use the SignUp API action, Amazon Cognito invokes
any functions that are assigned to the following triggers: pre
sign-up, custom message, and post confirmation. When
Amazon Cognito invokes any of these functions, it passes a JSON payload,
which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you
assigned to the ClientMetadata parameter in your SignUp request. In your
function code in AWS Lambda, you can process the
clientMetadata
value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to
user pool triggers. When you use the SignUp API action, Amazon
Cognito invokes any functions that are assigned to the following
triggers: pre sign-up, custom message, and post
confirmation. When Amazon Cognito invokes any of these
functions, it passes a JSON payload, which the function receives
as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the
ClientMetadata parameter in your SignUp request. In your function
code in AWS Lambda, you can process the
clientMetadata
value to enhance your workflow for
your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
public void setClientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user
pool triggers. When you use the SignUp API action, Amazon Cognito invokes
any functions that are assigned to the following triggers: pre
sign-up, custom message, and post confirmation. When
Amazon Cognito invokes any of these functions, it passes a JSON payload,
which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you
assigned to the ClientMetadata parameter in your SignUp request. In your
function code in AWS Lambda, you can process the
clientMetadata
value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
clientMetadata
- A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions
to user pool triggers. When you use the SignUp API action,
Amazon Cognito invokes any functions that are assigned to the
following triggers: pre sign-up, custom message,
and post confirmation. When Amazon Cognito invokes any
of these functions, it passes a JSON payload, which the
function receives as input. This payload contains a
clientMetadata
attribute, which provides the data
that you assigned to the ClientMetadata parameter in your
SignUp request. In your function code in AWS Lambda, you can
process the clientMetadata
value to enhance your
workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
public SignUpRequest withClientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user
pool triggers. When you use the SignUp API action, Amazon Cognito invokes
any functions that are assigned to the following triggers: pre
sign-up, custom message, and post confirmation. When
Amazon Cognito invokes any of these functions, it passes a JSON payload,
which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you
assigned to the ClientMetadata parameter in your SignUp request. In your
function code in AWS Lambda, you can process the
clientMetadata
value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
Returns a reference to this object so that method calls can be chained together.
clientMetadata
- A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions
to user pool triggers. When you use the SignUp API action,
Amazon Cognito invokes any functions that are assigned to the
following triggers: pre sign-up, custom message,
and post confirmation. When Amazon Cognito invokes any
of these functions, it passes a JSON payload, which the
function receives as input. This payload contains a
clientMetadata
attribute, which provides the data
that you assigned to the ClientMetadata parameter in your
SignUp request. In your function code in AWS Lambda, you can
process the clientMetadata
value to enhance your
workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
public SignUpRequest addClientMetadataEntry(String key, String value)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user
pool triggers. When you use the SignUp API action, Amazon Cognito invokes
any functions that are assigned to the following triggers: pre
sign-up, custom message, and post confirmation. When
Amazon Cognito invokes any of these functions, it passes a JSON payload,
which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you
assigned to the ClientMetadata parameter in your SignUp request. In your
function code in AWS Lambda, you can process the
clientMetadata
value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
The method adds a new key-value pair into ClientMetadata parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into ClientMetadata.value
- The corresponding value of the entry to be added into
ClientMetadata.public SignUpRequest clearClientMetadataEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2020. All rights reserved.