Interface TaskSet.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TaskSet.Builder,
,TaskSet> SdkBuilder<TaskSet.Builder,
,TaskSet> SdkPojo
- Enclosing class:
TaskSet
-
Method Summary
Modifier and TypeMethodDescriptioncapacityProviderStrategy
(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy that are associated with the task set.capacityProviderStrategy
(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy) The capacity provider strategy that are associated with the task set.capacityProviderStrategy
(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy that are associated with the task set.clusterArn
(String clusterArn) The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.computedDesiredCount
(Integer computedDesiredCount) The computed desired count for the task set.The Unix timestamp for the time when the task set was created.externalId
(String externalId) The external ID associated with the task set.The ID of the task set.launchType
(String launchType) The launch type the tasks in the task set are using.launchType
(LaunchType launchType) The launch type the tasks in the task set are using.loadBalancers
(Collection<LoadBalancer> loadBalancers) Details on a load balancer that are used with a task set.loadBalancers
(Consumer<LoadBalancer.Builder>... loadBalancers) Details on a load balancer that are used with a task set.loadBalancers
(LoadBalancer... loadBalancers) Details on a load balancer that are used with a task set.default TaskSet.Builder
networkConfiguration
(Consumer<NetworkConfiguration.Builder> networkConfiguration) The network configuration for the task set.networkConfiguration
(NetworkConfiguration networkConfiguration) The network configuration for the task set.pendingCount
(Integer pendingCount) The number of tasks in the task set that are in thePENDING
status during a deployment.platformFamily
(String platformFamily) The operating system that your tasks in the set are running on.platformVersion
(String platformVersion) The Fargate platform version where the tasks in the task set are running.runningCount
(Integer runningCount) The number of tasks in the task set that are in theRUNNING
status during a deployment.default TaskSet.Builder
scale
(Consumer<Scale.Builder> scale) A floating-point percentage of your desired number of tasks to place and keep running in the task set.A floating-point percentage of your desired number of tasks to place and keep running in the task set.serviceArn
(String serviceArn) The Amazon Resource Name (ARN) of the service the task set exists in.serviceRegistries
(Collection<ServiceRegistry> serviceRegistries) The details for the service discovery registries to assign to this task set.serviceRegistries
(Consumer<ServiceRegistry.Builder>... serviceRegistries) The details for the service discovery registries to assign to this task set.serviceRegistries
(ServiceRegistry... serviceRegistries) The details for the service discovery registries to assign to this task set.stabilityStatus
(String stabilityStatus) The stability status.stabilityStatus
(StabilityStatus stabilityStatus) The stability status.stabilityStatusAt
(Instant stabilityStatusAt) The Unix timestamp for the time when the task set stability status was retrieved.The tag specified when a task set is started.The status of the task set.tags
(Collection<Tag> tags) The metadata that you apply to the task set to help you categorize and organize them.tags
(Consumer<Tag.Builder>... tags) The metadata that you apply to the task set to help you categorize and organize them.The metadata that you apply to the task set to help you categorize and organize them.taskDefinition
(String taskDefinition) The task definition that the task set is using.taskSetArn
(String taskSetArn) The Amazon Resource Name (ARN) of the task set.The Unix timestamp for the time when the task set was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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.
-
serviceArn
The Amazon Resource Name (ARN) of the service the task set exists in.
- Parameters:
serviceArn
- The Amazon Resource Name (ARN) of the service the task set exists in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterArn
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
- Parameters:
clusterArn
- The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedBy
The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.- Parameters:
startedBy
- The tag specified when a task set is started. If an CodeDeploy deployment created the task set, thestartedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalId
The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.- Parameters:
externalId
- The external ID associated with the task set.If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't 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 isn't 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
The task definition that the task set is using.
- Parameters:
taskDefinition
- The task definition that the task set is using.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
computedDesiredCount
The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.- Parameters:
computedDesiredCount
- The computed desired count for the task set. This is calculated by multiplying the service'sdesiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingCount
The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.- Parameters:
pendingCount
- The number of tasks in the task set that are in thePENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runningCount
The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.- Parameters:
runningCount
- The number of tasks in the task set that are in theRUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The Unix timestamp for the time when the task set was created.
- Parameters:
createdAt
- The Unix timestamp for the time when the task set was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
The Unix timestamp for the time when the task set was last updated.
- Parameters:
updatedAt
- The Unix timestamp for the time when the task set was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
capacityProviderStrategy
TaskSet.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy that are associated with the task set.
- Parameters:
capacityProviderStrategy
- The capacity provider strategy that are associated with the task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
The capacity provider strategy that are associated with the task set.
- Parameters:
capacityProviderStrategy
- The capacity provider strategy that are associated with the task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
TaskSet.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy) The capacity provider strategy that are associated with the task set.
This is a convenience method that creates an instance of theCapacityProviderStrategyItem.Builder
avoiding the need to create one manually viaCapacityProviderStrategyItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocapacityProviderStrategy(List<CapacityProviderStrategyItem>)
.- Parameters:
capacityProviderStrategy
- a consumer that will call methods onCapacityProviderStrategyItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platformVersion
The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
- Parameters:
platformVersion
- The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. 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.
-
platformFamily
The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks in the set must have the same value.
- Parameters:
platformFamily
- The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.All tasks in the set must have the same value.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 method that creates an instance of theNetworkConfiguration.Builder
avoiding the need to create one manually viaNetworkConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkConfiguration(NetworkConfiguration)
.- Parameters:
networkConfiguration
- a consumer that will call methods onNetworkConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
loadBalancers
Details on a load balancer that are used with a task set.
- Parameters:
loadBalancers
- Details on a load balancer that are used with a task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loadBalancers
Details on a load balancer that are used with a task set.
- Parameters:
loadBalancers
- Details on a load balancer that are used with a task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loadBalancers
Details on a load balancer that are used with a task set.
This is a convenience method that creates an instance of theLoadBalancer.Builder
avoiding the need to create one manually viaLoadBalancer.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toloadBalancers(List<LoadBalancer>)
.- Parameters:
loadBalancers
- a consumer that will call methods onLoadBalancer.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceRegistries
The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
- Parameters:
serviceRegistries
- The details for the service discovery registries to assign to this task set. For more information, see Service discovery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRegistries
The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
- Parameters:
serviceRegistries
- The details for the service discovery registries to assign to this task set. For more information, see Service discovery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRegistries
The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
This is a convenience method that creates an instance of theServiceRegistry.Builder
avoiding the need to create one manually viaServiceRegistry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toserviceRegistries(List<ServiceRegistry>)
.- Parameters:
serviceRegistries
- a consumer that will call methods onServiceRegistry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scale
A floating-point percentage of your desired number of tasks to place and keep running in the task set.
- Parameters:
scale
- A floating-point percentage of your desired number of tasks to place and keep running in the task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scale
A floating-point percentage of your desired number of tasks to place and keep running in the task set.
This is a convenience method that creates an instance of theScale.Builder
avoiding the need to create one manually viaScale.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscale(Scale)
.- Parameters:
scale
- a consumer that will call methods onScale.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stabilityStatus
The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are 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 aren't met, the stability status returns
STABILIZING
.- Parameters:
stabilityStatus
- The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are inSTEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are 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 aren't met, the stability status returns
STABILIZING
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
stabilityStatus
The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are 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 aren't met, the stability status returns
STABILIZING
.- Parameters:
stabilityStatus
- The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are inSTEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are 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 aren't met, the stability status returns
STABILIZING
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
stabilityStatusAt
The Unix timestamp for the time when the task set stability status was retrieved.
- Parameters:
stabilityStatusAt
- The Unix timestamp for the time when the task set stability status was retrieved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
- Parameters:
tags
- The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
- Parameters:
tags
- The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-