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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass ModifyReplicationGroupMessage data as a 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ 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.

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) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ Boolean

This parameter is currently disabled.

Returns:

  • (Boolean) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#automatic_failover_enabled ⇒ Boolean

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

Valid values: ‘true` | `false`

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:

  • (Boolean) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#cache_node_type ⇒ String

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

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#cache_parameter_group_name ⇒ 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.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#cache_security_group_names ⇒ Array<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`.

Returns:

  • (Array<String>) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#engine_version ⇒ 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.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#node_group_id ⇒ String

Deprecated. This parameter is not used.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#notification_topic_arn ⇒ String

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

<note markdown=“1”> The Amazon SNS topic owner must be same as the replication group owner.

</note>

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#notification_topic_status ⇒ 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`

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#preferred_maintenance_window ⇒ 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`

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#primary_cluster_id ⇒ 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.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#replication_group_description ⇒ String

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

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#replication_group_id ⇒ String

The identifier of the replication group to modify.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#security_group_ids ⇒ Array<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).

Returns:

  • (Array<String>) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#snapshot_retention_limit ⇒ Integer

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) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#snapshot_window ⇒ 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.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end

#snapshotting_cluster_id ⇒ 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.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
 
# File 'lib/aws-sdk-elasticache/types.rb', line 4283

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :cache_security_group_names,
  :security_group_ids,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :cache_parameter_group_name,
  :notification_topic_status,
  :apply_immediately,
  :engine_version,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :cache_node_type,
  :node_group_id)
  include Aws::Structure
end