Amazonka.ECS.DeleteCluster

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.

Creating a Request

data DeleteCluster

See: newDeleteCluster smart constructor.

Constructors

DeleteCluster'

Fields

• cluster :: Text

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

Instances

ToJSON DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

toJSON :: DeleteCluster -> Value

toEncoding :: DeleteCluster -> Encoding

toJSONList :: [DeleteCluster] -> Value

toEncodingList :: [DeleteCluster] -> Encoding

ToHeaders DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

toHeaders :: DeleteCluster -> [Header]

ToPath DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

toPath :: DeleteCluster -> ByteString

ToQuery DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

toQuery :: DeleteCluster -> QueryString

AWSRequest DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Associated Types

type AWSResponse DeleteCluster

Methods

request :: (Service -> Service) -> DeleteCluster -> Request DeleteCluster

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteCluster)))

Generic DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Associated Types

type Rep DeleteCluster :: Type -> Type

Methods

from :: DeleteCluster -> Rep DeleteCluster x

to :: Rep DeleteCluster x -> DeleteCluster

Read DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

readsPrec :: Int -> ReadS DeleteCluster

readList :: ReadS [DeleteCluster]

readPrec :: ReadPrec DeleteCluster

readListPrec :: ReadPrec [DeleteCluster]

Show DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

showsPrec :: Int -> DeleteCluster -> ShowS

show :: DeleteCluster -> String

showList :: [DeleteCluster] -> ShowS

NFData DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

rnf :: DeleteCluster -> ()

Eq DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

(==) :: DeleteCluster -> DeleteCluster -> Bool

(/=) :: DeleteCluster -> DeleteCluster -> Bool

Hashable DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

Methods

hashWithSalt :: Int -> DeleteCluster -> Int

hash :: DeleteCluster -> Int

type AWSResponse DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

type AWSResponse DeleteCluster = DeleteClusterResponse

type Rep DeleteCluster

Defined in Amazonka.ECS.DeleteCluster

type Rep DeleteCluster = D1 ('MetaData "DeleteCluster" "Amazonka.ECS.DeleteCluster" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeleteCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteCluster

Arguments

:: Text

DeleteCluster

-> DeleteCluster

Create a value of DeleteCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

Request Lenses

deleteCluster_cluster :: Lens' DeleteCluster Text

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

Destructuring the Response

data DeleteClusterResponse

See: newDeleteClusterResponse smart constructor.

Constructors

DeleteClusterResponse'

Fields

• cluster :: Maybe Cluster

  The full description of the deleted cluster.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteClusterResponse

Defined in Amazonka.ECS.DeleteCluster

Associated Types

type Rep DeleteClusterResponse :: Type -> Type

Methods

from :: DeleteClusterResponse -> Rep DeleteClusterResponse x

to :: Rep DeleteClusterResponse x -> DeleteClusterResponse

Read DeleteClusterResponse

Defined in Amazonka.ECS.DeleteCluster

Methods

readsPrec :: Int -> ReadS DeleteClusterResponse

readList :: ReadS [DeleteClusterResponse]

readPrec :: ReadPrec DeleteClusterResponse

readListPrec :: ReadPrec [DeleteClusterResponse]

Show DeleteClusterResponse

Defined in Amazonka.ECS.DeleteCluster

Methods

showsPrec :: Int -> DeleteClusterResponse -> ShowS

show :: DeleteClusterResponse -> String

showList :: [DeleteClusterResponse] -> ShowS

NFData DeleteClusterResponse

Defined in Amazonka.ECS.DeleteCluster

Methods

rnf :: DeleteClusterResponse -> ()

Eq DeleteClusterResponse

Defined in Amazonka.ECS.DeleteCluster

Methods

(==) :: DeleteClusterResponse -> DeleteClusterResponse -> Bool

(/=) :: DeleteClusterResponse -> DeleteClusterResponse -> Bool

type Rep DeleteClusterResponse

Defined in Amazonka.ECS.DeleteCluster

type Rep DeleteClusterResponse = D1 ('MetaData "DeleteClusterResponse" "Amazonka.ECS.DeleteCluster" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeleteClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteClusterResponse

Arguments

:: Int

$sel:httpStatus:DeleteClusterResponse'

-> DeleteClusterResponse

Create a value of DeleteClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteCluster, deleteClusterResponse_cluster - The full description of the deleted cluster.

$sel:httpStatus:DeleteClusterResponse', deleteClusterResponse_httpStatus - The response's http status code.

Response Lenses

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster)

The full description of the deleted cluster.

deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int

The response's http status code.