This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-cognito

The CDK Construct Library for AWS Cognito

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Cognito" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Cognito --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Cognito" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:cognito:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="cognito" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>cognito</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:cognito:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='cognito', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-cognito@0.25.3

package.json:

{
  "@aws-cdk/aws-cognito": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-cognito@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-cognito@0.25.3

package.json:

{
  "@aws-cdk/aws-cognito": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-cognito@0.25.3

AuthFlow (enum)

class @aws-cdk/aws-cognito.AuthFlow

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.AuthFlow;
const { AuthFlow } = require('@aws-cdk/aws-cognito');
import { AuthFlow } from '@aws-cdk/aws-cognito';

Types of authentication flow

AdminNoSrp

Enable flow for server-side or admin authentication (no client app)

CustomFlowOnly

Enable custom authentication flow

UserPassword

Enable auth using username & password

CfnIdentityPool

class @aws-cdk/aws-cognito.CfnIdentityPool(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPool;
const { CfnIdentityPool } = require('@aws-cdk/aws-cognito');
import { CfnIdentityPool } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
identityPoolId
Type:string (readonly)
identityPoolName
Type:string (readonly)
propertyOverrides
Type:CfnIdentityPoolProps (readonly)
class CognitoIdentityProviderProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPool.CognitoIdentityProviderProperty;
// CfnIdentityPool.CognitoIdentityProviderProperty is an interface
import { CfnIdentityPool.CognitoIdentityProviderProperty } from '@aws-cdk/aws-cognito';
clientId

CfnIdentityPool.CognitoIdentityProviderProperty.ClientId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-clientid

Type:string (optional)
providerName

CfnIdentityPool.CognitoIdentityProviderProperty.ProviderName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-providername

Type:string (optional)
serverSideTokenCheck

CfnIdentityPool.CognitoIdentityProviderProperty.ServerSideTokenCheck

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-serversidetokencheck

Type:boolean or @aws-cdk/cdk.Token (optional)
class CognitoStreamsProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPool.CognitoStreamsProperty;
// CfnIdentityPool.CognitoStreamsProperty is an interface
import { CfnIdentityPool.CognitoStreamsProperty } from '@aws-cdk/aws-cognito';
roleArn

CfnIdentityPool.CognitoStreamsProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-rolearn

Type:string (optional)
streamingStatus

CfnIdentityPool.CognitoStreamsProperty.StreamingStatus

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamingstatus

Type:string (optional)
streamName

CfnIdentityPool.CognitoStreamsProperty.StreamName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname

Type:string (optional)
class PushSyncProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPool.PushSyncProperty;
// CfnIdentityPool.PushSyncProperty is an interface
import { CfnIdentityPool.PushSyncProperty } from '@aws-cdk/aws-cognito';
applicationArns

CfnIdentityPool.PushSyncProperty.ApplicationArns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-applicationarns

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
roleArn

CfnIdentityPool.PushSyncProperty.RoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-rolearn

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnIdentityPoolProps (interface)

class @aws-cdk/aws-cognito.CfnIdentityPoolProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPoolProps;
// CfnIdentityPoolProps is an interface
import { CfnIdentityPoolProps } from '@aws-cdk/aws-cognito';
allowUnauthenticatedIdentities

AWS::Cognito::IdentityPool.AllowUnauthenticatedIdentities

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

Type:boolean or @aws-cdk/cdk.Token
cognitoEvents

AWS::Cognito::IdentityPool.CognitoEvents

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

Type:json or @aws-cdk/cdk.Token (optional)
cognitoIdentityProviders

AWS::Cognito::IdentityPool.CognitoIdentityProviders

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

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or CognitoIdentityProviderProperty)[] (optional)
cognitoStreams

AWS::Cognito::IdentityPool.CognitoStreams

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

Type:@aws-cdk/cdk.Token or CognitoStreamsProperty (optional)
developerProviderName

AWS::Cognito::IdentityPool.DeveloperProviderName

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

Type:string (optional)
identityPoolName

AWS::Cognito::IdentityPool.IdentityPoolName

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

Type:string (optional)
openIdConnectProviderArns

AWS::Cognito::IdentityPool.OpenIdConnectProviderARNs

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
pushSync

AWS::Cognito::IdentityPool.PushSync

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

Type:@aws-cdk/cdk.Token or PushSyncProperty (optional)
samlProviderArns

AWS::Cognito::IdentityPool.SamlProviderARNs

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
supportedLoginProviders

AWS::Cognito::IdentityPool.SupportedLoginProviders

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

Type:json or @aws-cdk/cdk.Token (optional)

CfnIdentityPoolRoleAttachment

class @aws-cdk/aws-cognito.CfnIdentityPoolRoleAttachment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment;
const { CfnIdentityPoolRoleAttachment } = require('@aws-cdk/aws-cognito');
import { CfnIdentityPoolRoleAttachment } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
identityPoolRoleAttachmentId
Type:string (readonly)
propertyOverrides
Type:CfnIdentityPoolRoleAttachmentProps (readonly)
class MappingRuleProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty;
// CfnIdentityPoolRoleAttachment.MappingRuleProperty is an interface
import { CfnIdentityPoolRoleAttachment.MappingRuleProperty } from '@aws-cdk/aws-cognito';
claim

CfnIdentityPoolRoleAttachment.MappingRuleProperty.Claim

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim

Type:string
matchType

CfnIdentityPoolRoleAttachment.MappingRuleProperty.MatchType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype

Type:string
roleArn

CfnIdentityPoolRoleAttachment.MappingRuleProperty.RoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn

Type:string
value

CfnIdentityPoolRoleAttachment.MappingRuleProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value

Type:string
class RoleMappingProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment.RoleMappingProperty;
// CfnIdentityPoolRoleAttachment.RoleMappingProperty is an interface
import { CfnIdentityPoolRoleAttachment.RoleMappingProperty } from '@aws-cdk/aws-cognito';
type

CfnIdentityPoolRoleAttachment.RoleMappingProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-type

Type:string
ambiguousRoleResolution

CfnIdentityPoolRoleAttachment.RoleMappingProperty.AmbiguousRoleResolution

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-ambiguousroleresolution

Type:string (optional)
rulesConfiguration

CfnIdentityPoolRoleAttachment.RoleMappingProperty.RulesConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-rulesconfiguration

Type:@aws-cdk/cdk.Token or RulesConfigurationTypeProperty (optional)
class RulesConfigurationTypeProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty;
// CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty is an interface
import { CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty } from '@aws-cdk/aws-cognito';
rules

CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty.Rules

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html#cfn-cognito-identitypoolroleattachment-rulesconfigurationtype-rules

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or MappingRuleProperty)[]
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnIdentityPoolRoleAttachmentProps (interface)

class @aws-cdk/aws-cognito.CfnIdentityPoolRoleAttachmentProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachmentProps;
// CfnIdentityPoolRoleAttachmentProps is an interface
import { CfnIdentityPoolRoleAttachmentProps } from '@aws-cdk/aws-cognito';
identityPoolId

AWS::Cognito::IdentityPoolRoleAttachment.IdentityPoolId

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

Type:string
roleMappings

AWS::Cognito::IdentityPoolRoleAttachment.RoleMappings

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

Type:@aws-cdk/cdk.Token or string => (@aws-cdk/cdk.Token or RoleMappingProperty) (optional)
roles

AWS::Cognito::IdentityPoolRoleAttachment.Roles

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

Type:json or @aws-cdk/cdk.Token (optional)

CfnUserPool

class @aws-cdk/aws-cognito.CfnUserPool(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool;
const { CfnUserPool } = require('@aws-cdk/aws-cognito');
import { CfnUserPool } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnUserPoolProps (readonly)
userPoolArn
Type:string (readonly)
userPoolId
Type:string (readonly)
userPoolProviderName
Type:string (readonly)
userPoolProviderUrl
Type:string (readonly)
class AdminCreateUserConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.AdminCreateUserConfigProperty;
// CfnUserPool.AdminCreateUserConfigProperty is an interface
import { CfnUserPool.AdminCreateUserConfigProperty } from '@aws-cdk/aws-cognito';
allowAdminCreateUserOnly

CfnUserPool.AdminCreateUserConfigProperty.AllowAdminCreateUserOnly

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

Type:boolean or @aws-cdk/cdk.Token (optional)
inviteMessageTemplate

CfnUserPool.AdminCreateUserConfigProperty.InviteMessageTemplate

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

Type:@aws-cdk/cdk.Token or InviteMessageTemplateProperty (optional)
unusedAccountValidityDays

CfnUserPool.AdminCreateUserConfigProperty.UnusedAccountValidityDays

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

Type:number or @aws-cdk/cdk.Token (optional)
class DeviceConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.DeviceConfigurationProperty;
// CfnUserPool.DeviceConfigurationProperty is an interface
import { CfnUserPool.DeviceConfigurationProperty } from '@aws-cdk/aws-cognito';
challengeRequiredOnNewDevice

CfnUserPool.DeviceConfigurationProperty.ChallengeRequiredOnNewDevice

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

Type:boolean or @aws-cdk/cdk.Token (optional)
deviceOnlyRememberedOnUserPrompt

CfnUserPool.DeviceConfigurationProperty.DeviceOnlyRememberedOnUserPrompt

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

Type:boolean or @aws-cdk/cdk.Token (optional)
class EmailConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.EmailConfigurationProperty;
// CfnUserPool.EmailConfigurationProperty is an interface
import { CfnUserPool.EmailConfigurationProperty } from '@aws-cdk/aws-cognito';
replyToEmailAddress

CfnUserPool.EmailConfigurationProperty.ReplyToEmailAddress

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

Type:string (optional)
sourceArn

CfnUserPool.EmailConfigurationProperty.SourceArn

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

Type:string (optional)
class InviteMessageTemplateProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.InviteMessageTemplateProperty;
// CfnUserPool.InviteMessageTemplateProperty is an interface
import { CfnUserPool.InviteMessageTemplateProperty } from '@aws-cdk/aws-cognito';
emailMessage

CfnUserPool.InviteMessageTemplateProperty.EmailMessage

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailmessage

Type:string (optional)
emailSubject

CfnUserPool.InviteMessageTemplateProperty.EmailSubject

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailsubject

Type:string (optional)
smsMessage

CfnUserPool.InviteMessageTemplateProperty.SMSMessage

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-smsmessage

Type:string (optional)
class LambdaConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.LambdaConfigProperty;
// CfnUserPool.LambdaConfigProperty is an interface
import { CfnUserPool.LambdaConfigProperty } from '@aws-cdk/aws-cognito';
createAuthChallenge

CfnUserPool.LambdaConfigProperty.CreateAuthChallenge

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

Type:string (optional)
customMessage

CfnUserPool.LambdaConfigProperty.CustomMessage

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

Type:string (optional)
defineAuthChallenge

CfnUserPool.LambdaConfigProperty.DefineAuthChallenge

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

Type:string (optional)
postAuthentication

CfnUserPool.LambdaConfigProperty.PostAuthentication

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

Type:string (optional)
postConfirmation

CfnUserPool.LambdaConfigProperty.PostConfirmation

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

Type:string (optional)
preAuthentication

CfnUserPool.LambdaConfigProperty.PreAuthentication

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

Type:string (optional)
preSignUp

CfnUserPool.LambdaConfigProperty.PreSignUp

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

Type:string (optional)
verifyAuthChallengeResponse

CfnUserPool.LambdaConfigProperty.VerifyAuthChallengeResponse

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

Type:string (optional)
class NumberAttributeConstraintsProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.NumberAttributeConstraintsProperty;
// CfnUserPool.NumberAttributeConstraintsProperty is an interface
import { CfnUserPool.NumberAttributeConstraintsProperty } from '@aws-cdk/aws-cognito';
maxValue

CfnUserPool.NumberAttributeConstraintsProperty.MaxValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-maxvalue

Type:string (optional)
minValue

CfnUserPool.NumberAttributeConstraintsProperty.MinValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-minvalue

Type:string (optional)
class PasswordPolicyProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.PasswordPolicyProperty;
// CfnUserPool.PasswordPolicyProperty is an interface
import { CfnUserPool.PasswordPolicyProperty } from '@aws-cdk/aws-cognito';
minimumLength

CfnUserPool.PasswordPolicyProperty.MinimumLength

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-minimumlength

Type:number or @aws-cdk/cdk.Token (optional)
requireLowercase

CfnUserPool.PasswordPolicyProperty.RequireLowercase

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase

Type:boolean or @aws-cdk/cdk.Token (optional)
requireNumbers

CfnUserPool.PasswordPolicyProperty.RequireNumbers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers

Type:boolean or @aws-cdk/cdk.Token (optional)
requireSymbols

CfnUserPool.PasswordPolicyProperty.RequireSymbols

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols

Type:boolean or @aws-cdk/cdk.Token (optional)
requireUppercase

CfnUserPool.PasswordPolicyProperty.RequireUppercase

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase

Type:boolean or @aws-cdk/cdk.Token (optional)
class PoliciesProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.PoliciesProperty;
// CfnUserPool.PoliciesProperty is an interface
import { CfnUserPool.PoliciesProperty } from '@aws-cdk/aws-cognito';
passwordPolicy

CfnUserPool.PoliciesProperty.PasswordPolicy

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

Type:@aws-cdk/cdk.Token or PasswordPolicyProperty (optional)
class SchemaAttributeProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.SchemaAttributeProperty;
// CfnUserPool.SchemaAttributeProperty is an interface
import { CfnUserPool.SchemaAttributeProperty } from '@aws-cdk/aws-cognito';
attributeDataType

CfnUserPool.SchemaAttributeProperty.AttributeDataType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype

Type:string (optional)
developerOnlyAttribute

CfnUserPool.SchemaAttributeProperty.DeveloperOnlyAttribute

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute

Type:boolean or @aws-cdk/cdk.Token (optional)
mutable

CfnUserPool.SchemaAttributeProperty.Mutable

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable

Type:boolean or @aws-cdk/cdk.Token (optional)
name

CfnUserPool.SchemaAttributeProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name

Type:string (optional)
numberAttributeConstraints

CfnUserPool.SchemaAttributeProperty.NumberAttributeConstraints

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints

Type:@aws-cdk/cdk.Token or NumberAttributeConstraintsProperty (optional)
required

CfnUserPool.SchemaAttributeProperty.Required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required

Type:boolean or @aws-cdk/cdk.Token (optional)
stringAttributeConstraints

CfnUserPool.SchemaAttributeProperty.StringAttributeConstraints

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints

Type:@aws-cdk/cdk.Token or StringAttributeConstraintsProperty (optional)
class SmsConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.SmsConfigurationProperty;
// CfnUserPool.SmsConfigurationProperty is an interface
import { CfnUserPool.SmsConfigurationProperty } from '@aws-cdk/aws-cognito';
externalId

CfnUserPool.SmsConfigurationProperty.ExternalId

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

Type:string (optional)
snsCallerArn

CfnUserPool.SmsConfigurationProperty.SnsCallerArn

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

Type:string (optional)
class StringAttributeConstraintsProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPool.StringAttributeConstraintsProperty;
// CfnUserPool.StringAttributeConstraintsProperty is an interface
import { CfnUserPool.StringAttributeConstraintsProperty } from '@aws-cdk/aws-cognito';
maxLength

CfnUserPool.StringAttributeConstraintsProperty.MaxLength

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-maxlength

Type:string (optional)
minLength

CfnUserPool.StringAttributeConstraintsProperty.MinLength

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnUserPoolClient

class @aws-cdk/aws-cognito.CfnUserPoolClient(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolClient;
const { CfnUserPoolClient } = require('@aws-cdk/aws-cognito');
import { CfnUserPoolClient } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnUserPoolClientProps (readonly)
userPoolClientClientSecret
Type:string (readonly)
userPoolClientId
Type:string (readonly)
userPoolClientName
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnUserPoolClientProps (interface)

class @aws-cdk/aws-cognito.CfnUserPoolClientProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolClientProps;
// CfnUserPoolClientProps is an interface
import { CfnUserPoolClientProps } from '@aws-cdk/aws-cognito';
userPoolId

AWS::Cognito::UserPoolClient.UserPoolId

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

Type:string
clientName

AWS::Cognito::UserPoolClient.ClientName

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

Type:string (optional)
explicitAuthFlows

AWS::Cognito::UserPoolClient.ExplicitAuthFlows

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
generateSecret

AWS::Cognito::UserPoolClient.GenerateSecret

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

Type:boolean or @aws-cdk/cdk.Token (optional)
readAttributes

AWS::Cognito::UserPoolClient.ReadAttributes

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
refreshTokenValidity

AWS::Cognito::UserPoolClient.RefreshTokenValidity

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

Type:number or @aws-cdk/cdk.Token (optional)
writeAttributes

AWS::Cognito::UserPoolClient.WriteAttributes

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)

CfnUserPoolGroup

class @aws-cdk/aws-cognito.CfnUserPoolGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolGroup;
const { CfnUserPoolGroup } = require('@aws-cdk/aws-cognito');
import { CfnUserPoolGroup } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnUserPoolGroupProps (readonly)
userPoolGroupName
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnUserPoolGroupProps (interface)

class @aws-cdk/aws-cognito.CfnUserPoolGroupProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolGroupProps;
// CfnUserPoolGroupProps is an interface
import { CfnUserPoolGroupProps } from '@aws-cdk/aws-cognito';
userPoolId

AWS::Cognito::UserPoolGroup.UserPoolId

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

Type:string
description

AWS::Cognito::UserPoolGroup.Description

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

Type:string (optional)
groupName

AWS::Cognito::UserPoolGroup.GroupName

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

Type:string (optional)
precedence

AWS::Cognito::UserPoolGroup.Precedence

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

Type:number or @aws-cdk/cdk.Token (optional)
roleArn

AWS::Cognito::UserPoolGroup.RoleArn

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

Type:string (optional)

CfnUserPoolProps (interface)

class @aws-cdk/aws-cognito.CfnUserPoolProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolProps;
// CfnUserPoolProps is an interface
import { CfnUserPoolProps } from '@aws-cdk/aws-cognito';
adminCreateUserConfig

AWS::Cognito::UserPool.AdminCreateUserConfig

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

Type:@aws-cdk/cdk.Token or AdminCreateUserConfigProperty (optional)
aliasAttributes

AWS::Cognito::UserPool.AliasAttributes

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
autoVerifiedAttributes

AWS::Cognito::UserPool.AutoVerifiedAttributes

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
deviceConfiguration

AWS::Cognito::UserPool.DeviceConfiguration

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

Type:@aws-cdk/cdk.Token or DeviceConfigurationProperty (optional)
emailConfiguration

AWS::Cognito::UserPool.EmailConfiguration

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

Type:@aws-cdk/cdk.Token or EmailConfigurationProperty (optional)
emailVerificationMessage

AWS::Cognito::UserPool.EmailVerificationMessage

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

Type:string (optional)
emailVerificationSubject

AWS::Cognito::UserPool.EmailVerificationSubject

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

Type:string (optional)
lambdaConfig

AWS::Cognito::UserPool.LambdaConfig

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

Type:@aws-cdk/cdk.Token or LambdaConfigProperty (optional)
mfaConfiguration

AWS::Cognito::UserPool.MfaConfiguration

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

Type:string (optional)
policies

AWS::Cognito::UserPool.Policies

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

Type:@aws-cdk/cdk.Token or PoliciesProperty (optional)
schema

AWS::Cognito::UserPool.Schema

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

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SchemaAttributeProperty)[] (optional)
smsAuthenticationMessage

AWS::Cognito::UserPool.SmsAuthenticationMessage

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

Type:string (optional)
smsConfiguration

AWS::Cognito::UserPool.SmsConfiguration

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

Type:@aws-cdk/cdk.Token or SmsConfigurationProperty (optional)
smsVerificationMessage

AWS::Cognito::UserPool.SmsVerificationMessage

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

Type:string (optional)
usernameAttributes

AWS::Cognito::UserPool.UsernameAttributes

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
userPoolName

AWS::Cognito::UserPool.UserPoolName

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

Type:string (optional)
userPoolTags

AWS::Cognito::UserPool.UserPoolTags

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

Type:json or @aws-cdk/cdk.Token (optional)

CfnUserPoolUser

class @aws-cdk/aws-cognito.CfnUserPoolUser(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolUser;
const { CfnUserPoolUser } = require('@aws-cdk/aws-cognito');
import { CfnUserPoolUser } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnUserPoolUserProps (readonly)
userPoolUserName
Type:string (readonly)
class AttributeTypeProperty

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolUser.AttributeTypeProperty;
// CfnUserPoolUser.AttributeTypeProperty is an interface
import { CfnUserPoolUser.AttributeTypeProperty } from '@aws-cdk/aws-cognito';
name

CfnUserPoolUser.AttributeTypeProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-name

Type:string (optional)
value

CfnUserPoolUser.AttributeTypeProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-value

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnUserPoolUserProps (interface)

class @aws-cdk/aws-cognito.CfnUserPoolUserProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolUserProps;
// CfnUserPoolUserProps is an interface
import { CfnUserPoolUserProps } from '@aws-cdk/aws-cognito';
userPoolId

AWS::Cognito::UserPoolUser.UserPoolId

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

Type:string
desiredDeliveryMediums

AWS::Cognito::UserPoolUser.DesiredDeliveryMediums

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

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
forceAliasCreation

AWS::Cognito::UserPoolUser.ForceAliasCreation

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

Type:boolean or @aws-cdk/cdk.Token (optional)
messageAction

AWS::Cognito::UserPoolUser.MessageAction

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

Type:string (optional)
userAttributes

AWS::Cognito::UserPoolUser.UserAttributes

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

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or AttributeTypeProperty)[] (optional)
username

AWS::Cognito::UserPoolUser.Username

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

Type:string (optional)
validationData

AWS::Cognito::UserPoolUser.ValidationData

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

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or AttributeTypeProperty)[] (optional)

CfnUserPoolUserToGroupAttachment

class @aws-cdk/aws-cognito.CfnUserPoolUserToGroupAttachment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolUserToGroupAttachment;
const { CfnUserPoolUserToGroupAttachment } = require('@aws-cdk/aws-cognito');
import { CfnUserPoolUserToGroupAttachment } from '@aws-cdk/aws-cognito';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnUserPoolUserToGroupAttachmentProps (readonly)
userPoolUserToGroupAttachmentId
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnUserPoolUserToGroupAttachmentProps (interface)

class @aws-cdk/aws-cognito.CfnUserPoolUserToGroupAttachmentProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.CfnUserPoolUserToGroupAttachmentProps;
// CfnUserPoolUserToGroupAttachmentProps is an interface
import { CfnUserPoolUserToGroupAttachmentProps } from '@aws-cdk/aws-cognito';
groupName

AWS::Cognito::UserPoolUserToGroupAttachment.GroupName

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

Type:string
username

AWS::Cognito::UserPoolUserToGroupAttachment.Username

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

Type:string
userPoolId

AWS::Cognito::UserPoolUserToGroupAttachment.UserPoolId

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

Type:string

IUserPool (interface)

class @aws-cdk/aws-cognito.IUserPool

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.IUserPool;
// IUserPool is an interface
import { IUserPool } from '@aws-cdk/aws-cognito';
Extends:@aws-cdk/cdk.IConstruct
userPoolArn

The ARN of this user pool resource

Type:string (readonly)
userPoolId

The physical ID of this user pool resource

Type:string (readonly)
userPoolProviderName

The provider name of this user pool resource

Type:string (readonly)
userPoolProviderUrl

The provider URL of this user pool resource

Type:string (readonly)
export() → @aws-cdk/aws-cognito.UserPoolImportProps

Exports a User Pool from this stack

Returns:user pool props that can be imported into another stack
Return type:UserPoolImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

SignInType (enum)

class @aws-cdk/aws-cognito.SignInType

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.SignInType;
const { SignInType } = require('@aws-cdk/aws-cognito');
import { SignInType } from '@aws-cdk/aws-cognito';

Methods of user sign-in

Username

End-user will sign in with a username, with optional aliases

Email

End-user will sign in using an email address

Phone

End-user will sign in using a phone number

EmailOrPhone

End-user will sign in using either an email address or phone number

UserPool

class @aws-cdk/aws-cognito.UserPool(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPool;
const { UserPool } = require('@aws-cdk/aws-cognito');
import { UserPool } from '@aws-cdk/aws-cognito';

Define a Cognito User Pool

Extends:

@aws-cdk/cdk.Construct

Implements:

IUserPool

Parameters:
static import(scope, id, props) → @aws-cdk/aws-cognito.IUserPool

Import an existing user pool resource

Parameters:
Return type:

IUserPool

export() → @aws-cdk/aws-cognito.UserPoolImportProps

Implements @aws-cdk/aws-cognito.IUserPool.export()

Exports a User Pool from this stack

Return type:UserPoolImportProps
onCreateAuthChallenge(fn)

Attach ‘Create Auth Challenge’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onCustomMessage(fn)

Attach ‘Custom Message’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onDefineAuthChallenge(fn)

Attach ‘Define Auth Challenge’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onPostAuthentication(fn)

Attach ‘Post Authentication’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onPostConfirmation(fn)

Attach ‘Post Confirmation’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onPreAuthentication(fn)

Attach ‘Pre Authentication’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onPreSignUp(fn)

Attach ‘Pre Sign Up’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
onVerifyAuthChallengeResponse(fn)

Attach ‘Verify Auth Challenge Response’ trigger

Grants access from cognito-idp.amazonaws.com to the lambda

Parameters:fn (@aws-cdk/aws-lambda.IFunction) – the lambda function to attach
userPoolArn

Implements @aws-cdk/aws-cognito.IUserPool.userPoolArn()

The ARN of the user pool

Type:string (readonly)
userPoolId

Implements @aws-cdk/aws-cognito.IUserPool.userPoolId()

The physical ID of this user pool resource

Type:string (readonly)
userPoolProviderName

Implements @aws-cdk/aws-cognito.IUserPool.userPoolProviderName()

User pool provider name

Type:string (readonly)
userPoolProviderUrl

Implements @aws-cdk/aws-cognito.IUserPool.userPoolProviderUrl()

User pool provider URL

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

UserPoolAttribute (enum)

class @aws-cdk/aws-cognito.UserPoolAttribute

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPoolAttribute;
const { UserPoolAttribute } = require('@aws-cdk/aws-cognito');
import { UserPoolAttribute } from '@aws-cdk/aws-cognito';

Standard attributes

Specified following the OpenID Connect spec

Address

End-User’s preferred postal address.

Birthdate

End-User’s birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.

The year MAY be 0000, indicating that it is omitted.

To represent only the year, YYYY format is allowed.

Email

End-User’s preferred e-mail address.

Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax.

FamilyName

Surname(s) or last name(s) of the End-User.

Note that in some cultures, people can have multiple family names or no family name;

all can be present, with the names being separated by space characters.

Gender

End-User’s gender.

GivenName

Given name(s) or first name(s) of the End-User.

Note that in some cultures, people can have multiple given names;

all can be present, with the names being separated by space characters.

Locale

End-User’s locale, represented as a BCP47 [RFC5646] language tag.

This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase

and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash.

For example, en-US or fr-CA.

MiddleName

Middle name(s) of the End-User.

Note that in some cultures, people can have multiple middle names;

all can be present, with the names being separated by space characters.

Also note that in some cultures, middle names are not used.

Name

End-User’s full name in displayable form including all name parts,

possibly including titles and suffixes, ordered according to the End-User’s locale and preferences.

Nickname

Casual name of the End-User that may or may not be the same as the given_name.

For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.

PhoneNumber

End-User’s preferred telephone number.

E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400.

If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the

RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.

Picture

URL of the End-User’s profile picture.

This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file),

rather than to a Web page containing an image.

Note that this URL SHOULD specifically reference a profile photo of the End-User

suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User

PreferredUsername

Shorthand name by which the End-User wishes to be referred to.

Profile

URL of the End-User’s profile page. The contents of this Web page SHOULD be about the End-User.

Timezone

The End-User’s time zone

UpdatedAt

Time the End-User’s information was last updated.

Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z

as measured in UTC until the date/time.

Website

URL of the End-User’s Web page or blog.

This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.

UserPoolClient

class @aws-cdk/aws-cognito.UserPoolClient(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPoolClient;
const { UserPoolClient } = require('@aws-cdk/aws-cognito');
import { UserPoolClient } from '@aws-cdk/aws-cognito';

Define a UserPool App Client

Extends:

@aws-cdk/cdk.Construct

Parameters:
clientId
Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

UserPoolClientProps (interface)

class @aws-cdk/aws-cognito.UserPoolClientProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPoolClientProps;
// UserPoolClientProps is an interface
import { UserPoolClientProps } from '@aws-cdk/aws-cognito';
userPool

The UserPool resource this client will have access to

Type:IUserPool
clientName

Name of the application client

Type:string (optional)
Default:cloudformation generated name
enabledAuthFlows

List of enabled authentication flows

Type:AuthFlow[] (optional)
Default:no enabled flows
generateSecret

Whether to generate a client secret

Type:boolean (optional)
Default:false

UserPoolImportProps (interface)

class @aws-cdk/aws-cognito.UserPoolImportProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPoolImportProps;
// UserPoolImportProps is an interface
import { UserPoolImportProps } from '@aws-cdk/aws-cognito';
userPoolArn

The ARN of the imported user pool

Type:string
userPoolId

The ID of an existing user pool

Type:string
userPoolProviderName

The provider name of the imported user pool

Type:string
userPoolProviderUrl

The URL of the imported user pool

Type:string

UserPoolProps (interface)

class @aws-cdk/aws-cognito.UserPoolProps

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPoolProps;
// UserPoolProps is an interface
import { UserPoolProps } from '@aws-cdk/aws-cognito';
autoVerifiedAttributes

Attributes which Cognito will automatically send a verification message to.

Must be either EMAIL, PHONE, or both.

Type:UserPoolAttribute[] (optional)
Default:no auto verification
lambdaTriggers

Lambda functions to use for supported Cognito triggers.

Type:UserPoolTriggers (optional)
poolName

Name of the user pool

Type:string (optional)
Default:unique ID
signInType

Method used for user registration & sign in.

Allows either username with aliases OR sign in with email, phone, or both.

Type:SignInType (optional)
Default:SignInType.USERNAME
usernameAliasAttributes

Attributes to allow as username alias.

Only valid if signInType is USERNAME

Type:UserPoolAttribute[] (optional)
Default:no alias

UserPoolTriggers (interface)

class @aws-cdk/aws-cognito.UserPoolTriggers

Language-specific names:

using Amazon.CDK.AWS.Cognito;
import software.amazon.awscdk.services.cognito.UserPoolTriggers;
// UserPoolTriggers is an interface
import { UserPoolTriggers } from '@aws-cdk/aws-cognito';
createAuthChallenge

Creates an authentication challenge.

Type:@aws-cdk/aws-lambda.IFunction (optional)
customMessage

A custom Message AWS Lambda trigger.

Type:@aws-cdk/aws-lambda.IFunction (optional)
defineAuthChallenge

Defines the authentication challenge.

Type:@aws-cdk/aws-lambda.IFunction (optional)
postAuthentication

A post-authentication AWS Lambda trigger.

Type:@aws-cdk/aws-lambda.IFunction (optional)
postConfirmation

A post-confirmation AWS Lambda trigger.

Type:@aws-cdk/aws-lambda.IFunction (optional)
preAuthentication

A pre-authentication AWS Lambda trigger.

Type:@aws-cdk/aws-lambda.IFunction (optional)
preSignUp

A pre-registration AWS Lambda trigger.

Type:@aws-cdk/aws-lambda.IFunction (optional)
verifyAuthChallengeResponse

Verifies the authentication challenge response.

Type:@aws-cdk/aws-lambda.IFunction (optional)