Package software.amazon.awscdk.services.ecs

Class Volume.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ecs.Volume.Jsii$Proxy
All Implemented Interfaces:
Volume, software.amazon.jsii.JsiiSerializable
Enclosing interface:
Volume
@Stability(Stable) @Internal public static final class Volume.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements Volume
An implementation for Volume

  • 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.Volume

    Volume.Builder, Volume.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(Volume.Builder builder)
    Constructor that initializes the object based on literal property values passed by the Volume.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 Boolean
    getConfiguredAtLaunch()
    Indicates if the volume should be configured at launch.
    final DockerVolumeConfiguration
    getDockerVolumeConfiguration()
    This property is specified when you are using Docker volumes.
    final EfsVolumeConfiguration
    getEfsVolumeConfiguration()
    This property is specified when you are using Amazon EFS.
    final Host
    getHost()
    This property is specified when you are using 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(Volume.Builder builder)
      Constructor that initializes the object based on literal property values passed by the Volume.Builder.

  • Method Details

    • getName

      public final String getName()
      Description copied from interface: Volume
      The name of the volume.

      Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

      Specified by:
      getName in interface Volume

    • getConfiguredAtLaunch

      public final Boolean getConfiguredAtLaunch()
      Description copied from interface: Volume
      Indicates if the volume should be configured at launch.

      Default: false

      Specified by:
      getConfiguredAtLaunch in interface Volume

    • getDockerVolumeConfiguration

      public final DockerVolumeConfiguration getDockerVolumeConfiguration()
      Description copied from interface: Volume
      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.

      Specified by:
      getDockerVolumeConfiguration in interface Volume

    • getEfsVolumeConfiguration

      public final EfsVolumeConfiguration getEfsVolumeConfiguration()
      Description copied from interface: Volume
      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.

      Default: No Elastic FileSystem is setup

      Specified by:
      getEfsVolumeConfiguration in interface Volume

    • getHost

      public final Host getHost()
      Description copied from interface: Volume
      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.

      Specified by:
      getHost in interface Volume

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