HostVolumeOptions Struct
Options for configuring an ECS HostVolume.
| Source | aws-batch/lib/ecs-container-definition.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const hostVolumeOptions: batch.HostVolumeOptions = {
containerPath: 'containerPath',
name: 'name',
// the properties below are optional
hostPath: 'hostPath',
readonly: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch
host_volume_options = batch.HostVolumeOptions(
container_path="containerPath",
name="name",
# the properties below are optional
host_path="hostPath",
readonly=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.batch.*;
HostVolumeOptions hostVolumeOptions = HostVolumeOptions.builder()
.containerPath("containerPath")
.name("name")
// the properties below are optional
.hostPath("hostPath")
.readonly(false)
.build();
csharp
// 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.Batch;
var hostVolumeOptions = new HostVolumeOptions {
ContainerPath = "containerPath",
Name = "name",
// the properties below are optional
HostPath = "hostPath",
Readonly = false
};
go
// 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"
hostVolumeOptions := &HostVolumeOptions{
ContainerPath: jsii.String("containerPath"),
Name: jsii.String("name"),
// the properties below are optional
HostPath: jsii.String("hostPath"),
Readonly: jsii.Boolean(false),
}
Properties
containerPathstringcontainer_pathstrcontainerPathStringContainerPathstringContainerPath*string required #the path on the container where this volume is mounted.
hostPathoptionalstringhost_pathoptionalstrhostPathoptionalStringHostPathoptionalstringHostPathoptional*string #The path on the host machine this container will have access to.
Default: Docker will choose the host path. The data may not persist after the containers that use it stop running.
the name of this volume.
readonlyoptionalbooleanreadonlyoptionalboolreadonlyoptionalBooleanReadonlyoptionalboolReadonlyoptional*bool = false #if set, the container will have readonly access to the volume.