@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)", date="2021-12-22T10:27:16.618Z") @Stability(value=Stable) public class CfnUserPool extends CfnResource implements IInspectable
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;
CfnUserPool cfnUserPool = CfnUserPool.Builder.create(this, "MyCfnUserPool")
.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();
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnUserPool(software.constructs.Construct scope,
String id)
Create a new `AWS::Cognito::UserPool`.
|
|
CfnUserPool(software.constructs.Construct scope,
String id,
CfnUserPoolProps props)
Create a new `AWS::Cognito::UserPool`.
|
protected |
CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAccountRecoverySetting()
`AWS::Cognito::UserPool.AccountRecoverySetting`.
|
Object |
getAdminCreateUserConfig()
`AWS::Cognito::UserPool.AdminCreateUserConfig`.
|
List<String> |
getAliasAttributes()
`AWS::Cognito::UserPool.AliasAttributes`.
|
String |
getAttrArn() |
String |
getAttrProviderName() |
String |
getAttrProviderUrl() |
List<String> |
getAutoVerifiedAttributes()
`AWS::Cognito::UserPool.AutoVerifiedAttributes`.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getDeviceConfiguration()
`AWS::Cognito::UserPool.DeviceConfiguration`.
|
Object |
getEmailConfiguration()
`AWS::Cognito::UserPool.EmailConfiguration`.
|
String |
getEmailVerificationMessage()
`AWS::Cognito::UserPool.EmailVerificationMessage`.
|
String |
getEmailVerificationSubject()
`AWS::Cognito::UserPool.EmailVerificationSubject`.
|
List<String> |
getEnabledMfas()
`AWS::Cognito::UserPool.EnabledMfas`.
|
Object |
getLambdaConfig()
`AWS::Cognito::UserPool.LambdaConfig`.
|
String |
getMfaConfiguration()
`AWS::Cognito::UserPool.MfaConfiguration`.
|
Object |
getPolicies()
`AWS::Cognito::UserPool.Policies`.
|
Object |
getSchema()
`AWS::Cognito::UserPool.Schema`.
|
String |
getSmsAuthenticationMessage()
`AWS::Cognito::UserPool.SmsAuthenticationMessage`.
|
Object |
getSmsConfiguration()
`AWS::Cognito::UserPool.SmsConfiguration`.
|
String |
getSmsVerificationMessage()
`AWS::Cognito::UserPool.SmsVerificationMessage`.
|
TagManager |
getTags()
`AWS::Cognito::UserPool.UserPoolTags`.
|
List<String> |
getUsernameAttributes()
`AWS::Cognito::UserPool.UsernameAttributes`.
|
Object |
getUsernameConfiguration()
`AWS::Cognito::UserPool.UsernameConfiguration`.
|
Object |
getUserPoolAddOns()
`AWS::Cognito::UserPool.UserPoolAddOns`.
|
String |
getUserPoolName()
`AWS::Cognito::UserPool.UserPoolName`.
|
Object |
getVerificationMessageTemplate()
`AWS::Cognito::UserPool.VerificationMessageTemplate`.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAccountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty value)
`AWS::Cognito::UserPool.AccountRecoverySetting`.
|
void |
setAccountRecoverySetting(IResolvable value)
`AWS::Cognito::UserPool.AccountRecoverySetting`.
|
void |
setAdminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty value)
`AWS::Cognito::UserPool.AdminCreateUserConfig`.
|
void |
setAdminCreateUserConfig(IResolvable value)
`AWS::Cognito::UserPool.AdminCreateUserConfig`.
|
void |
setAliasAttributes(List<String> value)
`AWS::Cognito::UserPool.AliasAttributes`.
|
void |
setAutoVerifiedAttributes(List<String> value)
`AWS::Cognito::UserPool.AutoVerifiedAttributes`.
|
void |
setDeviceConfiguration(CfnUserPool.DeviceConfigurationProperty value)
`AWS::Cognito::UserPool.DeviceConfiguration`.
|
void |
setDeviceConfiguration(IResolvable value)
`AWS::Cognito::UserPool.DeviceConfiguration`.
|
void |
setEmailConfiguration(CfnUserPool.EmailConfigurationProperty value)
`AWS::Cognito::UserPool.EmailConfiguration`.
|
void |
setEmailConfiguration(IResolvable value)
`AWS::Cognito::UserPool.EmailConfiguration`.
|
void |
setEmailVerificationMessage(String value)
`AWS::Cognito::UserPool.EmailVerificationMessage`.
|
void |
setEmailVerificationSubject(String value)
`AWS::Cognito::UserPool.EmailVerificationSubject`.
|
void |
setEnabledMfas(List<String> value)
`AWS::Cognito::UserPool.EnabledMfas`.
|
void |
setLambdaConfig(CfnUserPool.LambdaConfigProperty value)
`AWS::Cognito::UserPool.LambdaConfig`.
|
void |
setLambdaConfig(IResolvable value)
`AWS::Cognito::UserPool.LambdaConfig`.
|
void |
setMfaConfiguration(String value)
`AWS::Cognito::UserPool.MfaConfiguration`.
|
void |
setPolicies(CfnUserPool.PoliciesProperty value)
`AWS::Cognito::UserPool.Policies`.
|
void |
setPolicies(IResolvable value)
`AWS::Cognito::UserPool.Policies`.
|
void |
setSchema(IResolvable value)
`AWS::Cognito::UserPool.Schema`.
|
void |
setSchema(List<Object> value)
`AWS::Cognito::UserPool.Schema`.
|
void |
setSmsAuthenticationMessage(String value)
`AWS::Cognito::UserPool.SmsAuthenticationMessage`.
|
void |
setSmsConfiguration(CfnUserPool.SmsConfigurationProperty value)
`AWS::Cognito::UserPool.SmsConfiguration`.
|
void |
setSmsConfiguration(IResolvable value)
`AWS::Cognito::UserPool.SmsConfiguration`.
|
void |
setSmsVerificationMessage(String value)
`AWS::Cognito::UserPool.SmsVerificationMessage`.
|
void |
setUsernameAttributes(List<String> value)
`AWS::Cognito::UserPool.UsernameAttributes`.
|
void |
setUsernameConfiguration(CfnUserPool.UsernameConfigurationProperty value)
`AWS::Cognito::UserPool.UsernameConfiguration`.
|
void |
setUsernameConfiguration(IResolvable value)
`AWS::Cognito::UserPool.UsernameConfiguration`.
|
void |
setUserPoolAddOns(CfnUserPool.UserPoolAddOnsProperty value)
`AWS::Cognito::UserPool.UserPoolAddOns`.
|
void |
setUserPoolAddOns(IResolvable value)
`AWS::Cognito::UserPool.UserPoolAddOns`.
|
void |
setUserPoolName(String value)
`AWS::Cognito::UserPool.UserPoolName`.
|
void |
setVerificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty value)
`AWS::Cognito::UserPool.VerificationMessageTemplate`.
|
void |
setVerificationMessageTemplate(IResolvable value)
`AWS::Cognito::UserPool.VerificationMessageTemplate`.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnUserPool(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@Nullable
CfnUserPoolProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties.@Stability(value=Stable)
public CfnUserPool(@NotNull
software.constructs.Construct scope,
@NotNull
String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @Nullable public Object getAccountRecoverySetting()
@Stability(value=Stable)
public void setAccountRecoverySetting(@Nullable
CfnUserPool.AccountRecoverySettingProperty value)
@Stability(value=Stable)
public void setAccountRecoverySetting(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getAdminCreateUserConfig()
@Stability(value=Stable)
public void setAdminCreateUserConfig(@Nullable
CfnUserPool.AdminCreateUserConfigProperty value)
@Stability(value=Stable)
public void setAdminCreateUserConfig(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public List<String> getAliasAttributes()
@Stability(value=Stable)
public void setAliasAttributes(@Nullable
List<String> value)
@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrProviderName()
@Stability(value=Stable) @NotNull public String getAttrProviderUrl()
@Stability(value=Stable) @Nullable public List<String> getAutoVerifiedAttributes()
@Stability(value=Stable)
public void setAutoVerifiedAttributes(@Nullable
List<String> value)
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @Nullable public Object getDeviceConfiguration()
@Stability(value=Stable)
public void setDeviceConfiguration(@Nullable
CfnUserPool.DeviceConfigurationProperty value)
@Stability(value=Stable)
public void setDeviceConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getEmailConfiguration()
@Stability(value=Stable)
public void setEmailConfiguration(@Nullable
CfnUserPool.EmailConfigurationProperty value)
@Stability(value=Stable)
public void setEmailConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getEmailVerificationMessage()
@Stability(value=Stable)
public void setEmailVerificationMessage(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getEmailVerificationSubject()
@Stability(value=Stable)
public void setEmailVerificationSubject(@Nullable
String value)
@Stability(value=Stable) @Nullable public List<String> getEnabledMfas()
@Stability(value=Stable)
public void setEnabledMfas(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public Object getLambdaConfig()
@Stability(value=Stable)
public void setLambdaConfig(@Nullable
CfnUserPool.LambdaConfigProperty value)
@Stability(value=Stable)
public void setLambdaConfig(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getMfaConfiguration()
@Stability(value=Stable)
public void setMfaConfiguration(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getPolicies()
@Stability(value=Stable)
public void setPolicies(@Nullable
CfnUserPool.PoliciesProperty value)
@Stability(value=Stable)
public void setPolicies(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getSchema()
@Stability(value=Stable)
public void setSchema(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setSchema(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public String getSmsAuthenticationMessage()
@Stability(value=Stable)
public void setSmsAuthenticationMessage(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getSmsConfiguration()
@Stability(value=Stable)
public void setSmsConfiguration(@Nullable
CfnUserPool.SmsConfigurationProperty value)
@Stability(value=Stable)
public void setSmsConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getSmsVerificationMessage()
@Stability(value=Stable)
public void setSmsVerificationMessage(@Nullable
String value)
@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @Nullable public List<String> getUsernameAttributes()
@Stability(value=Stable)
public void setUsernameAttributes(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public Object getUsernameConfiguration()
@Stability(value=Stable)
public void setUsernameConfiguration(@Nullable
CfnUserPool.UsernameConfigurationProperty value)
@Stability(value=Stable)
public void setUsernameConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getUserPoolAddOns()
@Stability(value=Stable)
public void setUserPoolAddOns(@Nullable
CfnUserPool.UserPoolAddOnsProperty value)
@Stability(value=Stable)
public void setUserPoolAddOns(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getUserPoolName()
@Stability(value=Stable)
public void setUserPoolName(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getVerificationMessageTemplate()
@Stability(value=Stable)
public void setVerificationMessageTemplate(@Nullable
CfnUserPool.VerificationMessageTemplateProperty value)
@Stability(value=Stable)
public void setVerificationMessageTemplate(@Nullable
IResolvable value)
Copyright © 2021. All rights reserved.