@aws-cdk/aws-ecr-assets

What is @aws-cdk/aws-ecr-assets?

@aws-cdk/aws-ecr-assets is an AWS CDK library that allows you to build and publish Docker images to Amazon Elastic Container Registry (ECR) as part of your AWS Cloud Development Kit (CDK) applications. This package simplifies the process of managing Docker images within your CDK stacks.

What are @aws-cdk/aws-ecr-assets's main functionalities?

Building Docker Images

This feature allows you to build Docker images from a specified directory and include them in your CDK stack. The Docker image is built and uploaded to an ECR repository automatically.

const ecrAssets = require('@aws-cdk/aws-ecr-assets');
const cdk = require('@aws-cdk/core');

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    new ecrAssets.DockerImageAsset(this, 'MyDockerImage', {
      directory: path.join(__dirname, 'my-docker-image')
    });
  }
}

const app = new cdk.App();
new MyStack(app, 'MyStack');

Using Docker Images in ECS

This feature demonstrates how to use a Docker image built with @aws-cdk/aws-ecr-assets in an Amazon ECS task definition. The Docker image is referenced directly from the ECR repository.

const ecs = require('@aws-cdk/aws-ecs');
const ecrAssets = require('@aws-cdk/aws-ecr-assets');
const cdk = require('@aws-cdk/core');

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    const asset = new ecrAssets.DockerImageAsset(this, 'MyDockerImage', {
      directory: path.join(__dirname, 'my-docker-image')
    });

    new ecs.ContainerImage.fromDockerImageAsset(asset);
  }
}

const app = new cdk.App();
new MyStack(app, 'MyStack');

Other packages similar to @aws-cdk/aws-ecr-assets

dockerode

Dockerode is a Node.js module that provides a Docker Remote API client. It allows you to manage Docker containers, images, and other Docker resources programmatically. Unlike @aws-cdk/aws-ecr-assets, which is tightly integrated with AWS CDK and ECR, Dockerode is a more general-purpose Docker client.

node-docker-api

Node Docker API is another Node.js client for the Docker Remote API. It provides a simple and flexible way to interact with Docker from Node.js applications. While it offers similar functionalities to Dockerode, it is not specifically designed for integration with AWS services like @aws-cdk/aws-ecr-assets.

aws-sdk

The AWS SDK for JavaScript provides a comprehensive set of tools for interacting with AWS services, including ECR. While you can use the AWS SDK to manage ECR repositories and images, it does not provide the same level of abstraction and integration with CDK as @aws-cdk/aws-ecr-assets.

README

AWS CDK Docker Image Assets

---

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

This module allows bundling Docker images as assets.

Images are built from a local Docker context directory (with a Dockerfile), uploaded to ECR by the CDK toolkit and/or your app's CI-CD pipeline, and can be naturally referenced in your CDK app.

import { DockerImageAsset } from '@aws-cdk/aws-ecr-assets';

const asset = new DockerImageAsset(this, 'MyBuildImage', {
  directory: path.join(__dirname, 'my-image')
});

The directory my-image must include a Dockerfile.

This will instruct the toolkit to build a Docker image from my-image, push it to an AWS ECR repository and wire the name of the repository as CloudFormation parameters to your stack.

Use asset.imageUri to reference the image (it includes both the ECR image URL and tag.

You can optionally pass build args to the docker build command by specifying the buildArgs property:

const asset = new DockerImageAsset(this, 'MyBuildImage', {
  directory: path.join(__dirname, 'my-image'),
  buildArgs: {
    HTTP_PROXY: 'http://10.20.30.2:1234'
  }
});

You can optionally pass a target to the docker build command by specifying the target property:

const asset = new DockerImageAsset(this, 'MyBuildImage', {
  directory: path.join(__dirname, 'my-image'),
  target: 'a-target'
})

Pull Permissions

Depending on the consumer of your image asset, you will need to make sure the principal has permissions to pull the image.

In most cases, you should use the asset.repository.grantPull(principal) method. This will modify the IAM policy of the principal to allow it to pull images from this repository.

If the pulling principal is not in the same account or is an AWS service that doesn't assume a role in your account (e.g. AWS CodeBuild), pull permissions must be granted on the resource policy (and not on the principal's policy). To do that, you can use asset.repository.addToResourcePolicy(statement) to grant the desired principal the following permissions: "ecr:GetDownloadUrlForLayer", "ecr:BatchGetImage" and "ecr:BatchCheckLayerAvailability".

Changelog

1.41.0 (2020-05-21)

Features

• cloudtrail: create cloudwatch event without needing to create a Trail (#8076) (0567a23), closes #6716
• cognito: user pool - case sensitivity for sign in (460394f), closes #7988 #7235
• core: CfnJson enables intrinsics in hash keys (#8099) (195cd40), closes #8084
• secretsmanager: adds grantWrite to Secret (#7858) (3fed84b)
• sns: add support for subscription DLQ in SNS (383cdb8)
• stepfunctions: new service integration classes for Lambda, SNS, and SQS (#7946) (c038848), closes #6715 #6489

Bug Fixes

• apigateway: contextAccountId in AccessLogField incorrectly resolves to requestId (7b89e80), closes #7952 #7951
• autoscaling: add noDevice as a volume type (#7253) (751958b), closes #7242