Interface AwsEcsClusterDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsEcsClusterDetails

@Mutable
@NotThreadSafe
public static interface AwsEcsClusterDetails.Builder
extends SdkPojo, CopyableBuilder<AwsEcsClusterDetails.Builder,AwsEcsClusterDetails>

Method Summary

Modifier and Type	Method	Description
AwsEcsClusterDetails.Builder	activeServicesCount(Integer activeServicesCount)	The number of services that are running on the cluster in an ACTIVE state.
AwsEcsClusterDetails.Builder	capacityProviders(String... capacityProviders)	The short name of one or more capacity providers to associate with the cluster.
AwsEcsClusterDetails.Builder	capacityProviders(Collection<String> capacityProviders)	The short name of one or more capacity providers to associate with the cluster.
AwsEcsClusterDetails.Builder	clusterArn(String clusterArn)	The Amazon Resource Name (ARN) that identifies the cluster.
AwsEcsClusterDetails.Builder	clusterName(String clusterName)	A name that you use to identify your cluster.
AwsEcsClusterDetails.Builder	clusterSettings(Collection<AwsEcsClusterClusterSettingsDetails> clusterSettings)	The setting to use to create the cluster.
AwsEcsClusterDetails.Builder	clusterSettings(Consumer<AwsEcsClusterClusterSettingsDetails.Builder>... clusterSettings)	The setting to use to create the cluster.
AwsEcsClusterDetails.Builder	clusterSettings(AwsEcsClusterClusterSettingsDetails... clusterSettings)	The setting to use to create the cluster.
default AwsEcsClusterDetails.Builder	configuration(Consumer<AwsEcsClusterConfigurationDetails.Builder> configuration)	The run command configuration for the cluster.
AwsEcsClusterDetails.Builder	configuration(AwsEcsClusterConfigurationDetails configuration)	The run command configuration for the cluster.
AwsEcsClusterDetails.Builder	defaultCapacityProviderStrategy(Collection<AwsEcsClusterDefaultCapacityProviderStrategyDetails> defaultCapacityProviderStrategy)	The default capacity provider strategy for the cluster.
AwsEcsClusterDetails.Builder	defaultCapacityProviderStrategy(Consumer<AwsEcsClusterDefaultCapacityProviderStrategyDetails.Builder>... defaultCapacityProviderStrategy)	The default capacity provider strategy for the cluster.
AwsEcsClusterDetails.Builder	defaultCapacityProviderStrategy(AwsEcsClusterDefaultCapacityProviderStrategyDetails... defaultCapacityProviderStrategy)	The default capacity provider strategy for the cluster.
AwsEcsClusterDetails.Builder	registeredContainerInstancesCount(Integer registeredContainerInstancesCount)	The number of container instances registered into the cluster.
AwsEcsClusterDetails.Builder	runningTasksCount(Integer runningTasksCount)	The number of tasks in the cluster that are in the RUNNING state.
AwsEcsClusterDetails.Builder	status(String status)	The status of the cluster.

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 Details

clusterArn

AwsEcsClusterDetails.Builder clusterArn(String clusterArn)

The Amazon Resource Name (ARN) that identifies the cluster.

Parameters:

clusterArn - The Amazon Resource Name (ARN) that identifies the cluster.

Returns:

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

activeServicesCount

AwsEcsClusterDetails.Builder activeServicesCount(Integer activeServicesCount)

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

Parameters:

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

Returns:

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

capacityProviders

AwsEcsClusterDetails.Builder capacityProviders(Collection<String> capacityProviders)

The short name of one or more capacity providers to associate with the cluster.

Parameters:

capacityProviders - The short name of one or more capacity providers to associate with the cluster.

Returns:

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

capacityProviders

AwsEcsClusterDetails.Builder capacityProviders(String... capacityProviders)

The short name of one or more capacity providers to associate with the cluster.

Parameters:

capacityProviders - The short name of one or more capacity providers to associate with the cluster.

Returns:

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

clusterSettings

AwsEcsClusterDetails.Builder clusterSettings(Collection<AwsEcsClusterClusterSettingsDetails> clusterSettings)

The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

Parameters:

clusterSettings - The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

Returns:

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

clusterSettings

AwsEcsClusterDetails.Builder clusterSettings(AwsEcsClusterClusterSettingsDetails... clusterSettings)

The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

Parameters:

clusterSettings - The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

Returns:

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

clusterSettings

AwsEcsClusterDetails.Builder clusterSettings(Consumer<AwsEcsClusterClusterSettingsDetails.Builder>... clusterSettings)

The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterSettings(List<AwsEcsClusterClusterSettingsDetails>).

Parameters:

clusterSettings - a consumer that will call methods on AwsEcsClusterClusterSettingsDetails.Builder

Returns:

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

See Also:

• clusterSettings(java.util.Collection<AwsEcsClusterClusterSettingsDetails>)

configuration

AwsEcsClusterDetails.Builder configuration(AwsEcsClusterConfigurationDetails configuration)

The run command configuration for the cluster.

Parameters:

configuration - The run command configuration for the cluster.

Returns:

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

configuration

default AwsEcsClusterDetails.Builder configuration(Consumer<AwsEcsClusterConfigurationDetails.Builder> configuration)

The run command configuration for the cluster.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(AwsEcsClusterConfigurationDetails).

Parameters:

configuration - a consumer that will call methods on AwsEcsClusterConfigurationDetails.Builder

Returns:

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

See Also:

• configuration(AwsEcsClusterConfigurationDetails)

defaultCapacityProviderStrategy

AwsEcsClusterDetails.Builder defaultCapacityProviderStrategy(Collection<AwsEcsClusterDefaultCapacityProviderStrategyDetails> defaultCapacityProviderStrategy)

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

Parameters:

defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

Returns:

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

defaultCapacityProviderStrategy

AwsEcsClusterDetails.Builder defaultCapacityProviderStrategy(AwsEcsClusterDefaultCapacityProviderStrategyDetails... defaultCapacityProviderStrategy)

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

Parameters:

defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

Returns:

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

defaultCapacityProviderStrategy

AwsEcsClusterDetails.Builder defaultCapacityProviderStrategy(Consumer<AwsEcsClusterDefaultCapacityProviderStrategyDetails.Builder>... defaultCapacityProviderStrategy)

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultCapacityProviderStrategy(List<AwsEcsClusterDefaultCapacityProviderStrategyDetails>).

Parameters:

defaultCapacityProviderStrategy - a consumer that will call methods on AwsEcsClusterDefaultCapacityProviderStrategyDetails.Builder

Returns:

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

See Also:

• defaultCapacityProviderStrategy(java.util.Collection<AwsEcsClusterDefaultCapacityProviderStrategyDetails>)

clusterName

AwsEcsClusterDetails.Builder clusterName(String clusterName)

A name that you use to identify your cluster.

Parameters:

clusterName - A name that you use to identify your cluster.

Returns:

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

registeredContainerInstancesCount

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

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

status

AwsEcsClusterDetails.Builder status(String status)

The status of the cluster.

Parameters:

status - The status of the cluster.

Returns:

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