libZSservicesZSamazonka-elasticacheZSamazonka-elasticache
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElastiCache.DeleteCacheCluster

Description

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

  • Redis (cluster mode enabled) clusters
  • Redis (cluster mode disabled) clusters
  • A cluster that is the last read replica of a replication group
  • A cluster that is the primary node of a replication group
  • A node group (shard) that has Multi-AZ mode enabled
  • A cluster from a Redis (cluster mode enabled) replication group
  • A cluster that is not in the available state
Synopsis

Creating a Request

data DeleteCacheCluster Source #

Represents the input of a DeleteCacheCluster operation.

See: newDeleteCacheCluster smart constructor.

Constructors

DeleteCacheCluster' 

Fields

  • finalSnapshotIdentifier :: Maybe Text

    The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

  • cacheClusterId :: Text

    The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Instances

Instances details
Eq DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

(==) :: DeleteCacheCluster -> DeleteCacheCluster -> Bool #

(/=) :: DeleteCacheCluster -> DeleteCacheCluster -> Bool #

Read DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

readsPrec :: Int -> ReadS DeleteCacheCluster #

readList :: ReadS [DeleteCacheCluster] #

readPrec :: ReadPrec DeleteCacheCluster #

readListPrec :: ReadPrec [DeleteCacheCluster] #

Show DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

showsPrec :: Int -> DeleteCacheCluster -> ShowS #

show :: DeleteCacheCluster -> String #

showList :: [DeleteCacheCluster] -> ShowS #

Generic DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Associated Types

type Rep DeleteCacheCluster :: Type -> Type #

Methods

from :: DeleteCacheCluster -> Rep DeleteCacheCluster x #

to :: Rep DeleteCacheCluster x -> DeleteCacheCluster #

NFData DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

rnf :: DeleteCacheCluster -> () #

Hashable DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

hashWithSalt :: Int -> DeleteCacheCluster -> Int #

hash :: DeleteCacheCluster -> Int #

AWSRequest DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Associated Types

type AWSResponse DeleteCacheCluster #

Methods

request :: DeleteCacheCluster -> Request DeleteCacheCluster #

response :: MonadResource m => Logger -> Service -> Proxy DeleteCacheCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteCacheCluster))) #

ToHeaders DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

toHeaders :: DeleteCacheCluster -> [Header] #

ToPath DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

toPath :: DeleteCacheCluster -> ByteString #

ToQuery DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

toQuery :: DeleteCacheCluster -> QueryString #

type Rep DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

type Rep DeleteCacheCluster = D1 ('MetaData "DeleteCacheCluster" "Amazonka.ElastiCache.DeleteCacheCluster" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DeleteCacheCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "finalSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cacheClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteCacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

type AWSResponse DeleteCacheCluster = DeleteCacheClusterResponse

newDeleteCacheCluster Source #

Arguments

:: Text

$sel:cacheClusterId:DeleteCacheCluster'

-> DeleteCacheCluster 

Create a value of DeleteCacheCluster 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:

$sel:finalSnapshotIdentifier:DeleteCacheCluster', deleteCacheCluster_finalSnapshotIdentifier - The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

$sel:cacheClusterId:DeleteCacheCluster', deleteCacheCluster_cacheClusterId - The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Request Lenses

deleteCacheCluster_finalSnapshotIdentifier :: Lens' DeleteCacheCluster (Maybe Text) Source #

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

deleteCacheCluster_cacheClusterId :: Lens' DeleteCacheCluster Text Source #

The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Destructuring the Response

data DeleteCacheClusterResponse Source #

See: newDeleteCacheClusterResponse smart constructor.

Constructors

DeleteCacheClusterResponse' 

Fields

Instances

Instances details
Eq DeleteCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

(==) :: DeleteCacheClusterResponse -> DeleteCacheClusterResponse -> Bool #

(/=) :: DeleteCacheClusterResponse -> DeleteCacheClusterResponse -> Bool #

Read DeleteCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

readsPrec :: Int -> ReadS DeleteCacheClusterResponse #

readList :: ReadS [DeleteCacheClusterResponse] #

readPrec :: ReadPrec DeleteCacheClusterResponse #

readListPrec :: ReadPrec [DeleteCacheClusterResponse] #

Show DeleteCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

showsPrec :: Int -> DeleteCacheClusterResponse -> ShowS #

show :: DeleteCacheClusterResponse -> String #

showList :: [DeleteCacheClusterResponse] -> ShowS #

Generic DeleteCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Associated Types

type Rep DeleteCacheClusterResponse :: Type -> Type #

Methods

from :: DeleteCacheClusterResponse -> Rep DeleteCacheClusterResponse x #

to :: Rep DeleteCacheClusterResponse x -> DeleteCacheClusterResponse #

NFData DeleteCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

Methods

rnf :: DeleteCacheClusterResponse -> () #

type Rep DeleteCacheClusterResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DeleteCacheCluster

type Rep DeleteCacheClusterResponse = D1 ('MetaData "DeleteCacheClusterResponse" "Amazonka.ElastiCache.DeleteCacheCluster" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DeleteCacheClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cacheCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteCacheClusterResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteCacheClusterResponse'

-> DeleteCacheClusterResponse 

Create a value of DeleteCacheClusterResponse 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:

$sel:cacheCluster:DeleteCacheClusterResponse', deleteCacheClusterResponse_cacheCluster - Undocumented member.

$sel:httpStatus:DeleteCacheClusterResponse', deleteCacheClusterResponse_httpStatus - The response's http status code.

Response Lenses

deleteCacheClusterResponse_cacheCluster :: Lens' DeleteCacheClusterResponse (Maybe CacheCluster) Source #

Undocumented member.

deleteCacheClusterResponse_httpStatus :: Lens' DeleteCacheClusterResponse Int Source #

The response's http status code.