Skip to content
v2.275.0

ClusterConfigurationProperty Struct ​

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 clusterConfigurationProperty: memorydb.CfnSnapshot.ClusterConfigurationProperty = {
  description: 'description',
  engine: 'engine',
  engineVersion: 'engineVersion',
  maintenanceWindow: 'maintenanceWindow',
  name: 'name',
  nodeType: 'nodeType',
  numShards: 123,
  parameterGroupName: 'parameterGroupName',
  port: 123,
  snapshotRetentionLimit: 123,
  snapshotWindow: 'snapshotWindow',
  subnetGroupName: 'subnetGroupName',
  topicArn: 'topicArn',
  vpcId: 'vpcId',
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the cluster configuration.
engineoptionalstringengineoptionalstrengineoptionalStringEngineoptionalstringEngineoptional*string#
The name of the engine used by the cluster configuration.
engineVersionoptionalstringengine_versionoptionalstrengineVersionoptionalStringEngineVersionoptionalstringEngineVersionoptional*string#
The Redis OSS engine version used by the cluster.
maintenanceWindowoptionalstringmaintenance_windowoptionalstrmaintenanceWindowoptionalStringMaintenanceWindowoptionalstringMaintenanceWindowoptional*string#
The specified maintenance window for the cluster.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the cluster.
nodeTypeoptionalstringnode_typeoptionalstrnodeTypeoptionalStringNodeTypeoptionalstringNodeTypeoptional*string#
The node type used for the cluster.
numShardsoptionalnumbernum_shardsoptionalint | floatnumShardsoptionalNumberNumShardsoptionaldoubleNumShardsoptional*float64#
The number of shards in the cluster.
parameterGroupNameoptionalstringparameter_group_nameoptionalstrparameterGroupNameoptionalStringParameterGroupNameoptionalstringParameterGroupNameoptional*string#
The name of parameter group used by the cluster.
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64#
The port used by the cluster.
snapshotRetentionLimitoptionalnumbersnapshot_retention_limitoptionalint | floatsnapshotRetentionLimitoptionalNumberSnapshotRetentionLimitoptionaldoubleSnapshotRetentionLimitoptional*float64#
The snapshot retention limit set by the cluster.
snapshotWindowoptionalstringsnapshot_windowoptionalstrsnapshotWindowoptionalStringSnapshotWindowoptionalstringSnapshotWindowoptional*string#
The snapshot window set by the cluster.
subnetGroupNameoptionalstringsubnet_group_nameoptionalstrsubnetGroupNameoptionalStringSubnetGroupNameoptionalstringSubnetGroupNameoptional*string#
The name of the subnet group used by the cluster.
topicArnoptionalstringtopic_arnoptionalstrtopicArnoptionalStringTopicArnoptionalstringTopicArnoptional*string#
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
vpcIdoptionalstringvpc_idoptionalstrvpcIdoptionalStringVpcIdoptionalstringVpcIdoptional*string#
The ID of the VPC the cluster belongs to.