Skip to main content

Interface: StageDepotEnvironmentProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:514

Environment properties to pass to the Environment construct.

Properties​

account?​

readonly optional account?: StageDepotAccountProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:599

Configuration for AWS account

admin?​

readonly optional admin?: StageDepotAdminProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:524

admin related properties to configure the Environment with.

allowAnonymousUsers?​

readonly optional allowAnonymousUsers?: boolean

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:671

Enables Gateway API to support anonymous users.

allowIntrospection?​

readonly optional allowIntrospection?: boolean

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:666

Enables GQL API introspection.

athena?​

readonly optional athena?: StageDepotAthenaProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:554

Deprecated​

Use the Location.Glue construct.

auroraMajorVersion?​

readonly optional auroraMajorVersion?: AuroraMajorVersion

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:699

Overrides the major PostgreSQL version used by every Aurora (PostgreSQL) Location deployed in this environment.

Lets a major version upgrade be rolled out per environment, independently of the Depot platform version. Changing it on an existing environment changes the engine version of already-deployed Aurora clusters, which is a major version upgrade — roll it out deliberately.

Default​

AuroraMajorVersion.POSTGRES_16

cognito?​

readonly optional cognito?: StageDepotCognitoProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:544

Deprecated​

Use the Location.Cognito construct.

dataPrefix?​

readonly optional dataPrefix?: string

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:619

data prefix to apply to storage related items

deployBastionHost?​

readonly optional deployBastionHost?: boolean

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:661

Should the environment deploy a bastion host to enable tunneling through the Vpc into the Aurora RDS instances?

Default​

true

See​

depot-cli's connect-bastion feature.

deploymentFlags?​

readonly optional deploymentFlags?: string[]

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:653

Deployment feature flags that can be used to e.g. perform two-step platform deployment for migrating CDK resources.

deploymentMode?​

readonly optional deploymentMode?: "STRICT" | "RELAXED"

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:687

Controls how deployments of child resources are handled.

  • STRICT - all child resources are redeployed when environment is updated.
  • RELAXED - datasets are not redeployed together with the environment when the version changes only.

Default​

STRICT

develop?​

readonly optional develop?: StageDepotDevelopProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:648

Internal

Development properties/overrides (DEVELOPMENT ONLY, do not use on production)

dynamodb?​

readonly optional dynamodb?: StageDepotDynamodbProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:534

Deprecated​

Use the Location.DynamoDB construct.

encryption?​

readonly optional encryption?: StageDepotEncryptionProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:589

Customisation options for encryption with KMS

forceIamGwAdminPrincipalsInheritance?​

readonly optional forceIamGwAdminPrincipalsInheritance?: boolean

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:677

If true, always adds IAM GW principals configured in Admin dataset regardless of other settings that might disable such behaviour (e.g. rawSqlEndpointEnabled flag set to true).

frontend?​

readonly optional frontend?: StageDepotFrontendProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:584

Configuration for the Depot Connector API

iamGateway?​

readonly optional iamGateway?: StageDepotIamGatewayProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:564

Deprecated​

Use the new Gateway construct to add Gateway configurations. For example to add IAM gateways, use the Gateway.IAM construct.

idPrefix?​

readonly optional idPrefix?: string

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:614

environment id prefix. Will form part of the environment's unique ID.

interfaceEndpoints?​

readonly optional interfaceEndpoints?: object

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:637

Interface endpoints to enable on the environment. These have an hourly cost associated with them, but provide improved security and performance. Traffic will be routed directly via AWS network backbone, and not over the public internet (i.e. not via the VPC NAT Gateway). There is a data transfer cost associated with these to consider too. Note: DynamoDB and S3 endpoints use the older style VPC gateway endpoints and these are not charged for.

cloudWatchLogs?​

readonly optional cloudWatchLogs?: boolean

secretsManager?​

readonly optional secretsManager?: boolean

sqs?​

readonly optional sqs?: boolean

lambdaDataGateway?​

readonly optional lambdaDataGateway?: StageDepotLambdaDataGatewayProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:574

Deprecated​

Use the new Gateway construct to add Gateway configurations. For example to add a Lambda Data gateway, use the Gateway.Lambda construct.

locator?​

readonly optional locator?: StageDepotLocatorProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:529

Locator lambda properties (DPT-2934). Off unless declared.

logging?​

readonly optional logging?: StageDepotLoggingProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:579

Logging configuration

name​

readonly name: string

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:609

The friendly name for the Depot environment

opsAlarms?​

readonly optional opsAlarms?: StageDepotOpsAlarmsProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:594

Configuration Alarms and Slack alerting for the Depot environment.

permissions?​

readonly optional permissions?: DepotPermissions

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:624

environment level schema access permissions

publicGateway?​

readonly optional publicGateway?: StageDepotPublicGatewayProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:559

Deprecated​

Use the new Gateway construct to add Gateway configurations. For example, to add a public Gateway, use the Gateway.API construct.

schema?​

readonly optional schema?: Record<string, any>

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:519

A basestar compatible schema for the environment to use. A schema of interface { [key:string]: any }.

readonly optional search?: StageDepotSearchProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:539

Deprecated​

Use the Location.ElasticSearch construct.

sfnLocation?​

readonly optional sfnLocation?: StageDepotStepFunctionLocationProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:549

Deprecated​

Use the Location.StepFunction construct.

tags?​

readonly optional tags?: Record<string, string>

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:604

Tags to apply to all Depot resources in AWS

useSharedVpc?​

readonly optional useSharedVpc?: string | boolean

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:630

Whether to use an AWS account-level shared VPC or not. Set to a string value to use a specific VPC in the same account by name.

Remarks​

If this is set to true, the environment will be deployed into the account's shared VPC. Environment resources will use shared subnets in the VPC along with other environment's resources.

Default​

false

websocketGateway?​

readonly optional websocketGateway?: StageDepotGatewayProps

Defined in: packages/depot-cdk/src/stage-depot-environment.ts:569

Deprecated​

Use the new Gateway construct to add Gateway configurations. For example to add WebSocket gateways, use the Gateway.WebSocket construct.