Interface ECSTaskSet.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ECSTaskSet.Builder,ECSTaskSet>,SdkBuilder<ECSTaskSet.Builder,ECSTaskSet>,SdkPojo
- Enclosing class:
- ECSTaskSet
public static interface ECSTaskSet.Builder extends SdkPojo, CopyableBuilder<ECSTaskSet.Builder,ECSTaskSet>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ECSTaskSet.BuilderdesiredCount(Long desiredCount)The number of tasks in a task set.ECSTaskSet.Builderidentifer(String identifer)A unique ID of anECSTaskSet.ECSTaskSet.BuilderpendingCount(Long pendingCount)The number of tasks in the task set that are in thePENDINGstatus during an Amazon ECS deployment.ECSTaskSet.BuilderrunningCount(Long runningCount)The number of tasks in the task set that are in theRUNNINGstatus during an Amazon ECS deployment.ECSTaskSet.Builderstatus(String status)The status of the task set.default ECSTaskSet.BuildertargetGroup(Consumer<TargetGroupInfo.Builder> targetGroup)The target group associated with the task set.ECSTaskSet.BuildertargetGroup(TargetGroupInfo targetGroup)The target group associated with the task set.ECSTaskSet.BuildertaskSetLabel(String taskSetLabel)A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).ECSTaskSet.BuildertaskSetLabel(TargetLabel taskSetLabel)A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).ECSTaskSet.BuildertrafficWeight(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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
identifer
ECSTaskSet.Builder identifer(String 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
ECSTaskSet.Builder desiredCount(Long 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
ECSTaskSet.Builder pendingCount(Long pendingCount)
The number of tasks in the task set that are in the
PENDINGstatus during an Amazon ECS deployment. A task in thePENDINGstate is preparing to enter theRUNNINGstate. A task set enters thePENDINGstatus when it launches for the first time, or when it is restarted after being in theSTOPPEDstate.- Parameters:
pendingCount- The number of tasks in the task set that are in thePENDINGstatus during an Amazon ECS deployment. A task in thePENDINGstate is preparing to enter theRUNNINGstate. A task set enters thePENDINGstatus when it launches for the first time, or when it is restarted after being in theSTOPPEDstate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runningCount
ECSTaskSet.Builder runningCount(Long runningCount)
The number of tasks in the task set that are in the
RUNNINGstatus during an Amazon ECS deployment. A task in theRUNNINGstate is running and ready for use.- Parameters:
runningCount- The number of tasks in the task set that are in theRUNNINGstatus during an Amazon ECS deployment. A task in theRUNNINGstate is running and ready for use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
ECSTaskSet.Builder status(String 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
ECSTaskSet.Builder trafficWeight(Double 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
ECSTaskSet.Builder targetGroup(TargetGroupInfo 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
default ECSTaskSet.Builder targetGroup(Consumer<TargetGroupInfo.Builder> 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.Builderavoiding the need to create one manually viaTargetGroupInfo.builder().When the
Consumercompletes,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:
targetGroup(TargetGroupInfo)
-
taskSetLabel
ECSTaskSet.Builder taskSetLabel(String 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:
TargetLabel,TargetLabel
-
taskSetLabel
ECSTaskSet.Builder taskSetLabel(TargetLabel 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:
TargetLabel,TargetLabel
-
-