Skip to main content

Interface: CognitoLocationProps

Defined in: packages/depot-cdk/src/stage-depot-location.ts:457

Cognito user pool Location configuration

Extends​

  • LocationProps

Properties​

clientId?​

readonly optional clientId?: string

Defined in: packages/depot-cdk/src/stage-depot-location.ts:468

Id of a client that is configured to authenticate against the provided user pool

deploymentGroup?​

readonly optional deploymentGroup?: boolean

Defined in: packages/depot-cdk/src/stage-depot-location.ts:67

Inherited from​

LocationProps.deploymentGroup

environment​

readonly environment: IStageDepotEnvironment

Defined in: packages/depot-cdk/src/stage-depot-location.ts:65

Inherited from​

LocationProps.environment

name​

readonly name: string

Defined in: packages/depot-cdk/src/stage-depot-location.ts:459

A name or alias for this location. No duplicates are allowed

region?​

readonly optional region?: string

Defined in: packages/depot-cdk/src/stage-depot-location.ts:465

Region of the user pool

roleArn​

readonly roleArn: string

Defined in: packages/depot-cdk/src/stage-depot-location.ts:471

Optional role arn with permission to administer users, if provided then CRUD operations will be supported, otherwise this pool is used only for authentication

userPoolId?​

readonly optional userPoolId?: string

Defined in: packages/depot-cdk/src/stage-depot-location.ts:462

Id of the user pool