Class CfnCacheCluster
A CloudFormation AWS::ElastiCache::CacheCluster
.
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.AWS.ElastiCache.dll
Syntax (csharp)
public class CfnCacheCluster : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCacheCluster
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.
CloudformationResource: AWS::ElastiCache::CacheCluster
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache;
var cfnCacheCluster = new CfnCacheCluster(this, "MyCfnCacheCluster", new CfnCacheClusterProps {
CacheNodeType = "cacheNodeType",
Engine = "engine",
NumCacheNodes = 123,
// the properties below are optional
AutoMinorVersionUpgrade = false,
AzMode = "azMode",
CacheParameterGroupName = "cacheParameterGroupName",
CacheSecurityGroupNames = new [] { "cacheSecurityGroupNames" },
CacheSubnetGroupName = "cacheSubnetGroupName",
ClusterName = "clusterName",
EngineVersion = "engineVersion",
IpDiscovery = "ipDiscovery",
LogDeliveryConfigurations = new [] { new LogDeliveryConfigurationRequestProperty {
DestinationDetails = new DestinationDetailsProperty {
CloudWatchLogsDetails = new CloudWatchLogsDestinationDetailsProperty {
LogGroup = "logGroup"
},
KinesisFirehoseDetails = new KinesisFirehoseDestinationDetailsProperty {
DeliveryStream = "deliveryStream"
}
},
DestinationType = "destinationType",
LogFormat = "logFormat",
LogType = "logType"
} },
NetworkType = "networkType",
NotificationTopicArn = "notificationTopicArn",
Port = 123,
PreferredAvailabilityZone = "preferredAvailabilityZone",
PreferredAvailabilityZones = new [] { "preferredAvailabilityZones" },
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
SnapshotArns = new [] { "snapshotArns" },
SnapshotName = "snapshotName",
SnapshotRetentionLimit = 123,
SnapshotWindow = "snapshotWindow",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TransitEncryptionEnabled = false,
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnCacheCluster(Construct, String, ICfnCacheClusterProps) | Create a new |
CfnCacheCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCacheCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrConfigurationEndpointAddress | The DNS hostname of the cache node. |
AttrConfigurationEndpointPort | The port number of the configuration endpoint for the Memcached cache cluster. |
AttrRedisEndpointAddress | The DNS address of the configuration endpoint for the Redis cache cluster. |
AttrRedisEndpointPort | The port number of the configuration endpoint for the Redis cache cluster. |
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 minor version upgrade campaign. This parameter is disabled for previous versions. |
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. |
CacheNodeType | The compute and memory capacity of the nodes in the node group (shard). |
CacheParameterGroupName | The name of the parameter group to associate with this cluster. |
CacheSecurityGroupNames | A list of security group names to associate with this cluster. |
CacheSubnetGroupName | The name of the subnet group to be used for the cluster. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | A name for the cache cluster. |
Engine | The name of the cache engine to be used for this cluster. |
EngineVersion | The version number of the cache engine to be used for this cluster. |
IpDiscovery | The network type you choose when modifying a cluster, either |
LogDeliveryConfigurations | Specifies the destination, format and type of the logs. |
NetworkType | Must be either |
NotificationTopicArn | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. |
NumCacheNodes | The number of cache nodes that the cache cluster should have. |
Port | The port number on which each of the cache nodes accepts connections. |
PreferredAvailabilityZone | The EC2 Availability Zone in which the cluster is created. |
PreferredAvailabilityZones | A list of the Availability Zones in which cache nodes are created. |
PreferredMaintenanceWindow | Specifies the weekly time range during which maintenance on the cluster is performed. |
SnapshotArns | A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. |
SnapshotName | The name of a Redis snapshot from which to restore data into the new node group (shard). |
SnapshotRetentionLimit | The number of days for which ElastiCache retains automatic snapshots before deleting them. |
SnapshotWindow | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). |
Tags | A list of tags to be added to this resource. |
TransitEncryptionEnabled | A flag that enables in-transit encryption when set to true. |
VpcSecurityGroupIds | One or more VPC security groups associated with the cluster. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCacheCluster(Construct, String, ICfnCacheClusterProps)
Create a new AWS::ElastiCache::CacheCluster
.
public CfnCacheCluster(Construct scope, string id, ICfnCacheClusterProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCacheClusterProps
- resource properties.
CfnCacheCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCacheCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCacheCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCacheCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrConfigurationEndpointAddress
The DNS hostname of the cache node.
public virtual string AttrConfigurationEndpointAddress { get; }
Property Value
System.String
Remarks
Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt
returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt
fails.
CloudformationAttribute: ConfigurationEndpoint.Address
AttrConfigurationEndpointPort
The port number of the configuration endpoint for the Memcached cache cluster.
public virtual string AttrConfigurationEndpointPort { get; }
Property Value
System.String
Remarks
Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt
returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt
fails.
CloudformationAttribute: ConfigurationEndpoint.Port
AttrRedisEndpointAddress
The DNS address of the configuration endpoint for the Redis cache cluster.
public virtual string AttrRedisEndpointAddress { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RedisEndpoint.Address
AttrRedisEndpointPort
The port number of the configuration endpoint for the Redis cache cluster.
public virtual string AttrRedisEndpointPort { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RedisEndpoint.Port
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 minor version upgrade campaign. This parameter is disabled for previous versions.
public virtual object AutoMinorVersionUpgrade { get; set; }
Property Value
System.Object
Remarks
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.
public virtual string AzMode { get; set; }
Property Value
System.String
Remarks
This parameter is only supported for Memcached clusters.
If the AZMode
and PreferredAvailabilityZones
are not specified, ElastiCache assumes single-az
mode.
CacheNodeType
The compute and memory capacity of the nodes in the node group (shard).
public virtual string CacheNodeType { get; set; }
Property Value
System.String
Remarks
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. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the LogicalResourceId
of the resource.
M6g node types: cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
, cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
, cache.m6g.16xlarge
, cache.m6g.24xlarge
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: 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
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
C1 node types: cache.c1.xlarge
R6gd node types: cache.r6gd.xlarge
, cache.r6gd.2xlarge
, cache.r6gd.4xlarge
, cache.r6gd.8xlarge
, cache.r6gd.12xlarge
, cache.r6gd.16xlarge
The <code>r6gd</code> family is available in the following regions: <code>us-east-2</code> , <code>us-east-1</code> , <code>us-west-2</code> , <code>us-west-1</code> , <code>eu-west-1</code> , <code>eu-central-1</code> , <code>ap-northeast-1</code> , <code>ap-southeast-1</code> , <code>ap-southeast-2</code> .
R6g node types: cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
, cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
, cache.r6g.16xlarge
, cache.r6g.24xlarge
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
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
For region availability, see Supported Node Types by Region
Additional node type info
CacheParameterGroupName
The name of the parameter group to associate with this cluster.
public virtual string CacheParameterGroupName { get; set; }
Property Value
System.String
Remarks
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.
CacheSecurityGroupNames
A list of security group names to associate with this cluster.
public virtual string[] CacheSecurityGroupNames { get; set; }
Property Value
System.String[]
Remarks
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
CacheSubnetGroupName
The name of the subnet group to be used for the cluster.
public virtual string CacheSubnetGroupName { get; set; }
Property Value
System.String
Remarks
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 AWS::ElastiCache::SubnetGroup .
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClusterName
A name for the cache cluster.
public virtual string ClusterName { get; set; }
Property Value
System.String
Remarks
If you don't specify a name, AWSCloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type .
The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.
Engine
The name of the cache engine to be used for this cluster.
public virtual string Engine { get; set; }
Property Value
System.String
Remarks
Valid values for this parameter are: memcached
| redis
EngineVersion
The version number of the cache engine to be used for this cluster.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
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
The network type you choose when modifying a cluster, either ipv4
| ipv6
.
public virtual string IpDiscovery { get; set; }
Property Value
System.String
Remarks
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 .
LogDeliveryConfigurations
Specifies the destination, format and type of the logs.
public virtual object LogDeliveryConfigurations { get; set; }
Property Value
System.Object
Remarks
NetworkType
Must be either ipv4
| ipv6
| dual_stack
.
public virtual string NetworkType { get; set; }
Property Value
System.String
Remarks
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 .
NotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
public virtual string NotificationTopicArn { get; set; }
Property Value
System.String
Remarks
The Amazon SNS topic owner must be the same as the cluster owner.
NumCacheNodes
The number of cache nodes that the cache cluster should have.
public virtual double NumCacheNodes { get; set; }
Property Value
System.Double
Remarks
However, if the PreferredAvailabilityZone
and PreferredAvailabilityZones
properties were not previously specified and you don't specify any new values, an update requires replacement .
Port
The port number on which each of the cache nodes accepts connections.
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
PreferredAvailabilityZone
The EC2 Availability Zone in which the cluster is created.
public virtual string PreferredAvailabilityZone { get; set; }
Property Value
System.String
Remarks
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
A list of the Availability Zones in which cache nodes are created.
public virtual string[] PreferredAvailabilityZones { get; set; }
Property Value
System.String[]
Remarks
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.
PreferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cluster is performed.
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
Remarks
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:
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:
Example: sun:23:00-mon:01:30
SnapshotArns
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3.
public virtual string[] SnapshotArns { get; set; }
Property Value
System.String[]
Remarks
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
SnapshotName
The name of a Redis snapshot from which to restore data into the new node group (shard).
public virtual string SnapshotName { get; set; }
Property Value
System.String
Remarks
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
.
SnapshotRetentionLimit
The number of days for which ElastiCache retains automatic snapshots before deleting them.
public virtual Nullable<double> SnapshotRetentionLimit { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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).
SnapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
public virtual string SnapshotWindow { get; set; }
Property Value
System.String
Remarks
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
.
Tags
A list of tags to be added to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
TransitEncryptionEnabled
A flag that enables in-transit encryption when set to true.
public virtual object TransitEncryptionEnabled { get; set; }
Property Value
System.Object
Remarks
VpcSecurityGroupIds
One or more VPC security groups associated with the cluster.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>