Skip to main content

Interface: AuroraLocationClusterProps

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

Extends​

Properties​

backupRetentionPeriod?​

readonly optional backupRetentionPeriod?: number

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

How long are automated backups retained. If not set it defaults to 7 days.

clusterParameters?​

readonly optional clusterParameters?: Record<string, string>

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

Additional cluster parameters to set for the Aurora cluster

createEntities?​

readonly optional createEntities?: boolean

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

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

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

Inherited from​

LocationProps.deploymentGroup

directAccess?​

readonly optional directAccess?: AuroraVpcLinkDirectAccessProps

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

Settings to configure an 'external' project VPC privatelink (VPC endpoint service and connected VPC endpoint) for the Aurora cluster to be accessed directly via privatelink from the 'external' project VPC.

disableMigrations?​

readonly optional disableMigrations?: boolean

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

When true, migrations will be skipped

Inherited from​

AuroraProps.disableMigrations

environment​

readonly environment: IStageDepotEnvironment

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

Inherited from​

LocationProps.environment

fromSnapshotId?​

readonly optional fromSnapshotId?: string

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

When you need to restore the location from a backup, you have to specify the snapshot id to restore from.

See​

DatabaseClusterFromSnapshotProps for details.

logSettings?​

readonly optional logSettings?: AuroraLogSettings

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

Logs configuration to use for the Aurora Postgres cluster instance(s) Providing this configuration will enable logging for the Aurora cluster (logs will appear in the Logs section in the RDS console) with default (or defined) settings. Enabling exportLogs will also export logs to CloudWatch.

name​

readonly name: string

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

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

Inherited from​

AuroraProps.name

performanceInsights?​

readonly optional performanceInsights?: object

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

The Aurora performance insights enables to look and analyze the longest queries

enabled​

enabled: boolean

retention​

retention: PerformanceInsightRetention

readable?​

readonly optional readable?: boolean

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

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

Inherited from​

AuroraProps.readable

readers​

readonly readers: AuroraInstanceProps[]

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

A list of instances to create as cluster reader instances

serverlessCapacity?​

readonly optional serverlessCapacity?: object

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

The Aurora capacity units (ACUs) for a serverless DB instances in an Aurora cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128 (256GB). ACU is shared between all serverless instances

The smallest value that you can use is 0.5. The maximum capacity must be higher than 0.5 ACUs.

max​

max: number

min​

min: number

strictMigrations?​

readonly optional strictMigrations?: boolean

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

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

Inherited from​

AuroraProps.strictMigrations

users?​

readonly optional users?: string[]

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

List of users should have access to the Aurora cluster via bastion connectivity / tunnel. Should be a list of users in e-mail address format. Note: actual permissions available to these users is based on the requested permission when using the depot cb CLI command and the user's IAM Role.

writable?​

readonly optional writable?: boolean

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

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

Inherited from​

AuroraProps.writable

writer​

readonly writer: AuroraInstanceProps

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

The instance to use for the cluster writer if no readers are provided it will be also used as write/read instance