AWS CDK Reference

Appearance

v2.274.0

IRepository Interface ​

Represents an ECR repository.

Source
aws-ecr/lib/repository.ts
Type last changed
v2.234.0 · 8 Jan 2026

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
registryUristringregistry_uristrregistryUriStringRegistryUristringRegistryUri*stringrequired#
The URI of this repository's registry:.

ACCOUNT.dkr.ecr.REGION.amazonaws.com

repositoryArnstringrepository_arnstrrepositoryArnStringRepositoryArnstringRepositoryArn*stringrequired#
The ARN of the repository.
repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*stringrequired#
The name of the repository.
repositoryRefRepositoryReferencerepository_refRepositoryReferencerepositoryRefRepositoryReferenceRepositoryRefRepositoryReferenceRepositoryRefRepositoryReferencerequired#
A reference to a Repository resource.
repositoryUristringrepository_uristrrepositoryUriStringRepositoryUristringRepositoryUri*stringrequired#
The URI of this repository (represents the latest image):.

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

stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#
Add a policy statement to the repository's resource policy.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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).

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#
Grant the given principal identity permissions to perform the actions on this repository.
grantPull(grantee: IGrantable): Grantdef grant_pull(self, grantee: IGrantable) -> Grantpublic Grant grantPull(IGrantable grantee)public Grant GrantPull(IGrantable grantee)func GrantPull(Grantee IGrantable) Grant#
Grant the given identity permissions to pull images in this repository.
grantPullPush(grantee: IGrantable): Grantdef grant_pull_push(self, grantee: IGrantable) -> Grantpublic Grant grantPullPush(IGrantable grantee)public Grant GrantPullPush(IGrantable grantee)func GrantPullPush(Grantee IGrantable) Grant#
Grant the given identity permissions to pull and push images to this repository.
grantPush(grantee: IGrantable): Grantdef grant_push(self, grantee: IGrantable) -> Grantpublic Grant grantPush(IGrantable grantee)public Grant GrantPush(IGrantable grantee)func GrantPush(Grantee IGrantable) Grant#
Grant the given identity permissions to push images in this repository.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#
Grant the given identity permissions to read images in this repository.
onCloudTrailEvent(id: string, options?: OnEventOptions): Ruledef on_cloud_trail_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onCloudTrailEvent(String id, OnEventOptions options)public Rule OnCloudTrailEvent(string id, OnEventOptions? options = null)func 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.

2 parameters

Parameters

  • ididididId — The id of the rule.
  • optionsoptionsoptionsoptionsOptions — Options for adding the rule.
onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions): Ruledef on_cloud_trail_image_pushed(self, id: str, options: typing.Optional[OnCloudTrailImagePushedOptions] = None) -> Rulepublic Rule onCloudTrailImagePushed(String id, OnCloudTrailImagePushedOptions options)public Rule OnCloudTrailImagePushed(string id, OnCloudTrailImagePushedOptions? options = null)func 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.

2 parameters

Parameters

  • ididididId — The id of the rule.
  • optionsoptionsoptionsoptionsOptions — Options for adding the rule.
onEvent(id: string, options?: OnEventOptions): Ruledef on_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onEvent(String id, OnEventOptions options)public Rule OnEvent(string id, OnEventOptions? options = null)func 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): Ruledef on_image_scan_completed(self, id: str, options: typing.Optional[OnImageScanCompletedOptions] = None) -> Rulepublic Rule onImageScanCompleted(String id, OnImageScanCompletedOptions options)public Rule OnImageScanCompleted(string id, OnImageScanCompletedOptions? options = null)func OnImageScanCompleted(Id *string, Options OnImageScanCompletedOptions) Rule#
Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.
2 parameters

Parameters

  • ididididId — The id of the rule.
  • optionsoptionsoptionsoptionsOptions — Options for adding the rule.
repositoryUriForDigest(digest?: string): stringdef repository_uri_for_digest(self, digest: typing.Optional[str] = None) -> strpublic String repositoryUriForDigest(String digest)public string RepositoryUriForDigest(string? digest = null)func RepositoryUriForDigest(Digest *string) *string#
Returns the URI of the repository for a certain digest. Can be used in `docker push/pull`.

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

1 parameter

Parameters

  • digestdigestdigestdigestDigest — Image digest to use (tools usually default to the image with the "latest" tag if omitted).
repositoryUriForTag(tag?: string): stringdef repository_uri_for_tag(self, tag: typing.Optional[str] = None) -> strpublic String repositoryUriForTag(String tag)public string RepositoryUriForTag(string? tag = null)func RepositoryUriForTag(Tag *string) *string#
Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.

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

1 parameter

Parameters

  • tagtagtagtagTag — Image tag to use (tools usually default to "latest" if omitted).
repositoryUriForTagOrDigest(tagOrDigest?: string): stringdef repository_uri_for_tag_or_digest(self, tag_or_digest: typing.Optional[str] = None) -> strpublic String repositoryUriForTagOrDigest(String tagOrDigest)public string RepositoryUriForTagOrDigest(string? tagOrDigest = null)func RepositoryUriForTagOrDigest(TagOrDigest *string) *string#
Returns the URI of the repository for a certain tag or digest, inferring based on the syntax of the tag.

Can be used in docker push/pull.

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

1 parameter

Parameters

  • tagOrDigesttag_or_digesttagOrDigesttagOrDigestTagOrDigest — Image tag or digest to use (tools usually default to the image with the "latest" tag if omitted).
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func 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.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining