Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReplicationGroup

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

Hierarchy

  • ReplicationGroup

Index

Properties

Optional ARN

ARN: undefined | string

The ARN (Amazon Resource Name) of the replication group.

Optional AtRestEncryptionEnabled

AtRestEncryptionEnabled: undefined | false | true

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, 4.x or later.

Default: false

Optional AuthTokenEnabled

AuthTokenEnabled: undefined | false | true

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

Default: false

Optional AuthTokenLastModifiedDate

AuthTokenLastModifiedDate: Date

The date the auth token was last modified

Optional AutoMinorVersionUpgrade

AutoMinorVersionUpgrade: undefined | false | true

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Optional AutomaticFailover

AutomaticFailover: AutomaticFailoverStatus | string

Indicates the status of automatic failover for this Redis replication group.

Optional CacheNodeType

CacheNodeType: undefined | string

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

Optional ClusterEnabled

ClusterEnabled: undefined | false | true

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

Optional ConfigurationEndpoint

ConfigurationEndpoint: Endpoint

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

Optional DataTiering

DataTiering: DataTieringStatus | string

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Optional Description

Description: undefined | string

The user supplied description of the replication group.

Optional GlobalReplicationGroupInfo

GlobalReplicationGroupInfo: GlobalReplicationGroupInfo

The name of the Global datastore and role of this replication group in the Global datastore.

Optional IpDiscovery

IpDiscovery: IpDiscovery | string

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

Optional KmsKeyId

KmsKeyId: undefined | string

The ID of the KMS key used to encrypt the disk in the cluster.

Optional LogDeliveryConfigurations

LogDeliveryConfigurations: LogDeliveryConfiguration[]

Returns the destination, format and type of the logs.

Optional MemberClusters

MemberClusters: string[]

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

Optional MemberClustersOutpostArns

MemberClustersOutpostArns: string[]

The outpost ARNs of the replication group's member clusters.

Optional MultiAZ

MultiAZ: MultiAZStatus | string

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

Optional NetworkType

NetworkType: NetworkType | string

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

Optional NodeGroups

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

Optional PendingModifiedValues

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

Optional ReplicationGroupCreateTime

ReplicationGroupCreateTime: Date

The date and time when the cluster was created.

Optional ReplicationGroupId

ReplicationGroupId: undefined | string

The identifier for the replication group.

Optional SnapshotRetentionLimit

SnapshotRetentionLimit: undefined | number

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.

Optional SnapshotWindow

SnapshotWindow: undefined | 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.

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

Optional SnapshottingClusterId

SnapshottingClusterId: undefined | string

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

Optional Status

Status: undefined | string

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

Optional TransitEncryptionEnabled

TransitEncryptionEnabled: undefined | false | true

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, 4.x or later.

Default: false

Optional UserGroupIds

UserGroupIds: string[]

The ID of the user group associated to the replication group.