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.
Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z
public class CreateCacheClusterRequest : AmazonElastiCacheRequest IAmazonWebServiceRequest
The CreateCacheClusterRequest type exposes the following members
Name | Description | |
---|---|---|
CreateCacheClusterRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
CreateCacheClusterRequest(string, int, string, string, List<String>) |
Instantiates CreateCacheClusterRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
AuthToken | System.String |
Gets and sets the property AuthToken. Reserved parameter. The password used to access a password protected server. Password constraints:
For more information, see AUTH password at http://redis.io/commands/AUTH. |
|
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. |
|
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 |
|
CacheClusterId | System.String |
Gets and sets the property CacheClusterId. The node group (shard) identifier. This parameter is stored as a lowercase string. Constraints:
|
|
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.
Additional node type info
|
|
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 |
|
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). |
|
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. |
|
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: |
|
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. |
|
IpDiscovery | Amazon.ElastiCache.IpDiscovery |
Gets and sets the property IpDiscovery.
The network type you choose when modifying a cluster, either |
|
LogDeliveryConfigurations | System.Collections.Generic.List<Amazon.ElastiCache.Model.LogDeliveryConfigurationRequest> |
Gets and sets the property LogDeliveryConfigurations. Specifies the destination, format and type of the logs. |
|
NetworkType | Amazon.ElastiCache.NetworkType |
Gets and sets the property NetworkType.
Must be either |
|
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. |
|
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/. |
|
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. |
|
Port | System.Int32 |
Gets and sets the property Port. The port number on which each of the cache nodes accepts connections. |
|
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 Default: System chosen Availability Zone. |
|
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
If you want all the nodes in the same Availability Zone, use Default: System chosen Availability Zones. |
|
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. |
|
PreferredOutpostArn | System.String |
Gets and sets the property PreferredOutpostArn. The outpost ARN in which the cache cluster is created. |
|
PreferredOutpostArns | System.Collections.Generic.List<System.String> |
Gets and sets the property PreferredOutpostArns. The outpost ARNs in which the cache cluster is created. |
|
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 |
|
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). |
|
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
Example of an Amazon S3 ARN: |
|
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
This parameter is only valid if the |
|
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
This parameter is only valid if the Default: 0 (i.e., automatic backups are disabled for this cache cluster). |
|
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: If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the |
|
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. |
|
TransitEncryptionEnabled | System.Boolean |
Gets and sets the property TransitEncryptionEnabled. A flag that enables in-transit encryption when set to true. |
Creates a Memcached cluster with 2 nodes.
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.
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;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5