Skip to main content

Class: ILocation

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

Base Depot Location interface Construct

Extends​

  • Construct

Extended by​

Constructors​

Constructor​

new ILocation(scope, id): ILocation

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

Parameters​

scope​

Construct

id​

string

Returns​

ILocation

Overrides​

Construct.constructor

Properties​

accountId​

readonly accountId: string

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

environmentId​

readonly environmentId: string

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

id​

readonly id: string

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

name​

readonly name: string

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

node​

readonly node: Node

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

The tree node.

Inherited from​

Construct.node

Methods​

toString()​

toString(): string

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

Returns a string representation of this construct.

Returns​

string

Inherited from​

Construct.toString

with()​

with(...mixins): IConstruct

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

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​

Construct.with

fromLocationName()​

static fromLocationName(scope, id, props): ILocation

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

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

fromLocationProps()​

static fromLocationProps(scope, id, props): ILocation

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

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

isConstruct()​

static isConstruct(x): x is Construct

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

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​

Construct.isConstruct