HostVolume Class
Creates a Host volume.
This volume will persist on the host at the specified hostPath. If the hostPath is not specified, Docker will choose the host path. In this case, the data may not persist after the containers that use it stop running.
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 hostVolume = new batch.HostVolume({
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 = batch.HostVolume(
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.*;
HostVolume hostVolume = HostVolume.Builder.create()
.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 hostVolume = new HostVolume(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"
hostVolume := awscdk.Aws_batch.NewHostVolume(&HostVolumeOptions{
ContainerPath: jsii.String("containerPath"),
Name: jsii.String("name"),
// the properties below are optional
HostPath: jsii.String("hostPath"),
Readonly: jsii.Boolean(false),
})
Initializer
ts
new HostVolume(options: HostVolumeOptions)
python
HostVolume(options: HostVolumeOptions)
java
new HostVolume(HostVolumeOptions options)
csharp
new HostVolume(HostVolumeOptions options)
go
NewHostVolume(Options HostVolumeOptions)
Properties
containerPathstringcontainer_pathstrcontainerPathStringContainerPathstringContainerPath*stringrequired#The path on the container that this volume will be mounted to.
hostPathmay be undefinedstringhost_pathmay be undefinedstrhostPathmay be undefinedStringHostPathmay be undefinedstringHostPathmay be undefined*string#The path on the host machine this container will have access to.
The name of this volume.
readonlymay be undefinedbooleanreadonlymay be undefinedboolreadonlymay be undefinedBooleanReadonlymay be undefinedboolReadonlymay be undefined*bool= false#Whether or not the container has readonly access to this volume.
Methods
efs(options: EfsVolumeOptions): EfsVolume@staticmethod def efs(options: EfsVolumeOptions) -> EfsVolumepublic static EfsVolume efs(EfsVolumeOptions options)public static EfsVolume Efs(EfsVolumeOptions options)func Efs(Options EfsVolumeOptions) EfsVolumestatic#Creates a Volume that uses an AWS Elastic File System (EFS);
this volume can grow and shrink as needed
host(options: HostVolumeOptions): HostVolume // chainable@staticmethod def host(options: HostVolumeOptions) -> HostVolumepublic static HostVolume host(HostVolumeOptions options)public static HostVolume Host(HostVolumeOptions options)func Host(Options HostVolumeOptions) HostVolumestatic#Creates a Host volume.
This volume will persist on the host at the specified hostPath. If the hostPath is not specified, Docker will choose the host path. In this case, the data may not persist after the containers that use it stop running.
isHostVolume(x: any): boolean@staticmethod def is_host_volume(x: Any) -> boolpublic static Boolean isHostVolume(Object x)public static bool IsHostVolume(object x)func IsHostVolume(X interface{}) *boolstatic#returns `true` if `x` is a `HostVolume`, `false` otherwise.