/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace CognitoIdentityProvider { namespace Model { /** *

Represents the request to register a user.

*/ class SignUpRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API SignUpRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SignUp"; } AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ID of the client associated with the user pool.

*/ inline const Aws::String& GetClientId() const{ return m_clientId; } /** *

The ID of the client associated with the user pool.

*/ inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; } /** *

The ID of the client associated with the user pool.

*/ inline void SetClientId(const Aws::String& value) { m_clientIdHasBeenSet = true; m_clientId = value; } /** *

The ID of the client associated with the user pool.

*/ inline void SetClientId(Aws::String&& value) { m_clientIdHasBeenSet = true; m_clientId = std::move(value); } /** *

The ID of the client associated with the user pool.

*/ inline void SetClientId(const char* value) { m_clientIdHasBeenSet = true; m_clientId.assign(value); } /** *

The ID of the client associated with the user pool.

*/ inline SignUpRequest& WithClientId(const Aws::String& value) { SetClientId(value); return *this;} /** *

The ID of the client associated with the user pool.

*/ inline SignUpRequest& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;} /** *

The ID of the client associated with the user pool.

*/ inline SignUpRequest& WithClientId(const char* value) { SetClientId(value); return *this;} /** *

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.

*/ inline const Aws::String& GetSecretHash() const{ return m_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.

*/ inline bool SecretHashHasBeenSet() const { return m_secretHashHasBeenSet; } /** *

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.

*/ inline void SetSecretHash(const Aws::String& value) { m_secretHashHasBeenSet = true; m_secretHash = value; } /** *

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.

*/ inline void SetSecretHash(Aws::String&& value) { m_secretHashHasBeenSet = true; m_secretHash = std::move(value); } /** *

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.

*/ inline void SetSecretHash(const char* value) { m_secretHashHasBeenSet = true; m_secretHash.assign(value); } /** *

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.

*/ inline SignUpRequest& WithSecretHash(const Aws::String& value) { SetSecretHash(value); return *this;} /** *

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.

*/ inline SignUpRequest& WithSecretHash(Aws::String&& value) { SetSecretHash(std::move(value)); return *this;} /** *

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.

*/ inline SignUpRequest& WithSecretHash(const char* value) { SetSecretHash(value); return *this;} /** *

The user name of the user you want to register.

*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *

The user name of the user you want to register.

*/ inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; } /** *

The user name of the user you want to register.

*/ inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; } /** *

The user name of the user you want to register.

*/ inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); } /** *

The user name of the user you want to register.

*/ inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); } /** *

The user name of the user you want to register.

*/ inline SignUpRequest& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *

The user name of the user you want to register.

*/ inline SignUpRequest& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *

The user name of the user you want to register.

*/ inline SignUpRequest& WithUsername(const char* value) { SetUsername(value); return *this;} /** *

The password of the user you want to register.

*/ inline const Aws::String& GetPassword() const{ return m_password; } /** *

The password of the user you want to register.

*/ inline bool PasswordHasBeenSet() const { return m_passwordHasBeenSet; } /** *

The password of the user you want to register.

*/ inline void SetPassword(const Aws::String& value) { m_passwordHasBeenSet = true; m_password = value; } /** *

The password of the user you want to register.

*/ inline void SetPassword(Aws::String&& value) { m_passwordHasBeenSet = true; m_password = std::move(value); } /** *

The password of the user you want to register.

*/ inline void SetPassword(const char* value) { m_passwordHasBeenSet = true; m_password.assign(value); } /** *

The password of the user you want to register.

*/ inline SignUpRequest& WithPassword(const Aws::String& value) { SetPassword(value); return *this;} /** *

The password of the user you want to register.

*/ inline SignUpRequest& WithPassword(Aws::String&& value) { SetPassword(std::move(value)); return *this;} /** *

The password of the user you want to register.

*/ inline SignUpRequest& WithPassword(const char* value) { SetPassword(value); return *this;} /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline const Aws::Vector& GetUserAttributes() const{ return m_userAttributes; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline bool UserAttributesHasBeenSet() const { return m_userAttributesHasBeenSet; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline void SetUserAttributes(const Aws::Vector& value) { m_userAttributesHasBeenSet = true; m_userAttributes = value; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline void SetUserAttributes(Aws::Vector&& value) { m_userAttributesHasBeenSet = true; m_userAttributes = std::move(value); } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline SignUpRequest& WithUserAttributes(const Aws::Vector& value) { SetUserAttributes(value); return *this;} /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline SignUpRequest& WithUserAttributes(Aws::Vector&& value) { SetUserAttributes(std::move(value)); return *this;} /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline SignUpRequest& AddUserAttributes(const AttributeType& value) { m_userAttributesHasBeenSet = true; m_userAttributes.push_back(value); return *this; } /** *

An array of name-value pairs representing user attributes.

For custom * attributes, you must prepend the custom: prefix to the attribute * name.

*/ inline SignUpRequest& AddUserAttributes(AttributeType&& value) { m_userAttributesHasBeenSet = true; m_userAttributes.push_back(std::move(value)); return *this; } /** *

The validation data in the request to register a user.

*/ inline const Aws::Vector& GetValidationData() const{ return m_validationData; } /** *

The validation data in the request to register a user.

*/ inline bool ValidationDataHasBeenSet() const { return m_validationDataHasBeenSet; } /** *

The validation data in the request to register a user.

*/ inline void SetValidationData(const Aws::Vector& value) { m_validationDataHasBeenSet = true; m_validationData = value; } /** *

The validation data in the request to register a user.

*/ inline void SetValidationData(Aws::Vector&& value) { m_validationDataHasBeenSet = true; m_validationData = std::move(value); } /** *

The validation data in the request to register a user.

*/ inline SignUpRequest& WithValidationData(const Aws::Vector& value) { SetValidationData(value); return *this;} /** *

The validation data in the request to register a user.

*/ inline SignUpRequest& WithValidationData(Aws::Vector&& value) { SetValidationData(std::move(value)); return *this;} /** *

The validation data in the request to register a user.

*/ inline SignUpRequest& AddValidationData(const AttributeType& value) { m_validationDataHasBeenSet = true; m_validationData.push_back(value); return *this; } /** *

The validation data in the request to register a user.

*/ inline SignUpRequest& AddValidationData(AttributeType&& value) { m_validationDataHasBeenSet = true; m_validationData.push_back(std::move(value)); return *this; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * SignUp calls.

*/ inline const AnalyticsMetadataType& GetAnalyticsMetadata() const{ return m_analyticsMetadata; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * SignUp calls.

*/ inline bool AnalyticsMetadataHasBeenSet() const { return m_analyticsMetadataHasBeenSet; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * SignUp calls.

*/ inline void SetAnalyticsMetadata(const AnalyticsMetadataType& value) { m_analyticsMetadataHasBeenSet = true; m_analyticsMetadata = value; } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * SignUp calls.

*/ inline void SetAnalyticsMetadata(AnalyticsMetadataType&& value) { m_analyticsMetadataHasBeenSet = true; m_analyticsMetadata = std::move(value); } /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * SignUp calls.

*/ inline SignUpRequest& WithAnalyticsMetadata(const AnalyticsMetadataType& value) { SetAnalyticsMetadata(value); return *this;} /** *

The Amazon Pinpoint analytics metadata that contributes to your metrics for * SignUp calls.

*/ inline SignUpRequest& WithAnalyticsMetadata(AnalyticsMetadataType&& value) { SetAnalyticsMetadata(std::move(value)); return *this;} /** *

Contextual data about your user session, such as the device fingerprint, IP * address, or location. Amazon Cognito advanced security evaluates the risk of an * authentication event based on the context that your app generates and passes to * Amazon Cognito when it makes API requests.

*/ inline const UserContextDataType& GetUserContextData() const{ return m_userContextData; } /** *

*/ inline bool UserContextDataHasBeenSet() const { return m_userContextDataHasBeenSet; } /** *

*/ inline void SetUserContextData(const UserContextDataType& value) { m_userContextDataHasBeenSet = true; m_userContextData = value; } /** *

*/ inline void SetUserContextData(UserContextDataType&& value) { m_userContextDataHasBeenSet = true; m_userContextData = std::move(value); } /** *

*/ inline SignUpRequest& WithUserContextData(const UserContextDataType& value) { SetUserContextData(value); return *this;} /** *

*/ inline SignUpRequest& WithUserContextData(UserContextDataType&& value) { SetUserContextData(std::move(value)); return *this;} /** *

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 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 * 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.