Interface EcsTaskDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EcsTaskDetails.Builder,EcsTaskDetails>, SdkBuilder<EcsTaskDetails.Builder,EcsTaskDetails>, SdkPojo
Enclosing class:
EcsTaskDetails
@Mutable @NotThreadSafe public static interface EcsTaskDetails.Builder extends SdkPojo, CopyableBuilder<EcsTaskDetails.Builder,EcsTaskDetails>

  • Method Details

    • containers

      EcsTaskDetails.Builder containers(Collection<TaskContainerDetails> containers)

      A list of containers that are included in the taskProperties list.

      Parameters:
      containers - A list of containers that are included in the taskProperties list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containers

      EcsTaskDetails.Builder containers(TaskContainerDetails... containers)

      A list of containers that are included in the taskProperties list.

      Parameters:
      containers - A list of containers that are included in the taskProperties list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containers

      EcsTaskDetails.Builder containers(Consumer<TaskContainerDetails.Builder>... containers)

      A list of containers that are included in the taskProperties list.

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

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

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

    • containerInstanceArn

      EcsTaskDetails.Builder containerInstanceArn(String containerInstanceArn)

      The Amazon Resource Name (ARN) of the container instance that hosts the task.

      Parameters:
      containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that hosts the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskArn

      EcsTaskDetails.Builder taskArn(String taskArn)

      The ARN of the Amazon ECS task.

      Parameters:
      taskArn - The ARN of the Amazon ECS task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      EcsTaskDetails.Builder ephemeralStorage(EphemeralStorage ephemeralStorage)

      The amount of ephemeral storage allocated for the task.

      Parameters:
      ephemeralStorage - The amount of ephemeral storage allocated for the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

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

      The amount of ephemeral storage allocated for the task.

      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

      EcsTaskDetails.Builder executionRoleArn(String executionRoleArn)

      The Amazon Resource Name (ARN) of the execution role that Batch can assume. 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 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

      EcsTaskDetails.Builder platformVersion(String platformVersion)

      The Fargate platform version where the jobs are running.

      Parameters:
      platformVersion - The Fargate platform version where the jobs are running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipcMode

      EcsTaskDetails.Builder ipcMode(String ipcMode)

      The IPC resource namespace to use for the containers in the task.

      Parameters:
      ipcMode - The IPC resource namespace to use for the containers in the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskRoleArn

      EcsTaskDetails.Builder taskRoleArn(String taskRoleArn)

      The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

      This is object is comparable to ContainerProperties:jobRoleArn.

      Parameters:
      taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

      This is object is comparable to ContainerProperties:jobRoleArn.

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

    • pidMode

      EcsTaskDetails.Builder pidMode(String pidMode)

      The process namespace to use for the containers in the task.

      Parameters:
      pidMode - The process namespace to use for the containers in the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      EcsTaskDetails.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 EcsTaskDetails.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

      EcsTaskDetails.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 EcsTaskDetails.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

      EcsTaskDetails.Builder volumes(Collection<Volume> volumes)

      A list of data volumes used in a job.

      Parameters:
      volumes - A list of data volumes used in a job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      EcsTaskDetails.Builder volumes(Volume... volumes)

      A list of data volumes used in a job.

      Parameters:
      volumes - A list of data volumes used in a job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

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

      A list of data volumes used in a 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:

    • enableExecuteCommand

      EcsTaskDetails.Builder enableExecuteCommand(Boolean enableExecuteCommand)

      Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

      Parameters:
      enableExecuteCommand - Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.