io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeployment 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;

/**
 * DockerImageDeployment pushes an image from a local or external source to a specified external destination.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-24T00:27:06.387Z")
@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.DockerImageDeployment")
public class DockerImageDeployment extends software.constructs.Construct {

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

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

    /**
     * @param scope This parameter is required.
     * @param id This parameter is required.
     * @param props This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public DockerImageDeployment(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeploymentProps props) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * A fluent builder for {@link io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeployment}.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static final class Builder implements software.amazon.jsii.Builder {
        /**
         * @return a new instance of {@link Builder}.
         * @param scope This parameter is required.
         * @param id This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
            return new Builder(scope, id);
        }

        private final software.constructs.Construct scope;
        private final java.lang.String id;
        private final io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeploymentProps.Builder props;

        private Builder(final software.constructs.Construct scope, final java.lang.String id) {
            this.scope = scope;
            this.id = id;
            this.props = new io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeploymentProps.Builder();
        }

        /**
         * Destination repository to deploy the image to.
         * 
         * @return {@code this}
         * @param destination Destination repository to deploy the image to. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder destination(final io.github.cdklabs.cdk.docker.image.deployment.Destination destination) {
            this.props.destination(destination);
            return this;
        }

        /**
         * Source of the image to deploy.
         * 
         * @return {@code this}
         * @param source Source of the image to deploy. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder source(final io.github.cdklabs.cdk.docker.image.deployment.Source source) {
            this.props.source(source);
            return this;
        }

        /**
         * @return a newly built instance of {@link io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeployment}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeployment build() {
            return new io.github.cdklabs.cdk.docker.image.deployment.DockerImageDeployment(
                this.scope,
                this.id,
                this.props.build()
            );
        }
    }
}