AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

Repository

Define an ECR repository.

Import

import { Repository } from 'aws-cdk-lib/aws-ecr';

Or use the module namespace:

import * as ecr from 'aws-cdk-lib/aws-ecr';
// ecr.Repository

Properties

Configuration passed to the constructor as RepositoryProps.

autoDeleteImagesOptionalDeprecated
boolean

Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted. Requires the `removalPolicy` to be set to `RemovalPolicy.DESTROY`.

Default: false

Deprecated: Use `emptyOnDelete` instead.

emptyOnDeleteOptional
boolean

If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.

Default: false

encryptionOptional
RepositoryEncryption

The kind of server-side encryption to apply to this repository. If you choose KMS, you can specify a KMS key via `encryptionKey`. If encryptionKey is not specified, an AWS managed KMS key is used.

Default: - `KMS` if `encryptionKey` is specified, or `AES256` otherwise.

encryptionKeyOptional
IKeyRef

External KMS key to use for repository encryption. The 'encryption' property must be either not specified or set to "KMS". An error will be emitted if encryption is set to "AES256".

Default: - If encryption is set to `KMS` and this property is undefined, an AWS managed KMS key is used.

imageScanOnPushOptional
boolean

Enable the scan on push when creating the repository.

Default: false

imageTagMutabilityOptional
TagMutability

The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten.

Default: TagMutability.MUTABLE

imageTagMutabilityExclusionFiltersOptional
ImageTagMutabilityExclusionFilter[]

The image tag mutability exclusion filters for the repository. These filters specify which image tags can override the repository's default image tag mutability setting.

Default: undefined - AWS ECR default is no exclusion filters

lifecycleRegistryIdOptional
string

The AWS account ID associated with the registry that contains the repository.

Default: The default registry is assumed.

lifecycleRulesOptional
LifecycleRule[]

Life cycle rules to apply to this registry.

Default: No life cycle rules

removalPolicyOptional
RemovalPolicy

Determine what happens to the repository when the resource/stack is deleted.

Default: RemovalPolicy.Retain

repositoryNameOptional
string

Name for this repository. The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Default: Automatically generated name.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-ecr
Properties11

Related Constructs

Explore This Service

External Links