You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElastiCache::Types::GlobalReplicationGroup

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) —

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

#at_rest_encryption_enabled ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#auth_token_enabled ⇒ Boolean

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

Default: false

Returns:

  • (Boolean) —

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

#cache_node_type ⇒ String

The cache node type of the Global Datastore

Returns:

  • (String) —

    The cache node type of the Global Datastore.

#cluster_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#engine ⇒ String

The Elasticache engine. For Redis only.

Returns:

  • (String) —

    The Elasticache engine.

#engine_version ⇒ String

The Elasticache Redis engine version.

Returns:

  • (String) —

    The Elasticache Redis engine version.

#global_node_groups ⇒ Array<Types::GlobalNodeGroup>

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

Returns:

  • (Array<Types::GlobalNodeGroup>) —

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

#global_replication_group_description ⇒ String

The optional description of the Global Datastore

Returns:

  • (String) —

    The optional description of the Global Datastore.

#global_replication_group_id ⇒ String

The name of the Global Datastore

Returns:

  • (String) —

    The name of the Global Datastore.

#members ⇒ Array<Types::GlobalReplicationGroupMember>

The replication groups that comprise the Global Datastore.

Returns:

#status ⇒ String

The status of the Global Datastore

Returns:

  • (String) —

    The status of the Global Datastore.

#transit_encryption_enabled ⇒ Boolean

A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Returns:

  • (Boolean) —

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