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 use Docker volumes.
Volume.Builder	dockerVolumeConfiguration(DockerVolumeConfiguration dockerVolumeConfiguration) This parameter is specified when you use Docker volumes.
default Volume.Builder	efsVolumeConfiguration(Consumer<EFSVolumeConfiguration.Builder> efsVolumeConfiguration) This parameter is specified when you use an Amazon Elastic File System file system for task storage.
Volume.Builder	efsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration) This parameter is specified when you use an Amazon Elastic File System file system for task storage.
default Volume.Builder	fsxWindowsFileServerVolumeConfiguration(Consumer<FSxWindowsFileServerVolumeConfiguration.Builder> fsxWindowsFileServerVolumeConfiguration) This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
Volume.Builder	fsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration) This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
default Volume.Builder	host(Consumer<HostVolumeProperties.Builder> host) This parameter is specified when you use bind mount host volumes.
Volume.Builder	host(HostVolumeProperties host) This parameter is specified when you use bind mount host volumes.
Volume.Builder	name(String name) The name of the volume.

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

equalsBySdkFields, 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, underscores, and hyphens 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, underscores, and hyphens 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 use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't 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 use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't 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 use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't 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 method 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 use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

Parameters:

dockerVolumeConfiguration - This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

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 use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

This is a convenience method 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)

efsVolumeConfiguration

Volume.Builder efsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration)

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

Parameters:

efsVolumeConfiguration - This parameter is specified when you use an Amazon Elastic File System file system for task storage.

Returns:

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

efsVolumeConfiguration

default Volume.Builder efsVolumeConfiguration(Consumer<EFSVolumeConfiguration.Builder> efsVolumeConfiguration)

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

This is a convenience method that creates an instance of the EFSVolumeConfiguration.Builder avoiding the need to create one manually via EFSVolumeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to efsVolumeConfiguration(EFSVolumeConfiguration).

Parameters:

efsVolumeConfiguration - a consumer that will call methods on EFSVolumeConfiguration.Builder

Returns:

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

See Also:

efsVolumeConfiguration(EFSVolumeConfiguration)

fsxWindowsFileServerVolumeConfiguration

Volume.Builder fsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration)

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Parameters:

fsxWindowsFileServerVolumeConfiguration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Returns:

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

fsxWindowsFileServerVolumeConfiguration

default Volume.Builder fsxWindowsFileServerVolumeConfiguration(Consumer<FSxWindowsFileServerVolumeConfiguration.Builder> fsxWindowsFileServerVolumeConfiguration)

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

This is a convenience method that creates an instance of the FSxWindowsFileServerVolumeConfiguration.Builder avoiding the need to create one manually via FSxWindowsFileServerVolumeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration).

Parameters:

fsxWindowsFileServerVolumeConfiguration - a consumer that will call methods on FSxWindowsFileServerVolumeConfiguration.Builder

Returns:

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

See Also:

fsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration)