AmazonECSClient.UpdateCluster Method (UpdateClusterRequest)

Updates the cluster.

Note:

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

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

Syntax

public virtual UpdateClusterResponse UpdateCluster(
         UpdateClusterRequest request
)

Parameters

request: Type: Amazon.ECS.Model.UpdateClusterRequest

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

Return Value

Type: UpdateClusterResponse

The response from the UpdateCluster 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.
NamespaceNotFoundException	The specified namespace wasn't found.
ServerException	These errors are usually caused by a server issue.

Examples

This example turns on enhanced containerInsights in an existing cluster.

To update a cluster's observability settings.


var client = new AmazonECSClient();
var response = client.UpdateCluster(new UpdateClusterRequest 
{
    Cluster = "ECS-project-update-cluster",
    Settings = new List<ClusterSetting> {
        new ClusterSetting {
            Name = "containerInsights",
            Value = "enhanced"
        }
    }
});

Cluster cluster = response.Cluster;

This example sets a default Service Connect namespace.

To update a cluster's Service Connect defaults.


var client = new AmazonECSClient();
var response = client.UpdateCluster(new UpdateClusterRequest 
{
    Cluster = "ECS-project-update-cluster",
    ServiceConnectDefaults = new ClusterServiceConnectDefaultsRequest { Namespace = "test" }
});

Cluster cluster = response.Cluster;

Version Information

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

AmazonECSClient.UpdateCluster (UpdateClusterRequest)

Method