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

Inherits:

Struct

Object
Struct
Aws::ElastiCache::Types::ReplicationGroup

show all

Includes:: Structure

Defined in:: lib/aws-sdk-elasticache/types.rb

Overview

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

Instance Attribute Summary collapse

#at_rest_encryption_enabled ⇒ Boolean

A flag that enables encryption at-rest when set to ‘true`.
#auth_token_enabled ⇒ Boolean

A flag that enables using an ‘AuthToken` (password) when issuing Redis commands.
#automatic_failover ⇒ String

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

The name of the compute and memory capacity node type for each node in the replication group.
#cluster_enabled ⇒ 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_endpoint ⇒ Types::Endpoint

The configuration endpoint for this replication group.
#description ⇒ String

The user supplied description of the replication group.
#member_clusters ⇒ Array<String>

The names of all the cache clusters that are part of this replication group.
#node_groups ⇒ Array<Types::NodeGroup>

A list of node groups in this replication group.
#pending_modified_values ⇒ Types::ReplicationGroupPendingModifiedValues

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

The identifier for the replication group.
#snapshot_retention_limit ⇒ Integer

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
#snapshot_window ⇒ String

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

The cluster ID that is used as the daily snapshot source for the replication group.
#status ⇒ String

The current state of this replication group - ‘creating`, `available`, `modifying`, `deleting`, `create-failed`, `snapshotting`.
#transit_encryption_enabled ⇒ Boolean

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

Instance Attribute Details

#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 cluster is created. To enable encryption at-rest on a cluster you must set `AtRestEncryptionEnabled` to `true` when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version ‘3.2.6` or `4.x`.

Default: ‘false`

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_enabled ⇒ `Boolean`

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

Default: ‘false`

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_failover ⇒ `String`

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_enabled ⇒ `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).

Valid values: ‘true` | `false`

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_endpoint ⇒ `Types::Endpoint`

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

Returns:

(Types::Endpoint)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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

#description ⇒ `String`

The user supplied description of the replication group.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_clusters ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_groups ⇒ `Array<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>)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_values ⇒ `Types::ReplicationGroupPendingModifiedValues`

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

Returns:

(Types::ReplicationGroupPendingModifiedValues)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_id ⇒ `String`

The identifier for the replication group.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_limit ⇒ `Integer`

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_window ⇒ `String`

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 markdown=“1”> This parameter is only valid if the ‘Engine` parameter is `redis`.

</note>

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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

#status ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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_enabled ⇒ `Boolean`

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.

Required: Only available when creating a replication group in an Amazon VPC using redis version ‘3.2.6` or `4.x`.

Default: ‘false`

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 5018

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#at_rest_encryption_enabled ⇒ Boolean

#auth_token_enabled ⇒ Boolean

#automatic_failover ⇒ String

#cache_node_type ⇒ String

#cluster_enabled ⇒ Boolean

#configuration_endpoint ⇒ Types::Endpoint

#description ⇒ String

#member_clusters ⇒ Array<String>

#node_groups ⇒ Array<Types::NodeGroup>

#pending_modified_values ⇒ Types::ReplicationGroupPendingModifiedValues

#replication_group_id ⇒ String

#snapshot_retention_limit ⇒ Integer

#snapshot_window ⇒ String

#snapshotting_cluster_id ⇒ String

#status ⇒ String

#transit_encryption_enabled ⇒ Boolean

#at_rest_encryption_enabled ⇒ `Boolean`

#auth_token_enabled ⇒ `Boolean`

#automatic_failover ⇒ `String`

#cache_node_type ⇒ `String`

#cluster_enabled ⇒ `Boolean`

#configuration_endpoint ⇒ `Types::Endpoint`

#description ⇒ `String`

#member_clusters ⇒ `Array<String>`

#node_groups ⇒ `Array<Types::NodeGroup>`

#pending_modified_values ⇒ `Types::ReplicationGroupPendingModifiedValues`

#replication_group_id ⇒ `String`

#snapshot_retention_limit ⇒ `Integer`

#snapshot_window ⇒ `String`

#snapshotting_cluster_id ⇒ `String`

#status ⇒ `String`

#transit_encryption_enabled ⇒ `Boolean`