Skip to content

ECS  >  Operations  >  delete_cluster

delete_cluster

Operation

delete_cluster async 

delete_cluster(input: DeleteClusterInput, plugins: list[Plugin] | None = None) -> DeleteClusterOutput

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.

Parameters:

Name Type Description Default
input DeleteClusterInput

An instance of DeleteClusterInput.

 required
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

Returns:

Type Description
DeleteClusterOutput

An instance of DeleteClusterOutput.

Input

DeleteClusterInput dataclass

Bases: _SerdeShape

Attributes

cluster class-attribute instance-attribute 
cluster: str | None = ...

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

Output

DeleteClusterOutput dataclass

Bases: _SerdeShape

Attributes

cluster class-attribute instance-attribute 
cluster: Cluster | None = ...

The full description of the deleted cluster.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.