aws-cdk-lib.DockerRunOptions

DockerRunOptions Struct

Docker run options.

Source

core/lib/bundling.ts

Type last changed

v2.88.0 · 20 Jul 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const dockerRunOptions: cdk.DockerRunOptions = {
  command: ['command'],
  entrypoint: ['entrypoint'],
  environment: {
    environmentKey: 'environment',
  },
  network: 'network',
  platform: 'platform',
  securityOpt: 'securityOpt',
  user: 'user',
  volumes: [{
    containerPath: 'containerPath',
    hostPath: 'hostPath',

    // the properties below are optional
    consistency: cdk.DockerVolumeConsistency.CONSISTENT,
  }],
  volumesFrom: ['volumesFrom'],
  workingDirectory: 'workingDirectory',
};

Properties

command?optionalstring[]command?optionaltyping.List[str]command?optionalList<String>Command?optionalstring[]Command?optional*[]*string#

The command to run in the container.

Default: run the command defined in the image

entrypoint?optionalstring[]entrypoint?optionaltyping.List[str]entrypoint?optionalList<String>Entrypoint?optionalstring[]Entrypoint?optional*[]*string#

The entrypoint to run in the container.

Default: run the entrypoint defined in the image

environment?optional{ [key: string]: string }environment?optionaltyping.Mapping[str, str]environment?optionalMap<String, String>Environment?optionalIDictionary<string, string>Environment?optional*map[string]*string#

The environment variables to pass to the container.

Default: no environment variables.

network?optionalstringnetwork?optionalstrnetwork?optionalStringNetwork?optionalstringNetwork?optional*string#

Docker [Networking options](https://docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network---network).

Default: no networking options

platform?optionalstringplatform?optionalstrplatform?optionalStringPlatform?optionalstringPlatform?optional*string#

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

Default: no platform specified

Example value: linux/amd64

securityOpt?optionalstringsecurity_opt?optionalstrsecurityOpt?optionalStringSecurityOpt?optionalstringSecurityOpt?optional*string#

[Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.

Default: no security options

user?optionalstringuser?optionalstruser?optionalStringUser?optionalstringUser?optional*string#

The user to use when running the container.

Default: root or image default

volumes?optionalDockerVolume[]volumes?optionaltyping.List[DockerVolume]volumes?optionalList<DockerVolume>Volumes?optionalDockerVolume[]Volumes?optional*[]DockerVolume#

Docker volumes to mount.

Default: no volumes are mounted

volumesFrom?optionalstring[]volumes_from?optionaltyping.List[str]volumesFrom?optionalList<String>VolumesFrom?optionalstring[]VolumesFrom?optional*[]*string#

Where to mount the specified volumes from.

Default: no containers are specified to mount volumes from

workingDirectory?optionalstringworking_directory?optionalstrworkingDirectory?optionalStringWorkingDirectory?optionalstringWorkingDirectory?optional*string#

Working directory inside the container.

Default: image default