Skip to main content

Class: Composite

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

Creates a Composite Location. This is a Location with multiple other constituent Locations, which use a 'tiered' write / replication order.

Extends​

Constructors​

Constructor​

new Composite(scope, id, props): Composite

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

Create a Composite Location.

Parameters​

scope​

Construct

CDK Construct to add this resource to.

id​

string

unique ID for this resource.

props​

CompositeLocationProps

Properties to configure the Composite Location.

Returns​

Composite

Overrides​

ConcreteLocation.constructor

Properties​

accountId​

readonly accountId: string

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

Inherited from​

ConcreteLocation.accountId

environmentId​

readonly environmentId: string

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

Inherited from​

ConcreteLocation.environmentId

id​

readonly id: string

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

Overrides​

ConcreteLocation.id

name​

readonly name: string

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

Inherited from​

ConcreteLocation.name

node​

readonly node: Node

Defined in: node_modules/constructs/lib/construct.d.ts:325

The tree node.

Inherited from​

ConcreteLocation.node

primaryLocation​

readonly primaryLocation: ILocation

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

replicaLocation​

readonly replicaLocation: ILocation

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

resource​

readonly resource: StageDepotCustomResource

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

Overrides​

ConcreteLocation.resource

Methods​

bindToDeploymentGroup()​

bindToDeploymentGroup(): void

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

Returns​

void

Inherited from​

ConcreteLocation.bindToDeploymentGroup

toString()​

toString(): string

Defined in: node_modules/constructs/lib/construct.d.ts:350

Returns a string representation of this construct.

Returns​

string

Inherited from​

ConcreteLocation.toString

with()​

with(...mixins): IConstruct

Defined in: node_modules/constructs/lib/construct.d.ts:346

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters​

mixins​

...IMixin[]

The mixins to apply

Returns​

IConstruct

This construct for chaining

Inherited from​

ConcreteLocation.with

fromLocationName()​

static fromLocationName(scope, id, props): ILocation

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

Construct a Location resource from an existing Location using a known name / alias.

Parameters​

scope​

Construct

the CDK Construct to add this resource to.

id​

string

Unique ID for the resource.

props​

ILocationFromNameProps

the configuration to identify the existing Location, specifically the `name'.

Returns​

ILocation

the ILocation

Inherited from​

ConcreteLocation.fromLocationName

fromLocationProps()​

static fromLocationProps(scope, id, props): ILocation

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

Retrieve an existing Location by id.

Parameters​

scope​

Construct

the CDK Construct to add this resource to.

id​

string

Unique ID for the resource.

props​

ILocationProps

the existing Location ILocationProps, specifically the `id'.

Returns​

ILocation

the ILocation

Inherited from​

ConcreteLocation.fromLocationProps

isConstruct()​

static isConstruct(x): x is Construct

Defined in: node_modules/constructs/lib/construct.d.ts:321

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters​

x​

any

Any object

Returns​

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from​

ConcreteLocation.isConstruct