# Repository

Define an ECR repository.

Extends: Construct › Resource › RepositoryBase › Repository
Implements: IResource, IRepository, IEnvironmentAware, IRepositoryRef, IConstruct, IDependable

- CloudFormation: [`AWS::ECR::Repository`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-ecr-repository.html)
- L1 type: [`CfnRepository`](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.CfnRepository.html)
- Source: [`aws-ecr/lib/repository.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-ecr/lib/repository.ts#L660)
- Type last changed: v2.196.0 · 16 May 2025

## Example

```ts
const repository = new ecr.Repository(this, 'TestRepository');

const runtime = new agentcore.Runtime(this, 'Runtime', {
  agentRuntimeArtifact: agentcore.AgentRuntimeArtifact.fromEcrRepository(repository, 'v1.0.0'),
});

new logs.MetricFilter(this, 'ToolErrors', {
  logGroup: runtime.applicationLogGroup,
  filterPattern: logs.FilterPattern.stringValue('$.tool_status', '=', 'error'),
  metricNamespace: 'MyApp',
  metricName: 'ToolExecutionErrors',
});
```

## Initializer

```ts
new Repository(scope: Construct, id: string, props?: RepositoryProps)
```

## Construct Props

- `autoDeleteImages`: boolean = false — Use `emptyOnDelete` instead.

  Requires the `removalPolicy` to be set to `RemovalPolicy.DESTROY`.

- `emptyOnDelete`: boolean = false — If true, deleting the repository force deletes the contents of the repository.

  If false, the repository must be empty before attempting to delete it.

- `encryption`: [RepositoryEncryption](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.RepositoryEncryption.html) — The kind of server-side encryption to apply to this repository.

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

  If you choose KMS, you can specify a KMS key via `encryptionKey`. If
  encryptionKey is not specified, an AWS managed KMS key is used.

- `encryptionKey`: [IKeyRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_kms.IKeyRef.html) — External KMS key to use for repository encryption.

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

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

- `imageScanOnPush`: boolean = false — Enable the scan on push when creating the repository.

- `imageTagMutability`: [TagMutability](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.TagMutability.html) = TagMutability.MUTABLE — 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.

- `imageTagMutabilityExclusionFilters`: [ImageTagMutabilityExclusionFilter](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.ImageTagMutabilityExclusionFilter.html)[] — The image tag mutability exclusion filters for the repository.

  **Default:** undefined - AWS ECR default is no exclusion filters

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

- `lifecycleRegistryId`: string — The AWS account ID associated with the registry that contains the repository.

  **Default:** The default registry is assumed.

- `lifecycleRules`: [LifecycleRule](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.LifecycleRule.html)[] — Life cycle rules to apply to this registry.

  **Default:** No life cycle rules

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.Retain — Determine what happens to the repository when the resource/stack is deleted.

- `repositoryName`: string — Name for this repository.

  **Default:** Automatically generated name.

  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.

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `registryUri`: string (required) — The URI of this repository's registry:.

  ACCOUNT.dkr.ecr.REGION.amazonaws.com

- `repositoryArn`: string (required) — The ARN of the repository.

- `repositoryName`: string (required) — The name of the repository.

- `repositoryRef`: [RepositoryReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_ecr.RepositoryReference.html) (required) — A reference to this repository.

- `repositoryUri`: string (required) — The URI of this repository (represents the latest image):.

  ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `addLifecycleRule(rule: LifecycleRule): void` — Add a life cycle rule to the repository.

  Life cycle rules automatically expire images from the repository that match
  certain conditions.

- `addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult` — Add a policy statement to the repository's resource policy.

  While other resources policies in AWS either require or accept a resource section,
  Cfn for ECR does not allow us to specify a resource policy.
  It will fail if a resource section is present at all.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `arnForLocalRepository(repositoryName: string, scope: IConstruct, account?: string): string` (static) — Returns an ECR ARN for a repository that resides in the same account/region as the current stack.

- `fromLookup(scope: Construct, id: string, options: RepositoryLookupOptions): IRepository` (static) — Lookup an existing repository.

- `fromRepositoryArn(scope: Construct, id: string, repositoryArn: string): IRepository` (static)

- `fromRepositoryAttributes(scope: Construct, id: string, attrs: RepositoryAttributes): IRepository` (static) — Import a repository.

- `fromRepositoryName(scope: Construct, id: string, repositoryName: string): IRepository` (static)

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Grant the given principal identity permissions to perform the actions on this repository [disable-awslint:no-grants].

- `grantPull(grantee: IGrantable): Grant` — Grant the given identity permissions to use the images in this repository [disable-awslint:no-grants].

- `grantPullPush(grantee: IGrantable): Grant` — Grant the given identity permissions to pull and push images to this repository.

  [disable-awslint:no-grants]

- `grantPush(grantee: IGrantable): Grant` — Grant the given identity permissions to use the images in this repository [disable-awslint:no-grants].

- `grantRead(grantee: IGrantable): Grant` — Grant the given identity permissions to read the images in this repository [disable-awslint:no-grants].

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `onCloudTrailEvent(id: string, options?: OnEventOptions): Rule` — Define a CloudWatch event that triggers when something happens to this repository.

  Requires that there exists at least one CloudTrail Trail in your account
  that captures the event. This method will not create the Trail.

  **Parameters**

  - `id` — The id of the rule.
  - `options` — Options for adding the rule.

- `onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions): Rule` — Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.

  Requires that there exists at least one CloudTrail Trail in your account
  that captures the event. This method will not create the Trail.

  **Parameters**

  - `id` — The id of the rule.
  - `options` — Options for adding the rule.

- `onEvent(id: string, options?: OnEventOptions): Rule` — Defines a CloudWatch event rule which triggers for repository events.

  Use
  `rule.addEventPattern(pattern)` to specify a filter.

- `onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions): Rule` — Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed.

  **Parameters**

  - `id` — The id of the rule.
  - `options` — Options for adding the rule.

- `repositoryUriForDigest(digest?: string): string` — Returns the URL of the repository. Can be used in `docker push/pull`.

  ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]

  **Parameters**

  - `digest` — Optional image digest.

- `repositoryUriForTag(tag?: string): string` — Returns the URL of the repository. Can be used in `docker push/pull`.

  ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]

  **Parameters**

  - `tag` — Optional image tag.

- `repositoryUriForTagOrDigest(tagOrDigest?: string): string` — Returns the URL of the repository. Can be used in `docker push/pull`.

  ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
     ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]

  **Parameters**

  - `tagOrDigest` — Optional image tag or digest (digests must start with `sha256:`).

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.