Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Docker Provider
  3. API Docs
  4. RemoteImage
Docker v4.5.6 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-docker

docker.RemoteImage

Explore with Pulumi AI

docker logo
Docker v4.5.6 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-docker

    Pulls a Docker image to a given Docker host from a Docker Registry. This resource will not pull new layers of the image automatically unless used in conjunction with docker.RegistryImage data source to update the pull_triggers field.

    Example Usage

    Basic

    Finds and downloads the latest ubuntu:precise image but does not check for further updates of the image

    import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const ubuntu = new docker.RemoteImage("ubuntu", {name: "ubuntu:precise"});

    import pulumi
import pulumi_docker as docker

ubuntu = docker.RemoteImage("ubuntu", name="ubuntu:precise")

    package main

import (
	"github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docker.NewRemoteImage(ctx, "ubuntu", &docker.RemoteImageArgs{
			Name: pulumi.String("ubuntu:precise"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;

return await Deployment.RunAsync(() => 
{
    var ubuntu = new Docker.RemoteImage("ubuntu", new()
    {
        Name = "ubuntu:precise",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.RemoteImage;
import com.pulumi.docker.RemoteImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var ubuntu = new RemoteImage("ubuntu", RemoteImageArgs.builder()
            .name("ubuntu:precise")
            .build());

    }
}

    resources:
  ubuntu:
    type: docker:RemoteImage
    properties:
      name: ubuntu:precise

    Dynamic updates

    To be able to update an image dynamically when the sha256 sum changes, you need to use it in combination with docker.RegistryImage as follows:

    import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const ubuntu = docker.getRegistryImage({
    name: "ubuntu:precise",
});
const ubuntuRemoteImage = new docker.RemoteImage("ubuntu", {
    name: ubuntu.then(ubuntu => ubuntu.name),
    pullTriggers: [ubuntu.then(ubuntu => ubuntu.sha256Digest)],
});

    import pulumi
import pulumi_docker as docker

ubuntu = docker.get_registry_image(name="ubuntu:precise")
ubuntu_remote_image = docker.RemoteImage("ubuntu",
    name=ubuntu.name,
    pull_triggers=[ubuntu.sha256_digest])

    package main

import (
	"github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ubuntu, err := docker.LookupRegistryImage(ctx, &docker.LookupRegistryImageArgs{
			Name: "ubuntu:precise",
		}, nil)
		if err != nil {
			return err
		}
		_, err = docker.NewRemoteImage(ctx, "ubuntu", &docker.RemoteImageArgs{
			Name: pulumi.String(ubuntu.Name),
			PullTriggers: pulumi.StringArray{
				pulumi.String(ubuntu.Sha256Digest),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;

return await Deployment.RunAsync(() => 
{
    var ubuntu = Docker.GetRegistryImage.Invoke(new()
    {
        Name = "ubuntu:precise",
    });

    var ubuntuRemoteImage = new Docker.RemoteImage("ubuntu", new()
    {
        Name = ubuntu.Apply(getRegistryImageResult => getRegistryImageResult.Name),
        PullTriggers = new[]
        {
            ubuntu.Apply(getRegistryImageResult => getRegistryImageResult.Sha256Digest),
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.DockerFunctions;
import com.pulumi.docker.inputs.GetRegistryImageArgs;
import com.pulumi.docker.RemoteImage;
import com.pulumi.docker.RemoteImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var ubuntu = DockerFunctions.getRegistryImage(GetRegistryImageArgs.builder()
            .name("ubuntu:precise")
            .build());

        var ubuntuRemoteImage = new RemoteImage("ubuntuRemoteImage", RemoteImageArgs.builder()
            .name(ubuntu.applyValue(getRegistryImageResult -> getRegistryImageResult.name()))
            .pullTriggers(ubuntu.applyValue(getRegistryImageResult -> getRegistryImageResult.sha256Digest()))
            .build());

    }
}

    resources:
  ubuntuRemoteImage:
    type: docker:RemoteImage
    name: ubuntu
    properties:
      name: ${ubuntu.name}
      pullTriggers:
        - ${ubuntu.sha256Digest}
variables:
  ubuntu:
    fn::invoke:
      Function: docker:getRegistryImage
      Arguments:
        name: ubuntu:precise

    Build

    You can also use the resource to build an image. In this case the image “zoo” and “zoo:develop” are built.

    import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const zoo = new docker.RemoteImage("zoo", {
    name: "zoo",
    build: {
        context: ".",
        tags: ["zoo:develop"],
        buildArg: {
            foo: "zoo",
        },
        label: {
            author: "zoo",
        },
    },
});

    import pulumi
import pulumi_docker as docker

zoo = docker.RemoteImage("zoo",
    name="zoo",
    build={
        "context": ".",
        "tags": ["zoo:develop"],
        "build_arg": {
            "foo": "zoo",
        },
        "label": {
            "author": "zoo",
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docker.NewRemoteImage(ctx, "zoo", &docker.RemoteImageArgs{
			Name: pulumi.String("zoo"),
			Build: &docker.RemoteImageBuildArgs{
				Context: pulumi.String("."),
				Tags: pulumi.StringArray{
					pulumi.String("zoo:develop"),
				},
				BuildArg: pulumi.StringMap{
					"foo": pulumi.String("zoo"),
				},
				Label: pulumi.StringMap{
					"author": pulumi.String("zoo"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;

return await Deployment.RunAsync(() => 
{
    var zoo = new Docker.RemoteImage("zoo", new()
    {
        Name = "zoo",
        Build = new Docker.Inputs.RemoteImageBuildArgs
        {
            Context = ".",
            Tags = new[]
            {
                "zoo:develop",
            },
            BuildArg = 
            {
                { "foo", "zoo" },
            },
            Label = 
            {
                { "author", "zoo" },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.RemoteImage;
import com.pulumi.docker.RemoteImageArgs;
import com.pulumi.docker.inputs.RemoteImageBuildArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var zoo = new RemoteImage("zoo", RemoteImageArgs.builder()
            .name("zoo")
            .build(RemoteImageBuildArgs.builder()
                .context(".")
                .tags("zoo:develop")
                .buildArg(Map.of("foo", "zoo"))
                .label(Map.of("author", "zoo"))
                .build())
            .build());

    }
}

    resources:
  zoo:
    type: docker:RemoteImage
    properties:
      name: zoo
      build:
        context: .
        tags:
          - zoo:develop
        buildArg:
          foo: zoo
        label:
          author: zoo

    You can use the triggers argument to specify when the image should be rebuild. This is for example helpful when you want to rebuild the docker image whenever the source code changes.

    Create RemoteImage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RemoteImage(name: string, args: RemoteImageArgs, opts?: CustomResourceOptions);
    @overload
def RemoteImage(resource_name: str,
                args: RemoteImageArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def RemoteImage(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                name: Optional[str] = None,
                build: Optional[RemoteImageBuildArgs] = None,
                force_remove: Optional[bool] = None,
                keep_locally: Optional[bool] = None,
                platform: Optional[str] = None,
                pull_triggers: Optional[Sequence[str]] = None,
                triggers: Optional[Mapping[str, str]] = None)
    func NewRemoteImage(ctx *Context, name string, args RemoteImageArgs, opts ...ResourceOption) (*RemoteImage, error)
    public RemoteImage(string name, RemoteImageArgs args, CustomResourceOptions? opts = null)
    public RemoteImage(String name, RemoteImageArgs args)
public RemoteImage(String name, RemoteImageArgs args, CustomResourceOptions options)

    type: docker:RemoteImage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RemoteImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RemoteImageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RemoteImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RemoteImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RemoteImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var remoteImageResource = new Docker.RemoteImage("remoteImageResource", new()
{
    Name = "string",
    Build = new Docker.Inputs.RemoteImageBuildArgs
    {
        Context = "string",
        Label = 
        {
            { "string", "string" },
        },
        CpuQuota = 0,
        BuildId = "string",
        CacheFroms = new[]
        {
            "string",
        },
        Labels = 
        {
            { "string", "string" },
        },
        BuildArg = 
        {
            { "string", "string" },
        },
        CpuPeriod = 0,
        Memory = 0,
        CpuSetCpus = "string",
        MemorySwap = 0,
        CpuShares = 0,
        Dockerfile = "string",
        ExtraHosts = new[]
        {
            "string",
        },
        ForceRemove = false,
        Isolation = "string",
        AuthConfigs = new[]
        {
            new Docker.Inputs.RemoteImageBuildAuthConfigArgs
            {
                HostName = "string",
                Auth = "string",
                Email = "string",
                IdentityToken = "string",
                Password = "string",
                RegistryToken = "string",
                ServerAddress = "string",
                UserName = "string",
            },
        },
        CgroupParent = "string",
        BuildArgs = 
        {
            { "string", "string" },
        },
        CpuSetMems = "string",
        NetworkMode = "string",
        NoCache = false,
        Platform = "string",
        PullParent = false,
        RemoteContext = "string",
        Remove = false,
        SecurityOpts = new[]
        {
            "string",
        },
        SessionId = "string",
        ShmSize = 0,
        Squash = false,
        SuppressOutput = false,
        Tags = new[]
        {
            "string",
        },
        Target = "string",
        Ulimits = new[]
        {
            new Docker.Inputs.RemoteImageBuildUlimitArgs
            {
                Hard = 0,
                Name = "string",
                Soft = 0,
            },
        },
        Version = "string",
    },
    ForceRemove = false,
    KeepLocally = false,
    Platform = "string",
    PullTriggers = new[]
    {
        "string",
    },
    Triggers = 
    {
        { "string", "string" },
    },
});

    example, err := docker.NewRemoteImage(ctx, "remoteImageResource", &docker.RemoteImageArgs{
	Name: pulumi.String("string"),
	Build: &docker.RemoteImageBuildArgs{
		Context: pulumi.String("string"),
		Label: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		CpuQuota: pulumi.Int(0),
		BuildId:  pulumi.String("string"),
		CacheFroms: pulumi.StringArray{
			pulumi.String("string"),
		},
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		BuildArg: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		CpuPeriod:  pulumi.Int(0),
		Memory:     pulumi.Int(0),
		CpuSetCpus: pulumi.String("string"),
		MemorySwap: pulumi.Int(0),
		CpuShares:  pulumi.Int(0),
		Dockerfile: pulumi.String("string"),
		ExtraHosts: pulumi.StringArray{
			pulumi.String("string"),
		},
		ForceRemove: pulumi.Bool(false),
		Isolation:   pulumi.String("string"),
		AuthConfigs: docker.RemoteImageBuildAuthConfigArray{
			&docker.RemoteImageBuildAuthConfigArgs{
				HostName:      pulumi.String("string"),
				Auth:          pulumi.String("string"),
				Email:         pulumi.String("string"),
				IdentityToken: pulumi.String("string"),
				Password:      pulumi.String("string"),
				RegistryToken: pulumi.String("string"),
				ServerAddress: pulumi.String("string"),
				UserName:      pulumi.String("string"),
			},
		},
		CgroupParent: pulumi.String("string"),
		BuildArgs: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		CpuSetMems:    pulumi.String("string"),
		NetworkMode:   pulumi.String("string"),
		NoCache:       pulumi.Bool(false),
		Platform:      pulumi.String("string"),
		PullParent:    pulumi.Bool(false),
		RemoteContext: pulumi.String("string"),
		Remove:        pulumi.Bool(false),
		SecurityOpts: pulumi.StringArray{
			pulumi.String("string"),
		},
		SessionId:      pulumi.String("string"),
		ShmSize:        pulumi.Int(0),
		Squash:         pulumi.Bool(false),
		SuppressOutput: pulumi.Bool(false),
		Tags: pulumi.StringArray{
			pulumi.String("string"),
		},
		Target: pulumi.String("string"),
		Ulimits: docker.RemoteImageBuildUlimitArray{
			&docker.RemoteImageBuildUlimitArgs{
				Hard: pulumi.Int(0),
				Name: pulumi.String("string"),
				Soft: pulumi.Int(0),
			},
		},
		Version: pulumi.String("string"),
	},
	ForceRemove: pulumi.Bool(false),
	KeepLocally: pulumi.Bool(false),
	Platform:    pulumi.String("string"),
	PullTriggers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Triggers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var remoteImageResource = new RemoteImage("remoteImageResource", RemoteImageArgs.builder()
    .name("string")
    .build(RemoteImageBuildArgs.builder()
        .context("string")
        .label(Map.of("string", "string"))
        .cpuQuota(0)
        .buildId("string")
        .cacheFroms("string")
        .labels(Map.of("string", "string"))
        .buildArg(Map.of("string", "string"))
        .cpuPeriod(0)
        .memory(0)
        .cpuSetCpus("string")
        .memorySwap(0)
        .cpuShares(0)
        .dockerfile("string")
        .extraHosts("string")
        .forceRemove(false)
        .isolation("string")
        .authConfigs(RemoteImageBuildAuthConfigArgs.builder()
            .hostName("string")
            .auth("string")
            .email("string")
            .identityToken("string")
            .password("string")
            .registryToken("string")
            .serverAddress("string")
            .userName("string")
            .build())
        .cgroupParent("string")
        .buildArgs(Map.of("string", "string"))
        .cpuSetMems("string")
        .networkMode("string")
        .noCache(false)
        .platform("string")
        .pullParent(false)
        .remoteContext("string")
        .remove(false)
        .securityOpts("string")
        .sessionId("string")
        .shmSize(0)
        .squash(false)
        .suppressOutput(false)
        .tags("string")
        .target("string")
        .ulimits(RemoteImageBuildUlimitArgs.builder()
            .hard(0)
            .name("string")
            .soft(0)
            .build())
        .version("string")
        .build())
    .forceRemove(false)
    .keepLocally(false)
    .platform("string")
    .pullTriggers("string")
    .triggers(Map.of("string", "string"))
    .build());

    remote_image_resource = docker.RemoteImage("remoteImageResource",
    name="string",
    build={
        "context": "string",
        "label": {
            "string": "string",
        },
        "cpu_quota": 0,
        "build_id": "string",
        "cache_froms": ["string"],
        "labels": {
            "string": "string",
        },
        "build_arg": {
            "string": "string",
        },
        "cpu_period": 0,
        "memory": 0,
        "cpu_set_cpus": "string",
        "memory_swap": 0,
        "cpu_shares": 0,
        "dockerfile": "string",
        "extra_hosts": ["string"],
        "force_remove": False,
        "isolation": "string",
        "auth_configs": [{
            "host_name": "string",
            "auth": "string",
            "email": "string",
            "identity_token": "string",
            "password": "string",
            "registry_token": "string",
            "server_address": "string",
            "user_name": "string",
        }],
        "cgroup_parent": "string",
        "build_args": {
            "string": "string",
        },
        "cpu_set_mems": "string",
        "network_mode": "string",
        "no_cache": False,
        "platform": "string",
        "pull_parent": False,
        "remote_context": "string",
        "remove": False,
        "security_opts": ["string"],
        "session_id": "string",
        "shm_size": 0,
        "squash": False,
        "suppress_output": False,
        "tags": ["string"],
        "target": "string",
        "ulimits": [{
            "hard": 0,
            "name": "string",
            "soft": 0,
        }],
        "version": "string",
    },
    force_remove=False,
    keep_locally=False,
    platform="string",
    pull_triggers=["string"],
    triggers={
        "string": "string",
    })

    const remoteImageResource = new docker.RemoteImage("remoteImageResource", {
    name: "string",
    build: {
        context: "string",
        label: {
            string: "string",
        },
        cpuQuota: 0,
        buildId: "string",
        cacheFroms: ["string"],
        labels: {
            string: "string",
        },
        buildArg: {
            string: "string",
        },
        cpuPeriod: 0,
        memory: 0,
        cpuSetCpus: "string",
        memorySwap: 0,
        cpuShares: 0,
        dockerfile: "string",
        extraHosts: ["string"],
        forceRemove: false,
        isolation: "string",
        authConfigs: [{
            hostName: "string",
            auth: "string",
            email: "string",
            identityToken: "string",
            password: "string",
            registryToken: "string",
            serverAddress: "string",
            userName: "string",
        }],
        cgroupParent: "string",
        buildArgs: {
            string: "string",
        },
        cpuSetMems: "string",
        networkMode: "string",
        noCache: false,
        platform: "string",
        pullParent: false,
        remoteContext: "string",
        remove: false,
        securityOpts: ["string"],
        sessionId: "string",
        shmSize: 0,
        squash: false,
        suppressOutput: false,
        tags: ["string"],
        target: "string",
        ulimits: [{
            hard: 0,
            name: "string",
            soft: 0,
        }],
        version: "string",
    },
    forceRemove: false,
    keepLocally: false,
    platform: "string",
    pullTriggers: ["string"],
    triggers: {
        string: "string",
    },
});

    type: docker:RemoteImage
properties:
    build:
        authConfigs:
            - auth: string
              email: string
              hostName: string
              identityToken: string
              password: string
              registryToken: string
              serverAddress: string
              userName: string
        buildArg:
            string: string
        buildArgs:
            string: string
        buildId: string
        cacheFroms:
            - string
        cgroupParent: string
        context: string
        cpuPeriod: 0
        cpuQuota: 0
        cpuSetCpus: string
        cpuSetMems: string
        cpuShares: 0
        dockerfile: string
        extraHosts:
            - string
        forceRemove: false
        isolation: string
        label:
            string: string
        labels:
            string: string
        memory: 0
        memorySwap: 0
        networkMode: string
        noCache: false
        platform: string
        pullParent: false
        remoteContext: string
        remove: false
        securityOpts:
            - string
        sessionId: string
        shmSize: 0
        squash: false
        suppressOutput: false
        tags:
            - string
        target: string
        ulimits:
            - hard: 0
              name: string
              soft: 0
        version: string
    forceRemove: false
    keepLocally: false
    name: string
    platform: string
    pullTriggers:
        - string
    triggers:
        string: string

    RemoteImage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RemoteImage resource accepts the following input properties:

    Name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    Build RemoteImageBuild
    Configuration to build an image. Please see docker build command reference too.
    ForceRemove bool
    If true, then the image is removed forcibly when the resource is destroyed.
    KeepLocally bool
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    Platform string
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    PullTriggers List<string>
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    Triggers Dictionary<string, string>
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    Name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    Build RemoteImageBuildArgs
    Configuration to build an image. Please see docker build command reference too.
    ForceRemove bool
    If true, then the image is removed forcibly when the resource is destroyed.
    KeepLocally bool
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    Platform string
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    PullTriggers []string
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    Triggers map[string]string
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    name String
    The name of the Docker image, including any tags or SHA256 repo digests.
    build RemoteImageBuild
    Configuration to build an image. Please see docker build command reference too.
    forceRemove Boolean
    If true, then the image is removed forcibly when the resource is destroyed.
    keepLocally Boolean
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    platform String
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pullTriggers List<String>
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    triggers Map<String,String>
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    build RemoteImageBuild
    Configuration to build an image. Please see docker build command reference too.
    forceRemove boolean
    If true, then the image is removed forcibly when the resource is destroyed.
    keepLocally boolean
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    platform string
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pullTriggers string[]
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    triggers {[key: string]: string}
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    name str
    The name of the Docker image, including any tags or SHA256 repo digests.
    build RemoteImageBuildArgs
    Configuration to build an image. Please see docker build command reference too.
    force_remove bool
    If true, then the image is removed forcibly when the resource is destroyed.
    keep_locally bool
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    platform str
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pull_triggers Sequence[str]
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    triggers Mapping[str, str]
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    name String
    The name of the Docker image, including any tags or SHA256 repo digests.
    build Property Map
    Configuration to build an image. Please see docker build command reference too.
    forceRemove Boolean
    If true, then the image is removed forcibly when the resource is destroyed.
    keepLocally Boolean
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    platform String
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pullTriggers List<String>
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    triggers Map<String>
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RemoteImage resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    RepoDigest string
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    RepoDigest string
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    repoDigest String
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    repoDigest string
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    repo_digest str
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    repoDigest String
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.

    Look up Existing RemoteImage Resource

    Get an existing RemoteImage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RemoteImageState, opts?: CustomResourceOptions): RemoteImage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        build: Optional[RemoteImageBuildArgs] = None,
        force_remove: Optional[bool] = None,
        image_id: Optional[str] = None,
        keep_locally: Optional[bool] = None,
        name: Optional[str] = None,
        platform: Optional[str] = None,
        pull_triggers: Optional[Sequence[str]] = None,
        repo_digest: Optional[str] = None,
        triggers: Optional[Mapping[str, str]] = None) -> RemoteImage
    func GetRemoteImage(ctx *Context, name string, id IDInput, state *RemoteImageState, opts ...ResourceOption) (*RemoteImage, error)
    public static RemoteImage Get(string name, Input<string> id, RemoteImageState? state, CustomResourceOptions? opts = null)
    public static RemoteImage get(String name, Output<String> id, RemoteImageState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Build RemoteImageBuild
    Configuration to build an image. Please see docker build command reference too.
    ForceRemove bool
    If true, then the image is removed forcibly when the resource is destroyed.
    ImageId string
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    KeepLocally bool
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    Name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    Platform string
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    PullTriggers List<string>
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    RepoDigest string
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    Triggers Dictionary<string, string>
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    Build RemoteImageBuildArgs
    Configuration to build an image. Please see docker build command reference too.
    ForceRemove bool
    If true, then the image is removed forcibly when the resource is destroyed.
    ImageId string
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    KeepLocally bool
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    Name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    Platform string
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    PullTriggers []string
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    RepoDigest string
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    Triggers map[string]string
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    build RemoteImageBuild
    Configuration to build an image. Please see docker build command reference too.
    forceRemove Boolean
    If true, then the image is removed forcibly when the resource is destroyed.
    imageId String
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    keepLocally Boolean
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    name String
    The name of the Docker image, including any tags or SHA256 repo digests.
    platform String
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pullTriggers List<String>
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    repoDigest String
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    triggers Map<String,String>
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    build RemoteImageBuild
    Configuration to build an image. Please see docker build command reference too.
    forceRemove boolean
    If true, then the image is removed forcibly when the resource is destroyed.
    imageId string
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    keepLocally boolean
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    platform string
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pullTriggers string[]
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    repoDigest string
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    triggers {[key: string]: string}
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    build RemoteImageBuildArgs
    Configuration to build an image. Please see docker build command reference too.
    force_remove bool
    If true, then the image is removed forcibly when the resource is destroyed.
    image_id str
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    keep_locally bool
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    name str
    The name of the Docker image, including any tags or SHA256 repo digests.
    platform str
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pull_triggers Sequence[str]
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    repo_digest str
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    triggers Mapping[str, str]
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
    build Property Map
    Configuration to build an image. Please see docker build command reference too.
    forceRemove Boolean
    If true, then the image is removed forcibly when the resource is destroyed.
    imageId String
    The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
    keepLocally Boolean
    If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
    name String
    The name of the Docker image, including any tags or SHA256 repo digests.
    platform String
    The platform to use when pulling the image. Defaults to the platform of the current machine.
    pullTriggers List<String>
    List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
    repoDigest String
    The image sha256 digest in the form of repo[:tag]@sha256:<hash>.
    triggers Map<String>
    A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change

    Supporting Types

    RemoteImageBuild, RemoteImageBuildArgs

    Context string
    Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
    AuthConfigs List<RemoteImageBuildAuthConfig>
    The configuration for the authentication
    BuildArg Dictionary<string, string>
    Set build-time variables
    BuildArgs Dictionary<string, string>
    Pairs for build-time variables in the form TODO
    BuildId string
    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.
    CacheFroms List<string>
    Images to consider as cache sources
    CgroupParent string
    Optional parent cgroup for the container
    CpuPeriod int
    The length of a CPU period in microseconds
    CpuQuota int
    Microseconds of CPU time that the container can get in a CPU period
    CpuSetCpus string
    CPUs in which to allow execution (e.g., 0-3, 0, 1)
    CpuSetMems string
    MEMs in which to allow execution (0-3, 0, 1)
    CpuShares int
    CPU shares (relative weight)
    Dockerfile string
    Name of the Dockerfile. Defaults to Dockerfile.
    ExtraHosts List<string>
    A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
    ForceRemove bool
    Always remove intermediate containers
    Isolation string
    Isolation represents the isolation technology of a container. The supported values are
    Label Dictionary<string, string>
    Set metadata for an image
    Labels Dictionary<string, string>
    User-defined key/value metadata
    Memory int
    Set memory limit for build
    MemorySwap int
    Total memory (memory + swap), -1 to enable unlimited swap
    NetworkMode string
    Set the networking mode for the RUN instructions during build
    NoCache bool
    Do not use the cache when building the image
    Platform string
    Set platform if server is multi-platform capable
    PullParent bool
    Attempt to pull the image even if an older image exists locally
    RemoteContext string
    A Git repository URI or HTTP/HTTPS context URI
    Remove bool
    Remove intermediate containers after a successful build. Defaults to true.
    SecurityOpts List<string>
    The security options
    SessionId string
    Set an ID for the build session
    ShmSize int
    Size of /dev/shm in bytes. The size must be greater than 0
    Squash bool
    If true the new layers are squashed into a new image with a single new layer
    SuppressOutput bool
    Suppress the build output and print image ID on success
    Tags List<string>
    Name and optionally a tag in the 'name:tag' format
    Target string
    Set the target build stage to build
    Ulimits List<RemoteImageBuildUlimit>
    Configuration for ulimits
    Version string
    Version of the underlying builder to use
    Context string
    Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
    AuthConfigs []RemoteImageBuildAuthConfig
    The configuration for the authentication
    BuildArg map[string]string
    Set build-time variables
    BuildArgs map[string]string
    Pairs for build-time variables in the form TODO
    BuildId string
    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.
    CacheFroms []string
    Images to consider as cache sources
    CgroupParent string
    Optional parent cgroup for the container
    CpuPeriod int
    The length of a CPU period in microseconds
    CpuQuota int
    Microseconds of CPU time that the container can get in a CPU period
    CpuSetCpus string
    CPUs in which to allow execution (e.g., 0-3, 0, 1)
    CpuSetMems string
    MEMs in which to allow execution (0-3, 0, 1)
    CpuShares int
    CPU shares (relative weight)
    Dockerfile string
    Name of the Dockerfile. Defaults to Dockerfile.
    ExtraHosts []string
    A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
    ForceRemove bool
    Always remove intermediate containers
    Isolation string
    Isolation represents the isolation technology of a container. The supported values are
    Label map[string]string
    Set metadata for an image
    Labels map[string]string
    User-defined key/value metadata
    Memory int
    Set memory limit for build
    MemorySwap int
    Total memory (memory + swap), -1 to enable unlimited swap
    NetworkMode string
    Set the networking mode for the RUN instructions during build
    NoCache bool
    Do not use the cache when building the image
    Platform string
    Set platform if server is multi-platform capable
    PullParent bool
    Attempt to pull the image even if an older image exists locally
    RemoteContext string
    A Git repository URI or HTTP/HTTPS context URI
    Remove bool
    Remove intermediate containers after a successful build. Defaults to true.
    SecurityOpts []string
    The security options
    SessionId string
    Set an ID for the build session
    ShmSize int
    Size of /dev/shm in bytes. The size must be greater than 0
    Squash bool
    If true the new layers are squashed into a new image with a single new layer
    SuppressOutput bool
    Suppress the build output and print image ID on success
    Tags []string
    Name and optionally a tag in the 'name:tag' format
    Target string
    Set the target build stage to build
    Ulimits []RemoteImageBuildUlimit
    Configuration for ulimits
    Version string
    Version of the underlying builder to use
    context String
    Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
    authConfigs List<RemoteImageBuildAuthConfig>
    The configuration for the authentication
    buildArg Map<String,String>
    Set build-time variables
    buildArgs Map<String,String>
    Pairs for build-time variables in the form TODO
    buildId String
    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.
    cacheFroms List<String>
    Images to consider as cache sources
    cgroupParent String
    Optional parent cgroup for the container
    cpuPeriod Integer
    The length of a CPU period in microseconds
    cpuQuota Integer
    Microseconds of CPU time that the container can get in a CPU period
    cpuSetCpus String
    CPUs in which to allow execution (e.g., 0-3, 0, 1)
    cpuSetMems String
    MEMs in which to allow execution (0-3, 0, 1)
    cpuShares Integer
    CPU shares (relative weight)
    dockerfile String
    Name of the Dockerfile. Defaults to Dockerfile.
    extraHosts List<String>
    A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
    forceRemove Boolean
    Always remove intermediate containers
    isolation String
    Isolation represents the isolation technology of a container. The supported values are
    label Map<String,String>
    Set metadata for an image
    labels Map<String,String>
    User-defined key/value metadata
    memory Integer
    Set memory limit for build
    memorySwap Integer
    Total memory (memory + swap), -1 to enable unlimited swap
    networkMode String
    Set the networking mode for the RUN instructions during build
    noCache Boolean
    Do not use the cache when building the image
    platform String
    Set platform if server is multi-platform capable
    pullParent Boolean
    Attempt to pull the image even if an older image exists locally
    remoteContext String
    A Git repository URI or HTTP/HTTPS context URI
    remove Boolean
    Remove intermediate containers after a successful build. Defaults to true.
    securityOpts List<String>
    The security options
    sessionId String
    Set an ID for the build session
    shmSize Integer
    Size of /dev/shm in bytes. The size must be greater than 0
    squash Boolean
    If true the new layers are squashed into a new image with a single new layer
    suppressOutput Boolean
    Suppress the build output and print image ID on success
    tags List<String>
    Name and optionally a tag in the 'name:tag' format
    target String
    Set the target build stage to build
    ulimits List<RemoteImageBuildUlimit>
    Configuration for ulimits
    version String
    Version of the underlying builder to use
    context string
    Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
    authConfigs RemoteImageBuildAuthConfig[]
    The configuration for the authentication
    buildArg {[key: string]: string}
    Set build-time variables
    buildArgs {[key: string]: string}
    Pairs for build-time variables in the form TODO
    buildId string
    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.
    cacheFroms string[]
    Images to consider as cache sources
    cgroupParent string
    Optional parent cgroup for the container
    cpuPeriod number
    The length of a CPU period in microseconds
    cpuQuota number
    Microseconds of CPU time that the container can get in a CPU period
    cpuSetCpus string
    CPUs in which to allow execution (e.g., 0-3, 0, 1)
    cpuSetMems string
    MEMs in which to allow execution (0-3, 0, 1)
    cpuShares number
    CPU shares (relative weight)
    dockerfile string
    Name of the Dockerfile. Defaults to Dockerfile.
    extraHosts string[]
    A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
    forceRemove boolean
    Always remove intermediate containers
    isolation string
    Isolation represents the isolation technology of a container. The supported values are
    label {[key: string]: string}
    Set metadata for an image
    labels {[key: string]: string}
    User-defined key/value metadata
    memory number
    Set memory limit for build
    memorySwap number
    Total memory (memory + swap), -1 to enable unlimited swap
    networkMode string
    Set the networking mode for the RUN instructions during build
    noCache boolean
    Do not use the cache when building the image
    platform string
    Set platform if server is multi-platform capable
    pullParent boolean
    Attempt to pull the image even if an older image exists locally
    remoteContext string
    A Git repository URI or HTTP/HTTPS context URI
    remove boolean
    Remove intermediate containers after a successful build. Defaults to true.
    securityOpts string[]
    The security options
    sessionId string
    Set an ID for the build session
    shmSize number
    Size of /dev/shm in bytes. The size must be greater than 0
    squash boolean
    If true the new layers are squashed into a new image with a single new layer
    suppressOutput boolean
    Suppress the build output and print image ID on success
    tags string[]
    Name and optionally a tag in the 'name:tag' format
    target string
    Set the target build stage to build
    ulimits RemoteImageBuildUlimit[]
    Configuration for ulimits
    version string
    Version of the underlying builder to use
    context str
    Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
    auth_configs Sequence[RemoteImageBuildAuthConfig]
    The configuration for the authentication
    build_arg Mapping[str, str]
    Set build-time variables
    build_args Mapping[str, str]
    Pairs for build-time variables in the form TODO
    build_id str
    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.
    cache_froms Sequence[str]
    Images to consider as cache sources
    cgroup_parent str
    Optional parent cgroup for the container
    cpu_period int
    The length of a CPU period in microseconds
    cpu_quota int
    Microseconds of CPU time that the container can get in a CPU period
    cpu_set_cpus str
    CPUs in which to allow execution (e.g., 0-3, 0, 1)
    cpu_set_mems str
    MEMs in which to allow execution (0-3, 0, 1)
    cpu_shares int
    CPU shares (relative weight)
    dockerfile str
    Name of the Dockerfile. Defaults to Dockerfile.
    extra_hosts Sequence[str]
    A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
    force_remove bool
    Always remove intermediate containers
    isolation str
    Isolation represents the isolation technology of a container. The supported values are
    label Mapping[str, str]
    Set metadata for an image
    labels Mapping[str, str]
    User-defined key/value metadata
    memory int
    Set memory limit for build
    memory_swap int
    Total memory (memory + swap), -1 to enable unlimited swap
    network_mode str
    Set the networking mode for the RUN instructions during build
    no_cache bool
    Do not use the cache when building the image
    platform str
    Set platform if server is multi-platform capable
    pull_parent bool
    Attempt to pull the image even if an older image exists locally
    remote_context str
    A Git repository URI or HTTP/HTTPS context URI
    remove bool
    Remove intermediate containers after a successful build. Defaults to true.
    security_opts Sequence[str]
    The security options
    session_id str
    Set an ID for the build session
    shm_size int
    Size of /dev/shm in bytes. The size must be greater than 0
    squash bool
    If true the new layers are squashed into a new image with a single new layer
    suppress_output bool
    Suppress the build output and print image ID on success
    tags Sequence[str]
    Name and optionally a tag in the 'name:tag' format
    target str
    Set the target build stage to build
    ulimits Sequence[RemoteImageBuildUlimit]
    Configuration for ulimits
    version str
    Version of the underlying builder to use
    context String
    Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.
    authConfigs List<Property Map>
    The configuration for the authentication
    buildArg Map<String>
    Set build-time variables
    buildArgs Map<String>
    Pairs for build-time variables in the form TODO
    buildId String
    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.
    cacheFroms List<String>
    Images to consider as cache sources
    cgroupParent String
    Optional parent cgroup for the container
    cpuPeriod Number
    The length of a CPU period in microseconds
    cpuQuota Number
    Microseconds of CPU time that the container can get in a CPU period
    cpuSetCpus String
    CPUs in which to allow execution (e.g., 0-3, 0, 1)
    cpuSetMems String
    MEMs in which to allow execution (0-3, 0, 1)
    cpuShares Number
    CPU shares (relative weight)
    dockerfile String
    Name of the Dockerfile. Defaults to Dockerfile.
    extraHosts List<String>
    A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
    forceRemove Boolean
    Always remove intermediate containers
    isolation String
    Isolation represents the isolation technology of a container. The supported values are
    label Map<String>
    Set metadata for an image
    labels Map<String>
    User-defined key/value metadata
    memory Number
    Set memory limit for build
    memorySwap Number
    Total memory (memory + swap), -1 to enable unlimited swap
    networkMode String
    Set the networking mode for the RUN instructions during build
    noCache Boolean
    Do not use the cache when building the image
    platform String
    Set platform if server is multi-platform capable
    pullParent Boolean
    Attempt to pull the image even if an older image exists locally
    remoteContext String
    A Git repository URI or HTTP/HTTPS context URI
    remove Boolean
    Remove intermediate containers after a successful build. Defaults to true.
    securityOpts List<String>
    The security options
    sessionId String
    Set an ID for the build session
    shmSize Number
    Size of /dev/shm in bytes. The size must be greater than 0
    squash Boolean
    If true the new layers are squashed into a new image with a single new layer
    suppressOutput Boolean
    Suppress the build output and print image ID on success
    tags List<String>
    Name and optionally a tag in the 'name:tag' format
    target String
    Set the target build stage to build
    ulimits List<Property Map>
    Configuration for ulimits
    version String
    Version of the underlying builder to use

    RemoteImageBuildAuthConfig, RemoteImageBuildAuthConfigArgs

    HostName string
    hostname of the registry
    Auth string
    the auth token
    Email string
    the user emal
    IdentityToken string
    the identity token
    Password string
    the registry password
    RegistryToken string
    the registry token
    ServerAddress string
    the server address
    UserName string
    the registry user name
    HostName string
    hostname of the registry
    Auth string
    the auth token
    Email string
    the user emal
    IdentityToken string
    the identity token
    Password string
    the registry password
    RegistryToken string
    the registry token
    ServerAddress string
    the server address
    UserName string
    the registry user name
    hostName String
    hostname of the registry
    auth String
    the auth token
    email String
    the user emal
    identityToken String
    the identity token
    password String
    the registry password
    registryToken String
    the registry token
    serverAddress String
    the server address
    userName String
    the registry user name
    hostName string
    hostname of the registry
    auth string
    the auth token
    email string
    the user emal
    identityToken string
    the identity token
    password string
    the registry password
    registryToken string
    the registry token
    serverAddress string
    the server address
    userName string
    the registry user name
    host_name str
    hostname of the registry
    auth str
    the auth token
    email str
    the user emal
    identity_token str
    the identity token
    password str
    the registry password
    registry_token str
    the registry token
    server_address str
    the server address
    user_name str
    the registry user name
    hostName String
    hostname of the registry
    auth String
    the auth token
    email String
    the user emal
    identityToken String
    the identity token
    password String
    the registry password
    registryToken String
    the registry token
    serverAddress String
    the server address
    userName String
    the registry user name

    RemoteImageBuildUlimit, RemoteImageBuildUlimitArgs

    Hard int
    soft limit
    Name string
    type of ulimit, e.g. nofile
    Soft int
    hard limit
    Hard int
    soft limit
    Name string
    type of ulimit, e.g. nofile
    Soft int
    hard limit
    hard Integer
    soft limit
    name String
    type of ulimit, e.g. nofile
    soft Integer
    hard limit
    hard number
    soft limit
    name string
    type of ulimit, e.g. nofile
    soft number
    hard limit
    hard int
    soft limit
    name str
    type of ulimit, e.g. nofile
    soft int
    hard limit
    hard Number
    soft limit
    name String
    type of ulimit, e.g. nofile
    soft Number
    hard limit

    Package Details

    Repository
    Docker pulumi/pulumi-docker
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the docker Terraform Provider.
    docker logo
    Docker v4.5.6 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-docker