Class CfnCacheCluster

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnCacheCluster
Implements
Inherited Members
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

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

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(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
CfnCacheCluster(Construct, String, ICfnCacheClusterProps)

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

Constructors

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

CfnCacheCluster(Construct, String, ICfnCacheClusterProps)

public CfnCacheCluster(Construct scope, string id, ICfnCacheClusterProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnCacheClusterProps

Resource properties.

Properties

AttrConfigurationEndpointAddress

The DNS hostname of the cache node.

public virtual string AttrConfigurationEndpointAddress { get; }
Property Value

System.String

Remarks

Valkey and Redis OSS (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

Valkey and Redis OSS (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

AttrId

The resource name.

public virtual string AttrId { get; }
Property Value

System.String

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

System.String

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

System.String

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

System.Object

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

CacheNodeType

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

public virtual string CacheNodeType { get; set; }
Property Value

System.String

CacheParameterGroupName

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

public virtual string CacheParameterGroupName { get; set; }
Property Value

System.String

CacheSecurityGroupNames

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

public virtual string[] CacheSecurityGroupNames { get; set; }
Property Value

System.String[]

CacheSubnetGroupName

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

public virtual string CacheSubnetGroupName { get; set; }
Property Value

System.String

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

Engine

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

public virtual string Engine { get; set; }
Property Value

System.String

EngineVersion

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

public virtual string EngineVersion { get; set; }
Property Value

System.String

IpDiscovery

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

public virtual string IpDiscovery { get; set; }
Property Value

System.String

LogDeliveryConfigurations

Specifies the destination, format and type of the logs.

public virtual object LogDeliveryConfigurations { get; set; }
Property Value

System.Object

NetworkType

Must be either ipv4 | ipv6 | dual_stack .

public virtual string NetworkType { get; set; }
Property Value

System.String

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

NumCacheNodes

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

public virtual double NumCacheNodes { get; set; }
Property Value

System.Double

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>

PreferredAvailabilityZone

The EC2 Availability Zone in which the cluster is created.

public virtual string PreferredAvailabilityZone { get; set; }
Property Value

System.String

PreferredAvailabilityZones

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

public virtual string[] PreferredAvailabilityZones { get; set; }
Property Value

System.String[]

PreferredMaintenanceWindow

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

public virtual string PreferredMaintenanceWindow { get; set; }
Property Value

System.String

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

System.String[]

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

System.String

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>

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

A list of tags to be added to this resource.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

TransitEncryptionEnabled

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

public virtual object TransitEncryptionEnabled { get; set; }
Property Value

System.Object

VpcSecurityGroupIds

One or more VPC security groups associated with the cluster.

public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value

System.String[]

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>

Overrides

Implements