Class ContainerState

Inheritance

System.Object

InputArgs

ResourceArgs

ContainerState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Docker

Assembly: Pulumi.Docker.dll

Syntax

public sealed class ContainerState : ResourceArgs

Constructors

View Source

ContainerState()

Declaration

public ContainerState()

Properties

View Source

Attach

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

Declaration

public Input<bool> Attach { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

Bridge

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

Declaration

public Input<string> Bridge { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Capabilities

See Capabilities below for details.

Declaration

public Input<ContainerCapabilitiesGetArgs> Capabilities { get; set; }

Property Value

Type	Description
Input<ContainerCapabilitiesGetArgs>

View Source

Command

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

Declaration

public InputList<string> Command { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

ContainerLogs

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

Declaration

public Input<string> ContainerLogs { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

CpuSet

A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.

Declaration

public Input<string> CpuSet { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

CpuShares

CPU shares (relative weight) for the container.

Declaration

public Input<int> CpuShares { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

DestroyGraceSeconds

If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.

Declaration

public Input<int> DestroyGraceSeconds { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

Devices

See Devices below for details.

Declaration

public InputList<ContainerDeviceGetArgs> Devices { get; set; }

Property Value

Type	Description
InputList<ContainerDeviceGetArgs>

View Source

Dns

Set of DNS servers.

Declaration

public InputList<string> Dns { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

DnsOpts

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

Declaration

public InputList<string> DnsOpts { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

DnsSearches

Set of DNS search domains that are used when bare unqualified hostnames are used inside of the container.

Declaration

public InputList<string> DnsSearches { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

Domainname

Domain name of the container.

Declaration

public Input<string> Domainname { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Entrypoints

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

Declaration

public InputList<string> Entrypoints { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

Envs

Environment variables to set.

Declaration

public InputList<string> Envs { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

ExitCode

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

Declaration

public Input<int> ExitCode { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

Gateway

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

Declaration

public Input<string> Gateway { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

GroupAdds

Add additional groups to run as.

Declaration

public InputList<string> GroupAdds { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

Healthcheck

See Healthcheck below for details.

Declaration

public Input<ContainerHealthcheckGetArgs> Healthcheck { get; set; }

Property Value

Type	Description
Input<ContainerHealthcheckGetArgs>

View Source

Hostname

Hostname of the container.

Declaration

public Input<string> Hostname { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Hosts

Hostname to add.

Declaration

public InputList<ContainerHostGetArgs> Hosts { get; set; }

Property Value

Type	Description
InputList<ContainerHostGetArgs>

View Source

Image

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.

Declaration

public Input<string> Image { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

IpAddress

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

Declaration

public Input<string> IpAddress { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

IpcMode

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

Declaration

public Input<string> IpcMode { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

IpPrefixLength

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

Declaration

public Input<int> IpPrefixLength { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

Labels

Adding labels.

Declaration

public InputList<ContainerLabelGetArgs> Labels { get; set; }

Property Value

Type	Description
InputList<ContainerLabelGetArgs>

View Source

Links

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

Declaration

[Obsolete("The --link flag is a legacy feature of Docker. It may eventually be removed.")]
public InputList<string> Links { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

LogDriver

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

Declaration

public Input<string> LogDriver { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

LogOpts

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

Declaration

public InputMap<object> LogOpts { get; set; }

Property Value

Type	Description
InputMap<System.Object>

View Source

Logs

Save the container logs (attach must be enabled).

Declaration

public Input<bool> Logs { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

MaxRetryCount

The maximum amount of times to an attempt a restart when restart is set to "on-failure"

Declaration

public Input<int> MaxRetryCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

Memory

The memory limit for the container in MBs.

Declaration

public Input<int> Memory { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

MemorySwap

Declaration

public Input<int> MemorySwap { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

Mounts

See Mounts below for details.

Declaration

public InputList<ContainerMountGetArgs> Mounts { get; set; }

Property Value

Type	Description
InputList<ContainerMountGetArgs>

View Source

MustRun

Declaration

public Input<bool> MustRun { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

Name

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

NetworkAliases

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

Declaration

[Obsolete("Use networks_advanced instead. Will be removed in v2.0.0")]
public InputList<string> NetworkAliases { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

NetworkDatas

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

Declaration

public InputList<ContainerNetworkDataGetArgs> NetworkDatas { get; set; }

Property Value

Type	Description
InputList<ContainerNetworkDataGetArgs>

View Source

NetworkMode

Network mode of the container.

Declaration

public Input<string> NetworkMode { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Networks

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

Declaration

[Obsolete("Use networks_advanced instead. Will be removed in v2.0.0")]
public InputList<string> Networks { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

NetworksAdvanced

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

Declaration

public InputList<ContainerNetworksAdvancedGetArgs> NetworksAdvanced { get; set; }

Property Value

Type	Description
InputList<ContainerNetworksAdvancedGetArgs>

View Source

PidMode

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

Declaration

public Input<string> PidMode { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Ports

See Ports below for details.

Declaration

public InputList<ContainerPortGetArgs> Ports { get; set; }

Property Value

Type	Description
InputList<ContainerPortGetArgs>

View Source

Privileged

Run container in privileged mode.

Declaration

public Input<bool> Privileged { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

PublishAllPorts

Publish all ports of the container.

Declaration

public Input<bool> PublishAllPorts { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

ReadOnly

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

Declaration

public Input<bool> ReadOnly { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

Restart

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

Declaration

public Input<string> Restart { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Rm

Declaration

public Input<bool> Rm { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

ShmSize

Size of /dev/shm in MBs.

Declaration

public Input<int> ShmSize { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

Start

If true, then the Docker container will be started after creation. If false, then the container is only created.

Declaration

public Input<bool> Start { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

Sysctls

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

Declaration

public InputMap<object> Sysctls { get; set; }

Property Value

Type	Description
InputMap<System.Object>

View Source

Tmpfs

A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.

Declaration

public InputMap<object> Tmpfs { get; set; }

Property Value

Type	Description
InputMap<System.Object>

View Source

Ulimits

See Ulimits below for details.

Declaration

public InputList<ContainerUlimitGetArgs> Ulimits { get; set; }

Property Value

Type	Description
InputList<ContainerUlimitGetArgs>

View Source

Uploads

See File Upload below for details.

Declaration

public InputList<ContainerUploadGetArgs> Uploads { get; set; }

Property Value

Type	Description
InputList<ContainerUploadGetArgs>

View Source

User

User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.

Declaration

public Input<string> User { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

UsernsMode

Sets the usernamespace mode for the container when usernamespace remapping option is enabled.

Declaration

public Input<string> UsernsMode { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Volumes

See Volumes below for details.

Declaration

public InputList<ContainerVolumeGetArgs> Volumes { get; set; }

Property Value

Type	Description
InputList<ContainerVolumeGetArgs>

View Source

WorkingDir

The working directory for commands to run in

Declaration

public Input<string> WorkingDir { get; set; }

Property Value

Type	Description
Input<System.String>