Package software.amazon.awscdk.services.rds

Interface ClusterEngineBindOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterEngineBindOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:18.863Z")
@Stability(Stable)
public interface ClusterEngineBindOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.rds.*;
 ParameterGroup parameterGroup;
 IRoleRef roleRef;
 ClusterEngineBindOptions clusterEngineBindOptions = ClusterEngineBindOptions.builder()
         .parameterGroup(parameterGroup)
         .s3ExportRole(roleRef)
         .s3ImportRole(roleRef)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClusterEngineBindOptions.Builder	A builder for ClusterEngineBindOptions
static final class	ClusterEngineBindOptions.Jsii$Proxy	An implementation for ClusterEngineBindOptions

Method Summary

Modifier and Type	Method	Description
static ClusterEngineBindOptions.Builder	builder()
default IParameterGroup	getParameterGroup()	The customer-provided ParameterGroup.
default IRoleRef	getS3ExportRole()	The role used for S3 exporting.
default IRoleRef	getS3ImportRole()	The role used for S3 importing.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParameterGroup

@Stability(Stable)
@Nullable
default IParameterGroup getParameterGroup()

The customer-provided ParameterGroup.

Default: - none

getS3ExportRole

@Stability(Stable)
@Nullable
default IRoleRef getS3ExportRole()

The role used for S3 exporting.

Default: - none

getS3ImportRole

@Stability(Stable)
@Nullable
default IRoleRef getS3ImportRole()

The role used for S3 importing.

Default: - none

builder

@Stability(Stable)
static ClusterEngineBindOptions.Builder builder()

Returns:

a ClusterEngineBindOptions.Builder of ClusterEngineBindOptions