Skip to main content

Interface: AuroraLocationClusterGroupProps

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

Extends​

Properties​

clusterGroupName​

readonly clusterGroupName: string

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

Cluster group is used to group multiple depot-aurora locations to re-use the same Aurora cluster

if clusterGroup is not set: name will be used as clusterGroup and this location will be considered the main location for the cluster config

if clusterGroup is set: all cluster config will be ignored and cluster with provided name will be used

createEntities?​

readonly optional createEntities?: boolean

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

When true, Aurora tables and views will be created automatically if they do not exist. Default is true

Inherited from​

AuroraProps.createEntities

dataLocations?​

readonly optional dataLocations?: string[]

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

S3 locations for which to create stages

Inherited from​

AuroraProps.dataLocations

deploymentGroup?​

readonly optional deploymentGroup?: boolean

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

Inherited from​

LocationProps.deploymentGroup

disableMigrations?​

readonly optional disableMigrations?: boolean

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

When true, migrations will be skipped

Inherited from​

AuroraProps.disableMigrations

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:283

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

Inherited from​

AuroraProps.name

readable?​

readonly optional readable?: boolean

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

When false, location will not be a candidate for query fallback. Default is true

Inherited from​

AuroraProps.readable

strictMigrations?​

readonly optional strictMigrations?: boolean

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

When true, migrations will be strict (i.e. an error will be thrown if the migration fails)

Inherited from​

AuroraProps.strictMigrations

writable?​

readonly optional writable?: boolean

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

When false, location will return exception on write requests through the API. Default is true

Inherited from​

AuroraProps.writable