Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
@aws-cdk/aws-ecr-assets
Advanced tools
@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.
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');
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 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.
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.
This is a developer preview (public beta) module.
All classes with the
Cfn
prefix in this module (CFN Resources) are auto-generated from CloudFormation. They are stable and safe to use.However, all other classes, i.e., higher level constructs, are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. 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'
})
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".
1.32.0 (2020-04-07)
UserPoolClient
construct no longer has the property
userPoolClientClientSecret
. The functionality to retrieve the client
secret never existed in CloudFormation, so this property was not
working in the first place.userPoolClientName
property on the UserPoolClient
construct will throw an error if client name was not configured on the
UserPoolClient
during initialization. This property was previously
incorrectly configured and was returning a not-implemented message from
CloudFormation every time.sourceCodeProvider
prop to connect your app to a source
code provider. The props repository
, accessToken
and oauthToken
do not exist
anymore in AppProps
.retentionPeriodHours
is now retentionPeriod
and of type Duration
Cluster
now creates a default managed nodegroup as its default capacity. Set the new cluster property defaultCapacityType
to DefaultCapacityType.EC2
to preserve EC2
as its default capacity.add*Trigger()
methods to configure
lambda triggers has now been replaced by a single
addTrigger()
method.addTrigger()
method will fail if a trigger
was already configured for that user pool operation.{[key: string]: any}
instead of plain any
. You were always supposed to pass a map/dictionary in these locations, but the type system didn't enforce it. It now does.aws:SecureTransport
for staging bucket (#7192) (ed106ea)Size
unit representing digital information quantity (#6940) (22a560d)acm-certificatemanager: DnsValidatedCertificateHandler support for SubjectAlternativeNames
(#7050) (a711c01), closes #4659
aws-kinesis: test assume order between stacks (#7065) (17aab37)
cli: can't use credential providers for stacks with assets (#7022) (afd7045), closes #7005
cloudtrail: include s3KeyPrefix in bucket policy resource (#7053) (b49881f), closes #6741
cognito: user pool - passwordPolicy.minLength
is not optional in all cases (#6971) (49cdd8f)
dynamodb: cannot use attribute as key in a GSI, non-key in another (#7075) (a6bd34f), closes #4398
ecs: default Service throws in a VPC without private subnets (#7188) (0ef6a95), closes #7062
events: Batch target does not work (#7191) (6f00783), closes #7137
kinesis: retention period does not use Duration type (#7037) (1186227), closes #7036
rewrite-imports: incorrect main in package.json (#7021) (2bf85b3)
stepfunctions-tasks: batch job - can not use task input as array size (#7008) (923d2a1), closes #6922
stepfunctions-tasks: confusion between multiple ways to run a Lambda (#6796) (7485448), closes #4801
FAQs
Docker image assets deployed to ECR
The npm package @aws-cdk/aws-ecr-assets receives a total of 94,512 weekly downloads. As such, @aws-cdk/aws-ecr-assets popularity was classified as popular.
We found that @aws-cdk/aws-ecr-assets demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.