Package software.amazon.awscdk.services.rds

Interface ClusterInstanceBindOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterInstanceBindOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-24T21:15:59.091Z")
@Stability(Stable)
public interface ClusterInstanceBindOptions
extends software.amazon.jsii.JsiiSerializable

Options for binding the instance to the cluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.rds.*;
 Role role;
 SubnetGroup subnetGroup;
 ClusterInstanceBindOptions clusterInstanceBindOptions = ClusterInstanceBindOptions.builder()
         .monitoringInterval(Duration.minutes(30))
         .monitoringRole(role)
         .promotionTier(123)
         .removalPolicy(RemovalPolicy.DESTROY)
         .subnetGroup(subnetGroup)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ClusterInstanceBindOptions.Builder	builder()
default Duration	getMonitoringInterval()	The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
default IRole	getMonitoringRole()	Role that will be used to manage DB instances monitoring.
default Number	getPromotionTier()	The promotion tier of the cluster instance.
default RemovalPolicy	getRemovalPolicy()	The removal policy on the cluster.
default ISubnetGroup	getSubnetGroup()	Existing subnet group for the cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMonitoringInterval

@Stability(Stable)
@Nullable
default Duration getMonitoringInterval()

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.

Default: no enhanced monitoring

getMonitoringRole

@Stability(Stable)
@Nullable
default IRole getMonitoringRole()

Role that will be used to manage DB instances monitoring.

Default: - A role is automatically created for you

getPromotionTier

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

The promotion tier of the cluster instance.

This matters more for serverlessV2 instances. If a serverless instance is in tier 0-1 then it will scale with the writer.

For provisioned instances this just determines the failover priority. If multiple instances have the same priority then one will be picked at random

Default: 2

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy on the cluster.

Default: - RemovalPolicy.DESTROY (cluster snapshot can restore)

getSubnetGroup

@Stability(Stable)
@Nullable
default ISubnetGroup getSubnetGroup()

Existing subnet group for the cluster.

This is only needed when using the isFromLegacyInstanceProps

Default: - cluster subnet group is used

builder

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

Returns:

a ClusterInstanceBindOptions.Builder of ClusterInstanceBindOptions