Builder

class Builder

Properties

Link copied to clipboard

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.

Link copied to clipboard

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The engine type used by the cache cluster. The options are valkey, memcached or redis.

Link copied to clipboard

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

Link copied to clipboard

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 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Link copied to clipboard

Specifies the destination, format and type of the logs.

Link copied to clipboard

This option is only supported on Memcached clusters.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.

Link copied to clipboard

Specifies the VPC Security Groups associated with the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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

Functions

Link copied to clipboard