Interface IClusterInstanceBindOptions
Options for binding the instance to the cluster.
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IClusterInstanceBindOptions
Syntax (vb)
Public Interface IClusterInstanceBindOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.RDS;
Role role;
SubnetGroup subnetGroup;
var clusterInstanceBindOptions = new ClusterInstanceBindOptions {
MonitoringInterval = Duration.Minutes(30),
MonitoringRole = role,
PromotionTier = 123,
RemovalPolicy = RemovalPolicy.DESTROY,
SubnetGroup = subnetGroup
};
Synopsis
Properties
MonitoringInterval | The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances. |
MonitoringRole | Role that will be used to manage DB instances monitoring. |
PromotionTier | The promotion tier of the cluster instance. |
RemovalPolicy | The removal policy on the cluster. |
SubnetGroup | Existing subnet group for the cluster. |
Properties
MonitoringInterval
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.
virtual Duration MonitoringInterval { get; }
Property Value
Remarks
Default: no enhanced monitoring
MonitoringRole
Role that will be used to manage DB instances monitoring.
virtual IRole MonitoringRole { get; }
Property Value
Remarks
Default: - A role is automatically created for you
PromotionTier
The promotion tier of the cluster instance.
virtual Nullable<double> PromotionTier { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
RemovalPolicy
The removal policy on the cluster.
virtual Nullable<RemovalPolicy> RemovalPolicy { get; }
Property Value
System.Nullable<RemovalPolicy>
Remarks
Default: - RemovalPolicy.DESTROY (cluster snapshot can restore)
SubnetGroup
Existing subnet group for the cluster.
virtual ISubnetGroup SubnetGroup { get; }
Property Value
Remarks
This is only needed when using the isFromLegacyInstanceProps
Default: - cluster subnet group is used