AWSCognitoIdentityProviderUpdateUserPoolRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

Represents the request to update the user pool.

Required parameters: [UserPoolId]

  adminCreateUserConfig

The configuration for AdminCreateUser requests.

@property (nonatomic, strong) AWSCognitoIdentityProviderAdminCreateUserConfigType *adminCreateUserConfig

Declared In

AWSCognitoIdentityProviderModel.h

  autoVerifiedAttributes

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

@property (nonatomic, strong) NSArray<NSString*> *autoVerifiedAttributes

Declared In

AWSCognitoIdentityProviderModel.h

  deviceConfiguration

Device configuration.

@property (nonatomic, strong) AWSCognitoIdentityProviderDeviceConfigurationType *deviceConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  emailConfiguration

Email configuration.

@property (nonatomic, strong) AWSCognitoIdentityProviderEmailConfigurationType *emailConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  emailVerificationMessage

The contents of the email verification message.

@property (nonatomic, strong) NSString *emailVerificationMessage

Declared In

AWSCognitoIdentityProviderModel.h

  emailVerificationSubject

The subject of the email verification message.

@property (nonatomic, strong) NSString *emailVerificationSubject

Declared In

AWSCognitoIdentityProviderModel.h

  lambdaConfig

The AWS Lambda configuration information from the request to update the user pool.

@property (nonatomic, strong) AWSCognitoIdentityProviderLambdaConfigType *lambdaConfig

Declared In

AWSCognitoIdentityProviderModel.h

  mfaConfiguration

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

@property (nonatomic, assign) AWSCognitoIdentityProviderUserPoolMfaType mfaConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  policies

A container with the policies you wish to update in a user pool.

@property (nonatomic, strong) AWSCognitoIdentityProviderUserPoolPolicyType *policies

Declared In

AWSCognitoIdentityProviderModel.h

  smsAuthenticationMessage

The contents of the SMS authentication message.

@property (nonatomic, strong) NSString *smsAuthenticationMessage

Declared In

AWSCognitoIdentityProviderModel.h

  smsConfiguration

SMS configuration.

@property (nonatomic, strong) AWSCognitoIdentityProviderSmsConfigurationType *smsConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  smsVerificationMessage

A container with information about the SMS verification message.

@property (nonatomic, strong) NSString *smsVerificationMessage

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolId

The user pool ID for the user pool you want to update.

@property (nonatomic, strong) NSString *userPoolId

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolTags

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *userPoolTags

Declared In

AWSCognitoIdentityProviderModel.h

  verificationMessageTemplate

The template for verification messages.

@property (nonatomic, strong) AWSCognitoIdentityProviderVerificationMessageTemplateType *verificationMessageTemplate

Declared In

AWSCognitoIdentityProviderModel.h