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
Container
Capabilities Args 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"]
.- Cpu
Set string A comma-separated list or hyphen-separated range of CPUs a container can use, e.g.
0-1
.- int
CPU shares (relative weight) for the container.
- Destroy
Grace intSeconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- Devices
List<Container
Device Args> See Devices below for details.
- Dns List<string>
Set of DNS servers.
- Dns
Opts List<string> Set of DNS options used by the DNS provider(s), see
resolv.conf
documentation for valid list of options.- Dns
Searches 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.
- Group
Adds List<string> Add additional groups to run as.
- Healthcheck
Container
Healthcheck Args See Healthcheck below for details.
- Hostname string
Hostname of the container.
- Hosts
List<Container
Host Args> 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 string IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- Labels
List<Container
Label Args> Adding labels.
- Links List<string>
Set of links for link based connectivity between containers that are running on the same host.
- Log
Driver string The logging driver to use for the container. Defaults to “json-file”.
- Log
Opts Dictionary<string, object> Key/value pairs to use as options for the logging driver.
- Logs bool
Save the container logs (
attach
must be enabled).- Max
Retry intCount 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
List<Container
Mount Args> See Mounts below for details.
- Must
Run bool - Name string
- Network
Aliases List<string> Network aliases of the container for user-defined networks only. Deprecated: use
networks_advanced
instead.- Network
Mode string Network mode of the container.
- Networks List<string>
Id of the networks in which the container is. Deprecated: use
networks_advanced
instead.- Networks
Advanced List<ContainerNetworks Advanced Args> See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- Pid
Mode string The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- Ports
List<Container
Port Args> See Ports below for details.
- Privileged bool
Run container in privileged mode.
- Publish
All boolPorts Publish all ports of the container.
- Read
Only bool If true, this volume will be readonly. Defaults to false.
- Remove
Volumes bool - Restart string
The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.
- Rm bool
- Security
Opts 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.
- 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 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<Container
Ulimit Args> See Ulimits below for details.
- Uploads
List<Container
Upload Args> See File Upload below for details.
- User string
User used for run the first process. Format is
user
oruser:group
which user and group can be passed literraly or by name.- Userns
Mode string Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
- Volumes
List<Container
Volume Args> See Volumes below for details.
- Working
Dir 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
Container
Capabilities 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"]
.- Cpu
Set string A comma-separated list or hyphen-separated range of CPUs a container can use, e.g.
0-1
.- int
CPU shares (relative weight) for the container.
- Destroy
Grace intSeconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- Devices
[]Container
Device See Devices below for details.
- Dns []string
Set of DNS servers.
- Dns
Opts []string Set of DNS options used by the DNS provider(s), see
resolv.conf
documentation for valid list of options.- Dns
Searches []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.
- Group
Adds []string Add additional groups to run as.
- Healthcheck
Container
Healthcheck See Healthcheck below for details.
- Hostname string
Hostname of the container.
- Hosts
[]Container
Host 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 string IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- Labels
[]Container
Label Adding labels.
- Links []string
Set of links for link based connectivity between containers that are running on the same host.
- Log
Driver string The logging driver to use for the container. Defaults to “json-file”.
- Log
Opts map[string]interface{} Key/value pairs to use as options for the logging driver.
- Logs bool
Save the container logs (
attach
must be enabled).- Max
Retry intCount 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
[]Container
Mount See Mounts below for details.
- Must
Run bool - Name string
- Network
Aliases []string Network aliases of the container for user-defined networks only. Deprecated: use
networks_advanced
instead.- Network
Mode string Network mode of the container.
- Networks []string
Id of the networks in which the container is. Deprecated: use
networks_advanced
instead.- Networks
Advanced []ContainerNetworks Advanced See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- Pid
Mode string The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- Ports
[]Container
Port See Ports below for details.
- Privileged bool
Run container in privileged mode.
- Publish
All boolPorts Publish all ports of the container.
- Read
Only bool If true, this volume will be readonly. Defaults to false.
- Remove
Volumes bool - Restart string
The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.
- Rm bool
- Security
Opts []string 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 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
[]Container
Ulimit See Ulimits below for details.
- Uploads
[]Container
Upload See File Upload below for details.
- User string
User used for run the first process. Format is
user
oruser:group
which user and group can be passed literraly or by name.- Userns
Mode string Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
- Volumes
[]Container
Volume See Volumes below for details.
- Working
Dir 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
Container
Capabilities 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"]
.- cpu
Set string A comma-separated list or hyphen-separated range of CPUs a container can use, e.g.
0-1
.- number
CPU shares (relative weight) for the container.
- destroy
Grace numberSeconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- devices
Container
Device[] See Devices below for details.
- dns string[]
Set of DNS servers.
- dns
Opts string[] Set of DNS options used by the DNS provider(s), see
resolv.conf
documentation for valid list of options.- dns
Searches 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.
- group
Adds string[] Add additional groups to run as.
- healthcheck
Container
Healthcheck See Healthcheck below for details.
- hostname string
Hostname of the container.
- hosts
Container
Host[] 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.- ipc
Mode string IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- labels
Container
Label[] Adding labels.
- links string[]
Set of links for link based connectivity between containers that are running on the same host.
- log
Driver string The logging driver to use for the container. Defaults to “json-file”.
- log
Opts {[key: string]: any} Key/value pairs to use as options for the logging driver.
- logs boolean
Save the container logs (
attach
must be enabled).- max
Retry numberCount 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.
- memory
Swap number - mounts
Container
Mount[] See Mounts below for details.
- must
Run boolean - name string
- network
Aliases string[] Network aliases of the container for user-defined networks only. Deprecated: use
networks_advanced
instead.- network
Mode string Network mode of the container.
- networks string[]
Id of the networks in which the container is. Deprecated: use
networks_advanced
instead.- networks
Advanced ContainerNetworks Advanced[] See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- pid
Mode string The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- ports
Container
Port[] See Ports below for details.
- privileged boolean
Run container in privileged mode.
- publish
All booleanPorts Publish all ports of the container.
- read
Only boolean If true, this volume will be readonly. Defaults to false.
- remove
Volumes boolean - restart string
The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.
- rm boolean
- security
Opts string[] 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 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.
- stdin
Open 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
Container
Ulimit[] See Ulimits below for details.
- uploads
Container
Upload[] See File Upload below for details.
- user string
User used for run the first process. Format is
user
oruser:group
which user and group can be passed literraly or by name.- userns
Mode string Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
- volumes
Container
Volume[] See Volumes below for details.
- working
Dir 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
Container
Capabilities Args 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
.- int
CPU shares (relative weight) for the container.
- destroy_
grace_ intseconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- devices
Sequence[Container
Device Args] 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
Container
Healthcheck Args See Healthcheck below for details.
- hostname str
Hostname of the container.
- hosts
Sequence[Container
Host Args] 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>
orhost
.- labels
Sequence[Container
Label Args] Adding labels.
- links Sequence[str]
Set of links for link based connectivity between containers that are running on the same host.
- 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_ intcount 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[Container
Mount Args] 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.- 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.- networks_
advanced Sequence[ContainerNetworks Advanced Args] See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- pid_
mode str The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- ports
Sequence[Container
Port Args] See Ports below for details.
- privileged bool
Run container in privileged mode.
- publish_
all_ boolports 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[Container
Ulimit Args] See Ulimits below for details.
- uploads
Sequence[Container
Upload Args] See File Upload below for details.
- user str
User used for run the first process. Format is
user
oruser: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[Container
Volume Args] 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.
- Container
Logs string 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 string
Deprecated: Use
network_data
instead. The network gateway of the container as read from its NetworkSettings.- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- Ip
Prefix intLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- Network
Datas List<ContainerNetwork Data> (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.
- Container
Logs string 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 string
Deprecated: Use
network_data
instead. The network gateway of the container as read from its NetworkSettings.- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- Ip
Prefix intLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- Network
Datas []ContainerNetwork Data (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.
- container
Logs string The logs of the container if its execution is done (
attach
must be disabled).- exit
Code 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.- id string
- The provider-assigned unique ID for this managed resource.
- ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- ip
Prefix numberLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- network
Datas ContainerNetwork Data[] (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.- 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.- ip_
prefix_ intlength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- network_
datas Sequence[ContainerNetwork Data] (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
Container
Capabilities Args 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"]
.- Container
Logs string The logs of the container if its execution is done (
attach
must be disabled).- Cpu
Set string A comma-separated list or hyphen-separated range of CPUs a container can use, e.g.
0-1
.- int
CPU shares (relative weight) for the container.
- Destroy
Grace intSeconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- Devices
List<Container
Device Args> See Devices below for details.
- Dns List<string>
Set of DNS servers.
- Dns
Opts List<string> Set of DNS options used by the DNS provider(s), see
resolv.conf
documentation for valid list of options.- Dns
Searches 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.
- Exit
Code 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.- Group
Adds List<string> Add additional groups to run as.
- Healthcheck
Container
Healthcheck Args See Healthcheck below for details.
- Hostname string
Hostname of the container.
- Hosts
List<Container
Host Args> 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.- Ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- Ip
Prefix intLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- Ipc
Mode string IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- Labels
List<Container
Label Args> Adding labels.
- Links List<string>
Set of links for link based connectivity between containers that are running on the same host.
- Log
Driver string The logging driver to use for the container. Defaults to “json-file”.
- Log
Opts Dictionary<string, object> Key/value pairs to use as options for the logging driver.
- Logs bool
Save the container logs (
attach
must be enabled).- Max
Retry intCount 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
List<Container
Mount Args> See Mounts below for details.
- Must
Run bool - Name string
- Network
Aliases List<string> Network aliases of the container for user-defined networks only. Deprecated: use
networks_advanced
instead.- Network
Datas List<ContainerNetwork Data Args> (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 string Network mode of the container.
- Networks List<string>
Id of the networks in which the container is. Deprecated: use
networks_advanced
instead.- Networks
Advanced List<ContainerNetworks Advanced Args> See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- Pid
Mode string The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- Ports
List<Container
Port Args> See Ports below for details.
- Privileged bool
Run container in privileged mode.
- Publish
All boolPorts Publish all ports of the container.
- Read
Only bool If true, this volume will be readonly. Defaults to false.
- Remove
Volumes bool - Restart string
The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.
- Rm bool
- Security
Opts 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.
- 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 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<Container
Ulimit Args> See Ulimits below for details.
- Uploads
List<Container
Upload Args> See File Upload below for details.
- User string
User used for run the first process. Format is
user
oruser:group
which user and group can be passed literraly or by name.- Userns
Mode string Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
- Volumes
List<Container
Volume Args> See Volumes below for details.
- Working
Dir 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
Container
Capabilities 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"]
.- Container
Logs string The logs of the container if its execution is done (
attach
must be disabled).- Cpu
Set string A comma-separated list or hyphen-separated range of CPUs a container can use, e.g.
0-1
.- int
CPU shares (relative weight) for the container.
- Destroy
Grace intSeconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- Devices
[]Container
Device See Devices below for details.
- Dns []string
Set of DNS servers.
- Dns
Opts []string Set of DNS options used by the DNS provider(s), see
resolv.conf
documentation for valid list of options.- Dns
Searches []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.
- Exit
Code 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.- Group
Adds []string Add additional groups to run as.
- Healthcheck
Container
Healthcheck See Healthcheck below for details.
- Hostname string
Hostname of the container.
- Hosts
[]Container
Host 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.- Ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- Ip
Prefix intLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- Ipc
Mode string IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- Labels
[]Container
Label Adding labels.
- Links []string
Set of links for link based connectivity between containers that are running on the same host.
- Log
Driver string The logging driver to use for the container. Defaults to “json-file”.
- Log
Opts map[string]interface{} Key/value pairs to use as options for the logging driver.
- Logs bool
Save the container logs (
attach
must be enabled).- Max
Retry intCount 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
[]Container
Mount See Mounts below for details.
- Must
Run bool - Name string
- Network
Aliases []string Network aliases of the container for user-defined networks only. Deprecated: use
networks_advanced
instead.- Network
Datas []ContainerNetwork Data (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 string Network mode of the container.
- Networks []string
Id of the networks in which the container is. Deprecated: use
networks_advanced
instead.- Networks
Advanced []ContainerNetworks Advanced See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- Pid
Mode string The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- Ports
[]Container
Port See Ports below for details.
- Privileged bool
Run container in privileged mode.
- Publish
All boolPorts Publish all ports of the container.
- Read
Only bool If true, this volume will be readonly. Defaults to false.
- Remove
Volumes bool - Restart string
The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.
- Rm bool
- Security
Opts []string 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 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
[]Container
Ulimit See Ulimits below for details.
- Uploads
[]Container
Upload See File Upload below for details.
- User string
User used for run the first process. Format is
user
oruser:group
which user and group can be passed literraly or by name.- Userns
Mode string Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
- Volumes
[]Container
Volume See Volumes below for details.
- Working
Dir 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
Container
Capabilities 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"]
.- container
Logs string The logs of the container if its execution is done (
attach
must be disabled).- cpu
Set string A comma-separated list or hyphen-separated range of CPUs a container can use, e.g.
0-1
.- number
CPU shares (relative weight) for the container.
- destroy
Grace numberSeconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- devices
Container
Device[] See Devices below for details.
- dns string[]
Set of DNS servers.
- dns
Opts string[] Set of DNS options used by the DNS provider(s), see
resolv.conf
documentation for valid list of options.- dns
Searches 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.
- exit
Code 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.- group
Adds string[] Add additional groups to run as.
- healthcheck
Container
Healthcheck See Healthcheck below for details.
- hostname string
Hostname of the container.
- hosts
Container
Host[] 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.- ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- ip
Prefix numberLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- ipc
Mode string IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- labels
Container
Label[] Adding labels.
- links string[]
Set of links for link based connectivity between containers that are running on the same host.
- log
Driver string The logging driver to use for the container. Defaults to “json-file”.
- log
Opts {[key: string]: any} Key/value pairs to use as options for the logging driver.
- logs boolean
Save the container logs (
attach
must be enabled).- max
Retry numberCount 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.
- memory
Swap number - mounts
Container
Mount[] See Mounts below for details.
- must
Run boolean - name string
- network
Aliases string[] Network aliases of the container for user-defined networks only. Deprecated: use
networks_advanced
instead.- network
Datas ContainerNetwork Data[] (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 string Network mode of the container.
- networks string[]
Id of the networks in which the container is. Deprecated: use
networks_advanced
instead.- networks
Advanced ContainerNetworks Advanced[] See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- pid
Mode string The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- ports
Container
Port[] See Ports below for details.
- privileged boolean
Run container in privileged mode.
- publish
All booleanPorts Publish all ports of the container.
- read
Only boolean If true, this volume will be readonly. Defaults to false.
- remove
Volumes boolean - restart string
The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.
- rm boolean
- security
Opts string[] 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 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.
- stdin
Open 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
Container
Ulimit[] See Ulimits below for details.
- uploads
Container
Upload[] See File Upload below for details.
- user string
User used for run the first process. Format is
user
oruser:group
which user and group can be passed literraly or by name.- userns
Mode string Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
- volumes
Container
Volume[] See Volumes below for details.
- working
Dir 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
Container
Capabilities Args 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
.- int
CPU shares (relative weight) for the container.
- destroy_
grace_ intseconds If defined will attempt to stop the container before destroying. Container will be destroyed after
n
seconds or on successful stop.- devices
Sequence[Container
Device Args] 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.- group_
adds Sequence[str] Add additional groups to run as.
- healthcheck
Container
Healthcheck Args See Healthcheck below for details.
- hostname str
Hostname of the container.
- hosts
Sequence[Container
Host Args] 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.- ip_
prefix_ intlength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- ipc_
mode str IPC sharing mode for the container. Possible values are:
none
,private
,shareable
,container:<name|id>
orhost
.- labels
Sequence[Container
Label Args] Adding labels.
- links Sequence[str]
Set of links for link based connectivity between containers that are running on the same host.
- 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_ intcount 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[Container
Mount Args] 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.- network_
datas Sequence[ContainerNetwork Data Args] (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.- networks_
advanced Sequence[ContainerNetworks Advanced Args] See Networks Advanced below for details. If this block has priority to the deprecated
network_alias
andnetwork
properties.- pid_
mode str The PID (Process) Namespace mode for the container. Either
container:<name|id>
orhost
.- ports
Sequence[Container
Port Args] See Ports below for details.
- privileged bool
Run container in privileged mode.
- publish_
all_ boolports 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[Container
Ulimit Args] See Ulimits below for details.
- uploads
Sequence[Container
Upload Args] See File Upload below for details.
- user str
User used for run the first process. Format is
user
oruser: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[Container
Volume Args] See Volumes below for details.
- working_
dir str The working directory for commands to run in
Supporting Types
ContainerCapabilities
ContainerDevice
- Host
Path string The path on the host where the device is located.
- Container
Path 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 string The path on the host where the device is located.
- Container
Path 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 string The path on the host where the device is located.
- container
Path 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
.- Start
Period 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
.- Start
Period 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
.- start
Period 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
ContainerLabel
ContainerMount
- Target string
The container path.
- Type string
The mount type: valid values are
bind|volume|tmpfs
.- Bind
Options ContainerMount Bind Options Args Optional configuration for the
bind
type.- Read
Only bool If true, this volume will be readonly. Defaults to false.
- Source string
The mount source (e.g., a volume name, a host path)
- Tmpfs
Options ContainerMount Tmpfs Options Args Optional configuration for the
tmpf
type.- Volume
Options ContainerMount Volume Options Args Optional configuration for the
volume
type.
- Target string
The container path.
- Type string
The mount type: valid values are
bind|volume|tmpfs
.- Bind
Options ContainerMount Bind Options Optional configuration for the
bind
type.- Read
Only bool If true, this volume will be readonly. Defaults to false.
- Source string
The mount source (e.g., a volume name, a host path)
- Tmpfs
Options ContainerMount Tmpfs Options Optional configuration for the
tmpf
type.- Volume
Options ContainerMount Volume Options Optional configuration for the
volume
type.
- target string
The container path.
- type string
The mount type: valid values are
bind|volume|tmpfs
.- bind
Options ContainerMount Bind Options Optional configuration for the
bind
type.- read
Only boolean If true, this volume will be readonly. Defaults to false.
- source string
The mount source (e.g., a volume name, a host path)
- tmpfs
Options ContainerMount Tmpfs Options Optional configuration for the
tmpf
type.- volume
Options ContainerMount Volume Options Optional configuration for the
volume
type.
- target str
The container path.
- type str
The mount type: valid values are
bind|volume|tmpfs
.- bind_
options ContainerMount Bind Options Args 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 ContainerMount Tmpfs Options Args Optional configuration for the
tmpf
type.- volume_
options ContainerMount Volume Options Args 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.
- size_
bytes int The size for the tmpfs mount in bytes.
ContainerMountVolumeOptions
- Driver
Name string - Driver
Options Dictionary<string, string> Options for the driver.
- Labels
List<Container
Mount Volume Options Label Args> Adding labels.
- No
Copy bool Whether to populate volume with data from the target.
- Driver
Name string - Driver
Options map[string]string Options for the driver.
- Labels
[]Container
Mount Volume Options Label Adding labels.
- No
Copy bool Whether to populate volume with data from the target.
- driver
Name string - driver
Options {[key: string]: string} Options for the driver.
- labels
Container
Mount Volume Options Label[] Adding labels.
- no
Copy boolean Whether to populate volume with data from the target.
- driver_
name str - driver_
options Mapping[str, str] Options for the driver.
- labels
Sequence[Container
Mount Volume Options Label Args] Adding labels.
- no_
copy bool Whether to populate volume with data from the target.
ContainerMountVolumeOptionsLabel
ContainerNetworkData
- Gateway string
Deprecated: Use
network_data
instead. The network gateway of the container as read from its NetworkSettings.- Global
Ipv6Address string - Global
Ipv6Prefix intLength - Ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- Ip
Prefix intLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- Ipv6Gateway string
- Network
Name string
- Gateway string
Deprecated: Use
network_data
instead. The network gateway of the container as read from its NetworkSettings.- Global
Ipv6Address string - Global
Ipv6Prefix intLength - Ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- Ip
Prefix intLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- Ipv6Gateway string
- Network
Name string
- gateway string
Deprecated: Use
network_data
instead. The network gateway of the container as read from its NetworkSettings.- global
Ipv6Address string - global
Ipv6Prefix numberLength - ip
Address string Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- ip
Prefix numberLength Deprecated: Use
network_data
instead. The IP prefix length of the container as read from its NetworkSettings.- ipv6Gateway string
- network
Name string
- gateway str
Deprecated: Use
network_data
instead. The network gateway of the container as read from its NetworkSettings.- global_
ipv6_ straddress - global_
ipv6_ intprefix_ length - ip_
address str Deprecated: Use
network_data
instead. The IP address of the container’s first network it.- ip_
prefix_ intlength 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
ContainerUlimit
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.
- Content
Base64 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.
- Source
Hash 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.
- Content
Base64 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.
- Source
Hash 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.
- content
Base64 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.
- source
Hash 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
- Container
Path string The path in the container where the device will be binded.
- From
Container string The container where the volume is coming from.
- Host
Path string 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 string The name of the docker volume which should be mounted.
- Container
Path string The path in the container where the device will be binded.
- From
Container string The container where the volume is coming from.
- Host
Path string 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 string The name of the docker volume which should be mounted.
- container
Path string The path in the container where the device will be binded.
- from
Container string The container where the volume is coming from.
- host
Path string The path on the host where the device is located.
- read
Only boolean If true, this volume will be readonly. Defaults to false.
- volume
Name 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.