Skip to main content

Class: IExecutor

Defined in: packages/depot-cdk/src/stage-depot-executor.ts:99

Base Depot Executor CDK Construct

Extends​

  • Construct

Extended by​

Constructors​

Constructor​

new IExecutor(scope, id): IExecutor

Defined in: packages/depot-cdk/src/stage-depot-executor.ts:104

Parameters​

scope​

Construct

id​

string

Returns​

IExecutor

Overrides​

Construct.constructor

Properties​

executorType​

executorType: string

Defined in: packages/depot-cdk/src/stage-depot-executor.ts:102

id​

readonly id: string

Defined in: packages/depot-cdk/src/stage-depot-executor.ts:100

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

fromExecutorName()​

static fromExecutorName(scope, id, props): IExecutor

Defined in: packages/depot-cdk/src/stage-depot-executor.ts:142

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

Parameters​

scope​

Construct

CDK Construct scope

id​

string

unique ID for this resource.

props​

IDepotResourceWithNameProps

Existing Executor environment and name IDepotResourceWithNameProps | properties

Returns​

IExecutor

the Executor IExecutor resource

fromExecutorProps()​

static fromExecutorProps(scope, id, props): IExecutor

Defined in: packages/depot-cdk/src/stage-depot-executor.ts:115

Retrieve an existing Executor by id.

Parameters​

scope​

Construct

the CDK Construct to add this resource to.

id​

string

Unique ID for the resource.

props​

IExecutorProps

the existing Executor Properties, specifically the `id'.

Returns​

IExecutor

an IExecutor resource.

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