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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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)

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

#auth_token_enabledBoolean

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

Default: false

Returns:

  • (Boolean)

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

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

    Possible values:

    • enabled
    • disabled
    • enabling
    • disabling

Returns:

  • (String)

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

#cache_node_typeString

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

Returns:

  • (String)

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

#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)

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

#configuration_endpointTypes::Endpoint

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

Returns:

  • (Types::Endpoint)

    The configuration endpoint for this replication group.

#descriptionString

The user supplied description of the replication group.

Returns:

  • (String)

    The user supplied description of the replication group.

#member_clustersArray<String>

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

Returns:

  • (Array<String>)

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

#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:

  • (Array<Types::NodeGroup>)

    A list of node groups in this replication group.

#pending_modified_valuesTypes::ReplicationGroupPendingModifiedValues

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

Returns:

#replication_group_idString

The identifier for the replication group.

Returns:

  • (String)

    The identifier for the replication group.

#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)

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.

#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)

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

#snapshotting_cluster_idString

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

Returns:

  • (String)

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

#statusString

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

Returns:

  • (String)

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

#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)

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