Package software.amazon.awscdk

Class DockerImageAssetSource.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.DockerImageAssetSource.Jsii$Proxy
All Implemented Interfaces:
DockerImageAssetSource, software.amazon.jsii.JsiiSerializable
Enclosing interface:
DockerImageAssetSource
@Stability(Stable) @Internal public static final class DockerImageAssetSource.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DockerImageAssetSource
An implementation for DockerImageAssetSource

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(DockerImageAssetSource.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DockerImageAssetSource.Builder.

  • Method Details

    • getSourceHash

      public final String getSourceHash()
      Description copied from interface: DockerImageAssetSource
      The hash of the contents of the docker build context.

      This hash is used throughout the system to identify this image and avoid duplicate work in case the source did not change.

      NOTE: this means that if you wish to update your docker image, you must make a modification to the source (e.g. add some metadata to your Dockerfile).

      Specified by:
      getSourceHash in interface DockerImageAssetSource

    • getAssetName

      public final String getAssetName()
      Description copied from interface: DockerImageAssetSource
      Unique identifier of the docker image asset and its potential revisions.

      Required if using AppScopedStagingSynthesizer.

      Default: - no asset name

      Specified by:
      getAssetName in interface DockerImageAssetSource

    • getDirectoryName

      public final String getDirectoryName()
      Description copied from interface: DockerImageAssetSource
      The directory where the Dockerfile is stored, must be relative to the cloud assembly root.

      Default: - Exactly one of `directoryName` and `executable` is required

      Specified by:
      getDirectoryName in interface DockerImageAssetSource

    • getDisplayName

      public final String getDisplayName()
      Description copied from interface: DockerImageAssetSource
      A display name for this asset.

      If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information.

      Default: - The asset hash is used to display the asset

      Specified by:
      getDisplayName in interface DockerImageAssetSource

    • getDockerBuildArgs

      public final Map<String,String> getDockerBuildArgs()
      Description copied from interface: DockerImageAssetSource
      Build args to pass to the docker build command.

      Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl).

      Only allowed when directoryName is specified.

      Default: - no build args are passed

      Specified by:
      getDockerBuildArgs in interface DockerImageAssetSource

    • getDockerBuildSecrets

      public final Map<String,String> getDockerBuildSecrets()
      Description copied from interface: DockerImageAssetSource
      Build secrets to pass to the docker build command.

      Since Docker build secrets are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl).

      Only allowed when directoryName is specified.

      Default: - no build secrets are passed

      Specified by:
      getDockerBuildSecrets in interface DockerImageAssetSource

    • getDockerBuildSsh

      public final String getDockerBuildSsh()
      Description copied from interface: DockerImageAssetSource
      SSH agent socket or keys to pass to the docker buildx command.

      Default: - no ssh arg is passed

      Specified by:
      getDockerBuildSsh in interface DockerImageAssetSource

    • getDockerBuildTarget

      public final String getDockerBuildTarget()
      Description copied from interface: DockerImageAssetSource
      Docker target to build to.

      Only allowed when directoryName is specified.

      Default: - no target

      Specified by:
      getDockerBuildTarget in interface DockerImageAssetSource

    • getDockerCacheDisabled

      public final Boolean getDockerCacheDisabled()
      Description copied from interface: DockerImageAssetSource
      Disable the cache and pass --no-cache to the docker build command.

      Default: - cache is used

      Specified by:
      getDockerCacheDisabled in interface DockerImageAssetSource

    • getDockerCacheFrom

      public final List<DockerCacheOption> getDockerCacheFrom()
      Description copied from interface: DockerImageAssetSource
      Cache from options to pass to the docker build command.

      Default: - no cache from args are passed

      Specified by:
      getDockerCacheFrom in interface DockerImageAssetSource

    • getDockerCacheTo

      public final DockerCacheOption getDockerCacheTo()
      Description copied from interface: DockerImageAssetSource
      Cache to options to pass to the docker build command.

      Default: - no cache to args are passed

      Specified by:
      getDockerCacheTo in interface DockerImageAssetSource

    • getDockerFile

      public final String getDockerFile()
      Description copied from interface: DockerImageAssetSource
      Path to the Dockerfile (relative to the directory).

      Only allowed when directoryName is specified.

      Default: - no file

      Specified by:
      getDockerFile in interface DockerImageAssetSource

    • getDockerOutputs

      public final List<String> getDockerOutputs()
      Description copied from interface: DockerImageAssetSource
      Outputs to pass to the docker build command.

      Default: - no build args are passed

      Specified by:
      getDockerOutputs in interface DockerImageAssetSource

    • getExecutable

      public final List<String> getExecutable()
      Description copied from interface: DockerImageAssetSource
      An external command that will produce the packaged asset.

      The command should produce the name of a local Docker image on stdout.

      Default: - Exactly one of `directoryName` and `executable` is required

      Specified by:
      getExecutable in interface DockerImageAssetSource

    • getNetworkMode

      public final String getNetworkMode()
      Description copied from interface: DockerImageAssetSource
      Networking mode for the RUN commands during build. Requires Docker Engine API v1.25+.

      Specify this property to build images on a specific networking mode.

      Default: - no networking mode specified

      Specified by:
      getNetworkMode in interface DockerImageAssetSource

    • getPlatform

      public final String getPlatform()
      Description copied from interface: DockerImageAssetSource
      Platform to build for. Requires Docker Buildx.

      Specify this property to build images on a specific platform.

      Default: - no platform specified (the current machine architecture will be used)

      Specified by:
      getPlatform in interface DockerImageAssetSource

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object