Skip to content

GlobalReplicationGroup

Source code in docs_src/capo_elasticache/types/global_replication_group.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class GlobalReplicationGroup(TypedDict, closed=True):
    global_replication_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The name of the Global datastore</p>"""
    global_replication_group_description: NotRequired[
        "capo_elasticache.types.string.String"
    ]
    """<p>The optional description of the Global datastore</p>"""
    status: NotRequired["capo_elasticache.types.string.String"]
    """<p>The status of the Global datastore</p>"""
    cache_node_type: NotRequired["capo_elasticache.types.string.String"]
    """<p>The cache node type of the Global datastore</p>"""
    engine: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ElastiCache engine. For Valkey or Redis OSS only.</p>"""
    engine_version: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ElastiCache engine version.</p>"""
    members: NotRequired[
        "capo_elasticache.types.global_replication_group_member_list.GlobalReplicationGroupMemberList"
    ]
    """<p>The replication groups that comprise the Global datastore.</p>"""
    cluster_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag that indicates whether the Global datastore is cluster enabled.</p>"""
    global_node_groups: NotRequired[
        "capo_elasticache.types.global_node_group_list.GlobalNodeGroupList"
    ]
    """<p>Indicates the slot configuration and global identifier for each slice group.</p>"""
    auth_token_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Valkey or Redis OSS commands.</p> <p>Default: <code>false</code> </p>"""
    transit_encryption_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag that enables in-transit encryption when set to true.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using Redis OSS version <code>3.2.6</code>, <code>4.x</code> or later.</p>"""
    at_rest_encryption_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using Redis OSS version <code>3.2.6</code>, <code>4.x</code> or later.</p>"""
    arn: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ARN (Amazon Resource Name) of the global replication group.</p>"""

arn instance-attribute 

arn: NotRequired[String]

The ARN (Amazon Resource Name) of the global replication group.

at_rest_encryption_enabled instance-attribute 

at_rest_encryption_enabled: NotRequired[BooleanOptional]

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

auth_token_enabled instance-attribute 

auth_token_enabled: NotRequired[BooleanOptional]

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

cache_node_type instance-attribute 

cache_node_type: NotRequired[String]

The cache node type of the Global datastore

cluster_enabled instance-attribute 

cluster_enabled: NotRequired[BooleanOptional]

A flag that indicates whether the Global datastore is cluster enabled.

engine instance-attribute 

engine: NotRequired[String]

The ElastiCache engine. For Valkey or Redis OSS only.

engine_version instance-attribute 

engine_version: NotRequired[String]

The ElastiCache engine version.

global_node_groups instance-attribute 

global_node_groups: NotRequired[GlobalNodeGroupList]

Indicates the slot configuration and global identifier for each slice group.

global_replication_group_description instance-attribute 

global_replication_group_description: NotRequired[String]

The optional description of the Global datastore

global_replication_group_id instance-attribute 

global_replication_group_id: NotRequired[String]

The name of the Global datastore

members instance-attribute 

members: NotRequired[GlobalReplicationGroupMemberList]

The replication groups that comprise the Global datastore.

status instance-attribute 

status: NotRequired[String]

The status of the Global datastore

transit_encryption_enabled instance-attribute 

transit_encryption_enabled: NotRequired[BooleanOptional]

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.