public static interface TaskSet.Builder extends SdkPojo, CopyableBuilder<TaskSet.Builder,TaskSet>
| Modifier and Type | Method and Description |
|---|---|
TaskSet.Builder |
capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy associated with the task set.
|
TaskSet.Builder |
capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy associated with the task set.
|
TaskSet.Builder |
capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
The capacity provider strategy associated with the task set.
|
TaskSet.Builder |
clusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
|
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 external ID associated with the task set.
|
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 AWS Fargate 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 task set.
|
TaskSet.Builder |
scale(Scale scale)
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
|
TaskSet.Builder |
serviceArn(String serviceArn)
The Amazon Resource Name (ARN) of the service the task set exists in.
|
TaskSet.Builder |
serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
TaskSet.Builder |
serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
TaskSet.Builder |
serviceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
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 |
tags(Collection<Tag> tags)
The metadata that you apply to the task set to help you categorize and organize them.
|
TaskSet.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task set to help you categorize and organize them.
|
TaskSet.Builder |
tags(Tag... tags)
The metadata that you apply to the task set to help you categorize and organize them.
|
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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildTaskSet.Builder id(String id)
The ID of the task set.
id - The ID of the task set.TaskSet.Builder taskSetArn(String taskSetArn)
The Amazon Resource Name (ARN) of the task set.
taskSetArn - The Amazon Resource Name (ARN) of the task set.TaskSet.Builder serviceArn(String serviceArn)
The Amazon Resource Name (ARN) of the service the task set exists in.
serviceArn - The Amazon Resource Name (ARN) of the service the task set exists in.TaskSet.Builder clusterArn(String clusterArn)
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
clusterArn - The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.TaskSet.Builder startedBy(String startedBy)
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the
startedBy parameter is CODE_DEPLOY. For a task set created for an external
deployment, the startedBy field isn't used.
startedBy - The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy
deployment, the startedBy parameter is CODE_DEPLOY. For a task set created
for an external deployment, the startedBy field isn't used.TaskSet.Builder externalId(String externalId)
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the
AWS 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 the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
externalId - The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter
contains the AWS 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 the ECS_TASK_SET_EXTERNAL_ID AWS
Cloud Map attribute.
TaskSet.Builder status(String status)
The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
status - The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
TaskSet.Builder taskDefinition(String taskDefinition)
The task definition the task set is using.
taskDefinition - The task definition the task set is using.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. The result is always rounded up.
For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
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. The result is always
rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.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.
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.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.
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.TaskSet.Builder createdAt(Instant createdAt)
The Unix timestamp for when the task set was created.
createdAt - The Unix timestamp for when the task set was created.TaskSet.Builder updatedAt(Instant updatedAt)
The Unix timestamp for when the task set was last updated.
updatedAt - The Unix timestamp for when the task set was last updated.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.
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.LaunchType,
LaunchTypeTaskSet.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.
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.LaunchType,
LaunchTypeTaskSet.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy associated with the task set.
capacityProviderStrategy - The capacity provider strategy associated with the task set.TaskSet.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy associated with the task set.
capacityProviderStrategy - The capacity provider strategy associated with the task set.TaskSet.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
The capacity provider strategy associated with the task set.
This is a convenience that creates an instance of theList.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 #capacityProviderStrategy(List)
.capacityProviderStrategy - a consumer that will call methods on List.Builder #capacityProviderStrategy(List) TaskSet.Builder platformVersion(String platformVersion)
The AWS Fargate platform version on which the tasks in the task set are running. A platform version is only specified for tasks run on AWS Fargate. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformVersion - The AWS Fargate platform version on which the tasks in the task set are running. A platform version is
only specified for tasks run on AWS Fargate. For more information, see AWS Fargate
platform versions in the Amazon Elastic Container Service Developer Guide.TaskSet.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the task set.
networkConfiguration - The network configuration for the task set.default TaskSet.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the task set.
This is a convenience that creates an instance of theNetworkConfiguration.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).networkConfiguration - a consumer that will call methods on NetworkConfiguration.BuildernetworkConfiguration(NetworkConfiguration)TaskSet.Builder loadBalancers(Collection<LoadBalancer> loadBalancers)
Details on a load balancer that is used with a task set.
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.
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.
This is a convenience that creates an instance of theList.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) .loadBalancers - a consumer that will call methods on List.Builder #loadBalancers(List) TaskSet.Builder serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
serviceRegistries - The details of the service discovery registries to assign to this task set. For more information, see
Service
discovery.TaskSet.Builder serviceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
serviceRegistries - The details of the service discovery registries to assign to this task set. For more information, see
Service
discovery.TaskSet.Builder serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
This is a convenience that creates an instance of theList.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 #serviceRegistries(List) .serviceRegistries - a consumer that will call methods on List.Builder #serviceRegistries(List) TaskSet.Builder scale(Scale scale)
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set.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 task set.
This is a convenience that creates an instance of theScale.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).scale - a consumer that will call methods on Scale.Builderscale(Scale)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.
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.
StabilityStatus,
StabilityStatusTaskSet.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.
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.
StabilityStatus,
StabilityStatusTaskSet.Builder stabilityStatusAt(Instant stabilityStatusAt)
The Unix timestamp for when the task set stability status was retrieved.
stabilityStatusAt - The Unix timestamp for when the task set stability status was retrieved.TaskSet.Builder tags(Collection<Tag> 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, both of which you define.
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 AWS 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.
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, both of which you define.
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 AWS 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.
TaskSet.Builder tags(Tag... 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, both of which you define.
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 AWS 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.
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, both of which you define.
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 AWS 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.
TaskSet.Builder tags(Consumer<Tag.Builder>... 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, both of which you define.
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 AWS 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.
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 #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List)