IClusterInstance

class aws_cdk.aws_rds.IClusterInstance(*args, **kwargs)

Bases: Protocol

Represents an Aurora cluster instance This can be either a provisioned instance or a serverless v2 instance.

Methods

bind(scope, cluster, *, monitoring_interval=None, monitoring_role=None, promotion_tier=None, removal_policy=None, subnet_group=None)

Create the database instance within the provided cluster.

Parameters:

  • scope (Construct) –

  • cluster (IDatabaseCluster) –

  • monitoring_interval (Optional[Duration]) – The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances. Default: no enhanced monitoring

  • monitoring_role (Optional[IRole]) – Role that will be used to manage DB instances monitoring. Default: - A role is automatically created for you

  • promotion_tier (Union[int, float, None]) – 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

  • removal_policy (Optional[RemovalPolicy]) – The removal policy on the cluster. Default: - RemovalPolicy.DESTROY (cluster snapshot can restore)

  • subnet_group (Optional[ISubnetGroup]) – Existing subnet group for the cluster. This is only needed when using the isFromLegacyInstanceProps Default: - cluster subnet group is used

Return type:

IAuroraClusterInstance