Class CfnCacheCluster

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

CfnElement

CfnRefElement

CfnResource

CfnCacheCluster

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCacheCluster : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnCacheCluster Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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)

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

Properties

AttrConfigurationEndpointAddress	The DNS hostname of the cache node.
AttrConfigurationEndpointPort	The port number of the configuration endpoint for the Memcached cache cluster.
AttrId	The resource name.
AttrRedisEndpointAddress	The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.
AttrRedisEndpointPort	The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.
AutoMinorVersionUpgrade	If you are running Valkey 7.2 or later, or Redis OSS 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.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
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.
CfnProperties	The `AWS::ElastiCache::CacheCluster` type creates an Amazon ElastiCache cache cluster.
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 `ipv4` \| `ipv6` .
LogDeliveryConfigurations	Specifies the destination, format and type of the logs.
NetworkType	Must be either `ipv4` \| `ipv6` \| `dual_stack` .
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 Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
SnapshotName	The name of a Valkey or Redis OSS 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	Tag Manager which manages the tags for this resource.
TagsRaw	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>)	The `AWS::ElastiCache::CacheCluster` type creates an Amazon ElastiCache cache cluster.

Constructors

CfnCacheCluster(Construct, string, ICfnCacheClusterProps)

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

public CfnCacheCluster(Construct scope, string id, ICfnCacheClusterProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnCacheClusterProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

Properties

AttrConfigurationEndpointAddress

The DNS hostname of the cache node.

public virtual string AttrConfigurationEndpointAddress { get; }

Property Value

Remarks

Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, <code>Fn::GetAtt</code> returns a value for this attribute only if the replication group is clustered. Otherwise, <code>Fn::GetAtt</code> fails.

CloudformationAttribute: ConfigurationEndpoint.Address

AttrConfigurationEndpointPort

The port number of the configuration endpoint for the Memcached cache cluster.

public virtual string AttrConfigurationEndpointPort { get; }

Property Value

Remarks

Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, <code>Fn::GetAtt</code> returns a value for this attribute only if the replication group is clustered. Otherwise, <code>Fn::GetAtt</code> fails.

CloudformationAttribute: ConfigurationEndpoint.Port

AttrId

The resource name.

public virtual string AttrId { get; }

Property Value

Remarks

CloudformationAttribute: Id

AttrRedisEndpointAddress

The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.

public virtual string AttrRedisEndpointAddress { get; }

Property Value

Remarks

CloudformationAttribute: RedisEndpoint.Address

AttrRedisEndpointPort

The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.

public virtual string AttrRedisEndpointPort { get; }

Property Value

Remarks

CloudformationAttribute: RedisEndpoint.Port

AutoMinorVersionUpgrade

If you are running Valkey 7.2 or later, or Redis OSS 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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

CacheNodeType

The compute and memory capacity of the nodes in the node group (shard).

public virtual string CacheNodeType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

CacheParameterGroupName

The name of the parameter group to associate with this cluster.

public virtual string? CacheParameterGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

CacheSecurityGroupNames

A list of security group names to associate with this cluster.

public virtual string[]? CacheSecurityGroupNames { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

CacheSubnetGroupName

The name of the subnet group to be used for the cluster.

public virtual string? CacheSubnetGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

ClusterName

A name for the cache cluster.

public virtual string? ClusterName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

Engine

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

public virtual string Engine { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

EngineVersion

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

public virtual string? EngineVersion { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

IpDiscovery

The network type you choose when modifying a cluster, either ipv4 | ipv6 .

public virtual string? IpDiscovery { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

LogDeliveryConfigurations

Specifies the destination, format and type of the logs.

public virtual object? LogDeliveryConfigurations { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

NetworkType

Must be either ipv4 | ipv6 | dual_stack .

public virtual string? NetworkType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

NumCacheNodes

The number of cache nodes that the cache cluster should have.

public virtual double NumCacheNodes { get; set; }

Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

Port

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

public virtual double? Port { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

PreferredAvailabilityZone

The EC2 Availability Zone in which the cluster is created.

public virtual string? PreferredAvailabilityZone { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

PreferredAvailabilityZones

A list of the Availability Zones in which cache nodes are created.

public virtual string[]? PreferredAvailabilityZones { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

PreferredMaintenanceWindow

Specifies the weekly time range during which maintenance on the cluster is performed.

public virtual string? PreferredMaintenanceWindow { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

SnapshotArns

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.

public virtual string[]? SnapshotArns { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

SnapshotName

The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).

public virtual string? SnapshotName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

SnapshotRetentionLimit

The number of days for which ElastiCache retains automatic snapshots before deleting them.

public virtual double? SnapshotRetentionLimit { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

TagsRaw

A list of tags to be added to this resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

TransitEncryptionEnabled

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

public virtual object? TransitEncryptionEnabled { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html

Remarks

CloudformationResource: AWS::ElastiCache::CacheCluster

ExampleMetadata: fixture=_generated

VpcSecurityGroupIds

One or more VPC security groups associated with the cluster.

public virtual string[]? VpcSecurityGroupIds { get; set; }

Property Value