software.amazon.awssdk.services.batch.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	efsVolumeConfiguration(Consumer<EFSVolumeConfiguration.Builder> efsVolumeConfiguration) This parameter is specified when you're using an Amazon Elastic File System file system for job storage.
Volume.Builder	efsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration) This parameter is specified when you're using an Amazon Elastic File System file system for job storage.
default Volume.Builder	host(Consumer<Host.Builder> host) The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored.
Volume.Builder	host(Host host) The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored.
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

host

Volume.Builder host(Host host)

The contents of the host parameter determine whether your data 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.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Parameters:

host - The contents of the host parameter determine whether your data 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.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Returns:

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

host

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

The contents of the host parameter determine whether your data 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.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

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

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

Parameters:

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

Returns:

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

See Also:

host(Host)

name

Volume.Builder name(String name)

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

Parameters:

name - The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). 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.

efsVolumeConfiguration

Volume.Builder efsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration)

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

Parameters:

efsVolumeConfiguration - This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

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're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

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)