Package software.amazon.awssdk.services.ecs.model

Interface TaskSet.Builder

    • 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.

      • serviceArn

        TaskSet.Builder serviceArn​(String 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

        TaskSet.Builder clusterArn​(String 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

        TaskSet.Builder startedBy​(String startedBy)

        The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

        Parameters:
        startedBy - The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalId

        TaskSet.Builder externalId​(String 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 the ECS_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 the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

        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 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

        TaskSet.Builder taskDefinition​(String 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

        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.

        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. 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

        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's 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's 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 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

        TaskSet.Builder updatedAt​(Instant 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

        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

      • 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

        TaskSet.Builder capacityProviderStrategy​(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.

      • platformVersion

        TaskSet.Builder platformVersion​(String 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

        TaskSet.Builder platformFamily​(String 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

        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.

      • loadBalancers

        TaskSet.Builder loadBalancers​(Collection<LoadBalancer> 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

        TaskSet.Builder loadBalancers​(LoadBalancer... 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.

      • serviceRegistries

        TaskSet.Builder serviceRegistries​(Collection<ServiceRegistry> 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

        TaskSet.Builder serviceRegistries​(ServiceRegistry... 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.

      • scale

        TaskSet.Builder scale​(Scale 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.

      • stabilityStatus

        TaskSet.Builder stabilityStatus​(String 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 the computedDesiredCount.

        • The pendingCount is 0.

        • 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 in STEADY_STATE:

        • The task runningCount is equal to the computedDesiredCount.

        • The pendingCount is 0.

        • 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, StabilityStatus

      • stabilityStatus

        TaskSet.Builder stabilityStatus​(StabilityStatus 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 the computedDesiredCount.

        • The pendingCount is 0.

        • 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 in STEADY_STATE:

        • The task runningCount is equal to the computedDesiredCount.

        • The pendingCount is 0.

        • 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, StabilityStatus

      • stabilityStatusAt

        TaskSet.Builder stabilityStatusAt​(Instant 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

        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. 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

        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. 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

        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. 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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)