Class Repository
java.lang.Object
software.amazon.jsii.JsiiObject
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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:37.434Z")
@Stability(Stable)
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 ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecr.IRepository
IRepository.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Repository
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Repository
(software.amazon.jsii.JsiiObjectRef objRef) Repository
(software.constructs.Construct scope, String id) Repository
(software.constructs.Construct scope, String id, RepositoryProps props) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a life cycle rule to the repository.addToResourcePolicy
(PolicyStatement statement) Add a policy statement to the repository's resource policy.static String
arnForLocalRepository
(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 String
arnForLocalRepository
(String repositoryName, software.constructs.IConstruct scope, 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, String id, String repositoryArn) static IRepository
fromRepositoryAttributes
(software.constructs.Construct scope, String id, RepositoryAttributes attrs) Import a repository.static IRepository
fromRepositoryName
(software.constructs.Construct scope, String id, String repositoryName) The ARN of the repository.The name of the repository.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 software.constructs.Construct
toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Repository
protected Repository(software.amazon.jsii.JsiiObjectRef objRef) -
Repository
protected Repository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Repository
@Stability(Stable) public Repository(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable RepositoryProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
-
-
Repository
@Stability(Stable) public Repository(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
arnForLocalRepository
@Stability(Stable) @NotNull public static String arnForLocalRepository(@NotNull String repositoryName, @NotNull software.constructs.IConstruct scope, @Nullable 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
@Stability(Stable) @NotNull public static String arnForLocalRepository(@NotNull String repositoryName, @NotNull 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
@Stability(Stable) @NotNull public static IRepository fromRepositoryArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String repositoryArn) - Parameters:
scope
- This parameter is required.id
- This parameter is required.repositoryArn
- This parameter is required.
-
fromRepositoryAttributes
@Stability(Stable) @NotNull public static IRepository fromRepositoryAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull RepositoryAttributes attrs) Import a repository.- Parameters:
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.
-
fromRepositoryName
@Stability(Stable) @NotNull public static IRepository fromRepositoryName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String repositoryName) - Parameters:
scope
- This parameter is required.id
- This parameter is required.repositoryName
- This parameter is required.
-
addLifecycleRule
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
@Stability(Stable) @NotNull public AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement) Add a policy statement to the repository's resource policy.- Specified by:
addToResourcePolicy
in interfaceIRepository
- Specified by:
addToResourcePolicy
in classRepositoryBase
- Parameters:
statement
- This parameter is required.
-
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.
-
getRepositoryArn
The ARN of the repository.- Specified by:
getRepositoryArn
in interfaceIRepository
- Specified by:
getRepositoryArn
in classRepositoryBase
-
getRepositoryName
The name of the repository.- Specified by:
getRepositoryName
in interfaceIRepository
- Specified by:
getRepositoryName
in classRepositoryBase
-