Skip to content

ECS  >  Operations  >  update_cluster

update_cluster

Operation

update_cluster async 

update_cluster(input: UpdateClusterInput, plugins: list[Plugin] | None = None) -> UpdateClusterOutput

Updates the cluster.

Parameters:

Name Type Description Default
input UpdateClusterInput

An instance of UpdateClusterInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateClusterOutput

An instance of UpdateClusterOutput.

Input

UpdateClusterInput dataclass

Bases: _SerdeShape

Dataclass for UpdateClusterInput structure.

Attributes

cluster class-attribute instance-attribute 
cluster: str | None = ...

The name of the cluster to modify the settings for.

configuration class-attribute instance-attribute 
configuration: ClusterConfiguration | None = ...

The execute command configuration for the cluster.

service_connect_defaults class-attribute instance-attribute 
service_connect_defaults: ClusterServiceConnectDefaultsRequest | None = ...

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.

settings class-attribute instance-attribute 
settings: list[ClusterSetting] | None = ...

The cluster settings for your cluster.

Output

UpdateClusterOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateClusterOutput structure.

Attributes

cluster class-attribute instance-attribute 
cluster: Cluster | None = ...

Details about the cluster.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.