Class: Aws::ElastiCache::Types::ModifyCacheClusterMessage

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

Overview

Represents the input of a ‘ModifyCacheCluster` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 cluster.

If ‘false`, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ‘ModifyCacheCluster` before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: ‘true` | `false`

Default: ‘false`

Returns:

  • (Boolean) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  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` 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) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  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/dg/auth.html

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ Boolean

 If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

Returns:

  • (Boolean) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#az_mode ⇒ String

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: ‘single-az` | `cross-az`.

This option is only supported for Memcached clusters.

<note markdown=“1”> You cannot specify ‘single-az` if the Memcached cluster already has cache nodes in different Availability Zones. If `cross-az` is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability

Zones.

</note>

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_id ⇒ String

The cluster identifier. This value is stored as a lowercase string.

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_ids_to_remove ⇒ Array<String>

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when ‘NumCacheNodes` is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of `NumCacheNodes` in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ‘ModifyCacheCluster` call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Returns:

  • (Array<String>) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_type ⇒ String

A valid cache node type that you want to scale this cluster up to.

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#cache_parameter_group_name ⇒ String

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ‘ApplyImmediately` parameter is specified as `true` for this request.

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#cache_security_group_names ⇒ Array<String>

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created 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>) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

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

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  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) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#log_delivery_configurations ⇒ Array<Types::LogDeliveryConfigurationRequest>

Specifies the destination, format and type of the logs.

Returns:



6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#new_availability_zones ⇒ Array<String>

<note markdown=“1”> This option is only supported on Memcached clusters.

</note>

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when ‘NumCacheNodes` in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

Scenarios:

  • **Scenario 1:** You have 3 active nodes and wish to add 2 nodes. Specify ‘NumCacheNodes=5` (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • **Scenario 2:** You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify ‘NumCacheNodes=6` ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • **Scenario 3:** You want to cancel all pending operations. Specify ‘NumCacheNodes=3` to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting ‘NumCacheNodes` to the number of current nodes.

If ‘cross-az` is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the **Availability Zone Considerations** section of [Cache Node Considerations for Memcached].

**Impact of new add/remove requests upon pending requests**

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is **Apply Immediately

      • Yes**, all creates are performed immediately. If the new

      create request is **Apply Immediately - No**, all creates are pending.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html

Returns:

  • (Array<String>) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  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 cluster owner.

</note>

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#notification_topic_status ⇒ String

The status of the Amazon SNS notification topic. Notifications are sent only if the status is ‘active`.

Valid values: ‘active` | `inactive`

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#num_cache_nodes ⇒ Integer

The number of cache nodes that the cluster should have. If the value for ‘NumCacheNodes` is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the ‘CacheNodeIdsToRemove` parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

<note markdown=“1”> Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ‘ApplyImmediately`).

A pending operation to modify the number of cache nodes in a cluster

during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer’s latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ‘ModifyCacheCluster` request and set `NumCacheNodes` equal to the number of cache nodes currently in the cluster.

</note>

Returns:

  • (Integer) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  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) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Returns:

  • (Array<String>) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limit ⇒ Integer

The number of days for which ElastiCache retains automatic cluster 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.

<note markdown=“1”> If the value of ‘SnapshotRetentionLimit` is set to zero (0), backups are turned off.

</note>

Returns:

  • (Integer) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_window ⇒ String

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Returns:

  • (String) 


6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
 
# File 'lib/aws-sdk-elasticache/types.rb', line 6119

class ModifyCacheClusterMessage < Struct.new(
  :cache_cluster_id,
  :num_cache_nodes,
  :cache_node_ids_to_remove,
  :az_mode,
  :new_availability_zones,
  :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,
  :log_delivery_configurations,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end