View a markdown version of this page

Use DeleteCluster with an AWS SDK or CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use DeleteCluster with an AWS SDK or CLI

The following code examples show how to use DeleteCluster.

Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:

CLI
AWS CLI

To delete an empty cluster

The following delete-cluster example deletes the specified empty cluster.

aws ecs delete-cluster --cluster MyCluster

Output:

{ "cluster": { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "status": "INACTIVE", "clusterName": "MyCluster", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 0 "statistics": [], "tags": [] } }

For more information, see Deleting a Cluster in the Amazon ECS Developer Guide.

  • For API details, see DeleteCluster in AWS CLI Command Reference.

PowerShell
Tools for PowerShell V4

Example 1: This cmdlet deletes the specified ECS cluster. You must deregister all container instances from this cluster before you may delete it.

Remove-ECSCluster -Cluster "LAB-ECS"

Output:

Confirm Are you sure you want to perform this action? Performing the operation "Remove-ECSCluster (DeleteCluster)" on target "LAB-ECS". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
  • For API details, see DeleteCluster in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: This cmdlet deletes the specified ECS cluster. You must deregister all container instances from this cluster before you may delete it.

Remove-ECSCluster -Cluster "LAB-ECS"

Output:

Confirm Are you sure you want to perform this action? Performing the operation "Remove-ECSCluster (DeleteCluster)" on target "LAB-ECS". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
  • For API details, see DeleteCluster in AWS Tools for PowerShell Cmdlet Reference (V5).

Python
SDK for Python (Boto3)
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository.

class EcsWrapper: """Encapsulates Amazon ECS operations.""" def __init__(self, ecs_client: BaseClient): """ Initializes the EcsWrapper with an ECS client. :param ecs_client: A Boto3 Amazon ECS client. Boto3 clients are created by the ``boto3.client`` factory function and are instances of ``botocore.client.BaseClient``, which is the correct type to annotate here (``boto3.client`` itself is a function, not a type). """ self.ecs_client = ecs_client @classmethod def from_client(cls) -> "EcsWrapper": """Creates an EcsWrapper using a default Boto3 ECS client.""" ecs_client = boto3.client("ecs") return cls(ecs_client) def delete_cluster(self, cluster: str) -> Dict[str, Any]: """ Deletes an ECS cluster. :param cluster: The cluster name or ARN. :return: The deleted cluster details. :raises ClientError: If the request fails (e.g., ClusterContainsServicesException). """ try: response = self.ecs_client.delete_cluster( cluster=cluster, ) cluster_info = response["cluster"] logger.info( "Deleted cluster '%s' (status: %s)", cluster_info["clusterName"], cluster_info["status"], ) return cluster_info except ClientError as err: if err.response["Error"]["Code"] == "ClusterContainsServicesException": logger.error( "Cluster '%s' still contains services. Delete services first: %s", cluster, err.response["Error"]["Message"], ) raise
  • For API details, see DeleteCluster in AWS SDK for Python (Boto3) API Reference.

Rust
SDK for Rust
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository.

async fn remove_cluster( client: &aws_sdk_ecs::Client, name: &str, ) -> Result<(), aws_sdk_ecs::Error> { let cluster_deleted = client.delete_cluster().cluster(name).send().await?; println!("cluster deleted: {:?}", cluster_deleted); Ok(()) }
  • For API details, see DeleteCluster in AWS SDK for Rust API reference.