Class CfnTaskDefinitionPropsMixin.VolumeProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskDefinitionPropsMixin.VolumeProperty>
- Enclosing interface:
CfnTaskDefinitionPropsMixin.VolumeProperty
CfnTaskDefinitionPropsMixin.VolumeProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.configuredAtLaunch(Boolean configuredAtLaunch) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getConfiguredAtLaunch()configuredAtLaunch(IResolvable configuredAtLaunch) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getConfiguredAtLaunch()dockerVolumeConfiguration(CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty dockerVolumeConfiguration) dockerVolumeConfiguration(IResolvable dockerVolumeConfiguration) efsVolumeConfiguration(CfnTaskDefinitionPropsMixin.EFSVolumeConfigurationProperty efsVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getEfsVolumeConfiguration()efsVolumeConfiguration(IResolvable efsVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getEfsVolumeConfiguration()fSxWindowsFileServerVolumeConfiguration(CfnTaskDefinitionPropsMixin.FSxWindowsFileServerVolumeConfigurationProperty fSxWindowsFileServerVolumeConfiguration) fSxWindowsFileServerVolumeConfiguration(IResolvable fSxWindowsFileServerVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getHost()host(IResolvable host) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getHost()Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
configuredAtLaunch
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder configuredAtLaunch(Boolean configuredAtLaunch) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getConfiguredAtLaunch()- 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
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs.- Returns:
this
-
configuredAtLaunch
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder configuredAtLaunch(IResolvable configuredAtLaunch) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getConfiguredAtLaunch()- 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
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs.- Returns:
this
-
dockerVolumeConfiguration
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder dockerVolumeConfiguration(IResolvable dockerVolumeConfiguration) - Parameters:
dockerVolumeConfiguration- This parameter is specified when you use Docker volumes. Windows containers only support the use of thelocaldriver. To use bind mounts, specify thehostparameter instead.Docker volumes aren't supported by tasks run on AWS Fargate .
- Returns:
this
-
dockerVolumeConfiguration
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder dockerVolumeConfiguration(CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty dockerVolumeConfiguration) - Parameters:
dockerVolumeConfiguration- This parameter is specified when you use Docker volumes. Windows containers only support the use of thelocaldriver. To use bind mounts, specify thehostparameter instead.Docker volumes aren't supported by tasks run on AWS Fargate .
- Returns:
this
-
efsVolumeConfiguration
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder efsVolumeConfiguration(IResolvable efsVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getEfsVolumeConfiguration()- 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 CfnTaskDefinitionPropsMixin.VolumeProperty.Builder efsVolumeConfiguration(CfnTaskDefinitionPropsMixin.EFSVolumeConfigurationProperty efsVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getEfsVolumeConfiguration()- Parameters:
efsVolumeConfiguration- This parameter is specified when you use an Amazon Elastic File System file system for task storage.- Returns:
this
-
fSxWindowsFileServerVolumeConfiguration
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder fSxWindowsFileServerVolumeConfiguration(IResolvable fSxWindowsFileServerVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getFSxWindowsFileServerVolumeConfiguration()- Parameters:
fSxWindowsFileServerVolumeConfiguration- This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.- Returns:
this
-
fSxWindowsFileServerVolumeConfiguration
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder fSxWindowsFileServerVolumeConfiguration(CfnTaskDefinitionPropsMixin.FSxWindowsFileServerVolumeConfigurationProperty fSxWindowsFileServerVolumeConfiguration) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getFSxWindowsFileServerVolumeConfiguration()- Parameters:
fSxWindowsFileServerVolumeConfiguration- This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.- Returns:
this
-
host
Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getHost()- Parameters:
host- This parameter is specified when you use bind mount host volumes. The contents of thehostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter 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 mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path.- Returns:
this
-
host
@Stability(Stable) public CfnTaskDefinitionPropsMixin.VolumeProperty.Builder host(CfnTaskDefinitionPropsMixin.HostVolumePropertiesProperty host) Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getHost()- Parameters:
host- This parameter is specified when you use bind mount host volumes. The contents of thehostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter 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 mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path.- Returns:
this
-
name
Sets the value ofCfnTaskDefinitionPropsMixin.VolumeProperty.getName()- 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, thenameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task.For all other types of volumes, this name is referenced in the
sourceVolumeparameter of themountPointsobject in the container definition.When a volume is using the
efsVolumeConfiguration, the name is required.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnTaskDefinitionPropsMixin.VolumeProperty>- Returns:
- a new instance of
CfnTaskDefinitionPropsMixin.VolumeProperty - Throws:
NullPointerException- if any required attribute was not provided
-