AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A container for information about the user pool type.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.UserPoolType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class UserPoolType

The UserPoolType type exposes the following members

Constructors

NameDescription
Public Method UserPoolType()

Properties

NameTypeDescription
Public Property AdminCreateUserConfig Amazon.CognitoIdentityProvider.Model.AdminCreateUserConfigType

Gets and sets the property AdminCreateUserConfig.

The configuration for AdminCreateUser requests.

Public Property AliasAttributes System.Collections.Generic.List<System.String>

Gets and sets the property AliasAttributes.

Specifies the attributes that are aliased in a user pool.

Public Property AutoVerifiedAttributes System.Collections.Generic.List<System.String>

Gets and sets the property AutoVerifiedAttributes.

Specifies the attributes that are auto-verified in a user pool.

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The date the user pool was created.

Public Property DeviceConfiguration Amazon.CognitoIdentityProvider.Model.DeviceConfigurationType

Gets and sets the property DeviceConfiguration.

The device configuration.

Public Property EmailConfiguration Amazon.CognitoIdentityProvider.Model.EmailConfigurationType

Gets and sets the property EmailConfiguration.

The email configuration.

Public Property EmailConfigurationFailure System.String

Gets and sets the property EmailConfigurationFailure.

The reason why the email configuration cannot send the messages to your users.

Public Property EmailVerificationMessage System.String

Gets and sets the property EmailVerificationMessage.

The contents of the email verification message.

Public Property EmailVerificationSubject System.String

Gets and sets the property EmailVerificationSubject.

The subject of the email verification message.

Public Property EstimatedNumberOfUsers System.Int32

Gets and sets the property EstimatedNumberOfUsers.

A number estimating the size of the user pool.

Public Property Id System.String

Gets and sets the property Id.

The ID of the user pool.

Public Property LambdaConfig Amazon.CognitoIdentityProvider.Model.LambdaConfigType

Gets and sets the property LambdaConfig.

A container for the AWS Lambda triggers associated with a user pool.

Public Property LastModifiedDate System.DateTime

Gets and sets the property LastModifiedDate.

The date the user pool was last modified.

Public Property MfaConfiguration Amazon.CognitoIdentityProvider.UserPoolMfaType

Gets and sets the property 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.

Public Property Name System.String

Gets and sets the property Name.

The name of the user pool.

Public Property Policies Amazon.CognitoIdentityProvider.Model.UserPoolPolicyType

Gets and sets the property Policies.

A container for the policies associated with a user pool.

Public Property SchemaAttributes System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.SchemaAttributeType>

Gets and sets the property SchemaAttributes.

A container with the schema attributes of a user pool.

Public Property SmsAuthenticationMessage System.String

Gets and sets the property SmsAuthenticationMessage.

The contents of the SMS authentication message.

Public Property SmsConfiguration Amazon.CognitoIdentityProvider.Model.SmsConfigurationType

Gets and sets the property SmsConfiguration.

The SMS configuration.

Public Property SmsConfigurationFailure System.String

Gets and sets the property SmsConfigurationFailure.

The reason why the SMS configuration cannot send the messages to your users.

Public Property SmsVerificationMessage System.String

Gets and sets the property SmsVerificationMessage.

The contents of the SMS verification message.

Public Property Status Amazon.CognitoIdentityProvider.StatusType

Gets and sets the property Status.

The status of a user pool.

Public Property UsernameAttributes System.Collections.Generic.List<System.String>

Gets and sets the property UsernameAttributes.

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

Public Property UserPoolTags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property UserPoolTags.

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

Public Property VerificationMessageTemplate Amazon.CognitoIdentityProvider.Model.VerificationMessageTemplateType

Gets and sets the property VerificationMessageTemplate.

The template for verification messages.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms