Package software.amazon.awssdk.services.ecs.model

Class UpdateClusterRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateClusterRequest.Builder	builder()
String	cluster()	The name of the cluster to modify the settings for.
ClusterConfiguration	configuration()	The execute command configuration for the cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSettings()	For responses, this returns true if the service returned a value for the Settings property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateClusterRequest.Builder>	serializableBuilderClass()
ClusterServiceConnectDefaultsRequest	serviceConnectDefaults()	Use this parameter to set a default Service Connect namespace.
List<ClusterSetting>	settings()	The cluster settings for your cluster.
UpdateClusterRequest.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 name of the cluster to modify the settings for.

Returns:

The name of the cluster to modify the settings for.

hasSettings

public final boolean hasSettings()

For responses, this returns true if the service returned a value for the Settings property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

settings

public final List<ClusterSetting> settings()

The cluster settings for your cluster.

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 hasSettings() method.

Returns:

The cluster settings for your cluster.

configuration

public final ClusterConfiguration configuration()

The execute command configuration for the cluster.

Returns:

The execute command configuration for the cluster.

serviceConnectDefaults

public final ClusterServiceConnectDefaultsRequest 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.

Returns:

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.

toBuilder

public UpdateClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static UpdateClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateClusterRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo