software.amazon.awscdk.services.cognito

Interface CfnUserPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.626Z")
 @Stability(value=Stable)
public interface CfnUserPoolProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Cognito::UserPool`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object userPoolTags;
 CfnUserPoolProps cfnUserPoolProps = CfnUserPoolProps.builder()
         .accountRecoverySetting(AccountRecoverySettingProperty.builder()
                 .recoveryMechanisms(List.of(RecoveryOptionProperty.builder()
                         .name("name")
                         .priority(123)
                         .build()))
                 .build())
         .adminCreateUserConfig(AdminCreateUserConfigProperty.builder()
                 .allowAdminCreateUserOnly(false)
                 .inviteMessageTemplate(InviteMessageTemplateProperty.builder()
                         .emailMessage("emailMessage")
                         .emailSubject("emailSubject")
                         .smsMessage("smsMessage")
                         .build())
                 .unusedAccountValidityDays(123)
                 .build())
         .aliasAttributes(List.of("aliasAttributes"))
         .autoVerifiedAttributes(List.of("autoVerifiedAttributes"))
         .deviceConfiguration(DeviceConfigurationProperty.builder()
                 .challengeRequiredOnNewDevice(false)
                 .deviceOnlyRememberedOnUserPrompt(false)
                 .build())
         .emailConfiguration(EmailConfigurationProperty.builder()
                 .configurationSet("configurationSet")
                 .emailSendingAccount("emailSendingAccount")
                 .from("from")
                 .replyToEmailAddress("replyToEmailAddress")
                 .sourceArn("sourceArn")
                 .build())
         .emailVerificationMessage("emailVerificationMessage")
         .emailVerificationSubject("emailVerificationSubject")
         .enabledMfas(List.of("enabledMfas"))
         .lambdaConfig(LambdaConfigProperty.builder()
                 .createAuthChallenge("createAuthChallenge")
                 .customEmailSender(CustomEmailSenderProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .customMessage("customMessage")
                 .customSmsSender(CustomSMSSenderProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .defineAuthChallenge("defineAuthChallenge")
                 .kmsKeyId("kmsKeyId")
                 .postAuthentication("postAuthentication")
                 .postConfirmation("postConfirmation")
                 .preAuthentication("preAuthentication")
                 .preSignUp("preSignUp")
                 .preTokenGeneration("preTokenGeneration")
                 .userMigration("userMigration")
                 .verifyAuthChallengeResponse("verifyAuthChallengeResponse")
                 .build())
         .mfaConfiguration("mfaConfiguration")
         .policies(PoliciesProperty.builder()
                 .passwordPolicy(PasswordPolicyProperty.builder()
                         .minimumLength(123)
                         .requireLowercase(false)
                         .requireNumbers(false)
                         .requireSymbols(false)
                         .requireUppercase(false)
                         .temporaryPasswordValidityDays(123)
                         .build())
                 .build())
         .schema(List.of(SchemaAttributeProperty.builder()
                 .attributeDataType("attributeDataType")
                 .developerOnlyAttribute(false)
                 .mutable(false)
                 .name("name")
                 .numberAttributeConstraints(NumberAttributeConstraintsProperty.builder()
                         .maxValue("maxValue")
                         .minValue("minValue")
                         .build())
                 .required(false)
                 .stringAttributeConstraints(StringAttributeConstraintsProperty.builder()
                         .maxLength("maxLength")
                         .minLength("minLength")
                         .build())
                 .build()))
         .smsAuthenticationMessage("smsAuthenticationMessage")
         .smsConfiguration(SmsConfigurationProperty.builder()
                 .externalId("externalId")
                 .snsCallerArn("snsCallerArn")
                 .build())
         .smsVerificationMessage("smsVerificationMessage")
         .usernameAttributes(List.of("usernameAttributes"))
         .usernameConfiguration(UsernameConfigurationProperty.builder()
                 .caseSensitive(false)
                 .build())
         .userPoolAddOns(UserPoolAddOnsProperty.builder()
                 .advancedSecurityMode("advancedSecurityMode")
                 .build())
         .userPoolName("userPoolName")
         .userPoolTags(userPoolTags)
         .verificationMessageTemplate(VerificationMessageTemplateProperty.builder()
                 .defaultEmailOption("defaultEmailOption")
                 .emailMessage("emailMessage")
                 .emailMessageByLink("emailMessageByLink")
                 .emailSubject("emailSubject")
                 .emailSubjectByLink("emailSubjectByLink")
                 .smsMessage("smsMessage")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserPoolProps.Builder A builder for CfnUserPoolProps
static class	CfnUserPoolProps.Jsii$Proxy An implementation for CfnUserPoolProps

Method Summary

Modifier and Type	Method and Description
static CfnUserPoolProps.Builder	builder()
default Object	getAccountRecoverySetting() `AWS::Cognito::UserPool.AccountRecoverySetting`.
default Object	getAdminCreateUserConfig() `AWS::Cognito::UserPool.AdminCreateUserConfig`.
default List<String>	getAliasAttributes() `AWS::Cognito::UserPool.AliasAttributes`.
default List<String>	getAutoVerifiedAttributes() `AWS::Cognito::UserPool.AutoVerifiedAttributes`.
default Object	getDeviceConfiguration() `AWS::Cognito::UserPool.DeviceConfiguration`.
default Object	getEmailConfiguration() `AWS::Cognito::UserPool.EmailConfiguration`.
default String	getEmailVerificationMessage() `AWS::Cognito::UserPool.EmailVerificationMessage`.
default String	getEmailVerificationSubject() `AWS::Cognito::UserPool.EmailVerificationSubject`.
default List<String>	getEnabledMfas() `AWS::Cognito::UserPool.EnabledMfas`.
default Object	getLambdaConfig() `AWS::Cognito::UserPool.LambdaConfig`.
default String	getMfaConfiguration() `AWS::Cognito::UserPool.MfaConfiguration`.
default Object	getPolicies() `AWS::Cognito::UserPool.Policies`.
default Object	getSchema() `AWS::Cognito::UserPool.Schema`.
default String	getSmsAuthenticationMessage() `AWS::Cognito::UserPool.SmsAuthenticationMessage`.
default Object	getSmsConfiguration() `AWS::Cognito::UserPool.SmsConfiguration`.
default String	getSmsVerificationMessage() `AWS::Cognito::UserPool.SmsVerificationMessage`.
default List<String>	getUsernameAttributes() `AWS::Cognito::UserPool.UsernameAttributes`.
default Object	getUsernameConfiguration() `AWS::Cognito::UserPool.UsernameConfiguration`.
default Object	getUserPoolAddOns() `AWS::Cognito::UserPool.UserPoolAddOns`.
default String	getUserPoolName() `AWS::Cognito::UserPool.UserPoolName`.
default Object	getUserPoolTags() `AWS::Cognito::UserPool.UserPoolTags`.
default Object	getVerificationMessageTemplate() `AWS::Cognito::UserPool.VerificationMessageTemplate`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccountRecoverySetting

@Stability(value=Stable)
 @Nullable
default Object getAccountRecoverySetting()

`AWS::Cognito::UserPool.AccountRecoverySetting`.

getAdminCreateUserConfig

@Stability(value=Stable)
 @Nullable
default Object getAdminCreateUserConfig()

`AWS::Cognito::UserPool.AdminCreateUserConfig`.

getAliasAttributes

@Stability(value=Stable)
 @Nullable
default List<String> getAliasAttributes()

`AWS::Cognito::UserPool.AliasAttributes`.

getAutoVerifiedAttributes

@Stability(value=Stable)
 @Nullable
default List<String> getAutoVerifiedAttributes()

`AWS::Cognito::UserPool.AutoVerifiedAttributes`.

getDeviceConfiguration

@Stability(value=Stable)
 @Nullable
default Object getDeviceConfiguration()

`AWS::Cognito::UserPool.DeviceConfiguration`.

getEmailConfiguration

@Stability(value=Stable)
 @Nullable
default Object getEmailConfiguration()

`AWS::Cognito::UserPool.EmailConfiguration`.

getEmailVerificationMessage

@Stability(value=Stable)
 @Nullable
default String getEmailVerificationMessage()

`AWS::Cognito::UserPool.EmailVerificationMessage`.

getEmailVerificationSubject

@Stability(value=Stable)
 @Nullable
default String getEmailVerificationSubject()

`AWS::Cognito::UserPool.EmailVerificationSubject`.

getEnabledMfas

@Stability(value=Stable)
 @Nullable
default List<String> getEnabledMfas()

`AWS::Cognito::UserPool.EnabledMfas`.

getLambdaConfig

@Stability(value=Stable)
 @Nullable
default Object getLambdaConfig()

`AWS::Cognito::UserPool.LambdaConfig`.

getMfaConfiguration

@Stability(value=Stable)
 @Nullable
default String getMfaConfiguration()

`AWS::Cognito::UserPool.MfaConfiguration`.

getPolicies

@Stability(value=Stable)
 @Nullable
default Object getPolicies()

`AWS::Cognito::UserPool.Policies`.

getSchema

@Stability(value=Stable)
 @Nullable
default Object getSchema()

`AWS::Cognito::UserPool.Schema`.

getSmsAuthenticationMessage

@Stability(value=Stable)
 @Nullable
default String getSmsAuthenticationMessage()

`AWS::Cognito::UserPool.SmsAuthenticationMessage`.

getSmsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getSmsConfiguration()

`AWS::Cognito::UserPool.SmsConfiguration`.

getSmsVerificationMessage

@Stability(value=Stable)
 @Nullable
default String getSmsVerificationMessage()

`AWS::Cognito::UserPool.SmsVerificationMessage`.

getUsernameAttributes

@Stability(value=Stable)
 @Nullable
default List<String> getUsernameAttributes()

`AWS::Cognito::UserPool.UsernameAttributes`.

getUsernameConfiguration

@Stability(value=Stable)
 @Nullable
default Object getUsernameConfiguration()

`AWS::Cognito::UserPool.UsernameConfiguration`.

getUserPoolAddOns

@Stability(value=Stable)
 @Nullable
default Object getUserPoolAddOns()

`AWS::Cognito::UserPool.UserPoolAddOns`.

getUserPoolName

@Stability(value=Stable)
 @Nullable
default String getUserPoolName()

`AWS::Cognito::UserPool.UserPoolName`.

getUserPoolTags

@Stability(value=Stable)
 @Nullable
default Object getUserPoolTags()

`AWS::Cognito::UserPool.UserPoolTags`.

getVerificationMessageTemplate

@Stability(value=Stable)
 @Nullable
default Object getVerificationMessageTemplate()

`AWS::Cognito::UserPool.VerificationMessageTemplate`.

builder

@Stability(value=Stable)
static CfnUserPoolProps.Builder builder()

Returns:

a CfnUserPoolProps.Builder of CfnUserPoolProps