IAmazonECS.DeleteCluster Method (DeleteClusterRequest)

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Note:

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

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

Syntax

public abstract DeleteClusterResponse DeleteCluster(
         DeleteClusterRequest request
)

Parameters

request: Type: Amazon.ECS.Model.DeleteClusterRequest

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

Return Value

Type: DeleteClusterResponse

The response from the DeleteCluster 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.
ClusterContainsContainerInstancesException	You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
ClusterContainsServicesException	You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.
ClusterContainsTasksException	You can't delete a cluster that has active tasks.
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.
ServerException	These errors are usually caused by a server issue.
UpdateInProgressException	There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

Examples

This example deletes an empty cluster in your default region.

To delete an empty cluster


var client = new AmazonECSClient();
var response = client.DeleteCluster(new DeleteClusterRequest 
{
    Cluster = "my_cluster"
});

Cluster cluster = response.Cluster;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonECS.DeleteCluster (DeleteClusterRequest)

Method