software.amazon.awscdk.services.ecr

Interface IRepository.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IRepository, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IRepository.Jsii$Proxy

Enclosing interface:

IRepository

@Internal
public static interface IRepository.Jsii$Default
extends IRepository, IResource.Jsii$Default

Internal default implementation for IRepository.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecr.IRepository

IRepository.Jsii$Default, IRepository.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Add a policy statement to the repository's resource policy.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default ConstructNode	getNode() The construct tree node for this construct.
default String	getRepositoryArn() The ARN of the repository.
default String	getRepositoryName() The name of the repository.
default String	getRepositoryUri() The URI of this repository (represents the latest image):.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions) Grant the given principal identity permissions to perform the actions on this repository.
default Grant	grantPull(IGrantable grantee) Grant the given identity permissions to pull images in this repository.
default Grant	grantPullPush(IGrantable grantee) Grant the given identity permissions to pull and push images to this repository.
default Rule	onCloudTrailEvent(String id, OnEventOptions options) Define a CloudWatch event that triggers when something happens to this repository.
default 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.
default Rule	onEvent(String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for repository events.
default Rule	onImageScanCompleted(String id, OnImageScanCompletedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.
default String	repositoryUriForDigest(String digest) Returns the URI of the repository for a certain tag.
default String	repositoryUriForTag(String tag) Returns the URI of the repository for a certain tag.

Methods inherited from interface software.amazon.awscdk.services.ecr.IRepository

onCloudTrailEvent, onCloudTrailImagePushed, onEvent, onImageScanCompleted, repositoryUriForDigest, repositoryUriForTag

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getRepositoryArn

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

The ARN of the repository.

Specified by:

getRepositoryArn in interface IRepository

getRepositoryName

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

The name of the repository.

Specified by:

getRepositoryName in interface IRepository

getRepositoryUri

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

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

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

Specified by:

getRepositoryUri in interface IRepository

addToResourcePolicy

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

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

Specified by:

addToResourcePolicy in interface IRepository

Parameters:

statement - This parameter is required.

grant

@Stability(value=Stable)
 @NotNull
default Grant grant(@NotNull
                                                       IGrantable grantee,
                                                       @NotNull
                                                       String... actions)

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

Specified by:

grant in interface IRepository

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPull

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

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

Specified by:

grantPull in interface IRepository

Parameters:

grantee - This parameter is required.

grantPullPush

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

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

Specified by:

grantPullPush in interface IRepository

Parameters:

grantee - This parameter is required.

onCloudTrailEvent

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

Specified by:

onCloudTrailEvent in interface IRepository

Parameters:

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

options - Options for adding the rule.

onCloudTrailImagePushed

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

Specified by:

onCloudTrailImagePushed in interface IRepository

Parameters:

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

options - Options for adding the rule.

onEvent

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

Specified by:

onEvent in interface IRepository

Parameters:

id - This parameter is required.

options -

onImageScanCompleted

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

Specified by:

onImageScanCompleted in interface IRepository

Parameters:

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

options - Options for adding the rule.

repositoryUriForDigest

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

Specified by:

repositoryUriForDigest in interface IRepository

Parameters:

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

repositoryUriForTag

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

Specified by:

repositoryUriForTag in interface IRepository

Parameters:

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