@Generated(value="software.amazon.awssdk:codegen") public final class PutClusterCapacityProvidersRequest extends EcsRequest implements ToCopyableBuilder<PutClusterCapacityProvidersRequest.Builder,PutClusterCapacityProvidersRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutClusterCapacityProvidersRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the CapacityProviders property.
|
boolean |
hasDefaultCapacityProviderStrategy()
For responses, this returns true if the service returned a value for the DefaultCapacityProviderStrategy
property.
|
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutClusterCapacityProvidersRequest.Builder> |
serializableBuilderClass() |
PutClusterCapacityProvidersRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String cluster()
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
public final boolean hasCapacityProviders()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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 Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity
providers. The 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCapacityProviders() method.
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 Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be
associated with a cluster to be used.
public final boolean hasDefaultCapacityProviderStrategy()
isEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may
need to differentiate between the service returning nothing (or null) and the service returning an empty
collection or map. For requests, this returns true if a value for the property was specified in the request
builder, and false if a value was not specified.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 Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity
providers. The 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDefaultCapacityProviderStrategy()
method.
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 Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be
associated with a cluster to be used.
public PutClusterCapacityProvidersRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<PutClusterCapacityProvidersRequest.Builder,PutClusterCapacityProvidersRequest>toBuilder in class EcsRequestpublic static PutClusterCapacityProvidersRequest.Builder builder()
public static Class<? extends PutClusterCapacityProvidersRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.