Skip to content

ClusterConfiguration

Source code in docs_src/capo_memorydb/types/cluster_configuration.py
class ClusterConfiguration(TypedDict, closed=True):
    name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the cluster</p>"""
    description: NotRequired["capo_memorydb.types.string.String"]
    """<p>The description of the cluster configuration</p>"""
    node_type: NotRequired["capo_memorydb.types.string.String"]
    """<p>The node type used for the cluster</p>"""
    engine: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the engine used by the cluster configuration.</p>"""
    engine_version: NotRequired["capo_memorydb.types.string.String"]
    """<p>The Redis OSS engine version used by the cluster</p>"""
    maintenance_window: NotRequired["capo_memorydb.types.string.String"]
    """<p>The specified maintenance window for the cluster</p>"""
    topic_arn: NotRequired["capo_memorydb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the SNS notification topic for the cluster</p>"""
    port: NotRequired["capo_memorydb.types.integer_optional.IntegerOptional"]
    """<p>The port used by the cluster</p>"""
    parameter_group_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of parameter group used by the cluster</p>"""
    subnet_group_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the subnet group used by the cluster</p>"""
    vpc_id: NotRequired["capo_memorydb.types.string.String"]
    """<p>The ID of the VPC the cluster belongs to</p>"""
    snapshot_retention_limit: NotRequired[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ]
    """<p>The snapshot retention limit set by the cluster</p>"""
    snapshot_window: NotRequired["capo_memorydb.types.string.String"]
    """<p>The snapshot window set by the cluster</p>"""
    num_shards: NotRequired["capo_memorydb.types.integer_optional.IntegerOptional"]
    """<p>The number of shards in the cluster</p>"""
    shards: NotRequired["capo_memorydb.types.shard_details.ShardDetails"]
    """<p>The list of shards in the cluster</p>"""
    multi_region_parameter_group_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the multi-Region parameter group associated with the cluster configuration.</p>"""
    multi_region_cluster_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name for the multi-Region cluster associated with the cluster configuration.</p>"""

description instance-attribute

description: NotRequired[String]

The description of the cluster configuration

engine instance-attribute

engine: NotRequired[String]

The name of the engine used by the cluster configuration.

engine_version instance-attribute

engine_version: NotRequired[String]

The Redis OSS engine version used by the cluster

maintenance_window instance-attribute

maintenance_window: NotRequired[String]

The specified maintenance window for the cluster

multi_region_cluster_name instance-attribute

multi_region_cluster_name: NotRequired[String]

The name for the multi-Region cluster associated with the cluster configuration.

multi_region_parameter_group_name instance-attribute

multi_region_parameter_group_name: NotRequired[String]

The name of the multi-Region parameter group associated with the cluster configuration.

name instance-attribute

name: NotRequired[String]

The name of the cluster

node_type instance-attribute

node_type: NotRequired[String]

The node type used for the cluster

num_shards instance-attribute

num_shards: NotRequired[IntegerOptional]

The number of shards in the cluster

parameter_group_name instance-attribute

parameter_group_name: NotRequired[String]

The name of parameter group used by the cluster

port instance-attribute

port: NotRequired[IntegerOptional]

The port used by the cluster

shards instance-attribute

shards: NotRequired[ShardDetails]

The list of shards in the cluster

snapshot_retention_limit instance-attribute

snapshot_retention_limit: NotRequired[IntegerOptional]

The snapshot retention limit set by the cluster

snapshot_window instance-attribute

snapshot_window: NotRequired[String]

The snapshot window set by the cluster

subnet_group_name instance-attribute

subnet_group_name: NotRequired[String]

The name of the subnet group used by the cluster

topic_arn instance-attribute

topic_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

vpc_id instance-attribute

vpc_id: NotRequired[String]

The ID of the VPC the cluster belongs to