Skip to content

ModifyGlobalReplicationGroupMessage

Source code in docs_src/capo_elasticache/types/modify_global_replication_group_message.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ModifyGlobalReplicationGroupMessage(TypedDict, closed=True):
    global_replication_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The name of the Global datastore</p>"""
    apply_immediately: NotRequired["capo_elasticache.types.boolean.Boolean"]
    """<p>This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow. </p>"""
    cache_node_type: NotRequired["capo_elasticache.types.string.String"]
    """<p>A valid cache node type that you want to scale this Global datastore to.</p>"""
    engine: NotRequired["capo_elasticache.types.string.String"]
    """<p>Modifies the engine listed in a global replication group message. The options are valkey, memcached or redis.</p>"""
    engine_version: NotRequired["capo_elasticache.types.string.String"]
    """<p>The upgraded version of the cache engine to be run on the clusters in the Global datastore. </p>"""
    cache_parameter_group_name: NotRequired["capo_elasticache.types.string.String"]
    """<p>The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.</p>"""
    global_replication_group_description: NotRequired[
        "capo_elasticache.types.string.String"
    ]
    """<p>A description of the Global datastore</p>"""
    automatic_failover_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. </p>"""

apply_immediately instance-attribute 

apply_immediately: NotRequired[Boolean]

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

automatic_failover_enabled instance-attribute 

automatic_failover_enabled: NotRequired[BooleanOptional]

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

cache_node_type instance-attribute 

cache_node_type: NotRequired[String]

A valid cache node type that you want to scale this Global datastore to.

cache_parameter_group_name instance-attribute 

cache_parameter_group_name: NotRequired[String]

The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

engine instance-attribute 

engine: NotRequired[String]

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

engine_version instance-attribute 

engine_version: NotRequired[String]

The upgraded version of the cache engine to be run on the clusters in the Global datastore.

global_replication_group_description instance-attribute 

global_replication_group_description: NotRequired[String]

A description of the Global datastore

global_replication_group_id instance-attribute 

global_replication_group_id: NotRequired[String]

The name of the Global datastore