Skip to content
v2.274.0

ClusterEngineConfig Struct ​

The type returned from the IClusterEngine.bindToCluster method.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';

declare const parameterGroup: rds.ParameterGroup;
const clusterEngineConfig: rds.ClusterEngineConfig = {
  features: {
    s3Export: 's3Export',
    s3Import: 's3Import',
    serverlessV2AutoPauseSupported: false,
  },
  parameterGroup: parameterGroup,
  port: 123,
};

Properties ​

featuresoptionalClusterEngineFeaturesfeaturesoptionalClusterEngineFeaturesfeaturesoptionalClusterEngineFeaturesFeaturesoptionalClusterEngineFeaturesFeaturesoptionalClusterEngineFeatures#
Features supported by the database engine.

Default: no features

parameterGroupoptionalIParameterGroupparameter_groupoptionalIParameterGroupparameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroup#
The ParameterGroup to use for the cluster.

Default: no ParameterGroup will be used

portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64#
The port to use for this cluster, unless the customer specified the port directly.

Default: use the default port for clusters (3306)