io.github.cdklabs.cdk.docker.image.deployment.Destination Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk-docker-image-deployment Show documentation
This module allows you to copy docker image assets to a repository you control. This can be necessary if you want to build a Docker image in one CDK app and consume it in a different app or outside the CDK.
There is a newer version: 0.0.660
Show newest version
package io.github.cdklabs.cdk.docker.image.deployment;

/**
 * Specifies docker image deployment destination.
 * 
 * Usage:
 * 

 * 
 * declare const repo: ecr.IRepository;
 * const destinationEcr = dockerDeploy.Destination.ecr(repository, {
 *    tag: 'tag',
 * });
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-24T00:27:06.382Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.docker.image.deployment.$Module.class, fqn = "cdk-docker-image-deployment.Destination")
public abstract class Destination extends software.amazon.jsii.JsiiObject {

    protected Destination(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected Destination(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    protected Destination() {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
    }

    /**
     * Uses an ECR repository in the same account as the stack as the destination for the image.
     * 
     * @param repository This parameter is required.
     * @param options
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.docker.image.deployment.Destination ecr(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecr.IRepository repository, final @org.jetbrains.annotations.Nullable io.github.cdklabs.cdk.docker.image.deployment.EcrSourceOptions options) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.cdk.docker.image.deployment.Destination.class, "ecr", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.docker.image.deployment.Destination.class), new Object[] { java.util.Objects.requireNonNull(repository, "repository is required"), options });
    }

    /**
     * Uses an ECR repository in the same account as the stack as the destination for the image.
     * 

     * @param repository This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.docker.image.deployment.Destination ecr(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecr.IRepository repository) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.cdk.docker.image.deployment.Destination.class, "ecr", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.docker.image.deployment.Destination.class), new Object[] { java.util.Objects.requireNonNull(repository, "repository is required") });
    }

    /**
     * Bind grants the CodeBuild role permissions to pull and push to a repository if necessary.
     * 

     * Bind should be invoked by the caller to get the DestinationConfig.
     * 

     * @param role This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public abstract @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.docker.image.deployment.DestinationConfig bind(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iam.IGrantable role);

    /**
     * A proxy class which represents a concrete javascript instance of this type.
     */
    @software.amazon.jsii.Internal
    private static final class Jsii$Proxy extends io.github.cdklabs.cdk.docker.image.deployment.Destination {
        protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
            super(objRef);
        }

        /**
         * Bind grants the CodeBuild role permissions to pull and push to a repository if necessary.
         * 

         * Bind should be invoked by the caller to get the DestinationConfig.
         * 
         * @param role This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.docker.image.deployment.DestinationConfig bind(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iam.IGrantable role) {
            return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.docker.image.deployment.DestinationConfig.class), new Object[] { java.util.Objects.requireNonNull(role, "role is required") });
        }
    }
}