Skip to content
v2.274.0

NetworkMode Class ​

networking mode on build time supported by docker.

Example ​

ts
import { DockerImageAsset, NetworkMode } from 'aws-cdk-lib/aws-ecr-assets';

const asset = new DockerImageAsset(this, 'MyBuildImage', {
  directory: path.join(__dirname, 'my-image'),
  networkMode: NetworkMode.HOST,
})

Properties ​

DEFAULTNetworkModedefaultNetworkModeDEFAULTNetworkModeDEFAULTNetworkModeDEFAULTNetworkModerequiredstatic#
The default networking mode if omitted, create a network stack on the default Docker bridge.
Use the Docker host network stack.
modestringmodestrmodeStringModestringMode*stringrequired#
The networking mode to use for docker build.
Disable the network stack, only the loopback device will be created.

Methods ​

custom(mode: string): NetworkMode // chainable@staticmethod def custom(mode: str) -> NetworkModepublic static NetworkMode custom(String mode)public static NetworkMode Custom(string mode)func Custom(Mode *string) NetworkModestatic#
Used to specify a custom networking mode Use this if the networking mode name is not yet supported by the CDK.
1 parameter

Parameters

  • modemodemodemodeMode — The networking mode to use for docker build.
fromContainer(containerId: string): NetworkMode // chainable@staticmethod def from_container(container_id: str) -> NetworkModepublic static NetworkMode fromContainer(String containerId)public static NetworkMode FromContainer(string containerId)func FromContainer(ContainerId *string) NetworkModestatic#
Reuse another container's network stack.
1 parameter

Parameters

  • containerIdcontainer_idcontainerIdcontainerIdContainerId — The target container's id or name.