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

Description

Synopsis

data GlobalCluster = GlobalCluster' {
- 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_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 #

Contains the details of an Amazon Neptune global database.

This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

See: newGlobalCluster smart constructor.

Constructors

GlobalCluster'

Fields

deletionProtection :: Maybe Bool
The deletion protection setting for the global database.
engine :: Maybe Text
The Neptune database engine used by the global database ("neptune").
engineVersion :: Maybe Text
The Neptune engine version used by the global database.
globalClusterArn :: Maybe Text
The Amazon Resource Name (ARN) for the global database.
globalClusterIdentifier :: Maybe Text
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
globalClusterMembers :: Maybe [GlobalClusterMember]
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
globalClusterResourceId :: Maybe Text
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
status :: Maybe Text
Specifies the current state of this global database.
storageEncrypted :: Maybe Bool
The storage encryption setting for the global database.

Instances

Instances details

FromXML GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.Types.GlobalCluster Methods parseXML :: [Node] -> Either String GlobalCluster #
Generic GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.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.Neptune.Types.GlobalCluster Methods readsPrec :: Int -> ReadS GlobalCluster # readList :: ReadS [GlobalCluster] # readPrec :: ReadPrec GlobalCluster # readListPrec :: ReadPrec [GlobalCluster] #
Show GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.Types.GlobalCluster Methods showsPrec :: Int -> GlobalCluster -> ShowS # show :: GlobalCluster -> String # showList :: [GlobalCluster] -> ShowS #
NFData GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.Types.GlobalCluster Methods rnf :: GlobalCluster -> () #
Eq GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.Types.GlobalCluster Methods (==) :: GlobalCluster -> GlobalCluster -> Bool # (/=) :: GlobalCluster -> GlobalCluster -> Bool #
Hashable GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.Types.GlobalCluster Methods hashWithSalt :: Int -> GlobalCluster -> Int # hash :: GlobalCluster -> Int #
type Rep GlobalCluster Source #
Instance details Defined in Amazonka.Neptune.Types.GlobalCluster type Rep GlobalCluster = D1 ('MetaData "GlobalCluster" "Amazonka.Neptune.Types.GlobalCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "GlobalCluster'" 'PrefixI 'True) (((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:deletionProtection:GlobalCluster', globalCluster_deletionProtection - The deletion protection setting for the global database.

$sel:engine:GlobalCluster', globalCluster_engine - The Neptune database engine used by the global database ("neptune").

$sel:engineVersion:GlobalCluster', globalCluster_engineVersion - The Neptune engine version used by the global database.

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

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

$sel:globalClusterMembers:GlobalCluster', globalCluster_globalClusterMembers - A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

$sel:globalClusterResourceId:GlobalCluster', globalCluster_globalClusterResourceId - An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

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

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

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

The deletion protection setting for the global database.

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

The Neptune database engine used by the global database ("neptune").

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

The Neptune engine version used by the global database.

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

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

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

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

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

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

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

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

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

Specifies the current state of this global database.

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

The storage encryption setting for the global database.