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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/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,
  multi_az_enabled: false,
  node_group_id: "String",
  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",
  auth_token: "String",
  auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
  user_group_ids_to_add: ["UserGroupId"],
  user_group_ids_to_remove: ["UserGroupId"],
  remove_user_groups: false,
}

Represents the input of a ModifyReplicationGroups operation.

Constant Summary collapse

SENSITIVE =
[]

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)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#auth_tokenString

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.

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#auth_token_update_strategyString

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

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

This parameter is currently disabled.

Returns:

  • (Boolean)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

  • (Boolean)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_typeString

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

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

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.

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az_enabledBoolean

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

Returns:

  • (Boolean)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#node_group_idString

Deprecated. This parameter is not used.

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#remove_user_groupsBoolean

Removes the user groups that can access this replication group.

Returns:

  • (Boolean)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_descriptionString

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

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_idString

The identifier of the replication group to modify.

Returns:

  • (String)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<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>)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

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


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#snapshotting_cluster_idString

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)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_ids_to_addArray<String>

A list of user group IDs.

Returns:

  • (Array<String>)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_ids_to_removeArray<String>

A list of users groups to remove, meaning the users in the group no longer can access thereplication group.

Returns:

  • (Array<String>)


6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6255

class ModifyReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :replication_group_description,
  :primary_cluster_id,
  :snapshotting_cluster_id,
  :automatic_failover_enabled,
  :multi_az_enabled,
  :node_group_id,
  :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,
  :auth_token,
  :auth_token_update_strategy,
  :user_group_ids_to_add,
  :user_group_ids_to_remove,
  :remove_user_groups)
  SENSITIVE = []
  include Aws::Structure
end