Package software.amazon.awscdk.services.ecs

Class TaskDefinitionProps.Jsii$Proxy

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

  • 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(TaskDefinitionProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the TaskDefinitionProps.Builder.

  • Method Details

    • getCompatibility

      public final Compatibility getCompatibility()
      Description copied from interface: TaskDefinitionProps
      The task launch type compatiblity requirement.
      Specified by:
      getCompatibility in interface TaskDefinitionProps

    • getCpu

      public final String getCpu()
      Description copied from interface: TaskDefinitionProps
      The number of cpu units used by the task.

      If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

      256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

      512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

      1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

      2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

      4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

      8192 (8 vCPU) - Available memory values: Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB)

      16384 (16 vCPU) - Available memory values: Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB)

      Default: - CPU units are not specified.

      Specified by:
      getCpu in interface TaskDefinitionProps

    • getEphemeralStorageGiB

      public final Number getEphemeralStorageGiB()
      Description copied from interface: TaskDefinitionProps
      The amount (in GiB) of ephemeral storage to be allocated to the task.

      Only supported in Fargate platform version 1.4.0 or later.

      Default: - Undefined, in which case, the task will receive 20GiB ephemeral storage.

      Specified by:
      getEphemeralStorageGiB in interface TaskDefinitionProps

    • getInferenceAccelerators

      public final List<InferenceAccelerator> getInferenceAccelerators()
      Description copied from interface: TaskDefinitionProps
      The inference accelerators to use for the containers in the task.

      Not supported in Fargate.

      Default: - No inference accelerators.

      Specified by:
      getInferenceAccelerators in interface TaskDefinitionProps

    • getIpcMode

      public final IpcMode getIpcMode()
      Description copied from interface: TaskDefinitionProps
      The IPC resource namespace to use for the containers in the task.

      Not supported in Fargate and Windows containers.

      Default: - IpcMode used by the task is not specified

      Specified by:
      getIpcMode in interface TaskDefinitionProps

    • getMemoryMiB

      public final String getMemoryMiB()
      Description copied from interface: TaskDefinitionProps
      The amount (in MiB) of memory used by the task.

      If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

      512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

      1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

      2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

      Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

      Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

      Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

      Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

      Default: - Memory used by task is not specified.

      Specified by:
      getMemoryMiB in interface TaskDefinitionProps

    • getNetworkMode

      public final NetworkMode getNetworkMode()
      Description copied from interface: TaskDefinitionProps
      The networking mode to use for the containers in the task.

      On Fargate, the only supported networking mode is AwsVpc.

      Default: - NetworkMode.Bridge for EC2 invalid input: '&' External tasks, AwsVpc for Fargate tasks.

      Specified by:
      getNetworkMode in interface TaskDefinitionProps

    • getPidMode

      public final PidMode getPidMode()
      Description copied from interface: TaskDefinitionProps
      The process namespace to use for the containers in the task.

      Only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version 1.4.0 or later (Linux). Only the TASK option is supported for Linux-based Fargate containers. Not supported in Windows containers. If pidMode is specified for a Fargate task, then runtimePlatform.operatingSystemFamily must also be specified. For more information, see Task Definition Parameters.

      Default: - PidMode used by the task is not specified

      Specified by:
      getPidMode in interface TaskDefinitionProps

    • getPlacementConstraints

      public final List<PlacementConstraint> getPlacementConstraints()
      Description copied from interface: TaskDefinitionProps
      The placement constraints to use for tasks in the service.

      You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

      Not supported in Fargate.

      Default: - No placement constraints.

      Specified by:
      getPlacementConstraints in interface TaskDefinitionProps

    • getRuntimePlatform

      public final RuntimePlatform getRuntimePlatform()
      Description copied from interface: TaskDefinitionProps
      The operating system that your task definitions are running on.

      A runtimePlatform is supported only for tasks using the Fargate launch type.

      Default: - Undefined.

      Specified by:
      getRuntimePlatform in interface TaskDefinitionProps

    • getExecutionRole

      public final IRole getExecutionRole()
      Description copied from interface: CommonTaskDefinitionProps
      The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf.

      The role will be used to retrieve container images from ECR and create CloudWatch log groups.

      Default: - An execution role will be automatically created if you use ECR images in your task definition.

      Specified by:
      getExecutionRole in interface CommonTaskDefinitionProps

    • getFamily

      public final String getFamily()
      Description copied from interface: CommonTaskDefinitionProps
      The name of a family that this task definition is registered to.

      A family groups multiple versions of a task definition.

      Default: - Automatically generated name.

      Specified by:
      getFamily in interface CommonTaskDefinitionProps

    • getProxyConfiguration

      public final ProxyConfiguration getProxyConfiguration()
      Description copied from interface: CommonTaskDefinitionProps
      The configuration details for the App Mesh proxy.

      Default: - No proxy configuration.

      Specified by:
      getProxyConfiguration in interface CommonTaskDefinitionProps

    • getTaskRole

      public final IRole getTaskRole()
      Description copied from interface: CommonTaskDefinitionProps
      The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

      Default: - A task role is automatically created for you.

      Specified by:
      getTaskRole in interface CommonTaskDefinitionProps

    • getVolumes

      public final List<Volume> getVolumes()
      Description copied from interface: CommonTaskDefinitionProps
      The list of volume definitions for the task.

      For more information, see Task Definition Parameter Volumes.

      Default: - No volumes are passed to the Docker daemon on a container instance.

      Specified by:
      getVolumes in interface CommonTaskDefinitionProps

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