software.amazon.awscdk.services.cognito

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.735Z")
 @Stability(value=Stable)
public class CfnUserPool
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPool`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnUserPool.AccountRecoverySettingProperty
static interface	CfnUserPool.AdminCreateUserConfigProperty
static class	CfnUserPool.Builder A fluent builder for CfnUserPool.
static interface	CfnUserPool.CustomEmailSenderProperty
static interface	CfnUserPool.CustomSMSSenderProperty
static interface	CfnUserPool.DeviceConfigurationProperty
static interface	CfnUserPool.EmailConfigurationProperty
static interface	CfnUserPool.InviteMessageTemplateProperty
static interface	CfnUserPool.LambdaConfigProperty
static interface	CfnUserPool.NumberAttributeConstraintsProperty
static interface	CfnUserPool.PasswordPolicyProperty
static interface	CfnUserPool.PoliciesProperty
static interface	CfnUserPool.RecoveryOptionProperty
static interface	CfnUserPool.SchemaAttributeProperty
static interface	CfnUserPool.SmsConfigurationProperty
static interface	CfnUserPool.StringAttributeConstraintsProperty
static interface	CfnUserPool.UsernameConfigurationProperty
static interface	CfnUserPool.UserPoolAddOnsProperty
static interface	CfnUserPool.VerificationMessageTemplateProperty

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPool

protected CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPool

protected CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPool

@Stability(value=Stable)
public CfnUserPool(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            CfnUserPoolProps props)

Create a new `AWS::Cognito::UserPool`.

Parameters:

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.

CfnUserPool

@Stability(value=Stable)
public CfnUserPool(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id)

Create a new `AWS::Cognito::UserPool`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrProviderName

@Stability(value=Stable)
 @NotNull
public String getAttrProviderName()

getAttrProviderUrl

@Stability(value=Stable)
 @NotNull
public String getAttrProviderUrl()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAccountRecoverySetting

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

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

setAccountRecoverySetting

@Stability(value=Stable)
public void setAccountRecoverySetting(@Nullable
                                                               CfnUserPool.AccountRecoverySettingProperty value)

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

setAccountRecoverySetting

@Stability(value=Stable)
public void setAccountRecoverySetting(@Nullable
                                                               IResolvable value)

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

getAdminCreateUserConfig

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

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

setAdminCreateUserConfig

@Stability(value=Stable)
public void setAdminCreateUserConfig(@Nullable
                                                              CfnUserPool.AdminCreateUserConfigProperty value)

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

setAdminCreateUserConfig

@Stability(value=Stable)
public void setAdminCreateUserConfig(@Nullable
                                                              IResolvable value)

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

getAliasAttributes

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

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

setAliasAttributes

@Stability(value=Stable)
public void setAliasAttributes(@Nullable
                                                        List<String> value)

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

getAutoVerifiedAttributes

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

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

setAutoVerifiedAttributes

@Stability(value=Stable)
public void setAutoVerifiedAttributes(@Nullable
                                                               List<String> value)

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

getDeviceConfiguration

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

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

setDeviceConfiguration

@Stability(value=Stable)
public void setDeviceConfiguration(@Nullable
                                                            CfnUserPool.DeviceConfigurationProperty value)

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

setDeviceConfiguration

@Stability(value=Stable)
public void setDeviceConfiguration(@Nullable
                                                            IResolvable value)

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

getEmailConfiguration

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

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

setEmailConfiguration

@Stability(value=Stable)
public void setEmailConfiguration(@Nullable
                                                           CfnUserPool.EmailConfigurationProperty value)

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

setEmailConfiguration

@Stability(value=Stable)
public void setEmailConfiguration(@Nullable
                                                           IResolvable value)

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

getEmailVerificationMessage

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

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

setEmailVerificationMessage

@Stability(value=Stable)
public void setEmailVerificationMessage(@Nullable
                                                                 String value)

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

getEmailVerificationSubject

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

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

setEmailVerificationSubject

@Stability(value=Stable)
public void setEmailVerificationSubject(@Nullable
                                                                 String value)

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

getEnabledMfas

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

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

setEnabledMfas

@Stability(value=Stable)
public void setEnabledMfas(@Nullable
                                                    List<String> value)

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

getLambdaConfig

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

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

setLambdaConfig

@Stability(value=Stable)
public void setLambdaConfig(@Nullable
                                                     CfnUserPool.LambdaConfigProperty value)

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

setLambdaConfig

@Stability(value=Stable)
public void setLambdaConfig(@Nullable
                                                     IResolvable value)

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

getMfaConfiguration

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

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

setMfaConfiguration

@Stability(value=Stable)
public void setMfaConfiguration(@Nullable
                                                         String value)

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

getPolicies

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

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

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 CfnUserPool.PoliciesProperty value)

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

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 IResolvable value)

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

getSchema

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

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

setSchema

@Stability(value=Stable)
public void setSchema(@Nullable
                                               IResolvable value)

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

setSchema

@Stability(value=Stable)
public void setSchema(@Nullable
                                               List<Object> value)

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

getSmsAuthenticationMessage

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

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

setSmsAuthenticationMessage

@Stability(value=Stable)
public void setSmsAuthenticationMessage(@Nullable
                                                                 String value)

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

getSmsConfiguration

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

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

setSmsConfiguration

@Stability(value=Stable)
public void setSmsConfiguration(@Nullable
                                                         CfnUserPool.SmsConfigurationProperty value)

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

setSmsConfiguration

@Stability(value=Stable)
public void setSmsConfiguration(@Nullable
                                                         IResolvable value)

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

getSmsVerificationMessage

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

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

setSmsVerificationMessage

@Stability(value=Stable)
public void setSmsVerificationMessage(@Nullable
                                                               String value)

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

getUsernameAttributes

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

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

setUsernameAttributes

@Stability(value=Stable)
public void setUsernameAttributes(@Nullable
                                                           List<String> value)

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

getUsernameConfiguration

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

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

setUsernameConfiguration

@Stability(value=Stable)
public void setUsernameConfiguration(@Nullable
                                                              CfnUserPool.UsernameConfigurationProperty value)

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

setUsernameConfiguration

@Stability(value=Stable)
public void setUsernameConfiguration(@Nullable
                                                              IResolvable value)

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

getUserPoolAddOns

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

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

setUserPoolAddOns

@Stability(value=Stable)
public void setUserPoolAddOns(@Nullable
                                                       CfnUserPool.UserPoolAddOnsProperty value)

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

setUserPoolAddOns

@Stability(value=Stable)
public void setUserPoolAddOns(@Nullable
                                                       IResolvable value)

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

getUserPoolName

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

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

setUserPoolName

@Stability(value=Stable)
public void setUserPoolName(@Nullable
                                                     String value)

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

getVerificationMessageTemplate

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

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

setVerificationMessageTemplate

@Stability(value=Stable)
public void setVerificationMessageTemplate(@Nullable
                                                                    CfnUserPool.VerificationMessageTemplateProperty value)

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

setVerificationMessageTemplate

@Stability(value=Stable)
public void setVerificationMessageTemplate(@Nullable
                                                                    IResolvable value)

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