Class UserPool

Provides a Cognito User Pool resource.

Example Usage

Basic configuration

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var pool = new Aws.Cognito.UserPool("pool", new Aws.Cognito.UserPoolArgs
    {
    });
}

}

Inheritance

System.Object

Resource

CustomResource

UserPool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

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 class UserPool : CustomResource

Constructors

UserPool(String, UserPoolArgs, CustomResourceOptions)

Create a UserPool resource with the given unique name, arguments, and options.

Declaration

public UserPool(string name, UserPoolArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
UserPoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AdminCreateUserConfig

The configuration for AdminCreateUser requests.

Declaration

public Output<UserPoolAdminCreateUserConfig> AdminCreateUserConfig { get; }

Property Value

Type	Description
Output<UserPoolAdminCreateUserConfig>

AliasAttributes

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

Declaration

public Output<ImmutableArray<string>> AliasAttributes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Arn

The ARN of the user pool.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AutoVerifiedAttributes

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

Declaration

public Output<ImmutableArray<string>> AutoVerifiedAttributes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

CreationDate

The date the user pool was created.

Declaration

public Output<string> CreationDate { get; }

Property Value

Type	Description
Output<System.String>

DeviceConfiguration

The configuration for the user pool's device tracking.

Declaration

public Output<UserPoolDeviceConfiguration> DeviceConfiguration { get; }

Property Value

Type	Description
Output<UserPoolDeviceConfiguration>

EmailConfiguration

The Email Configuration.

Declaration

public Output<UserPoolEmailConfiguration> EmailConfiguration { get; }

Property Value

Type	Description
Output<UserPoolEmailConfiguration>

EmailVerificationMessage

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

Declaration

public Output<string> EmailVerificationMessage { get; }

Property Value

Type	Description
Output<System.String>

EmailVerificationSubject

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

Declaration

public Output<string> EmailVerificationSubject { get; }

Property Value

Type	Description
Output<System.String>

Endpoint

The endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy

Declaration

public Output<string> Endpoint { get; }

Property Value

Type	Description
Output<System.String>

LambdaConfig

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

Declaration

public Output<UserPoolLambdaConfig> LambdaConfig { get; }

Property Value

Type	Description
Output<UserPoolLambdaConfig>

LastModifiedDate

The date the user pool was last modified.

Declaration

public Output<string> LastModifiedDate { get; }

Property Value

Type	Description
Output<System.String>

MfaConfiguration

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

Declaration

public Output<string> MfaConfiguration { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the attribute.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PasswordPolicy

A container for information about the user pool password policy.

Declaration

public Output<UserPoolPasswordPolicy> PasswordPolicy { get; }

Property Value

Type	Description
Output<UserPoolPasswordPolicy>

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 Output<ImmutableArray<UserPoolSchema>> Schemas { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<UserPoolSchema>>

SmsAuthenticationMessage

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

Declaration

public Output<string> SmsAuthenticationMessage { get; }

Property Value

Type	Description
Output<System.String>

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 Output<UserPoolSmsConfiguration> SmsConfiguration { get; }

Property Value

Type	Description
Output<UserPoolSmsConfiguration>

SmsVerificationMessage

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

Declaration

public Output<string> SmsVerificationMessage { get; }

Property Value

Type	Description
Output<System.String>

SoftwareTokenMfaConfiguration

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

Declaration

public Output<UserPoolSoftwareTokenMfaConfiguration> SoftwareTokenMfaConfiguration { get; }

Property Value

Type	Description
Output<UserPoolSoftwareTokenMfaConfiguration>

Tags

A map of tags to assign to the User Pool.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

UsernameAttributes

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

Declaration

public Output<ImmutableArray<string>> UsernameAttributes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

UsernameConfiguration

The Username Configuration.

Declaration

public Output<UserPoolUsernameConfiguration> UsernameConfiguration { get; }

Property Value

Type	Description
Output<UserPoolUsernameConfiguration>

UserPoolAddOns

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

Declaration

public Output<UserPoolUserPoolAddOns> UserPoolAddOns { get; }

Property Value

Type	Description
Output<UserPoolUserPoolAddOns>

VerificationMessageTemplate

The verification message templates configuration.

Declaration

public Output<UserPoolVerificationMessageTemplate> VerificationMessageTemplate { get; }

Property Value

Type	Description
Output<UserPoolVerificationMessageTemplate>

Methods

Get(String, Input<String>, UserPoolState, CustomResourceOptions)

Get an existing UserPool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static UserPool Get(string name, Input<string> id, UserPoolState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
UserPoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
UserPool