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.14.1 (build 828de8a)",
           date="2020-11-24T22:28:21.978Z")
 @Stability(value=Stable)
public interface CfnUserPoolProps
extends software.amazon.jsii.JsiiSerializable

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

See Also:

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

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

See Also:

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

getAdminCreateUserConfig

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

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

See Also:

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

getAliasAttributes

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

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

See Also:

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

getAutoVerifiedAttributes

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

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

See Also:

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

getDeviceConfiguration

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

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

See Also:

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

getEmailConfiguration

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

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

See Also:

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

getEmailVerificationMessage

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

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

See Also:

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

getEmailVerificationSubject

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

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

See Also:

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

getEnabledMfas

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

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

See Also:

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

getLambdaConfig

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

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

See Also:

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

getMfaConfiguration

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

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

See Also:

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

getPolicies

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

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

See Also:

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

getSchema

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

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

See Also:

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

getSmsAuthenticationMessage

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

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

See Also:

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

getSmsConfiguration

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

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

See Also:

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

getSmsVerificationMessage

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

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

See Also:

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

getUsernameAttributes

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

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

See Also:

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

getUsernameConfiguration

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

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

See Also:

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

getUserPoolAddOns

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

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

See Also:

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

getUserPoolName

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

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

See Also:

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

getUserPoolTags

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

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

See Also:

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

getVerificationMessageTemplate

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

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

See Also:

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

builder

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

Returns:

a CfnUserPoolProps.Builder of CfnUserPoolProps