update_cluster_settings¶
Operation¶
update_cluster_settings
¶
update_cluster_settings(request: UpdateClusterSettingsInput | UpdateClusterSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateClusterSettingsInputDict]) -> UpdateClusterSettingsOutput
Modifies the settings to use for a cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateClusterSettingsInput | UpdateClusterSettingsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateClusterSettingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateClusterSettingsOutput
|
An instance of |
update_cluster_settings
async
¶
update_cluster_settings(request: UpdateClusterSettingsInput | UpdateClusterSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateClusterSettingsInputDict]) -> UpdateClusterSettingsOutput
Modifies the settings to use for a cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateClusterSettingsInput | UpdateClusterSettingsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateClusterSettingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateClusterSettingsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateClusterSettingsInputDict
¶
Bases: TypedDict
Dictionary form of UpdateClusterSettingsInput.
Attributes¶
cluster
instance-attribute
¶
The name of the cluster to modify the settings for.
settings
instance-attribute
¶
settings: Required[Sequence[ClusterSetting | ClusterSettingDict]]
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.
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
¶
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.