DockerVolumeConfigurationProperty Struct
The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes.
Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
| Source | |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const dockerVolumeConfigurationProperty: ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty = {
autoprovision: false,
driver: 'driver',
driverOpts: {
driverOptsKey: 'driverOpts',
},
labels: {
labelsKey: 'labels',
},
scope: 'scope',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecs as ecs
docker_volume_configuration_property = ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty(
autoprovision=False,
driver="driver",
driver_opts={
"driver_opts_key": "driverOpts"
},
labels={
"labels_key": "labels"
},
scope="scope"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ecs.*;
DockerVolumeConfigurationProperty dockerVolumeConfigurationProperty = DockerVolumeConfigurationProperty.builder()
.autoprovision(false)
.driver("driver")
.driverOpts(Map.of(
"driverOptsKey", "driverOpts"))
.labels(Map.of(
"labelsKey", "labels"))
.scope("scope")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var dockerVolumeConfigurationProperty = new DockerVolumeConfigurationProperty {
Autoprovision = false,
Driver = "driver",
DriverOpts = new Dictionary<string, string> {
{ "driverOptsKey", "driverOpts" }
},
Labels = new Dictionary<string, string> {
{ "labelsKey", "labels" }
},
Scope = "scope"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dockerVolumeConfigurationProperty := &DockerVolumeConfigurationProperty{
Autoprovision: jsii.Boolean(false),
Driver: jsii.String("driver"),
DriverOpts: map[string]*string{
"driverOptsKey": jsii.String("driverOpts"),
},
Labels: map[string]*string{
"labelsKey": jsii.String("labels"),
},
Scope: jsii.String("scope"),
}
Properties
autoprovisionoptionalboolean | IResolvableautoprovisionoptionaltyping.Union[bool, IResolvable]autoprovisionoptionalBooleanAutoprovisionoptionalboolAutoprovisionoptionalinterface{} #This field is only used if the
scopeisshared.
driveroptionalstringdriveroptionalstrdriveroptionalStringDriveroptionalstringDriveroptional*string #notes
The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.
driverOptsoptionalIResolvable | { [key: string]: string }driver_optsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]driverOptsoptionalIResolvableDriverOptsoptionalIResolvableDriverOptsoptionalinterface{} #This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.
labelsoptionalIResolvable | { [key: string]: string }labelsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]labelsoptionalIResolvableLabelsoptionalIResolvableLabelsoptionalinterface{} #This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.
Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.