Docker v4.6.2, Mar 15 25

Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi

docker.Container

Explore with Pulumi AI

Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

// Find the latest Ubuntu precise image.
const ubuntuRemoteImage = new docker.RemoteImage("ubuntu", {name: "ubuntu:precise"});
// Start a container
const ubuntu = new docker.Container("ubuntu", {
    name: "foo",
    image: ubuntuRemoteImage.imageId,
});

import pulumi
import pulumi_docker as docker

# Find the latest Ubuntu precise image.
ubuntu_remote_image = docker.RemoteImage("ubuntu", name="ubuntu:precise")
# Start a container
ubuntu = docker.Container("ubuntu",
    name="foo",
    image=ubuntu_remote_image.image_id)

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 {
		// Find the latest Ubuntu precise image.
		ubuntuRemoteImage, err := docker.NewRemoteImage(ctx, "ubuntu", &docker.RemoteImageArgs{
			Name: pulumi.String("ubuntu:precise"),
		})
		if err != nil {
			return err
		}
		// Start a container
		_, err = docker.NewContainer(ctx, "ubuntu", &docker.ContainerArgs{
			Name:  pulumi.String("foo"),
			Image: ubuntuRemoteImage.ImageId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Find the latest Ubuntu precise image.
    var ubuntuRemoteImage = new Docker.RemoteImage("ubuntu", new()
    {
        Name = "ubuntu:precise",
    });

    // Start a container
    var ubuntu = new Docker.Container("ubuntu", new()
    {
        Name = "foo",
        Image = ubuntuRemoteImage.ImageId,
    });

});

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.Container;
import com.pulumi.docker.ContainerArgs;
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) {
        // Find the latest Ubuntu precise image.
        var ubuntuRemoteImage = new RemoteImage("ubuntuRemoteImage", RemoteImageArgs.builder()
            .name("ubuntu:precise")
            .build());

        // Start a container
        var ubuntu = new Container("ubuntu", ContainerArgs.builder()
            .name("foo")
            .image(ubuntuRemoteImage.imageId())
            .build());

    }
}

resources:
  # Start a container
  ubuntu:
    type: docker:Container
    properties:
      name: foo
      image: ${ubuntuRemoteImage.imageId}
  # Find the latest Ubuntu precise image.
  ubuntuRemoteImage:
    type: docker:RemoteImage
    name: ubuntu
    properties:
      name: ubuntu:precise

Create Container Resource

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

new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);

@overload
def Container(resource_name: str,
              args: ContainerArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Container(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              image: Optional[str] = None,
              attach: Optional[bool] = None,
              capabilities: Optional[ContainerCapabilitiesArgs] = None,
              cgroupns_mode: Optional[str] = None,
              command: Optional[Sequence[str]] = None,
              container_read_refresh_timeout_milliseconds: Optional[int] = None,
              cpu_set: Optional[str] = None,
              cpu_shares: Optional[int] = None,
              destroy_grace_seconds: Optional[int] = None,
              devices: Optional[Sequence[ContainerDeviceArgs]] = None,
              dns: Optional[Sequence[str]] = None,
              dns_opts: Optional[Sequence[str]] = None,
              dns_searches: Optional[Sequence[str]] = None,
              domainname: Optional[str] = None,
              entrypoints: Optional[Sequence[str]] = None,
              envs: Optional[Sequence[str]] = None,
              gpus: Optional[str] = None,
              group_adds: Optional[Sequence[str]] = None,
              healthcheck: Optional[ContainerHealthcheckArgs] = None,
              hostname: Optional[str] = None,
              hosts: Optional[Sequence[ContainerHostArgs]] = None,
              init: Optional[bool] = None,
              ipc_mode: Optional[str] = None,
              labels: Optional[Sequence[ContainerLabelArgs]] = None,
              log_driver: Optional[str] = None,
              log_opts: Optional[Mapping[str, str]] = None,
              logs: Optional[bool] = None,
              max_retry_count: Optional[int] = None,
              memory: Optional[int] = None,
              memory_swap: Optional[int] = None,
              mounts: Optional[Sequence[ContainerMountArgs]] = None,
              must_run: Optional[bool] = None,
              name: Optional[str] = None,
              network_mode: Optional[str] = None,
              networks_advanced: Optional[Sequence[ContainerNetworksAdvancedArgs]] = None,
              pid_mode: Optional[str] = None,
              ports: Optional[Sequence[ContainerPortArgs]] = None,
              privileged: Optional[bool] = None,
              publish_all_ports: Optional[bool] = None,
              read_only: Optional[bool] = None,
              remove_volumes: Optional[bool] = None,
              restart: Optional[str] = None,
              rm: Optional[bool] = None,
              runtime: Optional[str] = None,
              security_opts: Optional[Sequence[str]] = None,
              shm_size: Optional[int] = None,
              start: Optional[bool] = None,
              stdin_open: Optional[bool] = None,
              stop_signal: Optional[str] = None,
              stop_timeout: Optional[int] = None,
              storage_opts: Optional[Mapping[str, str]] = None,
              sysctls: Optional[Mapping[str, str]] = None,
              tmpfs: Optional[Mapping[str, str]] = None,
              tty: Optional[bool] = None,
              ulimits: Optional[Sequence[ContainerUlimitArgs]] = None,
              uploads: Optional[Sequence[ContainerUploadArgs]] = None,
              user: Optional[str] = None,
              userns_mode: Optional[str] = None,
              volumes: Optional[Sequence[ContainerVolumeArgs]] = None,
              wait: Optional[bool] = None,
              wait_timeout: Optional[int] = None,
              working_dir: Optional[str] = None)

func NewContainer(ctx *Context, name string, args ContainerArgs, opts ...ResourceOption) (*Container, error)

public Container(string name, ContainerArgs args, CustomResourceOptions? opts = null)

public Container(String name, ContainerArgs args)
public Container(String name, ContainerArgs args, CustomResourceOptions options)

type: docker:Container
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 ContainerArgs: 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 ContainerArgs: 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 ContainerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ContainerArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var containerResource = new Docker.Container("containerResource", new()
{
    Image = "string",
    Attach = false,
    Capabilities = new Docker.Inputs.ContainerCapabilitiesArgs
    {
        Adds = new[]
        {
            "string",
        },
        Drops = new[]
        {
            "string",
        },
    },
    CgroupnsMode = "string",
    Command = new[]
    {
        "string",
    },
    ContainerReadRefreshTimeoutMilliseconds = 0,
    CpuSet = "string",
    CpuShares = 0,
    DestroyGraceSeconds = 0,
    Devices = new[]
    {
        new Docker.Inputs.ContainerDeviceArgs
        {
            HostPath = "string",
            ContainerPath = "string",
            Permissions = "string",
        },
    },
    Dns = new[]
    {
        "string",
    },
    DnsOpts = new[]
    {
        "string",
    },
    DnsSearches = new[]
    {
        "string",
    },
    Domainname = "string",
    Entrypoints = new[]
    {
        "string",
    },
    Envs = new[]
    {
        "string",
    },
    Gpus = "string",
    GroupAdds = new[]
    {
        "string",
    },
    Healthcheck = new Docker.Inputs.ContainerHealthcheckArgs
    {
        Tests = new[]
        {
            "string",
        },
        Interval = "string",
        Retries = 0,
        StartPeriod = "string",
        Timeout = "string",
    },
    Hostname = "string",
    Hosts = new[]
    {
        new Docker.Inputs.ContainerHostArgs
        {
            Host = "string",
            Ip = "string",
        },
    },
    Init = false,
    IpcMode = "string",
    Labels = new[]
    {
        new Docker.Inputs.ContainerLabelArgs
        {
            Label = "string",
            Value = "string",
        },
    },
    LogDriver = "string",
    LogOpts = 
    {
        { "string", "string" },
    },
    Logs = false,
    MaxRetryCount = 0,
    Memory = 0,
    MemorySwap = 0,
    Mounts = new[]
    {
        new Docker.Inputs.ContainerMountArgs
        {
            Target = "string",
            Type = "string",
            BindOptions = new Docker.Inputs.ContainerMountBindOptionsArgs
            {
                Propagation = "string",
            },
            ReadOnly = false,
            Source = "string",
            TmpfsOptions = new Docker.Inputs.ContainerMountTmpfsOptionsArgs
            {
                Mode = 0,
                SizeBytes = 0,
            },
            VolumeOptions = new Docker.Inputs.ContainerMountVolumeOptionsArgs
            {
                DriverName = "string",
                DriverOptions = 
                {
                    { "string", "string" },
                },
                Labels = new[]
                {
                    new Docker.Inputs.ContainerMountVolumeOptionsLabelArgs
                    {
                        Label = "string",
                        Value = "string",
                    },
                },
                NoCopy = false,
            },
        },
    },
    MustRun = false,
    Name = "string",
    NetworkMode = "string",
    NetworksAdvanced = new[]
    {
        new Docker.Inputs.ContainerNetworksAdvancedArgs
        {
            Name = "string",
            Aliases = new[]
            {
                "string",
            },
            Ipv4Address = "string",
            Ipv6Address = "string",
        },
    },
    PidMode = "string",
    Ports = new[]
    {
        new Docker.Inputs.ContainerPortArgs
        {
            Internal = 0,
            External = 0,
            Ip = "string",
            Protocol = "string",
        },
    },
    Privileged = false,
    PublishAllPorts = false,
    ReadOnly = false,
    RemoveVolumes = false,
    Restart = "string",
    Rm = false,
    Runtime = "string",
    SecurityOpts = new[]
    {
        "string",
    },
    ShmSize = 0,
    Start = false,
    StdinOpen = false,
    StopSignal = "string",
    StopTimeout = 0,
    StorageOpts = 
    {
        { "string", "string" },
    },
    Sysctls = 
    {
        { "string", "string" },
    },
    Tmpfs = 
    {
        { "string", "string" },
    },
    Tty = false,
    Ulimits = new[]
    {
        new Docker.Inputs.ContainerUlimitArgs
        {
            Hard = 0,
            Name = "string",
            Soft = 0,
        },
    },
    Uploads = new[]
    {
        new Docker.Inputs.ContainerUploadArgs
        {
            File = "string",
            Content = "string",
            ContentBase64 = "string",
            Executable = false,
            Source = "string",
            SourceHash = "string",
        },
    },
    User = "string",
    UsernsMode = "string",
    Volumes = new[]
    {
        new Docker.Inputs.ContainerVolumeArgs
        {
            ContainerPath = "string",
            FromContainer = "string",
            HostPath = "string",
            ReadOnly = false,
            VolumeName = "string",
        },
    },
    Wait = false,
    WaitTimeout = 0,
    WorkingDir = "string",
});

example, err := docker.NewContainer(ctx, "containerResource", &docker.ContainerArgs{
	Image:  pulumi.String("string"),
	Attach: pulumi.Bool(false),
	Capabilities: &docker.ContainerCapabilitiesArgs{
		Adds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Drops: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	CgroupnsMode: pulumi.String("string"),
	Command: pulumi.StringArray{
		pulumi.String("string"),
	},
	ContainerReadRefreshTimeoutMilliseconds: pulumi.Int(0),
	CpuSet:                                  pulumi.String("string"),
	CpuShares:                               pulumi.Int(0),
	DestroyGraceSeconds:                     pulumi.Int(0),
	Devices: docker.ContainerDeviceArray{
		&docker.ContainerDeviceArgs{
			HostPath:      pulumi.String("string"),
			ContainerPath: pulumi.String("string"),
			Permissions:   pulumi.String("string"),
		},
	},
	Dns: pulumi.StringArray{
		pulumi.String("string"),
	},
	DnsOpts: pulumi.StringArray{
		pulumi.String("string"),
	},
	DnsSearches: pulumi.StringArray{
		pulumi.String("string"),
	},
	Domainname: pulumi.String("string"),
	Entrypoints: pulumi.StringArray{
		pulumi.String("string"),
	},
	Envs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Gpus: pulumi.String("string"),
	GroupAdds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Healthcheck: &docker.ContainerHealthcheckArgs{
		Tests: pulumi.StringArray{
			pulumi.String("string"),
		},
		Interval:    pulumi.String("string"),
		Retries:     pulumi.Int(0),
		StartPeriod: pulumi.String("string"),
		Timeout:     pulumi.String("string"),
	},
	Hostname: pulumi.String("string"),
	Hosts: docker.ContainerHostArray{
		&docker.ContainerHostArgs{
			Host: pulumi.String("string"),
			Ip:   pulumi.String("string"),
		},
	},
	Init:    pulumi.Bool(false),
	IpcMode: pulumi.String("string"),
	Labels: docker.ContainerLabelArray{
		&docker.ContainerLabelArgs{
			Label: pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	LogDriver: pulumi.String("string"),
	LogOpts: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Logs:          pulumi.Bool(false),
	MaxRetryCount: pulumi.Int(0),
	Memory:        pulumi.Int(0),
	MemorySwap:    pulumi.Int(0),
	Mounts: docker.ContainerMountArray{
		&docker.ContainerMountArgs{
			Target: pulumi.String("string"),
			Type:   pulumi.String("string"),
			BindOptions: &docker.ContainerMountBindOptionsArgs{
				Propagation: pulumi.String("string"),
			},
			ReadOnly: pulumi.Bool(false),
			Source:   pulumi.String("string"),
			TmpfsOptions: &docker.ContainerMountTmpfsOptionsArgs{
				Mode:      pulumi.Int(0),
				SizeBytes: pulumi.Int(0),
			},
			VolumeOptions: &docker.ContainerMountVolumeOptionsArgs{
				DriverName: pulumi.String("string"),
				DriverOptions: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				Labels: docker.ContainerMountVolumeOptionsLabelArray{
					&docker.ContainerMountVolumeOptionsLabelArgs{
						Label: pulumi.String("string"),
						Value: pulumi.String("string"),
					},
				},
				NoCopy: pulumi.Bool(false),
			},
		},
	},
	MustRun:     pulumi.Bool(false),
	Name:        pulumi.String("string"),
	NetworkMode: pulumi.String("string"),
	NetworksAdvanced: docker.ContainerNetworksAdvancedArray{
		&docker.ContainerNetworksAdvancedArgs{
			Name: pulumi.String("string"),
			Aliases: pulumi.StringArray{
				pulumi.String("string"),
			},
			Ipv4Address: pulumi.String("string"),
			Ipv6Address: pulumi.String("string"),
		},
	},
	PidMode: pulumi.String("string"),
	Ports: docker.ContainerPortArray{
		&docker.ContainerPortArgs{
			Internal: pulumi.Int(0),
			External: pulumi.Int(0),
			Ip:       pulumi.String("string"),
			Protocol: pulumi.String("string"),
		},
	},
	Privileged:      pulumi.Bool(false),
	PublishAllPorts: pulumi.Bool(false),
	ReadOnly:        pulumi.Bool(false),
	RemoveVolumes:   pulumi.Bool(false),
	Restart:         pulumi.String("string"),
	Rm:              pulumi.Bool(false),
	Runtime:         pulumi.String("string"),
	SecurityOpts: pulumi.StringArray{
		pulumi.String("string"),
	},
	ShmSize:     pulumi.Int(0),
	Start:       pulumi.Bool(false),
	StdinOpen:   pulumi.Bool(false),
	StopSignal:  pulumi.String("string"),
	StopTimeout: pulumi.Int(0),
	StorageOpts: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Sysctls: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tmpfs: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tty: pulumi.Bool(false),
	Ulimits: docker.ContainerUlimitArray{
		&docker.ContainerUlimitArgs{
			Hard: pulumi.Int(0),
			Name: pulumi.String("string"),
			Soft: pulumi.Int(0),
		},
	},
	Uploads: docker.ContainerUploadArray{
		&docker.ContainerUploadArgs{
			File:          pulumi.String("string"),
			Content:       pulumi.String("string"),
			ContentBase64: pulumi.String("string"),
			Executable:    pulumi.Bool(false),
			Source:        pulumi.String("string"),
			SourceHash:    pulumi.String("string"),
		},
	},
	User:       pulumi.String("string"),
	UsernsMode: pulumi.String("string"),
	Volumes: docker.ContainerVolumeArray{
		&docker.ContainerVolumeArgs{
			ContainerPath: pulumi.String("string"),
			FromContainer: pulumi.String("string"),
			HostPath:      pulumi.String("string"),
			ReadOnly:      pulumi.Bool(false),
			VolumeName:    pulumi.String("string"),
		},
	},
	Wait:        pulumi.Bool(false),
	WaitTimeout: pulumi.Int(0),
	WorkingDir:  pulumi.String("string"),
})

var containerResource = new Container("containerResource", ContainerArgs.builder()
    .image("string")
    .attach(false)
    .capabilities(ContainerCapabilitiesArgs.builder()
        .adds("string")
        .drops("string")
        .build())
    .cgroupnsMode("string")
    .command("string")
    .containerReadRefreshTimeoutMilliseconds(0)
    .cpuSet("string")
    .cpuShares(0)
    .destroyGraceSeconds(0)
    .devices(ContainerDeviceArgs.builder()
        .hostPath("string")
        .containerPath("string")
        .permissions("string")
        .build())
    .dns("string")
    .dnsOpts("string")
    .dnsSearches("string")
    .domainname("string")
    .entrypoints("string")
    .envs("string")
    .gpus("string")
    .groupAdds("string")
    .healthcheck(ContainerHealthcheckArgs.builder()
        .tests("string")
        .interval("string")
        .retries(0)
        .startPeriod("string")
        .timeout("string")
        .build())
    .hostname("string")
    .hosts(ContainerHostArgs.builder()
        .host("string")
        .ip("string")
        .build())
    .init(false)
    .ipcMode("string")
    .labels(ContainerLabelArgs.builder()
        .label("string")
        .value("string")
        .build())
    .logDriver("string")
    .logOpts(Map.of("string", "string"))
    .logs(false)
    .maxRetryCount(0)
    .memory(0)
    .memorySwap(0)
    .mounts(ContainerMountArgs.builder()
        .target("string")
        .type("string")
        .bindOptions(ContainerMountBindOptionsArgs.builder()
            .propagation("string")
            .build())
        .readOnly(false)
        .source("string")
        .tmpfsOptions(ContainerMountTmpfsOptionsArgs.builder()
            .mode(0)
            .sizeBytes(0)
            .build())
        .volumeOptions(ContainerMountVolumeOptionsArgs.builder()
            .driverName("string")
            .driverOptions(Map.of("string", "string"))
            .labels(ContainerMountVolumeOptionsLabelArgs.builder()
                .label("string")
                .value("string")
                .build())
            .noCopy(false)
            .build())
        .build())
    .mustRun(false)
    .name("string")
    .networkMode("string")
    .networksAdvanced(ContainerNetworksAdvancedArgs.builder()
        .name("string")
        .aliases("string")
        .ipv4Address("string")
        .ipv6Address("string")
        .build())
    .pidMode("string")
    .ports(ContainerPortArgs.builder()
        .internal(0)
        .external(0)
        .ip("string")
        .protocol("string")
        .build())
    .privileged(false)
    .publishAllPorts(false)
    .readOnly(false)
    .removeVolumes(false)
    .restart("string")
    .rm(false)
    .runtime("string")
    .securityOpts("string")
    .shmSize(0)
    .start(false)
    .stdinOpen(false)
    .stopSignal("string")
    .stopTimeout(0)
    .storageOpts(Map.of("string", "string"))
    .sysctls(Map.of("string", "string"))
    .tmpfs(Map.of("string", "string"))
    .tty(false)
    .ulimits(ContainerUlimitArgs.builder()
        .hard(0)
        .name("string")
        .soft(0)
        .build())
    .uploads(ContainerUploadArgs.builder()
        .file("string")
        .content("string")
        .contentBase64("string")
        .executable(false)
        .source("string")
        .sourceHash("string")
        .build())
    .user("string")
    .usernsMode("string")
    .volumes(ContainerVolumeArgs.builder()
        .containerPath("string")
        .fromContainer("string")
        .hostPath("string")
        .readOnly(false)
        .volumeName("string")
        .build())
    .wait(false)
    .waitTimeout(0)
    .workingDir("string")
    .build());

container_resource = docker.Container("containerResource",
    image="string",
    attach=False,
    capabilities={
        "adds": ["string"],
        "drops": ["string"],
    },
    cgroupns_mode="string",
    command=["string"],
    container_read_refresh_timeout_milliseconds=0,
    cpu_set="string",
    cpu_shares=0,
    destroy_grace_seconds=0,
    devices=[{
        "host_path": "string",
        "container_path": "string",
        "permissions": "string",
    }],
    dns=["string"],
    dns_opts=["string"],
    dns_searches=["string"],
    domainname="string",
    entrypoints=["string"],
    envs=["string"],
    gpus="string",
    group_adds=["string"],
    healthcheck={
        "tests": ["string"],
        "interval": "string",
        "retries": 0,
        "start_period": "string",
        "timeout": "string",
    },
    hostname="string",
    hosts=[{
        "host": "string",
        "ip": "string",
    }],
    init=False,
    ipc_mode="string",
    labels=[{
        "label": "string",
        "value": "string",
    }],
    log_driver="string",
    log_opts={
        "string": "string",
    },
    logs=False,
    max_retry_count=0,
    memory=0,
    memory_swap=0,
    mounts=[{
        "target": "string",
        "type": "string",
        "bind_options": {
            "propagation": "string",
        },
        "read_only": False,
        "source": "string",
        "tmpfs_options": {
            "mode": 0,
            "size_bytes": 0,
        },
        "volume_options": {
            "driver_name": "string",
            "driver_options": {
                "string": "string",
            },
            "labels": [{
                "label": "string",
                "value": "string",
            }],
            "no_copy": False,
        },
    }],
    must_run=False,
    name="string",
    network_mode="string",
    networks_advanced=[{
        "name": "string",
        "aliases": ["string"],
        "ipv4_address": "string",
        "ipv6_address": "string",
    }],
    pid_mode="string",
    ports=[{
        "internal": 0,
        "external": 0,
        "ip": "string",
        "protocol": "string",
    }],
    privileged=False,
    publish_all_ports=False,
    read_only=False,
    remove_volumes=False,
    restart="string",
    rm=False,
    runtime="string",
    security_opts=["string"],
    shm_size=0,
    start=False,
    stdin_open=False,
    stop_signal="string",
    stop_timeout=0,
    storage_opts={
        "string": "string",
    },
    sysctls={
        "string": "string",
    },
    tmpfs={
        "string": "string",
    },
    tty=False,
    ulimits=[{
        "hard": 0,
        "name": "string",
        "soft": 0,
    }],
    uploads=[{
        "file": "string",
        "content": "string",
        "content_base64": "string",
        "executable": False,
        "source": "string",
        "source_hash": "string",
    }],
    user="string",
    userns_mode="string",
    volumes=[{
        "container_path": "string",
        "from_container": "string",
        "host_path": "string",
        "read_only": False,
        "volume_name": "string",
    }],
    wait=False,
    wait_timeout=0,
    working_dir="string")

const containerResource = new docker.Container("containerResource", {
    image: "string",
    attach: false,
    capabilities: {
        adds: ["string"],
        drops: ["string"],
    },
    cgroupnsMode: "string",
    command: ["string"],
    containerReadRefreshTimeoutMilliseconds: 0,
    cpuSet: "string",
    cpuShares: 0,
    destroyGraceSeconds: 0,
    devices: [{
        hostPath: "string",
        containerPath: "string",
        permissions: "string",
    }],
    dns: ["string"],
    dnsOpts: ["string"],
    dnsSearches: ["string"],
    domainname: "string",
    entrypoints: ["string"],
    envs: ["string"],
    gpus: "string",
    groupAdds: ["string"],
    healthcheck: {
        tests: ["string"],
        interval: "string",
        retries: 0,
        startPeriod: "string",
        timeout: "string",
    },
    hostname: "string",
    hosts: [{
        host: "string",
        ip: "string",
    }],
    init: false,
    ipcMode: "string",
    labels: [{
        label: "string",
        value: "string",
    }],
    logDriver: "string",
    logOpts: {
        string: "string",
    },
    logs: false,
    maxRetryCount: 0,
    memory: 0,
    memorySwap: 0,
    mounts: [{
        target: "string",
        type: "string",
        bindOptions: {
            propagation: "string",
        },
        readOnly: false,
        source: "string",
        tmpfsOptions: {
            mode: 0,
            sizeBytes: 0,
        },
        volumeOptions: {
            driverName: "string",
            driverOptions: {
                string: "string",
            },
            labels: [{
                label: "string",
                value: "string",
            }],
            noCopy: false,
        },
    }],
    mustRun: false,
    name: "string",
    networkMode: "string",
    networksAdvanced: [{
        name: "string",
        aliases: ["string"],
        ipv4Address: "string",
        ipv6Address: "string",
    }],
    pidMode: "string",
    ports: [{
        internal: 0,
        external: 0,
        ip: "string",
        protocol: "string",
    }],
    privileged: false,
    publishAllPorts: false,
    readOnly: false,
    removeVolumes: false,
    restart: "string",
    rm: false,
    runtime: "string",
    securityOpts: ["string"],
    shmSize: 0,
    start: false,
    stdinOpen: false,
    stopSignal: "string",
    stopTimeout: 0,
    storageOpts: {
        string: "string",
    },
    sysctls: {
        string: "string",
    },
    tmpfs: {
        string: "string",
    },
    tty: false,
    ulimits: [{
        hard: 0,
        name: "string",
        soft: 0,
    }],
    uploads: [{
        file: "string",
        content: "string",
        contentBase64: "string",
        executable: false,
        source: "string",
        sourceHash: "string",
    }],
    user: "string",
    usernsMode: "string",
    volumes: [{
        containerPath: "string",
        fromContainer: "string",
        hostPath: "string",
        readOnly: false,
        volumeName: "string",
    }],
    wait: false,
    waitTimeout: 0,
    workingDir: "string",
});

type: docker:Container
properties:
    attach: false
    capabilities:
        adds:
            - string
        drops:
            - string
    cgroupnsMode: string
    command:
        - string
    containerReadRefreshTimeoutMilliseconds: 0
    cpuSet: string
    cpuShares: 0
    destroyGraceSeconds: 0
    devices:
        - containerPath: string
          hostPath: string
          permissions: string
    dns:
        - string
    dnsOpts:
        - string
    dnsSearches:
        - string
    domainname: string
    entrypoints:
        - string
    envs:
        - string
    gpus: string
    groupAdds:
        - string
    healthcheck:
        interval: string
        retries: 0
        startPeriod: string
        tests:
            - string
        timeout: string
    hostname: string
    hosts:
        - host: string
          ip: string
    image: string
    init: false
    ipcMode: string
    labels:
        - label: string
          value: string
    logDriver: string
    logOpts:
        string: string
    logs: false
    maxRetryCount: 0
    memory: 0
    memorySwap: 0
    mounts:
        - bindOptions:
            propagation: string
          readOnly: false
          source: string
          target: string
          tmpfsOptions:
            mode: 0
            sizeBytes: 0
          type: string
          volumeOptions:
            driverName: string
            driverOptions:
                string: string
            labels:
                - label: string
                  value: string
            noCopy: false
    mustRun: false
    name: string
    networkMode: string
    networksAdvanced:
        - aliases:
            - string
          ipv4Address: string
          ipv6Address: string
          name: string
    pidMode: string
    ports:
        - external: 0
          internal: 0
          ip: string
          protocol: string
    privileged: false
    publishAllPorts: false
    readOnly: false
    removeVolumes: false
    restart: string
    rm: false
    runtime: string
    securityOpts:
        - string
    shmSize: 0
    start: false
    stdinOpen: false
    stopSignal: string
    stopTimeout: 0
    storageOpts:
        string: string
    sysctls:
        string: string
    tmpfs:
        string: string
    tty: false
    ulimits:
        - hard: 0
          name: string
          soft: 0
    uploads:
        - content: string
          contentBase64: string
          executable: false
          file: string
          source: string
          sourceHash: string
    user: string
    usernsMode: string
    volumes:
        - containerPath: string
          fromContainer: string
          hostPath: string
          readOnly: false
          volumeName: string
    wait: false
    waitTimeout: 0
    workingDir: string

Container 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 Container resource accepts the following input properties:

Image string: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
Attach bool: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
Capabilities ContainerCapabilities: Add or drop certrain linux capabilities.
CgroupnsMode string: Cgroup namespace mode to use for the container. Possible values are: private, host.
Command List<string>: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
ContainerReadRefreshTimeoutMilliseconds int: The total number of milliseconds to wait for the container to reach status 'running'
CpuSet string: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
CpuShares int: CPU shares (relative weight) for the container.
DestroyGraceSeconds int: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
Devices List<ContainerDevice>: Bind devices to the container.
Dns List<string>: DNS servers to use.
DnsOpts List<string>: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
DnsSearches List<string>: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
Domainname string: Domain name of the container.
Entrypoints List<string>: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
Envs List<string>: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
Gpus string: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
GroupAdds List<string>: Additional groups for the container user
Healthcheck ContainerHealthcheck: A test to perform to check that the container is healthy
Hostname string: Hostname of the container.
Hosts List<ContainerHost>: Additional hosts to add to the container.
Init bool: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
IpcMode string: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
Labels List<ContainerLabel>: User-defined key/value metadata
LogDriver string: The logging driver to use for the container.
LogOpts Dictionary<string, string>: Key/value pairs to use as options for the logging driver.
Logs bool: Save the container logs (attach must be enabled). Defaults to false.
MaxRetryCount int: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
Memory int: The memory limit for the container in MBs.
MemorySwap int: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
Mounts List<ContainerMount>: Specification for mounts to be added to containers created as part of the service.
MustRun bool
Name string: The name of the container.
NetworkMode string: Network mode of the container.
NetworksAdvanced List<ContainerNetworksAdvanced>: The networks the container is attached to
PidMode string: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
Ports List<ContainerPort>: Publish a container's port(s) to the host.
Privileged bool: If true, the container runs in privileged mode.
PublishAllPorts bool: Publish all ports of the container.
ReadOnly bool: If true, the container will be started as readonly. Defaults to false.
RemoveVolumes bool: If true, it will remove anonymous volumes associated with the container. Defaults to true.
Restart string: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
Rm bool: If true, then the container will be automatically removed when it exits. Defaults to false.
Runtime string: Runtime to use for the container.
SecurityOpts List<string>: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
ShmSize int: Size of /dev/shm in MBs.
Start bool: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
StdinOpen bool: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
StopSignal string: Signal to stop a container (default SIGTERM).
StopTimeout int: Timeout (in seconds) to stop a container.
StorageOpts Dictionary<string, string>: Key/value pairs for the storage driver options, e.g. size: 120G
Sysctls Dictionary<string, string>: A map of kernel parameters (sysctls) to set in the container.
Tmpfs Dictionary<string, string>: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
Tty bool: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
Ulimits List<ContainerUlimit>: Ulimit options to add.
Uploads List<ContainerUpload>: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
User string: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
UsernsMode string: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
Volumes List<ContainerVolume>: Spec for mounting volumes in the container.
Wait bool: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
WaitTimeout int: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
WorkingDir string: The working directory for commands to run in.

Image string: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
Attach bool: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
Capabilities ContainerCapabilitiesArgs: Add or drop certrain linux capabilities.
CgroupnsMode string: Cgroup namespace mode to use for the container. Possible values are: private, host.
Command []string: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
ContainerReadRefreshTimeoutMilliseconds int: The total number of milliseconds to wait for the container to reach status 'running'
CpuSet string: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
CpuShares int: CPU shares (relative weight) for the container.
DestroyGraceSeconds int: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
Devices []ContainerDeviceArgs: Bind devices to the container.
Dns []string: DNS servers to use.
DnsOpts []string: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
DnsSearches []string: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
Domainname string: Domain name of the container.
Entrypoints []string: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
Envs []string: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
Gpus string: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
GroupAdds []string: Additional groups for the container user
Healthcheck ContainerHealthcheckArgs: A test to perform to check that the container is healthy
Hostname string: Hostname of the container.
Hosts []ContainerHostArgs: Additional hosts to add to the container.
Init bool: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
IpcMode string: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
Labels []ContainerLabelArgs: User-defined key/value metadata
LogDriver string: The logging driver to use for the container.
LogOpts map[string]string: Key/value pairs to use as options for the logging driver.
Logs bool: Save the container logs (attach must be enabled). Defaults to false.
MaxRetryCount int: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
Memory int: The memory limit for the container in MBs.
MemorySwap int: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
Mounts []ContainerMountArgs: Specification for mounts to be added to containers created as part of the service.
MustRun bool
Name string: The name of the container.
NetworkMode string: Network mode of the container.
NetworksAdvanced []ContainerNetworksAdvancedArgs: The networks the container is attached to
PidMode string: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
Ports []ContainerPortArgs: Publish a container's port(s) to the host.
Privileged bool: If true, the container runs in privileged mode.
PublishAllPorts bool: Publish all ports of the container.
ReadOnly bool: If true, the container will be started as readonly. Defaults to false.
RemoveVolumes bool: If true, it will remove anonymous volumes associated with the container. Defaults to true.
Restart string: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
Rm bool: If true, then the container will be automatically removed when it exits. Defaults to false.
Runtime string: Runtime to use for the container.
SecurityOpts []string: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
ShmSize int: Size of /dev/shm in MBs.
Start bool: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
StdinOpen bool: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
StopSignal string: Signal to stop a container (default SIGTERM).
StopTimeout int: Timeout (in seconds) to stop a container.
StorageOpts map[string]string: Key/value pairs for the storage driver options, e.g. size: 120G
Sysctls map[string]string: A map of kernel parameters (sysctls) to set in the container.
Tmpfs map[string]string: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
Tty bool: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
Ulimits []ContainerUlimitArgs: Ulimit options to add.
Uploads []ContainerUploadArgs: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
User string: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
UsernsMode string: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
Volumes []ContainerVolumeArgs: Spec for mounting volumes in the container.
Wait bool: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
WaitTimeout int: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
WorkingDir string: The working directory for commands to run in.

image String: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
attach Boolean: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
capabilities ContainerCapabilities: Add or drop certrain linux capabilities.
cgroupnsMode String: Cgroup namespace mode to use for the container. Possible values are: private, host.
command List<String>: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
containerReadRefreshTimeoutMilliseconds Integer: The total number of milliseconds to wait for the container to reach status 'running'
cpuSet String: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpuShares Integer: CPU shares (relative weight) for the container.
destroyGraceSeconds Integer: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices List<ContainerDevice>: Bind devices to the container.
dns List<String>: DNS servers to use.
dnsOpts List<String>: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dnsSearches List<String>: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname String: Domain name of the container.
entrypoints List<String>: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs List<String>: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
gpus String: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
groupAdds List<String>: Additional groups for the container user
healthcheck ContainerHealthcheck: A test to perform to check that the container is healthy
hostname String: Hostname of the container.
hosts List<ContainerHost>: Additional hosts to add to the container.
init Boolean: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipcMode String: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels List<ContainerLabel>: User-defined key/value metadata
logDriver String: The logging driver to use for the container.
logOpts Map<String,String>: Key/value pairs to use as options for the logging driver.
logs Boolean: Save the container logs (attach must be enabled). Defaults to false.
maxRetryCount Integer: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory Integer: The memory limit for the container in MBs.
memorySwap Integer: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts List<ContainerMount>: Specification for mounts to be added to containers created as part of the service.
mustRun Boolean
name String: The name of the container.
networkMode String: Network mode of the container.
networksAdvanced List<ContainerNetworksAdvanced>: The networks the container is attached to
pidMode String: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports List<ContainerPort>: Publish a container's port(s) to the host.
privileged Boolean: If true, the container runs in privileged mode.
publishAllPorts Boolean: Publish all ports of the container.
readOnly Boolean: If true, the container will be started as readonly. Defaults to false.
removeVolumes Boolean: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart String: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm Boolean: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime String: Runtime to use for the container.
securityOpts List<String>: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shmSize Integer: Size of /dev/shm in MBs.
start Boolean: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdinOpen Boolean: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stopSignal String: Signal to stop a container (default SIGTERM).
stopTimeout Integer: Timeout (in seconds) to stop a container.
storageOpts Map<String,String>: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls Map<String,String>: A map of kernel parameters (sysctls) to set in the container.
tmpfs Map<String,String>: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty Boolean: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits List<ContainerUlimit>: Ulimit options to add.
uploads List<ContainerUpload>: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user String: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
usernsMode String: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes List<ContainerVolume>: Spec for mounting volumes in the container.
waitTimeout Integer: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
wait_ Boolean: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
workingDir String: The working directory for commands to run in.

image string: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
attach boolean: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
capabilities ContainerCapabilities: Add or drop certrain linux capabilities.
cgroupnsMode string: Cgroup namespace mode to use for the container. Possible values are: private, host.
command string[]: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
containerReadRefreshTimeoutMilliseconds number: The total number of milliseconds to wait for the container to reach status 'running'
cpuSet string: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpuShares number: CPU shares (relative weight) for the container.
destroyGraceSeconds number: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices ContainerDevice[]: Bind devices to the container.
dns string[]: DNS servers to use.
dnsOpts string[]: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dnsSearches string[]: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname string: Domain name of the container.
entrypoints string[]: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs string[]: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
gpus string: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
groupAdds string[]: Additional groups for the container user
healthcheck ContainerHealthcheck: A test to perform to check that the container is healthy
hostname string: Hostname of the container.
hosts ContainerHost[]: Additional hosts to add to the container.
init boolean: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipcMode string: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels ContainerLabel[]: User-defined key/value metadata
logDriver string: The logging driver to use for the container.
logOpts {[key: string]: string}: Key/value pairs to use as options for the logging driver.
logs boolean: Save the container logs (attach must be enabled). Defaults to false.
maxRetryCount number: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory number: The memory limit for the container in MBs.
memorySwap number: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts ContainerMount[]: Specification for mounts to be added to containers created as part of the service.
mustRun boolean
name string: The name of the container.
networkMode string: Network mode of the container.
networksAdvanced ContainerNetworksAdvanced[]: The networks the container is attached to
pidMode string: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports ContainerPort[]: Publish a container's port(s) to the host.
privileged boolean: If true, the container runs in privileged mode.
publishAllPorts boolean: Publish all ports of the container.
readOnly boolean: If true, the container will be started as readonly. Defaults to false.
removeVolumes boolean: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart string: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm boolean: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime string: Runtime to use for the container.
securityOpts string[]: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shmSize number: Size of /dev/shm in MBs.
start boolean: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdinOpen boolean: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stopSignal string: Signal to stop a container (default SIGTERM).
stopTimeout number: Timeout (in seconds) to stop a container.
storageOpts {[key: string]: string}: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls {[key: string]: string}: A map of kernel parameters (sysctls) to set in the container.
tmpfs {[key: string]: string}: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty boolean: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits ContainerUlimit[]: Ulimit options to add.
uploads ContainerUpload[]: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user string: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
usernsMode string: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes ContainerVolume[]: Spec for mounting volumes in the container.
wait boolean: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
waitTimeout number: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
workingDir string: The working directory for commands to run in.

image str: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
attach bool: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
capabilities ContainerCapabilitiesArgs: Add or drop certrain linux capabilities.
cgroupns_mode str: Cgroup namespace mode to use for the container. Possible values are: private, host.
command Sequence[str]: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
container_read_refresh_timeout_milliseconds int: The total number of milliseconds to wait for the container to reach status 'running'
cpu_set str: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpu_shares int: CPU shares (relative weight) for the container.
destroy_grace_seconds int: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices Sequence[ContainerDeviceArgs]: Bind devices to the container.
dns Sequence[str]: DNS servers to use.
dns_opts Sequence[str]: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dns_searches Sequence[str]: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname str: Domain name of the container.
entrypoints Sequence[str]: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs Sequence[str]: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
gpus str: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
group_adds Sequence[str]: Additional groups for the container user
healthcheck ContainerHealthcheckArgs: A test to perform to check that the container is healthy
hostname str: Hostname of the container.
hosts Sequence[ContainerHostArgs]: Additional hosts to add to the container.
init bool: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipc_mode str: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels Sequence[ContainerLabelArgs]: User-defined key/value metadata
log_driver str: The logging driver to use for the container.
log_opts Mapping[str, str]: Key/value pairs to use as options for the logging driver.
logs bool: Save the container logs (attach must be enabled). Defaults to false.
max_retry_count int: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory int: The memory limit for the container in MBs.
memory_swap int: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts Sequence[ContainerMountArgs]: Specification for mounts to be added to containers created as part of the service.
must_run bool
name str: The name of the container.
network_mode str: Network mode of the container.
networks_advanced Sequence[ContainerNetworksAdvancedArgs]: The networks the container is attached to
pid_mode str: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports Sequence[ContainerPortArgs]: Publish a container's port(s) to the host.
privileged bool: If true, the container runs in privileged mode.
publish_all_ports bool: Publish all ports of the container.
read_only bool: If true, the container will be started as readonly. Defaults to false.
remove_volumes bool: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart str: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm bool: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime str: Runtime to use for the container.
security_opts Sequence[str]: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shm_size int: Size of /dev/shm in MBs.
start bool: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdin_open bool: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stop_signal str: Signal to stop a container (default SIGTERM).
stop_timeout int: Timeout (in seconds) to stop a container.
storage_opts Mapping[str, str]: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls Mapping[str, str]: A map of kernel parameters (sysctls) to set in the container.
tmpfs Mapping[str, str]: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty bool: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits Sequence[ContainerUlimitArgs]: Ulimit options to add.
uploads Sequence[ContainerUploadArgs]: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user str: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
userns_mode str: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes Sequence[ContainerVolumeArgs]: Spec for mounting volumes in the container.
wait bool: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
wait_timeout int: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
working_dir str: The working directory for commands to run in.

image String: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
attach Boolean: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
capabilities Property Map: Add or drop certrain linux capabilities.
cgroupnsMode String: Cgroup namespace mode to use for the container. Possible values are: private, host.
command List<String>: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
containerReadRefreshTimeoutMilliseconds Number: The total number of milliseconds to wait for the container to reach status 'running'
cpuSet String: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpuShares Number: CPU shares (relative weight) for the container.
destroyGraceSeconds Number: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices List<Property Map>: Bind devices to the container.
dns List<String>: DNS servers to use.
dnsOpts List<String>: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dnsSearches List<String>: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname String: Domain name of the container.
entrypoints List<String>: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs List<String>: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
gpus String: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
groupAdds List<String>: Additional groups for the container user
healthcheck Property Map: A test to perform to check that the container is healthy
hostname String: Hostname of the container.
hosts List<Property Map>: Additional hosts to add to the container.
init Boolean: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipcMode String: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels List<Property Map>: User-defined key/value metadata
logDriver String: The logging driver to use for the container.
logOpts Map<String>: Key/value pairs to use as options for the logging driver.
logs Boolean: Save the container logs (attach must be enabled). Defaults to false.
maxRetryCount Number: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory Number: The memory limit for the container in MBs.
memorySwap Number: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts List<Property Map>: Specification for mounts to be added to containers created as part of the service.
mustRun Boolean
name String: The name of the container.
networkMode String: Network mode of the container.
networksAdvanced List<Property Map>: The networks the container is attached to
pidMode String: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports List<Property Map>: Publish a container's port(s) to the host.
privileged Boolean: If true, the container runs in privileged mode.
publishAllPorts Boolean: Publish all ports of the container.
readOnly Boolean: If true, the container will be started as readonly. Defaults to false.
removeVolumes Boolean: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart String: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm Boolean: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime String: Runtime to use for the container.
securityOpts List<String>: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shmSize Number: Size of /dev/shm in MBs.
start Boolean: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdinOpen Boolean: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stopSignal String: Signal to stop a container (default SIGTERM).
stopTimeout Number: Timeout (in seconds) to stop a container.
storageOpts Map<String>: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls Map<String>: A map of kernel parameters (sysctls) to set in the container.
tmpfs Map<String>: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty Boolean: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits List<Property Map>: Ulimit options to add.
uploads List<Property Map>: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user String: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
usernsMode String: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes List<Property Map>: Spec for mounting volumes in the container.
wait Boolean: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
waitTimeout Number: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
workingDir String: The working directory for commands to run in.

Outputs

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

Bridge string: The network bridge of the container as read from its NetworkSettings.
ContainerLogs string: The logs of the container if its execution is done (attach must be disabled).
ExitCode int: The exit code of the container if its execution is done (must_run must be disabled).
Id string: The provider-assigned unique ID for this managed resource.
NetworkDatas List<ContainerNetworkData>: The data of the networks the container is connected to.

Bridge string: The network bridge of the container as read from its NetworkSettings.
ContainerLogs string: The logs of the container if its execution is done (attach must be disabled).
ExitCode int: The exit code of the container if its execution is done (must_run must be disabled).
Id string: The provider-assigned unique ID for this managed resource.
NetworkDatas []ContainerNetworkData: The data of the networks the container is connected to.

bridge String: The network bridge of the container as read from its NetworkSettings.
containerLogs String: The logs of the container if its execution is done (attach must be disabled).
exitCode Integer: The exit code of the container if its execution is done (must_run must be disabled).
id String: The provider-assigned unique ID for this managed resource.
networkDatas List<ContainerNetworkData>: The data of the networks the container is connected to.

bridge string: The network bridge of the container as read from its NetworkSettings.
containerLogs string: The logs of the container if its execution is done (attach must be disabled).
exitCode number: The exit code of the container if its execution is done (must_run must be disabled).
id string: The provider-assigned unique ID for this managed resource.
networkDatas ContainerNetworkData[]: The data of the networks the container is connected to.

bridge str: The network bridge of the container as read from its NetworkSettings.
container_logs str: The logs of the container if its execution is done (attach must be disabled).
exit_code int: The exit code of the container if its execution is done (must_run must be disabled).
id str: The provider-assigned unique ID for this managed resource.
network_datas Sequence[ContainerNetworkData]: The data of the networks the container is connected to.

bridge String: The network bridge of the container as read from its NetworkSettings.
containerLogs String: The logs of the container if its execution is done (attach must be disabled).
exitCode Number: The exit code of the container if its execution is done (must_run must be disabled).
id String: The provider-assigned unique ID for this managed resource.
networkDatas List<Property Map>: The data of the networks the container is connected to.

Look up Existing Container Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: ContainerState, opts?: CustomResourceOptions): Container

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attach: Optional[bool] = None,
        bridge: Optional[str] = None,
        capabilities: Optional[ContainerCapabilitiesArgs] = None,
        cgroupns_mode: Optional[str] = None,
        command: Optional[Sequence[str]] = None,
        container_logs: Optional[str] = None,
        container_read_refresh_timeout_milliseconds: Optional[int] = None,
        cpu_set: Optional[str] = None,
        cpu_shares: Optional[int] = None,
        destroy_grace_seconds: Optional[int] = None,
        devices: Optional[Sequence[ContainerDeviceArgs]] = None,
        dns: Optional[Sequence[str]] = None,
        dns_opts: Optional[Sequence[str]] = None,
        dns_searches: Optional[Sequence[str]] = None,
        domainname: Optional[str] = None,
        entrypoints: Optional[Sequence[str]] = None,
        envs: Optional[Sequence[str]] = None,
        exit_code: Optional[int] = None,
        gpus: Optional[str] = None,
        group_adds: Optional[Sequence[str]] = None,
        healthcheck: Optional[ContainerHealthcheckArgs] = None,
        hostname: Optional[str] = None,
        hosts: Optional[Sequence[ContainerHostArgs]] = None,
        image: Optional[str] = None,
        init: Optional[bool] = None,
        ipc_mode: Optional[str] = None,
        labels: Optional[Sequence[ContainerLabelArgs]] = None,
        log_driver: Optional[str] = None,
        log_opts: Optional[Mapping[str, str]] = None,
        logs: Optional[bool] = None,
        max_retry_count: Optional[int] = None,
        memory: Optional[int] = None,
        memory_swap: Optional[int] = None,
        mounts: Optional[Sequence[ContainerMountArgs]] = None,
        must_run: Optional[bool] = None,
        name: Optional[str] = None,
        network_datas: Optional[Sequence[ContainerNetworkDataArgs]] = None,
        network_mode: Optional[str] = None,
        networks_advanced: Optional[Sequence[ContainerNetworksAdvancedArgs]] = None,
        pid_mode: Optional[str] = None,
        ports: Optional[Sequence[ContainerPortArgs]] = None,
        privileged: Optional[bool] = None,
        publish_all_ports: Optional[bool] = None,
        read_only: Optional[bool] = None,
        remove_volumes: Optional[bool] = None,
        restart: Optional[str] = None,
        rm: Optional[bool] = None,
        runtime: Optional[str] = None,
        security_opts: Optional[Sequence[str]] = None,
        shm_size: Optional[int] = None,
        start: Optional[bool] = None,
        stdin_open: Optional[bool] = None,
        stop_signal: Optional[str] = None,
        stop_timeout: Optional[int] = None,
        storage_opts: Optional[Mapping[str, str]] = None,
        sysctls: Optional[Mapping[str, str]] = None,
        tmpfs: Optional[Mapping[str, str]] = None,
        tty: Optional[bool] = None,
        ulimits: Optional[Sequence[ContainerUlimitArgs]] = None,
        uploads: Optional[Sequence[ContainerUploadArgs]] = None,
        user: Optional[str] = None,
        userns_mode: Optional[str] = None,
        volumes: Optional[Sequence[ContainerVolumeArgs]] = None,
        wait: Optional[bool] = None,
        wait_timeout: Optional[int] = None,
        working_dir: Optional[str] = None) -> Container

func GetContainer(ctx *Context, name string, id IDInput, state *ContainerState, opts ...ResourceOption) (*Container, error)

public static Container Get(string name, Input<string> id, ContainerState? state, CustomResourceOptions? opts = null)

public static Container get(String name, Output<String> id, ContainerState state, CustomResourceOptions options)

resources:  _:    type: docker:Container    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:

Attach bool: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
Bridge string: The network bridge of the container as read from its NetworkSettings.
Capabilities ContainerCapabilities: Add or drop certrain linux capabilities.
CgroupnsMode string: Cgroup namespace mode to use for the container. Possible values are: private, host.
Command List<string>: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
ContainerLogs string: The logs of the container if its execution is done (attach must be disabled).
ContainerReadRefreshTimeoutMilliseconds int: The total number of milliseconds to wait for the container to reach status 'running'
CpuSet string: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
CpuShares int: CPU shares (relative weight) for the container.
DestroyGraceSeconds int: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
Devices List<ContainerDevice>: Bind devices to the container.
Dns List<string>: DNS servers to use.
DnsOpts List<string>: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
DnsSearches List<string>: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
Domainname string: Domain name of the container.
Entrypoints List<string>: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
Envs List<string>: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
ExitCode int: The exit code of the container if its execution is done (must_run must be disabled).
Gpus string: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
GroupAdds List<string>: Additional groups for the container user
Healthcheck ContainerHealthcheck: A test to perform to check that the container is healthy
Hostname string: Hostname of the container.
Hosts List<ContainerHost>: Additional hosts to add to the container.
Image string: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
Init bool: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
IpcMode string: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
Labels List<ContainerLabel>: User-defined key/value metadata
LogDriver string: The logging driver to use for the container.
LogOpts Dictionary<string, string>: Key/value pairs to use as options for the logging driver.
Logs bool: Save the container logs (attach must be enabled). Defaults to false.
MaxRetryCount int: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
Memory int: The memory limit for the container in MBs.
MemorySwap int: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
Mounts List<ContainerMount>: Specification for mounts to be added to containers created as part of the service.
MustRun bool
Name string: The name of the container.
NetworkDatas List<ContainerNetworkData>: The data of the networks the container is connected to.
NetworkMode string: Network mode of the container.
NetworksAdvanced List<ContainerNetworksAdvanced>: The networks the container is attached to
PidMode string: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
Ports List<ContainerPort>: Publish a container's port(s) to the host.
Privileged bool: If true, the container runs in privileged mode.
PublishAllPorts bool: Publish all ports of the container.
ReadOnly bool: If true, the container will be started as readonly. Defaults to false.
RemoveVolumes bool: If true, it will remove anonymous volumes associated with the container. Defaults to true.
Restart string: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
Rm bool: If true, then the container will be automatically removed when it exits. Defaults to false.
Runtime string: Runtime to use for the container.
SecurityOpts List<string>: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
ShmSize int: Size of /dev/shm in MBs.
Start bool: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
StdinOpen bool: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
StopSignal string: Signal to stop a container (default SIGTERM).
StopTimeout int: Timeout (in seconds) to stop a container.
StorageOpts Dictionary<string, string>: Key/value pairs for the storage driver options, e.g. size: 120G
Sysctls Dictionary<string, string>: A map of kernel parameters (sysctls) to set in the container.
Tmpfs Dictionary<string, string>: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
Tty bool: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
Ulimits List<ContainerUlimit>: Ulimit options to add.
Uploads List<ContainerUpload>: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
User string: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
UsernsMode string: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
Volumes List<ContainerVolume>: Spec for mounting volumes in the container.
Wait bool: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
WaitTimeout int: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
WorkingDir string: The working directory for commands to run in.

Attach bool: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
Bridge string: The network bridge of the container as read from its NetworkSettings.
Capabilities ContainerCapabilitiesArgs: Add or drop certrain linux capabilities.
CgroupnsMode string: Cgroup namespace mode to use for the container. Possible values are: private, host.
Command []string: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
ContainerLogs string: The logs of the container if its execution is done (attach must be disabled).
ContainerReadRefreshTimeoutMilliseconds int: The total number of milliseconds to wait for the container to reach status 'running'
CpuSet string: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
CpuShares int: CPU shares (relative weight) for the container.
DestroyGraceSeconds int: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
Devices []ContainerDeviceArgs: Bind devices to the container.
Dns []string: DNS servers to use.
DnsOpts []string: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
DnsSearches []string: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
Domainname string: Domain name of the container.
Entrypoints []string: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
Envs []string: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
ExitCode int: The exit code of the container if its execution is done (must_run must be disabled).
Gpus string: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
GroupAdds []string: Additional groups for the container user
Healthcheck ContainerHealthcheckArgs: A test to perform to check that the container is healthy
Hostname string: Hostname of the container.
Hosts []ContainerHostArgs: Additional hosts to add to the container.
Image string: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
Init bool: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
IpcMode string: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
Labels []ContainerLabelArgs: User-defined key/value metadata
LogDriver string: The logging driver to use for the container.
LogOpts map[string]string: Key/value pairs to use as options for the logging driver.
Logs bool: Save the container logs (attach must be enabled). Defaults to false.
MaxRetryCount int: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
Memory int: The memory limit for the container in MBs.
MemorySwap int: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
Mounts []ContainerMountArgs: Specification for mounts to be added to containers created as part of the service.
MustRun bool
Name string: The name of the container.
NetworkDatas []ContainerNetworkDataArgs: The data of the networks the container is connected to.
NetworkMode string: Network mode of the container.
NetworksAdvanced []ContainerNetworksAdvancedArgs: The networks the container is attached to
PidMode string: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
Ports []ContainerPortArgs: Publish a container's port(s) to the host.
Privileged bool: If true, the container runs in privileged mode.
PublishAllPorts bool: Publish all ports of the container.
ReadOnly bool: If true, the container will be started as readonly. Defaults to false.
RemoveVolumes bool: If true, it will remove anonymous volumes associated with the container. Defaults to true.
Restart string: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
Rm bool: If true, then the container will be automatically removed when it exits. Defaults to false.
Runtime string: Runtime to use for the container.
SecurityOpts []string: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
ShmSize int: Size of /dev/shm in MBs.
Start bool: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
StdinOpen bool: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
StopSignal string: Signal to stop a container (default SIGTERM).
StopTimeout int: Timeout (in seconds) to stop a container.
StorageOpts map[string]string: Key/value pairs for the storage driver options, e.g. size: 120G
Sysctls map[string]string: A map of kernel parameters (sysctls) to set in the container.
Tmpfs map[string]string: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
Tty bool: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
Ulimits []ContainerUlimitArgs: Ulimit options to add.
Uploads []ContainerUploadArgs: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
User string: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
UsernsMode string: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
Volumes []ContainerVolumeArgs: Spec for mounting volumes in the container.
Wait bool: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
WaitTimeout int: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
WorkingDir string: The working directory for commands to run in.

attach Boolean: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
bridge String: The network bridge of the container as read from its NetworkSettings.
capabilities ContainerCapabilities: Add or drop certrain linux capabilities.
cgroupnsMode String: Cgroup namespace mode to use for the container. Possible values are: private, host.
command List<String>: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
containerLogs String: The logs of the container if its execution is done (attach must be disabled).
containerReadRefreshTimeoutMilliseconds Integer: The total number of milliseconds to wait for the container to reach status 'running'
cpuSet String: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpuShares Integer: CPU shares (relative weight) for the container.
destroyGraceSeconds Integer: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices List<ContainerDevice>: Bind devices to the container.
dns List<String>: DNS servers to use.
dnsOpts List<String>: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dnsSearches List<String>: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname String: Domain name of the container.
entrypoints List<String>: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs List<String>: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
exitCode Integer: The exit code of the container if its execution is done (must_run must be disabled).
gpus String: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
groupAdds List<String>: Additional groups for the container user
healthcheck ContainerHealthcheck: A test to perform to check that the container is healthy
hostname String: Hostname of the container.
hosts List<ContainerHost>: Additional hosts to add to the container.
image String: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
init Boolean: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipcMode String: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels List<ContainerLabel>: User-defined key/value metadata
logDriver String: The logging driver to use for the container.
logOpts Map<String,String>: Key/value pairs to use as options for the logging driver.
logs Boolean: Save the container logs (attach must be enabled). Defaults to false.
maxRetryCount Integer: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory Integer: The memory limit for the container in MBs.
memorySwap Integer: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts List<ContainerMount>: Specification for mounts to be added to containers created as part of the service.
mustRun Boolean
name String: The name of the container.
networkDatas List<ContainerNetworkData>: The data of the networks the container is connected to.
networkMode String: Network mode of the container.
networksAdvanced List<ContainerNetworksAdvanced>: The networks the container is attached to
pidMode String: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports List<ContainerPort>: Publish a container's port(s) to the host.
privileged Boolean: If true, the container runs in privileged mode.
publishAllPorts Boolean: Publish all ports of the container.
readOnly Boolean: If true, the container will be started as readonly. Defaults to false.
removeVolumes Boolean: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart String: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm Boolean: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime String: Runtime to use for the container.
securityOpts List<String>: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shmSize Integer: Size of /dev/shm in MBs.
start Boolean: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdinOpen Boolean: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stopSignal String: Signal to stop a container (default SIGTERM).
stopTimeout Integer: Timeout (in seconds) to stop a container.
storageOpts Map<String,String>: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls Map<String,String>: A map of kernel parameters (sysctls) to set in the container.
tmpfs Map<String,String>: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty Boolean: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits List<ContainerUlimit>: Ulimit options to add.
uploads List<ContainerUpload>: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user String: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
usernsMode String: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes List<ContainerVolume>: Spec for mounting volumes in the container.
waitTimeout Integer: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
wait_ Boolean: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
workingDir String: The working directory for commands to run in.

attach boolean: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
bridge string: The network bridge of the container as read from its NetworkSettings.
capabilities ContainerCapabilities: Add or drop certrain linux capabilities.
cgroupnsMode string: Cgroup namespace mode to use for the container. Possible values are: private, host.
command string[]: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
containerLogs string: The logs of the container if its execution is done (attach must be disabled).
containerReadRefreshTimeoutMilliseconds number: The total number of milliseconds to wait for the container to reach status 'running'
cpuSet string: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpuShares number: CPU shares (relative weight) for the container.
destroyGraceSeconds number: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices ContainerDevice[]: Bind devices to the container.
dns string[]: DNS servers to use.
dnsOpts string[]: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dnsSearches string[]: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname string: Domain name of the container.
entrypoints string[]: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs string[]: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
exitCode number: The exit code of the container if its execution is done (must_run must be disabled).
gpus string: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
groupAdds string[]: Additional groups for the container user
healthcheck ContainerHealthcheck: A test to perform to check that the container is healthy
hostname string: Hostname of the container.
hosts ContainerHost[]: Additional hosts to add to the container.
image string: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
init boolean: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipcMode string: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels ContainerLabel[]: User-defined key/value metadata
logDriver string: The logging driver to use for the container.
logOpts {[key: string]: string}: Key/value pairs to use as options for the logging driver.
logs boolean: Save the container logs (attach must be enabled). Defaults to false.
maxRetryCount number: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory number: The memory limit for the container in MBs.
memorySwap number: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts ContainerMount[]: Specification for mounts to be added to containers created as part of the service.
mustRun boolean
name string: The name of the container.
networkDatas ContainerNetworkData[]: The data of the networks the container is connected to.
networkMode string: Network mode of the container.
networksAdvanced ContainerNetworksAdvanced[]: The networks the container is attached to
pidMode string: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports ContainerPort[]: Publish a container's port(s) to the host.
privileged boolean: If true, the container runs in privileged mode.
publishAllPorts boolean: Publish all ports of the container.
readOnly boolean: If true, the container will be started as readonly. Defaults to false.
removeVolumes boolean: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart string: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm boolean: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime string: Runtime to use for the container.
securityOpts string[]: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shmSize number: Size of /dev/shm in MBs.
start boolean: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdinOpen boolean: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stopSignal string: Signal to stop a container (default SIGTERM).
stopTimeout number: Timeout (in seconds) to stop a container.
storageOpts {[key: string]: string}: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls {[key: string]: string}: A map of kernel parameters (sysctls) to set in the container.
tmpfs {[key: string]: string}: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty boolean: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits ContainerUlimit[]: Ulimit options to add.
uploads ContainerUpload[]: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user string: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
usernsMode string: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes ContainerVolume[]: Spec for mounting volumes in the container.
wait boolean: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
waitTimeout number: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
workingDir string: The working directory for commands to run in.

attach bool: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
bridge str: The network bridge of the container as read from its NetworkSettings.
capabilities ContainerCapabilitiesArgs: Add or drop certrain linux capabilities.
cgroupns_mode str: Cgroup namespace mode to use for the container. Possible values are: private, host.
command Sequence[str]: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
container_logs str: The logs of the container if its execution is done (attach must be disabled).
container_read_refresh_timeout_milliseconds int: The total number of milliseconds to wait for the container to reach status 'running'
cpu_set str: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpu_shares int: CPU shares (relative weight) for the container.
destroy_grace_seconds int: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices Sequence[ContainerDeviceArgs]: Bind devices to the container.
dns Sequence[str]: DNS servers to use.
dns_opts Sequence[str]: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dns_searches Sequence[str]: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname str: Domain name of the container.
entrypoints Sequence[str]: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs Sequence[str]: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
exit_code int: The exit code of the container if its execution is done (must_run must be disabled).
gpus str: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
group_adds Sequence[str]: Additional groups for the container user
healthcheck ContainerHealthcheckArgs: A test to perform to check that the container is healthy
hostname str: Hostname of the container.
hosts Sequence[ContainerHostArgs]: Additional hosts to add to the container.
image str: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
init bool: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipc_mode str: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels Sequence[ContainerLabelArgs]: User-defined key/value metadata
log_driver str: The logging driver to use for the container.
log_opts Mapping[str, str]: Key/value pairs to use as options for the logging driver.
logs bool: Save the container logs (attach must be enabled). Defaults to false.
max_retry_count int: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory int: The memory limit for the container in MBs.
memory_swap int: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts Sequence[ContainerMountArgs]: Specification for mounts to be added to containers created as part of the service.
must_run bool
name str: The name of the container.
network_datas Sequence[ContainerNetworkDataArgs]: The data of the networks the container is connected to.
network_mode str: Network mode of the container.
networks_advanced Sequence[ContainerNetworksAdvancedArgs]: The networks the container is attached to
pid_mode str: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports Sequence[ContainerPortArgs]: Publish a container's port(s) to the host.
privileged bool: If true, the container runs in privileged mode.
publish_all_ports bool: Publish all ports of the container.
read_only bool: If true, the container will be started as readonly. Defaults to false.
remove_volumes bool: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart str: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm bool: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime str: Runtime to use for the container.
security_opts Sequence[str]: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shm_size int: Size of /dev/shm in MBs.
start bool: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdin_open bool: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stop_signal str: Signal to stop a container (default SIGTERM).
stop_timeout int: Timeout (in seconds) to stop a container.
storage_opts Mapping[str, str]: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls Mapping[str, str]: A map of kernel parameters (sysctls) to set in the container.
tmpfs Mapping[str, str]: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty bool: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits Sequence[ContainerUlimitArgs]: Ulimit options to add.
uploads Sequence[ContainerUploadArgs]: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user str: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
userns_mode str: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes Sequence[ContainerVolumeArgs]: Spec for mounting volumes in the container.
wait bool: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
wait_timeout int: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
working_dir str: The working directory for commands to run in.

attach Boolean: If true attach to the container after its creation and waits the end of its execution. Defaults to false.
bridge String: The network bridge of the container as read from its NetworkSettings.
capabilities Property Map: Add or drop certrain linux capabilities.
cgroupnsMode String: Cgroup namespace mode to use for the container. Possible values are: private, host.
command List<String>: The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram","-f","baz.con"].
containerLogs String: The logs of the container if its execution is done (attach must be disabled).
containerReadRefreshTimeoutMilliseconds Number: The total number of milliseconds to wait for the container to reach status 'running'
cpuSet String: A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.
cpuShares Number: CPU shares (relative weight) for the container.
destroyGraceSeconds Number: If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.
devices List<Property Map>: Bind devices to the container.
dns List<String>: DNS servers to use.
dnsOpts List<String>: DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.
dnsSearches List<String>: DNS search domains that are used when bare unqualified hostnames are used inside of the container.
domainname String: Domain name of the container.
entrypoints List<String>: The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be "/usr/bin/myprogra"].
envs List<String>: Environment variables to set in the form of KEY=VALUE, e.g. DEBUG=0
exitCode Number: The exit code of the container if its execution is done (must_run must be disabled).
gpus String: GPU devices to add to the container. Currently, only the value all is supported. Passing any other value will result in unexpected behavior.
groupAdds List<String>: Additional groups for the container user
healthcheck Property Map: A test to perform to check that the container is healthy
hostname String: Hostname of the container.
hosts List<Property Map>: Additional hosts to add to the container.
image String: The ID of the image to back this container. The easiest way to get this value is to use the docker.RemoteImage resource as is shown in the example.
init Boolean: Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.
ipcMode String: IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.
labels List<Property Map>: User-defined key/value metadata
logDriver String: The logging driver to use for the container.
logOpts Map<String>: Key/value pairs to use as options for the logging driver.
logs Boolean: Save the container logs (attach must be enabled). Defaults to false.
maxRetryCount Number: The maximum amount of times to an attempt a restart when restart is set to 'on-failure'.
memory Number: The memory limit for the container in MBs.
memorySwap Number: The total memory limit (memory + swap) for the container in MBs. This setting may compute to -1 after pulumi up if the target host doesn't support memory swap, when that is the case docker will use a soft limitation.
mounts List<Property Map>: Specification for mounts to be added to containers created as part of the service.
mustRun Boolean
name String: The name of the container.
networkDatas List<Property Map>: The data of the networks the container is connected to.
networkMode String: Network mode of the container.
networksAdvanced List<Property Map>: The networks the container is attached to
pidMode String: he PID (Process) Namespace mode for the container. Either container:<name|id> or host.
ports List<Property Map>: Publish a container's port(s) to the host.
privileged Boolean: If true, the container runs in privileged mode.
publishAllPorts Boolean: Publish all ports of the container.
readOnly Boolean: If true, the container will be started as readonly. Defaults to false.
removeVolumes Boolean: If true, it will remove anonymous volumes associated with the container. Defaults to true.
restart String: The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no.
rm Boolean: If true, then the container will be automatically removed when it exits. Defaults to false.
runtime String: Runtime to use for the container.
securityOpts List<String>: List of string values to customize labels for MLS systems, such as SELinux. See https://docs.docker.com/engine/reference/run/#security-configuration.
shmSize Number: Size of /dev/shm in MBs.
start Boolean: If true, then the Docker container will be started after creation. If false, then the container is only created. Defaults to true.
stdinOpen Boolean: If true, keep STDIN open even if not attached (docker run -i). Defaults to false.
stopSignal String: Signal to stop a container (default SIGTERM).
stopTimeout Number: Timeout (in seconds) to stop a container.
storageOpts Map<String>: Key/value pairs for the storage driver options, e.g. size: 120G
sysctls Map<String>: A map of kernel parameters (sysctls) to set in the container.
tmpfs Map<String>: A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.
tty Boolean: If true, allocate a pseudo-tty (docker run -t). Defaults to false.
ulimits List<Property Map>: Ulimit options to add.
uploads List<Property Map>: Specifies files to upload to the container before starting it. Only one of content or content_base64 can be set and at least one of them has to be set.
user String: User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.
usernsMode String: Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
volumes List<Property Map>: Spec for mounting volumes in the container.
wait Boolean: If true, then the Docker container is waited for being healthy state after creation. If false, then the container health state is not checked. Defaults to false.
waitTimeout Number: The timeout in seconds to wait the container to be healthy after creation. Defaults to 60.
workingDir String: The working directory for commands to run in.

Supporting Types

ContainerCapabilities
, ContainerCapabilitiesArgs

Adds List<string>: List of linux capabilities to add.
Drops List<string>: List of linux capabilities to drop.

Adds []string: List of linux capabilities to add.
Drops []string: List of linux capabilities to drop.

adds List<String>: List of linux capabilities to add.
drops List<String>: List of linux capabilities to drop.

adds string[]: List of linux capabilities to add.
drops string[]: List of linux capabilities to drop.

adds Sequence[str]: List of linux capabilities to add.
drops Sequence[str]: List of linux capabilities to drop.

adds List<String>: List of linux capabilities to add.
drops List<String>: List of linux capabilities to drop.

ContainerDevice
, ContainerDeviceArgs

HostPath string: The path on the host where the device is located.
ContainerPath string: The path in the container where the device will be bound.
Permissions string: The cgroup permissions given to the container to access the device. Defaults to rwm.

HostPath string: The path on the host where the device is located.
ContainerPath string: The path in the container where the device will be bound.
Permissions string: The cgroup permissions given to the container to access the device. Defaults to rwm.

hostPath String: The path on the host where the device is located.
containerPath String: The path in the container where the device will be bound.
permissions String: The cgroup permissions given to the container to access the device. Defaults to rwm.

hostPath string: The path on the host where the device is located.
containerPath string: The path in the container where the device will be bound.
permissions string: The cgroup permissions given to the container to access the device. Defaults to rwm.

host_path str: The path on the host where the device is located.
container_path str: The path in the container where the device will be bound.
permissions str: The cgroup permissions given to the container to access the device. Defaults to rwm.

hostPath String: The path on the host where the device is located.
containerPath String: The path in the container where the device will be bound.
permissions String: The cgroup permissions given to the container to access the device. Defaults to rwm.

ContainerHealthcheck
, ContainerHealthcheckArgs

Tests List<string>: Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].
Interval string: Time between running the check (ms|s|m|h). Defaults to 0s.
Retries int: Consecutive failures needed to report unhealthy. Defaults to 0.
StartPeriod string: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
Timeout string: Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.

Tests []string: Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].
Interval string: Time between running the check (ms|s|m|h). Defaults to 0s.
Retries int: Consecutive failures needed to report unhealthy. Defaults to 0.
StartPeriod string: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
Timeout string: Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.

tests List<String>: Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].
interval String: Time between running the check (ms|s|m|h). Defaults to 0s.
retries Integer: Consecutive failures needed to report unhealthy. Defaults to 0.
startPeriod String: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
timeout String: Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.

tests string[]: Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].
interval string: Time between running the check (ms|s|m|h). Defaults to 0s.
retries number: Consecutive failures needed to report unhealthy. Defaults to 0.
startPeriod string: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
timeout string: Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.

tests Sequence[str]: Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].
interval str: Time between running the check (ms|s|m|h). Defaults to 0s.
retries int: Consecutive failures needed to report unhealthy. Defaults to 0.
start_period str: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
timeout str: Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.

tests List<String>: Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].
interval String: Time between running the check (ms|s|m|h). Defaults to 0s.
retries Number: Consecutive failures needed to report unhealthy. Defaults to 0.
startPeriod String: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.
timeout String: Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.

ContainerHost
, ContainerHostArgs

Host string: Hostname to add
Ip string: IP address this hostname should resolve to.

Host string: Hostname to add
Ip string: IP address this hostname should resolve to.

host String: Hostname to add
ip String: IP address this hostname should resolve to.

host string: Hostname to add
ip string: IP address this hostname should resolve to.

host str: Hostname to add
ip str: IP address this hostname should resolve to.

host String: Hostname to add
ip String: IP address this hostname should resolve to.

ContainerLabel
, ContainerLabelArgs

Label string: Name of the label
Value string: Value of the label

Label string: Name of the label
Value string: Value of the label

label String: Name of the label
value String: Value of the label

label string: Name of the label
value string: Value of the label

label str: Name of the label
value str: Value of the label

label String: Name of the label
value String: Value of the label

ContainerMount
, ContainerMountArgs

Target string: Container path
Type string: The mount type
BindOptions ContainerMountBindOptions: Optional configuration for the bind type.
ReadOnly bool: Whether the mount should be read-only.
Source string: Mount source (e.g. a volume name, a host path).
TmpfsOptions ContainerMountTmpfsOptions: Optional configuration for the tmpfs type.
VolumeOptions ContainerMountVolumeOptions: Optional configuration for the volume type.

Target string: Container path
Type string: The mount type
BindOptions ContainerMountBindOptions: Optional configuration for the bind type.
ReadOnly bool: Whether the mount should be read-only.
Source string: Mount source (e.g. a volume name, a host path).
TmpfsOptions ContainerMountTmpfsOptions: Optional configuration for the tmpfs type.
VolumeOptions ContainerMountVolumeOptions: Optional configuration for the volume type.

target String: Container path
type String: The mount type
bindOptions ContainerMountBindOptions: Optional configuration for the bind type.
readOnly Boolean: Whether the mount should be read-only.
source String: Mount source (e.g. a volume name, a host path).
tmpfsOptions ContainerMountTmpfsOptions: Optional configuration for the tmpfs type.
volumeOptions ContainerMountVolumeOptions: Optional configuration for the volume type.

target string: Container path
type string: The mount type
bindOptions ContainerMountBindOptions: Optional configuration for the bind type.
readOnly boolean: Whether the mount should be read-only.
source string: Mount source (e.g. a volume name, a host path).
tmpfsOptions ContainerMountTmpfsOptions: Optional configuration for the tmpfs type.
volumeOptions ContainerMountVolumeOptions: Optional configuration for the volume type.

target str: Container path
type str: The mount type
bind_options ContainerMountBindOptions: Optional configuration for the bind type.
read_only bool: Whether the mount should be read-only.
source str: Mount source (e.g. a volume name, a host path).
tmpfs_options ContainerMountTmpfsOptions: Optional configuration for the tmpfs type.
volume_options ContainerMountVolumeOptions: Optional configuration for the volume type.

target String: Container path
type String: The mount type
bindOptions Property Map: Optional configuration for the bind type.
readOnly Boolean: Whether the mount should be read-only.
source String: Mount source (e.g. a volume name, a host path).
tmpfsOptions Property Map: Optional configuration for the tmpfs type.
volumeOptions Property Map: Optional configuration for the volume type.

ContainerMountBindOptions
, ContainerMountBindOptionsArgs

Propagation string: A propagation mode with the value.

Propagation string: A propagation mode with the value.

propagation String: A propagation mode with the value.

propagation string: A propagation mode with the value.

propagation str: A propagation mode with the value.

propagation String: A propagation mode with the value.

ContainerMountTmpfsOptions
, ContainerMountTmpfsOptionsArgs

Mode int: The permission mode for the tmpfs mount in an integer.
SizeBytes int: The size for the tmpfs mount in bytes.

Mode int: The permission mode for the tmpfs mount in an integer.
SizeBytes int: The size for the tmpfs mount in bytes.

mode Integer: The permission mode for the tmpfs mount in an integer.
sizeBytes Integer: The size for the tmpfs mount in bytes.

mode number: The permission mode for the tmpfs mount in an integer.
sizeBytes number: The size for the tmpfs mount in bytes.

mode int: The permission mode for the tmpfs mount in an integer.
size_bytes int: The size for the tmpfs mount in bytes.

mode Number: The permission mode for the tmpfs mount in an integer.
sizeBytes Number: The size for the tmpfs mount in bytes.

ContainerMountVolumeOptions
, ContainerMountVolumeOptionsArgs

DriverName string: Name of the driver to use to create the volume.
DriverOptions Dictionary<string, string>: key/value map of driver specific options.
Labels List<ContainerMountVolumeOptionsLabel>: User-defined key/value metadata.
NoCopy bool: Populate volume with data from the target.

DriverName string: Name of the driver to use to create the volume.
DriverOptions map[string]string: key/value map of driver specific options.
Labels []ContainerMountVolumeOptionsLabel: User-defined key/value metadata.
NoCopy bool: Populate volume with data from the target.

driverName String: Name of the driver to use to create the volume.
driverOptions Map<String,String>: key/value map of driver specific options.
labels List<ContainerMountVolumeOptionsLabel>: User-defined key/value metadata.
noCopy Boolean: Populate volume with data from the target.

driverName string: Name of the driver to use to create the volume.
driverOptions {[key: string]: string}: key/value map of driver specific options.
labels ContainerMountVolumeOptionsLabel[]: User-defined key/value metadata.
noCopy boolean: Populate volume with data from the target.

driver_name str: Name of the driver to use to create the volume.
driver_options Mapping[str, str]: key/value map of driver specific options.
labels Sequence[ContainerMountVolumeOptionsLabel]: User-defined key/value metadata.
no_copy bool: Populate volume with data from the target.

driverName String: Name of the driver to use to create the volume.
driverOptions Map<String>: key/value map of driver specific options.
labels List<Property Map>: User-defined key/value metadata.
noCopy Boolean: Populate volume with data from the target.

ContainerMountVolumeOptionsLabel
, ContainerMountVolumeOptionsLabelArgs

Label string: Name of the label
Value string: Value of the label

Label string: Name of the label
Value string: Value of the label

label String: Name of the label
value String: Value of the label

label string: Name of the label
value string: Value of the label

label str: Name of the label
value str: Value of the label

label String: Name of the label
value String: Value of the label

ContainerNetworkData
, ContainerNetworkDataArgs

Gateway string: The network gateway of the container.
GlobalIpv6Address string: The IPV6 address of the container.
GlobalIpv6PrefixLength int: The IPV6 prefix length address of the container.
IpAddress string: The IP address of the container.
IpPrefixLength int: The IP prefix length of the container.
Ipv6Gateway string: The IPV6 gateway of the container.
MacAddress string: The MAC address of the container.
NetworkName string: The name of the network

Gateway string: The network gateway of the container.
GlobalIpv6Address string: The IPV6 address of the container.
GlobalIpv6PrefixLength int: The IPV6 prefix length address of the container.
IpAddress string: The IP address of the container.
IpPrefixLength int: The IP prefix length of the container.
Ipv6Gateway string: The IPV6 gateway of the container.
MacAddress string: The MAC address of the container.
NetworkName string: The name of the network

gateway String: The network gateway of the container.
globalIpv6Address String: The IPV6 address of the container.
globalIpv6PrefixLength Integer: The IPV6 prefix length address of the container.
ipAddress String: The IP address of the container.
ipPrefixLength Integer: The IP prefix length of the container.
ipv6Gateway String: The IPV6 gateway of the container.
macAddress String: The MAC address of the container.
networkName String: The name of the network

gateway string: The network gateway of the container.
globalIpv6Address string: The IPV6 address of the container.
globalIpv6PrefixLength number: The IPV6 prefix length address of the container.
ipAddress string: The IP address of the container.
ipPrefixLength number: The IP prefix length of the container.
ipv6Gateway string: The IPV6 gateway of the container.
macAddress string: The MAC address of the container.
networkName string: The name of the network

gateway str: The network gateway of the container.
global_ipv6_address str: The IPV6 address of the container.
global_ipv6_prefix_length int: The IPV6 prefix length address of the container.
ip_address str: The IP address of the container.
ip_prefix_length int: The IP prefix length of the container.
ipv6_gateway str: The IPV6 gateway of the container.
mac_address str: The MAC address of the container.
network_name str: The name of the network

gateway String: The network gateway of the container.
globalIpv6Address String: The IPV6 address of the container.
globalIpv6PrefixLength Number: The IPV6 prefix length address of the container.
ipAddress String: The IP address of the container.
ipPrefixLength Number: The IP prefix length of the container.
ipv6Gateway String: The IPV6 gateway of the container.
macAddress String: The MAC address of the container.
networkName String: The name of the network

ContainerNetworksAdvanced
, ContainerNetworksAdvancedArgs

Name string: The name or id of the network to use. You can use name or id attribute from a docker.Network resource.
Aliases List<string>: The network aliases of the container in the specific network.
Ipv4Address string: The IPV4 address of the container in the specific network.
Ipv6Address string: The IPV6 address of the container in the specific network.

Name string: The name or id of the network to use. You can use name or id attribute from a docker.Network resource.
Aliases []string: The network aliases of the container in the specific network.
Ipv4Address string: The IPV4 address of the container in the specific network.
Ipv6Address string: The IPV6 address of the container in the specific network.

name String: The name or id of the network to use. You can use name or id attribute from a docker.Network resource.
aliases List<String>: The network aliases of the container in the specific network.
ipv4Address String: The IPV4 address of the container in the specific network.
ipv6Address String: The IPV6 address of the container in the specific network.

name string: The name or id of the network to use. You can use name or id attribute from a docker.Network resource.
aliases string[]: The network aliases of the container in the specific network.
ipv4Address string: The IPV4 address of the container in the specific network.
ipv6Address string: The IPV6 address of the container in the specific network.

name str: The name or id of the network to use. You can use name or id attribute from a docker.Network resource.
aliases Sequence[str]: The network aliases of the container in the specific network.
ipv4_address str: The IPV4 address of the container in the specific network.
ipv6_address str: The IPV6 address of the container in the specific network.

name String: The name or id of the network to use. You can use name or id attribute from a docker.Network resource.
aliases List<String>: The network aliases of the container in the specific network.
ipv4Address String: The IPV4 address of the container in the specific network.
ipv6Address String: The IPV6 address of the container in the specific network.

ContainerPort
, ContainerPortArgs

Internal int: Port within the container.
External int: Port exposed out of the container. If not given a free random port >= 32768 will be used.
Ip string: IP address/mask that can access this port. Defaults to 0.0.0.0.
Protocol string: Protocol that can be used over this port. Defaults to tcp.

Internal int: Port within the container.
External int: Port exposed out of the container. If not given a free random port >= 32768 will be used.
Ip string: IP address/mask that can access this port. Defaults to 0.0.0.0.
Protocol string: Protocol that can be used over this port. Defaults to tcp.

internal Integer: Port within the container.
external Integer: Port exposed out of the container. If not given a free random port >= 32768 will be used.
ip String: IP address/mask that can access this port. Defaults to 0.0.0.0.
protocol String: Protocol that can be used over this port. Defaults to tcp.

internal number: Port within the container.
external number: Port exposed out of the container. If not given a free random port >= 32768 will be used.
ip string: IP address/mask that can access this port. Defaults to 0.0.0.0.
protocol string: Protocol that can be used over this port. Defaults to tcp.

internal int: Port within the container.
external int: Port exposed out of the container. If not given a free random port >= 32768 will be used.
ip str: IP address/mask that can access this port. Defaults to 0.0.0.0.
protocol str: Protocol that can be used over this port. Defaults to tcp.

internal Number: Port within the container.
external Number: Port exposed out of the container. If not given a free random port >= 32768 will be used.
ip String: IP address/mask that can access this port. Defaults to 0.0.0.0.
protocol String: Protocol that can be used over this port. Defaults to tcp.

ContainerUlimit
, ContainerUlimitArgs

Hard int: The hard limit
Name string: The name of the ulimit
Soft int: The soft limit

Hard int: The hard limit
Name string: The name of the ulimit
Soft int: The soft limit

hard Integer: The hard limit
name String: The name of the ulimit
soft Integer: The soft limit

hard number: The hard limit
name string: The name of the ulimit
soft number: The soft limit

hard int: The hard limit
name str: The name of the ulimit
soft int: The soft limit

hard Number: The hard limit
name String: The name of the ulimit
soft Number: The soft limit

ContainerUpload
, ContainerUploadArgs

File string: Path to the file in the container where is upload goes to
Content string: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with content_base64 & source
ContentBase64 string: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the base64encode interpolation function. See here for the reason. Conflicts with content & source
Executable bool: If true, the file will be uploaded with user executable permission. Defaults to false.
Source string: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with content & content_base64
SourceHash string: If using source, this will force an update if the file content has updated but the filename has not.

File string: Path to the file in the container where is upload goes to
Content string: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with content_base64 & source
ContentBase64 string: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the base64encode interpolation function. See here for the reason. Conflicts with content & source
Executable bool: If true, the file will be uploaded with user executable permission. Defaults to false.
Source string: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with content & content_base64
SourceHash string: If using source, this will force an update if the file content has updated but the filename has not.

file String: Path to the file in the container where is upload goes to
content String: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with content_base64 & source
contentBase64 String: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the base64encode interpolation function. See here for the reason. Conflicts with content & source
executable Boolean: If true, the file will be uploaded with user executable permission. Defaults to false.
source String: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with content & content_base64
sourceHash String: If using source, this will force an update if the file content has updated but the filename has not.

file string: Path to the file in the container where is upload goes to
content string: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with content_base64 & source
contentBase64 string: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the base64encode interpolation function. See here for the reason. Conflicts with content & source
executable boolean: If true, the file will be uploaded with user executable permission. Defaults to false.
source string: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with content & content_base64
sourceHash string: If using source, this will force an update if the file content has updated but the filename has not.

file str: Path to the file in the container where is upload goes to
content str: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with content_base64 & source
content_base64 str: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the base64encode interpolation function. See here for the reason. Conflicts with content & source
executable bool: If true, the file will be uploaded with user executable permission. Defaults to false.
source str: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with content & content_base64
source_hash str: If using source, this will force an update if the file content has updated but the filename has not.

file String: Path to the file in the container where is upload goes to
content String: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with content_base64 & source
contentBase64 String: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the base64encode interpolation function. See here for the reason. Conflicts with content & source
executable Boolean: If true, the file will be uploaded with user executable permission. Defaults to false.
source String: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with content & content_base64
sourceHash String: If using source, this will force an update if the file content has updated but the filename has not.

ContainerVolume
, ContainerVolumeArgs

ContainerPath string: The path in the container where the volume will be mounted.
FromContainer string: The container where the volume is coming from.
HostPath string: The path on the host where the volume is coming from.
ReadOnly bool: If true, this volume will be readonly. Defaults to false.
VolumeName string: The name of the docker volume which should be mounted.

ContainerPath string: The path in the container where the volume will be mounted.
FromContainer string: The container where the volume is coming from.
HostPath string: The path on the host where the volume is coming from.
ReadOnly bool: If true, this volume will be readonly. Defaults to false.
VolumeName string: The name of the docker volume which should be mounted.

containerPath String: The path in the container where the volume will be mounted.
fromContainer String: The container where the volume is coming from.
hostPath String: The path on the host where the volume is coming from.
readOnly Boolean: If true, this volume will be readonly. Defaults to false.
volumeName String: The name of the docker volume which should be mounted.

containerPath string: The path in the container where the volume will be mounted.
fromContainer string: The container where the volume is coming from.
hostPath string: The path on the host where the volume is coming from.
readOnly boolean: If true, this volume will be readonly. Defaults to false.
volumeName string: The name of the docker volume which should be mounted.

container_path str: The path in the container where the volume will be mounted.
from_container str: The container where the volume is coming from.
host_path str: The path on the host where the volume is coming from.
read_only bool: If true, this volume will be readonly. Defaults to false.
volume_name str: The name of the docker volume which should be mounted.

containerPath String: The path in the container where the volume will be mounted.
fromContainer String: The container where the volume is coming from.
hostPath String: The path on the host where the volume is coming from.
readOnly Boolean: If true, this volume will be readonly. Defaults to false.
volumeName String: The name of the docker volume which should be mounted.

Import

Example

Assuming you created a container as follows

#!/bin/bash

docker run –name foo -p8080:80 -d nginx

prints the container ID

9a550c0f0163d39d77222d3efd58701b625d47676c25c686c95b5b92d1cba6fd

you provide the definition for the resource as follows

terraform

resource “docker_container” “foo” {

name = “foo”

image = “nginx”

ports {

internal = "80"

external = "8080"

}

then the import command is as follows

#!/bin/bash

$ pulumi import docker:index/container:Container foo 9a550c0f0163d39d77222d3efd58701b625d47676c25c686c95b5b92d1cba6fd

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Docker pulumi/pulumi-docker
License: Apache-2.0
Notes: This Pulumi package is based on the docker Terraform Provider.

Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi

pulumi/pulumi-docker

docker.Container

On this page

On this page

Example Usage

Create Container Resource

Constructor syntax

Parameters

Constructor example

Container Resource Properties

Inputs

Outputs

Look up Existing Container Resource

Supporting Types

ContainerCapabilities
, ContainerCapabilitiesArgs

ContainerDevice
, ContainerDeviceArgs

ContainerHealthcheck
, ContainerHealthcheckArgs

ContainerHost
, ContainerHostArgs

ContainerLabel
, ContainerLabelArgs

ContainerMount
, ContainerMountArgs

ContainerMountBindOptions
, ContainerMountBindOptionsArgs

ContainerMountTmpfsOptions
, ContainerMountTmpfsOptionsArgs

ContainerMountVolumeOptions
, ContainerMountVolumeOptionsArgs

ContainerMountVolumeOptionsLabel
, ContainerMountVolumeOptionsLabelArgs

ContainerNetworkData
, ContainerNetworkDataArgs

ContainerNetworksAdvanced
, ContainerNetworksAdvancedArgs

ContainerPort
, ContainerPortArgs

ContainerUlimit
, ContainerUlimitArgs

ContainerUpload
, ContainerUploadArgs

ContainerVolume
, ContainerVolumeArgs

Import

Example

Package Details

On this page

On this page

docker.Container

On this page

On this page

Example Usage

Create Container Resource

Constructor syntax

Parameters

Constructor example

Container Resource Properties

Inputs

Outputs

Look up Existing Container Resource

Supporting Types

ContainerCapabilities, ContainerCapabilitiesArgs

ContainerDevice, ContainerDeviceArgs

ContainerHealthcheck, ContainerHealthcheckArgs

ContainerHost, ContainerHostArgs

ContainerLabel, ContainerLabelArgs

ContainerMount, ContainerMountArgs

ContainerMountBindOptions, ContainerMountBindOptionsArgs

ContainerMountTmpfsOptions, ContainerMountTmpfsOptionsArgs

ContainerMountVolumeOptions, ContainerMountVolumeOptionsArgs

ContainerMountVolumeOptionsLabel, ContainerMountVolumeOptionsLabelArgs

ContainerNetworkData, ContainerNetworkDataArgs

ContainerNetworksAdvanced, ContainerNetworksAdvancedArgs

ContainerPort, ContainerPortArgs

ContainerUlimit, ContainerUlimitArgs

ContainerUpload, ContainerUploadArgs

ContainerVolume, ContainerVolumeArgs

Import

Example

Package Details

On this page

On this page

ContainerCapabilities
, ContainerCapabilitiesArgs

ContainerDevice
, ContainerDeviceArgs

ContainerHealthcheck
, ContainerHealthcheckArgs

ContainerHost
, ContainerHostArgs

ContainerLabel
, ContainerLabelArgs

ContainerMount
, ContainerMountArgs

ContainerMountBindOptions
, ContainerMountBindOptionsArgs

ContainerMountTmpfsOptions
, ContainerMountTmpfsOptionsArgs

ContainerMountVolumeOptions
, ContainerMountVolumeOptionsArgs

ContainerMountVolumeOptionsLabel
, ContainerMountVolumeOptionsLabelArgs

ContainerNetworkData
, ContainerNetworkDataArgs

ContainerNetworksAdvanced
, ContainerNetworksAdvancedArgs

ContainerPort
, ContainerPortArgs

ContainerUlimit
, ContainerUlimitArgs

ContainerUpload
, ContainerUploadArgs

ContainerVolume
, ContainerVolumeArgs