Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElastiCache.DeleteReplicationGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

This operation is valid for Redis only.

Synopsis

data DeleteReplicationGroup = DeleteReplicationGroup' {
- finalSnapshotIdentifier :: Maybe Text
- retainPrimaryCluster :: Maybe Bool
- replicationGroupId :: Text
}
newDeleteReplicationGroup :: Text -> DeleteReplicationGroup
deleteReplicationGroup_finalSnapshotIdentifier :: Lens' DeleteReplicationGroup (Maybe Text)
deleteReplicationGroup_retainPrimaryCluster :: Lens' DeleteReplicationGroup (Maybe Bool)
deleteReplicationGroup_replicationGroupId :: Lens' DeleteReplicationGroup Text
data DeleteReplicationGroupResponse = DeleteReplicationGroupResponse' {
- replicationGroup :: Maybe ReplicationGroup
- httpStatus :: Int
}
newDeleteReplicationGroupResponse :: Int -> DeleteReplicationGroupResponse
deleteReplicationGroupResponse_replicationGroup :: Lens' DeleteReplicationGroupResponse (Maybe ReplicationGroup)
deleteReplicationGroupResponse_httpStatus :: Lens' DeleteReplicationGroupResponse Int

Creating a Request

data DeleteReplicationGroup Source #

Represents the input of a DeleteReplicationGroup operation.

See: newDeleteReplicationGroup smart constructor.

Constructors

DeleteReplicationGroup'

Fields

finalSnapshotIdentifier :: Maybe Text
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
retainPrimaryCluster :: Maybe Bool
If set to true, all of the read replicas are deleted, but the primary node is retained.
replicationGroupId :: Text
The identifier for the cluster to be deleted. This parameter is not case sensitive.

Instances

Instances details

Eq DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods (==) :: DeleteReplicationGroup -> DeleteReplicationGroup -> Bool # (/=) :: DeleteReplicationGroup -> DeleteReplicationGroup -> Bool #
Read DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods readsPrec :: Int -> ReadS DeleteReplicationGroup # readList :: ReadS [DeleteReplicationGroup] # readPrec :: ReadPrec DeleteReplicationGroup # readListPrec :: ReadPrec [DeleteReplicationGroup] #
Show DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods showsPrec :: Int -> DeleteReplicationGroup -> ShowS # show :: DeleteReplicationGroup -> String # showList :: [DeleteReplicationGroup] -> ShowS #
Generic DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Associated Types type Rep DeleteReplicationGroup :: Type -> Type # Methods from :: DeleteReplicationGroup -> Rep DeleteReplicationGroup x # to :: Rep DeleteReplicationGroup x -> DeleteReplicationGroup #
NFData DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods rnf :: DeleteReplicationGroup -> () #
Hashable DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods hashWithSalt :: Int -> DeleteReplicationGroup -> Int # hash :: DeleteReplicationGroup -> Int #
AWSRequest DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Associated Types type AWSResponse DeleteReplicationGroup # Methods request :: DeleteReplicationGroup -> Request DeleteReplicationGroup # response :: MonadResource m => Logger -> Service -> Proxy DeleteReplicationGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteReplicationGroup))) #
ToHeaders DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods toHeaders :: DeleteReplicationGroup -> [Header] #
ToPath DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods toPath :: DeleteReplicationGroup -> ByteString #
ToQuery DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods toQuery :: DeleteReplicationGroup -> QueryString #
type Rep DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup type Rep DeleteReplicationGroup = D1 ('MetaData "DeleteReplicationGroup" "Amazonka.ElastiCache.DeleteReplicationGroup" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DeleteReplicationGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "finalSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "retainPrimaryCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup type AWSResponse DeleteReplicationGroup = DeleteReplicationGroupResponse

newDeleteReplicationGroup Source #

Arguments

:: Text	`$sel:replicationGroupId:DeleteReplicationGroup'`
-> DeleteReplicationGroup

Create a value of DeleteReplicationGroup 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:DeleteReplicationGroup', deleteReplicationGroup_finalSnapshotIdentifier - The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

$sel:retainPrimaryCluster:DeleteReplicationGroup', deleteReplicationGroup_retainPrimaryCluster - If set to true, all of the read replicas are deleted, but the primary node is retained.

$sel:replicationGroupId:DeleteReplicationGroup', deleteReplicationGroup_replicationGroupId - The identifier for the cluster to be deleted. This parameter is not case sensitive.

Request Lenses

deleteReplicationGroup_finalSnapshotIdentifier :: Lens' DeleteReplicationGroup (Maybe Text) Source #

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

deleteReplicationGroup_retainPrimaryCluster :: Lens' DeleteReplicationGroup (Maybe Bool) Source #

If set to true, all of the read replicas are deleted, but the primary node is retained.

deleteReplicationGroup_replicationGroupId :: Lens' DeleteReplicationGroup Text Source #

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

Destructuring the Response

data DeleteReplicationGroupResponse Source #

See: newDeleteReplicationGroupResponse smart constructor.

Constructors

DeleteReplicationGroupResponse'
Fields replicationGroup :: Maybe ReplicationGroup httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods (==) :: DeleteReplicationGroupResponse -> DeleteReplicationGroupResponse -> Bool # (/=) :: DeleteReplicationGroupResponse -> DeleteReplicationGroupResponse -> Bool #
Read DeleteReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods readsPrec :: Int -> ReadS DeleteReplicationGroupResponse # readList :: ReadS [DeleteReplicationGroupResponse] # readPrec :: ReadPrec DeleteReplicationGroupResponse # readListPrec :: ReadPrec [DeleteReplicationGroupResponse] #
Show DeleteReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods showsPrec :: Int -> DeleteReplicationGroupResponse -> ShowS # show :: DeleteReplicationGroupResponse -> String # showList :: [DeleteReplicationGroupResponse] -> ShowS #
Generic DeleteReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Associated Types type Rep DeleteReplicationGroupResponse :: Type -> Type # Methods from :: DeleteReplicationGroupResponse -> Rep DeleteReplicationGroupResponse x # to :: Rep DeleteReplicationGroupResponse x -> DeleteReplicationGroupResponse #
NFData DeleteReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup Methods rnf :: DeleteReplicationGroupResponse -> () #
type Rep DeleteReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.DeleteReplicationGroup type Rep DeleteReplicationGroupResponse = D1 ('MetaData "DeleteReplicationGroupResponse" "Amazonka.ElastiCache.DeleteReplicationGroup" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DeleteReplicationGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteReplicationGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteReplicationGroupResponse'`
-> DeleteReplicationGroupResponse

Create a value of DeleteReplicationGroupResponse 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:replicationGroup:DeleteReplicationGroupResponse', deleteReplicationGroupResponse_replicationGroup - Undocumented member.

$sel:httpStatus:DeleteReplicationGroupResponse', deleteReplicationGroupResponse_httpStatus - The response's http status code.

Response Lenses

deleteReplicationGroupResponse_replicationGroup :: Lens' DeleteReplicationGroupResponse (Maybe ReplicationGroup) Source #

Undocumented member.

deleteReplicationGroupResponse_httpStatus :: Lens' DeleteReplicationGroupResponse Int Source #

The response's http status code.