Package software.amazon.awscdk.services.rds

Interface ProvisionedClusterInstanceProps

All Superinterfaces:

ClusterInstanceOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ProvisionedClusterInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:45.592Z")
@Stability(Stable)
public interface ProvisionedClusterInstanceProps
extends software.amazon.jsii.JsiiSerializable, ClusterInstanceOptions

Options for creating a provisioned instance.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_3_01_0).build()))
         .writer(ClusterInstance.provisioned("Instance", ProvisionedClusterInstanceProps.builder()
                 .instanceType(InstanceType.of(InstanceClass.BURSTABLE3, InstanceSize.SMALL))
                 .build()))
         .readers(List.of(ClusterInstance.provisioned("reader")))
         .instanceUpdateBehaviour(InstanceUpdateBehaviour.ROLLING) // Optional - defaults to rds.InstanceUpdateBehaviour.BULK
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ProvisionedClusterInstanceProps.Builder	builder()
default InstanceType	getInstanceType()	The cluster instance type.
default Number	getPromotionTier()	The promotion tier of the cluster instance.

Methods inherited from interface software.amazon.awscdk.services.rds.ClusterInstanceOptions

getAllowMajorVersionUpgrade, getApplyImmediately, getAutoMinorVersionUpgrade, getAvailabilityZone, getCaCertificate, getEnablePerformanceInsights, getInstanceIdentifier, getIsFromLegacyInstanceProps, getParameterGroup, getParameters, getPerformanceInsightEncryptionKey, getPerformanceInsightRetention, getPreferredMaintenanceWindow, getPubliclyAccessible

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@Nullable
default InstanceType getInstanceType()

The cluster instance type.

Default: db.t3.medium

getPromotionTier

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

The promotion tier of the cluster instance.

Can be between 0-15

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

builder

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

Returns:

a ProvisionedClusterInstanceProps.Builder of ProvisionedClusterInstanceProps