Package software.amazon.awscdk.services.rds

Interface ClusterEngineConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterEngineConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:35.116Z")
@Stability(Stable)
public interface ClusterEngineConfig
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.rds.*;
 ParameterGroup parameterGroup;
 ClusterEngineConfig clusterEngineConfig = ClusterEngineConfig.builder()
         .features(ClusterEngineFeatures.builder()
                 .s3Export("s3Export")
                 .s3Import("s3Import")
                 .build())
         .parameterGroup(parameterGroup)
         .port(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ClusterEngineConfig.Builder	builder()
default ClusterEngineFeatures	getFeatures()	Features supported by the database engine.
default IParameterGroup	getParameterGroup()	The ParameterGroup to use for the cluster.
default Number	getPort()	The port to use for this cluster, unless the customer specified the port directly.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFeatures

@Stability(Stable)
@Nullable
default ClusterEngineFeatures getFeatures()

Features supported by the database engine.

Default: - no features

See Also:

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

getParameterGroup

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

The ParameterGroup to use for the cluster.

Default: - no ParameterGroup will be used

getPort

@Stability(Stable)
@Nullable
default Number getPort()

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

Default: - use the default port for clusters (3306)

builder

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

Returns:

a ClusterEngineConfig.Builder of ClusterEngineConfig