TaskSet.Builder (AWS SDK for Java

All Superinterfaces:

Buildable, CopyableBuilder<TaskSet.Builder,TaskSet>, SdkBuilder<TaskSet.Builder,TaskSet>, SdkPojo

Enclosing class:

TaskSet
```
public static interface TaskSet.Builder
extends SdkPojo, CopyableBuilder<TaskSet.Builder,TaskSet>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`TaskSet.Builder`	`computedDesiredCount(Integer computedDesiredCount)` The computed desired count for the task set.
`TaskSet.Builder`	`createdAt(Instant createdAt)` The Unix timestamp for when the task set was created.
`TaskSet.Builder`	`externalId(String externalId)` The deployment ID of the AWS CodeDeploy deployment.
`TaskSet.Builder`	`id(String id)` The ID of the task set.
`TaskSet.Builder`	`launchType(LaunchType launchType)` The launch type the tasks in the task set are using.
`TaskSet.Builder`	`launchType(String launchType)` The launch type the tasks in the task set are using.
`TaskSet.Builder`	`loadBalancers(Collection<LoadBalancer> loadBalancers)` Details on a load balancer that is used with a task set.
`TaskSet.Builder`	`loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)` Details on a load balancer that is used with a task set.
`TaskSet.Builder`	`loadBalancers(LoadBalancer... loadBalancers)` Details on a load balancer that is used with a task set.
`default TaskSet.Builder`	`networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)` The network configuration for the task set.
`TaskSet.Builder`	`networkConfiguration(NetworkConfiguration networkConfiguration)` The network configuration for the task set.
`TaskSet.Builder`	`pendingCount(Integer pendingCount)` The number of tasks in the task set that are in the `PENDING` status during a deployment.
`TaskSet.Builder`	`platformVersion(String platformVersion)` The platform version on which the tasks in the task set are running.
`TaskSet.Builder`	`runningCount(Integer runningCount)` The number of tasks in the task set that are in the `RUNNING` status during a deployment.
`default TaskSet.Builder`	`scale(Consumer<Scale.Builder> scale)` A floating-point percentage of the desired number of tasks to place and keep running in the service.
`TaskSet.Builder`	`scale(Scale scale)` A floating-point percentage of the desired number of tasks to place and keep running in the service.
`TaskSet.Builder`	`stabilityStatus(StabilityStatus stabilityStatus)` The stability status, which indicates whether the task set has reached a steady state.
`TaskSet.Builder`	`stabilityStatus(String stabilityStatus)` The stability status, which indicates whether the task set has reached a steady state.
`TaskSet.Builder`	`stabilityStatusAt(Instant stabilityStatusAt)` The Unix timestamp for when the task set stability status was retrieved.
`TaskSet.Builder`	`startedBy(String startedBy)` The tag specified when a task set is started.
`TaskSet.Builder`	`status(String status)` The status of the task set.
`TaskSet.Builder`	`taskDefinition(String taskDefinition)` The task definition the task set is using.
`TaskSet.Builder`	`taskSetArn(String taskSetArn)` The Amazon Resource Name (ARN) of the task set.
`TaskSet.Builder`	`updatedAt(Instant updatedAt)` The Unix timestamp for when the task set was last updated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - id
```
TaskSet.Builder id(String id)
```
    The ID of the task set.
    
    Parameters:
    
    id - The ID of the task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskSetArn
```
TaskSet.Builder taskSetArn(String taskSetArn)
```
    The Amazon Resource Name (ARN) of the task set.
    
    Parameters:
    
    taskSetArn - The Amazon Resource Name (ARN) of the task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - startedBy
```
TaskSet.Builder startedBy(String startedBy)
```
    The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.
    
    Parameters:
    
    startedBy - The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - externalId
```
TaskSet.Builder externalId(String externalId)
```
    The deployment ID of the AWS CodeDeploy deployment.
    
    Parameters:
    
    externalId - The deployment ID of the AWS CodeDeploy deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - status
```
TaskSet.Builder status(String status)
```
    The status of the task set. The following describes each state:
    
    PRIMARY
    
    The task set is serving production traffic.
    
    ACTIVE
    
    The task set is not serving production traffic.
    
    DRAINING
    
    The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
    
    Parameters:
    
    status - The status of the task set. The following describes each state:
    
    PRIMARY
    
    The task set is serving production traffic.
    
    ACTIVE
    
    The task set is not serving production traffic.
    
    DRAINING
    
    The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskDefinition
```
TaskSet.Builder taskDefinition(String taskDefinition)
```
    The task definition the task set is using.
    
    Parameters:
    
    taskDefinition - The task definition the task set is using.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - computedDesiredCount
```
TaskSet.Builder computedDesiredCount(Integer computedDesiredCount)
```
    The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
    
    Parameters:
    
    computedDesiredCount - The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - pendingCount
```
TaskSet.Builder pendingCount(Integer pendingCount)
```
    The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
    
    Parameters:
    
    pendingCount - The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - runningCount
```
TaskSet.Builder runningCount(Integer runningCount)
```
    The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
    
    Parameters:
    
    runningCount - The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - createdAt
```
TaskSet.Builder createdAt(Instant createdAt)
```
    The Unix timestamp for when the task set was created.
    
    Parameters:
    
    createdAt - The Unix timestamp for when the task set was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - updatedAt
```
TaskSet.Builder updatedAt(Instant updatedAt)
```
    The Unix timestamp for when the task set was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp for when the task set was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - launchType
```
TaskSet.Builder launchType(String launchType)
```
    The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    launchType - The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LaunchType, LaunchType
  - launchType
```
TaskSet.Builder launchType(LaunchType launchType)
```
    The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    launchType - The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LaunchType, LaunchType
  - platformVersion
```
TaskSet.Builder platformVersion(String platformVersion)
```
    The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    platformVersion - The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS 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.
  - networkConfiguration
```
TaskSet.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
```
    The network configuration for the task set.
    
    Parameters:
    
    networkConfiguration - The network configuration for the task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkConfiguration
```
default TaskSet.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
```
    The network configuration for the task set.
    This is a convenience 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:
    
    networkConfiguration(NetworkConfiguration)
  - loadBalancers
```
TaskSet.Builder loadBalancers(Collection<LoadBalancer> loadBalancers)
```
    Details on a load balancer that is used with a task set.
    
    Parameters:
    
    loadBalancers - Details on a load balancer that is used with a task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - loadBalancers
```
TaskSet.Builder loadBalancers(LoadBalancer... loadBalancers)
```
    Details on a load balancer that is used with a task set.
    
    Parameters:
    
    loadBalancers - Details on a load balancer that is used with a task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - loadBalancers
```
TaskSet.Builder loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)
```
    Details on a load balancer that is used with a task set.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #loadBalancers(List).
    
    Parameters:
    
    loadBalancers - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #loadBalancers(List)
  - scale
```
TaskSet.Builder scale(Scale scale)
```
    A floating-point percentage of the desired number of tasks to place and keep running in the service.
    
    Parameters:
    
    scale - A floating-point percentage of the desired number of tasks to place and keep running in the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scale
```
default TaskSet.Builder scale(Consumer<Scale.Builder> scale)
```
    A floating-point percentage of the desired number of tasks to place and keep running in the service.
    This is a convenience that creates an instance of the Scale.Builder avoiding the need to create one manually via Scale.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scale(Scale).
    
    Parameters:
    
    scale - a consumer that will call methods on Scale.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    scale(Scale)
  - stabilityStatus
```
TaskSet.Builder stabilityStatus(String stabilityStatus)
```
    The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    - The task runningCount is equal to the computedDesiredCount.
    - The pendingCount is 0.
    - There are no tasks running on container instances in the DRAINING status.
    - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    If any of those conditions are not met, the stability status returns STABILIZING.
    Parameters:
    stabilityStatus - The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    
    The task runningCount is equal to the computedDesiredCount.
    
    The pendingCount is 0.
    
    There are no tasks running on container instances in the DRAINING status.
    
    All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    
    If any of those conditions are not met, the stability status returns STABILIZING.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StabilityStatus, StabilityStatus
  - stabilityStatus
```
TaskSet.Builder stabilityStatus(StabilityStatus stabilityStatus)
```
    The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    - The task runningCount is equal to the computedDesiredCount.
    - The pendingCount is 0.
    - There are no tasks running on container instances in the DRAINING status.
    - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    If any of those conditions are not met, the stability status returns STABILIZING.
    Parameters:
    stabilityStatus - The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
    
    The task runningCount is equal to the computedDesiredCount.
    
    The pendingCount is 0.
    
    There are no tasks running on container instances in the DRAINING status.
    
    All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
    
    If any of those conditions are not met, the stability status returns STABILIZING.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StabilityStatus, StabilityStatus
  - stabilityStatusAt
```
TaskSet.Builder stabilityStatusAt(Instant stabilityStatusAt)
```
    The Unix timestamp for when the task set stability status was retrieved.
    
    Parameters:
    
    stabilityStatusAt - The Unix timestamp for when the task set stability status was retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface TaskSet.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

id

taskSetArn

startedBy

externalId

status

taskDefinition

computedDesiredCount

pendingCount

runningCount

createdAt

updatedAt

launchType

launchType

platformVersion

networkConfiguration

networkConfiguration

loadBalancers

loadBalancers

loadBalancers

scale

scale

stabilityStatus

stabilityStatus

stabilityStatusAt