public static interface Cluster.Builder extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>
| 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 |
attachments(Attachment... attachments)
The resources attached to a cluster.
|
Cluster.Builder |
attachments(Collection<Attachment> attachments)
The resources attached to a cluster.
|
Cluster.Builder |
attachments(Consumer<Attachment.Builder>... attachments)
The resources attached to a cluster.
|
Cluster.Builder |
attachmentsStatus(String attachmentsStatus)
The status of the capacity providers associated with the cluster.
|
Cluster.Builder |
capacityProviders(Collection<String> capacityProviders)
The capacity providers associated with the cluster.
|
Cluster.Builder |
capacityProviders(String... capacityProviders)
The capacity providers associated with the cluster.
|
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 |
configuration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
|
default Cluster.Builder |
configuration(Consumer<ClusterConfiguration.Builder> configuration)
The execute command configuration for the cluster.
|
Cluster.Builder |
defaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)
The default capacity provider strategy for the cluster.
|
Cluster.Builder |
defaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The default capacity provider strategy for the cluster.
|
Cluster.Builder |
defaultCapacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... defaultCapacityProviderStrategy)
The default capacity provider strategy for the 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 |
serviceConnectDefaults(ClusterServiceConnectDefaults serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace.
|
default Cluster.Builder |
serviceConnectDefaults(Consumer<ClusterServiceConnectDefaults.Builder> serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace.
|
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.
|
Cluster.Builder |
statistics(Consumer<KeyValuePair.Builder>... statistics)
Additional information about your clusters that are separated by launch type.
|
Cluster.Builder |
statistics(KeyValuePair... statistics)
Additional information about your clusters that are separated by launch type.
|
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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildCluster.Builder clusterArn(String clusterArn)
The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format,
see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.Cluster.Builder clusterName(String clusterName)
A user-generated string that you use to identify your cluster.
clusterName - A user-generated string that you use to identify your cluster.Cluster.Builder configuration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
configuration - The execute command configuration for the cluster.default Cluster.Builder configuration(Consumer<ClusterConfiguration.Builder> configuration)
The execute command configuration for the cluster.
This is a convenience method that creates an instance of theClusterConfiguration.Builder avoiding
the need to create one manually via ClusterConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to configuration(ClusterConfiguration).
configuration - a consumer that will call methods on ClusterConfiguration.Builderconfiguration(ClusterConfiguration)Cluster.Builder status(String status)
The status of the cluster. The following are the possible states that are returned.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your
account for a period of time. However, this behavior is subject to change in the future. We don't recommend
that you rely on INACTIVE clusters persisting.
status - The status of the cluster. The following are the possible states that are returned.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in
your account for a period of time. However, this behavior is subject to change in the future. We don't
recommend that you rely on INACTIVE clusters persisting.
Cluster.Builder registeredContainerInstancesCount(Integer registeredContainerInstancesCount)
The number of container instances registered into the cluster. This includes container instances in both
ACTIVE and DRAINING status.
registeredContainerInstancesCount - The number of container instances registered into the cluster. This includes container instances in
both ACTIVE and DRAINING status.Cluster.Builder runningTasksCount(Integer runningTasksCount)
The number of tasks in the cluster that are in the RUNNING state.
runningTasksCount - The number of tasks in the cluster that are in the RUNNING state.Cluster.Builder pendingTasksCount(Integer pendingTasksCount)
The number of tasks in the cluster that are in the PENDING state.
pendingTasksCount - The number of tasks in the cluster that are in the PENDING state.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.
activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view
these services with ListServices.Cluster.Builder statistics(Collection<KeyValuePair> statistics)
Additional information about your clusters that are separated by launch type. They include the following:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
statistics - Additional information about your clusters that are separated by launch type. They include the
following:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
Cluster.Builder statistics(KeyValuePair... statistics)
Additional information about your clusters that are separated by launch type. They include the following:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
statistics - Additional information about your clusters that are separated by launch type. They include the
following:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
Cluster.Builder statistics(Consumer<KeyValuePair.Builder>... statistics)
Additional information about your clusters that are separated by launch type. They include the following:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
KeyValuePair.Builder avoiding the need to create one
manually via KeyValuePair.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #statistics(List.
statistics - a consumer that will call methods on
KeyValuePair.Builder#statistics(java.util.Collection) 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. 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.
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. 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.
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. 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.
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. 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.
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. 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.
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.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) 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.
settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is
enabled or disabled for a cluster.Cluster.Builder settings(ClusterSetting... settings)
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is
enabled or disabled for a cluster.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 method that creates an instance of theClusterSetting.Builder avoiding the need to create one
manually via ClusterSetting.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #settings(List.
settings - a consumer that will call methods on
ClusterSetting.Builder#settings(java.util.Collection) Cluster.Builder capacityProviders(Collection<String> capacityProviders)
The capacity providers associated with the cluster.
capacityProviders - The capacity providers associated with the cluster.Cluster.Builder capacityProviders(String... capacityProviders)
The capacity providers associated with the cluster.
capacityProviders - The capacity providers associated with the cluster.Cluster.Builder defaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. When services or tasks are run in the cluster
with no launch type or capacity provider strategy specified, the default capacity provider strategy is
used.Cluster.Builder defaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. When services or tasks are run in the cluster
with no launch type or capacity provider strategy specified, the default capacity provider strategy is
used.Cluster.Builder defaultCapacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... defaultCapacityProviderStrategy)
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
This is a convenience method that creates an instance of theCapacityProviderStrategyItem.Builder avoiding the need to
create one manually via
CapacityProviderStrategyItem.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #defaultCapacityProviderStrategy(List.
defaultCapacityProviderStrategy - a consumer that will call methods on
CapacityProviderStrategyItem.Builder#defaultCapacityProviderStrategy(java.util.Collection) Cluster.Builder attachments(Collection<Attachment> attachments)
The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
attachments - The resources attached to a cluster. When using a capacity provider with a cluster, the capacity
provider and associated resources are returned as cluster attachments.Cluster.Builder attachments(Attachment... attachments)
The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
attachments - The resources attached to a cluster. When using a capacity provider with a cluster, the capacity
provider and associated resources are returned as cluster attachments.Cluster.Builder attachments(Consumer<Attachment.Builder>... attachments)
The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
This is a convenience method that creates an instance of theAttachment.Builder avoiding the need to create one manually
via Attachment.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #attachments(List.
attachments - a consumer that will call methods on
Attachment.Builder#attachments(java.util.Collection) Cluster.Builder attachmentsStatus(String attachmentsStatus)
The status of the capacity providers associated with the cluster. The following are the states that are returned.
The available capacity providers for the cluster are updating.
The capacity providers have successfully updated.
The capacity provider updates failed.
attachmentsStatus - The status of the capacity providers associated with the cluster. The following are the states that
are returned.
The available capacity providers for the cluster are updating.
The capacity providers have successfully updated.
The capacity provider updates failed.
Cluster.Builder serviceConnectDefaults(ClusterServiceConnectDefaults serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace. After you set a default Service Connect
namespace, any new services with Service Connect turned on that are created in the cluster are added as
client services in the namespace. This setting only applies to new services that set the enabled
parameter to true in the ServiceConnectConfiguration. You can set the namespace of
each service individually in the ServiceConnectConfiguration to override this default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
serviceConnectDefaults - Use this parameter to set a default Service Connect namespace. After you set a default Service Connect
namespace, any new services with Service Connect turned on that are created in the cluster are added
as client services in the namespace. This setting only applies to new services that set the
enabled parameter to true in the ServiceConnectConfiguration.
You can set the namespace of each service individually in the ServiceConnectConfiguration
to override this default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
default Cluster.Builder serviceConnectDefaults(Consumer<ClusterServiceConnectDefaults.Builder> serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace. After you set a default Service Connect
namespace, any new services with Service Connect turned on that are created in the cluster are added as
client services in the namespace. This setting only applies to new services that set the enabled
parameter to true in the ServiceConnectConfiguration. You can set the namespace of
each service individually in the ServiceConnectConfiguration to override this default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
This is a convenience method that creates an instance of theClusterServiceConnectDefaults.Builder
avoiding the need to create one manually via ClusterServiceConnectDefaults.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to serviceConnectDefaults(ClusterServiceConnectDefaults).
serviceConnectDefaults - a consumer that will call methods on ClusterServiceConnectDefaults.BuilderserviceConnectDefaults(ClusterServiceConnectDefaults)Copyright © 2023. All rights reserved.