interface CfnClusterProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.MemoryDB.CfnClusterProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsmemorydb#CfnClusterProps |
 Java | software.amazon.awscdk.services.memorydb.CfnClusterProps |
 Python | aws_cdk.aws_memorydb.CfnClusterProps |
 TypeScript | aws-cdk-lib » aws_memorydb » CfnClusterProps |
Properties for defining a CfnCluster.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_memorydb as memorydb } from 'aws-cdk-lib';
const cfnClusterProps: memorydb.CfnClusterProps = {
aclName: 'aclName',
clusterName: 'clusterName',
nodeType: 'nodeType',
// the properties below are optional
autoMinorVersionUpgrade: false,
clusterEndpoint: {
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: ['securityGroupIds'],
snapshotArns: ['snapshotArns'],
snapshotName: 'snapshotName',
snapshotRetentionLimit: 123,
snapshotWindow: 'snapshotWindow',
snsTopicArn: 'snsTopicArn',
snsTopicStatus: 'snsTopicStatus',
subnetGroupName: 'subnetGroupName',
tags: [{
key: 'key',
value: 'value',
}],
tlsEnabled: false,
};
Properties
| Name | Type | Description |
|---|---|---|
| acl | string | The name of the Access Control List to associate with the cluster . |
| cluster | string | The name of the cluster . |
| node | string | The cluster 's node type. |
| auto | boolean | IResolvable | When set to true, the cluster will automatically receive minor engine version upgrades after launch. |
| cluster | IResolvable | Endpoint | The cluster 's configuration endpoint. |
| data | string | Enables data tiering. |
| description? | string | A description of the cluster . |
| engine? | string | The name of the engine used by the cluster. |
| engine | string | The Valkey or Redis OSS engine version used by the cluster . |
| final | string | The user-supplied name of a final cluster snapshot. |
| kms | string | The ID of the KMS key used to encrypt the cluster . |
| maintenance | string | Specifies the weekly time range during which maintenance on the cluster is performed. |
| multi | string | The name of the multi-Region cluster that this cluster belongs to. |
| num | number | The number of replicas to apply to each shard. |
| num | number | The number of shards in the cluster . |
| parameter | string | The name of the parameter group used by the cluster . |
| port? | number | The port used by the cluster . |
| security | string[] | A list of security group names to associate with this cluster . |
| snapshot | string[] | A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. |
| snapshot | string | The name of a snapshot from which to restore data into the new cluster . |
| snapshot | number | The number of days for which MemoryDB retains automatic snapshots before deleting them. |
| snapshot | string | The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. |
| sns | string | 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. |
| sns | string | The SNS topic must be in Active status to receive notifications. |
| subnet | string | The name of the subnet group used by the cluster . |
| tags? | Cfn[] | An array of key-value pairs to apply to this resource. |
| tls | boolean | IResolvable | A flag to indicate if In-transit encryption is enabled. |
aclName
Type:
string
The name of the Access Control List to associate with the cluster .
clusterName
Type:
string
The name of the cluster .
nodeType
Type:
string
The cluster 's node type.
autoMinorVersionUpgrade?
Type:
boolean | IResolvable
(optional)
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
clusterEndpoint?
Type:
IResolvable | Endpoint
(optional)
The cluster 's configuration endpoint.
dataTiering?
Type:
string
(optional)
Enables data tiering.
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?
Type:
string
(optional)
A description of the cluster .
engine?
Type:
string
(optional)
The name of the engine used by the cluster.
engineVersion?
Type:
string
(optional)
The Valkey or Redis OSS engine version used by the cluster .
finalSnapshotName?
Type:
string
(optional)
The user-supplied name of a final cluster snapshot.
This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
kmsKeyId?
Type:
string
(optional)
The ID of the KMS key used to encrypt the cluster .
maintenanceWindow?
Type:
string
(optional)
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.
Pattern : ddd:hh24:mi-ddd:hh24:mi
multiRegionClusterName?
Type:
string
(optional)
The name of the multi-Region cluster that this cluster belongs to.
numReplicasPerShard?
Type:
number
(optional)
The number of replicas to apply to each shard.
Default value : 1
Maximum value : 5
numShards?
Type:
number
(optional)
The number of shards in the cluster .
parameterGroupName?
Type:
string
(optional)
The name of the parameter group used by the cluster .
port?
Type:
number
(optional)
The port used by the cluster .
securityGroupIds?
Type:
string[]
(optional)
A list of security group names to associate with this cluster .
snapshotArns?
Type:
string[]
(optional)
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
snapshotName?
Type:
string
(optional)
The name of a snapshot from which to restore data into the new cluster .
The snapshot status changes to restoring while the new cluster is being created.
snapshotRetentionLimit?
Type:
number
(optional)
The number of days for which MemoryDB retains automatic 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.
snapshotWindow?
Type:
string
(optional)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
snsTopicArn?
Type:
string
(optional)
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.
snsTopicStatus?
Type:
string
(optional)
The SNS topic must be in Active status to receive notifications.
subnetGroupName?
Type:
string
(optional)
The name of the subnet group used by the cluster .
tags?
Type:
Cfn[]
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .
tlsEnabled?
Type:
boolean | IResolvable
(optional)
A flag to indicate if In-transit encryption is enabled.