Interface Volume.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Volume.Builder,Volume>, SdkBuilder<Volume.Builder,Volume>, SdkPojo
Enclosing class:
Volume
@Mutable @NotThreadSafe public static interface Volume.Builder extends SdkPojo, CopyableBuilder<Volume.Builder,Volume>

  • Method Details

    • name

      Volume.Builder name(String name)

      The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

      When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

      For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

      When a volume is using the efsVolumeConfiguration, the name is required.

      Parameters:
      name - The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

      When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

      For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

      When a volume is using the efsVolumeConfiguration, the name is required.

      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:

    • 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:

    • 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:

    • 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:

    • configuredAtLaunch

      Volume.Builder configuredAtLaunch(Boolean configuredAtLaunch)

      Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

      To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService, UpdateService, RunTask or StartTask APIs.

      Parameters:
      configuredAtLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

      To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService, UpdateService, RunTask or StartTask APIs.

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