Namespace Amazon.CDK.AWS.Cognito
Classes
- AttributeMapping
The mapping of user pool attributes to the attributes provided by the identity providers.
- AuthFlow
Types of authentication flow.
- AutoVerifiedAttrs
Attributes that can be automatically verified for users in a user pool.
- BaseUrlOptions
Options to customize the behaviour of
baseUrl().
- BooleanAttribute
The Boolean custom attribute type.
- CfnIdentityPool
A CloudFormation
AWS::Cognito::IdentityPool.
- CfnIdentityPool.CognitoIdentityProviderProperty
CognitoIdentityProvideris a property of the AWS::Cognito::IdentityPool resource that represents an Amazon Cognito user pool and its client ID.
- CfnIdentityPool.CognitoStreamsProperty
CognitoStreamsis a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.
- CfnIdentityPool.PushSyncProperty
PushSyncis a property of the AWS::Cognito::IdentityPool resource that defines the configuration options to be applied to an Amazon Cognito identity pool.
- CfnIdentityPoolPrincipalTag
A CloudFormation
AWS::Cognito::IdentityPoolPrincipalTag.
- CfnIdentityPoolPrincipalTagProps
Properties for defining a
CfnIdentityPoolPrincipalTag.
- CfnIdentityPoolProps
Properties for defining a
CfnIdentityPool.
- CfnIdentityPoolRoleAttachment
A CloudFormation
AWS::Cognito::IdentityPoolRoleAttachment.
- CfnIdentityPoolRoleAttachment.MappingRuleProperty
Defines how to map a claim to a role ARN.
- CfnIdentityPoolRoleAttachment.RoleMappingProperty
RoleMappingis a property of the AWS::Cognito::IdentityPoolRoleAttachment resource that defines the role-mapping attributes of an Amazon Cognito identity pool.
- CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty
RulesConfigurationTypeis a subproperty of the RoleMapping property that defines the rules to be used for mapping users to roles.
- CfnIdentityPoolRoleAttachmentProps
Properties for defining a
CfnIdentityPoolRoleAttachment.
- CfnUserPool
A CloudFormation
AWS::Cognito::UserPool.
- CfnUserPool.AccountRecoverySettingProperty
Use this setting to define which verified available method a user can use to recover their password when they call
ForgotPassword.
- CfnUserPool.AdminCreateUserConfigProperty
The configuration for
AdminCreateUserrequests.
- CfnUserPool.CustomEmailSenderProperty
A custom email sender AWS Lambda trigger.
- CfnUserPool.CustomSMSSenderProperty
A custom SMS sender AWS Lambda trigger.
- CfnUserPool.DeviceConfigurationProperty
The device-remembering configuration for a user pool.
- CfnUserPool.EmailConfigurationProperty
The email configuration of your user pool.
- CfnUserPool.InviteMessageTemplateProperty
The message template to be used for the welcome message to new users.
- CfnUserPool.LambdaConfigProperty
Specifies the configuration for AWS Lambda triggers.
- CfnUserPool.NumberAttributeConstraintsProperty
The minimum and maximum values of an attribute that is of the number data type.
- CfnUserPool.PasswordPolicyProperty
The password policy type.
- CfnUserPool.PoliciesProperty
The policy associated with a user pool.
- CfnUserPool.RecoveryOptionProperty
A map containing a priority as a key, and recovery method name as a value.
- CfnUserPool.SchemaAttributeProperty
Contains information about the schema attribute.
- CfnUserPool.SmsConfigurationProperty
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 .
- CfnUserPool.StringAttributeConstraintsProperty
The
StringAttributeConstraintsproperty type defines the string attribute constraints of an Amazon Cognito user pool.
- CfnUserPool.UserAttributeUpdateSettingsProperty
The settings for updates to user attributes.
- CfnUserPool.UserPoolAddOnsProperty
The user pool add-ons type.
- CfnUserPool.UsernameConfigurationProperty
The
UsernameConfigurationproperty type specifies case sensitivity on the username input for the selected sign-in option.
- CfnUserPool.VerificationMessageTemplateProperty
The template for verification messages.
- CfnUserPoolClient
A CloudFormation
AWS::Cognito::UserPoolClient.
- CfnUserPoolClient.AnalyticsConfigurationProperty
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
- CfnUserPoolClient.TokenValidityUnitsProperty
The time units you use when you set the duration of ID, access, and refresh tokens.
- CfnUserPoolClientProps
Properties for defining a
CfnUserPoolClient.
- CfnUserPoolDomain
A CloudFormation
AWS::Cognito::UserPoolDomain.
- CfnUserPoolDomain.CustomDomainConfigTypeProperty
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
- CfnUserPoolDomainProps
Properties for defining a
CfnUserPoolDomain.
- CfnUserPoolGroup
A CloudFormation
AWS::Cognito::UserPoolGroup.
- CfnUserPoolGroupProps
Properties for defining a
CfnUserPoolGroup.
- CfnUserPoolIdentityProvider
A CloudFormation
AWS::Cognito::UserPoolIdentityProvider.
- CfnUserPoolIdentityProviderProps
Properties for defining a
CfnUserPoolIdentityProvider.
- CfnUserPoolProps
Properties for defining a
CfnUserPool.
- CfnUserPoolResourceServer
A CloudFormation
AWS::Cognito::UserPoolResourceServer.
- CfnUserPoolResourceServer.ResourceServerScopeTypeProperty
A resource server scope.
- CfnUserPoolResourceServerProps
Properties for defining a
CfnUserPoolResourceServer.
- CfnUserPoolRiskConfigurationAttachment
A CloudFormation
AWS::Cognito::UserPoolRiskConfigurationAttachment.
- CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionTypeProperty
Account takeover action type.
- CfnUserPoolRiskConfigurationAttachment.AccountTakeoverActionsTypeProperty
Account takeover actions type.
- CfnUserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationTypeProperty
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
- CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsTypeProperty
The compromised credentials actions type.
- CfnUserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationTypeProperty
The compromised credentials risk configuration type.
- CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty
The notify configuration type.
- CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty
The notify email type.
- CfnUserPoolRiskConfigurationAttachment.RiskExceptionConfigurationTypeProperty
The type of the configuration to override the risk decision.
- CfnUserPoolRiskConfigurationAttachmentProps
Properties for defining a
CfnUserPoolRiskConfigurationAttachment.
- CfnUserPoolUICustomizationAttachment
A CloudFormation
AWS::Cognito::UserPoolUICustomizationAttachment.
- CfnUserPoolUICustomizationAttachmentProps
Properties for defining a
CfnUserPoolUICustomizationAttachment.
- CfnUserPoolUser
A CloudFormation
AWS::Cognito::UserPoolUser.
- CfnUserPoolUser.AttributeTypeProperty
Specifies whether the attribute is standard or custom.
- CfnUserPoolUserProps
Properties for defining a
CfnUserPoolUser.
- CfnUserPoolUserToGroupAttachment
A CloudFormation
AWS::Cognito::UserPoolUserToGroupAttachment.
- CfnUserPoolUserToGroupAttachmentProps
Properties for defining a
CfnUserPoolUserToGroupAttachment.
- ClientAttributes
A set of attributes, useful to set Read and Write attributes.
- CognitoDomainOptions
Options while specifying a cognito prefix domain.
- CustomAttributeConfig
Configuration that will be fed into CloudFormation for any custom attribute type.
- CustomAttributeProps
Constraints that can be applied to a custom attribute of any type.
- CustomDomainOptions
Options while specifying custom domain.
- DateTimeAttribute
The DateTime custom attribute type.
- DeviceTracking
Device tracking settings.
- EmailSettings
Email settings for the user pool.
- MfaSecondFactor
The different ways in which a user pool can obtain their MFA token for sign in.
- NumberAttribute
The Number custom attribute type.
- NumberAttributeConstraints
Constraints that can be applied to a custom attribute of number type.
- NumberAttributeProps
Props for NumberAttr.
- OAuthFlows
Types of OAuth grant flows.
- OAuthScope
OAuth scopes that are allowed with this client.
- OAuthSettings
OAuth settings to configure the interaction between the app and this client.
- OidcEndpoints
OpenID Connect endpoints.
- PasswordPolicy
Password policy for User Pools.
- ProviderAttribute
An attribute available from a third party identity provider.
- ResourceServerScope
A scope for ResourceServer.
- ResourceServerScopeProps
Props to initialize ResourceServerScope.
- SignInAliases
The different ways in which users of this pool can sign up or sign in.
- SignInUrlOptions
Options to customize the behaviour of
signInUrl().
- StandardAttribute
Standard attribute that can be marked as required or mutable.
- StandardAttributes
The set of standard attributes that can be marked as required or mutable.
- StandardAttributesMask
This interface contains standard attributes recognized by Cognito from https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html including built-in attributes
email_verifiedandphone_number_verified.
- StringAttribute
The String custom attribute type.
- StringAttributeConstraints
Constraints that can be applied to a custom attribute of string type.
- StringAttributeProps
Props for constructing a StringAttr.
- UserInvitationConfig
User pool configuration when administrators sign users up.
- UserPool
Define a Cognito User Pool.
- UserPoolClient
Define a UserPool App Client.
- UserPoolClientIdentityProvider
Identity providers supported by the UserPoolClient.
- UserPoolClientOptions
Options to create a UserPoolClient.
- UserPoolClientProps
Properties for the UserPoolClient construct.
- UserPoolDomain
Define a user pool domain.
- UserPoolDomainOptions
Options to create a UserPoolDomain.
- UserPoolDomainProps
Props for UserPoolDomain construct.
- UserPoolEmail
Configure how Cognito sends emails.
- UserPoolIdentityProvider
User pool third-party identity providers.
- UserPoolIdentityProviderAmazon
Represents a identity provider that integrates with 'Login with Amazon'.
- UserPoolIdentityProviderAmazonProps
Properties to initialize UserPoolAmazonIdentityProvider.
- UserPoolIdentityProviderApple
Represents a identity provider that integrates with 'Apple'.
- UserPoolIdentityProviderAppleProps
Properties to initialize UserPoolAppleIdentityProvider.
- UserPoolIdentityProviderFacebook
Represents a identity provider that integrates with 'Facebook Login'.
- UserPoolIdentityProviderFacebookProps
Properties to initialize UserPoolFacebookIdentityProvider.
- UserPoolIdentityProviderGoogle
Represents a identity provider that integrates with 'Google'.
- UserPoolIdentityProviderGoogleProps
Properties to initialize UserPoolGoogleIdentityProvider.
- UserPoolIdentityProviderOidc
Represents a identity provider that integrates with OpenID Connect.
- UserPoolIdentityProviderOidcProps
Properties to initialize UserPoolIdentityProviderOidc.
- UserPoolIdentityProviderProps
Properties to create a new instance of UserPoolIdentityProvider.
- UserPoolOperation
User pool operations to which lambda triggers can be attached.
- UserPoolProps
Props for the UserPool construct.
- UserPoolResourceServer
Defines a User Pool OAuth2.0 Resource Server.
- UserPoolResourceServerOptions
Options to create a UserPoolResourceServer.
- UserPoolResourceServerProps
Properties for the UserPoolResourceServer construct.
- UserPoolSESOptions
Configuration for Cognito sending emails via Amazon SES.
- UserPoolTriggers
Triggers for a user pool.
- UserVerificationConfig
User pool configuration for user self sign up.
Interfaces
- CfnIdentityPool.ICognitoIdentityProviderProperty
CognitoIdentityProvideris a property of the AWS::Cognito::IdentityPool resource that represents an Amazon Cognito user pool and its client ID.
- CfnIdentityPool.ICognitoStreamsProperty
CognitoStreamsis a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.
- CfnIdentityPool.IPushSyncProperty
PushSyncis a property of the AWS::Cognito::IdentityPool resource that defines the configuration options to be applied to an Amazon Cognito identity pool.
- CfnIdentityPoolRoleAttachment.IMappingRuleProperty
Defines how to map a claim to a role ARN.
- CfnIdentityPoolRoleAttachment.IRoleMappingProperty
RoleMappingis a property of the AWS::Cognito::IdentityPoolRoleAttachment resource that defines the role-mapping attributes of an Amazon Cognito identity pool.
- CfnIdentityPoolRoleAttachment.IRulesConfigurationTypeProperty
RulesConfigurationTypeis a subproperty of the RoleMapping property that defines the rules to be used for mapping users to roles.
- CfnUserPool.IAccountRecoverySettingProperty
Use this setting to define which verified available method a user can use to recover their password when they call
ForgotPassword.
- CfnUserPool.IAdminCreateUserConfigProperty
The configuration for
AdminCreateUserrequests.
- CfnUserPool.ICustomEmailSenderProperty
A custom email sender AWS Lambda trigger.
- CfnUserPool.ICustomSMSSenderProperty
A custom SMS sender AWS Lambda trigger.
- CfnUserPool.IDeviceConfigurationProperty
The device-remembering configuration for a user pool.
- CfnUserPool.IEmailConfigurationProperty
The email configuration of your user pool.
- CfnUserPool.IInviteMessageTemplateProperty
The message template to be used for the welcome message to new users.
- CfnUserPool.ILambdaConfigProperty
Specifies the configuration for AWS Lambda triggers.
- CfnUserPool.INumberAttributeConstraintsProperty
The minimum and maximum values of an attribute that is of the number data type.
- CfnUserPool.IPasswordPolicyProperty
The password policy type.
- CfnUserPool.IPoliciesProperty
The policy associated with a user pool.
- CfnUserPool.IRecoveryOptionProperty
A map containing a priority as a key, and recovery method name as a value.
- CfnUserPool.ISchemaAttributeProperty
Contains information about the schema attribute.
- CfnUserPool.ISmsConfigurationProperty
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 .
- CfnUserPool.IStringAttributeConstraintsProperty
The
StringAttributeConstraintsproperty type defines the string attribute constraints of an Amazon Cognito user pool.
- CfnUserPool.IUserAttributeUpdateSettingsProperty
The settings for updates to user attributes.
- CfnUserPool.IUserPoolAddOnsProperty
The user pool add-ons type.
- CfnUserPool.IUsernameConfigurationProperty
The
UsernameConfigurationproperty type specifies case sensitivity on the username input for the selected sign-in option.
- CfnUserPool.IVerificationMessageTemplateProperty
The template for verification messages.
- CfnUserPoolClient.IAnalyticsConfigurationProperty
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
- CfnUserPoolClient.ITokenValidityUnitsProperty
The time units you use when you set the duration of ID, access, and refresh tokens.
- CfnUserPoolDomain.ICustomDomainConfigTypeProperty
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
- CfnUserPoolResourceServer.IResourceServerScopeTypeProperty
A resource server scope.
- CfnUserPoolRiskConfigurationAttachment.IAccountTakeoverActionTypeProperty
Account takeover action type.
- CfnUserPoolRiskConfigurationAttachment.IAccountTakeoverActionsTypeProperty
Account takeover actions type.
- CfnUserPoolRiskConfigurationAttachment.IAccountTakeoverRiskConfigurationTypeProperty
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
- CfnUserPoolRiskConfigurationAttachment.ICompromisedCredentialsActionsTypeProperty
The compromised credentials actions type.
- CfnUserPoolRiskConfigurationAttachment.ICompromisedCredentialsRiskConfigurationTypeProperty
The compromised credentials risk configuration type.
- CfnUserPoolRiskConfigurationAttachment.INotifyConfigurationTypeProperty
The notify configuration type.
- CfnUserPoolRiskConfigurationAttachment.INotifyEmailTypeProperty
The notify email type.
- CfnUserPoolRiskConfigurationAttachment.IRiskExceptionConfigurationTypeProperty
The type of the configuration to override the risk decision.
- CfnUserPoolUser.IAttributeTypeProperty
Specifies whether the attribute is standard or custom.
- IAttributeMapping
The mapping of user pool attributes to the attributes provided by the identity providers.
- IAuthFlow
Types of authentication flow.
- IAutoVerifiedAttrs
Attributes that can be automatically verified for users in a user pool.
- IBaseUrlOptions
Options to customize the behaviour of
baseUrl().
- ICfnIdentityPoolPrincipalTagProps
Properties for defining a
CfnIdentityPoolPrincipalTag.
- ICfnIdentityPoolProps
Properties for defining a
CfnIdentityPool.
- ICfnIdentityPoolRoleAttachmentProps
Properties for defining a
CfnIdentityPoolRoleAttachment.
- ICfnUserPoolClientProps
Properties for defining a
CfnUserPoolClient.
- ICfnUserPoolDomainProps
Properties for defining a
CfnUserPoolDomain.
- ICfnUserPoolGroupProps
Properties for defining a
CfnUserPoolGroup.
- ICfnUserPoolIdentityProviderProps
Properties for defining a
CfnUserPoolIdentityProvider.
- ICfnUserPoolProps
Properties for defining a
CfnUserPool.
- ICfnUserPoolResourceServerProps
Properties for defining a
CfnUserPoolResourceServer.
- ICfnUserPoolRiskConfigurationAttachmentProps
Properties for defining a
CfnUserPoolRiskConfigurationAttachment.
- ICfnUserPoolUICustomizationAttachmentProps
Properties for defining a
CfnUserPoolUICustomizationAttachment.
- ICfnUserPoolUserProps
Properties for defining a
CfnUserPoolUser.
- ICfnUserPoolUserToGroupAttachmentProps
Properties for defining a
CfnUserPoolUserToGroupAttachment.
- ICognitoDomainOptions
Options while specifying a cognito prefix domain.
- ICustomAttribute
Represents a custom attribute type.
- ICustomAttributeConfig
Configuration that will be fed into CloudFormation for any custom attribute type.
- ICustomAttributeProps
Constraints that can be applied to a custom attribute of any type.
- ICustomDomainOptions
Options while specifying custom domain.
- IDeviceTracking
Device tracking settings.
- IEmailSettings
Email settings for the user pool.
- IMfaSecondFactor
The different ways in which a user pool can obtain their MFA token for sign in.
- INumberAttributeConstraints
Constraints that can be applied to a custom attribute of number type.
- INumberAttributeProps
Props for NumberAttr.
- IOAuthFlows
Types of OAuth grant flows.
- IOAuthSettings
OAuth settings to configure the interaction between the app and this client.
- IOidcEndpoints
OpenID Connect endpoints.
- IPasswordPolicy
Password policy for User Pools.
- IResourceServerScopeProps
Props to initialize ResourceServerScope.
- ISignInAliases
The different ways in which users of this pool can sign up or sign in.
- ISignInUrlOptions
Options to customize the behaviour of
signInUrl().
- IStandardAttribute
Standard attribute that can be marked as required or mutable.
- IStandardAttributes
The set of standard attributes that can be marked as required or mutable.
- IStandardAttributesMask
This interface contains standard attributes recognized by Cognito from https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html including built-in attributes
email_verifiedandphone_number_verified.
- IStringAttributeConstraints
Constraints that can be applied to a custom attribute of string type.
- IStringAttributeProps
Props for constructing a StringAttr.
- IUserInvitationConfig
User pool configuration when administrators sign users up.
- IUserPool
Represents a Cognito UserPool.
- IUserPoolClient
Represents a Cognito user pool client.
- IUserPoolClientOptions
Options to create a UserPoolClient.
- IUserPoolClientProps
Properties for the UserPoolClient construct.
- IUserPoolDomain
Represents a user pool domain.
- IUserPoolDomainOptions
Options to create a UserPoolDomain.
- IUserPoolDomainProps
Props for UserPoolDomain construct.
- IUserPoolIdentityProvider
Represents a UserPoolIdentityProvider.
- IUserPoolIdentityProviderAmazonProps
Properties to initialize UserPoolAmazonIdentityProvider.
- IUserPoolIdentityProviderAppleProps
Properties to initialize UserPoolAppleIdentityProvider.
- IUserPoolIdentityProviderFacebookProps
Properties to initialize UserPoolFacebookIdentityProvider.
- IUserPoolIdentityProviderGoogleProps
Properties to initialize UserPoolGoogleIdentityProvider.
- IUserPoolIdentityProviderOidcProps
Properties to initialize UserPoolIdentityProviderOidc.
- IUserPoolIdentityProviderProps
Properties to create a new instance of UserPoolIdentityProvider.
- IUserPoolProps
Props for the UserPool construct.
- IUserPoolResourceServer
Represents a Cognito user pool resource server.
- IUserPoolResourceServerOptions
Options to create a UserPoolResourceServer.
- IUserPoolResourceServerProps
Properties for the UserPoolResourceServer construct.
- IUserPoolSESOptions
Configuration for Cognito sending emails via Amazon SES.
- IUserPoolTriggers
Triggers for a user pool.
- IUserVerificationConfig
User pool configuration for user self sign up.
Enums
- AccountRecovery
How will a user be able to recover their account?
- Mfa
The different ways in which a user pool's MFA enforcement can be configured.
- OidcAttributeRequestMethod
The method to use to request attributes.
- VerificationEmailStyle
The email verification style.