io.cloudshiftdev.awscdk.services.ecr.IRepository.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.ecr
import io.cloudshiftdev.awscdk.IResource
import io.cloudshiftdev.awscdk.RemovalPolicy
import io.cloudshiftdev.awscdk.ResourceEnvironment
import io.cloudshiftdev.awscdk.Stack
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.events.OnEventOptions
import io.cloudshiftdev.awscdk.services.events.Rule
import io.cloudshiftdev.awscdk.services.iam.AddToResourcePolicyResult
import io.cloudshiftdev.awscdk.services.iam.Grant
import io.cloudshiftdev.awscdk.services.iam.IGrantable
import io.cloudshiftdev.awscdk.services.iam.PolicyStatement
import io.cloudshiftdev.constructs.Node
import kotlin.String
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* Represents an ECR repository.
*/
public interface IRepository : IResource {
/**
* Add a policy statement to the repository's resource policy.
*
* @param statement
*/
public fun addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult
/**
* Add a policy statement to the repository's resource policy.
*
* @param statement
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("b93f8258425594b02debe63f0c120f198512d8431f5ae67b7fb7780e34fcbae2")
public fun addToResourcePolicy(statement: PolicyStatement.Builder.() -> Unit):
AddToResourcePolicyResult
/**
* Grant the given principal identity permissions to perform the actions on this repository.
*
* @param grantee
* @param actions
*/
public fun grant(grantee: IGrantable, vararg actions: String): Grant
/**
* Grant the given identity permissions to pull images in this repository.
*
* @param grantee
*/
public fun grantPull(grantee: IGrantable): Grant
/**
* Grant the given identity permissions to pull and push images to this repository.
*
* @param grantee
*/
public fun grantPullPush(grantee: IGrantable): Grant
/**
* Grant the given identity permissions to push images in this repository.
*
* @param grantee
*/
public fun grantPush(grantee: IGrantable): Grant
/**
* Grant the given identity permissions to read images in this repository.
*
* @param grantee
*/
public fun grantRead(grantee: IGrantable): Grant
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
public fun onCloudTrailEvent(id: String): Rule
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
public fun onCloudTrailEvent(id: String, options: OnEventOptions): Rule
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("5ed49a38b97e72d144f73c4dfe2a95a34b876c411ce7dd72df9a7a84fbeb4376")
public fun onCloudTrailEvent(id: String, options: OnEventOptions.Builder.() -> Unit): Rule
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
public fun onCloudTrailImagePushed(id: String): Rule
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
public fun onCloudTrailImagePushed(id: String, options: OnCloudTrailImagePushedOptions): Rule
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("b6ef082c6b809d259f51198817aa3b80a159542a1994bc4960ac065b0a64b707")
public fun onCloudTrailImagePushed(id: String,
options: OnCloudTrailImagePushedOptions.Builder.() -> Unit): Rule
/**
* Defines a CloudWatch event rule which triggers for repository events.
*
* Use
* `rule.addEventPattern(pattern)` to specify a filter.
*
* @param id
* @param options
*/
public fun onEvent(id: String): Rule
/**
* Defines a CloudWatch event rule which triggers for repository events.
*
* Use
* `rule.addEventPattern(pattern)` to specify a filter.
*
* @param id
* @param options
*/
public fun onEvent(id: String, options: OnEventOptions): Rule
/**
* Defines a CloudWatch event rule which triggers for repository events.
*
* Use
* `rule.addEventPattern(pattern)` to specify a filter.
*
* @param id
* @param options
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("dc6b56ca17cf70d5df4c4cb59d88b17086787e6d21187ab337b8006053ced50b")
public fun onEvent(id: String, options: OnEventOptions.Builder.() -> Unit): Rule
/**
* Defines an AWS CloudWatch event rule that can trigger a target when the image scan is
* completed.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
public fun onImageScanCompleted(id: String): Rule
/**
* Defines an AWS CloudWatch event rule that can trigger a target when the image scan is
* completed.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
public fun onImageScanCompleted(id: String, options: OnImageScanCompletedOptions): Rule
/**
* Defines an AWS CloudWatch event rule that can trigger a target when the image scan is
* completed.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("af5fc24c7b64d0577fb9d831f23d31aac8a626027ac1285086eb1271758a5da3")
public fun onImageScanCompleted(id: String,
options: OnImageScanCompletedOptions.Builder.() -> Unit): Rule
/**
* The ARN of the repository.
*/
public fun repositoryArn(): String
/**
* The name of the repository.
*/
public fun repositoryName(): String
/**
* The URI of this repository (represents the latest image):.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY
*/
public fun repositoryUri(): String
/**
* Returns the URI of the repository for a certain digest. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
*
* @param digest Image digest to use (tools usually default to the image with the "latest" tag if
* omitted).
*/
public fun repositoryUriForDigest(): String
/**
* Returns the URI of the repository for a certain digest. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
*
* @param digest Image digest to use (tools usually default to the image with the "latest" tag if
* omitted).
*/
public fun repositoryUriForDigest(digest: String): String
/**
* Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
*
* @param tag Image tag to use (tools usually default to "latest" if omitted).
*/
public fun repositoryUriForTag(): String
/**
* Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
*
* @param tag Image tag to use (tools usually default to "latest" if omitted).
*/
public fun repositoryUriForTag(tag: String): String
/**
* 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]
*
* @param tagOrDigest Image tag or digest to use (tools usually default to the image with the
* "latest" tag if omitted).
*/
public fun repositoryUriForTagOrDigest(): String
/**
* 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]
*
* @param tagOrDigest Image tag or digest to use (tools usually default to the image with the
* "latest" tag if omitted).
*/
public fun repositoryUriForTagOrDigest(tagOrDigest: String): String
private class Wrapper(
cdkObject: software.amazon.awscdk.services.ecr.IRepository,
) : CdkObject(cdkObject),
IRepository {
/**
* Add a policy statement to the repository's resource policy.
*
* @param statement
*/
override fun addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult =
unwrap(this).addToResourcePolicy(statement.let(PolicyStatement.Companion::unwrap)).let(AddToResourcePolicyResult::wrap)
/**
* Add a policy statement to the repository's resource policy.
*
* @param statement
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("b93f8258425594b02debe63f0c120f198512d8431f5ae67b7fb7780e34fcbae2")
override fun addToResourcePolicy(statement: PolicyStatement.Builder.() -> Unit):
AddToResourcePolicyResult = addToResourcePolicy(PolicyStatement(statement))
/**
* 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`).
*
* @param policy
*/
override fun applyRemovalPolicy(policy: RemovalPolicy) {
unwrap(this).applyRemovalPolicy(policy.let(RemovalPolicy.Companion::unwrap))
}
/**
* 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.
*/
override fun env(): ResourceEnvironment = unwrap(this).getEnv().let(ResourceEnvironment::wrap)
/**
* Grant the given principal identity permissions to perform the actions on this repository.
*
* @param grantee
* @param actions
*/
override fun grant(grantee: IGrantable, vararg actions: String): Grant =
unwrap(this).grant(grantee.let(IGrantable.Companion::unwrap),
*actions.map{CdkObjectWrappers.unwrap(it) as String}.toTypedArray()).let(Grant::wrap)
/**
* Grant the given identity permissions to pull images in this repository.
*
* @param grantee
*/
override fun grantPull(grantee: IGrantable): Grant =
unwrap(this).grantPull(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
/**
* Grant the given identity permissions to pull and push images to this repository.
*
* @param grantee
*/
override fun grantPullPush(grantee: IGrantable): Grant =
unwrap(this).grantPullPush(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
/**
* Grant the given identity permissions to push images in this repository.
*
* @param grantee
*/
override fun grantPush(grantee: IGrantable): Grant =
unwrap(this).grantPush(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
/**
* Grant the given identity permissions to read images in this repository.
*
* @param grantee
*/
override fun grantRead(grantee: IGrantable): Grant =
unwrap(this).grantRead(grantee.let(IGrantable.Companion::unwrap)).let(Grant::wrap)
override fun node(): Node = unwrap(this).getNode().let(Node::wrap)
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
override fun onCloudTrailEvent(id: String): Rule =
unwrap(this).onCloudTrailEvent(id).let(Rule::wrap)
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
override fun onCloudTrailEvent(id: String, options: OnEventOptions): Rule =
unwrap(this).onCloudTrailEvent(id,
options.let(OnEventOptions.Companion::unwrap)).let(Rule::wrap)
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("5ed49a38b97e72d144f73c4dfe2a95a34b876c411ce7dd72df9a7a84fbeb4376")
override fun onCloudTrailEvent(id: String, options: OnEventOptions.Builder.() -> Unit): Rule =
onCloudTrailEvent(id, OnEventOptions(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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
override fun onCloudTrailImagePushed(id: String): Rule =
unwrap(this).onCloudTrailImagePushed(id).let(Rule::wrap)
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
override fun onCloudTrailImagePushed(id: String, options: OnCloudTrailImagePushedOptions): Rule
= unwrap(this).onCloudTrailImagePushed(id,
options.let(OnCloudTrailImagePushedOptions.Companion::unwrap)).let(Rule::wrap)
/**
* 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.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("b6ef082c6b809d259f51198817aa3b80a159542a1994bc4960ac065b0a64b707")
override fun onCloudTrailImagePushed(id: String,
options: OnCloudTrailImagePushedOptions.Builder.() -> Unit): Rule =
onCloudTrailImagePushed(id, OnCloudTrailImagePushedOptions(options))
/**
* Defines a CloudWatch event rule which triggers for repository events.
*
* Use
* `rule.addEventPattern(pattern)` to specify a filter.
*
* @param id
* @param options
*/
override fun onEvent(id: String): Rule = unwrap(this).onEvent(id).let(Rule::wrap)
/**
* Defines a CloudWatch event rule which triggers for repository events.
*
* Use
* `rule.addEventPattern(pattern)` to specify a filter.
*
* @param id
* @param options
*/
override fun onEvent(id: String, options: OnEventOptions): Rule = unwrap(this).onEvent(id,
options.let(OnEventOptions.Companion::unwrap)).let(Rule::wrap)
/**
* Defines a CloudWatch event rule which triggers for repository events.
*
* Use
* `rule.addEventPattern(pattern)` to specify a filter.
*
* @param id
* @param options
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("dc6b56ca17cf70d5df4c4cb59d88b17086787e6d21187ab337b8006053ced50b")
override fun onEvent(id: String, options: OnEventOptions.Builder.() -> Unit): Rule = onEvent(id,
OnEventOptions(options))
/**
* Defines an AWS CloudWatch event rule that can trigger a target when the image scan is
* completed.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
override fun onImageScanCompleted(id: String): Rule =
unwrap(this).onImageScanCompleted(id).let(Rule::wrap)
/**
* Defines an AWS CloudWatch event rule that can trigger a target when the image scan is
* completed.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
override fun onImageScanCompleted(id: String, options: OnImageScanCompletedOptions): Rule =
unwrap(this).onImageScanCompleted(id,
options.let(OnImageScanCompletedOptions.Companion::unwrap)).let(Rule::wrap)
/**
* Defines an AWS CloudWatch event rule that can trigger a target when the image scan is
* completed.
*
* @param id The id of the rule.
* @param options Options for adding the rule.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("af5fc24c7b64d0577fb9d831f23d31aac8a626027ac1285086eb1271758a5da3")
override fun onImageScanCompleted(id: String,
options: OnImageScanCompletedOptions.Builder.() -> Unit): Rule = onImageScanCompleted(id,
OnImageScanCompletedOptions(options))
/**
* The ARN of the repository.
*/
override fun repositoryArn(): String = unwrap(this).getRepositoryArn()
/**
* The name of the repository.
*/
override fun repositoryName(): String = unwrap(this).getRepositoryName()
/**
* The URI of this repository (represents the latest image):.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY
*/
override fun repositoryUri(): String = unwrap(this).getRepositoryUri()
/**
* Returns the URI of the repository for a certain digest. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
*
* @param digest Image digest to use (tools usually default to the image with the "latest" tag
* if omitted).
*/
override fun repositoryUriForDigest(): String = unwrap(this).repositoryUriForDigest()
/**
* Returns the URI of the repository for a certain digest. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
*
* @param digest Image digest to use (tools usually default to the image with the "latest" tag
* if omitted).
*/
override fun repositoryUriForDigest(digest: String): String =
unwrap(this).repositoryUriForDigest(digest)
/**
* Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
*
* @param tag Image tag to use (tools usually default to "latest" if omitted).
*/
override fun repositoryUriForTag(): String = unwrap(this).repositoryUriForTag()
/**
* Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.
*
* ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
*
* @param tag Image tag to use (tools usually default to "latest" if omitted).
*/
override fun repositoryUriForTag(tag: String): String = unwrap(this).repositoryUriForTag(tag)
/**
* 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]
*
* @param tagOrDigest Image tag or digest to use (tools usually default to the image with the
* "latest" tag if omitted).
*/
override fun repositoryUriForTagOrDigest(): String = unwrap(this).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]
*
* @param tagOrDigest Image tag or digest to use (tools usually default to the image with the
* "latest" tag if omitted).
*/
override fun repositoryUriForTagOrDigest(tagOrDigest: String): String =
unwrap(this).repositoryUriForTagOrDigest(tagOrDigest)
/**
* The stack in which this resource is defined.
*/
override fun stack(): Stack = unwrap(this).getStack().let(Stack::wrap)
}
public companion object {
internal fun wrap(cdkObject: software.amazon.awscdk.services.ecr.IRepository): IRepository =
CdkObjectWrappers.wrap(cdkObject) as? IRepository ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: IRepository): software.amazon.awscdk.services.ecr.IRepository =
(wrapped as CdkObject).cdkObject as software.amazon.awscdk.services.ecr.IRepository
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy