Skip to content

UpdateClusterRequest

Source code in docs_src/capo_memorydb/types/update_cluster_request.py
class UpdateClusterRequest(TypedDict, closed=True):
    cluster_name: "capo_memorydb.types.string.String"
    """<p>The name of the cluster to update.</p>"""
    description: NotRequired["capo_memorydb.types.string.String"]
    """<p>The description of the cluster to update.</p>"""
    security_group_ids: NotRequired[
        "capo_memorydb.types.security_group_ids_list.SecurityGroupIdsList"
    ]
    """<p>The SecurityGroupIds to update.</p>"""
    maintenance_window: NotRequired["capo_memorydb.types.string.String"]
    """<p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"""
    sns_topic_arn: NotRequired["capo_memorydb.types.string.String"]
    """<p>The SNS topic ARN to update.</p>"""
    sns_topic_status: NotRequired["capo_memorydb.types.string.String"]
    """<p>The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.</p>"""
    parameter_group_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the parameter group to update.</p>"""
    snapshot_window: NotRequired["capo_memorydb.types.string.String"]
    """<p>The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.</p>"""
    snapshot_retention_limit: NotRequired[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of days for which MemoryDB 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.</p>"""
    node_type: NotRequired["capo_memorydb.types.string.String"]
    """<p>A valid node type that you want to scale this cluster up or down to.</p>"""
    engine: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the engine to be used for the cluster.</p>"""
    engine_version: NotRequired["capo_memorydb.types.string.String"]
    """<p>The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine 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.</p>"""
    replica_configuration: NotRequired[
        "capo_memorydb.types.replica_configuration_request.ReplicaConfigurationRequest"
    ]
    """<p>The number of replicas that will reside in each shard.</p>"""
    shard_configuration: NotRequired[
        "capo_memorydb.types.shard_configuration_request.ShardConfigurationRequest"
    ]
    """<p>The number of shards in the cluster.</p>"""
    acl_name: NotRequired["capo_memorydb.types.acl_name.ACLName"]
    """<p>The Access Control List that is associated with the cluster.</p>"""
    ip_discovery: NotRequired["capo_memorydb.types.ip_discovery.IpDiscovery"]
    """<p>The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes will return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.</p>"""

acl_name instance-attribute

acl_name: NotRequired[ACLName]

The Access Control List that is associated with the cluster.

cluster_name instance-attribute

cluster_name: String

The name of the cluster to update.

description instance-attribute

description: NotRequired[String]

The description of the cluster to update.

engine instance-attribute

engine: NotRequired[String]

The name of the engine to be used for the cluster.

engine_version instance-attribute

engine_version: NotRequired[String]

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine 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.

ip_discovery instance-attribute

ip_discovery: NotRequired[IpDiscovery]

The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes will return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.

maintenance_window instance-attribute

maintenance_window: NotRequired[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

node_type instance-attribute

node_type: NotRequired[String]

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

parameter_group_name instance-attribute

parameter_group_name: NotRequired[String]

The name of the parameter group to update.

replica_configuration instance-attribute

replica_configuration: NotRequired[ReplicaConfigurationRequest]

The number of replicas that will reside in each shard.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdsList]

The SecurityGroupIds to update.

shard_configuration instance-attribute

shard_configuration: NotRequired[ShardConfigurationRequest]

The number of shards in the cluster.

snapshot_retention_limit instance-attribute

snapshot_retention_limit: NotRequired[IntegerOptional]

The number of days for which MemoryDB 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.

snapshot_window instance-attribute

snapshot_window: NotRequired[String]

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

sns_topic_arn instance-attribute

sns_topic_arn: NotRequired[String]

The SNS topic ARN to update.

sns_topic_status instance-attribute

sns_topic_status: NotRequired[String]

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