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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/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.

^

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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:



5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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:



5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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) 


5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5289

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