Interface ICfnClusterProps
Properties for defining a CfnCluster.
Namespace: Amazon.CDK.AWS.MemoryDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnClusterPropsSyntax (vb)
Public Interface ICfnClusterPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html
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.MemoryDB;
var cfnClusterProps = new CfnClusterProps {
AclName = "aclName",
ClusterName = "clusterName",
NodeType = "nodeType",
// the properties below are optional
AutoMinorVersionUpgrade = false,
ClusterEndpoint = new EndpointProperty {
Address = "address",
Port = 123
},
DataTiering = "dataTiering",
Description = "description",
Engine = "engine",
EngineVersion = "engineVersion",
FinalSnapshotName = "finalSnapshotName",
KmsKeyId = "kmsKeyId",
MaintenanceWindow = "maintenanceWindow",
MultiRegionClusterName = "multiRegionClusterName",
NumReplicasPerShard = 123,
NumShards = 123,
ParameterGroupName = "parameterGroupName",
Port = 123,
SecurityGroupIds = new [] { "securityGroupIds" },
SnapshotArns = new [] { "snapshotArns" },
SnapshotName = "snapshotName",
SnapshotRetentionLimit = 123,
SnapshotWindow = "snapshotWindow",
SnsTopicArn = "snsTopicArn",
SnsTopicStatus = "snsTopicStatus",
SubnetGroupName = "subnetGroupName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TlsEnabled = false
};Synopsis
Properties
| Acl |
The name of the Access Control List to associate with the cluster . |
| Auto |
When set to true, the cluster will automatically receive minor engine version upgrades after launch. |
| Cluster |
The cluster 's configuration endpoint. |
| Cluster |
The name of the cluster . |
| Data |
Enables data tiering. |
| Description | A description of the cluster . |
| Engine | The name of the engine used by the cluster. |
| Engine |
The Redis engine version used by the cluster . |
| Final |
The user-supplied name of a final cluster snapshot. |
| Kms |
The ID of the KMS key used to encrypt the cluster . |
| Maintenance |
Specifies the weekly time range during which maintenance on the cluster is performed. |
| Multi |
The name of the multi-Region cluster that this cluster belongs to. |
| Node |
The cluster 's node type. |
| Num |
The number of replicas to apply to each shard. |
| Num |
The number of shards in the cluster . |
| Parameter |
The name of the parameter group used by the cluster . |
| Port | The port used by the cluster . |
| Security |
A list of security group names to associate with this cluster . |
| Snapshot |
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. |
| Snapshot |
The name of a snapshot from which to restore data into the new cluster . |
| Snapshot |
The number of days for which MemoryDB retains automatic snapshots before deleting them. |
| Snapshot |
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. |
| Sns |
When you pass the logical ID of this resource to the intrinsic |
| Sns |
The SNS topic must be in Active status to receive notifications. |
| Subnet |
The name of the subnet group used by the cluster . |
| Tags | An array of key-value pairs to apply to this resource. |
| Tls |
A flag to indicate if In-transit encryption is enabled. |
Properties
AclName
The name of the Access Control List to associate with the cluster .
string AclName { get; }Property Value
System.
Remarks
AutoMinorVersionUpgrade
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
virtual object AutoMinorVersionUpgrade { get; }Property Value
System.
Remarks
ClusterEndpoint
The cluster 's configuration endpoint.
virtual object ClusterEndpoint { get; }Property Value
System.
Remarks
ClusterName
The name of the cluster .
string ClusterName { get; }Property Value
System.
Remarks
DataTiering
Enables data tiering.
virtual string DataTiering { get; }Property Value
System.
Remarks
Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering .
Description
A description of the cluster .
virtual string Description { get; }Property Value
System.
Remarks
Engine
The name of the engine used by the cluster.
virtual string Engine { get; }Property Value
System.
Remarks
EngineVersion
The Redis engine version used by the cluster .
virtual string EngineVersion { get; }Property Value
System.
Remarks
FinalSnapshotName
The user-supplied name of a final cluster snapshot.
virtual string FinalSnapshotName { get; }Property Value
System.
Remarks
This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
KmsKeyId
The ID of the KMS key used to encrypt the cluster .
virtual string KmsKeyId { get; }Property Value
System.
Remarks
MaintenanceWindow
Specifies the weekly time range during which maintenance on the cluster is performed.
virtual string MaintenanceWindow { get; }Property Value
System.
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.
Pattern : ddd:hh24:mi-ddd:hh24:mi
MultiRegionClusterName
The name of the multi-Region cluster that this cluster belongs to.
virtual string MultiRegionClusterName { get; }Property Value
System.
Remarks
NodeType
The cluster 's node type.
string NodeType { get; }Property Value
System.
Remarks
NumReplicasPerShard
The number of replicas to apply to each shard.
virtual Nullable<double> NumReplicasPerShard { get; }Property Value
System.
Remarks
Default value : 1
Maximum value : 5
NumShards
The number of shards in the cluster .
virtual Nullable<double> NumShards { get; }Property Value
System.
Remarks
ParameterGroupName
The name of the parameter group used by the cluster .
virtual string ParameterGroupName { get; }Property Value
System.
Remarks
Port
The port used by the cluster .
virtual Nullable<double> Port { get; }Property Value
System.
Remarks
SecurityGroupIds
A list of security group names to associate with this cluster .
virtual string[] SecurityGroupIds { get; }Property Value
System.
Remarks
SnapshotArns
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
virtual string[] SnapshotArns { get; }Property Value
System.
Remarks
The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
SnapshotName
The name of a snapshot from which to restore data into the new cluster .
virtual string SnapshotName { get; }Property Value
System.
Remarks
The snapshot status changes to restoring while the new cluster is being created.
SnapshotRetentionLimit
The number of days for which MemoryDB retains automatic snapshots before deleting them.
virtual Nullable<double> SnapshotRetentionLimit { get; }Property Value
System.
Remarks
For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
SnapshotWindow
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
virtual string SnapshotWindow { get; }Property Value
System.
Remarks
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
SnsTopicArn
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.
virtual string SnsTopicArn { get; }Property Value
System.
Remarks
SnsTopicStatus
The SNS topic must be in Active status to receive notifications.
virtual string SnsTopicStatus { get; }Property Value
System.
Remarks
SubnetGroupName
The name of the subnet group used by the cluster .
virtual string SubnetGroupName { get; }Property Value
System.
Remarks
Tags
An array of key-value pairs to apply to this resource.
virtual ICfnTag[] Tags { get; }Property Value
ICfn
Remarks
For more information, see Tag .
TlsEnabled
A flag to indicate if In-transit encryption is enabled.
virtual object TlsEnabled { get; }Property Value
System.