Skip to main content

Class: Dataset

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

A Depot CDK Construct for creating a Depot Dataset.

Extends​

Implements​

  • ITaggableV2

Constructors​

Constructor​

new Dataset(scope, id, props): Dataset

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

Parameters​

scope​

Construct

CDK Construct

id​

string

Unique ID for the instance

props​

StageDepotDatasetProps

Dataset properties

Returns​

Dataset

the Depot Dataset CDK node.

Example​

// Create a simple Dataset:
const sourcePackageImport = require('@some-org/package-source');
const sourcePackage = new Package(this, "ExamplePackage", {
  name: "source",
  version: "v1",
  schemas: sourcePackageImport.schemas,
  imports: sourcePackageImport.imports
});

const sourceDataset = new Dataset(this, "Dataset1", {
  environment: environment,
  package: sourcePackage,
  name: "source",
  location: exampleLocation
});

Overrides​

IStageDepotDataset.constructor

Properties​

accountId​

readonly accountId: string

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

AWS Account ID

Overrides​

IStageDepotDataset.accountId

cdkTagManager​

readonly cdkTagManager: TagManager

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

TagManager to set, remove and format tags

Implementation of​

ITaggableV2.cdkTagManager

dependencies​

readonly dependencies: DatasetDependency[]

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

The list of Dataset dependencies

environment​

readonly environment: IStageDepotEnvironment

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

The Depot Environment

environmentId​

readonly environmentId: string

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

Depot Environment ID

Overrides​

IStageDepotDataset.environmentId

id​

readonly id: string

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

Unique Dataset ID

Overrides​

IStageDepotDataset.id

location​

readonly location: ILocation

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

The Dataset Location

name?​

readonly optional name?: string

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

Unique Dataset name

Overrides​

IStageDepotDataset.name

node​

readonly node: Node

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

The tree node.

Inherited from​

IStageDepotDataset.node

resource​

readonly resource: StageDepotCustomResource

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

Reference to the Depot CloudFormation resource

Accessors​

endpoints​

Get Signature​

get endpoints(): DatasetEndpoints

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

Returns​

DatasetEndpoints

Inherited from​

IStageDepotDataset.endpoints

seedingStepFunctionArn​

Get Signature​

get seedingStepFunctionArn(): string

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

Returns​

string

Inherited from​

IStageDepotDataset.seedingStepFunctionArn

transactionOutputPattern​

Get Signature​

get transactionOutputPattern(): string

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

Returns​

string

Inherited from​

IStageDepotDataset.transactionOutputPattern

Methods​

bindToDeploymentGroup()​

bindToDeploymentGroup(): void

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

Returns​

void

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]);

Inherited from​

IStageDepotDataset.onUpdate

s3Asset()​

s3Asset(scope, id, data): string | undefined

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

Parameters​

scope​

Construct

id​

string

data​

unknown

Returns​

string | undefined

toString()​

toString(): string

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

Returns a string representation of this construct.

Returns​

string

Inherited from​

IStageDepotDataset.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​

IStageDepotDataset.with

fromDatasetName()​

static fromDatasetName(scope, id, props): IStageDepotDataset

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

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

Parameters​

scope​

Construct

CDK Construct scope to add this resource to.

id​

string

unique ID for this resource.

props​

IStageDepotDatasetFromNameProps

Existing Dataset environment and name IStageDepotDatasetFromNameProps | properties

Returns​

IStageDepotDataset

the Dataset resource

fromDatasetProps()​

static fromDatasetProps(scope, id, props): IStageDepotDataset

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

Construct a Dataset resource from an existing Dataset using a known id.

Parameters​

scope​

Construct

CDK Construct scope to add this resource to.

id​

string

unique ID for this resource.

props​

IStageDepotDatasetProps

Existing Dataset properties

Returns​

IStageDepotDataset

the Dataset resource

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​

IStageDepotDataset.isConstruct