aws-cdk-lib.aws_rds.ClusterEngineConfig

interface ClusterEngineConfig

LanguageType name
.NETAmazon.CDK.AWS.RDS.ClusterEngineConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#ClusterEngineConfig
Javasoftware.amazon.awscdk.services.rds.ClusterEngineConfig
Pythonaws_cdk.aws_rds.ClusterEngineConfig
TypeScript (source)aws-cdk-lib » aws_rds » ClusterEngineConfig

The type returned from the IClusterEngine.bindToCluster method.

Example

// 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',
  },
  parameterGroup: parameterGroup,
  port: 123,
};

Properties

NameTypeDescription
features?ClusterEngineFeaturesFeatures supported by the database engine.
parameterGroup?IParameterGroupThe ParameterGroup to use for the cluster.
port?numberThe port to use for this cluster, unless the customer specified the port directly.

features?

Type: ClusterEngineFeatures (optional, default: no features)

Features supported by the database engine.

See also: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html


parameterGroup?

Type: IParameterGroup (optional, default: no ParameterGroup will be used)

The ParameterGroup to use for the cluster.


port?

Type: number (optional, default: use the default port for clusters (3306))

The port to use for this cluster, unless the customer specified the port directly.