Amazonka.RDS.Types.GlobalCluster

Documentation

data GlobalCluster

A data type representing an Aurora global database.

See: newGlobalCluster smart constructor.

Constructors

GlobalCluster'

Fields

• databaseName :: Maybe Text

  The default database name within the new global database cluster.

• deletionProtection :: Maybe Bool

  The deletion protection setting for the new global database cluster.

• engine :: Maybe Text

  The Aurora database engine used by the global database cluster.

• engineVersion :: Maybe Text

  Indicates the database engine version.

• failoverState :: Maybe FailoverState

  A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

• globalClusterArn :: Maybe Text

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

• globalClusterIdentifier :: Maybe Text

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

• globalClusterMembers :: Maybe [GlobalClusterMember]

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

• globalClusterResourceId :: Maybe Text

  The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

• status :: Maybe Text

  Specifies the current state of this global database cluster.

• storageEncrypted :: Maybe Bool

  The storage encryption setting for the global database cluster.

Instances

FromXML GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

parseXML :: [Node] -> Either String GlobalCluster

Generic GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Associated Types

type Rep GlobalCluster :: Type -> Type

Methods

from :: GlobalCluster -> Rep GlobalCluster x

to :: Rep GlobalCluster x -> GlobalCluster

Read GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

readsPrec :: Int -> ReadS GlobalCluster

readList :: ReadS [GlobalCluster]

readPrec :: ReadPrec GlobalCluster

readListPrec :: ReadPrec [GlobalCluster]

Show GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

showsPrec :: Int -> GlobalCluster -> ShowS

show :: GlobalCluster -> String

showList :: [GlobalCluster] -> ShowS

NFData GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

rnf :: GlobalCluster -> ()

Eq GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

(==) :: GlobalCluster -> GlobalCluster -> Bool

(/=) :: GlobalCluster -> GlobalCluster -> Bool

Hashable GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

hashWithSalt :: Int -> GlobalCluster -> Int

hash :: GlobalCluster -> Int

type Rep GlobalCluster

Defined in Amazonka.RDS.Types.GlobalCluster

type Rep GlobalCluster = D1 ('MetaData "GlobalCluster" "Amazonka.RDS.Types.GlobalCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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 "failoverState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailoverState))))) :*: ((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

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 database cluster.

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

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

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

$sel:failoverState:GlobalCluster', globalCluster_failoverState - A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

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

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

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

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

GlobalCluster, globalCluster_status - Specifies the current state of this global database cluster.

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

globalCluster_databaseName :: Lens' GlobalCluster (Maybe Text)

The default database name within the new global database cluster.

globalCluster_deletionProtection :: Lens' GlobalCluster (Maybe Bool)

The deletion protection setting for the new global database cluster.

globalCluster_engine :: Lens' GlobalCluster (Maybe Text)

The Aurora database engine used by the global database cluster.

globalCluster_engineVersion :: Lens' GlobalCluster (Maybe Text)

Indicates the database engine version.

globalCluster_failoverState :: Lens' GlobalCluster (Maybe FailoverState)

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

globalCluster_globalClusterArn :: Lens' GlobalCluster (Maybe Text)

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

globalCluster_globalClusterIdentifier :: Lens' GlobalCluster (Maybe Text)

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

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

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

globalCluster_globalClusterResourceId :: Lens' GlobalCluster (Maybe Text)

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

globalCluster_status :: Lens' GlobalCluster (Maybe Text)

Specifies the current state of this global database cluster.

globalCluster_storageEncrypted :: Lens' GlobalCluster (Maybe Bool)

The storage encryption setting for the global database cluster.