Skip to content

ECS  >  Operations  >  update_cluster_settings

update_cluster_settings

Operation

update_cluster_settings async

update_cluster_settings(input: UpdateClusterSettingsInput, plugins: list[Plugin] | None = None) -> UpdateClusterSettingsOutput

Modifies the settings to use for a cluster.

Parameters:

Name Type Description Default
input UpdateClusterSettingsInput

An instance of UpdateClusterSettingsInput.

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
UpdateClusterSettingsOutput

An instance of UpdateClusterSettingsOutput.

Input

UpdateClusterSettingsInput dataclass

Bases: _SerdeShape

Dataclass for UpdateClusterSettingsInput structure.

Attributes

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

The name of the cluster to modify the settings for.

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

The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Warning

Currently, if you delete an existing cluster that does not have Container Insights turned on, and then create a new cluster with the same name with Container Insights tuned on, Container Insights will not actually be turned on. If you want to preserve the same name for your existing cluster and turn on Container Insights, you must wait 7 days before you can re-create it.

Output

UpdateClusterSettingsOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateClusterSettingsOutput 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.