sam_oneal/pulumi-docker-build
1
0
Fork 0
Code Actions Packages Releases Wiki Activity

Regenerating Python SDK based on updated modules

Browse Source
This commit is contained in:
pulumi-bot
2025-07-24 12:57:50 +00:00
parent 591c008fb9
commit f50a7b191a
10 changed files with 1307 additions and 1314 deletions
Download Patch File Download Diff File Expand all files Collapse all files

295
sdk/python/pulumi_docker_build/image.py generated
View File

@@ -2,8 +2,7 @@
# *** WARNING: this file was generated by pulumi-language-python. ***
# *** Do not edit by hand unless you're certain you know what you are doing! ***
import builtins
import copy
import builtins as _builtins
import warnings
import sys
import pulumi
@@ -23,39 +22,39 @@ __all__ = ['ImageArgs', 'Image']
@pulumi.input_type
class ImageArgs:
def __init__(__self__, *,
push: pulumi.Input[builtins.bool],
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
push: pulumi.Input[_builtins.bool],
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
build_on_preview: Optional[pulumi.Input[_builtins.bool]] = None,
builder: Optional[pulumi.Input['BuilderConfigArgs']] = None,
cache_from: Optional[pulumi.Input[Sequence[pulumi.Input['CacheFromArgs']]]] = None,
cache_to: Optional[pulumi.Input[Sequence[pulumi.Input['CacheToArgs']]]] = None,
context: Optional[pulumi.Input['BuildContextArgs']] = None,
dockerfile: Optional[pulumi.Input['DockerfileArgs']] = None,
exec_: Optional[pulumi.Input[builtins.bool]] = None,
exec_: Optional[pulumi.Input[_builtins.bool]] = None,
exports: Optional[pulumi.Input[Sequence[pulumi.Input['ExportArgs']]]] = None,
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
load: Optional[pulumi.Input[builtins.bool]] = None,
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
load: Optional[pulumi.Input[_builtins.bool]] = None,
network: Optional[pulumi.Input['NetworkMode']] = None,
no_cache: Optional[pulumi.Input[builtins.bool]] = None,
no_cache: Optional[pulumi.Input[_builtins.bool]] = None,
platforms: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]] = None,
pull: Optional[pulumi.Input[builtins.bool]] = None,
pull: Optional[pulumi.Input[_builtins.bool]] = None,
registries: Optional[pulumi.Input[Sequence[pulumi.Input['RegistryArgs']]]] = None,
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
ssh: Optional[pulumi.Input[Sequence[pulumi.Input['SSHArgs']]]] = None,
tags: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
target: Optional[pulumi.Input[builtins.str]] = None):
tags: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
target: Optional[pulumi.Input[_builtins.str]] = None):
"""
The set of arguments for constructing a Image resource.
:param pulumi.Input[builtins.bool] push: When `true` the build will automatically include a `registry` export.
:param pulumi.Input[_builtins.bool] push: When `true` the build will automatically include a `registry` export.
Defaults to `false`.
Equivalent to Docker's `--push` flag.
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] add_hosts: Custom `host:ip` mappings to use during the build.
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] add_hosts: Custom `host:ip` mappings to use during the build.
Equivalent to Docker's `--add-host` flag.
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] build_args: `ARG` names and values to set during the build.
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] build_args: `ARG` names and values to set during the build.
These variables are accessed like environment variables inside `RUN`
instructions.
@@ -64,7 +63,7 @@ class ImageArgs:
if these arguments are sensitive.
Equivalent to Docker's `--build-arg` flag.
:param pulumi.Input[builtins.bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
:param pulumi.Input[_builtins.bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
and setting it to `true` will always build images during previews.
Images built during previews are never exported to registries, however
@@ -88,7 +87,7 @@ class ImageArgs:
:param pulumi.Input['DockerfileArgs'] dockerfile: Dockerfile settings.
Equivalent to Docker's `--file` flag.
:param pulumi.Input[builtins.bool] exec_: Use `exec` mode to build this image.
:param pulumi.Input[_builtins.bool] exec_: Use `exec` mode to build this image.
By default the provider embeds a v25 Docker client with v0.12 buildx
support. This helps ensure consistent behavior across environments and
@@ -117,10 +116,10 @@ class ImageArgs:
0.13 or later.
Equivalent to Docker's `--output` flag.
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: Attach arbitrary key/value metadata to the image.
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] labels: Attach arbitrary key/value metadata to the image.
Equivalent to Docker's `--label` flag.
:param pulumi.Input[builtins.bool] load: When `true` the build will automatically include a `docker` export.
:param pulumi.Input[_builtins.bool] load: When `true` the build will automatically include a `docker` export.
Defaults to `false`.
@@ -130,13 +129,13 @@ class ImageArgs:
For custom networks, configure your builder with `--driver-opt network=...`.
Equivalent to Docker's `--network` flag.
:param pulumi.Input[builtins.bool] no_cache: Do not import cache manifests when building the image.
:param pulumi.Input[_builtins.bool] no_cache: Do not import cache manifests when building the image.
Equivalent to Docker's `--no-cache` flag.
:param pulumi.Input[Sequence[pulumi.Input['Platform']]] platforms: Set target platform(s) for the build. Defaults to the host's platform.
Equivalent to Docker's `--platform` flag.
:param pulumi.Input[builtins.bool] pull: Always pull referenced images.
:param pulumi.Input[_builtins.bool] pull: Always pull referenced images.
Equivalent to Docker's `--pull` flag.
:param pulumi.Input[Sequence[pulumi.Input['RegistryArgs']]] registries: Registry credentials. Required if reading or exporting to private
@@ -146,7 +145,7 @@ class ImageArgs:
credentials on the host.
Similar to `docker login`.
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] secrets: A mapping of secret names to their corresponding values.
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] secrets: A mapping of secret names to their corresponding values.
Unlike the Docker CLI, these can be passed by value and do not need to
exist on-disk or in environment variables.
@@ -158,13 +157,13 @@ class ImageArgs:
:param pulumi.Input[Sequence[pulumi.Input['SSHArgs']]] ssh: SSH agent socket or keys to expose to the build.
Equivalent to Docker's `--ssh` flag.
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] tags: Name and optionally a tag (format: `name:tag`).
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] tags: Name and optionally a tag (format: `name:tag`).
If exporting to a registry, the name should include the fully qualified
registry address (e.g. `docker.io/pulumi/pulumi:latest`).
Equivalent to Docker's `--tag` flag.
:param pulumi.Input[builtins.str] target: Set the target build stage(s) to build.
:param pulumi.Input[_builtins.str] target: Set the target build stage(s) to build.
If not specified all targets will be built by default.
@@ -218,9 +217,9 @@ class ImageArgs:
if target is not None:
pulumi.set(__self__, "target", target)
@property
@_builtins.property
@pulumi.getter
def push(self) -> pulumi.Input[builtins.bool]:
def push(self) -> pulumi.Input[_builtins.bool]:
"""
When `true` the build will automatically include a `registry` export.
@@ -231,12 +230,12 @@ class ImageArgs:
return pulumi.get(self, "push")
@push.setter
def push(self, value: pulumi.Input[builtins.bool]):
def push(self, value: pulumi.Input[_builtins.bool]):
pulumi.set(self, "push", value)
@property
@_builtins.property
@pulumi.getter(name="addHosts")
def add_hosts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]:
def add_hosts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
"""
Custom `host:ip` mappings to use during the build.
@@ -245,12 +244,12 @@ class ImageArgs:
return pulumi.get(self, "add_hosts")
@add_hosts.setter
def add_hosts(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]):
def add_hosts(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
pulumi.set(self, "add_hosts", value)
@property
@_builtins.property
@pulumi.getter(name="buildArgs")
def build_args(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
def build_args(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
"""
`ARG` names and values to set during the build.
@@ -265,12 +264,12 @@ class ImageArgs:
return pulumi.get(self, "build_args")
@build_args.setter
def build_args(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
def build_args(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
pulumi.set(self, "build_args", value)
@property
@_builtins.property
@pulumi.getter(name="buildOnPreview")
def build_on_preview(self) -> Optional[pulumi.Input[builtins.bool]]:
def build_on_preview(self) -> Optional[pulumi.Input[_builtins.bool]]:
"""
Setting this to `false` will always skip image builds during previews,
and setting it to `true` will always build images during previews.
@@ -287,10 +286,10 @@ class ImageArgs:
return pulumi.get(self, "build_on_preview")
@build_on_preview.setter
def build_on_preview(self, value: Optional[pulumi.Input[builtins.bool]]):
def build_on_preview(self, value: Optional[pulumi.Input[_builtins.bool]]):
pulumi.set(self, "build_on_preview", value)
@property
@_builtins.property
@pulumi.getter
def builder(self) -> Optional[pulumi.Input['BuilderConfigArgs']]:
"""
@@ -302,7 +301,7 @@ class ImageArgs:
def builder(self, value: Optional[pulumi.Input['BuilderConfigArgs']]):
pulumi.set(self, "builder", value)
@property
@_builtins.property
@pulumi.getter(name="cacheFrom")
def cache_from(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CacheFromArgs']]]]:
"""
@@ -316,7 +315,7 @@ class ImageArgs:
def cache_from(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CacheFromArgs']]]]):
pulumi.set(self, "cache_from", value)
@property
@_builtins.property
@pulumi.getter(name="cacheTo")
def cache_to(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CacheToArgs']]]]:
"""
@@ -330,7 +329,7 @@ class ImageArgs:
def cache_to(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CacheToArgs']]]]):
pulumi.set(self, "cache_to", value)
@property
@_builtins.property
@pulumi.getter
def context(self) -> Optional[pulumi.Input['BuildContextArgs']]:
"""
@@ -344,7 +343,7 @@ class ImageArgs:
def context(self, value: Optional[pulumi.Input['BuildContextArgs']]):
pulumi.set(self, "context", value)
@property
@_builtins.property
@pulumi.getter
def dockerfile(self) -> Optional[pulumi.Input['DockerfileArgs']]:
"""
@@ -358,9 +357,9 @@ class ImageArgs:
def dockerfile(self, value: Optional[pulumi.Input['DockerfileArgs']]):
pulumi.set(self, "dockerfile", value)
@property
@_builtins.property
@pulumi.getter(name="exec")
def exec_(self) -> Optional[pulumi.Input[builtins.bool]]:
def exec_(self) -> Optional[pulumi.Input[_builtins.bool]]:
"""
Use `exec` mode to build this image.
@@ -386,10 +385,10 @@ class ImageArgs:
return pulumi.get(self, "exec_")
@exec_.setter
def exec_(self, value: Optional[pulumi.Input[builtins.bool]]):
def exec_(self, value: Optional[pulumi.Input[_builtins.bool]]):
pulumi.set(self, "exec_", value)
@property
@_builtins.property
@pulumi.getter
def exports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ExportArgs']]]]:
"""
@@ -409,9 +408,9 @@ class ImageArgs:
def exports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ExportArgs']]]]):
pulumi.set(self, "exports", value)
@property
@_builtins.property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
def labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
"""
Attach arbitrary key/value metadata to the image.
@@ -420,12 +419,12 @@ class ImageArgs:
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
def labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
pulumi.set(self, "labels", value)
@property
@_builtins.property
@pulumi.getter
def load(self) -> Optional[pulumi.Input[builtins.bool]]:
def load(self) -> Optional[pulumi.Input[_builtins.bool]]:
"""
When `true` the build will automatically include a `docker` export.
@@ -436,10 +435,10 @@ class ImageArgs:
return pulumi.get(self, "load")
@load.setter
def load(self, value: Optional[pulumi.Input[builtins.bool]]):
def load(self, value: Optional[pulumi.Input[_builtins.bool]]):
pulumi.set(self, "load", value)
@property
@_builtins.property
@pulumi.getter
def network(self) -> Optional[pulumi.Input['NetworkMode']]:
"""
@@ -455,9 +454,9 @@ class ImageArgs:
def network(self, value: Optional[pulumi.Input['NetworkMode']]):
pulumi.set(self, "network", value)
@property
@_builtins.property
@pulumi.getter(name="noCache")
def no_cache(self) -> Optional[pulumi.Input[builtins.bool]]:
def no_cache(self) -> Optional[pulumi.Input[_builtins.bool]]:
"""
Do not import cache manifests when building the image.
@@ -466,10 +465,10 @@ class ImageArgs:
return pulumi.get(self, "no_cache")
@no_cache.setter
def no_cache(self, value: Optional[pulumi.Input[builtins.bool]]):
def no_cache(self, value: Optional[pulumi.Input[_builtins.bool]]):
pulumi.set(self, "no_cache", value)
@property
@_builtins.property
@pulumi.getter
def platforms(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]]:
"""
@@ -483,9 +482,9 @@ class ImageArgs:
def platforms(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]]):
pulumi.set(self, "platforms", value)
@property
@_builtins.property
@pulumi.getter
def pull(self) -> Optional[pulumi.Input[builtins.bool]]:
def pull(self) -> Optional[pulumi.Input[_builtins.bool]]:
"""
Always pull referenced images.
@@ -494,10 +493,10 @@ class ImageArgs:
return pulumi.get(self, "pull")
@pull.setter
def pull(self, value: Optional[pulumi.Input[builtins.bool]]):
def pull(self, value: Optional[pulumi.Input[_builtins.bool]]):
pulumi.set(self, "pull", value)
@property
@_builtins.property
@pulumi.getter
def registries(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['RegistryArgs']]]]:
"""
@@ -515,9 +514,9 @@ class ImageArgs:
def registries(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['RegistryArgs']]]]):
pulumi.set(self, "registries", value)
@property
@_builtins.property
@pulumi.getter
def secrets(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
def secrets(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
"""
A mapping of secret names to their corresponding values.
@@ -532,10 +531,10 @@ class ImageArgs:
return pulumi.get(self, "secrets")
@secrets.setter
def secrets(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
def secrets(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
pulumi.set(self, "secrets", value)
@property
@_builtins.property
@pulumi.getter
def ssh(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SSHArgs']]]]:
"""
@@ -549,9 +548,9 @@ class ImageArgs:
def ssh(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SSHArgs']]]]):
pulumi.set(self, "ssh", value)
@property
@_builtins.property
@pulumi.getter
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]:
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
"""
Name and optionally a tag (format: `name:tag`).
@@ -563,12 +562,12 @@ class ImageArgs:
return pulumi.get(self, "tags")
@tags.setter
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]):
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
pulumi.set(self, "tags", value)
@property
@_builtins.property
@pulumi.getter
def target(self) -> Optional[pulumi.Input[builtins.str]]:
def target(self) -> Optional[pulumi.Input[_builtins.str]]:
"""
Set the target build stage(s) to build.
@@ -579,7 +578,7 @@ class ImageArgs:
return pulumi.get(self, "target")
@target.setter
def target(self, value: Optional[pulumi.Input[builtins.str]]):
def target(self, value: Optional[pulumi.Input[_builtins.str]]):
pulumi.set(self, "target", value)
@@ -589,28 +588,28 @@ class Image(pulumi.CustomResource):
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
build_on_preview: Optional[pulumi.Input[_builtins.bool]] = None,
builder: Optional[pulumi.Input[Union['BuilderConfigArgs', 'BuilderConfigArgsDict']]] = None,
cache_from: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheFromArgs', 'CacheFromArgsDict']]]]] = None,
cache_to: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheToArgs', 'CacheToArgsDict']]]]] = None,
context: Optional[pulumi.Input[Union['BuildContextArgs', 'BuildContextArgsDict']]] = None,
dockerfile: Optional[pulumi.Input[Union['DockerfileArgs', 'DockerfileArgsDict']]] = None,
exec_: Optional[pulumi.Input[builtins.bool]] = None,
exec_: Optional[pulumi.Input[_builtins.bool]] = None,
exports: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExportArgs', 'ExportArgsDict']]]]] = None,
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
load: Optional[pulumi.Input[builtins.bool]] = None,
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
load: Optional[pulumi.Input[_builtins.bool]] = None,
network: Optional[pulumi.Input['NetworkMode']] = None,
no_cache: Optional[pulumi.Input[builtins.bool]] = None,
no_cache: Optional[pulumi.Input[_builtins.bool]] = None,
platforms: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]] = None,
pull: Optional[pulumi.Input[builtins.bool]] = None,
push: Optional[pulumi.Input[builtins.bool]] = None,
pull: Optional[pulumi.Input[_builtins.bool]] = None,
push: Optional[pulumi.Input[_builtins.bool]] = None,
registries: Optional[pulumi.Input[Sequence[pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']]]]] = None,
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
ssh: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SSHArgs', 'SSHArgsDict']]]]] = None,
tags: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
target: Optional[pulumi.Input[builtins.str]] = None,
tags: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
target: Optional[pulumi.Input[_builtins.str]] = None,
__props__=None):
"""
A Docker image built using buildx -- Docker's interface to the improved
@@ -921,10 +920,10 @@ class Image(pulumi.CustomResource):
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] add_hosts: Custom `host:ip` mappings to use during the build.
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] add_hosts: Custom `host:ip` mappings to use during the build.
Equivalent to Docker's `--add-host` flag.
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] build_args: `ARG` names and values to set during the build.
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] build_args: `ARG` names and values to set during the build.
These variables are accessed like environment variables inside `RUN`
instructions.
@@ -933,7 +932,7 @@ class Image(pulumi.CustomResource):
if these arguments are sensitive.
Equivalent to Docker's `--build-arg` flag.
:param pulumi.Input[builtins.bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
:param pulumi.Input[_builtins.bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
and setting it to `true` will always build images during previews.
Images built during previews are never exported to registries, however
@@ -957,7 +956,7 @@ class Image(pulumi.CustomResource):
:param pulumi.Input[Union['DockerfileArgs', 'DockerfileArgsDict']] dockerfile: Dockerfile settings.
Equivalent to Docker's `--file` flag.
:param pulumi.Input[builtins.bool] exec_: Use `exec` mode to build this image.
:param pulumi.Input[_builtins.bool] exec_: Use `exec` mode to build this image.
By default the provider embeds a v25 Docker client with v0.12 buildx
support. This helps ensure consistent behavior across environments and
@@ -986,10 +985,10 @@ class Image(pulumi.CustomResource):
0.13 or later.
Equivalent to Docker's `--output` flag.
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: Attach arbitrary key/value metadata to the image.
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] labels: Attach arbitrary key/value metadata to the image.
Equivalent to Docker's `--label` flag.
:param pulumi.Input[builtins.bool] load: When `true` the build will automatically include a `docker` export.
:param pulumi.Input[_builtins.bool] load: When `true` the build will automatically include a `docker` export.
Defaults to `false`.
@@ -999,16 +998,16 @@ class Image(pulumi.CustomResource):
For custom networks, configure your builder with `--driver-opt network=...`.
Equivalent to Docker's `--network` flag.
:param pulumi.Input[builtins.bool] no_cache: Do not import cache manifests when building the image.
:param pulumi.Input[_builtins.bool] no_cache: Do not import cache manifests when building the image.
Equivalent to Docker's `--no-cache` flag.
:param pulumi.Input[Sequence[pulumi.Input['Platform']]] platforms: Set target platform(s) for the build. Defaults to the host's platform.
Equivalent to Docker's `--platform` flag.
:param pulumi.Input[builtins.bool] pull: Always pull referenced images.
:param pulumi.Input[_builtins.bool] pull: Always pull referenced images.
Equivalent to Docker's `--pull` flag.
:param pulumi.Input[builtins.bool] push: When `true` the build will automatically include a `registry` export.
:param pulumi.Input[_builtins.bool] push: When `true` the build will automatically include a `registry` export.
Defaults to `false`.
@@ -1020,7 +1019,7 @@ class Image(pulumi.CustomResource):
credentials on the host.
Similar to `docker login`.
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] secrets: A mapping of secret names to their corresponding values.
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] secrets: A mapping of secret names to their corresponding values.
Unlike the Docker CLI, these can be passed by value and do not need to
exist on-disk or in environment variables.
@@ -1032,13 +1031,13 @@ class Image(pulumi.CustomResource):
:param pulumi.Input[Sequence[pulumi.Input[Union['SSHArgs', 'SSHArgsDict']]]] ssh: SSH agent socket or keys to expose to the build.
Equivalent to Docker's `--ssh` flag.
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] tags: Name and optionally a tag (format: `name:tag`).
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] tags: Name and optionally a tag (format: `name:tag`).
If exporting to a registry, the name should include the fully qualified
registry address (e.g. `docker.io/pulumi/pulumi:latest`).
Equivalent to Docker's `--tag` flag.
:param pulumi.Input[builtins.str] target: Set the target build stage(s) to build.
:param pulumi.Input[_builtins.str] target: Set the target build stage(s) to build.
If not specified all targets will be built by default.
@@ -1372,28 +1371,28 @@ class Image(pulumi.CustomResource):
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
build_on_preview: Optional[pulumi.Input[_builtins.bool]] = None,
builder: Optional[pulumi.Input[Union['BuilderConfigArgs', 'BuilderConfigArgsDict']]] = None,
cache_from: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheFromArgs', 'CacheFromArgsDict']]]]] = None,
cache_to: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheToArgs', 'CacheToArgsDict']]]]] = None,
context: Optional[pulumi.Input[Union['BuildContextArgs', 'BuildContextArgsDict']]] = None,
dockerfile: Optional[pulumi.Input[Union['DockerfileArgs', 'DockerfileArgsDict']]] = None,
exec_: Optional[pulumi.Input[builtins.bool]] = None,
exec_: Optional[pulumi.Input[_builtins.bool]] = None,
exports: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExportArgs', 'ExportArgsDict']]]]] = None,
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
load: Optional[pulumi.Input[builtins.bool]] = None,
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
load: Optional[pulumi.Input[_builtins.bool]] = None,
network: Optional[pulumi.Input['NetworkMode']] = None,
no_cache: Optional[pulumi.Input[builtins.bool]] = None,
no_cache: Optional[pulumi.Input[_builtins.bool]] = None,
platforms: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]] = None,
pull: Optional[pulumi.Input[builtins.bool]] = None,
push: Optional[pulumi.Input[builtins.bool]] = None,
pull: Optional[pulumi.Input[_builtins.bool]] = None,
push: Optional[pulumi.Input[_builtins.bool]] = None,
registries: Optional[pulumi.Input[Sequence[pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']]]]] = None,
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
ssh: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SSHArgs', 'SSHArgsDict']]]]] = None,
tags: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
target: Optional[pulumi.Input[builtins.str]] = None,
tags: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
target: Optional[pulumi.Input[_builtins.str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
@@ -1483,9 +1482,9 @@ class Image(pulumi.CustomResource):
__props__.__dict__["target"] = None
return Image(resource_name, opts=opts, __props__=__props__)
@property
@_builtins.property
@pulumi.getter(name="addHosts")
def add_hosts(self) -> pulumi.Output[Optional[Sequence[builtins.str]]]:
def add_hosts(self) -> pulumi.Output[Optional[Sequence[_builtins.str]]]:
"""
Custom `host:ip` mappings to use during the build.
@@ -1493,9 +1492,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "add_hosts")
@property
@_builtins.property
@pulumi.getter(name="buildArgs")
def build_args(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
def build_args(self) -> pulumi.Output[Optional[Mapping[str, _builtins.str]]]:
"""
`ARG` names and values to set during the build.
@@ -1509,9 +1508,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "build_args")
@property
@_builtins.property
@pulumi.getter(name="buildOnPreview")
def build_on_preview(self) -> pulumi.Output[Optional[builtins.bool]]:
def build_on_preview(self) -> pulumi.Output[Optional[_builtins.bool]]:
"""
Setting this to `false` will always skip image builds during previews,
and setting it to `true` will always build images during previews.
@@ -1527,7 +1526,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "build_on_preview")
@property
@_builtins.property
@pulumi.getter
def builder(self) -> pulumi.Output[Optional['outputs.BuilderConfig']]:
"""
@@ -1535,7 +1534,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "builder")
@property
@_builtins.property
@pulumi.getter(name="cacheFrom")
def cache_from(self) -> pulumi.Output[Optional[Sequence['outputs.CacheFrom']]]:
"""
@@ -1545,7 +1544,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "cache_from")
@property
@_builtins.property
@pulumi.getter(name="cacheTo")
def cache_to(self) -> pulumi.Output[Optional[Sequence['outputs.CacheTo']]]:
"""
@@ -1555,7 +1554,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "cache_to")
@property
@_builtins.property
@pulumi.getter
def context(self) -> pulumi.Output[Optional['outputs.BuildContext']]:
"""
@@ -1565,9 +1564,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "context")
@property
@_builtins.property
@pulumi.getter(name="contextHash")
def context_hash(self) -> pulumi.Output[builtins.str]:
def context_hash(self) -> pulumi.Output[_builtins.str]:
"""
A preliminary hash of the image's build context.
@@ -1575,9 +1574,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "context_hash")
@property
@_builtins.property
@pulumi.getter
def digest(self) -> pulumi.Output[builtins.str]:
def digest(self) -> pulumi.Output[_builtins.str]:
"""
A SHA256 digest of the image if it was exported to a registry or
elsewhere.
@@ -1589,7 +1588,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "digest")
@property
@_builtins.property
@pulumi.getter
def dockerfile(self) -> pulumi.Output[Optional['outputs.Dockerfile']]:
"""
@@ -1599,9 +1598,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "dockerfile")
@property
@_builtins.property
@pulumi.getter(name="exec")
def exec_(self) -> pulumi.Output[Optional[builtins.bool]]:
def exec_(self) -> pulumi.Output[Optional[_builtins.bool]]:
"""
Use `exec` mode to build this image.
@@ -1626,7 +1625,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "exec_")
@property
@_builtins.property
@pulumi.getter
def exports(self) -> pulumi.Output[Optional[Sequence['outputs.Export']]]:
"""
@@ -1642,9 +1641,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "exports")
@property
@_builtins.property
@pulumi.getter
def labels(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
def labels(self) -> pulumi.Output[Optional[Mapping[str, _builtins.str]]]:
"""
Attach arbitrary key/value metadata to the image.
@@ -1652,9 +1651,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "labels")
@property
@_builtins.property
@pulumi.getter
def load(self) -> pulumi.Output[Optional[builtins.bool]]:
def load(self) -> pulumi.Output[Optional[_builtins.bool]]:
"""
When `true` the build will automatically include a `docker` export.
@@ -1664,7 +1663,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "load")
@property
@_builtins.property
@pulumi.getter
def network(self) -> pulumi.Output[Optional['NetworkMode']]:
"""
@@ -1676,9 +1675,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "network")
@property
@_builtins.property
@pulumi.getter(name="noCache")
def no_cache(self) -> pulumi.Output[Optional[builtins.bool]]:
def no_cache(self) -> pulumi.Output[Optional[_builtins.bool]]:
"""
Do not import cache manifests when building the image.
@@ -1686,7 +1685,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "no_cache")
@property
@_builtins.property
@pulumi.getter
def platforms(self) -> pulumi.Output[Optional[Sequence['Platform']]]:
"""
@@ -1696,9 +1695,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "platforms")
@property
@_builtins.property
@pulumi.getter
def pull(self) -> pulumi.Output[Optional[builtins.bool]]:
def pull(self) -> pulumi.Output[Optional[_builtins.bool]]:
"""
Always pull referenced images.
@@ -1706,9 +1705,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "pull")
@property
@_builtins.property
@pulumi.getter
def push(self) -> pulumi.Output[builtins.bool]:
def push(self) -> pulumi.Output[_builtins.bool]:
"""
When `true` the build will automatically include a `registry` export.
@@ -1718,9 +1717,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "push")
@property
@_builtins.property
@pulumi.getter
def ref(self) -> pulumi.Output[builtins.str]:
def ref(self) -> pulumi.Output[_builtins.str]:
"""
If the image was pushed to any registries then this will contain a
single fully-qualified tag including the build's digest.
@@ -1739,7 +1738,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "ref")
@property
@_builtins.property
@pulumi.getter
def registries(self) -> pulumi.Output[Optional[Sequence['outputs.Registry']]]:
"""
@@ -1753,9 +1752,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "registries")
@property
@_builtins.property
@pulumi.getter
def secrets(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
def secrets(self) -> pulumi.Output[Optional[Mapping[str, _builtins.str]]]:
"""
A mapping of secret names to their corresponding values.
@@ -1769,7 +1768,7 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "secrets")
@property
@_builtins.property
@pulumi.getter
def ssh(self) -> pulumi.Output[Optional[Sequence['outputs.SSH']]]:
"""
@@ -1779,9 +1778,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "ssh")
@property
@_builtins.property
@pulumi.getter
def tags(self) -> pulumi.Output[Optional[Sequence[builtins.str]]]:
def tags(self) -> pulumi.Output[Optional[Sequence[_builtins.str]]]:
"""
Name and optionally a tag (format: `name:tag`).
@@ -1792,9 +1791,9 @@ class Image(pulumi.CustomResource):
"""
return pulumi.get(self, "tags")
@property
@_builtins.property
@pulumi.getter
def target(self) -> pulumi.Output[Optional[builtins.str]]:
def target(self) -> pulumi.Output[Optional[_builtins.str]]:
"""
Set the target build stage(s) to build.