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.

Contains all of the attributes of a specific cluster.

Inheritance Hierarchy

System.Object
  Amazon.ElastiCache.Model.CacheCluster

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

Syntax

C#
public class CacheCluster

The CacheCluster type exposes the following members

Constructors

NameDescription
Public Method CacheCluster()

Properties

NameTypeDescription
Public Property AtRestEncryptionEnabled System.Boolean

Gets and sets the property AtRestEncryptionEnabled.

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.

Default: false

Public Property AuthTokenEnabled System.Boolean

Gets and sets the property AuthTokenEnabled.

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

This parameter is currently disabled.

Public Property CacheClusterCreateTime System.DateTime

Gets and sets the property CacheClusterCreateTime.

The date and time when the cluster was created.

Public Property CacheClusterId System.String

Gets and sets the property CacheClusterId.

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

Public Property CacheClusterStatus System.String

Gets and sets the property CacheClusterStatus.

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.

Public Property CacheNodes System.Collections.Generic.List<Amazon.ElastiCache.Model.CacheNode>

Gets and sets the property CacheNodes.

A list of cache nodes that are members of the cluster.

Public Property CacheNodeType System.String

Gets and sets the property CacheNodeType.

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:

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

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

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

    • Previous generation: (not recommended)

      T1 node types:cache.t1.micro

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

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types:cache.c1.xlarge

  • Memory optimized:

    • Current generation:

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

    • Previous generation: (not recommended)

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

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Public Property CacheParameterGroup Amazon.ElastiCache.Model.CacheParameterGroupStatus

Gets and sets the property CacheParameterGroup.

Status of the cache parameter group.

Public Property CacheSecurityGroups System.Collections.Generic.List<Amazon.ElastiCache.Model.CacheSecurityGroupMembership>

Gets and sets the property CacheSecurityGroups.

A list of cache security group elements, composed of name and status sub-elements.

Public Property CacheSubnetGroupName System.String

Gets and sets the property CacheSubnetGroupName.

The name of the cache subnet group associated with the cluster.

Public Property ClientDownloadLandingPage System.String

Gets and sets the property ClientDownloadLandingPage.

The URL of the web page where you can download the latest ElastiCache client library.

Public Property ConfigurationEndpoint Amazon.ElastiCache.Model.Endpoint

Gets and sets the property ConfigurationEndpoint.

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, 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

Public Property Engine System.String

Gets and sets the property Engine.

The name of the cache engine (memcached or redis) to be used for this cluster.

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

The version of the cache engine that is used in this cluster.

Public Property NotificationConfiguration Amazon.ElastiCache.Model.NotificationConfiguration

Gets and sets the property NotificationConfiguration.

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

Public Property NumCacheNodes System.Int32

Gets and sets the property NumCacheNodes.

The number of cache nodes in the cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Public Property PendingModifiedValues Amazon.ElastiCache.Model.PendingModifiedValues

Gets and sets the property PendingModifiedValues.

Public Property PreferredAvailabilityZone System.String

Gets and sets the property PreferredAvailabilityZone.

The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different 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.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

Public Property ReplicationGroupId System.String

Gets and sets the property ReplicationGroupId.

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

Public Property SecurityGroups System.Collections.Generic.List<Amazon.ElastiCache.Model.SecurityGroupMembership>

Gets and sets the property SecurityGroups.

A list of VPC Security Groups associated with the cluster.

Public Property SnapshotRetentionLimit System.Int32

Gets and sets the property SnapshotRetentionLimit.

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.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

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

Example: 05:00-09:00

Public Property TransitEncryptionEnabled System.Boolean

Gets and sets the property TransitEncryptionEnabled.

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

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Default: false

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms