interface ClusterEngineBindOptions

Language	Type name
.NET	Amazon.CDK.AWS.RDS.ClusterEngineBindOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#ClusterEngineBindOptions
Java	software.amazon.awscdk.services.rds.ClusterEngineBindOptions
Python	aws_cdk.aws_rds.ClusterEngineBindOptions
TypeScript (source)	aws-cdk-lib » aws_rds » ClusterEngineBindOptions

The extra options passed to 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_iam as iam } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';

declare const parameterGroup: rds.ParameterGroup;
declare const role: iam.Role;
const clusterEngineBindOptions: rds.ClusterEngineBindOptions = {
  parameterGroup: parameterGroup,
  s3ExportRole: role,
  s3ImportRole: role,
};

Properties

Name	Type	Description
parameterGroup?	IParameterGroup	The customer-provided ParameterGroup.
s3ExportRole?	IRole	The role used for S3 exporting.
s3ImportRole?	IRole	The role used for S3 importing.

---

parameterGroup?

Type: IParameterGroup (optional, default: none)

The customer-provided ParameterGroup.

---

s3ExportRole?

Type: IRole (optional, default: none)

The role used for S3 exporting.

---

s3ImportRole?

Type: IRole (optional, default: none)

The role used for S3 importing.