Skip to content
v2.277.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,
};
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
from aws_cdk.interfaces import aws_iam as interfaces_iam

# parameter_group: rds.ParameterGroup
# role_ref: interfaces_iam.IRoleRef

cluster_engine_bind_options = rds.ClusterEngineBindOptions(
    parameter_group=parameter_group,
    s3_export_role=role_ref,
    s3_import_role=role_ref
)
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.*;
import software.amazon.awscdk.interfaces.iam.*;

ParameterGroup parameterGroup;
IRoleRef roleRef;

ClusterEngineBindOptions clusterEngineBindOptions = ClusterEngineBindOptions.builder()
        .parameterGroup(parameterGroup)
        .s3ExportRole(roleRef)
        .s3ImportRole(roleRef)
        .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;
using Amazon.CDK.Interfaces.IAM;

ParameterGroup parameterGroup;
IRoleRef roleRef;

var clusterEngineBindOptions = new ClusterEngineBindOptions {
    ParameterGroup = parameterGroup,
    S3ExportRole = roleRef,
    S3ImportRole = roleRef
};
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"
import "github.com/aws/aws-cdk-go/awscdk"

var parameterGroup ParameterGroup
var roleRef IRoleRef

clusterEngineBindOptions := &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.