Interface ICfnUserPoolMixinProps

Properties for CfnUserPoolPropsMixin.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface ICfnUserPoolMixinProps

Syntax (vb)

Public Interface ICfnUserPoolMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins;

             var userPoolTags;

             var cfnUserPoolMixinProps = new CfnUserPoolMixinProps {
                 AccountRecoverySetting = new AccountRecoverySettingProperty {
                     RecoveryMechanisms = new [] { new RecoveryOptionProperty {
                         Name = "name",
                         Priority = 123
                     } }
                 },
                 AdminCreateUserConfig = new AdminCreateUserConfigProperty {
                     AllowAdminCreateUserOnly = false,
                     InviteMessageTemplate = new InviteMessageTemplateProperty {
                         EmailMessage = "emailMessage",
                         EmailSubject = "emailSubject",
                         SmsMessage = "smsMessage"
                     },
                     UnusedAccountValidityDays = 123
                 },
                 AliasAttributes = new [] { "aliasAttributes" },
                 AutoVerifiedAttributes = new [] { "autoVerifiedAttributes" },
                 DeletionProtection = "deletionProtection",
                 DeviceConfiguration = new DeviceConfigurationProperty {
                     ChallengeRequiredOnNewDevice = false,
                     DeviceOnlyRememberedOnUserPrompt = false
                 },
                 EmailAuthenticationMessage = "emailAuthenticationMessage",
                 EmailAuthenticationSubject = "emailAuthenticationSubject",
                 EmailConfiguration = new EmailConfigurationProperty {
                     ConfigurationSet = "configurationSet",
                     EmailSendingAccount = "emailSendingAccount",
                     From = "from",
                     ReplyToEmailAddress = "replyToEmailAddress",
                     SourceArn = "sourceArn"
                 },
                 EmailVerificationMessage = "emailVerificationMessage",
                 EmailVerificationSubject = "emailVerificationSubject",
                 EnabledMfas = new [] { "enabledMfas" },
                 LambdaConfig = new LambdaConfigProperty {
                     CreateAuthChallenge = "createAuthChallenge",
                     CustomEmailSender = new CustomEmailSenderProperty {
                         LambdaArn = "lambdaArn",
                         LambdaVersion = "lambdaVersion"
                     },
                     CustomMessage = "customMessage",
                     CustomSmsSender = new CustomSMSSenderProperty {
                         LambdaArn = "lambdaArn",
                         LambdaVersion = "lambdaVersion"
                     },
                     DefineAuthChallenge = "defineAuthChallenge",
                     KmsKeyId = "kmsKeyId",
                     PostAuthentication = "postAuthentication",
                     PostConfirmation = "postConfirmation",
                     PreAuthentication = "preAuthentication",
                     PreSignUp = "preSignUp",
                     PreTokenGeneration = "preTokenGeneration",
                     PreTokenGenerationConfig = new PreTokenGenerationConfigProperty {
                         LambdaArn = "lambdaArn",
                         LambdaVersion = "lambdaVersion"
                     },
                     UserMigration = "userMigration",
                     VerifyAuthChallengeResponse = "verifyAuthChallengeResponse"
                 },
                 MfaConfiguration = "mfaConfiguration",
                 Policies = new PoliciesProperty {
                     PasswordPolicy = new PasswordPolicyProperty {
                         MinimumLength = 123,
                         PasswordHistorySize = 123,
                         RequireLowercase = false,
                         RequireNumbers = false,
                         RequireSymbols = false,
                         RequireUppercase = false,
                         TemporaryPasswordValidityDays = 123
                     },
                     SignInPolicy = new SignInPolicyProperty {
                         AllowedFirstAuthFactors = new [] { "allowedFirstAuthFactors" }
                     }
                 },
                 Schema = new [] { new SchemaAttributeProperty {
                     AttributeDataType = "attributeDataType",
                     DeveloperOnlyAttribute = false,
                     Mutable = false,
                     Name = "name",
                     NumberAttributeConstraints = new NumberAttributeConstraintsProperty {
                         MaxValue = "maxValue",
                         MinValue = "minValue"
                     },
                     Required = false,
                     StringAttributeConstraints = new StringAttributeConstraintsProperty {
                         MaxLength = "maxLength",
                         MinLength = "minLength"
                     }
                 } },
                 SmsAuthenticationMessage = "smsAuthenticationMessage",
                 SmsConfiguration = new SmsConfigurationProperty {
                     ExternalId = "externalId",
                     SnsCallerArn = "snsCallerArn",
                     SnsRegion = "snsRegion"
                 },
                 SmsVerificationMessage = "smsVerificationMessage",
                 UserAttributeUpdateSettings = new UserAttributeUpdateSettingsProperty {
                     AttributesRequireVerificationBeforeUpdate = new [] { "attributesRequireVerificationBeforeUpdate" }
                 },
                 UsernameAttributes = new [] { "usernameAttributes" },
                 UsernameConfiguration = new UsernameConfigurationProperty {
                     CaseSensitive = false
                 },
                 UserPoolAddOns = new UserPoolAddOnsProperty {
                     AdvancedSecurityAdditionalFlows = new AdvancedSecurityAdditionalFlowsProperty {
                         CustomAuthMode = "customAuthMode"
                     },
                     AdvancedSecurityMode = "advancedSecurityMode"
                 },
                 UserPoolName = "userPoolName",
                 UserPoolTags = userPoolTags,
                 UserPoolTier = "userPoolTier",
                 VerificationMessageTemplate = new VerificationMessageTemplateProperty {
                     DefaultEmailOption = "defaultEmailOption",
                     EmailMessage = "emailMessage",
                     EmailMessageByLink = "emailMessageByLink",
                     EmailSubject = "emailSubject",
                     EmailSubjectByLink = "emailSubjectByLink",
                     SmsMessage = "smsMessage"
                 },
                 WebAuthnRelyingPartyId = "webAuthnRelyingPartyId",
                 WebAuthnUserVerification = "webAuthnUserVerification"
             };

Synopsis

Properties

AccountRecoverySetting	The available verified method a user can use to recover their password when they call ForgotPassword .
AdminCreateUserConfig	The settings for administrator creation of users in a user pool.
AliasAttributes	Attributes supported as an alias for this user pool.
AutoVerifiedAttributes	The attributes that you want your user pool to automatically verify.
DeletionProtection	When active, DeletionProtection prevents accidental deletion of your user pool.
DeviceConfiguration	The device-remembering configuration for a user pool.
EmailAuthenticationMessage	Properties for CfnUserPoolPropsMixin.
EmailAuthenticationSubject	Properties for CfnUserPoolPropsMixin.
EmailConfiguration	The email configuration of your user pool.
EmailVerificationMessage	This parameter is no longer used.
EmailVerificationSubject	This parameter is no longer used.
EnabledMfas	Set enabled MFA options on a specified user pool.
LambdaConfig	A collection of user pool Lambda triggers.
MfaConfiguration	Displays the state of multi-factor authentication (MFA) as on, off, or optional.
Policies	A list of user pool policies.
Schema	An array of attributes for the new user pool.
SmsAuthenticationMessage	The contents of the SMS authentication message.
SmsConfiguration	The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.
SmsVerificationMessage	This parameter is no longer used.
UserAttributeUpdateSettings	The settings for updates to user attributes.
UserPoolAddOns	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
UserPoolName	A friendly name for your user pool.
UserPoolTags	The tag keys and values to assign to the user pool.
UserPoolTier	The user pool feature plan , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS .
UsernameAttributes	Specifies whether a user can use an email address or phone number as a username when they sign up.
UsernameConfiguration	Sets the case sensitivity option for sign-in usernames.
VerificationMessageTemplate	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
WebAuthnRelyingPartyId	Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
WebAuthnUserVerification	When required , users can only register and sign in users with passkeys that are capable of user verification . When preferred , your user pool doesn't require the use of authenticators with user verification but encourages it.

Properties

AccountRecoverySetting

The available verified method a user can use to recover their password when they call ForgotPassword .

object? AccountRecoverySetting { get; }

Property Value

object

Remarks

You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

Type union: either IResolvable or CfnUserPoolPropsMixin.IAccountRecoverySettingProperty

AdminCreateUserConfig

The settings for administrator creation of users in a user pool.

object? AdminCreateUserConfig { get; }

Property Value

object

Remarks

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

Type union: either IResolvable or CfnUserPoolPropsMixin.IAdminCreateUserConfigProperty

AliasAttributes

Attributes supported as an alias for this user pool.

string[]? AliasAttributes { get; }

Property Value

string[]

Remarks

For more information about alias attributes, see Customizing sign-in attributes .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes

AutoVerifiedAttributes

The attributes that you want your user pool to automatically verify.

string[]? AutoVerifiedAttributes { get; }

Property Value

string[]

Remarks

For more information, see Verifying contact information at sign-up .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes

DeletionProtection

When active, DeletionProtection prevents accidental deletion of your user pool.

string? DeletionProtection { get; }

Property Value

string

Remarks

Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deletionprotection

DeviceConfiguration

The device-remembering configuration for a user pool.

object? DeviceConfiguration { get; }

Property Value

object

Remarks

Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool . A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration

Type union: either IResolvable or CfnUserPoolPropsMixin.IDeviceConfigurationProperty

EmailAuthenticationMessage

Properties for CfnUserPoolPropsMixin.

string? EmailAuthenticationMessage { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationmessage

EmailAuthenticationSubject

Properties for CfnUserPoolPropsMixin.

string? EmailAuthenticationSubject { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationsubject

EmailConfiguration

The email configuration of your user pool.

object? EmailConfiguration { get; }

Property Value

object

Remarks

The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

Type union: either IResolvable or CfnUserPoolPropsMixin.IEmailConfigurationProperty

EmailVerificationMessage

This parameter is no longer used.

string? EmailVerificationMessage { get; }

Property Value

string

Remarks

See VerificationMessageTemplateType .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage

EmailVerificationSubject

This parameter is no longer used.

string? EmailVerificationSubject { get; }

Property Value

string

Remarks

See VerificationMessageTemplateType .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject

EnabledMfas

Set enabled MFA options on a specified user pool.

string[]? EnabledMfas { get; }

Property Value

string[]

Remarks

To disable all MFAs after it has been enabled, set MfaConfiguration to OFF and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF . After you enable SMS_MFA , you can only disable it by setting MfaConfiguration to OFF . Can be one of the following values:

Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA | EMAIL_OTP

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas

LambdaConfig

A collection of user pool Lambda triggers.

object? LambdaConfig { get; }

Property Value

object

Remarks

Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

Type union: either IResolvable or CfnUserPoolPropsMixin.ILambdaConfigProperty

MfaConfiguration

Displays the state of multi-factor authentication (MFA) as on, off, or optional.

string? MfaConfiguration { get; }

Property Value

string

Remarks

When ON , all users must set up MFA before they can sign in. When OPTIONAL , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL .

When MfaConfiguration is OPTIONAL , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration

Policies

A list of user pool policies.

object? Policies { get; }

Property Value

object

Remarks

Contains the policy that sets password-complexity requirements.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies

Type union: either IResolvable or CfnUserPoolPropsMixin.IPoliciesProperty

Schema

An array of attributes for the new user pool.

object? Schema { get; }

Property Value

object

Remarks

You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

Type union: either IResolvable or (either IResolvable or CfnUserPoolPropsMixin.ISchemaAttributeProperty)[]

SmsAuthenticationMessage

The contents of the SMS authentication message.

string? SmsAuthenticationMessage { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage

SmsConfiguration

The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.

object? SmsConfiguration { get; }

Property Value

object

Remarks

To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see SMS message settings .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

Type union: either IResolvable or CfnUserPoolPropsMixin.ISmsConfigurationProperty

SmsVerificationMessage

This parameter is no longer used.

string? SmsVerificationMessage { get; }

Property Value

string

Remarks

See VerificationMessageTemplateType .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage

UserAttributeUpdateSettings

The settings for updates to user attributes.

object? UserAttributeUpdateSettings { get; }

Property Value

object

Remarks

These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings

Type union: either IResolvable or CfnUserPoolPropsMixin.IUserAttributeUpdateSettingsProperty

UserPoolAddOns

Contains settings for activation of threat protection, including the operating mode and additional authentication types.

object? UserPoolAddOns { get; }

Property Value

object

Remarks

To log user security information but take no action, set to AUDIT . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED .

For more information, see Adding advanced security to a user pool . To activate this setting, your user pool must be on the Plus tier .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons

Type union: either IResolvable or CfnUserPoolPropsMixin.IUserPoolAddOnsProperty

UserPoolName

A friendly name for your user pool.

string? UserPoolName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname

UserPoolTags

The tag keys and values to assign to the user pool.

object? UserPoolTags { get; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags

UserPoolTier

The user pool feature plan , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS .

string? UserPoolTier { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltier

UsernameAttributes

Specifies whether a user can use an email address or phone number as a username when they sign up.

string[]? UsernameAttributes { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes

UsernameConfiguration

Sets the case sensitivity option for sign-in usernames.

object? UsernameConfiguration { get; }

Property Value

object

Remarks

When CaseSensitive is false (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to false as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

This configuration is immutable after you set it.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

Type union: either IResolvable or CfnUserPoolPropsMixin.IUsernameConfigurationProperty

VerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

object? VerificationMessageTemplate { get; }

Property Value

object

Remarks

Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK , specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE , specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

Type union: either IResolvable or CfnUserPoolPropsMixin.IVerificationMessageTemplateProperty

WebAuthnRelyingPartyId

Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

string? WebAuthnRelyingPartyId { get; }

Property Value

string

Remarks

Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnrelyingpartyid

WebAuthnUserVerification

When required , users can only register and sign in users with passkeys that are capable of user verification . When preferred , your user pool doesn't require the use of authenticators with user verification but encourages it.

string? WebAuthnUserVerification { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnuserverification