Class CfnUserPool
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPool
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-12T19:33:59.427Z")
@Stability(Stable)
public class CfnUserPool
extends CfnResource
implements IInspectable, ITaggable
The
AWS::Cognito::UserPool
resource creates an Amazon Cognito user pool.
For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools and CreateUserPool .
If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.
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")) .deletionProtection("deletionProtection") .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") .preTokenGenerationConfig(PreTokenGenerationConfigProperty.builder() .lambdaArn("lambdaArn") .lambdaVersion("lambdaVersion") .build()) .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") .snsRegion("snsRegion") .build()) .smsVerificationMessage("smsVerificationMessage") .userAttributeUpdateSettings(UserAttributeUpdateSettingsProperty.builder() .attributesRequireVerificationBeforeUpdate(List.of("attributesRequireVerificationBeforeUpdate")) .build()) .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.static interface
The configuration forAdminCreateUser
requests.static final class
A fluent builder forCfnUserPool
.static interface
A custom email sender AWS Lambda trigger.static interface
A custom SMS sender AWS Lambda trigger.static interface
The device-remembering configuration for a user pool.static interface
The email configuration of your user pool.static interface
The message template to be used for the welcome message to new users.static interface
Specifies the configuration for AWS Lambda triggers.static interface
The minimum and maximum values of an attribute that is of the number data type.static interface
The password policy type.static interface
The policy associated with a user pool.static interface
The properties of a pre token generation Lambda trigger.static interface
A map containing a priority as a key, and recovery method name as a value.static interface
A list of the user attributes and their properties in your user pool.static interface
The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account .static interface
TheStringAttributeConstraints
property type defines the string attribute constraints of an Amazon Cognito user pool.static interface
The settings for updates to user attributes.static interface
TheUsernameConfiguration
property type specifies case sensitivity on the username input for the selected sign-in option.static interface
User pool add-ons.static interface
The template for verification messages.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnUserPool
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnUserPool
(software.amazon.jsii.JsiiObjectRef objRef) CfnUserPool
(software.constructs.Construct scope, String id) CfnUserPool
(software.constructs.Construct scope, String id, CfnUserPoolProps props) -
Method Summary
Modifier and TypeMethodDescriptionUse this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.The configuration for creating a new user profile.Attributes supported as an alias for this user pool.The Amazon Resource Name (ARN) of the user pool, such asarn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341
.The provider name of the Amazon Cognito user pool, specified as aString
.The URL of the provider of the Amazon Cognito user pool, specified as aString
.The ID of the user pool.The attributes to be auto-verified.When active,DeletionProtection
prevents accidental deletion of your user pool.The device-remembering configuration for a user pool.The email configuration of your user pool.This parameter is no longer used.This parameter is no longer used.Enables MFA on a specified user pool.The Lambda trigger configuration information for the new user pool.The multi-factor authentication (MFA) configuration.The policy associated with a user pool.The schema attributes for the new user pool.A string representing the SMS authentication message.The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.This parameter is no longer used.getTags()
Tag Manager which manages the tags for this resource.The settings for updates to user attributes.Determines whether email addresses or phone numbers can be specified as user names when a user signs up.You can choose to set case sensitivity on the username input for the selected sign-in option.User pool add-ons.A string used to name the user pool.The tag keys and values to assign to the user pool.The template for the verification message that the user sees when the app requests permission to access the user's information.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.void
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.void
The configuration for creating a new user profile.void
The configuration for creating a new user profile.void
setAliasAttributes
(List<String> value) Attributes supported as an alias for this user pool.void
setAutoVerifiedAttributes
(List<String> value) The attributes to be auto-verified.void
setDeletionProtection
(String value) When active,DeletionProtection
prevents accidental deletion of your user pool.void
The device-remembering configuration for a user pool.void
The device-remembering configuration for a user pool.void
setEmailConfiguration
(IResolvable value) The email configuration of your user pool.void
The email configuration of your user pool.void
This parameter is no longer used.void
This parameter is no longer used.void
setEnabledMfas
(List<String> value) Enables MFA on a specified user pool.void
setLambdaConfig
(IResolvable value) The Lambda trigger configuration information for the new user pool.void
The Lambda trigger configuration information for the new user pool.void
setMfaConfiguration
(String value) The multi-factor authentication (MFA) configuration.void
setPolicies
(IResolvable value) The policy associated with a user pool.void
The policy associated with a user pool.void
The schema attributes for the new user pool.void
setSchema
(IResolvable value) The schema attributes for the new user pool.void
A string representing the SMS authentication message.void
setSmsConfiguration
(IResolvable value) The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.void
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.void
setSmsVerificationMessage
(String value) This parameter is no longer used.void
The settings for updates to user attributes.void
The settings for updates to user attributes.void
setUsernameAttributes
(List<String> value) Determines whether email addresses or phone numbers can be specified as user names when a user signs up.void
You can choose to set case sensitivity on the username input for the selected sign-in option.void
You can choose to set case sensitivity on the username input for the selected sign-in option.void
setUserPoolAddOns
(IResolvable value) User pool add-ons.void
User pool add-ons.void
setUserPoolName
(String value) A string used to name the user pool.void
setUserPoolTagsRaw
(Object value) The tag keys and values to assign to the user pool.void
The template for the verification message that the user sees when the app requests permission to access the user's information.void
The template for the verification message that the user sees when the app requests permission to access the user's information.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnUserPool
protected CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef) -
CfnUserPool
protected CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnUserPool
@Stability(Stable) public CfnUserPool(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnUserPoolProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnUserPool
@Stability(Stable) public CfnUserPool(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the user pool, such asarn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341
. -
getAttrProviderName
The provider name of the Amazon Cognito user pool, specified as aString
. -
getAttrProviderUrl
The URL of the provider of the Amazon Cognito user pool, specified as aString
. -
getAttrUserPoolId
The ID of the user pool. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAccountRecoverySetting
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
. -
setAccountRecoverySetting
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
. -
setAccountRecoverySetting
@Stability(Stable) public void setAccountRecoverySetting(@Nullable CfnUserPool.AccountRecoverySettingProperty value) Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
. -
getAdminCreateUserConfig
The configuration for creating a new user profile. -
setAdminCreateUserConfig
The configuration for creating a new user profile. -
setAdminCreateUserConfig
@Stability(Stable) public void setAdminCreateUserConfig(@Nullable CfnUserPool.AdminCreateUserConfigProperty value) The configuration for creating a new user profile. -
getAliasAttributes
Attributes supported as an alias for this user pool.Possible values: phone_number , email , or preferred_username .
-
setAliasAttributes
Attributes supported as an alias for this user pool.Possible values: phone_number , email , or preferred_username .
-
getAutoVerifiedAttributes
The attributes to be auto-verified. -
setAutoVerifiedAttributes
The attributes to be auto-verified. -
getDeletionProtection
When active,DeletionProtection
prevents accidental deletion of your user pool. -
setDeletionProtection
When active,DeletionProtection
prevents accidental deletion of your user pool. -
getDeviceConfiguration
The device-remembering configuration for a user pool. -
setDeviceConfiguration
The device-remembering configuration for a user pool. -
setDeviceConfiguration
@Stability(Stable) public void setDeviceConfiguration(@Nullable CfnUserPool.DeviceConfigurationProperty value) The device-remembering configuration for a user pool. -
getEmailConfiguration
The email configuration of your user pool. -
setEmailConfiguration
The email configuration of your user pool. -
setEmailConfiguration
@Stability(Stable) public void setEmailConfiguration(@Nullable CfnUserPool.EmailConfigurationProperty value) The email configuration of your user pool. -
getEmailVerificationMessage
This parameter is no longer used. -
setEmailVerificationMessage
This parameter is no longer used. -
getEmailVerificationSubject
This parameter is no longer used. -
setEmailVerificationSubject
This parameter is no longer used. -
getEnabledMfas
Enables MFA on a specified user pool. -
setEnabledMfas
Enables MFA on a specified user pool. -
getLambdaConfig
The Lambda trigger configuration information for the new user pool. -
setLambdaConfig
The Lambda trigger configuration information for the new user pool. -
setLambdaConfig
The Lambda trigger configuration information for the new user pool. -
getMfaConfiguration
The multi-factor authentication (MFA) configuration.Valid values include:.
-
setMfaConfiguration
The multi-factor authentication (MFA) configuration.Valid values include:.
-
getPolicies
The policy associated with a user pool. -
setPolicies
The policy associated with a user pool. -
setPolicies
The policy associated with a user pool. -
getSchema
The schema attributes for the new user pool.These attributes can be standard or custom attributes.
-
setSchema
The schema attributes for the new user pool.These attributes can be standard or custom attributes.
-
setSchema
The schema attributes for the new user pool.These attributes can be standard or custom attributes.
-
getSmsAuthenticationMessage
A string representing the SMS authentication message. -
setSmsAuthenticationMessage
A string representing the SMS authentication message. -
getSmsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. -
setSmsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. -
setSmsConfiguration
@Stability(Stable) public void setSmsConfiguration(@Nullable CfnUserPool.SmsConfigurationProperty value) The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. -
getSmsVerificationMessage
This parameter is no longer used. -
setSmsVerificationMessage
This parameter is no longer used. -
getUserAttributeUpdateSettings
The settings for updates to user attributes. -
setUserAttributeUpdateSettings
The settings for updates to user attributes. -
setUserAttributeUpdateSettings
@Stability(Stable) public void setUserAttributeUpdateSettings(@Nullable CfnUserPool.UserAttributeUpdateSettingsProperty value) The settings for updates to user attributes. -
getUsernameAttributes
Determines whether email addresses or phone numbers can be specified as user names when a user signs up. -
setUsernameAttributes
Determines whether email addresses or phone numbers can be specified as user names when a user signs up. -
getUsernameConfiguration
You can choose to set case sensitivity on the username input for the selected sign-in option. -
setUsernameConfiguration
You can choose to set case sensitivity on the username input for the selected sign-in option. -
setUsernameConfiguration
@Stability(Stable) public void setUsernameConfiguration(@Nullable CfnUserPool.UsernameConfigurationProperty value) You can choose to set case sensitivity on the username input for the selected sign-in option. -
getUserPoolAddOns
User pool add-ons. -
setUserPoolAddOns
User pool add-ons. -
setUserPoolAddOns
@Stability(Stable) public void setUserPoolAddOns(@Nullable CfnUserPool.UserPoolAddOnsProperty value) User pool add-ons. -
getUserPoolName
A string used to name the user pool. -
setUserPoolName
A string used to name the user pool. -
getUserPoolTagsRaw
The tag keys and values to assign to the user pool. -
setUserPoolTagsRaw
The tag keys and values to assign to the user pool. -
getVerificationMessageTemplate
The template for the verification message that the user sees when the app requests permission to access the user's information. -
setVerificationMessageTemplate
The template for the verification message that the user sees when the app requests permission to access the user's information. -
setVerificationMessageTemplate
@Stability(Stable) public void setVerificationMessageTemplate(@Nullable CfnUserPool.VerificationMessageTemplateProperty value) The template for the verification message that the user sees when the app requests permission to access the user's information.
-