ClusterInstanceBindOptions Struct
Options for binding the instance to the cluster.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
import { aws_iam as interfaces_iam } from 'aws-cdk-lib/interfaces';
import { aws_rds as interfaces_rds } from 'aws-cdk-lib/interfaces';
declare const dBSubnetGroupRef: interfaces_rds.IDBSubnetGroupRef;
declare const roleRef: interfaces_iam.IRoleRef;
const clusterInstanceBindOptions: rds.ClusterInstanceBindOptions = {
monitoringInterval: cdk.Duration.minutes(30),
monitoringRole: roleRef,
promotionTier: 123,
removalPolicy: cdk.RemovalPolicy.DESTROY,
subnetGroup: dBSubnetGroupRef,
};
Properties
monitoringIntervaloptionalDurationmonitoring_intervaloptionalDurationmonitoringIntervaloptionalDurationMonitoringIntervaloptionalDurationMonitoringIntervaloptionalDuration#The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
Default: no enhanced monitoring
monitoringRoleoptionalIRoleRefmonitoring_roleoptionalIRoleRefmonitoringRoleoptionalIRoleRefMonitoringRoleoptionalIRoleRefMonitoringRoleoptionalIRoleRef#Role that will be used to manage DB instances monitoring.
Default: A role is automatically created for you
promotionTieroptionalnumberpromotion_tieroptionalint | floatpromotionTieroptionalNumberPromotionTieroptionaldoublePromotionTieroptional*float64= 2#The promotion tier of the cluster instance.
notes
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
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy#The removal policy on the cluster.
Default: RemovalPolicy.DESTROY (cluster snapshot can restore)
subnetGroupoptionalIDBSubnetGroupRefsubnet_groupoptionalIDBSubnetGroupRefsubnetGroupoptionalIDBSubnetGroupRefSubnetGroupoptionalIDBSubnetGroupRefSubnetGroupoptionalIDBSubnetGroupRef#Existing subnet group for the cluster.
Default: cluster subnet group is used
This is only needed when using the isFromLegacyInstanceProps