software.amazon.awssdk.services.ecs.model

Interface Volume.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Volume.Builder,Volume>, SdkBuilder<Volume.Builder,Volume>, SdkPojo

Enclosing class:

Volume

public static interface Volume.Builder
extends SdkPojo, CopyableBuilder<Volume.Builder,Volume>

Method Summary

Modifier and Type	Method and Description
default Volume.Builder	dockerVolumeConfiguration(Consumer<DockerVolumeConfiguration.Builder> dockerVolumeConfiguration) This parameter is specified when you are using Docker volumes.
Volume.Builder	dockerVolumeConfiguration(DockerVolumeConfiguration dockerVolumeConfiguration) This parameter is specified when you are using Docker volumes.
default Volume.Builder	host(Consumer<HostVolumeProperties.Builder> host) This parameter is specified when you are using bind mount host volumes.
Volume.Builder	host(HostVolumeProperties host) This parameter is specified when you are using bind mount host volumes.
Volume.Builder	name(String name) The name of the volume.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

Volume.Builder name(String name)

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

Parameters:

name - The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

Returns:

Returns a reference to this object so that method calls can be chained together.

host

Volume.Builder host(HostVolumeProperties host)

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Parameters:

host - This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Returns:

Returns a reference to this object so that method calls can be chained together.

host

default Volume.Builder host(Consumer<HostVolumeProperties.Builder> host)

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

This is a convenience that creates an instance of the HostVolumeProperties.Builder avoiding the need to create one manually via HostVolumeProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to host(HostVolumeProperties).

Parameters:

host - a consumer that will call methods on HostVolumeProperties.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

host(HostVolumeProperties)

dockerVolumeConfiguration

Volume.Builder dockerVolumeConfiguration(DockerVolumeConfiguration dockerVolumeConfiguration)

This parameter is specified when you are using 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.

Parameters:

dockerVolumeConfiguration - This parameter is specified when you are using 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

dockerVolumeConfiguration

default Volume.Builder dockerVolumeConfiguration(Consumer<DockerVolumeConfiguration.Builder> dockerVolumeConfiguration)

This parameter is specified when you are using 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.

This is a convenience that creates an instance of the DockerVolumeConfiguration.Builder avoiding the need to create one manually via DockerVolumeConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dockerVolumeConfiguration(DockerVolumeConfiguration).

Parameters:

dockerVolumeConfiguration - a consumer that will call methods on DockerVolumeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dockerVolumeConfiguration(DockerVolumeConfiguration)