software.amazon.awssdk.services.ecs.model

Class PutClusterCapacityProvidersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.PutClusterCapacityProvidersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutClusterCapacityProvidersRequest.Builder,PutClusterCapacityProvidersRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutClusterCapacityProvidersRequest
extends EcsRequest
implements ToCopyableBuilder<PutClusterCapacityProvidersRequest.Builder,PutClusterCapacityProvidersRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutClusterCapacityProvidersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutClusterCapacityProvidersRequest.Builder	builder()
List<String>	capacityProviders() The name of one or more capacity providers to associate with the cluster.
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for.
List<CapacityProviderStrategyItem>	defaultCapacityProviderStrategy() The capacity provider strategy to use by default for the cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCapacityProviders() Returns true if the CapacityProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasDefaultCapacityProviderStrategy() Returns true if the DefaultCapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PutClusterCapacityProvidersRequest.Builder>	serializableBuilderClass()
PutClusterCapacityProvidersRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

cluster

public final String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

hasCapacityProviders

public final boolean hasCapacityProviders()

Returns true if the CapacityProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

capacityProviders

public final List<String> capacityProviders()

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

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCapacityProviders() to see if a value was sent in this field.

Returns:

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

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

hasDefaultCapacityProviderStrategy

public final boolean hasDefaultCapacityProviderStrategy()

Returns true if the DefaultCapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

defaultCapacityProviderStrategy

public final List<CapacityProviderStrategyItem> defaultCapacityProviderStrategy()

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDefaultCapacityProviderStrategy() to see if a value was sent in this field.

Returns:

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

toBuilder

public PutClusterCapacityProvidersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutClusterCapacityProvidersRequest.Builder,PutClusterCapacityProvidersRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static PutClusterCapacityProvidersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutClusterCapacityProvidersRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo