software.amazon.awscdk.services.ecr

Interface IRepository

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IRepository.Jsii$Default

All Known Implementing Classes:

IRepository.Jsii$Proxy, Repository, RepositoryBase

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:13.341Z")
public interface IRepository
extends IResource

Represents an ECR repository.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IRepository.Jsii$Default Internal default implementation for IRepository.
static class	IRepository.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Add a policy statement to the repository's resource policy.
java.lang.String	getRepositoryArn() The ARN of the repository.
java.lang.String	getRepositoryName() The name of the repository.
java.lang.String	getRepositoryUri() The URI of this repository (represents the latest image):.
Grant	grant(IGrantable grantee, java.lang.String... actions) Grant the given principal identity permissions to perform the actions on this repository.
Grant	grantPull(IGrantable grantee) Grant the given identity permissions to pull images in this repository.
Grant	grantPullPush(IGrantable grantee) Grant the given identity permissions to pull and push images to this repository.
Rule	onCloudTrailEvent(java.lang.String id) Define a CloudWatch event that triggers when something happens to this repository.
Rule	onCloudTrailEvent(java.lang.String id, OnEventOptions options) Define a CloudWatch event that triggers when something happens to this repository.
Rule	onCloudTrailImagePushed(java.lang.String id) Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.
Rule	onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.
Rule	onEvent(java.lang.String id) Defines a CloudWatch event rule which triggers for repository events.
Rule	onEvent(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for repository events.
Rule	onImageScanCompleted(java.lang.String id) Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.
Rule	onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.
java.lang.String	repositoryUriForDigest() Returns the URI of the repository for a certain digest.
java.lang.String	repositoryUriForDigest(java.lang.String digest) Returns the URI of the repository for a certain digest.
java.lang.String	repositoryUriForTag() Returns the URI of the repository for a certain tag.
java.lang.String	repositoryUriForTag(java.lang.String tag) Returns the URI of the repository for a certain tag.
java.lang.String	repositoryUriForTagOrDigest() Returns the URI of the repository for a certain tag or digest, inferring based on the syntax of the tag.
java.lang.String	repositoryUriForTagOrDigest(java.lang.String tagOrDigest) Returns the URI of the repository for a certain tag or digest, inferring based on the syntax of the tag.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

getRepositoryArn

java.lang.String getRepositoryArn()

The ARN of the repository.

getRepositoryName

java.lang.String getRepositoryName()

The name of the repository.

getRepositoryUri

java.lang.String getRepositoryUri()

The URI of this repository (represents the latest image):.

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

addToResourcePolicy

AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)

Add a policy statement to the repository's resource policy.

Parameters:

statement - This parameter is required.

grant

Grant grant(IGrantable grantee,
            java.lang.String... actions)

Grant the given principal identity permissions to perform the actions on this repository.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPull

Grant grantPull(IGrantable grantee)

Grant the given identity permissions to pull images in this repository.

Parameters:

grantee - This parameter is required.

grantPullPush

Grant grantPullPush(IGrantable grantee)

Grant the given identity permissions to pull and push images to this repository.

Parameters:

grantee - This parameter is required.

onCloudTrailEvent

Rule onCloudTrailEvent(java.lang.String id,
                       OnEventOptions options)

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. This parameter is required.

options - Options for adding the rule.

onCloudTrailEvent

Rule onCloudTrailEvent(java.lang.String id)

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. This parameter is required.

onCloudTrailImagePushed

Rule onCloudTrailImagePushed(java.lang.String id,
                             OnCloudTrailImagePushedOptions options)

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. This parameter is required.

options - Options for adding the rule.

onCloudTrailImagePushed

Rule onCloudTrailImagePushed(java.lang.String id)

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. This parameter is required.

onEvent

Rule onEvent(java.lang.String id,
             OnEventOptions options)

Defines a CloudWatch event rule which triggers for repository events.

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

Parameters:

id - This parameter is required.

options -

onEvent

Rule onEvent(java.lang.String id)

Defines a CloudWatch event rule which triggers for repository events.

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

Parameters:

id - This parameter is required.

onImageScanCompleted

Rule onImageScanCompleted(java.lang.String id,
                          OnImageScanCompletedOptions options)

Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.

Parameters:

id - The id of the rule. This parameter is required.

options - Options for adding the rule.

onImageScanCompleted

Rule onImageScanCompleted(java.lang.String id)

Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.

Parameters:

id - The id of the rule. This parameter is required.

repositoryUriForDigest

java.lang.String repositoryUriForDigest(java.lang.String digest)

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]

Parameters:

digest - Image digest to use (tools usually default to the image with the "latest" tag if omitted).

repositoryUriForDigest

java.lang.String repositoryUriForDigest()

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]

repositoryUriForTag

java.lang.String repositoryUriForTag(java.lang.String tag)

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]

Parameters:

tag - Image tag to use (tools usually default to "latest" if omitted).

repositoryUriForTag

java.lang.String repositoryUriForTag()

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]

repositoryUriForTagOrDigest

java.lang.String repositoryUriForTagOrDigest(java.lang.String tagOrDigest)

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]
 

Parameters:

tagOrDigest - Image tag or digest to use (tools usually default to the image with the "latest" tag if omitted).

repositoryUriForTagOrDigest

java.lang.String repositoryUriForTagOrDigest()

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]