Package software.amazon.awscdk.services.ecs

Class Volume.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.Volume.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Volume>
Enclosing interface:
Volume
@Stability(Stable) public static final class Volume.Builder extends Object implements software.amazon.jsii.Builder<Volume>
A builder for Volume

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public Volume.Builder name(String name)
      Sets the value of Volume.getName()
      Parameters:
      name - The name of the volume. This parameter is required. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
      Returns:
      this

    • configuredAtLaunch

      @Stability(Stable) public Volume.Builder configuredAtLaunch(Boolean configuredAtLaunch)
      Sets the value of Volume.getConfiguredAtLaunch()
      Parameters:
      configuredAtLaunch - Indicates if the volume should be configured at launch.
      Returns:
      this

    • dockerVolumeConfiguration

      @Stability(Stable) public Volume.Builder dockerVolumeConfiguration(DockerVolumeConfiguration dockerVolumeConfiguration)
      Sets the value of Volume.getDockerVolumeConfiguration()
      Parameters:
      dockerVolumeConfiguration - This property 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:
      this

    • efsVolumeConfiguration

      @Stability(Stable) public Volume.Builder efsVolumeConfiguration(EfsVolumeConfiguration efsVolumeConfiguration)
      Sets the value of Volume.getEfsVolumeConfiguration()
      Parameters:
      efsVolumeConfiguration - This property is specified when you are using Amazon EFS. When specifying Amazon EFS volumes in tasks using the Fargate launch type, Fargate creates a supervisor container that is responsible for managing the Amazon EFS volume. The supervisor container uses a small amount of the task's memory. The supervisor container is visible when querying the task metadata version 4 endpoint, but is not visible in CloudWatch Container Insights.
      Returns:
      this

    • host

      @Stability(Stable) public Volume.Builder host(Host host)
      Sets the value of Volume.getHost()
      Parameters:
      host - This property 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.
      Returns:
      this

    • build

      @Stability(Stable) public Volume build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<Volume>
      Returns:
      a new instance of Volume
      Throws:
      NullPointerException - if any required attribute was not provided