Skip to main content

Interface: MigrationPlannedEvent

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:68

Informative or command event sent over EventBridge as a new version of a dataset is registered.

It is important look at the executionResponsibility field to determine whether action is required from the receiver.

Extends​

  • MigrationEventBase

Properties​

datasetAlias​

readonly datasetAlias: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:13

The dataset name (alias) this event relates to

Inherited from​

MigrationEventBase.datasetAlias

datasetId​

readonly datasetId: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:9

The dataset id this event relates to

Inherited from​

MigrationEventBase.datasetId

datasetVersionHash​

readonly datasetVersionHash: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:80

A hash representing the version of the dataset being migrated to.

environmentId​

readonly environmentId: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:5

The environment id this event relates to

Inherited from​

MigrationEventBase.environmentId

environmentUri​

readonly environmentUri: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:17

The environment uri (version) of the dataset infrastructure deployment.

Inherited from​

MigrationEventBase.environmentUri

executionResponsibility​

readonly executionResponsibility: ResponsibleParty

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:112

Which party is responsible for executing the migration plan. One of

  • [ResponsibleParty.MIGRATIONS\_DISABLED](../enumerations/ResponsibleParty.md#migrations_disabled) - migrations are disabled for this dataset.
  • [ResponsibleParty.EXECUTED\_BY\_SENDER](../enumerations/ResponsibleParty.md#executed_by_sender) - Depot has already executed the migration plan synchronously.
  • [ResponsibleParty.TO\_BE\_EXECUTED\_BY\_RECEIVER](../enumerations/ResponsibleParty.md#to_be_executed_by_receiver) - Depot has not or not yet executed the migration plan synchronously.

migrationId​

readonly migrationId: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:98

The id of the migration plan, typically a UUID.

migrationPlanBucket​

readonly migrationPlanBucket: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:89

The name of the S3 bucket in which the migration plan has been recorded.

migrationPlanKey​

readonly migrationPlanKey: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:94

The key of the S3 object in which the migration plan has been recorded, as a JSON document conforming to MigrationPlan.

oldDatasetVersionHash​

readonly oldDatasetVersionHash: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:84

A hash representing the version of the dataset being migrated from.

oldEnvironmentUri​

readonly oldEnvironmentUri: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:76

The "old" environment uri (version) of the dataset infrastructure deployment.

Note that whilst Depot has traditionally updated the environmentUri on each dataset update, this may no longer be true in the future (May 2025).

summary​

readonly summary: MigrationPlanSummary

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

A high level view of what the migration plan contains. Some migration plans are actually no-operations

type​

readonly type: "planned"

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:69