Skip to content

create_cache_cluster async

create_cache_cluster(
    *,
    config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
    cache_cluster_id: Optional[String] = None,
    replication_group_id: Optional[String] = None,
    az_mode: Optional[AZMode] = None,
    preferred_availability_zone: Optional[String] = None,
    preferred_availability_zones: Optional[PreferredAvailabilityZoneList] = None,
    num_cache_nodes: Optional[IntegerOptional] = None,
    cache_node_type: Optional[String] = None,
    engine: Optional[String] = None,
    engine_version: Optional[String] = None,
    cache_parameter_group_name: Optional[String] = None,
    cache_subnet_group_name: Optional[String] = None,
    cache_security_group_names: Optional[CacheSecurityGroupNameList] = None,
    security_group_ids: Optional[SecurityGroupIdsList] = None,
    tags: Optional[TagList] = None,
    snapshot_arns: Optional[SnapshotArnsList] = None,
    snapshot_name: Optional[String] = None,
    preferred_maintenance_window: Optional[String] = None,
    port: Optional[IntegerOptional] = None,
    notification_topic_arn: Optional[String] = None,
    auto_minor_version_upgrade: Optional[BooleanOptional] = None,
    snapshot_retention_limit: Optional[IntegerOptional] = None,
    snapshot_window: Optional[String] = None,
    auth_token: Optional[String] = None,
    outpost_mode: Optional[OutpostMode] = None,
    preferred_outpost_arn: Optional[String] = None,
    preferred_outpost_arns: Optional[PreferredOutpostArnList] = None,
    log_delivery_configurations: Optional[LogDeliveryConfigurationRequestList] = None,
    transit_encryption_enabled: Optional[BooleanOptional] = None,
    network_type: Optional[NetworkType] = None,
    ip_discovery: Optional[IpDiscovery] = None,
) -> CreateCacheClusterResult

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.

This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

Parameters:

  • cache_cluster_id (Optional[String], default: None ) –

    The node group (shard) identifier. This parameter is stored as a lowercase string.

    Constraints:

    • A name must contain from 1 to 50 alphanumeric characters or hyphens.

    • The first character must be a letter.

    • A name cannot end with a hyphen or contain two consecutive hyphens.

  • replication_group_id (Optional[String], default: None ) –

    The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

    If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

    This parameter is only valid if the Engine parameter is redis.

  • az_mode (Optional[AZMode], default: None ) –

    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

    This parameter is only supported for Memcached clusters.

    If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

  • preferred_availability_zone (Optional[String], default: None ) –

    The EC2 Availability Zone in which the cluster is created.

    All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

    Default: System chosen Availability Zone.

  • preferred_availability_zones (Optional[PreferredAvailabilityZoneList], default: None ) –

    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

    This option is only supported on Memcached.

    If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of NumCacheNodes.

    If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

    Default: System chosen Availability Zones.

  • num_cache_nodes (Optional[IntegerOptional], default: None ) –

    The initial number of cache nodes that the cluster has.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

  • cache_node_type (Optional[String], default: None ) –

    The compute and memory capacity of the nodes in the node group (shard).

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

        For region availability, see Supported Node Types

        M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

        For region availability, see Supported Node Types

        R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.

    • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

    • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

  • engine (Optional[String], default: None ) –

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

    Valid values for this parameter are: memcached | redis

  • engine_version (Optional[String], default: None ) –

    The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and 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 or replication group and create it anew with the earlier engine version.

  • cache_parameter_group_name (Optional[String], default: None ) –

    The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

  • cache_subnet_group_name (Optional[String], default: None ) –

    The name of the subnet group to be used for the cluster.

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

    If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

  • cache_security_group_names (Optional[CacheSecurityGroupNameList], default: None ) –

    A list of security group names to associate with this cluster.

    Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

  • security_group_ids (Optional[SecurityGroupIdsList], default: None ) –

    One or more VPC security groups associated with the cluster.

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

  • tags (Optional[TagList], default: None ) –

    A list of tags to be added to this resource.

  • snapshot_arns (Optional[SnapshotArnsList], default: None ) –

    A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

    This parameter is only valid if the Engine parameter is redis.

    Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

  • snapshot_name (Optional[String], default: None ) –

    The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

    This parameter is only valid if the Engine parameter is redis.

  • preferred_maintenance_window (Optional[String], default: None ) –

    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.

  • port (Optional[IntegerOptional], default: None ) –

    The port number on which each of the cache nodes accepts connections.

  • notification_topic_arn (Optional[String], default: None ) –

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    The Amazon SNS topic owner must be the same as the cluster owner.

  • auto_minor_version_upgrade (Optional[BooleanOptional], default: None ) –

    If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

  • snapshot_retention_limit (Optional[IntegerOptional], default: None ) –

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

    This parameter is only valid if the Engine parameter is redis.

    Default: 0 (i.e., automatic backups are disabled for this cache cluster).

  • snapshot_window (Optional[String], default: None ) –

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    This parameter is only valid if the Engine parameter is redis.

  • auth_token (Optional[String], default: None ) –

    Reserved parameter. The password used to access a password protected server.

    Password constraints:

    • Must be only printable ASCII characters.

    • Must be at least 16 characters and no more than 128 characters in length.

    • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

  • outpost_mode (Optional[OutpostMode], default: None ) –

    Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

  • preferred_outpost_arn (Optional[String], default: None ) –

    The outpost ARN in which the cache cluster is created.

  • preferred_outpost_arns (Optional[PreferredOutpostArnList], default: None ) –

    The outpost ARNs in which the cache cluster is created.

  • log_delivery_configurations (Optional[LogDeliveryConfigurationRequestList], default: None ) –

    Specifies the destination, format and type of the logs.

  • transit_encryption_enabled (Optional[BooleanOptional], default: None ) –

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

  • network_type (Optional[NetworkType], default: None ) –

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

  • ip_discovery (Optional[IpDiscovery], default: None ) –

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Raises:

Examples:

CreateCacheCluster Creates a Memcached cluster with 2 nodes.

>>> await client.create_cache_cluster(cache_cluster_id='my-memcached-cluster', az_mode='cross-az', num_cache_nodes=2, cache_node_type='cache.r3.large', engine='memcached', engine_version='1.4.24', cache_subnet_group_name='default', port=11211)
CreateCacheCluster
Creates a Redis cluster with 1 node.
>>> await client.create_cache_cluster(cache_cluster_id='my-redis', preferred_availability_zone='us-east-1c', num_cache_nodes=1, cache_node_type='cache.r3.larage', engine='redis', engine_version='3.2.4', cache_subnet_group_name='default', port=6379, snapshot_retention_limit=7, auto_minor_version_upgrade=True)
Source code in docs_src/capo_elasticache/_services/async_elasti_cache.py
async def create_cache_cluster(
    self,
    *,
    config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
    cache_cluster_id: Optional["capo_elasticache.types.string.String"] = None,
    replication_group_id: Optional["capo_elasticache.types.string.String"] = None,
    az_mode: Optional["capo_elasticache.types.az_mode.AZMode"] = None,
    preferred_availability_zone: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    preferred_availability_zones: Optional[
        "capo_elasticache.types.preferred_availability_zone_list.PreferredAvailabilityZoneList"
    ] = None,
    num_cache_nodes: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    cache_node_type: Optional["capo_elasticache.types.string.String"] = None,
    engine: Optional["capo_elasticache.types.string.String"] = None,
    engine_version: Optional["capo_elasticache.types.string.String"] = None,
    cache_parameter_group_name: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    cache_subnet_group_name: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    cache_security_group_names: Optional[
        "capo_elasticache.types.cache_security_group_name_list.CacheSecurityGroupNameList"
    ] = None,
    security_group_ids: Optional[
        "capo_elasticache.types.security_group_ids_list.SecurityGroupIdsList"
    ] = None,
    tags: Optional["capo_elasticache.types.tag_list.TagList"] = None,
    snapshot_arns: Optional[
        "capo_elasticache.types.snapshot_arns_list.SnapshotArnsList"
    ] = None,
    snapshot_name: Optional["capo_elasticache.types.string.String"] = None,
    preferred_maintenance_window: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    port: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    notification_topic_arn: Optional["capo_elasticache.types.string.String"] = None,
    auto_minor_version_upgrade: Optional[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ] = None,
    snapshot_retention_limit: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    snapshot_window: Optional["capo_elasticache.types.string.String"] = None,
    auth_token: Optional["capo_elasticache.types.string.String"] = None,
    outpost_mode: Optional[
        "capo_elasticache.types.outpost_mode.OutpostMode"
    ] = None,
    preferred_outpost_arn: Optional["capo_elasticache.types.string.String"] = None,
    preferred_outpost_arns: Optional[
        "capo_elasticache.types.preferred_outpost_arn_list.PreferredOutpostArnList"
    ] = None,
    log_delivery_configurations: Optional[
        "capo_elasticache.types.log_delivery_configuration_request_list.LogDeliveryConfigurationRequestList"
    ] = None,
    transit_encryption_enabled: Optional[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ] = None,
    network_type: Optional[
        "capo_elasticache.types.network_type.NetworkType"
    ] = None,
    ip_discovery: Optional[
        "capo_elasticache.types.ip_discovery.IpDiscovery"
    ] = None,
) -> "capo_elasticache.types.create_cache_cluster_result.CreateCacheClusterResult":
    """<p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.</p> <p>This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.</p>

    Args:
        cache_cluster_id: <p>The node group (shard) identifier. This parameter is stored as a lowercase string.</p> <p> <b>Constraints:</b> </p> <ul> <li> <p>A name must contain from 1 to 50 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
        replication_group_id: <p>The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.</p> <p>If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>
        az_mode: <p>Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.</p> <p>This parameter is only supported for Memcached clusters.</p> <p>If the <code>AZMode</code> and <code>PreferredAvailabilityZones</code> are not specified, ElastiCache assumes <code>single-az</code> mode.</p>
        preferred_availability_zone: <p>The EC2 Availability Zone in which the cluster is created.</p> <p>All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use <code>PreferredAvailabilityZones</code>.</p> <p>Default: System chosen Availability Zone.</p>
        preferred_availability_zones: <p>A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.</p> <p>This option is only supported on Memcached.</p> <note> <p>If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.</p> <p>The number of Availability Zones listed must equal the value of <code>NumCacheNodes</code>.</p> </note> <p>If you want all the nodes in the same Availability Zone, use <code>PreferredAvailabilityZone</code> instead, or repeat the Availability Zone multiple times in the list.</p> <p>Default: System chosen Availability Zones.</p>
        num_cache_nodes: <p>The initial number of cache nodes that the cluster has.</p> <p>For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.</p> <p>If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at <a href="http://aws.amazon.com/contact-us/elasticache-node-limit-request/">http://aws.amazon.com/contact-us/elasticache-node-limit-request/</a>.</p>
        cache_node_type: <p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M7g node types</b>: <code>cache.m7g.large</code>, <code>cache.m7g.xlarge</code>, <code>cache.m7g.2xlarge</code>, <code>cache.m7g.4xlarge</code>, <code>cache.m7g.8xlarge</code>, <code>cache.m7g.12xlarge</code>, <code>cache.m7g.16xlarge</code> </p> <note> <p>For region availability, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion">Supported Node Types</a> </p> </note> <p> <b>M6g node types</b> (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R7g node types</b>: <code>cache.r7g.large</code>, <code>cache.r7g.xlarge</code>, <code>cache.r7g.2xlarge</code>, <code>cache.r7g.4xlarge</code>, <code>cache.r7g.8xlarge</code>, <code>cache.r7g.12xlarge</code>, <code>cache.r7g.16xlarge</code> </p> <note> <p>For region availability, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion">Supported Node Types</a> </p> </note> <p> <b>R6g node types</b> (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>The configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Valkey, or on Redis OSS version 2.8.22 and later.</p> </li> </ul>
        engine: <p>The name of the cache engine to be used for this cluster.</p> <p>Valid values for this parameter are: <code>memcached</code> | <code>redis</code> </p>
        engine_version: <p>The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.</p> <p> <b>Important:</b> You can upgrade to a newer engine version (see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement">Selecting a Cache Engine and Version</a>), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. </p>
        cache_parameter_group_name: <p>The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has <code>cluster-enabled='yes'</code> when creating a cluster.</p>
        cache_subnet_group_name: <p>The name of the subnet group to be used for the cluster.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p> <important> <p>If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.html">Subnets and Subnet Groups</a>.</p> </important>
        cache_security_group_names: <p>A list of security group names to associate with this cluster.</p> <p>Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).</p>
        security_group_ids: <p>One or more VPC security groups associated with the cluster.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>
        tags: <p>A list of tags to be added to this resource.</p>
        snapshot_arns: <p>A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code> </p>
        snapshot_name: <p>The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to <code>restoring</code> while the new node group (shard) is being created.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>
        preferred_maintenance_window: <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>
        port: <p>The port number on which each of the cache nodes accepts connections.</p>
        notification_topic_arn: <p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.</p> <note> <p>The Amazon SNS topic owner must be the same as the cluster owner.</p> </note>
        auto_minor_version_upgrade: <p> If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>
        snapshot_retention_limit: <p>The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot taken today is retained for 5 days before being deleted.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</p>
        snapshot_window: <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>
        auth_token: <p> <b>Reserved parameter.</b> The password used to access a password protected server.</p> <p>Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters.</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length.</p> </li> <li> <p>The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.</p> </li> </ul> <p>For more information, see <a href="http://redis.io/commands/AUTH">AUTH password</a> at http://redis.io/commands/AUTH.</p>
        outpost_mode: <p>Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.</p>
        preferred_outpost_arn: <p>The outpost ARN in which the cache cluster is created.</p>
        preferred_outpost_arns: <p>The outpost ARNs in which the cache cluster is created.</p>
        log_delivery_configurations: <p>Specifies the destination, format and type of the logs. </p>
        transit_encryption_enabled: <p>A flag that enables in-transit encryption when set to true.</p>
        network_type: <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 and 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: <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 and 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>

    Raises:
        capo_elasticache.errors.cache_cluster_already_exists_fault.CacheClusterAlreadyExistsFault: <p>You already have a cluster with the given identifier.</p>
        capo_elasticache.errors.cache_parameter_group_not_found_fault.CacheParameterGroupNotFoundFault: <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
        capo_elasticache.errors.cache_security_group_not_found_fault.CacheSecurityGroupNotFoundFault: <p>The requested cache security group name does not refer to an existing cache security group.</p>
        capo_elasticache.errors.cache_subnet_group_not_found_fault.CacheSubnetGroupNotFoundFault: <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
        capo_elasticache.errors.cluster_quota_for_customer_exceeded_fault.ClusterQuotaForCustomerExceededFault: <p>The request cannot be processed because it would exceed the allowed number of clusters per customer.</p>
        capo_elasticache.errors.insufficient_cache_cluster_capacity_fault.InsufficientCacheClusterCapacityFault: <p>The requested cache node type is not available in the specified Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
        capo_elasticache.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.invalid_replication_group_state_fault.InvalidReplicationGroupStateFault: <p>The requested replication group is not in the <code>available</code> state.</p>
        capo_elasticache.errors.invalid_vpc_network_state_fault.InvalidVPCNetworkStateFault: <p>The VPC network is in an invalid state.</p>
        capo_elasticache.errors.node_quota_for_cluster_exceeded_fault.NodeQuotaForClusterExceededFault: <p>The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.</p>
        capo_elasticache.errors.node_quota_for_customer_exceeded_fault.NodeQuotaForCustomerExceededFault: <p>The request cannot be processed because it would exceed the allowed number of cache nodes per customer.</p>
        capo_elasticache.errors.replication_group_not_found_fault.ReplicationGroupNotFoundFault: <p>The specified replication group does not exist.</p>
        capo_elasticache.errors.tag_quota_per_resource_exceeded.TagQuotaPerResourceExceeded: <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        CreateCacheCluster
        Creates a Memcached cluster with 2 nodes.

        >>> await client.create_cache_cluster(cache_cluster_id='my-memcached-cluster', az_mode='cross-az', num_cache_nodes=2, cache_node_type='cache.r3.large', engine='memcached', engine_version='1.4.24', cache_subnet_group_name='default', port=11211)
        CreateCacheCluster
        Creates a Redis cluster with 1 node.

        >>> await client.create_cache_cluster(cache_cluster_id='my-redis', preferred_availability_zone='us-east-1c', num_cache_nodes=1, cache_node_type='cache.r3.larage', engine='redis', engine_version='3.2.4', cache_subnet_group_name='default', port=6379, snapshot_retention_limit=7, auto_minor_version_upgrade=True)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elasticache.types.create_cache_cluster_message.CreateCacheClusterMessage]",
    ) -> AsyncOperationResponse[
        "capo_elasticache.types.create_cache_cluster_result.CreateCacheClusterResult"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.create_cache_cluster

        (
            output,
            http_response,
        ) = await capo_elasticache._operations.amazon_elasti_cache_v9.create_cache_cluster.async_create_cache_cluster(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCacheCluster")
    )
    input_: capo_elasticache.types.create_cache_cluster_message.CreateCacheClusterMessage = {}
    if cache_cluster_id is not None:
        input_["cache_cluster_id"] = cache_cluster_id
    if replication_group_id is not None:
        input_["replication_group_id"] = replication_group_id
    if az_mode is not None:
        input_["az_mode"] = az_mode
    if preferred_availability_zone is not None:
        input_["preferred_availability_zone"] = preferred_availability_zone
    if preferred_availability_zones is not None:
        input_["preferred_availability_zones"] = preferred_availability_zones
    if num_cache_nodes is not None:
        input_["num_cache_nodes"] = num_cache_nodes
    if cache_node_type is not None:
        input_["cache_node_type"] = cache_node_type
    if engine is not None:
        input_["engine"] = engine
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if cache_parameter_group_name is not None:
        input_["cache_parameter_group_name"] = cache_parameter_group_name
    if cache_subnet_group_name is not None:
        input_["cache_subnet_group_name"] = cache_subnet_group_name
    if cache_security_group_names is not None:
        input_["cache_security_group_names"] = cache_security_group_names
    if security_group_ids is not None:
        input_["security_group_ids"] = security_group_ids
    if tags is not None:
        input_["tags"] = tags
    if snapshot_arns is not None:
        input_["snapshot_arns"] = snapshot_arns
    if snapshot_name is not None:
        input_["snapshot_name"] = snapshot_name
    if preferred_maintenance_window is not None:
        input_["preferred_maintenance_window"] = preferred_maintenance_window
    if port is not None:
        input_["port"] = port
    if notification_topic_arn is not None:
        input_["notification_topic_arn"] = notification_topic_arn
    if auto_minor_version_upgrade is not None:
        input_["auto_minor_version_upgrade"] = auto_minor_version_upgrade
    if snapshot_retention_limit is not None:
        input_["snapshot_retention_limit"] = snapshot_retention_limit
    if snapshot_window is not None:
        input_["snapshot_window"] = snapshot_window
    if auth_token is not None:
        input_["auth_token"] = auth_token
    if outpost_mode is not None:
        input_["outpost_mode"] = outpost_mode
    if preferred_outpost_arn is not None:
        input_["preferred_outpost_arn"] = preferred_outpost_arn
    if preferred_outpost_arns is not None:
        input_["preferred_outpost_arns"] = preferred_outpost_arns
    if log_delivery_configurations is not None:
        input_["log_delivery_configurations"] = log_delivery_configurations
    if transit_encryption_enabled is not None:
        input_["transit_encryption_enabled"] = transit_encryption_enabled
    if network_type is not None:
        input_["network_type"] = network_type
    if ip_discovery is not None:
        input_["ip_discovery"] = ip_discovery

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output