2.184.1

interface ClusterInstanceBindOptions

LanguageType name
.NETAmazon.CDK.AWS.RDS.ClusterInstanceBindOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#ClusterInstanceBindOptions
Javasoftware.amazon.awscdk.services.rds.ClusterInstanceBindOptions
Pythonaws_cdk.aws_rds.ClusterInstanceBindOptions
TypeScript (source)aws-cdk-lib » aws_rds » ClusterInstanceBindOptions

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 * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';

declare const role: iam.Role;
declare const subnetGroup: rds.SubnetGroup;
const clusterInstanceBindOptions: rds.ClusterInstanceBindOptions = {
  monitoringInterval: cdk.Duration.minutes(30),
  monitoringRole: role,
  promotionTier: 123,
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  subnetGroup: subnetGroup,
};

Properties

NameTypeDescription
monitoringInterval?DurationThe interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
monitoringRole?IRoleRole that will be used to manage DB instances monitoring.
promotionTier?numberThe promotion tier of the cluster instance.
removalPolicy?RemovalPolicyThe removal policy on the cluster.
subnetGroup?ISubnetGroupExisting subnet group for the cluster.

monitoringInterval?

Type: Duration (optional, default: no enhanced monitoring)

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

monitoringRole?

Type: IRole (optional, default: A role is automatically created for you)

Role that will be used to manage DB instances monitoring.

promotionTier?

Type: number (optional, default: 2)

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

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY (cluster snapshot can restore))

The removal policy on the cluster.

subnetGroup?

Type: ISubnetGroup (optional, default: cluster subnet group is used)

Existing subnet group for the cluster.

This is only needed when using the isFromLegacyInstanceProps

← PreviousNext →