ReplicationGroup ¶

class ReplicationGroup(TypedDict, closed=True):
    replication_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The identifier for the replication group.</p>"""
    description: NotRequired["capo_elasticache.types.string.String"]
    """<p>The user supplied description of the replication group.</p>"""
    global_replication_group_info: NotRequired[
        "capo_elasticache.types.global_replication_group_info.GlobalReplicationGroupInfo"
    ]
    """<p>The name of the Global datastore and role of this replication group in the Global datastore.</p>"""
    status: NotRequired["capo_elasticache.types.string.String"]
    """<p>The current state of this replication group - <code>creating</code>, <code>available</code>, <code>modifying</code>, <code>deleting</code>, <code>create-failed</code>, <code>snapshotting</code>.</p>"""
    pending_modified_values: NotRequired[
        "capo_elasticache.types.replication_group_pending_modified_values.ReplicationGroupPendingModifiedValues"
    ]
    """<p>A group of settings to be applied to the replication group, either immediately or during the next maintenance window.</p>"""
    member_clusters: NotRequired["capo_elasticache.types.cluster_id_list.ClusterIdList"]
    """<p>The names of all the cache clusters that are part of this replication group.</p>"""
    node_groups: NotRequired["capo_elasticache.types.node_group_list.NodeGroupList"]
    """<p>A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).</p>"""
    snapshotting_cluster_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The cluster ID that is used as the daily snapshot source for the replication group.</p>"""
    automatic_failover: NotRequired[
        "capo_elasticache.types.automatic_failover_status.AutomaticFailoverStatus"
    ]
    """<p>Indicates the status of automatic failover for this Valkey or Redis OSS replication group.</p>"""
    multi_az: NotRequired["capo_elasticache.types.multi_az_status.MultiAZStatus"]
    """<p>A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/AutoFailover.html">Minimizing Downtime: Multi-AZ</a> </p>"""
    configuration_endpoint: NotRequired["capo_elasticache.types.endpoint.Endpoint"]
    """<p>The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.</p>"""
    snapshot_retention_limit: NotRequired[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p> <important> <p> If the value of <code>SnapshotRetentionLimit</code> is set to zero (0), backups are turned off.</p> </important>"""
    snapshot_window: NotRequired["capo_elasticache.types.string.String"]
    """<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"""
    cluster_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).</p> <p>Valid values: <code>true</code> | <code>false</code> </p>"""
    cache_node_type: NotRequired["capo_elasticache.types.string.String"]
    """<p>The name of the compute and memory capacity node type for each node in the replication 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>"""
    auth_token_last_modified_date: NotRequired["capo_elasticache.types.t_stamp.TStamp"]
    """<p>The date the auth token was last modified</p>"""
    transit_encryption_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag that enables in-transit encryption when set to <code>true</code>.</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> <p>Default: <code>false</code> </p>"""
    at_rest_encryption_enabled: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A flag that enables encryption at-rest on the cluster when set to <code>true</code>. In some cases, encryption at-rest may be enabled even when this value is false. Use <code>StorageEncryptionType</code> to view the effective encryption state of a cluster.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the cluster is created.</p> <p>Default: <code>true</code> when using Valkey, <code>false</code> when using Redis OSS</p>"""
    member_clusters_outpost_arns: NotRequired[
        "capo_elasticache.types.replication_group_outpost_arn_list.ReplicationGroupOutpostArnList"
    ]
    """<p>The outpost ARNs of the replication group's member clusters.</p>"""
    kms_key_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ID of the KMS key used to encrypt the disk in the cluster.</p>"""
    storage_encryption_type: NotRequired[
        "capo_elasticache.types.storage_encryption_type.StorageEncryptionType"
    ]
    """<p>Indicates the type of encryption for data stored at rest in the replication group. The value is <code>none</code> if at-rest encryption is not enabled, <code>sse-elasticache</code> if an ElastiCache service-managed key is used, or <code>sse-kms</code> if a customer-managed KMS key is used.</p>"""
    arn: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ARN (Amazon Resource Name) of the replication group.</p>"""
    user_group_ids: NotRequired[
        "capo_elasticache.types.user_group_id_list.UserGroupIdList"
    ]
    """<p>The ID of the user group associated to the replication group.</p>"""
    log_delivery_configurations: NotRequired[
        "capo_elasticache.types.log_delivery_configuration_list.LogDeliveryConfigurationList"
    ]
    """<p>Returns the destination, format and type of the logs. </p>"""
    replication_group_create_time: NotRequired["capo_elasticache.types.t_stamp.TStamp"]
    """<p>The date and time when the cluster was created.</p>"""
    data_tiering: NotRequired[
        "capo_elasticache.types.data_tiering_status.DataTieringStatus"
    ]
    """<p>Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/data-tiering.html">Data tiering</a>.</p>"""
    auto_minor_version_upgrade: NotRequired["capo_elasticache.types.boolean.Boolean"]
    """<p>If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>"""
    network_type: NotRequired["capo_elasticache.types.network_type.NetworkType"]
    """<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. 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 <a href="http://aws.amazon.com/ec2/nitro/">Nitro system</a>.</p>"""
    ip_discovery: NotRequired["capo_elasticache.types.ip_discovery.IpDiscovery"]
    """<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. 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 <a href="http://aws.amazon.com/ec2/nitro/">Nitro system</a>.</p>"""
    transit_encryption_mode: NotRequired[
        "capo_elasticache.types.transit_encryption_mode.TransitEncryptionMode"
    ]
    """<p>A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.</p>"""
    cluster_mode: NotRequired["capo_elasticache.types.cluster_mode.ClusterMode"]
    """<p>Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.</p>"""
    engine: NotRequired["capo_elasticache.types.string.String"]
    """<p>The engine used in a replication group. The options are valkey, memcached or redis.</p>"""
    durability: NotRequired["capo_elasticache.types.durability.Durability"]
    """<p>The durability setting of the replication group. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/durability.html">Durability</a>.</p>"""
    effective_durability: NotRequired[
        "capo_elasticache.types.effective_durability.EffectiveDurability"
    ]
    """<p>The effective durability of the replication group. When <code>Durability</code> is set to <code>default</code>, the service resolves the actual durability based on the engine version, cluster mode, and other parameters. This field reflects the resolved value. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Durability.Configuring.html">Configuring Durability</a>.</p>"""