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

^

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_enabledBoolean

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)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_enabledBoolean

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

Default: false

Returns:

  • (Boolean)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_typeString

The cache node type of the Global Datastore

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_enabledBoolean

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

Returns:

  • (Boolean)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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

#engineString

The Elasticache engine. For Redis only.

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_versionString

The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_groupsArray<Types::GlobalNodeGroup>

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

Returns:



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_descriptionString

The optional description of the Global Datastore

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_idString

The name of the Global Datastore

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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

#membersArray<Types::GlobalReplicationGroupMember>

The replication groups that comprise the Global Datastore.



4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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

#statusString

The status of the Global Datastore

Returns:

  • (String)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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_enabledBoolean

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)


4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4498

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