software.amazon.awssdk.services.ecs.model

Interface Cluster.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo

Enclosing class:

Cluster

public static interface Cluster.Builder
extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

Method Summary

Modifier and Type	Method and Description
Cluster.Builder	activeServicesCount(Integer activeServicesCount) The number of services that are running on the cluster in an ACTIVE state.
Cluster.Builder	clusterArn(String clusterArn) The Amazon Resource Name (ARN) that identifies the cluster.
Cluster.Builder	clusterName(String clusterName) A user-generated string that you use to identify your cluster.
Cluster.Builder	pendingTasksCount(Integer pendingTasksCount) The number of tasks in the cluster that are in the PENDING state.
Cluster.Builder	registeredContainerInstancesCount(Integer registeredContainerInstancesCount) The number of container instances registered into the cluster.
Cluster.Builder	runningTasksCount(Integer runningTasksCount) The number of tasks in the cluster that are in the RUNNING state.
Cluster.Builder	settings(ClusterSetting... settings) The settings for the cluster.
Cluster.Builder	settings(Collection<ClusterSetting> settings) The settings for the cluster.
Cluster.Builder	settings(Consumer<ClusterSetting.Builder>... settings) The settings for the cluster.
Cluster.Builder	statistics(Collection<KeyValuePair> statistics) Additional information about your clusters that are separated by launch type, including:
Cluster.Builder	statistics(Consumer<KeyValuePair.Builder>... statistics) Additional information about your clusters that are separated by launch type, including:
Cluster.Builder	statistics(KeyValuePair... statistics) Additional information about your clusters that are separated by launch type, including:
Cluster.Builder	status(String status) The status of the cluster.
Cluster.Builder	tags(Collection<Tag> tags) The metadata that you apply to the cluster to help you categorize and organize them.
Cluster.Builder	tags(Consumer<Tag.Builder>... tags) The metadata that you apply to the cluster to help you categorize and organize them.
Cluster.Builder	tags(Tag... tags) The metadata that you apply to the cluster to help you categorize and organize them.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clusterArn

Cluster.Builder clusterArn(String clusterArn)

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Parameters:

clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterName

Cluster.Builder clusterName(String clusterName)

A user-generated string that you use to identify your cluster.

Parameters:

clusterName - A user-generated string that you use to identify your cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

Cluster.Builder status(String status)

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Parameters:

status - The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Returns:

Returns a reference to this object so that method calls can be chained together.

registeredContainerInstancesCount

Cluster.Builder registeredContainerInstancesCount(Integer registeredContainerInstancesCount)

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Parameters:

registeredContainerInstancesCount - The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Returns:

Returns a reference to this object so that method calls can be chained together.

runningTasksCount

Cluster.Builder runningTasksCount(Integer runningTasksCount)

The number of tasks in the cluster that are in the RUNNING state.

Parameters:

runningTasksCount - The number of tasks in the cluster that are in the RUNNING state.

Returns:

Returns a reference to this object so that method calls can be chained together.

pendingTasksCount

Cluster.Builder pendingTasksCount(Integer pendingTasksCount)

The number of tasks in the cluster that are in the PENDING state.

Parameters:

pendingTasksCount - The number of tasks in the cluster that are in the PENDING state.

Returns:

Returns a reference to this object so that method calls can be chained together.

activeServicesCount

Cluster.Builder activeServicesCount(Integer activeServicesCount)

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Parameters:

activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

Cluster.Builder statistics(Collection<KeyValuePair> statistics)

Additional information about your clusters that are separated by launch type, including:

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

Parameters:

statistics - Additional information about your clusters that are separated by launch type, including:

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

Cluster.Builder statistics(KeyValuePair... statistics)

Additional information about your clusters that are separated by launch type, including:

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

Parameters:

statistics - Additional information about your clusters that are separated by launch type, including:

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

Cluster.Builder statistics(Consumer<KeyValuePair.Builder>... statistics)

Additional information about your clusters that are separated by launch type, including:

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

This is a convenience that creates an instance of the 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 #statistics(List).

Parameters:

statistics - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#statistics(List)

tags

Cluster.Builder tags(Collection<Tag> tags)

The metadata that you apply to the cluster 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.

Parameters:

tags - The metadata that you apply to the cluster 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Cluster.Builder tags(Tag... tags)

The metadata that you apply to the cluster 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.

Parameters:

tags - The metadata that you apply to the cluster 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Cluster.Builder tags(Consumer<Tag.Builder>... tags)

The metadata that you apply to the cluster 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.

This is a convenience that creates an instance of the 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).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

settings

Cluster.Builder settings(Collection<ClusterSetting> settings)

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Parameters:

settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

Cluster.Builder settings(ClusterSetting... settings)

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Parameters:

settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

Cluster.Builder settings(Consumer<ClusterSetting.Builder>... settings)

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

This is a convenience that creates an instance of the 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 #settings(List).

Parameters:

settings - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#settings(List)