RegistryImageBuild constructor
- Input<
List< ? additionalContexts,String> ?> - Input<
List< ? authConfigs,RegistryImageBuildAuthConfig> ?> - Input<
Map< ? buildArgs,String, String> ?> - Input<
String?> ? buildId, - Input<
String?> ? buildLogFile, - Input<
String?> ? builder, - Input<
List< ? cacheFroms,String> ?> - Input<
List< ? cacheTos,String> ?> - Input<
String?> ? cgroupParent, - required Input<
String> context, - Input<
int?> ? cpuPeriod, - Input<
int?> ? cpuQuota, - Input<
String?> ? cpuSetCpus, - Input<
String?> ? cpuSetMems, - Input<
String?> ? dockerfile, - Input<
List< ? extraHosts,String> ?> - Input<
bool?> ? forceRemove, - Input<
String?> ? isolation, - Input<
Map< ? label,String, String> ?> - Input<
Map< ? labels,String, String> ?> - Input<
int?> ? memory, - Input<
int?> ? memorySwap, - Input<
String?> ? networkMode, - Input<
bool?> ? noCache, - Input<
String?> ? platform, - Input<
String?> ? provenance, - Input<
bool?> ? pullParent, - Input<
String?> ? remoteContext, - Input<
bool?> ? remove, - Input<
String?> ? sbom, - Input<
List< ? secrets,RegistryImageBuildSecret> ?> - Input<
List< ? securityOpts,String> ?> - Input<
String?> ? sessionId, - Input<
int?> ? shmSize, - Input<
bool?> ? squash, - Input<
bool?> ? suppressOutput, - Input<
List< ? tags,String> ?> - Input<
String?> ? target, - Input<
List< ? ulimits,RegistryImageBuildUlimit> ?> - Input<
bool?> ? useLegacyBuilder, - Input<
String?> ? version,
Creates a new RegistryImageBuild.
additionalContexts A list of additional build contexts. Only supported when using a buildx builder. Example: ["name=path", "src = https://example.org"}. Please see https://docs.docker.com/reference/cli/docker/buildx/build/#build-context for more information.
authConfigs The configuration for the authentication
buildArgs Pairs for build-time variables in the form of ENDPOINT : "https://example.com"
buildId BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
buildLogFile Path to a file where the buildx log are written to. Only available when builder is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available.
builder The name of the buildx builder to use. If BUILDX_BUILDER environment variable is set, it will be used. If left empty, the provider tries to resolve to the default builder - which might not always work. If you are in Windows, the legacy builder is used.
cacheFroms External cache sources (e.g., user/app:cache, type=local,src=path/to/dir). Only supported when using a buildx builder.
cacheTos Cache export destinations (e.g., user/app:cache, type=local,dest=path/to/dir). Only supported when using a buildx builder.
cgroupParent Optional parent cgroup for the container
context Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
cpuPeriod The length of a CPU period in microseconds
cpuQuota Microseconds of CPU time that the container can get in a CPU period
cpuSetCpus CPUs in which to allow execution (e.g., 0-3, 0, 1)
cpuSetMems MEMs in which to allow execution (0-3, 0, 1)
cpuShares CPU shares (relative weight)
dockerfile Name of the Dockerfile. Defaults to Dockerfile.
extraHosts A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form "hostname:IP"
forceRemove Always remove intermediate containers
isolation Isolation represents the isolation technology of a container. The supported values are
label Set metadata for an image
labels User-defined key/value metadata
memory Set memory limit for build
memorySwap Total memory (memory + swap), -1 to enable unlimited swap
networkMode Set the networking mode for the RUN instructions during build
noCache Do not use the cache when building the image
platform Set the target platform for the build. Defaults to GOOS/GOARCH. For more information see the docker documentation
provenance Set provenance attestation for the build. BuildKit v0.11+ adds provenance attestations by default, which creates OCI image manifests that some registries (like AWS Lambda) don't support. Set to false to disable. Valid values: false, true, min, max, mode=min, mode=max, or a full provenance specification. Only available when using a buildx builder.
pullParent Attempt to pull the image even if an older image exists locally
remoteContext A Git repository URI or HTTP/HTTPS context URI. Will be ignored if builder is set.
remove Remove intermediate containers after a successful build. Defaults to true.
sbom Set SBOM (Software Bill of Materials) attestation for the build. Set to false to disable. Valid values: false, true, or a full SBOM specification. Only available when using a buildx builder.
secrets Set build-time secrets. Only available when you use a buildx builder.
securityOpts The security options
sessionId Set an ID for the build session
shmSize Size of /dev/shm in bytes. The size must be greater than 0
squash If true the new layers are squashed into a new image with a single new layer
suppressOutput Suppress the build output and print image ID on success
tags Name and optionally a tag in the 'name:tag' format
target Set the target build stage to build
ulimits Configuration for ulimits
useLegacyBuilder Force using the legacy Docker builder for image builds, even if buildx/buildkit would be available.
version Version of the underlying builder to use
Implementation
const RegistryImageBuild({
this.additionalContexts,
this.authConfigs,
this.buildArgs,
this.buildId,
this.buildLogFile,
this.builder,
this.cacheFroms,
this.cacheTos,
this.cgroupParent,
required this.context,
this.cpuPeriod,
this.cpuQuota,
this.cpuSetCpus,
this.cpuSetMems,
this.cpuShares,
this.dockerfile,
this.extraHosts,
this.forceRemove,
this.isolation,
this.label,
this.labels,
this.memory,
this.memorySwap,
this.networkMode,
this.noCache,
this.platform,
this.provenance,
this.pullParent,
this.remoteContext,
this.remove,
this.sbom,
this.secrets,
this.securityOpts,
this.sessionId,
this.shmSize,
this.squash,
this.suppressOutput,
this.tags,
this.target,
this.ulimits,
this.useLegacyBuilder,
this.version,
});