software.amazon.awscdk.services.ecr

Class Repository

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ecr.RepositoryBase

software.amazon.awscdk.services.ecr.Repository

All Implemented Interfaces:

IConstruct, IDependable, IResource, IRepository

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.479Z")
public class Repository
extends RepositoryBase

Define an ECR repository.

Example:

 import software.amazon.awscdk.services.ecr.*;
 Service.Builder.create(this, "Service")
         .source(Source.fromEcr(EcrProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(80).build())
                 .repository(Repository.fromRepositoryName(this, "NginxRepository", "nginx"))
                 .tagOrDigest("latest")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Repository.Builder A fluent builder for Repository.

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

IRepository.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addLifecycleRule(LifecycleRule rule) Add a life cycle rule to the repository.
AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Add a policy statement to the repository's resource policy.
static java.lang.String	arnForLocalRepository(java.lang.String repositoryName, software.constructs.IConstruct scope) Returns an ECR ARN for a repository that resides in the same account/region as the current stack.
static java.lang.String	arnForLocalRepository(java.lang.String repositoryName, software.constructs.IConstruct scope, java.lang.String account) Returns an ECR ARN for a repository that resides in the same account/region as the current stack.
static IRepository	fromRepositoryArn(software.constructs.Construct scope, java.lang.String id, java.lang.String repositoryArn)
static IRepository	fromRepositoryAttributes(software.constructs.Construct scope, java.lang.String id, RepositoryAttributes attrs) Import a repository.
static IRepository	fromRepositoryName(software.constructs.Construct scope, java.lang.String id, java.lang.String repositoryName)
java.lang.String	getRepositoryArn() The ARN of the repository.
java.lang.String	getRepositoryName() The name of the repository.
protected java.util.List<java.lang.String>	validate() Validate the current construct.

Methods inherited from class software.amazon.awscdk.services.ecr.RepositoryBase

getRepositoryUri, grant, grantPull, grantPullPush, onCloudTrailEvent, onCloudTrailEvent, onCloudTrailImagePushed, onCloudTrailImagePushed, onEvent, onEvent, onImageScanCompleted, onImageScanCompleted, repositoryUriForDigest, repositoryUriForDigest, repositoryUriForTag, repositoryUriForTag, repositoryUriForTagOrDigest, repositoryUriForTagOrDigest

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

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

Repository

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

Repository

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

Repository

public Repository(software.constructs.Construct scope,
                  java.lang.String id,
                  RepositoryProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Repository

public Repository(software.constructs.Construct scope,
                  java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

arnForLocalRepository

public static java.lang.String arnForLocalRepository(java.lang.String repositoryName,
                                                     software.constructs.IConstruct scope,
                                                     java.lang.String account)

Returns an ECR ARN for a repository that resides in the same account/region as the current stack.

Parameters:

repositoryName - This parameter is required.

scope - This parameter is required.

account -

arnForLocalRepository

public static java.lang.String arnForLocalRepository(java.lang.String repositoryName,
                                                     software.constructs.IConstruct scope)

Returns an ECR ARN for a repository that resides in the same account/region as the current stack.

Parameters:

repositoryName - This parameter is required.

scope - This parameter is required.

fromRepositoryArn

public static IRepository fromRepositoryArn(software.constructs.Construct scope,
                                            java.lang.String id,
                                            java.lang.String repositoryArn)

Parameters:

scope - This parameter is required.

id - This parameter is required.

repositoryArn - This parameter is required.

fromRepositoryAttributes

public static IRepository fromRepositoryAttributes(software.constructs.Construct scope,
                                                   java.lang.String id,
                                                   RepositoryAttributes attrs)

Import a repository.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

fromRepositoryName

public static IRepository fromRepositoryName(software.constructs.Construct scope,
                                             java.lang.String id,
                                             java.lang.String repositoryName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

repositoryName - This parameter is required.

addLifecycleRule

public void addLifecycleRule(LifecycleRule rule)

Add a life cycle rule to the repository.

Life cycle rules automatically expire images from the repository that match certain conditions.

Parameters:

rule - This parameter is required.

addToResourcePolicy

public AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)

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

Specified by:

addToResourcePolicy in interface IRepository

Specified by:

addToResourcePolicy in class RepositoryBase

Parameters:

statement - This parameter is required.

validate

protected java.util.List<java.lang.String> validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getRepositoryArn

public java.lang.String getRepositoryArn()

The ARN of the repository.

Specified by:

getRepositoryArn in interface IRepository

Specified by:

getRepositoryArn in class RepositoryBase

getRepositoryName

public java.lang.String getRepositoryName()

The name of the repository.

Specified by:

getRepositoryName in interface IRepository

Specified by:

getRepositoryName in class RepositoryBase