AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.ElastiCache.Model.ReplicationGroup

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z

Syntax

C#
public class ReplicationGroup

The ReplicationGroup type exposes the following members

Constructors

NameDescription
Public Method ReplicationGroup()

Properties

NameTypeDescription
Public Property AtRestEncryptionEnabled System.Boolean

Gets and sets the property AtRestEncryptionEnabled.

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

Public Property AuthTokenEnabled System.Boolean

Gets and sets the property AuthTokenEnabled.

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

Default: false

Public Property AutomaticFailover Amazon.ElastiCache.AutomaticFailoverStatus

Gets and sets the property AutomaticFailover.

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.

Public Property CacheNodeType System.String

Gets and sets the property CacheNodeType.

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

Public Property ClusterEnabled System.Boolean

Gets and sets the property ClusterEnabled.

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

Public Property ConfigurationEndpoint Amazon.ElastiCache.Model.Endpoint

Gets and sets the property ConfigurationEndpoint.

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

Public Property Description System.String

Gets and sets the property Description.

The user supplied description of the replication group.

Public Property MemberClusters System.Collections.Generic.List<System.String>

Gets and sets the property MemberClusters.

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

Public Property NodeGroups System.Collections.Generic.List<Amazon.ElastiCache.Model.NodeGroup>

Gets and sets the property NodeGroups.

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

Public Property PendingModifiedValues Amazon.ElastiCache.Model.ReplicationGroupPendingModifiedValues

Gets and sets the property PendingModifiedValues.

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

Public Property ReplicationGroupId System.String

Gets and sets the property ReplicationGroupId.

The identifier for the replication group.

Public Property SnapshotRetentionLimit System.Int32

Gets and sets the property SnapshotRetentionLimit.

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.

Public Property SnapshottingClusterId System.String

Gets and sets the property SnapshottingClusterId.

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

Public Property SnapshotWindow System.String

Gets and sets the property SnapshotWindow.

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.

Public Property Status System.String

Gets and sets the property Status.

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

Public Property TransitEncryptionEnabled System.Boolean

Gets and sets the property TransitEncryptionEnabled.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms