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

Inherits:

Struct

Object
Struct
Aws::ElastiCache::Types::ModifyReplicationGroupMessage

show all

Includes:: Structure

Defined in:: lib/aws-sdk-elasticache/types.rb

Overview

Represents the input of a ‘ModifyReplicationGroups` operation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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.
#auth_token ⇒ String

Reserved parameter.
#auth_token_update_strategy ⇒ String

Specifies the strategy to use to update the AUTH token.
#auto_minor_version_upgrade ⇒ Boolean

If you are running Valkey or Redis OSS 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.
#automatic_failover_enabled ⇒ Boolean

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

A valid cache node type that you want to scale this replication group to.
#cache_parameter_group_name ⇒ String

The name of the cache parameter group to apply to all of the clusters in this replication group.
#cache_security_group_names ⇒ Array<String>

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

Enabled or Disabled.
#engine ⇒ String

Modifies the engine listed in a replication group message.
#engine_version ⇒ String

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

The network type you choose when modifying a cluster, either ‘ipv4` | `ipv6`.
#log_delivery_configurations ⇒ Array<Types::LogDeliveryConfigurationRequest>

Specifies the destination, format and type of the logs.
#multi_az_enabled ⇒ Boolean

A flag to indicate MultiAZ is enabled.
#node_group_id ⇒ String

Deprecated.
#notification_topic_arn ⇒ String

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

The status of the Amazon SNS notification topic for the replication group.
#preferred_maintenance_window ⇒ String

Specifies the weekly time range during which maintenance on the cluster is performed.
#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.
#remove_user_groups ⇒ Boolean

Removes the user group associated with this replication group.
#replication_group_description ⇒ String

A description for the replication group.
#replication_group_id ⇒ String

The identifier of the replication group to modify.
#security_group_ids ⇒ Array<String>

Specifies the VPC Security Groups associated with the clusters in the replication group.
#snapshot_retention_limit ⇒ Integer

The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
#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`.
#snapshotting_cluster_id ⇒ String

The cluster ID that is used as the daily snapshot source for the replication group.
#transit_encryption_enabled ⇒ Boolean

A flag that enables in-transit encryption when set to true.
#transit_encryption_mode ⇒ String

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
#user_group_ids_to_add ⇒ Array<String>

The ID of the user group you are associating with the replication group.
#user_group_ids_to_remove ⇒ Array<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.

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#auth_token ⇒ `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].

[1]: redis.io/commands/AUTH

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#auth_token_update_strategy ⇒ `String`

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

ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC

For more information, see [Authenticating Users with AUTH]

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

If you are running Valkey or Redis OSS 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.

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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`

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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>)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_mode ⇒ `String`

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#ip_discovery ⇒ `String`

The network type you choose when modifying a cluster, either ‘ipv4` | `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

[1]: aws.amazon.com/ec2/nitro/

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#log_delivery_configurations ⇒ `Array<Types::LogDeliveryConfigurationRequest>`

Specifies the destination, format and type of the logs.

Returns:

(Array<Types::LogDeliveryConfigurationRequest>)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az_enabled ⇒ `Boolean`

A flag to indicate MultiAZ is enabled.

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#node_group_id ⇒ `String`

Deprecated. This parameter is not used.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#remove_user_groups ⇒ `Boolean`

Removes the user group associated with this replication group.

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_description ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_id ⇒ `String`

The identifier of the replication group to modify.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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>)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  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 Valkey or Redis OSS (cluster mode enabled) replication groups.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryption_enabled ⇒ `Boolean`

A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set ‘TransitEncryptionMode` to `preferred`.

Returns:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryption_mode ⇒ `String`

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

You must set ‘TransitEncryptionEnabled` to `true`, for your existing cluster, and set `TransitEncryptionMode` to `preferred` in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set the value to `required` to allow encrypted connections only.

Setting ‘TransitEncryptionMode` to `required` is a two-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_ids_to_add ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-elasticache/types.rb', line 6585

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,
  :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,
  :log_delivery_configurations,
  :ip_discovery,
  :transit_encryption_enabled,
  :transit_encryption_mode,
  :cluster_mode)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

#auth_token ⇒ String

#auth_token_update_strategy ⇒ String

#auto_minor_version_upgrade ⇒ Boolean

#automatic_failover_enabled ⇒ Boolean

#cache_node_type ⇒ String

#cache_parameter_group_name ⇒ String

#cache_security_group_names ⇒ Array<String>

#cluster_mode ⇒ String

#engine ⇒ String

#engine_version ⇒ String

#ip_discovery ⇒ String

#log_delivery_configurations ⇒ Array<Types::LogDeliveryConfigurationRequest>

#multi_az_enabled ⇒ Boolean

#node_group_id ⇒ String

#notification_topic_arn ⇒ String

#notification_topic_status ⇒ String

#preferred_maintenance_window ⇒ String

#primary_cluster_id ⇒ String

#remove_user_groups ⇒ Boolean

#replication_group_description ⇒ String

#replication_group_id ⇒ String

#security_group_ids ⇒ Array<String>

#snapshot_retention_limit ⇒ Integer

#snapshot_window ⇒ String

#snapshotting_cluster_id ⇒ String

#transit_encryption_enabled ⇒ Boolean

#transit_encryption_mode ⇒ String

#user_group_ids_to_add ⇒ Array<String>

#user_group_ids_to_remove ⇒ Array<String>

#apply_immediately ⇒ `Boolean`

#auth_token ⇒ `String`

#auth_token_update_strategy ⇒ `String`

#auto_minor_version_upgrade ⇒ `Boolean`

#automatic_failover_enabled ⇒ `Boolean`

#cache_node_type ⇒ `String`

#cache_parameter_group_name ⇒ `String`

#cache_security_group_names ⇒ `Array<String>`

#cluster_mode ⇒ `String`

#engine ⇒ `String`

#engine_version ⇒ `String`

#ip_discovery ⇒ `String`

#log_delivery_configurations ⇒ `Array<Types::LogDeliveryConfigurationRequest>`

#multi_az_enabled ⇒ `Boolean`

#node_group_id ⇒ `String`

#notification_topic_arn ⇒ `String`

#notification_topic_status ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#primary_cluster_id ⇒ `String`

#remove_user_groups ⇒ `Boolean`

#replication_group_description ⇒ `String`

#replication_group_id ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#snapshot_retention_limit ⇒ `Integer`

#snapshot_window ⇒ `String`

#snapshotting_cluster_id ⇒ `String`

#transit_encryption_enabled ⇒ `Boolean`

#transit_encryption_mode ⇒ `String`

#user_group_ids_to_add ⇒ `Array<String>`

#user_group_ids_to_remove ⇒ `Array<String>`