Package software.amazon.awscdk.services.rds

Interface ClusterInstanceProps

All Superinterfaces:

ClusterInstanceOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:37.986Z")
@Stability(Stable)
public interface ClusterInstanceProps
extends software.amazon.jsii.JsiiSerializable, ClusterInstanceOptions

Common options for creating cluster instances (both serverless and provisioned).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.rds.*;
 CaCertificate caCertificate;
 ClusterInstanceType clusterInstanceType;
 Key key;
 ParameterGroup parameterGroup;
 ClusterInstanceProps clusterInstanceProps = ClusterInstanceProps.builder()
         .instanceType(clusterInstanceType)
         // the properties below are optional
         .allowMajorVersionUpgrade(false)
         .autoMinorVersionUpgrade(false)
         .caCertificate(caCertificate)
         .enablePerformanceInsights(false)
         .instanceIdentifier("instanceIdentifier")
         .isFromLegacyInstanceProps(false)
         .parameterGroup(parameterGroup)
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .performanceInsightEncryptionKey(key)
         .performanceInsightRetention(PerformanceInsightRetention.DEFAULT)
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .promotionTier(123)
         .publiclyAccessible(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ClusterInstanceProps.Builder	builder()
ClusterInstanceType	getInstanceType()	The type of cluster instance to create.
default Number	getPromotionTier()	The promotion tier of the cluster instance.

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

getAllowMajorVersionUpgrade, getAutoMinorVersionUpgrade, 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)
@NotNull
ClusterInstanceType getInstanceType()

The type of cluster instance to create.

Can be either provisioned or serverless v2

getPromotionTier

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

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

builder

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

Returns:

a ClusterInstanceProps.Builder of ClusterInstanceProps