AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ECR::Repository

CfnRepository

The `AWS::ECR::Repository` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide* .

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnRepositoryProps.

emptyOnDeleteOptional
boolean | IResolvable

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

encryptionConfigurationOptional
IResolvable | EncryptionConfigurationProperty

The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.

imageScanningConfigurationOptional
IResolvable | ImageScanningConfigurationProperty

> The `imageScanningConfiguration` parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see `PutRegistryScanningConfiguration` . The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

imageTagMutabilityOptional
string

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. If `IMMUTABLE` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

imageTagMutabilityExclusionFiltersOptional
IResolvable | IResolvable | ImageTagMutabilityExclusionFilterProperty[]

A list of filters that specify which image tags are excluded from the repository's image tag mutability setting.

lifecyclePolicyOptional
IResolvable | LifecyclePolicyProperty

Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) .

repositoryNameOptional
string

The name to use for the repository. The repository name may be specified on its own (such as `nginx-web-app` ) or it can be prepended with a namespace to group the repository into a category (such as `project-a/nginx-web-app` ). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) . 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.

repositoryPolicyTextOptional
any

The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide* .

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

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

Subscribe to Newsletter