AmazonECSClient.UpdateClusterSettings Method (UpdateClusterSettingsRequest)

Modifies the settings to use for a cluster.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateClusterSettingsAsync.

Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public virtual UpdateClusterSettingsResponse UpdateClusterSettings(
         UpdateClusterSettingsRequest request
)

Parameters

request: Type: Amazon.ECS.Model.UpdateClusterSettingsRequest

Container for the necessary parameters to execute the UpdateClusterSettings service method.

Return Value

Type: UpdateClusterSettingsResponse

The response from the UpdateClusterSettings service method, as returned by ECS.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
ClusterNotFoundException	The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.

Examples

This example enables CloudWatch Container Insights for the default cluster.

To update a cluster's settings


var client = new AmazonECSClient();
var response = client.UpdateClusterSettings(new UpdateClusterSettingsRequest 
{
    Cluster = "default",
    Settings = new List<ClusterSetting> {
        new ClusterSetting {
            Name = "containerInsights",
            Value = "enabled"
        }
    }
});

Cluster cluster = response.Cluster;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.UpdateClusterSettings (UpdateClusterSettingsRequest)

Method