Interface IRepository
- All Superinterfaces:
IConstruct
,software.constructs.IConstruct
,IDependable
,IResource
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IRepository.Jsii$Default
- All Known Implementing Classes:
IRepository.Jsii$Proxy
,Repository
,RepositoryBase
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIRepository
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptionaddToResourcePolicy
(PolicyStatement statement) Add a policy statement to the repository's resource policy.The ARN of the repository.The name of the repository.The URI of this repository (represents the latest image):.grant
(IGrantable grantee, @NotNull String... actions) Grant the given principal identity permissions to perform the actions on this repository.grantPull
(IGrantable grantee) Grant the given identity permissions to pull images in this repository.grantPullPush
(IGrantable grantee) Grant the given identity permissions to pull and push images to this repository.Define a CloudWatch event that triggers when something happens to this repository.onCloudTrailEvent
(String id, OnEventOptions options) Define a CloudWatch event that triggers when something happens to this repository.Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.onCloudTrailImagePushed
(String id, OnCloudTrailImagePushedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.Defines a CloudWatch event rule which triggers for repository events.onEvent
(String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for repository events.Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.onImageScanCompleted
(String id, OnImageScanCompletedOptions options) Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.Returns the URI of the repository for a certain digest.repositoryUriForDigest
(String digest) Returns the URI of the repository for a certain digest.Returns the URI of the repository for a certain tag.Returns the URI of the repository for a certain tag.Returns the URI of the repository for a certain tag or digest, inferring based on the syntax of the tag.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.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
-
Method Details
-
getRepositoryArn
The ARN of the repository. -
getRepositoryName
The name of the repository. -
getRepositoryUri
The URI of this repository (represents the latest image):.ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY
-
addToResourcePolicy
@Stability(Stable) @NotNull AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement) Add a policy statement to the repository's resource policy.- Parameters:
statement
- This parameter is required.
-
grant
@Stability(Stable) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Grant the given principal identity permissions to perform the actions on this repository.- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
grantPull
Grant the given identity permissions to pull images in this repository.- Parameters:
grantee
- This parameter is required.
-
grantPullPush
Grant the given identity permissions to pull and push images to this repository.- Parameters:
grantee
- This parameter is required.
-
onCloudTrailEvent
@Stability(Stable) @NotNull 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.
- Parameters:
id
- The id of the rule. This parameter is required.options
- Options for adding the rule.
-
onCloudTrailEvent
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.
- Parameters:
id
- The id of the rule. This parameter is required.
-
onCloudTrailImagePushed
@Stability(Stable) @NotNull 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.
- Parameters:
id
- The id of the rule. This parameter is required.options
- Options for adding the rule.
-
onCloudTrailImagePushed
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.
- Parameters:
id
- The id of the rule. This parameter is required.
-
onEvent
Defines a CloudWatch event rule which triggers for repository events.Use
rule.addEventPattern(pattern)
to specify a filter.- Parameters:
id
- This parameter is required.options
-
-
onEvent
Defines a CloudWatch event rule which triggers for repository events.Use
rule.addEventPattern(pattern)
to specify a filter.- Parameters:
id
- This parameter is required.
-
onImageScanCompleted
@Stability(Stable) @NotNull 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.- Parameters:
id
- The id of the rule. This parameter is required.options
- Options for adding the rule.
-
onImageScanCompleted
Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.- Parameters:
id
- The id of the rule. This parameter is required.
-
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]
- Parameters:
digest
- Image digest to use (tools usually default to the image with the "latest" tag if omitted).
-
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]
-
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]
- Parameters:
tag
- Image tag to use (tools usually default to "latest" 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]
-
repositoryUriForTagOrDigest
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]
- Parameters:
tagOrDigest
- Image tag or digest to use (tools usually default to the image with the "latest" tag if omitted).
-
repositoryUriForTagOrDigest
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]
-