Class UserPoolArgs

Inheritance
System.Object
InputArgs
ResourceArgs
UserPoolArgs
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Cognito
Assembly: Pulumi.Aws.dll
Syntax
public sealed class UserPoolArgs : ResourceArgs

Constructors

View Source

UserPoolArgs()

Declaration
public UserPoolArgs()

Properties

View Source

AdminCreateUserConfig

The configuration for AdminCreateUser requests.

Declaration
public Input<UserPoolAdminCreateUserConfigArgs> AdminCreateUserConfig { get; set; }
Property Value
Type Description
Input<UserPoolAdminCreateUserConfigArgs>
View Source

AliasAttributes

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

Declaration
public InputList<string> AliasAttributes { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

AutoVerifiedAttributes

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

Declaration
public InputList<string> AutoVerifiedAttributes { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

DeviceConfiguration

The configuration for the user pool's device tracking.

Declaration
public Input<UserPoolDeviceConfigurationArgs> DeviceConfiguration { get; set; }
Property Value
Type Description
Input<UserPoolDeviceConfigurationArgs>
View Source

EmailConfiguration

The Email Configuration.

Declaration
public Input<UserPoolEmailConfigurationArgs> EmailConfiguration { get; set; }
Property Value
Type Description
Input<UserPoolEmailConfigurationArgs>
View Source

EmailVerificationMessage

A string representing the email verification message. Conflicts with verification_message_template configuration block email_message argument.

Declaration
public Input<string> EmailVerificationMessage { get; set; }
Property Value
Type Description
Input<System.String>
View Source

EmailVerificationSubject

A string representing the email verification subject. Conflicts with verification_message_template configuration block email_subject argument.

Declaration
public Input<string> EmailVerificationSubject { get; set; }
Property Value
Type Description
Input<System.String>
View Source

LambdaConfig

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

Declaration
public Input<UserPoolLambdaConfigArgs> LambdaConfig { get; set; }
Property Value
Type Description
Input<UserPoolLambdaConfigArgs>
View Source

MfaConfiguration

Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values:

Declaration
public Input<string> MfaConfiguration { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Name

The name of the attribute.

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
View Source

PasswordPolicy

A container for information about the user pool password policy.

Declaration
public Input<UserPoolPasswordPolicyArgs> PasswordPolicy { get; set; }
Property Value
Type Description
Input<UserPoolPasswordPolicyArgs>
View Source

Schemas

A container with the schema attributes of a user pool. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Maximum of 50 attributes.

Declaration
public InputList<UserPoolSchemaArgs> Schemas { get; set; }
Property Value
Type Description
InputList<UserPoolSchemaArgs>
View Source

SmsAuthenticationMessage

A string representing the SMS authentication message. The message must contain the {####} placeholder, which will be replaced with the code.

Declaration
public Input<string> SmsAuthenticationMessage { get; set; }
Property Value
Type Description
Input<System.String>
View Source

SmsConfiguration

Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the up command and use --replace.

Declaration
public Input<UserPoolSmsConfigurationArgs> SmsConfiguration { get; set; }
Property Value
Type Description
Input<UserPoolSmsConfigurationArgs>
View Source

SmsVerificationMessage

A string representing the SMS verification message. Conflicts with verification_message_template configuration block sms_message argument.

Declaration
public Input<string> SmsVerificationMessage { get; set; }
Property Value
Type Description
Input<System.String>
View Source

SoftwareTokenMfaConfiguration

Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.

Declaration
public Input<UserPoolSoftwareTokenMfaConfigurationArgs> SoftwareTokenMfaConfiguration { get; set; }
Property Value
Type Description
Input<UserPoolSoftwareTokenMfaConfigurationArgs>
View Source

Tags

A map of tags to assign to the User Pool.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>
View Source

UsernameAttributes

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

Declaration
public InputList<string> UsernameAttributes { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

UsernameConfiguration

The Username Configuration.

Declaration
public Input<UserPoolUsernameConfigurationArgs> UsernameConfiguration { get; set; }
Property Value
Type Description
Input<UserPoolUsernameConfigurationArgs>
View Source

UserPoolAddOns

Configuration block for user pool add-ons to enable user pool advanced security mode features.

Declaration
public Input<UserPoolUserPoolAddOnsArgs> UserPoolAddOns { get; set; }
Property Value
Type Description
Input<UserPoolUserPoolAddOnsArgs>
View Source

VerificationMessageTemplate

The verification message templates configuration.

Declaration
public Input<UserPoolVerificationMessageTemplateArgs> VerificationMessageTemplate { get; set; }
Property Value
Type Description
Input<UserPoolVerificationMessageTemplateArgs>