io.github.cdklabs.cdk.ecr.deployment.IImageName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk-ecr-deployment Show documentation
CDK construct to deploy docker image to Amazon ECR
The newest version!
package io.github.cdklabs.cdk.ecr.deployment;

/**
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.106.0 (build e852934)", date = "2024-12-18T18:21:42.889Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.ecr.deployment.$Module.class, fqn = "cdk-ecr-deployment.IImageName")
@software.amazon.jsii.Jsii.Proxy(IImageName.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface IImageName extends software.amazon.jsii.JsiiSerializable {

    /**
     * The uri of the docker image.
     * 
     * The uri spec follows https://github.com/containers/skopeo
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @org.jetbrains.annotations.NotNull java.lang.String getUri();

    /**
     * The credentials of the docker image.
     * 

     * Format user:password or AWS Secrets Manager secret arn or AWS Secrets Manager secret name
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    default @org.jetbrains.annotations.Nullable java.lang.String getCreds() {
        return null;
    }

    /**
     * The credentials of the docker image.
     * 

     * Format user:password or AWS Secrets Manager secret arn or AWS Secrets Manager secret name
     */
    @software.amazon.jsii.Optional
    default void setCreds(final @org.jetbrains.annotations.Nullable java.lang.String value) {
        throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setCreds(@org.jetbrains.annotations.Nullable java.lang.String)' is not implemented!");
    }

    /**
     * A proxy class which represents a concrete javascript instance of this type.
     */
    @software.amazon.jsii.Internal
    final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements io.github.cdklabs.cdk.ecr.deployment.IImageName.Jsii$Default {
        protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
            super(objRef);
        }

        /**
         * The uri of the docker image.
         * 

         * The uri spec follows https://github.com/containers/skopeo
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public final @org.jetbrains.annotations.NotNull java.lang.String getUri() {
            return software.amazon.jsii.Kernel.get(this, "uri", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }

        /**
         * The credentials of the docker image.
         * 

         * Format user:password or AWS Secrets Manager secret arn or AWS Secrets Manager secret name
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public final @org.jetbrains.annotations.Nullable java.lang.String getCreds() {
            return software.amazon.jsii.Kernel.get(this, "creds", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }

        /**
         * The credentials of the docker image.
         * 

         * Format user:password or AWS Secrets Manager secret arn or AWS Secrets Manager secret name
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public final void setCreds(final @org.jetbrains.annotations.Nullable java.lang.String value) {
            software.amazon.jsii.Kernel.set(this, "creds", value);
        }
    }

    /**
     * Internal default implementation for {@link IImageName}.
     */
    @software.amazon.jsii.Internal
    interface Jsii$Default extends IImageName {

        /**
         * The uri of the docker image.
         * 

         * The uri spec follows https://github.com/containers/skopeo
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        default @org.jetbrains.annotations.NotNull java.lang.String getUri() {
            return software.amazon.jsii.Kernel.get(this, "uri", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }

        /**
         * The credentials of the docker image.
         * 

         * Format user:password or AWS Secrets Manager secret arn or AWS Secrets Manager secret name
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        default @org.jetbrains.annotations.Nullable java.lang.String getCreds() {
            return software.amazon.jsii.Kernel.get(this, "creds", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }

        /**
         * The credentials of the docker image.
         * 
         * Format user:password or AWS Secrets Manager secret arn or AWS Secrets Manager secret name
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        default void setCreds(final @org.jetbrains.annotations.Nullable java.lang.String value) {
            software.amazon.jsii.Kernel.set(this, "creds", value);
        }
    }
}