software.amazon.awscdk.services.ecr

Class RepositoryBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ecr.RepositoryBase

All Implemented Interfaces:

IConstruct, IDependable, IResource, IRepository

Direct Known Subclasses:

Repository

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:36.085Z")
public abstract class RepositoryBase
extends Resource
implements IRepository

Base class for ECR repository.

Reused between imported repositories and owned repositories.

Nested Class Summary

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

IRepository.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RepositoryBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RepositoryBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	RepositoryBase(software.constructs.Construct scope, java.lang.String id)
protected	RepositoryBase(software.constructs.Construct scope, java.lang.String id, ResourceProps props)

Method Summary

Modifier and Type	Method and Description
abstract AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Add a policy statement to the repository's resource policy.
abstract java.lang.String	getRepositoryArn() The ARN of the repository.
abstract 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 use the 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 an image scan is completed.
Rule	onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed.
java.lang.String	repositoryUriForDigest() Returns the URL of the repository.
java.lang.String	repositoryUriForDigest(java.lang.String digest) Returns the URL of the repository.
java.lang.String	repositoryUriForTag() Returns the URL of the repository.
java.lang.String	repositoryUriForTag(java.lang.String tag) Returns the URL of the repository.
java.lang.String	repositoryUriForTagOrDigest() Returns the URL of the repository.
java.lang.String	repositoryUriForTagOrDigest(java.lang.String tagOrDigest) Returns the URL of the repository.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Constructor Detail

RepositoryBase

protected RepositoryBase(software.amazon.jsii.JsiiObjectRef objRef)

RepositoryBase

protected RepositoryBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

RepositoryBase

protected RepositoryBase(software.constructs.Construct scope,
                         java.lang.String id,
                         ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

RepositoryBase

protected RepositoryBase(software.constructs.Construct scope,
                         java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addToResourcePolicy

public abstract AddToResourcePolicyResult addToResourcePolicy(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

public Grant grant(IGrantable grantee,
                   java.lang.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

public Grant grantPull(IGrantable grantee)

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

Specified by:

grantPull in interface IRepository

Parameters:

grantee - This parameter is required.

grantPullPush

public Grant grantPullPush(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

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

Specified by:

onCloudTrailEvent in interface IRepository

Parameters:

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

options - Options for adding the rule.

onCloudTrailEvent

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

Specified by:

onCloudTrailEvent in interface IRepository

Parameters:

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

onCloudTrailImagePushed

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

Specified by:

onCloudTrailImagePushed in interface IRepository

Parameters:

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

options - Options for adding the rule.

onCloudTrailImagePushed

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

Specified by:

onCloudTrailImagePushed in interface IRepository

Parameters:

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

onEvent

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

Specified by:

onEvent in interface IRepository

Parameters:

id - This parameter is required.

options -

onEvent

public Rule onEvent(java.lang.String id)

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.

onImageScanCompleted

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

Defines an AWS CloudWatch event rule that can trigger a target when an 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.

onImageScanCompleted

public Rule onImageScanCompleted(java.lang.String id)

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

Specified by:

onImageScanCompleted in interface IRepository

Parameters:

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

repositoryUriForDigest

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

Returns the URL of the repository. Can be used in `docker push/pull`.

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

Specified by:

repositoryUriForDigest in interface IRepository

Parameters:

digest - Optional image digest.

repositoryUriForDigest

public java.lang.String repositoryUriForDigest()

Returns the URL of the repository. Can be used in `docker push/pull`.

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

Specified by:

repositoryUriForDigest in interface IRepository

repositoryUriForTag

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

Returns the URL of the repository. Can be used in `docker push/pull`.

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

Specified by:

repositoryUriForTag in interface IRepository

Parameters:

tag - Optional image tag.

repositoryUriForTag

public java.lang.String repositoryUriForTag()

Returns the URL of the repository. Can be used in `docker push/pull`.

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

Specified by:

repositoryUriForTag in interface IRepository

repositoryUriForTagOrDigest

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

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]

Specified by:

repositoryUriForTagOrDigest in interface IRepository

Parameters:

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

repositoryUriForTagOrDigest

public java.lang.String repositoryUriForTagOrDigest()

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]

Specified by:

repositoryUriForTagOrDigest in interface IRepository

getRepositoryArn

public abstract java.lang.String getRepositoryArn()

The ARN of the repository.

Specified by:

getRepositoryArn in interface IRepository

getRepositoryName

public abstract java.lang.String getRepositoryName()

The name of the repository.

Specified by:

getRepositoryName in interface IRepository

getRepositoryUri

public java.lang.String getRepositoryUri()

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

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

Specified by:

getRepositoryUri in interface IRepository