Amazonka.ElastiCache.Types.GlobalReplicationGroup

Documentation

data GlobalReplicationGroup

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

• The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

See: newGlobalReplicationGroup smart constructor.

Constructors

GlobalReplicationGroup'

Fields

• arn :: Maybe Text

  The ARN (Amazon Resource Name) of the global replication group.

• atRestEncryptionEnabled :: Maybe Bool

  A flag that enables encryption at rest when set to true.

  You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

  Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

• authTokenEnabled :: Maybe Bool

  A flag that enables using an AuthToken (password) when issuing Redis commands.

  Default: false

• cacheNodeType :: Maybe Text

  The cache node type of the Global datastore

• clusterEnabled :: Maybe Bool

  A flag that indicates whether the Global datastore is cluster enabled.

• engine :: Maybe Text

  The Elasticache engine. For Redis only.

• engineVersion :: Maybe Text

  The Elasticache Redis engine version.

• globalNodeGroups :: Maybe [GlobalNodeGroup]

  Indicates the slot configuration and global identifier for each slice group.

• globalReplicationGroupDescription :: Maybe Text

  The optional description of the Global datastore

• globalReplicationGroupId :: Maybe Text

  The name of the Global datastore

• members :: Maybe [GlobalReplicationGroupMember]

  The replication groups that comprise the Global datastore.

• status :: Maybe Text

  The status of the Global datastore

• transitEncryptionEnabled :: Maybe Bool

  A flag that enables in-transit encryption when set to true.

  Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Instances

FromXML GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Methods

parseXML :: [Node] -> Either String GlobalReplicationGroup

Generic GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Associated Types

type Rep GlobalReplicationGroup :: Type -> Type

Methods

from :: GlobalReplicationGroup -> Rep GlobalReplicationGroup x

to :: Rep GlobalReplicationGroup x -> GlobalReplicationGroup

Read GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Methods

readsPrec :: Int -> ReadS GlobalReplicationGroup

readList :: ReadS [GlobalReplicationGroup]

readPrec :: ReadPrec GlobalReplicationGroup

readListPrec :: ReadPrec [GlobalReplicationGroup]

Show GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Methods

showsPrec :: Int -> GlobalReplicationGroup -> ShowS

show :: GlobalReplicationGroup -> String

showList :: [GlobalReplicationGroup] -> ShowS

NFData GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Methods

rnf :: GlobalReplicationGroup -> ()

Eq GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Methods

(==) :: GlobalReplicationGroup -> GlobalReplicationGroup -> Bool

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

Hashable GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

Methods

hashWithSalt :: Int -> GlobalReplicationGroup -> Int

hash :: GlobalReplicationGroup -> Int

type Rep GlobalReplicationGroup

Defined in Amazonka.ElastiCache.Types.GlobalReplicationGroup

type Rep GlobalReplicationGroup = D1 ('MetaData "GlobalReplicationGroup" "Amazonka.ElastiCache.Types.GlobalReplicationGroup" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "GlobalReplicationGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "atRestEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "authTokenEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clusterEnabled") '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 "globalNodeGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalNodeGroup])) :*: S1 ('MetaSel ('Just "globalReplicationGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "globalReplicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalReplicationGroupMember]))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newGlobalReplicationGroup :: GlobalReplicationGroup

Create a value of GlobalReplicationGroup 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:arn:GlobalReplicationGroup', globalReplicationGroup_arn - The ARN (Amazon Resource Name) of the global replication group.

$sel:atRestEncryptionEnabled:GlobalReplicationGroup', globalReplicationGroup_atRestEncryptionEnabled - A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

$sel:authTokenEnabled:GlobalReplicationGroup', globalReplicationGroup_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

$sel:cacheNodeType:GlobalReplicationGroup', globalReplicationGroup_cacheNodeType - The cache node type of the Global datastore

$sel:clusterEnabled:GlobalReplicationGroup', globalReplicationGroup_clusterEnabled - A flag that indicates whether the Global datastore is cluster enabled.

$sel:engine:GlobalReplicationGroup', globalReplicationGroup_engine - The Elasticache engine. For Redis only.

$sel:engineVersion:GlobalReplicationGroup', globalReplicationGroup_engineVersion - The Elasticache Redis engine version.

$sel:globalNodeGroups:GlobalReplicationGroup', globalReplicationGroup_globalNodeGroups - Indicates the slot configuration and global identifier for each slice group.

$sel:globalReplicationGroupDescription:GlobalReplicationGroup', globalReplicationGroup_globalReplicationGroupDescription - The optional description of the Global datastore

$sel:globalReplicationGroupId:GlobalReplicationGroup', globalReplicationGroup_globalReplicationGroupId - The name of the Global datastore

$sel:members:GlobalReplicationGroup', globalReplicationGroup_members - The replication groups that comprise the Global datastore.

GlobalReplicationGroup, globalReplicationGroup_status - The status of the Global datastore

$sel:transitEncryptionEnabled:GlobalReplicationGroup', globalReplicationGroup_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

globalReplicationGroup_arn :: Lens' GlobalReplicationGroup (Maybe Text)

The ARN (Amazon Resource Name) of the global replication group.

globalReplicationGroup_atRestEncryptionEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

globalReplicationGroup_authTokenEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

globalReplicationGroup_cacheNodeType :: Lens' GlobalReplicationGroup (Maybe Text)

The cache node type of the Global datastore

globalReplicationGroup_clusterEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that indicates whether the Global datastore is cluster enabled.

globalReplicationGroup_engine :: Lens' GlobalReplicationGroup (Maybe Text)

The Elasticache engine. For Redis only.

globalReplicationGroup_engineVersion :: Lens' GlobalReplicationGroup (Maybe Text)

The Elasticache Redis engine version.

globalReplicationGroup_globalNodeGroups :: Lens' GlobalReplicationGroup (Maybe [GlobalNodeGroup])

Indicates the slot configuration and global identifier for each slice group.

globalReplicationGroup_globalReplicationGroupDescription :: Lens' GlobalReplicationGroup (Maybe Text)

The optional description of the Global datastore

globalReplicationGroup_globalReplicationGroupId :: Lens' GlobalReplicationGroup (Maybe Text)

The name of the Global datastore

globalReplicationGroup_members :: Lens' GlobalReplicationGroup (Maybe [GlobalReplicationGroupMember])

The replication groups that comprise the Global datastore.

globalReplicationGroup_status :: Lens' GlobalReplicationGroup (Maybe Text)

The status of the Global datastore

globalReplicationGroup_transitEncryptionEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.