Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModifyReplicationGroupMessage

Represents the input of a ModifyReplicationGroups operation.

Hierarchy

Index

Properties

Optional ApplyImmediately

ApplyImmediately: undefined | false | true

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

Optional AuthToken

AuthToken: undefined | string

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', '%'

For more information, see AUTH password at AUTH.

Optional AuthTokenUpdateStrategy

AuthTokenUpdateStrategy: AuthTokenUpdateStrategyType | string

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

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 AutomaticFailoverEnabled

AutomaticFailoverEnabled: undefined | false | true

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Optional CacheNodeType

CacheNodeType: undefined | string

A valid cache node type that you want to scale this replication group to.

Optional CacheParameterGroupName

CacheParameterGroupName: undefined | string

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Optional CacheSecurityGroupNames

CacheSecurityGroupNames: string[]

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

Optional EngineVersion

EngineVersion: undefined | string

The upgraded version of the cache engine to be run on the clusters in the replication group.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

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 LogDeliveryConfigurations

LogDeliveryConfigurations: LogDeliveryConfigurationRequest[]

Specifies the destination, format and type of the logs.

Optional MultiAZEnabled

MultiAZEnabled: undefined | false | true

A flag to indicate MultiAZ is enabled.

Optional NodeGroupId

NodeGroupId: undefined | string
deprecated

Deprecated. This parameter is not used.

Optional NotificationTopicArn

NotificationTopicArn: undefined | string

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

The Amazon SNS topic owner must be same as the replication group owner.

Optional NotificationTopicStatus

NotificationTopicStatus: undefined | string

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

Optional PreferredMaintenanceWindow

PreferredMaintenanceWindow: undefined | string

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

Optional PrimaryClusterId

PrimaryClusterId: undefined | string

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Optional RemoveUserGroups

RemoveUserGroups: undefined | false | true

Removes the user group associated with this replication group.

Optional ReplicationGroupDescription

ReplicationGroupDescription: undefined | string

A description for the replication group. Maximum length is 255 characters.

ReplicationGroupId

ReplicationGroupId: string | undefined

The identifier of the replication group to modify.

Optional SecurityGroupIds

SecurityGroupIds: string[]

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Optional SnapshotRetentionLimit

SnapshotRetentionLimit: undefined | number

The number of days for which ElastiCache retains automatic node group (shard) 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.

Important 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 the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Optional SnapshottingClusterId

SnapshottingClusterId: undefined | string

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Optional UserGroupIdsToAdd

UserGroupIdsToAdd: string[]

The ID of the user group you are associating with the replication group.

Optional UserGroupIdsToRemove

UserGroupIdsToRemove: string[]

The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.