AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateCacheCluster operation. Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.CreateCacheClusterRequest

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z

Syntax

C#
public class CreateCacheClusterRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The CreateCacheClusterRequest type exposes the following members

Constructors

NameDescription
Public Method CreateCacheClusterRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateCacheClusterRequest(string, int, string, string, List<String>)

Instantiates CreateCacheClusterRequest with the parameterized properties

Properties

NameTypeDescription
Public Property AuthToken System.String

Gets and sets the property AuthToken.

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.

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

 If you are running Redis 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. 

Public Property AZMode Amazon.ElastiCache.AZMode

Gets and sets the property AZMode.

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.

Public Property CacheClusterId System.String

Gets and sets the property CacheClusterId.

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.

Public Property CacheNodeType System.String

Gets and sets the property CacheNodeType.

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 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 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 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.

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

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

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Public Property CacheParameterGroupName System.String

Gets and sets the property CacheParameterGroupName.

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.

Public Property CacheSecurityGroupNames System.Collections.Generic.List<System.String>

Gets and sets the property CacheSecurityGroupNames.

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).

Public Property CacheSubnetGroupName System.String

Gets and sets the property CacheSubnetGroupName.

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.

Public Property Engine System.String

Gets and sets the property Engine.

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

Valid values for this parameter are: memcached | redis

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

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.

Public Property IpDiscovery Amazon.ElastiCache.IpDiscovery

Gets and sets the property IpDiscovery.

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

Public Property LogDeliveryConfigurations System.Collections.Generic.List<Amazon.ElastiCache.Model.LogDeliveryConfigurationRequest>

Gets and sets the property LogDeliveryConfigurations.

Specifies the destination, format and type of the logs.

Public Property NetworkType Amazon.ElastiCache.NetworkType

Gets and sets the property NetworkType.

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

Public Property NotificationTopicArn System.String

Gets and sets the property NotificationTopicArn.

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.

Public Property NumCacheNodes System.Int32

Gets and sets the property NumCacheNodes.

The initial number of cache nodes that the cluster has.

For clusters running Redis, 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/.

Public Property OutpostMode Amazon.ElastiCache.OutpostMode

Gets and sets the property OutpostMode.

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

Public Property Port System.Int32

Gets and sets the property Port.

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

Public Property PreferredAvailabilityZone System.String

Gets and sets the property PreferredAvailabilityZone.

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.

Public Property PreferredAvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property PreferredAvailabilityZones.

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.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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.

Public Property PreferredOutpostArn System.String

Gets and sets the property PreferredOutpostArn.

The outpost ARN in which the cache cluster is created.

Public Property PreferredOutpostArns System.Collections.Generic.List<System.String>

Gets and sets the property PreferredOutpostArns.

The outpost ARNs in which the cache cluster is created.

Public Property ReplicationGroupId System.String

Gets and sets the property ReplicationGroupId.

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.

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

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).

Public Property SnapshotArns System.Collections.Generic.List<System.String>

Gets and sets the property SnapshotArns.

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis 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

Public Property SnapshotName System.String

Gets and sets the property SnapshotName.

The name of a Redis 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.

Public Property SnapshotRetentionLimit System.Int32

Gets and sets the property SnapshotRetentionLimit.

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).

Public Property SnapshotWindow System.String

Gets and sets the property SnapshotWindow.

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.

Public Property Tags System.Collections.Generic.List<Amazon.ElastiCache.Model.Tag>

Gets and sets the property Tags.

A list of tags to be added to this resource.

Public Property TransitEncryptionEnabled System.Boolean

Gets and sets the property TransitEncryptionEnabled.

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

Examples

Creates a Memcached cluster with 2 nodes.

CreateCacheCluster


var client = new AmazonElastiCacheClient();
var response = client.CreateCacheCluster(new CreateCacheClusterRequest 
{
    AZMode = "cross-az",
    CacheClusterId = "my-memcached-cluster",
    CacheNodeType = "cache.r3.large",
    CacheSubnetGroupName = "default",
    Engine = "memcached",
    EngineVersion = "1.4.24",
    NumCacheNodes = 2,
    Port = 11211
});

CacheCluster cacheCluster = response.CacheCluster;

            

Creates a Redis cluster with 1 node.

CreateCacheCluster


var client = new AmazonElastiCacheClient();
var response = client.CreateCacheCluster(new CreateCacheClusterRequest 
{
    AZMode = "cross-az",
    CacheClusterId = "my-memcached-cluster",
    CacheNodeType = "cache.r3.large",
    CacheSubnetGroupName = "default",
    Engine = "memcached",
    EngineVersion = "1.4.24",
    NumCacheNodes = 2,
    Port = 11211
});

CacheCluster cacheCluster = response.CacheCluster;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5