ElastiCache / Client / create_cache_cluster

create_cache_cluster#

ElastiCache.Client.create_cache_cluster(**kwargs)#

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.

Request Syntax

response = client.create_cache_cluster(
    CacheClusterId='string',
    ReplicationGroupId='string',
    AZMode='single-az'|'cross-az',
    PreferredAvailabilityZone='string',
    PreferredAvailabilityZones=[
        'string',
    ],
    NumCacheNodes=123,
    CacheNodeType='string',
    Engine='string',
    EngineVersion='string',
    CacheParameterGroupName='string',
    CacheSubnetGroupName='string',
    CacheSecurityGroupNames=[
        'string',
    ],
    SecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SnapshotArns=[
        'string',
    ],
    SnapshotName='string',
    PreferredMaintenanceWindow='string',
    Port=123,
    NotificationTopicArn='string',
    AutoMinorVersionUpgrade=True|False,
    SnapshotRetentionLimit=123,
    SnapshotWindow='string',
    AuthToken='string',
    OutpostMode='single-outpost'|'cross-outpost',
    PreferredOutpostArn='string',
    PreferredOutpostArns=[
        'string',
    ],
    LogDeliveryConfigurations=[
        {
            'LogType': 'slow-log'|'engine-log',
            'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
            'DestinationDetails': {
                'CloudWatchLogsDetails': {
                    'LogGroup': 'string'
                },
                'KinesisFirehoseDetails': {
                    'DeliveryStream': 'string'
                }
            },
            'LogFormat': 'text'|'json',
            'Enabled': True|False
        },
    ],
    TransitEncryptionEnabled=True|False,
    NetworkType='ipv4'|'ipv6'|'dual_stack',
    IpDiscovery='ipv4'|'ipv6'
)

Parameters:

CacheClusterId (string) –
[REQUIRED]

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.
ReplicationGroupId (string) –
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.

Note
This parameter is only valid if the Engine parameter is redis.
AZMode (string) –
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.
PreferredAvailabilityZone (string) –
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.
PreferredAvailabilityZones (list) –
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.

Note
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.
- (string) –
NumCacheNodes (integer) –
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/.
CacheNodeType (string) –
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
  Note
  
  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
  Note
  
  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 (string) –
The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis
EngineVersion (string) –
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.
CacheParameterGroupName (string) – 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.
CacheSubnetGroupName (string) –
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).

Warning
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.
CacheSecurityGroupNames (list) –
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).
- (string) –
SecurityGroupIds (list) –
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).
- (string) –
Tags (list) –
A list of tags to be added to this resource.
- (dict) –
  
  A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
  - Key (string) –
    
    The key for the tag. May not be null.
  - Value (string) –
    
    The tag’s value. May be null.
SnapshotArns (list) –
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.

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

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
- (string) –
SnapshotName (string) –
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.

Note
This parameter is only valid if the Engine parameter is redis.
PreferredMaintenanceWindow (string) – 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 (integer) – The port number on which each of the cache nodes accepts connections.
NotificationTopicArn (string) –
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

Note
The Amazon SNS topic owner must be the same as the cluster owner.
AutoMinorVersionUpgrade (boolean) – 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.
SnapshotRetentionLimit (integer) –
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.

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

Default: 0 (i.e., automatic backups are disabled for this cache cluster).
SnapshotWindow (string) –
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.

Note
This parameter is only valid if the Engine parameter is redis.
AuthToken (string) –
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.
OutpostMode (string) – Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
PreferredOutpostArn (string) – The outpost ARN in which the cache cluster is created.
PreferredOutpostArns (list) –
The outpost ARNs in which the cache cluster is created.
- (string) –
LogDeliveryConfigurations (list) –
Specifies the destination, format and type of the logs.
- (dict) –
  
  Specifies the destination, format and type of the logs.
  - LogType (string) –
    
    Refers to slow-log or engine-log..
  - DestinationType (string) –
    
    Specify either cloudwatch-logs or kinesis-firehose as the destination type.
  - DestinationDetails (dict) –
    
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    - CloudWatchLogsDetails (dict) –
      
      The configuration details of the CloudWatch Logs destination.
      - LogGroup (string) –
        
        The name of the CloudWatch Logs log group.
    - KinesisFirehoseDetails (dict) –
      
      The configuration details of the Kinesis Data Firehose destination.
      - DeliveryStream (string) –
        
        The name of the Kinesis Data Firehose delivery stream.
  - LogFormat (string) –
    
    Specifies either JSON or TEXT
  - Enabled (boolean) –
    
    Specify if log delivery is enabled. Default true.
TransitEncryptionEnabled (boolean) – A flag that enables in-transit encryption when set to true.
NetworkType (string) – Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
IpDiscovery (string) – 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 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Return type:

dict

Returns:

Response Syntax

{
    'CacheCluster': {
        'CacheClusterId': 'string',
        'ConfigurationEndpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClientDownloadLandingPage': 'string',
        'CacheNodeType': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'CacheClusterStatus': 'string',
        'NumCacheNodes': 123,
        'PreferredAvailabilityZone': 'string',
        'PreferredOutpostArn': 'string',
        'CacheClusterCreateTime': datetime(2015, 1, 1),
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'NumCacheNodes': 123,
            'CacheNodeIdsToRemove': [
                'string',
            ],
            'EngineVersion': 'string',
            'CacheNodeType': 'string',
            'AuthTokenStatus': 'SETTING'|'ROTATING',
            'LogDeliveryConfigurations': [
                {
                    'LogType': 'slow-log'|'engine-log',
                    'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
                    'DestinationDetails': {
                        'CloudWatchLogsDetails': {
                            'LogGroup': 'string'
                        },
                        'KinesisFirehoseDetails': {
                            'DeliveryStream': 'string'
                        }
                    },
                    'LogFormat': 'text'|'json'
                },
            ],
            'TransitEncryptionEnabled': True|False,
            'TransitEncryptionMode': 'preferred'|'required'
        },
        'NotificationConfiguration': {
            'TopicArn': 'string',
            'TopicStatus': 'string'
        },
        'CacheSecurityGroups': [
            {
                'CacheSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CacheParameterGroup': {
            'CacheParameterGroupName': 'string',
            'ParameterApplyStatus': 'string',
            'CacheNodeIdsToReboot': [
                'string',
            ]
        },
        'CacheSubnetGroupName': 'string',
        'CacheNodes': [
            {
                'CacheNodeId': 'string',
                'CacheNodeStatus': 'string',
                'CacheNodeCreateTime': datetime(2015, 1, 1),
                'Endpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ParameterGroupStatus': 'string',
                'SourceCacheNodeId': 'string',
                'CustomerAvailabilityZone': 'string',
                'CustomerOutpostArn': 'string'
            },
        ],
        'AutoMinorVersionUpgrade': True|False,
        'SecurityGroups': [
            {
                'SecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ReplicationGroupId': 'string',
        'SnapshotRetentionLimit': 123,
        'SnapshotWindow': 'string',
        'AuthTokenEnabled': True|False,
        'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
        'TransitEncryptionEnabled': True|False,
        'AtRestEncryptionEnabled': True|False,
        'ARN': 'string',
        'ReplicationGroupLogDeliveryEnabled': True|False,
        'LogDeliveryConfigurations': [
            {
                'LogType': 'slow-log'|'engine-log',
                'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
                'DestinationDetails': {
                    'CloudWatchLogsDetails': {
                        'LogGroup': 'string'
                    },
                    'KinesisFirehoseDetails': {
                        'DeliveryStream': 'string'
                    }
                },
                'LogFormat': 'text'|'json',
                'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
                'Message': 'string'
            },
        ],
        'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
        'IpDiscovery': 'ipv4'|'ipv6',
        'TransitEncryptionMode': 'preferred'|'required'
    }
}

Response Structure

(dict) –
- CacheCluster (dict) –
  
  Contains all of the attributes of a specific cluster.
  - CacheClusterId (string) –
    
    The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
  - ConfigurationEndpoint (dict) –
    
    Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
    
    Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
    - Address (string) –
      
      The DNS hostname of the cache node.
    - Port (integer) –
      
      The port number that the cache engine is listening on.
  - ClientDownloadLandingPage (string) –
    
    The URL of the web page where you can download the latest ElastiCache client library.
  - CacheNodeType (string) –
    
    The name of the compute and memory capacity node type for the cluster.
    
    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
      Note
      
      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
      Note
      
      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 (string) –
    
    The name of the cache engine ( memcached or redis) to be used for this cluster.
  - EngineVersion (string) –
    
    The version of the cache engine that is used in this cluster.
  - CacheClusterStatus (string) –
    
    The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.
  - NumCacheNodes (integer) –
    
    The number of cache nodes in the cluster.
    
    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
  - PreferredAvailabilityZone (string) –
    
    The name of the Availability Zone in which the cluster is located or “Multiple” if the cache nodes are located in different Availability Zones.
  - PreferredOutpostArn (string) –
    
    The outpost ARN in which the cache cluster is created.
  - CacheClusterCreateTime (datetime) –
    
    The date and time when the cluster was created.
  - PreferredMaintenanceWindow (string) –
    
    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.
    
    Valid values for ddd are:
    - sun
    - mon
    - tue
    - wed
    - thu
    - fri
    - sat
    Example: sun:23:00-mon:01:30
  - PendingModifiedValues (dict) –
    
    A group of settings that are applied to the cluster in the future, or that are currently being applied.
    - NumCacheNodes (integer) –
      
      The new number of cache nodes for the cluster.
      
      For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
    - CacheNodeIdsToRemove (list) –
      
      A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
      - (string) –
    - EngineVersion (string) –
      
      The new cache engine version that the cluster runs.
    - CacheNodeType (string) –
      
      The cache node type that this cluster or replication group is scaled to.
    - AuthTokenStatus (string) –
      
      The auth token status
    - LogDeliveryConfigurations (list) –
      
      The log delivery configurations being modified
      - (dict) –
        
        The log delivery configurations being modified
        
        LogType (string) –
        
        Refers to slow-log or engine-log..
        
        DestinationType (string) –
        
        Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
        
        DestinationDetails (dict) –
        
        Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
        
        CloudWatchLogsDetails (dict) –
        
        The configuration details of the CloudWatch Logs destination.
        
        LogGroup (string) –
        
        The name of the CloudWatch Logs log group.
        
        KinesisFirehoseDetails (dict) –
        
        The configuration details of the Kinesis Data Firehose destination.
        
        DeliveryStream (string) –
        
        The name of the Kinesis Data Firehose delivery stream.
        
        LogFormat (string) –
        
        Returns the log format, either JSON or TEXT
    - TransitEncryptionEnabled (boolean) –
      
      A flag that enables in-transit encryption when set to true.
    - TransitEncryptionMode (string) –
      
      A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
  - NotificationConfiguration (dict) –
    
    Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
    - TopicArn (string) –
      
      The Amazon Resource Name (ARN) that identifies the topic.
    - TopicStatus (string) –
      
      The current state of the topic.
  - CacheSecurityGroups (list) –
    
    A list of cache security group elements, composed of name and status sub-elements.
    - (dict) –
      
      Represents a cluster’s status within a particular cache security group.
      - CacheSecurityGroupName (string) –
        
        The name of the cache security group.
      - Status (string) –
        
        The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
  - CacheParameterGroup (dict) –
    
    Status of the cache parameter group.
    - CacheParameterGroupName (string) –
      
      The name of the cache parameter group.
    - ParameterApplyStatus (string) –
      
      The status of parameter updates.
    - CacheNodeIdsToReboot (list) –
      
      A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
      - (string) –
  - CacheSubnetGroupName (string) –
    
    The name of the cache subnet group associated with the cluster.
  - CacheNodes (list) –
    
    A list of cache nodes that are members of the cluster.
    - (dict) –
      
      Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster’s protocol-compliant caching software - either Memcached, Valkey or Redis OSS.
      
      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
        
        Note
        
        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
        
        Note
        
        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.
      - CacheNodeId (string) –
        
        The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer’s Amazon account.
      - CacheNodeStatus (string) –
        
        The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.
      - CacheNodeCreateTime (datetime) –
        
        The date and time when the cache node was created.
      - Endpoint (dict) –
        
        The hostname for connecting to this cache node.
        
        Address (string) –
        
        The DNS hostname of the cache node.
        
        Port (integer) –
        
        The port number that the cache engine is listening on.
      - ParameterGroupStatus (string) –
        
        The status of the parameter group applied to this cache node.
      - SourceCacheNodeId (string) –
        
        The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
      - CustomerAvailabilityZone (string) –
        
        The Availability Zone where this node was created and now resides.
      - CustomerOutpostArn (string) –
        
        The customer outpost ARN of the cache node.
  - AutoMinorVersionUpgrade (boolean) –
    
    If you are running Valkey or Redis OSS engine version 6.0 or later, 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.
  - SecurityGroups (list) –
    
    A list of VPC Security Groups associated with the cluster.
    - (dict) –
      
      Represents a single cache security group and its status.
      - SecurityGroupId (string) –
        
        The identifier of the cache security group.
      - Status (string) –
        
        The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
  - ReplicationGroupId (string) –
    
    The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
  - SnapshotRetentionLimit (integer) –
    
    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
    
    Warning
    If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
  - SnapshotWindow (string) –
    
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
    
    Example: 05:00-09:00
  - AuthTokenEnabled (boolean) –
    
    A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
    
    Default: false
  - AuthTokenLastModifiedDate (datetime) –
    
    The date the auth token was last modified
  - TransitEncryptionEnabled (boolean) –
    
    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.
    
    Default: false
  - AtRestEncryptionEnabled (boolean) –
    
    A flag that enables encryption at-rest when set to true.
    
    You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
    
    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.
    
    Default: false
  - ARN (string) –
    
    The ARN (Amazon Resource Name) of the cache cluster.
  - ReplicationGroupLogDeliveryEnabled (boolean) –
    
    A boolean value indicating whether log delivery is enabled for the replication group.
  - LogDeliveryConfigurations (list) –
    
    Returns the destination, format and type of the logs.
    - (dict) –
      
      Returns the destination, format and type of the logs.
      - LogType (string) –
        
        Refers to slow-log or engine-log.
      - DestinationType (string) –
        
        Returns the destination type, either cloudwatch-logs or kinesis-firehose.
      - DestinationDetails (dict) –
        
        Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
        
        CloudWatchLogsDetails (dict) –
        
        The configuration details of the CloudWatch Logs destination.
        
        LogGroup (string) –
        
        The name of the CloudWatch Logs log group.
        
        KinesisFirehoseDetails (dict) –
        
        The configuration details of the Kinesis Data Firehose destination.
        
        DeliveryStream (string) –
        
        The name of the Kinesis Data Firehose delivery stream.
      - LogFormat (string) –
        
        Returns the log format, either JSON or TEXT.
      - Status (string) –
        
        Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
      - Message (string) –
        
        Returns an error message for the log delivery configuration.
  - NetworkType (string) –
    
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
  - IpDiscovery (string) –
    
    The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
  - TransitEncryptionMode (string) –
    
    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Exceptions

ElastiCache.Client.exceptions.ReplicationGroupNotFoundFault
ElastiCache.Client.exceptions.InvalidReplicationGroupStateFault
ElastiCache.Client.exceptions.CacheClusterAlreadyExistsFault
ElastiCache.Client.exceptions.InsufficientCacheClusterCapacityFault
ElastiCache.Client.exceptions.CacheSecurityGroupNotFoundFault
ElastiCache.Client.exceptions.CacheSubnetGroupNotFoundFault
ElastiCache.Client.exceptions.ClusterQuotaForCustomerExceededFault
ElastiCache.Client.exceptions.NodeQuotaForClusterExceededFault
ElastiCache.Client.exceptions.NodeQuotaForCustomerExceededFault
ElastiCache.Client.exceptions.CacheParameterGroupNotFoundFault
ElastiCache.Client.exceptions.InvalidVPCNetworkStateFault
ElastiCache.Client.exceptions.TagQuotaPerResourceExceeded
ElastiCache.Client.exceptions.InvalidParameterValueException
ElastiCache.Client.exceptions.InvalidParameterCombinationException

Examples

Creates a Redis cluster with 1 node.

response = client.create_cache_cluster(
    AutoMinorVersionUpgrade=True,
    CacheClusterId='my-redis',
    CacheNodeType='cache.r3.larage',
    CacheSubnetGroupName='default',
    Engine='redis',
    EngineVersion='3.2.4',
    NumCacheNodes=1,
    Port=6379,
    PreferredAvailabilityZone='us-east-1c',
    SnapshotRetentionLimit=7,
)

print(response)

Expected Output:

{
    'CacheCluster': {
        'AutoMinorVersionUpgrade': True,
        'CacheClusterId': 'my-redis',
        'CacheClusterStatus': 'creating',
        'CacheNodeType': 'cache.m3.large',
        'CacheParameterGroup': {
            'CacheNodeIdsToReboot': [
            ],
            'CacheParameterGroupName': 'default.redis3.2',
            'ParameterApplyStatus': 'in-sync',
        },
        'CacheSecurityGroups': [
        ],
        'CacheSubnetGroupName': 'default',
        'ClientDownloadLandingPage': 'https: //console.aws.amazon.com/elasticache/home#client-download: ',
        'Engine': 'redis',
        'EngineVersion': '3.2.4',
        'NumCacheNodes': 1,
        'PendingModifiedValues': {
        },
        'PreferredAvailabilityZone': 'us-east-1c',
        'PreferredMaintenanceWindow': 'fri: 05: 30-fri: 06: 30',
        'SnapshotRetentionLimit': 7,
        'SnapshotWindow': '10: 00-11: 00',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}

create_cache_cluster#

Request Syntax

Constraints:

Note

Note

Note

Note

Additional node type info

Warning

Note

Note

Note

Note

Note

Response Syntax

Response Structure

Note

Note

Additional node type info

Note

Note

Additional node type info

Warning

Exceptions

Examples