Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Docker
  5. Container

Container

Manages the lifecycle of a Docker container.

Example Usage

using Pulumi;
using Docker = Pulumi.Docker;

class MyStack : Stack
{
    public MyStack()
    {
        // Find the latest Ubuntu precise image.
        var ubuntuRemoteImage = new Docker.RemoteImage("ubuntuRemoteImage", new Docker.RemoteImageArgs
        {
            Name = "ubuntu:precise",
        });
        // Start a container
        var ubuntuContainer = new Docker.Container("ubuntuContainer", new Docker.ContainerArgs
        {
            Image = ubuntuRemoteImage.Latest,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        ubuntuRemoteImage, err := docker.NewRemoteImage(ctx, "ubuntuRemoteImage", &docker.RemoteImageArgs{
            Name: pulumi.String("ubuntu:precise"),
        })
        if err != nil {
            return err
        }
        _, err = docker.NewContainer(ctx, "ubuntuContainer", &docker.ContainerArgs{
            Image: ubuntuRemoteImage.Latest,
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_docker as docker

# Find the latest Ubuntu precise image.
ubuntu_remote_image = docker.RemoteImage("ubuntuRemoteImage", name="ubuntu:precise")
# Start a container
ubuntu_container = docker.Container("ubuntuContainer", image=ubuntu_remote_image.latest)
import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

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

Create a Container Resource

new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);
def Container(resource_name: str, opts: Optional[ResourceOptions] = None, attach: Optional[bool] = None, capabilities: Optional[ContainerCapabilitiesArgs] = None, command: Optional[Sequence[str]] = 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, 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, links: Optional[Sequence[str]] = None, log_driver: Optional[str] = None, log_opts: Optional[Mapping[str, Any]] = 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_aliases: Optional[Sequence[str]] = None, network_mode: Optional[str] = None, networks: Optional[Sequence[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, security_opts: Optional[Sequence[str]] = None, shm_size: Optional[int] = None, start: Optional[bool] = None, stdin_open: Optional[bool] = None, sysctls: Optional[Mapping[str, Any]] = None, tmpfs: Optional[Mapping[str, Any]] = 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, 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)
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.
opts ResourceOptions
A bag of options that control this 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.

Container Resource Properties

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

Inputs

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 above.

Attach bool

If true attach to the container after its creation and waits the end of his execution.

Capabilities ContainerCapabilitiesArgs

See Capabilities below for details.

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.conf"].

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

See Devices below for details.

Dns List<string>

Set of DNS servers.

DnsOpts List<string>

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

DnsSearches List<string>

Set of 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/myprogram"].

Envs List<string>

Environment variables to set.

GroupAdds List<string>

Add additional groups to run as.

Healthcheck ContainerHealthcheckArgs

See Healthcheck below for details.

Hostname string

Hostname of the container.

Hosts List<ContainerHostArgs>

Hostname to add.

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

Adding labels.

Links List<string>

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

LogDriver string

The logging driver to use for the container. Defaults to “json-file”.

LogOpts Dictionary<string, object>

Key/value pairs to use as options for the logging driver.

Logs bool

Save the container logs (attach must be enabled).

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
Mounts List<ContainerMountArgs>

See Mounts below for details.

MustRun bool
Name string
NetworkAliases List<string>

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworkMode string

Network mode of the container.

Networks List<string>

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworksAdvanced List<ContainerNetworksAdvancedArgs>

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

PidMode string

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

Ports List<ContainerPortArgs>

See Ports below for details.

Privileged bool

Run container in privileged mode.

PublishAllPorts bool

Publish all ports of the container.

ReadOnly bool

If true, this volume will be readonly. Defaults to false.

RemoveVolumes bool
Restart string

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

Rm bool
SecurityOpts List<string>

Set 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.

StdinOpen bool

if true, keep STDIN open even if not attached (docker run -i)

Sysctls Dictionary<string, object>

A map of kernel parameters (sysctls) to set in the container.

Tmpfs Dictionary<string, object>

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)

Ulimits List<ContainerUlimitArgs>

See Ulimits below for details.

Uploads List<ContainerUploadArgs>

See File Upload below for details.

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

See Volumes below for details.

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 above.

Attach bool

If true attach to the container after its creation and waits the end of his execution.

Capabilities ContainerCapabilities

See Capabilities below for details.

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.conf"].

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 []ContainerDevice

See Devices below for details.

Dns []string

Set of DNS servers.

DnsOpts []string

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

DnsSearches []string

Set of 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/myprogram"].

Envs []string

Environment variables to set.

GroupAdds []string

Add additional groups to run as.

Healthcheck ContainerHealthcheck

See Healthcheck below for details.

Hostname string

Hostname of the container.

Hosts []ContainerHost

Hostname to add.

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 []ContainerLabel

Adding labels.

Links []string

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

LogDriver string

The logging driver to use for the container. Defaults to “json-file”.

LogOpts map[string]interface{}

Key/value pairs to use as options for the logging driver.

Logs bool

Save the container logs (attach must be enabled).

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
Mounts []ContainerMount

See Mounts below for details.

MustRun bool
Name string
NetworkAliases []string

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworkMode string

Network mode of the container.

Networks []string

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworksAdvanced []ContainerNetworksAdvanced

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

PidMode string

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

Ports []ContainerPort

See Ports below for details.

Privileged bool

Run container in privileged mode.

PublishAllPorts bool

Publish all ports of the container.

ReadOnly bool

If true, this volume will be readonly. Defaults to false.

RemoveVolumes bool
Restart string

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

Rm bool
SecurityOpts []string

Set 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.

StdinOpen bool

if true, keep STDIN open even if not attached (docker run -i)

Sysctls map[string]interface{}

A map of kernel parameters (sysctls) to set in the container.

Tmpfs map[string]interface{}

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)

Ulimits []ContainerUlimit

See Ulimits below for details.

Uploads []ContainerUpload

See File Upload below for details.

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

See Volumes below for details.

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 above.

attach boolean

If true attach to the container after its creation and waits the end of his execution.

capabilities ContainerCapabilities

See Capabilities below for details.

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.conf"].

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[]

See Devices below for details.

dns string[]

Set of DNS servers.

dnsOpts string[]

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

dnsSearches string[]

Set of 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/myprogram"].

envs string[]

Environment variables to set.

groupAdds string[]

Add additional groups to run as.

healthcheck ContainerHealthcheck

See Healthcheck below for details.

hostname string

Hostname of the container.

hosts ContainerHost[]

Hostname to add.

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[]

Adding labels.

links string[]

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

logDriver string

The logging driver to use for the container. Defaults to “json-file”.

logOpts {[key: string]: any}

Key/value pairs to use as options for the logging driver.

logs boolean

Save the container logs (attach must be enabled).

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
mounts ContainerMount[]

See Mounts below for details.

mustRun boolean
name string
networkAliases string[]

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

networkMode string

Network mode of the container.

networks string[]

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

networksAdvanced ContainerNetworksAdvanced[]

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

pidMode string

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

ports ContainerPort[]

See Ports below for details.

privileged boolean

Run container in privileged mode.

publishAllPorts boolean

Publish all ports of the container.

readOnly boolean

If true, this volume will be readonly. Defaults to false.

removeVolumes boolean
restart string

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

rm boolean
securityOpts string[]

Set 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.

stdinOpen boolean

if true, keep STDIN open even if not attached (docker run -i)

sysctls {[key: string]: any}

A map of kernel parameters (sysctls) to set in the container.

tmpfs {[key: string]: any}

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)

ulimits ContainerUlimit[]

See Ulimits below for details.

uploads ContainerUpload[]

See File Upload below for details.

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[]

See Volumes below for details.

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 above.

attach bool

If true attach to the container after its creation and waits the end of his execution.

capabilities ContainerCapabilitiesArgs

See Capabilities below for details.

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.conf"].

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]

See Devices below for details.

dns Sequence[str]

Set of DNS servers.

dns_opts Sequence[str]

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

dns_searches Sequence[str]

Set of 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/myprogram"].

envs Sequence[str]

Environment variables to set.

group_adds Sequence[str]

Add additional groups to run as.

healthcheck ContainerHealthcheckArgs

See Healthcheck below for details.

hostname str

Hostname of the container.

hosts Sequence[ContainerHostArgs]

Hostname to add.

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]

Adding labels.

links Sequence[str]

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

log_driver str

The logging driver to use for the container. Defaults to “json-file”.

log_opts Mapping[str, Any]

Key/value pairs to use as options for the logging driver.

logs bool

Save the container logs (attach must be enabled).

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
mounts Sequence[ContainerMountArgs]

See Mounts below for details.

must_run bool
name str
network_aliases Sequence[str]

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

network_mode str

Network mode of the container.

networks Sequence[str]

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

networks_advanced Sequence[ContainerNetworksAdvancedArgs]

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

pid_mode str

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

ports Sequence[ContainerPortArgs]

See Ports below for details.

privileged bool

Run container in privileged mode.

publish_all_ports bool

Publish all ports of the container.

read_only bool

If true, this volume will be readonly. Defaults to false.

remove_volumes bool
restart str

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

rm bool
security_opts Sequence[str]

Set 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.

stdin_open bool

if true, keep STDIN open even if not attached (docker run -i)

sysctls Mapping[str, Any]

A map of kernel parameters (sysctls) to set in the container.

tmpfs Mapping[str, Any]

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)

ulimits Sequence[ContainerUlimitArgs]

See Ulimits below for details.

uploads Sequence[ContainerUploadArgs]

See File Upload below for details.

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]

See Volumes below for details.

working_dir str

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

Gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

IpPrefixLength int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

NetworkDatas List<ContainerNetworkData>

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

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

Gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

IpPrefixLength int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

NetworkDatas []ContainerNetworkData

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

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

gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

id string
The provider-assigned unique ID for this managed resource.
ipAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

ipPrefixLength number

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

networkDatas ContainerNetworkData[]

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

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

gateway str

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

id str
The provider-assigned unique ID for this managed resource.
ip_address str

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

ip_prefix_length int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

network_datas Sequence[ContainerNetworkData]

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

Look up an Existing Container Resource

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

public static get(name: string, id: Input<ID>, state?: 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, command: Optional[Sequence[str]] = None, container_logs: Optional[str] = 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, gateway: 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, ip_address: Optional[str] = None, ip_prefix_length: Optional[int] = None, ipc_mode: Optional[str] = None, labels: Optional[Sequence[ContainerLabelArgs]] = None, links: Optional[Sequence[str]] = None, log_driver: Optional[str] = None, log_opts: Optional[Mapping[str, Any]] = 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_aliases: Optional[Sequence[str]] = None, network_datas: Optional[Sequence[ContainerNetworkDataArgs]] = None, network_mode: Optional[str] = None, networks: Optional[Sequence[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, security_opts: Optional[Sequence[str]] = None, shm_size: Optional[int] = None, start: Optional[bool] = None, stdin_open: Optional[bool] = None, sysctls: Optional[Mapping[str, Any]] = None, tmpfs: Optional[Mapping[str, Any]] = 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, 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)
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.

The following state arguments are supported:

Attach bool

If true attach to the container after its creation and waits the end of his execution.

Bridge string

The network bridge of the container as read from its NetworkSettings.

Capabilities ContainerCapabilitiesArgs

See Capabilities below for details.

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.conf"].

ContainerLogs string

The logs of the container if its execution is done (attach must be disabled).

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

See Devices below for details.

Dns List<string>

Set of DNS servers.

DnsOpts List<string>

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

DnsSearches List<string>

Set of 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/myprogram"].

Envs List<string>

Environment variables to set.

ExitCode int

The exit code of the container if its execution is done (must_run must be disabled).

Gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

GroupAdds List<string>

Add additional groups to run as.

Healthcheck ContainerHealthcheckArgs

See Healthcheck below for details.

Hostname string

Hostname of the container.

Hosts List<ContainerHostArgs>

Hostname to add.

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 above.

Init bool

Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.

IpAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

IpPrefixLength int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

IpcMode string

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

Labels List<ContainerLabelArgs>

Adding labels.

Links List<string>

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

LogDriver string

The logging driver to use for the container. Defaults to “json-file”.

LogOpts Dictionary<string, object>

Key/value pairs to use as options for the logging driver.

Logs bool

Save the container logs (attach must be enabled).

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
Mounts List<ContainerMountArgs>

See Mounts below for details.

MustRun bool
Name string
NetworkAliases List<string>

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworkDatas List<ContainerNetworkDataArgs>

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

NetworkMode string

Network mode of the container.

Networks List<string>

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworksAdvanced List<ContainerNetworksAdvancedArgs>

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

PidMode string

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

Ports List<ContainerPortArgs>

See Ports below for details.

Privileged bool

Run container in privileged mode.

PublishAllPorts bool

Publish all ports of the container.

ReadOnly bool

If true, this volume will be readonly. Defaults to false.

RemoveVolumes bool
Restart string

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

Rm bool
SecurityOpts List<string>

Set 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.

StdinOpen bool

if true, keep STDIN open even if not attached (docker run -i)

Sysctls Dictionary<string, object>

A map of kernel parameters (sysctls) to set in the container.

Tmpfs Dictionary<string, object>

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)

Ulimits List<ContainerUlimitArgs>

See Ulimits below for details.

Uploads List<ContainerUploadArgs>

See File Upload below for details.

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

See Volumes below for details.

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 his execution.

Bridge string

The network bridge of the container as read from its NetworkSettings.

Capabilities ContainerCapabilities

See Capabilities below for details.

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.conf"].

ContainerLogs string

The logs of the container if its execution is done (attach must be disabled).

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 []ContainerDevice

See Devices below for details.

Dns []string

Set of DNS servers.

DnsOpts []string

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

DnsSearches []string

Set of 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/myprogram"].

Envs []string

Environment variables to set.

ExitCode int

The exit code of the container if its execution is done (must_run must be disabled).

Gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

GroupAdds []string

Add additional groups to run as.

Healthcheck ContainerHealthcheck

See Healthcheck below for details.

Hostname string

Hostname of the container.

Hosts []ContainerHost

Hostname to add.

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 above.

Init bool

Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.

IpAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

IpPrefixLength int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

IpcMode string

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

Labels []ContainerLabel

Adding labels.

Links []string

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

LogDriver string

The logging driver to use for the container. Defaults to “json-file”.

LogOpts map[string]interface{}

Key/value pairs to use as options for the logging driver.

Logs bool

Save the container logs (attach must be enabled).

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
Mounts []ContainerMount

See Mounts below for details.

MustRun bool
Name string
NetworkAliases []string

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworkDatas []ContainerNetworkData

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

NetworkMode string

Network mode of the container.

Networks []string

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

NetworksAdvanced []ContainerNetworksAdvanced

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

PidMode string

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

Ports []ContainerPort

See Ports below for details.

Privileged bool

Run container in privileged mode.

PublishAllPorts bool

Publish all ports of the container.

ReadOnly bool

If true, this volume will be readonly. Defaults to false.

RemoveVolumes bool
Restart string

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

Rm bool
SecurityOpts []string

Set 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.

StdinOpen bool

if true, keep STDIN open even if not attached (docker run -i)

Sysctls map[string]interface{}

A map of kernel parameters (sysctls) to set in the container.

Tmpfs map[string]interface{}

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)

Ulimits []ContainerUlimit

See Ulimits below for details.

Uploads []ContainerUpload

See File Upload below for details.

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

See Volumes below for details.

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 his execution.

bridge string

The network bridge of the container as read from its NetworkSettings.

capabilities ContainerCapabilities

See Capabilities below for details.

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.conf"].

containerLogs string

The logs of the container if its execution is done (attach must be disabled).

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[]

See Devices below for details.

dns string[]

Set of DNS servers.

dnsOpts string[]

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

dnsSearches string[]

Set of 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/myprogram"].

envs string[]

Environment variables to set.

exitCode number

The exit code of the container if its execution is done (must_run must be disabled).

gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

groupAdds string[]

Add additional groups to run as.

healthcheck ContainerHealthcheck

See Healthcheck below for details.

hostname string

Hostname of the container.

hosts ContainerHost[]

Hostname to add.

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 above.

init boolean

Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.

ipAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

ipPrefixLength number

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

ipcMode string

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

labels ContainerLabel[]

Adding labels.

links string[]

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

logDriver string

The logging driver to use for the container. Defaults to “json-file”.

logOpts {[key: string]: any}

Key/value pairs to use as options for the logging driver.

logs boolean

Save the container logs (attach must be enabled).

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
mounts ContainerMount[]

See Mounts below for details.

mustRun boolean
name string
networkAliases string[]

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

networkDatas ContainerNetworkData[]

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

networkMode string

Network mode of the container.

networks string[]

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

networksAdvanced ContainerNetworksAdvanced[]

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

pidMode string

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

ports ContainerPort[]

See Ports below for details.

privileged boolean

Run container in privileged mode.

publishAllPorts boolean

Publish all ports of the container.

readOnly boolean

If true, this volume will be readonly. Defaults to false.

removeVolumes boolean
restart string

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

rm boolean
securityOpts string[]

Set 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.

stdinOpen boolean

if true, keep STDIN open even if not attached (docker run -i)

sysctls {[key: string]: any}

A map of kernel parameters (sysctls) to set in the container.

tmpfs {[key: string]: any}

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)

ulimits ContainerUlimit[]

See Ulimits below for details.

uploads ContainerUpload[]

See File Upload below for details.

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[]

See Volumes below for details.

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 his execution.

bridge str

The network bridge of the container as read from its NetworkSettings.

capabilities ContainerCapabilitiesArgs

See Capabilities below for details.

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.conf"].

container_logs str

The logs of the container if its execution is done (attach must be disabled).

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]

See Devices below for details.

dns Sequence[str]

Set of DNS servers.

dns_opts Sequence[str]

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

dns_searches Sequence[str]

Set of 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/myprogram"].

envs Sequence[str]

Environment variables to set.

exit_code int

The exit code of the container if its execution is done (must_run must be disabled).

gateway str

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

Deprecated: Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

group_adds Sequence[str]

Add additional groups to run as.

healthcheck ContainerHealthcheckArgs

See Healthcheck below for details.

hostname str

Hostname of the container.

hosts Sequence[ContainerHostArgs]

Hostname to add.

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 above.

init bool

Configured whether an init process should be injected for this container. If unset this will default to the dockerd defaults.

ip_address str

Deprecated: Use network_data instead. The IP address of the container’s first network it.

Deprecated: Use ip_adresses_data instead. This field exposes the data of the container's first network.

ip_prefix_length int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Deprecated: Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

ipc_mode str

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

labels Sequence[ContainerLabelArgs]

Adding labels.

links Sequence[str]

Set of links for link based connectivity between containers that are running on the same host.

Deprecated: The –link flag is a legacy feature of Docker. It may eventually be removed.

log_driver str

The logging driver to use for the container. Defaults to “json-file”.

log_opts Mapping[str, Any]

Key/value pairs to use as options for the logging driver.

logs bool

Save the container logs (attach must be enabled).

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
mounts Sequence[ContainerMountArgs]

See Mounts below for details.

must_run bool
name str
network_aliases Sequence[str]

Network aliases of the container for user-defined networks only. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

network_datas Sequence[ContainerNetworkDataArgs]

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

network_mode str

Network mode of the container.

networks Sequence[str]

Id of the networks in which the container is. Deprecated: use networks_advanced instead.

Deprecated: Use networks_advanced instead. Will be removed in v2.0.0

networks_advanced Sequence[ContainerNetworksAdvancedArgs]

See Networks Advanced below for details. If this block has priority to the deprecated network_alias and network properties.

pid_mode str

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

ports Sequence[ContainerPortArgs]

See Ports below for details.

privileged bool

Run container in privileged mode.

publish_all_ports bool

Publish all ports of the container.

read_only bool

If true, this volume will be readonly. Defaults to false.

remove_volumes bool
restart str

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

rm bool
security_opts Sequence[str]

Set 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.

stdin_open bool

if true, keep STDIN open even if not attached (docker run -i)

sysctls Mapping[str, Any]

A map of kernel parameters (sysctls) to set in the container.

tmpfs Mapping[str, Any]

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)

ulimits Sequence[ContainerUlimitArgs]

See Ulimits below for details.

uploads Sequence[ContainerUploadArgs]

See File Upload below for details.

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]

See Volumes below for details.

working_dir str

The working directory for commands to run in

Supporting Types

ContainerCapabilities

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

ContainerDevice

HostPath string

The path on the host where the device is located.

ContainerPath string

The path in the container where the device will be binded.

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 binded.

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 binded.

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 binded.

permissions str

The cgroup permissions given to the container to access the device. Defaults to rwm.

ContainerHealthcheck

Tests List<string>

Command to run to check health. For example, to run curl -f http://localhost/health set the command to be ["CMD", "curl", "-f", "http://localhost/health"].

Interval string

Time between running the check (ms|s|m|h). Default: 0s.

Retries int

Consecutive failures needed to report unhealthy. Default: 0.

StartPeriod string

Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Default: 0s.

Timeout string

Maximum time to allow one check to run (ms|s|m|h). Default: 0s.

Tests []string

Command to run to check health. For example, to run curl -f http://localhost/health set the command to be ["CMD", "curl", "-f", "http://localhost/health"].

Interval string

Time between running the check (ms|s|m|h). Default: 0s.

Retries int

Consecutive failures needed to report unhealthy. Default: 0.

StartPeriod string

Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Default: 0s.

Timeout string

Maximum time to allow one check to run (ms|s|m|h). Default: 0s.

tests string[]

Command to run to check health. For example, to run curl -f http://localhost/health set the command to be ["CMD", "curl", "-f", "http://localhost/health"].

interval string

Time between running the check (ms|s|m|h). Default: 0s.

retries number

Consecutive failures needed to report unhealthy. Default: 0.

startPeriod string

Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Default: 0s.

timeout string

Maximum time to allow one check to run (ms|s|m|h). Default: 0s.

tests Sequence[str]

Command to run to check health. For example, to run curl -f http://localhost/health set the command to be ["CMD", "curl", "-f", "http://localhost/health"].

interval str

Time between running the check (ms|s|m|h). Default: 0s.

retries int

Consecutive failures needed to report unhealthy. Default: 0.

start_period str

Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Default: 0s.

timeout str

Maximum time to allow one check to run (ms|s|m|h). Default: 0s.

ContainerHost

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.

ContainerLabel

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

ContainerMount

Target string

The container path.

Type string

The mount type: valid values are bind|volume|tmpfs.

BindOptions ContainerMountBindOptionsArgs

Optional configuration for the bind type.

ReadOnly bool

If true, this volume will be readonly. Defaults to false.

Source string

The mount source (e.g., a volume name, a host path)

TmpfsOptions ContainerMountTmpfsOptionsArgs

Optional configuration for the tmpf type.

VolumeOptions ContainerMountVolumeOptionsArgs

Optional configuration for the volume type.

Target string

The container path.

Type string

The mount type: valid values are bind|volume|tmpfs.

BindOptions ContainerMountBindOptions

Optional configuration for the bind type.

ReadOnly bool

If true, this volume will be readonly. Defaults to false.

Source string

The mount source (e.g., a volume name, a host path)

TmpfsOptions ContainerMountTmpfsOptions

Optional configuration for the tmpf type.

VolumeOptions ContainerMountVolumeOptions

Optional configuration for the volume type.

target string

The container path.

type string

The mount type: valid values are bind|volume|tmpfs.

bindOptions ContainerMountBindOptions

Optional configuration for the bind type.

readOnly boolean

If true, this volume will be readonly. Defaults to false.

source string

The mount source (e.g., a volume name, a host path)

tmpfsOptions ContainerMountTmpfsOptions

Optional configuration for the tmpf type.

volumeOptions ContainerMountVolumeOptions

Optional configuration for the volume type.

target str

The container path.

type str

The mount type: valid values are bind|volume|tmpfs.

bind_options ContainerMountBindOptionsArgs

Optional configuration for the bind type.

read_only bool

If true, this volume will be readonly. Defaults to false.

source str

The mount source (e.g., a volume name, a host path)

tmpfs_options ContainerMountTmpfsOptionsArgs

Optional configuration for the tmpf type.

volume_options ContainerMountVolumeOptionsArgs

Optional configuration for the volume type.

ContainerMountBindOptions

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.

ContainerMountTmpfsOptions

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

ContainerMountVolumeOptions

DriverName string
DriverOptions Dictionary<string, string>

Options for the driver.

Labels List<ContainerMountVolumeOptionsLabelArgs>

Adding labels.

NoCopy bool

Whether to populate volume with data from the target.

DriverName string
DriverOptions map[string]string

Options for the driver.

Labels []ContainerMountVolumeOptionsLabel

Adding labels.

NoCopy bool

Whether to populate volume with data from the target.

driverName string
driverOptions {[key: string]: string}

Options for the driver.

labels ContainerMountVolumeOptionsLabel[]

Adding labels.

noCopy boolean

Whether to populate volume with data from the target.

driver_name str
driver_options Mapping[str, str]

Options for the driver.

labels Sequence[ContainerMountVolumeOptionsLabelArgs]

Adding labels.

no_copy bool

Whether to populate volume with data from the target.

ContainerMountVolumeOptionsLabel

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

ContainerNetworkData

Gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

GlobalIpv6Address string
GlobalIpv6PrefixLength int
IpAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

IpPrefixLength int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Ipv6Gateway string
NetworkName string
Gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

GlobalIpv6Address string
GlobalIpv6PrefixLength int
IpAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

IpPrefixLength int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

Ipv6Gateway string
NetworkName string
gateway string

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

globalIpv6Address string
globalIpv6PrefixLength number
ipAddress string

Deprecated: Use network_data instead. The IP address of the container’s first network it.

ipPrefixLength number

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

ipv6Gateway string
networkName string
gateway str

Deprecated: Use network_data instead. The network gateway of the container as read from its NetworkSettings.

global_ipv6_address str
global_ipv6_prefix_length int
ip_address str

Deprecated: Use network_data instead. The IP address of the container’s first network it.

ip_prefix_length int

Deprecated: Use network_data instead. The IP prefix length of the container as read from its NetworkSettings.

ipv6_gateway str
network_name str

ContainerNetworksAdvanced

Name string

The name of the network.

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 of the network.

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 of the network.

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 of the network.

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.

ContainerPort

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 this hostname should resolve to.

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 this hostname should resolve to.

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 this hostname should resolve to.

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 this hostname should resolve to.

protocol str

Protocol that can be used over this port, defaults to tcp.

ContainerUlimit

Hard int
Name string
Soft int
Hard int
Name string
Soft int
hard number
name string
soft number
hard int
name str
soft int

ContainerUpload

File string

path to a file in the container.

Content string

Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

ContentBase64 string
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.

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 a file in the container.

Content string

Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

ContentBase64 string
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.

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 a file in the container.

content string

Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

contentBase64 string
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.

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 a file in the container.

content str

Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

content_base64 str
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.

source_hash str

If using source, this will force an update if the file content has updated but the filename has not.

ContainerVolume

ContainerPath string

The path in the container where the device will be binded.

FromContainer string

The container where the volume is coming from.

HostPath string

The path on the host where the device is located.

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 device will be binded.

FromContainer string

The container where the volume is coming from.

HostPath string

The path on the host where the device is located.

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 device will be binded.

fromContainer string

The container where the volume is coming from.

hostPath string

The path on the host where the device is located.

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 device will be binded.

from_container str

The container where the volume is coming from.

host_path str

The path on the host where the device is located.

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.

Import

Docker containers can be imported using the long id, e.g. for a container named foo

 $ pulumi import docker:index/container:Container foo $(docker inspect -f {{.ID}} foo)

Package Details

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