CfnClusterProps Struct
Properties for defining a CfnCluster.
Example
ts
// 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',
ipDiscovery: 'ipDiscovery',
kmsKeyId: 'kmsKeyId',
maintenanceWindow: 'maintenanceWindow',
multiRegionClusterName: 'multiRegionClusterName',
networkType: 'networkType',
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
The name of the Access Control List to associate with the cluster .
autoMinorVersionUpgradeoptionalboolean | IResolvableauto_minor_version_upgradeoptionaltyping.Union[bool, IResolvable]autoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptionalinterface{}#When set to true, the cluster will automatically receive minor engine version upgrades after launch.
clusterEndpointoptionalIResolvable | CfnCluster.EndpointPropertycluster_endpointoptionaltyping.Union[IResolvable, EndpointProperty]clusterEndpointoptionalIResolvableClusterEndpointoptionalIResolvableClusterEndpointoptionalinterface{}#The cluster 's configuration endpoint.
The name of the cluster .
dataTieringoptionalstringdata_tieringoptionalstrdataTieringoptionalStringDataTieringoptionalstringDataTieringoptional*string#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 .
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the cluster .
The name of the engine used by the cluster.
engineVersionoptionalstringengine_versionoptionalstrengineVersionoptionalStringEngineVersionoptionalstringEngineVersionoptional*string#The Redis engine version used by the cluster .
finalSnapshotNameoptionalstringfinal_snapshot_nameoptionalstrfinalSnapshotNameoptionalStringFinalSnapshotNameoptionalstringFinalSnapshotNameoptional*string#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.
ipDiscoveryoptionalstringip_discoveryoptionalstripDiscoveryoptionalStringIpDiscoveryoptionalstringIpDiscoveryoptional*string#The mechanism that the cluster uses to discover IP addresses.
Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#The ID of the KMS key used to encrypt the cluster .
maintenanceWindowoptionalstringmaintenance_windowoptionalstrmaintenanceWindowoptionalStringMaintenanceWindowoptionalstringMaintenanceWindowoptional*string#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
multiRegionClusterNameoptionalstringmulti_region_cluster_nameoptionalstrmultiRegionClusterNameoptionalStringMultiRegionClusterNameoptionalstringMultiRegionClusterNameoptional*string#The name of the multi-Region cluster that this cluster belongs to.
networkTypeoptionalstringnetwork_typeoptionalstrnetworkTypeoptionalStringNetworkTypeoptionalstringNetworkTypeoptional*string#The IP address type for the cluster.
Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.
The cluster 's node type.
numReplicasPerShardoptionalnumbernum_replicas_per_shardoptionalint | floatnumReplicasPerShardoptionalNumberNumReplicasPerShardoptionaldoubleNumReplicasPerShardoptional*float64#The number of replicas to apply to each shard.
Default value : 1
Maximum value : 5
numShardsoptionalnumbernum_shardsoptionalint | floatnumShardsoptionalNumberNumShardsoptionaldoubleNumShardsoptional*float64#The number of shards in the cluster .
parameterGroupNameoptionalstringparameter_group_nameoptionalstrparameterGroupNameoptionalStringParameterGroupNameoptionalstringParameterGroupNameoptional*string#The name of the parameter group used by the cluster .
The port used by the cluster .
securityGroupIdsoptionalstring | ISecurityGroupRef[]security_group_idsoptionaltyping.List[typing.Union[str, ISecurityGroupRef]]securityGroupIdsoptionalList<String>SecurityGroupIdsoptionalstring[]SecurityGroupIdsoptional*[]interface{}#A list of security group names to associate with this cluster .
snapshotArnsoptionalstring[]snapshot_arnsoptionaltyping.List[str]snapshotArnsoptionalList<String>SnapshotArnsoptionalstring[]SnapshotArnsoptional*[]*string#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.
snapshotNameoptionalstringsnapshot_nameoptionalstrsnapshotNameoptionalStringSnapshotNameoptionalstringSnapshotNameoptional*string#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.
snapshotRetentionLimitoptionalnumbersnapshot_retention_limitoptionalint | floatsnapshotRetentionLimitoptionalNumberSnapshotRetentionLimitoptionaldoubleSnapshotRetentionLimitoptional*float64#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.
snapshotWindowoptionalstringsnapshot_windowoptionalstrsnapshotWindowoptionalStringSnapshotWindowoptionalstringSnapshotWindowoptional*string#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.
snsTopicArnoptionalstringsns_topic_arnoptionalstrsnsTopicArnoptionalStringSnsTopicArnoptionalstringSnsTopicArnoptional*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`.
snsTopicStatusoptionalstringsns_topic_statusoptionalstrsnsTopicStatusoptionalStringSnsTopicStatusoptionalstringSnsTopicStatusoptional*string#The SNS topic must be in Active status to receive notifications.
subnetGroupNameoptionalstringsubnet_group_nameoptionalstrsubnetGroupNameoptionalStringSubnetGroupNameoptionalstringSubnetGroupNameoptional*string#The name of the subnet group used by the cluster .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of key-value pairs to apply to this resource.
For more information, see Tag .
tlsEnabledoptionalboolean | IResolvabletls_enabledoptionaltyping.Union[bool, IResolvable]tlsEnabledoptionalBooleanTlsEnabledoptionalboolTlsEnabledoptionalinterface{}#A flag to indicate if In-transit encryption is enabled.