Skip to content
v2.278.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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

# parameter_group: rds.ParameterGroup

cluster_engine_config = rds.ClusterEngineConfig(
    features=rds.ClusterEngineFeatures(
        s3_export="s3Export",
        s3_import="s3Import",
        serverless_v2_auto_pause_supported=False
    ),
    parameter_group=parameter_group,
    port=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;

ParameterGroup parameterGroup;

ClusterEngineConfig clusterEngineConfig = ClusterEngineConfig.builder()
        .features(ClusterEngineFeatures.builder()
                .s3Export("s3Export")
                .s3Import("s3Import")
                .serverlessV2AutoPauseSupported(false)
                .build())
        .parameterGroup(parameterGroup)
        .port(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;

ParameterGroup parameterGroup;

var clusterEngineConfig = new ClusterEngineConfig {
    Features = new ClusterEngineFeatures {
        S3Export = "s3Export",
        S3Import = "s3Import",
        ServerlessV2AutoPauseSupported = false
    },
    ParameterGroup = parameterGroup,
    Port = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var parameterGroup ParameterGroup

clusterEngineConfig := &ClusterEngineConfig{
	Features: &ClusterEngineFeatures{
		S3Export: jsii.String("s3Export"),
		S3Import: jsii.String("s3Import"),
		ServerlessV2AutoPauseSupported: jsii.Boolean(false),
	},
	ParameterGroup: parameterGroup,
	Port: jsii.Number(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)