Interface ECSTaskSet.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ECSTaskSet.Builder,
,ECSTaskSet> SdkBuilder<ECSTaskSet.Builder,
,ECSTaskSet> SdkPojo
- Enclosing class:
ECSTaskSet
-
Method Summary
Modifier and TypeMethodDescriptiondesiredCount
(Long desiredCount) The number of tasks in a task set.A unique ID of anECSTaskSet
.pendingCount
(Long pendingCount) The number of tasks in the task set that are in thePENDING
status during an Amazon ECS deployment.runningCount
(Long runningCount) The number of tasks in the task set that are in theRUNNING
status during an Amazon ECS deployment.The status of the task set.default ECSTaskSet.Builder
targetGroup
(Consumer<TargetGroupInfo.Builder> targetGroup) The target group associated with the task set.targetGroup
(TargetGroupInfo targetGroup) The target group associated with the task set.taskSetLabel
(String taskSetLabel) A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).taskSetLabel
(TargetLabel taskSetLabel) A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).trafficWeight
(Double trafficWeight) The percentage of traffic served by this task set.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
-
identifer
A unique ID of an
ECSTaskSet
.- Parameters:
identifer
- A unique ID of anECSTaskSet
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
desiredCount
The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.
- Parameters:
desiredCount
- The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.- 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 an Amazon ECS 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 is restarted after being in theSTOPPED
state.- Parameters:
pendingCount
- The number of tasks in the task set that are in thePENDING
status during an Amazon ECS 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 is 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 an Amazon ECS 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 an Amazon ECS 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.
-
status
The status of the task set. There are three valid task set statuses:
-
PRIMARY
: Indicates the task set is serving production traffic. -
ACTIVE
: Indicates the task set is not serving production traffic. -
DRAINING
: Indicates 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. There are three valid task set statuses:-
PRIMARY
: Indicates the task set is serving production traffic. -
ACTIVE
: Indicates the task set is not serving production traffic. -
DRAINING
: Indicates 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.
-
-
trafficWeight
The percentage of traffic served by this task set.
- Parameters:
trafficWeight
- The percentage of traffic served by this task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetGroup
The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
- Parameters:
targetGroup
- The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetGroup
The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
This is a convenience method that creates an instance of theTargetGroupInfo.Builder
avoiding the need to create one manually viaTargetGroupInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetGroup(TargetGroupInfo)
.- Parameters:
targetGroup
- a consumer that will call methods onTargetGroupInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskSetLabel
A label that identifies whether the ECS task set is an original target (
BLUE
) or a replacement target (GREEN
).- Parameters:
taskSetLabel
- A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskSetLabel
A label that identifies whether the ECS task set is an original target (
BLUE
) or a replacement target (GREEN
).- Parameters:
taskSetLabel
- A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-