Package software.amazon.awscdk.services.ecs

Class CfnTaskDefinition.VolumeProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.CfnTaskDefinition.VolumeProperty.Jsii$Proxy

All Implemented Interfaces:

CfnTaskDefinition.VolumeProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnTaskDefinition.VolumeProperty

@Stability(Stable)
@Internal
public static final class CfnTaskDefinition.VolumeProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnTaskDefinition.VolumeProperty

An implementation for CfnTaskDefinition.VolumeProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.CfnTaskDefinition.VolumeProperty

CfnTaskDefinition.VolumeProperty.Builder, CfnTaskDefinition.VolumeProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnTaskDefinition.VolumeProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnTaskDefinition.VolumeProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getConfiguredAtLaunch()	Indicates whether the volume should be configured at launch time.
final Object	getDockerVolumeConfiguration()	This parameter is specified when you use Docker volumes.
final Object	getEfsVolumeConfiguration()	This parameter is specified when you use an Amazon Elastic File System file system for task storage.
final Object	getFSxWindowsFileServerVolumeConfiguration()	This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
final Object	getHost()	This parameter is specified when you use bind mount host volumes.
final String	getName()	The name of the volume.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnTaskDefinition.VolumeProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnTaskDefinition.VolumeProperty.Builder.

Method Details

getConfiguredAtLaunch

public final Object getConfiguredAtLaunch()

Description copied from interface: CfnTaskDefinition.VolumeProperty

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 union: either Boolean or IResolvable

Specified by:

getConfiguredAtLaunch in interface CfnTaskDefinition.VolumeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-configuredatlaunch

getDockerVolumeConfiguration

public final Object getDockerVolumeConfiguration()

Description copied from interface: CfnTaskDefinition.VolumeProperty

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 union: either IResolvable or CfnTaskDefinition.DockerVolumeConfigurationProperty

Specified by:

getDockerVolumeConfiguration in interface CfnTaskDefinition.VolumeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-dockervolumeconfiguration

getEfsVolumeConfiguration

public final Object getEfsVolumeConfiguration()

Description copied from interface: CfnTaskDefinition.VolumeProperty

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

Returns union: either IResolvable or CfnTaskDefinition.EFSVolumeConfigurationProperty

Specified by:

getEfsVolumeConfiguration in interface CfnTaskDefinition.VolumeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-efsvolumeconfiguration

getFSxWindowsFileServerVolumeConfiguration

public final Object getFSxWindowsFileServerVolumeConfiguration()

Description copied from interface: CfnTaskDefinition.VolumeProperty

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Returns union: either IResolvable or CfnTaskDefinition.FSxWindowsFileServerVolumeConfigurationProperty

Specified by:

getFSxWindowsFileServerVolumeConfiguration in interface CfnTaskDefinition.VolumeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-fsxwindowsfileservervolumeconfiguration

getHost

public final Object getHost()

Description copied from interface: CfnTaskDefinition.VolumeProperty

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 union: either IResolvable or CfnTaskDefinition.HostVolumePropertiesProperty

Specified by:

getHost in interface CfnTaskDefinition.VolumeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-host

getName

public final String getName()

Description copied from interface: CfnTaskDefinition.VolumeProperty

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.

Specified by:

getName in interface CfnTaskDefinition.VolumeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html#cfn-ecs-taskdefinition-volume-name

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object