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

Class: Aws::ElastiCache::Types::ModifyReplicationGroupMessage

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

Overview

Note:

When passing ModifyReplicationGroupMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  replication_group_id: "String", # required
  replication_group_description: "String",
  primary_cluster_id: "String",
  snapshotting_cluster_id: "String",
  automatic_failover_enabled: false,
  cache_security_group_names: ["String"],
  security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  cache_parameter_group_name: "String",
  notification_topic_status: "String",
  apply_immediately: false,
  engine_version: "String",
  auto_minor_version_upgrade: false,
  snapshot_retention_limit: 1,
  snapshot_window: "String",
  cache_node_type: "String",
  node_group_id: "String",
}

Represents the input of a ModifyReplicationGroups operation.

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

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

Returns:

  • (Boolean)

    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.

#auto_minor_version_upgradeBoolean

This parameter is currently disabled.

Returns:

  • (Boolean)

    This parameter is currently disabled.

#automatic_failover_enabledBoolean

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

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported 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:

  • (Boolean)

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

#cache_node_typeString

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

Returns:

  • (String)

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

#cache_parameter_group_nameString

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.

Returns:

  • (String)

    The name of the cache parameter group to apply to all of the clusters in this replication group.

#cache_security_group_namesArray<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 cache clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

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

Returns:

  • (Array<String>)

    A list of cache security group names to authorize for the clusters in this replication group.

#engine_versionString

The upgraded version of the cache engine to be run on the cache 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.

Returns:

  • (String)

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

#node_group_idString

The name of the Node Group (called shard in the console).

Returns:

  • (String)

    The name of the Node Group (called shard in the console).

#notification_topic_arnString

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.

Returns:

  • (String)

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

#notification_topic_statusString

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

Returns:

  • (String)

    The status of the Amazon SNS notification topic for the replication group.

#preferred_maintenance_windowString

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

Returns:

  • (String)

    Specifies the weekly time range during which maintenance on the cluster is performed.

#primary_cluster_idString

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.

Returns:

  • (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.

#replication_group_descriptionString

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

Returns:

  • (String)

    A description for the replication group.

#replication_group_idString

The identifier of the replication group to modify.

Returns:

  • (String)

    The identifier of the replication group to modify.

#security_group_idsArray<String>

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

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

Returns:

  • (Array<String>)

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

#snapshot_retention_limitInteger

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.

Returns:

  • (Integer)

    The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.

#snapshot_windowString

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.

Returns:

  • (String)

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

#snapshotting_cluster_idString

The cache 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.

Returns:

  • (String)

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