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

Interface EcsTaskDetails.Builder

    • Method Detail

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

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

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

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

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

        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:
        #volumes(java.util.Collection)