DockerRunOptions

Docker run options.

Initializer

import { DockerRunOptions } from '@alicloud/ros-cdk-core'
const dockerRunOptions: DockerRunOptions = { ... }

Properties

Name	Type	Description
command	string[]	The command to run in the container.
entrypoint	string[]	The entrypoint to run in the container.
environment	{[ key: string ]: string}	The environment variables to pass to the container.
network	string	Docker Networking options.
platform	string	Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.
securityOpt	string	Security configuration when running the docker container.
user	string	The user to use when running the container.
volumes	DockerVolume[]	Docker volumes to mount.
volumesFrom	string[]	Where to mount the specified volumes from.
workingDirectory	string	Working directory inside the container.

---

command^Optional

public readonly command: string[];

• Type: string[]
• Default: run the command defined in the image

The command to run in the container.

---

entrypoint^Optional

public readonly entrypoint: string[];

• Type: string[]
• Default: run the entrypoint defined in the image

The entrypoint to run in the container.

---

environment^Optional

public readonly environment: {[ key: string ]: string};

• Type: {[ key: string ]: string}
• Default: no environment variables.

The environment variables to pass to the container.

---

network^Optional

public readonly network: string;

• Type: string
• Default: no networking options

Docker Networking options.

---

platform^Optional

public readonly platform: string;

• Type: string
• Default: no platform specified

Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.

Example value: linux/amd64

---

securityOpt^Optional

public readonly securityOpt: string;

• Type: string
• Default: no security options

Security configuration when running the docker container.

---

user^Optional

public readonly user: string;

• Type: string
• Default: root or image default

The user to use when running the container.

---

volumes^Optional

public readonly volumes: DockerVolume[];

• Type: DockerVolume[]
• Default: no volumes are mounted

Docker volumes to mount.

---

volumesFrom^Optional

public readonly volumesFrom: string[];

• Type: string[]
• Default: no containers are specified to mount volumes from

Where to mount the specified volumes from.

https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container---volumes-from

---

workingDirectory^Optional

public readonly workingDirectory: string;

• Type: string
• Default: image default

Working directory inside the container.

---