AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest Class Reference

#include <CreateUserPoolRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest:

Public Member Functions

 CreateUserPoolRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPoolName () const
 
bool PoolNameHasBeenSet () const
 
void SetPoolName (const Aws::String &value)
 
void SetPoolName (Aws::String &&value)
 
void SetPoolName (const char *value)
 
CreateUserPoolRequestWithPoolName (const Aws::String &value)
 
CreateUserPoolRequestWithPoolName (Aws::String &&value)
 
CreateUserPoolRequestWithPoolName (const char *value)
 
const UserPoolPolicyTypeGetPolicies () const
 
bool PoliciesHasBeenSet () const
 
void SetPolicies (const UserPoolPolicyType &value)
 
void SetPolicies (UserPoolPolicyType &&value)
 
CreateUserPoolRequestWithPolicies (const UserPoolPolicyType &value)
 
CreateUserPoolRequestWithPolicies (UserPoolPolicyType &&value)
 
const LambdaConfigTypeGetLambdaConfig () const
 
bool LambdaConfigHasBeenSet () const
 
void SetLambdaConfig (const LambdaConfigType &value)
 
void SetLambdaConfig (LambdaConfigType &&value)
 
CreateUserPoolRequestWithLambdaConfig (const LambdaConfigType &value)
 
CreateUserPoolRequestWithLambdaConfig (LambdaConfigType &&value)
 
const Aws::Vector< VerifiedAttributeType > & GetAutoVerifiedAttributes () const
 
bool AutoVerifiedAttributesHasBeenSet () const
 
void SetAutoVerifiedAttributes (const Aws::Vector< VerifiedAttributeType > &value)
 
void SetAutoVerifiedAttributes (Aws::Vector< VerifiedAttributeType > &&value)
 
CreateUserPoolRequestWithAutoVerifiedAttributes (const Aws::Vector< VerifiedAttributeType > &value)
 
CreateUserPoolRequestWithAutoVerifiedAttributes (Aws::Vector< VerifiedAttributeType > &&value)
 
CreateUserPoolRequestAddAutoVerifiedAttributes (const VerifiedAttributeType &value)
 
CreateUserPoolRequestAddAutoVerifiedAttributes (VerifiedAttributeType &&value)
 
const Aws::Vector< AliasAttributeType > & GetAliasAttributes () const
 
bool AliasAttributesHasBeenSet () const
 
void SetAliasAttributes (const Aws::Vector< AliasAttributeType > &value)
 
void SetAliasAttributes (Aws::Vector< AliasAttributeType > &&value)
 
CreateUserPoolRequestWithAliasAttributes (const Aws::Vector< AliasAttributeType > &value)
 
CreateUserPoolRequestWithAliasAttributes (Aws::Vector< AliasAttributeType > &&value)
 
CreateUserPoolRequestAddAliasAttributes (const AliasAttributeType &value)
 
CreateUserPoolRequestAddAliasAttributes (AliasAttributeType &&value)
 
const Aws::Vector< UsernameAttributeType > & GetUsernameAttributes () const
 
bool UsernameAttributesHasBeenSet () const
 
void SetUsernameAttributes (const Aws::Vector< UsernameAttributeType > &value)
 
void SetUsernameAttributes (Aws::Vector< UsernameAttributeType > &&value)
 
CreateUserPoolRequestWithUsernameAttributes (const Aws::Vector< UsernameAttributeType > &value)
 
CreateUserPoolRequestWithUsernameAttributes (Aws::Vector< UsernameAttributeType > &&value)
 
CreateUserPoolRequestAddUsernameAttributes (const UsernameAttributeType &value)
 
CreateUserPoolRequestAddUsernameAttributes (UsernameAttributeType &&value)
 
const Aws::StringGetSmsVerificationMessage () const
 
bool SmsVerificationMessageHasBeenSet () const
 
void SetSmsVerificationMessage (const Aws::String &value)
 
void SetSmsVerificationMessage (Aws::String &&value)
 
void SetSmsVerificationMessage (const char *value)
 
CreateUserPoolRequestWithSmsVerificationMessage (const Aws::String &value)
 
CreateUserPoolRequestWithSmsVerificationMessage (Aws::String &&value)
 
CreateUserPoolRequestWithSmsVerificationMessage (const char *value)
 
const Aws::StringGetEmailVerificationMessage () const
 
bool EmailVerificationMessageHasBeenSet () const
 
void SetEmailVerificationMessage (const Aws::String &value)
 
void SetEmailVerificationMessage (Aws::String &&value)
 
void SetEmailVerificationMessage (const char *value)
 
CreateUserPoolRequestWithEmailVerificationMessage (const Aws::String &value)
 
CreateUserPoolRequestWithEmailVerificationMessage (Aws::String &&value)
 
CreateUserPoolRequestWithEmailVerificationMessage (const char *value)
 
const Aws::StringGetEmailVerificationSubject () const
 
bool EmailVerificationSubjectHasBeenSet () const
 
void SetEmailVerificationSubject (const Aws::String &value)
 
void SetEmailVerificationSubject (Aws::String &&value)
 
void SetEmailVerificationSubject (const char *value)
 
CreateUserPoolRequestWithEmailVerificationSubject (const Aws::String &value)
 
CreateUserPoolRequestWithEmailVerificationSubject (Aws::String &&value)
 
CreateUserPoolRequestWithEmailVerificationSubject (const char *value)
 
const VerificationMessageTemplateTypeGetVerificationMessageTemplate () const
 
bool VerificationMessageTemplateHasBeenSet () const
 
void SetVerificationMessageTemplate (const VerificationMessageTemplateType &value)
 
void SetVerificationMessageTemplate (VerificationMessageTemplateType &&value)
 
CreateUserPoolRequestWithVerificationMessageTemplate (const VerificationMessageTemplateType &value)
 
CreateUserPoolRequestWithVerificationMessageTemplate (VerificationMessageTemplateType &&value)
 
const Aws::StringGetSmsAuthenticationMessage () const
 
bool SmsAuthenticationMessageHasBeenSet () const
 
void SetSmsAuthenticationMessage (const Aws::String &value)
 
void SetSmsAuthenticationMessage (Aws::String &&value)
 
void SetSmsAuthenticationMessage (const char *value)
 
CreateUserPoolRequestWithSmsAuthenticationMessage (const Aws::String &value)
 
CreateUserPoolRequestWithSmsAuthenticationMessage (Aws::String &&value)
 
CreateUserPoolRequestWithSmsAuthenticationMessage (const char *value)
 
const UserPoolMfaTypeGetMfaConfiguration () const
 
bool MfaConfigurationHasBeenSet () const
 
void SetMfaConfiguration (const UserPoolMfaType &value)
 
void SetMfaConfiguration (UserPoolMfaType &&value)
 
CreateUserPoolRequestWithMfaConfiguration (const UserPoolMfaType &value)
 
CreateUserPoolRequestWithMfaConfiguration (UserPoolMfaType &&value)
 
const DeviceConfigurationTypeGetDeviceConfiguration () const
 
bool DeviceConfigurationHasBeenSet () const
 
void SetDeviceConfiguration (const DeviceConfigurationType &value)
 
void SetDeviceConfiguration (DeviceConfigurationType &&value)
 
CreateUserPoolRequestWithDeviceConfiguration (const DeviceConfigurationType &value)
 
CreateUserPoolRequestWithDeviceConfiguration (DeviceConfigurationType &&value)
 
const EmailConfigurationTypeGetEmailConfiguration () const
 
bool EmailConfigurationHasBeenSet () const
 
void SetEmailConfiguration (const EmailConfigurationType &value)
 
void SetEmailConfiguration (EmailConfigurationType &&value)
 
CreateUserPoolRequestWithEmailConfiguration (const EmailConfigurationType &value)
 
CreateUserPoolRequestWithEmailConfiguration (EmailConfigurationType &&value)
 
const SmsConfigurationTypeGetSmsConfiguration () const
 
bool SmsConfigurationHasBeenSet () const
 
void SetSmsConfiguration (const SmsConfigurationType &value)
 
void SetSmsConfiguration (SmsConfigurationType &&value)
 
CreateUserPoolRequestWithSmsConfiguration (const SmsConfigurationType &value)
 
CreateUserPoolRequestWithSmsConfiguration (SmsConfigurationType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetUserPoolTags () const
 
bool UserPoolTagsHasBeenSet () const
 
void SetUserPoolTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetUserPoolTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateUserPoolRequestWithUserPoolTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateUserPoolRequestWithUserPoolTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateUserPoolRequestAddUserPoolTags (const Aws::String &key, const Aws::String &value)
 
CreateUserPoolRequestAddUserPoolTags (Aws::String &&key, const Aws::String &value)
 
CreateUserPoolRequestAddUserPoolTags (const Aws::String &key, Aws::String &&value)
 
CreateUserPoolRequestAddUserPoolTags (Aws::String &&key, Aws::String &&value)
 
CreateUserPoolRequestAddUserPoolTags (const char *key, Aws::String &&value)
 
CreateUserPoolRequestAddUserPoolTags (Aws::String &&key, const char *value)
 
CreateUserPoolRequestAddUserPoolTags (const char *key, const char *value)
 
const AdminCreateUserConfigTypeGetAdminCreateUserConfig () const
 
bool AdminCreateUserConfigHasBeenSet () const
 
void SetAdminCreateUserConfig (const AdminCreateUserConfigType &value)
 
void SetAdminCreateUserConfig (AdminCreateUserConfigType &&value)
 
CreateUserPoolRequestWithAdminCreateUserConfig (const AdminCreateUserConfigType &value)
 
CreateUserPoolRequestWithAdminCreateUserConfig (AdminCreateUserConfigType &&value)
 
const Aws::Vector< SchemaAttributeType > & GetSchema () const
 
bool SchemaHasBeenSet () const
 
void SetSchema (const Aws::Vector< SchemaAttributeType > &value)
 
void SetSchema (Aws::Vector< SchemaAttributeType > &&value)
 
CreateUserPoolRequestWithSchema (const Aws::Vector< SchemaAttributeType > &value)
 
CreateUserPoolRequestWithSchema (Aws::Vector< SchemaAttributeType > &&value)
 
CreateUserPoolRequestAddSchema (const SchemaAttributeType &value)
 
CreateUserPoolRequestAddSchema (SchemaAttributeType &&value)
 
const UserPoolAddOnsTypeGetUserPoolAddOns () const
 
bool UserPoolAddOnsHasBeenSet () const
 
void SetUserPoolAddOns (const UserPoolAddOnsType &value)
 
void SetUserPoolAddOns (UserPoolAddOnsType &&value)
 
CreateUserPoolRequestWithUserPoolAddOns (const UserPoolAddOnsType &value)
 
CreateUserPoolRequestWithUserPoolAddOns (UserPoolAddOnsType &&value)
 
const UsernameConfigurationTypeGetUsernameConfiguration () const
 
bool UsernameConfigurationHasBeenSet () const
 
void SetUsernameConfiguration (const UsernameConfigurationType &value)
 
void SetUsernameConfiguration (UsernameConfigurationType &&value)
 
CreateUserPoolRequestWithUsernameConfiguration (const UsernameConfigurationType &value)
 
CreateUserPoolRequestWithUsernameConfiguration (UsernameConfigurationType &&value)
 
const AccountRecoverySettingTypeGetAccountRecoverySetting () const
 
bool AccountRecoverySettingHasBeenSet () const
 
void SetAccountRecoverySetting (const AccountRecoverySettingType &value)
 
void SetAccountRecoverySetting (AccountRecoverySettingType &&value)
 
CreateUserPoolRequestWithAccountRecoverySetting (const AccountRecoverySettingType &value)
 
CreateUserPoolRequestWithAccountRecoverySetting (AccountRecoverySettingType &&value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the request to create a user pool.

See Also:

AWS API Reference

Definition at line 41 of file CreateUserPoolRequest.h.

Constructor & Destructor Documentation

◆ CreateUserPoolRequest()

Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::CreateUserPoolRequest ( )

Member Function Documentation

◆ AccountRecoverySettingHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AccountRecoverySettingHasBeenSet ( ) const
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 1018 of file CreateUserPoolRequest.h.

◆ AddAliasAttributes() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddAliasAttributes ( AliasAttributeType &&  value)
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 309 of file CreateUserPoolRequest.h.

◆ AddAliasAttributes() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddAliasAttributes ( const AliasAttributeType value)
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 303 of file CreateUserPoolRequest.h.

◆ AddAutoVerifiedAttributes() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddAutoVerifiedAttributes ( const VerifiedAttributeType value)
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 254 of file CreateUserPoolRequest.h.

◆ AddAutoVerifiedAttributes() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddAutoVerifiedAttributes ( VerifiedAttributeType &&  value)
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 260 of file CreateUserPoolRequest.h.

◆ AddSchema() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddSchema ( const SchemaAttributeType value)
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 897 of file CreateUserPoolRequest.h.

◆ AddSchema() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddSchema ( SchemaAttributeType &&  value)
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 903 of file CreateUserPoolRequest.h.

◆ AddUsernameAttributes() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUsernameAttributes ( const UsernameAttributeType value)
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 352 of file CreateUserPoolRequest.h.

◆ AddUsernameAttributes() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUsernameAttributes ( UsernameAttributeType &&  value)
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 358 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [1/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 802 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [2/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 788 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [3/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( Aws::String &&  key,
const char *  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 816 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [4/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 795 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [5/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( const Aws::String key,
const Aws::String value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 781 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [6/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( const char *  key,
Aws::String &&  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 809 of file CreateUserPoolRequest.h.

◆ AddUserPoolTags() [7/7]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AddUserPoolTags ( const char *  key,
const char *  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 823 of file CreateUserPoolRequest.h.

◆ AdminCreateUserConfigHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AdminCreateUserConfigHasBeenSet ( ) const
inline

The configuration for AdminCreateUser requests.

Definition at line 834 of file CreateUserPoolRequest.h.

◆ AliasAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AliasAttributesHasBeenSet ( ) const
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 273 of file CreateUserPoolRequest.h.

◆ AutoVerifiedAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::AutoVerifiedAttributesHasBeenSet ( ) const
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 224 of file CreateUserPoolRequest.h.

◆ DeviceConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::DeviceConfigurationHasBeenSet ( ) const
inline

The device configuration.

Definition at line 649 of file CreateUserPoolRequest.h.

◆ EmailConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::EmailConfigurationHasBeenSet ( ) const
inline

The email configuration.

Definition at line 680 of file CreateUserPoolRequest.h.

◆ EmailVerificationMessageHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::EmailVerificationMessageHasBeenSet ( ) const
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 416 of file CreateUserPoolRequest.h.

◆ EmailVerificationSubjectHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::EmailVerificationSubjectHasBeenSet ( ) const
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 481 of file CreateUserPoolRequest.h.

◆ GetAccountRecoverySetting()

const AccountRecoverySettingType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetAccountRecoverySetting ( ) const
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 1007 of file CreateUserPoolRequest.h.

◆ GetAdminCreateUserConfig()

const AdminCreateUserConfigType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetAdminCreateUserConfig ( ) const
inline

The configuration for AdminCreateUser requests.

Definition at line 829 of file CreateUserPoolRequest.h.

◆ GetAliasAttributes()

const Aws::Vector<AliasAttributeType>& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetAliasAttributes ( ) const
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 267 of file CreateUserPoolRequest.h.

◆ GetAutoVerifiedAttributes()

const Aws::Vector<VerifiedAttributeType>& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetAutoVerifiedAttributes ( ) const
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 218 of file CreateUserPoolRequest.h.

◆ GetDeviceConfiguration()

const DeviceConfigurationType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetDeviceConfiguration ( ) const
inline

The device configuration.

Definition at line 644 of file CreateUserPoolRequest.h.

◆ GetEmailConfiguration()

const EmailConfigurationType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetEmailConfiguration ( ) const
inline

The email configuration.

Definition at line 675 of file CreateUserPoolRequest.h.

◆ GetEmailVerificationMessage()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetEmailVerificationMessage ( ) const
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 408 of file CreateUserPoolRequest.h.

◆ GetEmailVerificationSubject()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetEmailVerificationSubject ( ) const
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 473 of file CreateUserPoolRequest.h.

◆ GetLambdaConfig()

const LambdaConfigType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetLambdaConfig ( ) const
inline

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

Definition at line 141 of file CreateUserPoolRequest.h.

◆ GetMfaConfiguration()

const UserPoolMfaType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetMfaConfiguration ( ) const
inline

Specifies MFA configuration details.

Definition at line 613 of file CreateUserPoolRequest.h.

◆ GetPolicies()

const UserPoolPolicyType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetPolicies ( ) const
inline

The policies associated with the new user pool.

Definition at line 101 of file CreateUserPoolRequest.h.

◆ GetPoolName()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetPoolName ( ) const
inline

A string used to name the user pool.

Definition at line 60 of file CreateUserPoolRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSchema()

const Aws::Vector<SchemaAttributeType>& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetSchema ( ) const
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 861 of file CreateUserPoolRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 50 of file CreateUserPoolRequest.h.

◆ GetSmsAuthenticationMessage()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetSmsAuthenticationMessage ( ) const
inline

A string representing the SMS authentication message.

Definition at line 572 of file CreateUserPoolRequest.h.

◆ GetSmsConfiguration()

const SmsConfigurationType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetSmsConfiguration ( ) const
inline

The SMS configuration.

Definition at line 706 of file CreateUserPoolRequest.h.

◆ GetSmsVerificationMessage()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetSmsVerificationMessage ( ) const
inline

A string representing the SMS verification message.

Definition at line 364 of file CreateUserPoolRequest.h.

◆ GetUsernameAttributes()

const Aws::Vector<UsernameAttributeType>& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetUsernameAttributes ( ) const
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 316 of file CreateUserPoolRequest.h.

◆ GetUsernameConfiguration()

const UsernameConfigurationType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetUsernameConfiguration ( ) const
inline

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Definition at line 950 of file CreateUserPoolRequest.h.

◆ GetUserPoolAddOns()

const UserPoolAddOnsType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetUserPoolAddOns ( ) const
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 910 of file CreateUserPoolRequest.h.

◆ GetUserPoolTags()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetUserPoolTags ( ) const
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 739 of file CreateUserPoolRequest.h.

◆ GetVerificationMessageTemplate()

const VerificationMessageTemplateType& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::GetVerificationMessageTemplate ( ) const
inline

The template for the verification message that the user sees when the app requests permission to access the user's information.

Definition at line 536 of file CreateUserPoolRequest.h.

◆ LambdaConfigHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::LambdaConfigHasBeenSet ( ) const
inline

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

Definition at line 155 of file CreateUserPoolRequest.h.

◆ MfaConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::MfaConfigurationHasBeenSet ( ) const
inline

Specifies MFA configuration details.

Definition at line 618 of file CreateUserPoolRequest.h.

◆ PoliciesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::PoliciesHasBeenSet ( ) const
inline

The policies associated with the new user pool.

Definition at line 106 of file CreateUserPoolRequest.h.

◆ PoolNameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::PoolNameHasBeenSet ( ) const
inline

A string used to name the user pool.

Definition at line 65 of file CreateUserPoolRequest.h.

◆ SchemaHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SchemaHasBeenSet ( ) const
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 867 of file CreateUserPoolRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountRecoverySetting() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAccountRecoverySetting ( AccountRecoverySettingType &&  value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 1040 of file CreateUserPoolRequest.h.

◆ SetAccountRecoverySetting() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAccountRecoverySetting ( const AccountRecoverySettingType value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 1029 of file CreateUserPoolRequest.h.

◆ SetAdminCreateUserConfig() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAdminCreateUserConfig ( AdminCreateUserConfigType &&  value)
inline

The configuration for AdminCreateUser requests.

Definition at line 844 of file CreateUserPoolRequest.h.

◆ SetAdminCreateUserConfig() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAdminCreateUserConfig ( const AdminCreateUserConfigType value)
inline

The configuration for AdminCreateUser requests.

Definition at line 839 of file CreateUserPoolRequest.h.

◆ SetAliasAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAliasAttributes ( Aws::Vector< AliasAttributeType > &&  value)
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 285 of file CreateUserPoolRequest.h.

◆ SetAliasAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAliasAttributes ( const Aws::Vector< AliasAttributeType > &  value)
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 279 of file CreateUserPoolRequest.h.

◆ SetAutoVerifiedAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAutoVerifiedAttributes ( Aws::Vector< VerifiedAttributeType > &&  value)
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 236 of file CreateUserPoolRequest.h.

◆ SetAutoVerifiedAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetAutoVerifiedAttributes ( const Aws::Vector< VerifiedAttributeType > &  value)
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 230 of file CreateUserPoolRequest.h.

◆ SetDeviceConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetDeviceConfiguration ( const DeviceConfigurationType value)
inline

The device configuration.

Definition at line 654 of file CreateUserPoolRequest.h.

◆ SetDeviceConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetDeviceConfiguration ( DeviceConfigurationType &&  value)
inline

The device configuration.

Definition at line 659 of file CreateUserPoolRequest.h.

◆ SetEmailConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailConfiguration ( const EmailConfigurationType value)
inline

The email configuration.

Definition at line 685 of file CreateUserPoolRequest.h.

◆ SetEmailConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailConfiguration ( EmailConfigurationType &&  value)
inline

The email configuration.

Definition at line 690 of file CreateUserPoolRequest.h.

◆ SetEmailVerificationMessage() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailVerificationMessage ( Aws::String &&  value)
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 432 of file CreateUserPoolRequest.h.

◆ SetEmailVerificationMessage() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailVerificationMessage ( const Aws::String value)
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 424 of file CreateUserPoolRequest.h.

◆ SetEmailVerificationMessage() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailVerificationMessage ( const char *  value)
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 440 of file CreateUserPoolRequest.h.

◆ SetEmailVerificationSubject() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailVerificationSubject ( Aws::String &&  value)
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 497 of file CreateUserPoolRequest.h.

◆ SetEmailVerificationSubject() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailVerificationSubject ( const Aws::String value)
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 489 of file CreateUserPoolRequest.h.

◆ SetEmailVerificationSubject() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetEmailVerificationSubject ( const char *  value)
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 505 of file CreateUserPoolRequest.h.

◆ SetLambdaConfig() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetLambdaConfig ( const LambdaConfigType value)
inline

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

Definition at line 169 of file CreateUserPoolRequest.h.

◆ SetLambdaConfig() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetLambdaConfig ( LambdaConfigType &&  value)
inline

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

Definition at line 183 of file CreateUserPoolRequest.h.

◆ SetMfaConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetMfaConfiguration ( const UserPoolMfaType value)
inline

Specifies MFA configuration details.

Definition at line 623 of file CreateUserPoolRequest.h.

◆ SetMfaConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetMfaConfiguration ( UserPoolMfaType &&  value)
inline

Specifies MFA configuration details.

Definition at line 628 of file CreateUserPoolRequest.h.

◆ SetPolicies() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetPolicies ( const UserPoolPolicyType value)
inline

The policies associated with the new user pool.

Definition at line 111 of file CreateUserPoolRequest.h.

◆ SetPolicies() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetPolicies ( UserPoolPolicyType &&  value)
inline

The policies associated with the new user pool.

Definition at line 116 of file CreateUserPoolRequest.h.

◆ SetPoolName() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetPoolName ( Aws::String &&  value)
inline

A string used to name the user pool.

Definition at line 75 of file CreateUserPoolRequest.h.

◆ SetPoolName() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetPoolName ( const Aws::String value)
inline

A string used to name the user pool.

Definition at line 70 of file CreateUserPoolRequest.h.

◆ SetPoolName() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetPoolName ( const char *  value)
inline

A string used to name the user pool.

Definition at line 80 of file CreateUserPoolRequest.h.

◆ SetSchema() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSchema ( Aws::Vector< SchemaAttributeType > &&  value)
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 879 of file CreateUserPoolRequest.h.

◆ SetSchema() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSchema ( const Aws::Vector< SchemaAttributeType > &  value)
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 873 of file CreateUserPoolRequest.h.

◆ SetSmsAuthenticationMessage() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsAuthenticationMessage ( Aws::String &&  value)
inline

A string representing the SMS authentication message.

Definition at line 587 of file CreateUserPoolRequest.h.

◆ SetSmsAuthenticationMessage() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsAuthenticationMessage ( const Aws::String value)
inline

A string representing the SMS authentication message.

Definition at line 582 of file CreateUserPoolRequest.h.

◆ SetSmsAuthenticationMessage() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsAuthenticationMessage ( const char *  value)
inline

A string representing the SMS authentication message.

Definition at line 592 of file CreateUserPoolRequest.h.

◆ SetSmsConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsConfiguration ( const SmsConfigurationType value)
inline

The SMS configuration.

Definition at line 716 of file CreateUserPoolRequest.h.

◆ SetSmsConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsConfiguration ( SmsConfigurationType &&  value)
inline

The SMS configuration.

Definition at line 721 of file CreateUserPoolRequest.h.

◆ SetSmsVerificationMessage() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsVerificationMessage ( Aws::String &&  value)
inline

A string representing the SMS verification message.

Definition at line 379 of file CreateUserPoolRequest.h.

◆ SetSmsVerificationMessage() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsVerificationMessage ( const Aws::String value)
inline

A string representing the SMS verification message.

Definition at line 374 of file CreateUserPoolRequest.h.

◆ SetSmsVerificationMessage() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetSmsVerificationMessage ( const char *  value)
inline

A string representing the SMS verification message.

Definition at line 384 of file CreateUserPoolRequest.h.

◆ SetUsernameAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUsernameAttributes ( Aws::Vector< UsernameAttributeType > &&  value)
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 334 of file CreateUserPoolRequest.h.

◆ SetUsernameAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUsernameAttributes ( const Aws::Vector< UsernameAttributeType > &  value)
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 328 of file CreateUserPoolRequest.h.

◆ SetUsernameConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUsernameConfiguration ( const UsernameConfigurationType value)
inline

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Definition at line 968 of file CreateUserPoolRequest.h.

◆ SetUsernameConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUsernameConfiguration ( UsernameConfigurationType &&  value)
inline

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Definition at line 977 of file CreateUserPoolRequest.h.

◆ SetUserPoolAddOns() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUserPoolAddOns ( const UserPoolAddOnsType value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 922 of file CreateUserPoolRequest.h.

◆ SetUserPoolAddOns() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUserPoolAddOns ( UserPoolAddOnsType &&  value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 928 of file CreateUserPoolRequest.h.

◆ SetUserPoolTags() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUserPoolTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 760 of file CreateUserPoolRequest.h.

◆ SetUserPoolTags() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetUserPoolTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 753 of file CreateUserPoolRequest.h.

◆ SetVerificationMessageTemplate() [1/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetVerificationMessageTemplate ( const VerificationMessageTemplateType value)
inline

The template for the verification message that the user sees when the app requests permission to access the user's information.

Definition at line 548 of file CreateUserPoolRequest.h.

◆ SetVerificationMessageTemplate() [2/2]

void Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SetVerificationMessageTemplate ( VerificationMessageTemplateType &&  value)
inline

The template for the verification message that the user sees when the app requests permission to access the user's information.

Definition at line 554 of file CreateUserPoolRequest.h.

◆ SmsAuthenticationMessageHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SmsAuthenticationMessageHasBeenSet ( ) const
inline

A string representing the SMS authentication message.

Definition at line 577 of file CreateUserPoolRequest.h.

◆ SmsConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SmsConfigurationHasBeenSet ( ) const
inline

The SMS configuration.

Definition at line 711 of file CreateUserPoolRequest.h.

◆ SmsVerificationMessageHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::SmsVerificationMessageHasBeenSet ( ) const
inline

A string representing the SMS verification message.

Definition at line 369 of file CreateUserPoolRequest.h.

◆ UsernameAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::UsernameAttributesHasBeenSet ( ) const
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 322 of file CreateUserPoolRequest.h.

◆ UsernameConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::UsernameConfigurationHasBeenSet ( ) const
inline

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Definition at line 959 of file CreateUserPoolRequest.h.

◆ UserPoolAddOnsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::UserPoolAddOnsHasBeenSet ( ) const
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 916 of file CreateUserPoolRequest.h.

◆ UserPoolTagsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::UserPoolTagsHasBeenSet ( ) const
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 746 of file CreateUserPoolRequest.h.

◆ VerificationMessageTemplateHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::VerificationMessageTemplateHasBeenSet ( ) const
inline

The template for the verification message that the user sees when the app requests permission to access the user's information.

Definition at line 542 of file CreateUserPoolRequest.h.

◆ WithAccountRecoverySetting() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAccountRecoverySetting ( AccountRecoverySettingType &&  value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 1062 of file CreateUserPoolRequest.h.

◆ WithAccountRecoverySetting() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAccountRecoverySetting ( const AccountRecoverySettingType value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 1051 of file CreateUserPoolRequest.h.

◆ WithAdminCreateUserConfig() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAdminCreateUserConfig ( AdminCreateUserConfigType &&  value)
inline

The configuration for AdminCreateUser requests.

Definition at line 854 of file CreateUserPoolRequest.h.

◆ WithAdminCreateUserConfig() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAdminCreateUserConfig ( const AdminCreateUserConfigType value)
inline

The configuration for AdminCreateUser requests.

Definition at line 849 of file CreateUserPoolRequest.h.

◆ WithAliasAttributes() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAliasAttributes ( Aws::Vector< AliasAttributeType > &&  value)
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 297 of file CreateUserPoolRequest.h.

◆ WithAliasAttributes() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAliasAttributes ( const Aws::Vector< AliasAttributeType > &  value)
inline

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Definition at line 291 of file CreateUserPoolRequest.h.

◆ WithAutoVerifiedAttributes() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAutoVerifiedAttributes ( Aws::Vector< VerifiedAttributeType > &&  value)
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 248 of file CreateUserPoolRequest.h.

◆ WithAutoVerifiedAttributes() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithAutoVerifiedAttributes ( const Aws::Vector< VerifiedAttributeType > &  value)
inline

The attributes to be auto-verified. Possible values: email, phone_number.

Definition at line 242 of file CreateUserPoolRequest.h.

◆ WithDeviceConfiguration() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithDeviceConfiguration ( const DeviceConfigurationType value)
inline

The device configuration.

Definition at line 664 of file CreateUserPoolRequest.h.

◆ WithDeviceConfiguration() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithDeviceConfiguration ( DeviceConfigurationType &&  value)
inline

The device configuration.

Definition at line 669 of file CreateUserPoolRequest.h.

◆ WithEmailConfiguration() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailConfiguration ( const EmailConfigurationType value)
inline

The email configuration.

Definition at line 695 of file CreateUserPoolRequest.h.

◆ WithEmailConfiguration() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailConfiguration ( EmailConfigurationType &&  value)
inline

The email configuration.

Definition at line 700 of file CreateUserPoolRequest.h.

◆ WithEmailVerificationMessage() [1/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailVerificationMessage ( Aws::String &&  value)
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 456 of file CreateUserPoolRequest.h.

◆ WithEmailVerificationMessage() [2/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailVerificationMessage ( const Aws::String value)
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 448 of file CreateUserPoolRequest.h.

◆ WithEmailVerificationMessage() [3/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailVerificationMessage ( const char *  value)
inline

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 464 of file CreateUserPoolRequest.h.

◆ WithEmailVerificationSubject() [1/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailVerificationSubject ( Aws::String &&  value)
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 521 of file CreateUserPoolRequest.h.

◆ WithEmailVerificationSubject() [2/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailVerificationSubject ( const Aws::String value)
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 513 of file CreateUserPoolRequest.h.

◆ WithEmailVerificationSubject() [3/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithEmailVerificationSubject ( const char *  value)
inline

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

Definition at line 529 of file CreateUserPoolRequest.h.

◆ WithLambdaConfig() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithLambdaConfig ( const LambdaConfigType value)
inline

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

Definition at line 197 of file CreateUserPoolRequest.h.

◆ WithLambdaConfig() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithLambdaConfig ( LambdaConfigType &&  value)
inline

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

Definition at line 211 of file CreateUserPoolRequest.h.

◆ WithMfaConfiguration() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithMfaConfiguration ( const UserPoolMfaType value)
inline

Specifies MFA configuration details.

Definition at line 633 of file CreateUserPoolRequest.h.

◆ WithMfaConfiguration() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithMfaConfiguration ( UserPoolMfaType &&  value)
inline

Specifies MFA configuration details.

Definition at line 638 of file CreateUserPoolRequest.h.

◆ WithPolicies() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithPolicies ( const UserPoolPolicyType value)
inline

The policies associated with the new user pool.

Definition at line 121 of file CreateUserPoolRequest.h.

◆ WithPolicies() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithPolicies ( UserPoolPolicyType &&  value)
inline

The policies associated with the new user pool.

Definition at line 126 of file CreateUserPoolRequest.h.

◆ WithPoolName() [1/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithPoolName ( Aws::String &&  value)
inline

A string used to name the user pool.

Definition at line 90 of file CreateUserPoolRequest.h.

◆ WithPoolName() [2/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithPoolName ( const Aws::String value)
inline

A string used to name the user pool.

Definition at line 85 of file CreateUserPoolRequest.h.

◆ WithPoolName() [3/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithPoolName ( const char *  value)
inline

A string used to name the user pool.

Definition at line 95 of file CreateUserPoolRequest.h.

◆ WithSchema() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSchema ( Aws::Vector< SchemaAttributeType > &&  value)
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 891 of file CreateUserPoolRequest.h.

◆ WithSchema() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSchema ( const Aws::Vector< SchemaAttributeType > &  value)
inline

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Definition at line 885 of file CreateUserPoolRequest.h.

◆ WithSmsAuthenticationMessage() [1/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsAuthenticationMessage ( Aws::String &&  value)
inline

A string representing the SMS authentication message.

Definition at line 602 of file CreateUserPoolRequest.h.

◆ WithSmsAuthenticationMessage() [2/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsAuthenticationMessage ( const Aws::String value)
inline

A string representing the SMS authentication message.

Definition at line 597 of file CreateUserPoolRequest.h.

◆ WithSmsAuthenticationMessage() [3/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsAuthenticationMessage ( const char *  value)
inline

A string representing the SMS authentication message.

Definition at line 607 of file CreateUserPoolRequest.h.

◆ WithSmsConfiguration() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsConfiguration ( const SmsConfigurationType value)
inline

The SMS configuration.

Definition at line 726 of file CreateUserPoolRequest.h.

◆ WithSmsConfiguration() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsConfiguration ( SmsConfigurationType &&  value)
inline

The SMS configuration.

Definition at line 731 of file CreateUserPoolRequest.h.

◆ WithSmsVerificationMessage() [1/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsVerificationMessage ( Aws::String &&  value)
inline

A string representing the SMS verification message.

Definition at line 394 of file CreateUserPoolRequest.h.

◆ WithSmsVerificationMessage() [2/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsVerificationMessage ( const Aws::String value)
inline

A string representing the SMS verification message.

Definition at line 389 of file CreateUserPoolRequest.h.

◆ WithSmsVerificationMessage() [3/3]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithSmsVerificationMessage ( const char *  value)
inline

A string representing the SMS verification message.

Definition at line 399 of file CreateUserPoolRequest.h.

◆ WithUsernameAttributes() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUsernameAttributes ( Aws::Vector< UsernameAttributeType > &&  value)
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 346 of file CreateUserPoolRequest.h.

◆ WithUsernameAttributes() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUsernameAttributes ( const Aws::Vector< UsernameAttributeType > &  value)
inline

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Definition at line 340 of file CreateUserPoolRequest.h.

◆ WithUsernameConfiguration() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUsernameConfiguration ( const UsernameConfigurationType value)
inline

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Definition at line 986 of file CreateUserPoolRequest.h.

◆ WithUsernameConfiguration() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUsernameConfiguration ( UsernameConfigurationType &&  value)
inline

You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Definition at line 995 of file CreateUserPoolRequest.h.

◆ WithUserPoolAddOns() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUserPoolAddOns ( const UserPoolAddOnsType value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 934 of file CreateUserPoolRequest.h.

◆ WithUserPoolAddOns() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUserPoolAddOns ( UserPoolAddOnsType &&  value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 940 of file CreateUserPoolRequest.h.

◆ WithUserPoolTags() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUserPoolTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 774 of file CreateUserPoolRequest.h.

◆ WithUserPoolTags() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithUserPoolTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 767 of file CreateUserPoolRequest.h.

◆ WithVerificationMessageTemplate() [1/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithVerificationMessageTemplate ( const VerificationMessageTemplateType value)
inline

The template for the verification message that the user sees when the app requests permission to access the user's information.

Definition at line 560 of file CreateUserPoolRequest.h.

◆ WithVerificationMessageTemplate() [2/2]

CreateUserPoolRequest& Aws::CognitoIdentityProvider::Model::CreateUserPoolRequest::WithVerificationMessageTemplate ( VerificationMessageTemplateType &&  value)
inline

The template for the verification message that the user sees when the app requests permission to access the user's information.

Definition at line 566 of file CreateUserPoolRequest.h.


The documentation for this class was generated from the following file: