Skip to main content

Class: IStageDepotDataset

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:301

A Depot Dataset CDK construct with getters for related Dataset resources

Extends​

  • Construct

Extended by​

Constructors​

Constructor​

new IStageDepotDataset(scope, id): IStageDepotDataset

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

Creates a new construct node.

Parameters​

scope​

Construct

The scope in which to define this construct

id​

string

The scoped construct ID. Must be unique amongst siblings. If the ID includes a path separator (/) or a newline, then it will be replaced by double dash --.

Returns​

IStageDepotDataset

Inherited from​

Construct.constructor

Properties​

accountId​

readonly accountId: string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:302

environmentId​

readonly environmentId: string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:304

id​

readonly id: string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:306

name?​

readonly optional name?: string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:308

node​

readonly node: Node

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

The tree node.

Inherited from​

Construct.node

Accessors​

endpoints​

Get Signature​

get endpoints(): DatasetEndpoints

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:325

Returns​

DatasetEndpoints

seedingStepFunctionArn​

Get Signature​

get seedingStepFunctionArn(): string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:316

Returns​

string

transactionOutputPattern​

Get Signature​

get transactionOutputPattern(): string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:310

Returns​

string

Methods​

onUpdate()​

onUpdate(scope, id, ruleTargets): Rule

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:345

Parameters​

scope​

Construct

CDK Construct scope

id​

string

rule id

ruleTargets​

IRuleTarget[]

rule targets that will be invoked

Returns​

Rule

aws rule cdk node.

Example​

// Create on update rule:
 import * as targets from '@aws-cdk/aws-events-targets';
 ...
 const resourceUpdateHandler = new targets.LambdaFunction(new lambda.Function(....));
 dataset.onUpdate(this, '-e2e-invoker', [resourceUpdateHandler]);

toString()​

toString(): string

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

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

Construct.with

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​

Construct.isConstruct