Class CfnTaskDefinition.VolumeProperty.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.CfnTaskDefinition.VolumeProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskDefinition.VolumeProperty>
Enclosing interface:
CfnTaskDefinition.VolumeProperty

@Stability(Stable) public static final class CfnTaskDefinition.VolumeProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnTaskDefinition.VolumeProperty>
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • configuredAtLaunch

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder configuredAtLaunch(Boolean configuredAtLaunch)
      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:
      this
    • configuredAtLaunch

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder configuredAtLaunch(IResolvable configuredAtLaunch)
      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:
      this
    • dockerVolumeConfiguration

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder dockerVolumeConfiguration(IResolvable dockerVolumeConfiguration)
      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 AWS Fargate .

      Returns:
      this
    • dockerVolumeConfiguration

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder dockerVolumeConfiguration(CfnTaskDefinition.DockerVolumeConfigurationProperty dockerVolumeConfiguration)
      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 AWS Fargate .

      Returns:
      this
    • efsVolumeConfiguration

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder efsVolumeConfiguration(IResolvable efsVolumeConfiguration)
      Parameters:
      efsVolumeConfiguration - This parameter is specified when you use an Amazon Elastic File System file system for task storage.
      Returns:
      this
    • efsVolumeConfiguration

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder efsVolumeConfiguration(CfnTaskDefinition.EFSVolumeConfigurationProperty efsVolumeConfiguration)
      Parameters:
      efsVolumeConfiguration - This parameter is specified when you use an Amazon Elastic File System file system for task storage.
      Returns:
      this
    • host

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder host(IResolvable host)
      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:
      this
    • host

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

      @Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder name(String name)
      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:
      this
    • build

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