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

Inherits:

Struct

Object
Struct
Aws::ElastiCache::Types::GlobalReplicationGroup

show all

Includes:: Structure

Defined in:: lib/aws-sdk-elasticache/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ 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`.
#auth_token_enabled ⇒ Boolean

A flag that enables using an ‘AuthToken` (password) when issuing Valkey or Redis OSS commands.
#cache_node_type ⇒ String

The cache node type of the Global datastore.
#cluster_enabled ⇒ Boolean

A flag that indicates whether the Global datastore is cluster enabled.
#engine ⇒ String

The ElastiCache engine.
#engine_version ⇒ String

The ElastiCache engine version.
#global_node_groups ⇒ 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.
#global_replication_group_id ⇒ String

The name of the Global datastore.
#members ⇒ Array<Types::GlobalReplicationGroupMember>

The replication groups that comprise the Global datastore.
#status ⇒ String

The status of the Global datastore.
#transit_encryption_enabled ⇒ Boolean

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

Instance Attribute Details

#arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#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 OSS version ‘3.2.6`, `4.x` or later.

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#auth_token_enabled ⇒ `Boolean`

A flag that enables using an ‘AuthToken` (password) when issuing Valkey or Redis OSS commands.

Default: ‘false`

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_type ⇒ `String`

The cache node type of the Global datastore

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The ElastiCache engine. For Valkey or Redis OSS only.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The ElastiCache engine version.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#global_node_groups ⇒ `Array<Types::GlobalNodeGroup>`

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

Returns:

(Array<Types::GlobalNodeGroup>)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#global_replication_group_description ⇒ `String`

The optional description of the Global datastore

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#global_replication_group_id ⇒ `String`

The name of the Global datastore

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#members ⇒ `Array<Types::GlobalReplicationGroupMember>`

The replication groups that comprise the Global datastore.

Returns:

(Array<Types::GlobalReplicationGroupMember>)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the Global datastore

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryption_enabled ⇒ `Boolean`

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 OSS version ‘3.2.6`, `4.x` or later.

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5287

class GlobalReplicationGroup < Struct.new(
  :global_replication_group_id,
  :global_replication_group_description,
  :status,
  :cache_node_type,
  :engine,
  :engine_version,
  :members,
  :cluster_enabled,
  :global_node_groups,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#at_rest_encryption_enabled ⇒ Boolean

#auth_token_enabled ⇒ Boolean

#cache_node_type ⇒ String

#cluster_enabled ⇒ Boolean

#engine ⇒ String

#engine_version ⇒ String

#global_node_groups ⇒ Array<Types::GlobalNodeGroup>

#global_replication_group_description ⇒ String

#global_replication_group_id ⇒ String

#members ⇒ Array<Types::GlobalReplicationGroupMember>

#status ⇒ String

#transit_encryption_enabled ⇒ Boolean

#arn ⇒ `String`

#at_rest_encryption_enabled ⇒ `Boolean`

#auth_token_enabled ⇒ `Boolean`

#cache_node_type ⇒ `String`

#cluster_enabled ⇒ `Boolean`

#engine ⇒ `String`

#engine_version ⇒ `String`

#global_node_groups ⇒ `Array<Types::GlobalNodeGroup>`

#global_replication_group_description ⇒ `String`

#global_replication_group_id ⇒ `String`

#members ⇒ `Array<Types::GlobalReplicationGroupMember>`

#status ⇒ `String`

#transit_encryption_enabled ⇒ `Boolean`