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

Class: Aws::ElastiCache::Types::ReplicationGroup

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Contains all of the attributes of a specific Redis replication group.

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_failoverString

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled):T1 and T2 cache node types.

    Redis (cluster mode enabled): T1 node types.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#cache_node_typeString

The name of the compute and memory capacity node type for each node in the replication group.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#cluster_enabledBoolean

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Returns:

  • (Boolean)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#configuration_endpointTypes::Endpoint

The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

Returns:



4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#descriptionString

The description of the replication group.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#member_clustersArray<String>

The names of all the cache clusters that are part of this replication group.

Returns:

  • (Array<String>)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#node_groupsArray<Types::NodeGroup>

A single element list with information about the nodes in the replication group.

Returns:



4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#pending_modified_valuesTypes::ReplicationGroupPendingModifiedValues

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.



4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#replication_group_idString

The identifier for the replication group.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#snapshot_retention_limitInteger

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

  • (Integer)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#snapshot_windowString

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#snapshotting_cluster_idString

The cache cluster ID that is used as the daily snapshot source for the replication group.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end

#statusString

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Returns:

  • (String)


4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4437

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type)
  include Aws::Structure
end