| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ElastiCache.DeleteGlobalReplicationGroup
Description
Deleting a Global datastore is a two-step process:
- First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
- Once the Global datastore contains only the primary cluster, you can
use the
DeleteGlobalReplicationGroupAPI to delete the Global datastore while retainining the primary cluster usingRetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete
the Global Datastore while retaining the primary by setting
RetainPrimaryReplicationGroup=true. The primary cluster is never
deleted when deleting a Global Datastore. It can only be deleted when it
no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
Synopsis
- data DeleteGlobalReplicationGroup = DeleteGlobalReplicationGroup' {}
- newDeleteGlobalReplicationGroup :: Text -> Bool -> DeleteGlobalReplicationGroup
- deleteGlobalReplicationGroup_globalReplicationGroupId :: Lens' DeleteGlobalReplicationGroup Text
- deleteGlobalReplicationGroup_retainPrimaryReplicationGroup :: Lens' DeleteGlobalReplicationGroup Bool
- data DeleteGlobalReplicationGroupResponse = DeleteGlobalReplicationGroupResponse' {}
- newDeleteGlobalReplicationGroupResponse :: Int -> DeleteGlobalReplicationGroupResponse
- deleteGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DeleteGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)
- deleteGlobalReplicationGroupResponse_httpStatus :: Lens' DeleteGlobalReplicationGroupResponse Int
Creating a Request
data DeleteGlobalReplicationGroup Source #
See: newDeleteGlobalReplicationGroup smart constructor.
Constructors
| DeleteGlobalReplicationGroup' | |
Fields
| |
Instances
newDeleteGlobalReplicationGroup Source #
Arguments
| :: Text | |
| -> Bool |
|
| -> DeleteGlobalReplicationGroup |
Create a value of DeleteGlobalReplicationGroup 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:
DeleteGlobalReplicationGroup, deleteGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:retainPrimaryReplicationGroup:DeleteGlobalReplicationGroup', deleteGlobalReplicationGroup_retainPrimaryReplicationGroup - The primary replication group is retained as a standalone replication
group.
Request Lenses
deleteGlobalReplicationGroup_globalReplicationGroupId :: Lens' DeleteGlobalReplicationGroup Text Source #
The name of the Global datastore
deleteGlobalReplicationGroup_retainPrimaryReplicationGroup :: Lens' DeleteGlobalReplicationGroup Bool Source #
The primary replication group is retained as a standalone replication group.
Destructuring the Response
data DeleteGlobalReplicationGroupResponse Source #
See: newDeleteGlobalReplicationGroupResponse smart constructor.
Constructors
| DeleteGlobalReplicationGroupResponse' | |
Fields
| |
Instances
newDeleteGlobalReplicationGroupResponse Source #
Arguments
| :: Int | |
| -> DeleteGlobalReplicationGroupResponse |
Create a value of DeleteGlobalReplicationGroupResponse 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:globalReplicationGroup:DeleteGlobalReplicationGroupResponse', deleteGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:DeleteGlobalReplicationGroupResponse', deleteGlobalReplicationGroupResponse_httpStatus - The response's http status code.
Response Lenses
deleteGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DeleteGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup) Source #
Undocumented member.
deleteGlobalReplicationGroupResponse_httpStatus :: Lens' DeleteGlobalReplicationGroupResponse Int Source #
The response's http status code.