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

#at_rest_encryption_enabledBoolean

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

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Default: false

Returns:

  • (Boolean)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#auth_token_enabledBoolean

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

Default: false

Returns:

  • (Boolean)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#automatic_failoverString

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover 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)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  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)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  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)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#configuration_endpointTypes::Endpoint

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

Returns:



4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#descriptionString

The user supplied description of the replication group.

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#member_clustersArray<String>

The identifiers of all the nodes that are part of this replication group.

Returns:

  • (Array<String>)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#node_groupsArray<Types::NodeGroup>

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Returns:



4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  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.



4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#replication_group_idString

The identifier for the replication group.

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_retention_limitInteger

The number of days for which ElastiCache retains automatic 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)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  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.

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

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshotting_cluster_idString

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

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  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.

Default: false

Returns:

  • (Boolean)


4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4737

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,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end