Interface ServerlessV2ClusterInstanceProps

All Superinterfaces:
ClusterInstanceOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ServerlessV2ClusterInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:23.620Z") @Stability(Stable) public interface ServerlessV2ClusterInstanceProps extends software.amazon.jsii.JsiiSerializable, ClusterInstanceOptions
Options for creating a serverless v2 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("writer", ProvisionedClusterInstanceProps.builder()
                 .caCertificate(CaCertificate.RDS_CA_RDS2048_G1)
                 .build()))
         .readers(List.of(ClusterInstance.serverlessV2("reader", ServerlessV2ClusterInstanceProps.builder()
                 .caCertificate(CaCertificate.of("custom-ca"))
                 .build())))
         .vpc(vpc)
         .build();
 
  • Method Details

    • getScaleWithWriter

      @Stability(Stable) @Nullable default Boolean getScaleWithWriter()
      Only applicable to reader instances.

      If this is true then the instance will be placed in promotion tier 1, otherwise it will be placed in promotion tier 2.

      For serverless v2 instances this means:

      • true: The serverless v2 reader will scale to match the writer instance (provisioned or serverless)
      • false: The serverless v2 reader will scale with the read workfload on the instance

      Default: false

    • builder

      @Stability(Stable) static ServerlessV2ClusterInstanceProps.Builder builder()
      Returns:
      a ServerlessV2ClusterInstanceProps.Builder of ServerlessV2ClusterInstanceProps