software.amazon.awscdk.services.ecr

Interface IRepository

All Superinterfaces:

software.constructs.IConstruct, IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IRepository.Jsii$Default

All Known Implementing Classes:

IRepository.Jsii$Proxy, Repository, RepositoryBase

@Generated(value="jsii-pacmak/1.24.0 (build b722f66)",
           date="2021-03-11T13:46:26.365Z")
 @Stability(value=Stable)
public interface IRepository
extends software.amazon.jsii.JsiiSerializable, 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.
String	getRepositoryArn() The ARN of the repository.
String	getRepositoryName() The name of the repository.
String	getRepositoryUri() The URI of this repository (represents the latest image):.
Grant	grant(IGrantable grantee, 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(String id) Define a CloudWatch event that triggers when something happens to this repository.
Rule	onCloudTrailEvent(String id, OnEventOptions options) Define a CloudWatch event that triggers when something happens to this repository.
Rule	onCloudTrailImagePushed(String id) Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.
Rule	onCloudTrailImagePushed(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(String id) Defines a CloudWatch event rule which triggers for repository events.
Rule	onEvent(String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for repository events.
Rule	onImageScanCompleted(String id) Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.
Rule	onImageScanCompleted(String id, OnImageScanCompletedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.
String	repositoryUriForDigest() Returns the URI of the repository for a certain tag.
String	repositoryUriForDigest(String digest) Returns the URI of the repository for a certain tag.
String	repositoryUriForTag() Returns the URI of the repository for a certain tag.
String	repositoryUriForTag(String tag) Returns the URI of the repository for a certain tag.

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

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRepositoryArn

@Stability(value=Stable)
 @NotNull
String getRepositoryArn()

The ARN of the repository.

getRepositoryName

@Stability(value=Stable)
 @NotNull
String getRepositoryName()

The name of the repository.

getRepositoryUri

@Stability(value=Stable)
 @NotNull
String getRepositoryUri()

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

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

addToResourcePolicy

@Stability(value=Stable)
 @NotNull
AddToResourcePolicyResult addToResourcePolicy(@NotNull
                                                                                 PolicyStatement statement)

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

Parameters:

statement - This parameter is required.

grant

@Stability(value=Stable)
 @NotNull
Grant grant(@NotNull
                                               IGrantable grantee,
                                               @NotNull
                                               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

@Stability(value=Stable)
 @NotNull
Grant grantPull(@NotNull
                                                   IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

grantPullPush

@Stability(value=Stable)
 @NotNull
Grant grantPullPush(@NotNull
                                                       IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

onCloudTrailEvent

@Stability(value=Stable)
 @NotNull
Rule onCloudTrailEvent(@NotNull
                                                          String id,
                                                          @Nullable
                                                          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

@Stability(value=Stable)
 @NotNull
Rule onCloudTrailEvent(@NotNull
                                                          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

@Stability(value=Stable)
 @NotNull
Rule onCloudTrailImagePushed(@NotNull
                                                                String id,
                                                                @Nullable
                                                                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

@Stability(value=Stable)
 @NotNull
Rule onCloudTrailImagePushed(@NotNull
                                                                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

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id,
                                                @Nullable
                                                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

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                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

@Stability(value=Stable)
 @NotNull
Rule onImageScanCompleted(@NotNull
                                                             String id,
                                                             @Nullable
                                                             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

@Stability(value=Stable)
 @NotNull
Rule onImageScanCompleted(@NotNull
                                                             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

@Stability(value=Stable)
 @NotNull
String repositoryUriForDigest(@Nullable
                                                                 String digest)

Returns the URI of the repository for a certain tag. 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

@Stability(value=Stable)
 @NotNull
String repositoryUriForDigest()

Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.

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

repositoryUriForTag

@Stability(value=Stable)
 @NotNull
String repositoryUriForTag(@Nullable
                                                              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

@Stability(value=Stable)
 @NotNull
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]