Skip to content
v2.275.0

ClusterEngineBindOptions Struct ​

The extra options passed to 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';
import { aws_iam as interfaces_iam } from 'aws-cdk-lib/interfaces';

declare const parameterGroup: rds.ParameterGroup;
declare const roleRef: interfaces_iam.IRoleRef;
const clusterEngineBindOptions: rds.ClusterEngineBindOptions = {
  parameterGroup: parameterGroup,
  s3ExportRole: roleRef,
  s3ImportRole: roleRef,
};

Properties ​

parameterGroupoptionalIParameterGroupparameter_groupoptionalIParameterGroupparameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroup= none#
The customer-provided ParameterGroup.
s3ExportRoleoptionalIRoleRefs3_export_roleoptionalIRoleRefs3ExportRoleoptionalIRoleRefS3ExportRoleoptionalIRoleRefS3ExportRoleoptionalIRoleRef= none#
The role used for S3 exporting.
s3ImportRoleoptionalIRoleRefs3_import_roleoptionalIRoleRefs3ImportRoleoptionalIRoleRefS3ImportRoleoptionalIRoleRefS3ImportRoleoptionalIRoleRef= none#
The role used for S3 importing.