CDK Amazon DataZone Construct Library

CDK Amazon DataZone is an AWS CDK construct library that simplifies the creation and management of Amazon DataZone resources. This library enables developers to automate data governance, data cataloging, and secure data sharing across domains by using familiar infrastructure-as-code practices with AWS CDK.

Features

• Easily create and manage Amazon DataZone components, such as Domains, Projects, and Environments.
• Seamless integration with the AWS CDK ecosystem, allowing users to manage DataZone resources alongside other AWS resources.
• Support for secure resource configurations like KMS encryption, S3 bucket management, and domain-level blueprinting.

Installation

To install this library, use the following npm command:

npm install @cdklabs/cdk-data-zone

Usage Example

Here’s an example of how to use the @cdklabs/cdk-data-zone library in your AWS CDK project:

import { App, RemovalPolicy } from 'aws-cdk-lib';
import { Key } from 'aws-cdk-lib/aws-kms';
import { Bucket, BucketEncryption } from 'aws-cdk-lib/aws-s3';

const app = new App();
const stack = new Stack(app, 'TestStack');

// Create an S3 Bucket for the Blueprint
const bucket = new Bucket(stack, 'BlueprintBucket', {
  enforceSSL: true,
  removalPolicy: RemovalPolicy.DESTROY,
  autoDeleteObjects: true,
  encryption: BucketEncryption.S3_MANAGED,
});

// Create a DataZone Domain
const domain = new Domain(stack, 'Domain', {
  name: 'integration',
  encryptionKey: new Key(stack, 'Key', { enableKeyRotation: true }),
});

// Enable a Blueprint for the Domain
const blueprint = domain.enableBlueprint(BlueprintEnvironmentIdentifiers.DEFAULT_DATA_LAKE, {
  parameters: {
    S3Location: `s3://${bucket.bucketName}`,
  },
});

// Create a Project within the Domain
const project = domain.createProject('test-project', {
  name: 'test-project',
  glossaries: Glossaries.fromFile('./resources/glossaries.json'),
  forms: Forms.fromFile('./resources/form-metadata.json'),
});

// Create an Environment Profile for the Project
const environmentProfile = new EnvironmentProfile(stack, 'EnvironmentProfile', {
  name: 'dev',
  blueprint,
  project,
});

// Create an Environment using the Environment Profile
new Environment(stack, 'environment', {
  project,
  name: 'DEV',
  environmentProfile,
});

app.synth();

Key Features Highlighted

• Domain Creation: Easily create Amazon DataZone Domains with encryption and other security features.
• Project Management: Use Blueprints, Forms, and Glossaries to structure data governance.
• Environment Profiles: Manage different environments within your data projects to ensure proper data governance policies.

Projen for Development

This project leverages Projen for managing development workflows. Projen automates common tasks like dependency management, testing, and versioning.

Getting Started with Development

1. Clone the Repository:

   git clone https://github.com/cdklabs/cdk-data-zone.git
   cd cdk-data-zone

2. Install Dependencies:

   npx projen install

3. Run Projen to synthesize files:

   npx projen

4. Build the Project:

   npx projen build

5. Run Tests:

   npx projen test

API Reference

Detailed documentation of the available constructs, their properties, and methods is available in the API.md file.

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md guide for more details on how to get involved.

Security policy

Please see the SECURITY.md for more information.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for more information.