Interface IRepository.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IRepository
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IRepository.Jsii$Proxy
- Enclosing interface:
IRepository
IRepository
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecr.IRepository
IRepository.Jsii$Default, IRepository.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddToResourcePolicyResult
addToResourcePolicy
(PolicyStatement statement) Add a policy statement to the repository's resource policy.default void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default software.constructs.Node
getNode()
The tree node.default String
The ARN of the repository.default String
The name of the repository.default String
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, @NotNull 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 Grant
grantPush
(IGrantable grantee) Grant the given identity permissions to push images in this repository.default Grant
grantRead
(IGrantable grantee) Grant the given identity permissions to read images in 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 digest.default String
Returns the URI of the repository for a certain tag.default String
repositoryUriForTagOrDigest
(String tagOrDigest) Returns the URI of the repository for a certain tag or digest, inferring based on the syntax of the tag.Methods inherited from interface software.amazon.awscdk.services.ecr.IRepository
onCloudTrailEvent, onCloudTrailImagePushed, onEvent, onImageScanCompleted, repositoryUriForDigest, repositoryUriForTag, repositoryUriForTagOrDigest
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getRepositoryArn
The ARN of the repository.- Specified by:
getRepositoryArn
in interfaceIRepository
-
getRepositoryName
The name of the repository.- Specified by:
getRepositoryName
in interfaceIRepository
-
getRepositoryUri
The URI of this repository (represents the latest image):.ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY
- Specified by:
getRepositoryUri
in interfaceIRepository
-
applyRemovalPolicy
Apply the given removal policy to this resource.The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addToResourcePolicy
@Stability(Stable) @NotNull default AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement) Add a policy statement to the repository's resource policy.- Specified by:
addToResourcePolicy
in interfaceIRepository
- Parameters:
statement
- This parameter is required.
-
grant
@Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Grant the given principal identity permissions to perform the actions on this repository.- Specified by:
grant
in interfaceIRepository
- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
grantPull
Grant the given identity permissions to pull images in this repository.- Specified by:
grantPull
in interfaceIRepository
- Parameters:
grantee
- This parameter is required.
-
grantPullPush
Grant the given identity permissions to pull and push images to this repository.- Specified by:
grantPullPush
in interfaceIRepository
- Parameters:
grantee
- This parameter is required.
-
grantPush
Grant the given identity permissions to push images in this repository.- Specified by:
grantPush
in interfaceIRepository
- Parameters:
grantee
- This parameter is required.
-
grantRead
Grant the given identity permissions to read images in this repository.- Specified by:
grantRead
in interfaceIRepository
- Parameters:
grantee
- This parameter is required.
-
onCloudTrailEvent
@Stability(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 interfaceIRepository
- Parameters:
id
- The id of the rule. This parameter is required.options
- Options for adding the rule.
-
onCloudTrailImagePushed
@Stability(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 interfaceIRepository
- Parameters:
id
- The id of the rule. This parameter is required.options
- Options for adding the rule.
-
onEvent
@Stability(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 interfaceIRepository
- Parameters:
id
- This parameter is required.options
-
-
onImageScanCompleted
@Stability(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 interfaceIRepository
- Parameters:
id
- The id of the rule. This parameter is required.options
- Options for adding the rule.
-
repositoryUriForDigest
Returns the URI of the repository for a certain digest. Can be used indocker push/pull
.ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
- Specified by:
repositoryUriForDigest
in interfaceIRepository
- Parameters:
digest
- Image digest to use (tools usually default to the image with the "latest" tag if omitted).
-
repositoryUriForTag
Returns the URI of the repository for a certain tag. Can be used indocker push/pull
.ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
- Specified by:
repositoryUriForTag
in interfaceIRepository
- Parameters:
tag
- Image tag to use (tools usually default to "latest" if omitted).
-
repositoryUriForTagOrDigest
@Stability(Stable) @NotNull default String repositoryUriForTagOrDigest(@Nullable String tagOrDigest) Returns the URI of the repository for a certain tag or digest, inferring based on the syntax of the tag.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 interfaceIRepository
- Parameters:
tagOrDigest
- Image tag or digest to use (tools usually default to the image with the "latest" tag if omitted).
-