Package software.amazon.awssdk.services.batch.model

Interface EcsTaskProperties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EcsTaskProperties.Builder,EcsTaskProperties>, SdkBuilder<EcsTaskProperties.Builder,EcsTaskProperties>, SdkPojo
Enclosing class:
EcsTaskProperties
public static interface EcsTaskProperties.Builder extends SdkPojo, CopyableBuilder<EcsTaskProperties.Builder,EcsTaskProperties>

  • Method Details

    • containers

      EcsTaskProperties.Builder containers(Collection<TaskContainerProperties> containers)

      This object is a list of containers.

      Parameters:
      containers - This object is a list of containers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containers

      EcsTaskProperties.Builder containers(TaskContainerProperties... containers)

      This object is a list of containers.

      Parameters:
      containers - This object is a list of containers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containers

      EcsTaskProperties.Builder containers(Consumer<TaskContainerProperties.Builder>... containers)

      This object is a list of containers.

      This is a convenience method that creates an instance of the TaskContainerProperties.Builder avoiding the need to create one manually via TaskContainerProperties.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containers(List<TaskContainerProperties>).

      Parameters:
      containers - a consumer that will call methods on TaskContainerProperties.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ephemeralStorage

      EcsTaskProperties.Builder ephemeralStorage(EphemeralStorage ephemeralStorage)

      The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

      Parameters:
      ephemeralStorage - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      default EcsTaskProperties.Builder ephemeralStorage(Consumer<EphemeralStorage.Builder> ephemeralStorage)

      The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

      This is a convenience method that creates an instance of the EphemeralStorage.Builder avoiding the need to create one manually via EphemeralStorage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ephemeralStorage(EphemeralStorage).

      Parameters:
      ephemeralStorage - a consumer that will call methods on EphemeralStorage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRoleArn

      EcsTaskProperties.Builder executionRoleArn(String executionRoleArn)

      The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformVersion

      EcsTaskProperties.Builder platformVersion(String platformVersion)

      The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      platformVersion - The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipcMode

      EcsTaskProperties.Builder ipcMode(String ipcMode)

      The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

      If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same IPC resources.

      If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

      If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

      Parameters:
      ipcMode - The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

      If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same IPC resources.

      If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

      If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskRoleArn

      EcsTaskProperties.Builder taskRoleArn(String taskRoleArn)

      The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

      This is object is comparable to ContainerProperties:jobRoleArn.

      Parameters:
      taskRoleArn - The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

      This is object is comparable to ContainerProperties:jobRoleArn.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pidMode

      EcsTaskProperties.Builder pidMode(String pidMode)

      The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

      If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same process namespace.

      If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

      Parameters:
      pidMode - The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

      If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

      If task is specified, all containers within the specified task share the same process namespace.

      If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      EcsTaskProperties.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

      The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

      Parameters:
      networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      default EcsTaskProperties.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

      The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

      This is a convenience method that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

      Parameters:
      networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runtimePlatform

      EcsTaskProperties.Builder runtimePlatform(RuntimePlatform runtimePlatform)

      An object that represents the compute environment architecture for Batch jobs on Fargate.

      Parameters:
      runtimePlatform - An object that represents the compute environment architecture for Batch jobs on Fargate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimePlatform

      default EcsTaskProperties.Builder runtimePlatform(Consumer<RuntimePlatform.Builder> runtimePlatform)

      An object that represents the compute environment architecture for Batch jobs on Fargate.

      This is a convenience method that creates an instance of the RuntimePlatform.Builder avoiding the need to create one manually via RuntimePlatform.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runtimePlatform(RuntimePlatform).

      Parameters:
      runtimePlatform - a consumer that will call methods on RuntimePlatform.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • volumes

      EcsTaskProperties.Builder volumes(Collection<Volume> volumes)

      A list of volumes that are associated with the job.

      Parameters:
      volumes - A list of volumes that are associated with the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      EcsTaskProperties.Builder volumes(Volume... volumes)

      A list of volumes that are associated with the job.

      Parameters:
      volumes - A list of volumes that are associated with the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      EcsTaskProperties.Builder volumes(Consumer<Volume.Builder>... volumes)

      A list of volumes that are associated with the job.

      This is a convenience method that creates an instance of the Volume.Builder avoiding the need to create one manually via Volume.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumes(List<Volume>).

      Parameters:
      volumes - a consumer that will call methods on Volume.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: