1. Packages
  2. Packages
  3. Docker Provider
  4. API Docs
  5. RemoteImage
Viewing docs for Docker v3.6.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-docker

docker.RemoteImage

docker logo
Viewing docs for Docker v3.6.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
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

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

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

});

    package main

import (
	"github.com/pulumi/pulumi-docker/sdk/v3/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
	})
}

    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());

    }
}

    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")

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

    Dynamic updates

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

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

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

});

    package main

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

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

    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 ubuntuRegistryImage = DockerFunctions.getRegistryImage(GetRegistryImageArgs.builder()
            .name("ubuntu:precise")
            .build());

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

    }
}

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

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

    import pulumi
import pulumi_docker as docker

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

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

    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,
                pull_trigger: Optional[str] = None,
                pull_triggers: Optional[Sequence[str]] = None,
                triggers: Optional[Mapping[str, Any]] = 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
    {
        Path = "string",
        BuildArg = 
        {
            { "string", "string" },
        },
        Dockerfile = "string",
        ForceRemove = false,
        Label = 
        {
            { "string", "string" },
        },
        NoCache = false,
        Remove = false,
        Tags = new[]
        {
            "string",
        },
        Target = "string",
    },
    ForceRemove = false,
    KeepLocally = false,
    PullTriggers = new[]
    {
        "string",
    },
    Triggers = 
    {
        { "string", "any" },
    },
});

    example, err := docker.NewRemoteImage(ctx, "remoteImageResource", &docker.RemoteImageArgs{
	Name: pulumi.String("string"),
	Build: &docker.RemoteImageBuildArgs{
		Path: pulumi.String("string"),
		BuildArg: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Dockerfile:  pulumi.String("string"),
		ForceRemove: pulumi.Bool(false),
		Label: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		NoCache: pulumi.Bool(false),
		Remove:  pulumi.Bool(false),
		Tags: pulumi.StringArray{
			pulumi.String("string"),
		},
		Target: pulumi.String("string"),
	},
	ForceRemove: pulumi.Bool(false),
	KeepLocally: pulumi.Bool(false),
	PullTriggers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Triggers: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

    var remoteImageResource = new RemoteImage("remoteImageResource", RemoteImageArgs.builder()
    .name("string")
    .build(RemoteImageBuildArgs.builder()
        .path("string")
        .buildArg(Map.of("string", "string"))
        .dockerfile("string")
        .forceRemove(false)
        .label(Map.of("string", "string"))
        .noCache(false)
        .remove(false)
        .tags("string")
        .target("string")
        .build())
    .forceRemove(false)
    .keepLocally(false)
    .pullTriggers("string")
    .triggers(Map.of("string", "any"))
    .build());

    remote_image_resource = docker.RemoteImage("remoteImageResource",
    name="string",
    build={
        "path": "string",
        "build_arg": {
            "string": "string",
        },
        "dockerfile": "string",
        "force_remove": False,
        "label": {
            "string": "string",
        },
        "no_cache": False,
        "remove": False,
        "tags": ["string"],
        "target": "string",
    },
    force_remove=False,
    keep_locally=False,
    pull_triggers=["string"],
    triggers={
        "string": "any",
    })

    const remoteImageResource = new docker.RemoteImage("remoteImageResource", {
    name: "string",
    build: {
        path: "string",
        buildArg: {
            string: "string",
        },
        dockerfile: "string",
        forceRemove: false,
        label: {
            string: "string",
        },
        noCache: false,
        remove: false,
        tags: ["string"],
        target: "string",
    },
    forceRemove: false,
    keepLocally: false,
    pullTriggers: ["string"],
    triggers: {
        string: "any",
    },
});

    type: docker:RemoteImage
properties:
    build:
        buildArg:
            string: string
        dockerfile: string
        forceRemove: false
        label:
            string: string
        noCache: false
        path: string
        remove: false
        tags:
            - string
        target: string
    forceRemove: false
    keepLocally: false
    name: string
    pullTriggers:
        - string
    triggers:
        string: any

    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.
    PullTrigger string
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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, object>
    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.
    PullTrigger string
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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]interface{}
    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.
    pullTrigger String
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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,Object>
    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.
    pullTrigger string
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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]: any}
    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.
    pull_trigger str
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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, Any]
    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.
    pullTrigger String
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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<Any>
    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.
    Latest string
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    Output string

    Deprecated: Is unused and will be removed.

    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.
    Latest string
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    Output string

    Deprecated: Is unused and will be removed.

    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.
    latest String
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    output String

    Deprecated: Is unused and will be removed.

    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.
    latest string
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    output string

    Deprecated: Is unused and will be removed.

    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.
    latest str
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    output str

    Deprecated: Is unused and will be removed.

    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.
    latest String
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    output String

    Deprecated: Is unused and will be removed.

    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,
        latest: Optional[str] = None,
        name: Optional[str] = None,
        output: Optional[str] = None,
        pull_trigger: Optional[str] = None,
        pull_triggers: Optional[Sequence[str]] = None,
        repo_digest: Optional[str] = None,
        triggers: Optional[Mapping[str, Any]] = 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)
    resources:  _:    type: docker:RemoteImage    get:      id: ${id}
    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.
    Latest string
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    Name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    Output string

    Deprecated: Is unused and will be removed.

    PullTrigger string
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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, object>
    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.
    Latest string
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    Name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    Output string

    Deprecated: Is unused and will be removed.

    PullTrigger string
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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]interface{}
    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.
    latest String
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    name String
    The name of the Docker image, including any tags or SHA256 repo digests.
    output String

    Deprecated: Is unused and will be removed.

    pullTrigger String
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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,Object>
    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.
    latest string
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    name string
    The name of the Docker image, including any tags or SHA256 repo digests.
    output string

    Deprecated: Is unused and will be removed.

    pullTrigger string
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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]: any}
    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.
    latest str
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    name str
    The name of the Docker image, including any tags or SHA256 repo digests.
    output str

    Deprecated: Is unused and will be removed.

    pull_trigger str
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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, Any]
    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.
    latest String
    The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

    Deprecated: Use repo_digest instead

    name String
    The name of the Docker image, including any tags or SHA256 repo digests.
    output String

    Deprecated: Is unused and will be removed.

    pullTrigger String
    A value which cause an image pull when changed

    Deprecated: Use field pull_triggers instead

    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<Any>
    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

    Path string
    Context path
    BuildArg Dictionary<string, string>
    Set build-time variables
    Dockerfile string
    Name of the Dockerfile. Defaults to Dockerfile.
    ForceRemove bool
    Always remove intermediate containers
    Label Dictionary<string, string>
    Set metadata for an image
    NoCache bool
    Do not use cache when building the image
    Remove bool
    Remove intermediate containers after a successful build. Defaults to true.
    Tags List<string>
    Name and optionally a tag in the 'name:tag' format
    Target string
    Set the target build stage to build
    Path string
    Context path
    BuildArg map[string]string
    Set build-time variables
    Dockerfile string
    Name of the Dockerfile. Defaults to Dockerfile.
    ForceRemove bool
    Always remove intermediate containers
    Label map[string]string
    Set metadata for an image
    NoCache bool
    Do not use cache when building the image
    Remove bool
    Remove intermediate containers after a successful build. Defaults to true.
    Tags []string
    Name and optionally a tag in the 'name:tag' format
    Target string
    Set the target build stage to build
    path String
    Context path
    buildArg Map<String,String>
    Set build-time variables
    dockerfile String
    Name of the Dockerfile. Defaults to Dockerfile.
    forceRemove Boolean
    Always remove intermediate containers
    label Map<String,String>
    Set metadata for an image
    noCache Boolean
    Do not use cache when building the image
    remove Boolean
    Remove intermediate containers after a successful build. Defaults to true.
    tags List<String>
    Name and optionally a tag in the 'name:tag' format
    target String
    Set the target build stage to build
    path string
    Context path
    buildArg {[key: string]: string}
    Set build-time variables
    dockerfile string
    Name of the Dockerfile. Defaults to Dockerfile.
    forceRemove boolean
    Always remove intermediate containers
    label {[key: string]: string}
    Set metadata for an image
    noCache boolean
    Do not use cache when building the image
    remove boolean
    Remove intermediate containers after a successful build. Defaults to true.
    tags string[]
    Name and optionally a tag in the 'name:tag' format
    target string
    Set the target build stage to build
    path str
    Context path
    build_arg Mapping[str, str]
    Set build-time variables
    dockerfile str
    Name of the Dockerfile. Defaults to Dockerfile.
    force_remove bool
    Always remove intermediate containers
    label Mapping[str, str]
    Set metadata for an image
    no_cache bool
    Do not use cache when building the image
    remove bool
    Remove intermediate containers after a successful build. Defaults to true.
    tags Sequence[str]
    Name and optionally a tag in the 'name:tag' format
    target str
    Set the target build stage to build
    path String
    Context path
    buildArg Map<String>
    Set build-time variables
    dockerfile String
    Name of the Dockerfile. Defaults to Dockerfile.
    forceRemove Boolean
    Always remove intermediate containers
    label Map<String>
    Set metadata for an image
    noCache Boolean
    Do not use cache when building the image
    remove Boolean
    Remove intermediate containers after a successful build. Defaults to true.
    tags List<String>
    Name and optionally a tag in the 'name:tag' format
    target String
    Set the target build stage to build

    Package Details

    Repository
    Docker pulumi/pulumi-docker
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the docker Terraform Provider.
    docker logo
    Viewing docs for Docker v3.6.1 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-docker
      Try Pulumi Cloud free. Your team will thank you.