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.DocumentDB.Types.GlobalCluster

Description

Synopsis

data GlobalCluster = GlobalCluster' {
- databaseName :: Maybe Text
- deletionProtection :: Maybe Bool
- engine :: Maybe Text
- engineVersion :: Maybe Text
- globalClusterArn :: Maybe Text
- globalClusterIdentifier :: Maybe Text
- globalClusterMembers :: Maybe [GlobalClusterMember]
- globalClusterResourceId :: Maybe Text
- status :: Maybe Text
- storageEncrypted :: Maybe Bool
}
newGlobalCluster :: GlobalCluster
globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text)
globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool)
globalCluster_engine :: Lens' GlobalCluster (Maybe Text)
globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text)
globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text)
globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text)
globalCluster_globalClusterMembers :: Lens' GlobalCluster (Maybe [GlobalClusterMember])
globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text)
globalCluster_status :: Lens' GlobalCluster (Maybe Text)
globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool)

Documentation

data GlobalCluster Source #

A data type representing an Amazon DocumentDB global cluster.

See: newGlobalCluster smart constructor.

Constructors

GlobalCluster'

Fields

databaseName :: Maybe Text
The default database name within the new global cluster.
deletionProtection :: Maybe Bool
The deletion protection setting for the new global cluster.
engine :: Maybe Text
The Amazon DocumentDB database engine used by the global cluster.
engineVersion :: Maybe Text
Indicates the database engine version.
globalClusterArn :: Maybe Text
The Amazon Resource Name (ARN) for the global cluster.
globalClusterIdentifier :: Maybe Text
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
globalClusterMembers :: Maybe [GlobalClusterMember]
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
globalClusterResourceId :: Maybe Text
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
status :: Maybe Text
Specifies the current state of this global cluster.
storageEncrypted :: Maybe Bool
The storage encryption setting for the global cluster.

Instances

Instances details

FromXML GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods parseXML :: [Node] -> Either String GlobalCluster #
Generic GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Associated Types type Rep GlobalCluster :: Type -> Type # Methods from :: GlobalCluster -> Rep GlobalCluster x # to :: Rep GlobalCluster x -> GlobalCluster #
Read GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods readsPrec :: Int -> ReadS GlobalCluster # readList :: ReadS [GlobalCluster] # readPrec :: ReadPrec GlobalCluster # readListPrec :: ReadPrec [GlobalCluster] #
Show GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods showsPrec :: Int -> GlobalCluster -> ShowS # show :: GlobalCluster -> String # showList :: [GlobalCluster] -> ShowS #
NFData GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods rnf :: GlobalCluster -> () #
Eq GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods (==) :: GlobalCluster -> GlobalCluster -> Bool # (/=) :: GlobalCluster -> GlobalCluster -> Bool #
Hashable GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster Methods hashWithSalt :: Int -> GlobalCluster -> Int # hash :: GlobalCluster -> Int #
type Rep GlobalCluster Source #
Instance details Defined in Amazonka.DocumentDB.Types.GlobalCluster type Rep GlobalCluster = D1 ('MetaData "GlobalCluster" "Amazonka.DocumentDB.Types.GlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "GlobalCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "globalClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "globalClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalClusterMember]))) :: (S1 ('MetaSel ('Just "globalClusterResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newGlobalCluster :: GlobalCluster Source #

Create a value of GlobalCluster 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:databaseName:GlobalCluster', globalCluster_databaseName - The default database name within the new global cluster.

$sel:deletionProtection:GlobalCluster', globalCluster_deletionProtection - The deletion protection setting for the new global cluster.

$sel:engine:GlobalCluster', globalCluster_engine - The Amazon DocumentDB database engine used by the global cluster.

$sel:engineVersion:GlobalCluster', globalCluster_engineVersion - Indicates the database engine version.

$sel:globalClusterArn:GlobalCluster', globalCluster_globalClusterArn - The Amazon Resource Name (ARN) for the global cluster.

$sel:globalClusterIdentifier:GlobalCluster', globalCluster_globalClusterIdentifier - Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

$sel:globalClusterMembers:GlobalCluster', globalCluster_globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

$sel:globalClusterResourceId:GlobalCluster', globalCluster_globalClusterResourceId - The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

$sel:status:GlobalCluster', globalCluster_status - Specifies the current state of this global cluster.

$sel:storageEncrypted:GlobalCluster', globalCluster_storageEncrypted - The storage encryption setting for the global cluster.

globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text) Source #

The default database name within the new global cluster.

globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool) Source #

The deletion protection setting for the new global cluster.

globalCluster_engine :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon DocumentDB database engine used by the global cluster.

globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text) Source #

Indicates the database engine version.

globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the global cluster.

globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text) Source #

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

globalCluster_globalClusterMembers :: Lens' GlobalCluster (Maybe [GlobalClusterMember]) Source #

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text) Source #

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

globalCluster_status :: Lens' GlobalCluster (Maybe Text) Source #

Specifies the current state of this global cluster.

globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool) Source #

The storage encryption setting for the global cluster.