Package software.amazon.awscdk.services.rds

Class ServerlessV2ClusterInstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.ServerlessV2ClusterInstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServerlessV2ClusterInstanceProps>

Enclosing interface:

ServerlessV2ClusterInstanceProps

@Stability(Stable)
public static final class ServerlessV2ClusterInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<ServerlessV2ClusterInstanceProps>

A builder for ServerlessV2ClusterInstanceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ServerlessV2ClusterInstanceProps.Builder	allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)	Sets the value of ClusterInstanceOptions.getAllowMajorVersionUpgrade()
ServerlessV2ClusterInstanceProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of ClusterInstanceOptions.getAutoMinorVersionUpgrade()
ServerlessV2ClusterInstanceProps	build()	Builds the configured instance.
ServerlessV2ClusterInstanceProps.Builder	caCertificate(CaCertificate caCertificate)	Sets the value of ClusterInstanceOptions.getCaCertificate()
ServerlessV2ClusterInstanceProps.Builder	enablePerformanceInsights(Boolean enablePerformanceInsights)	Sets the value of ClusterInstanceOptions.getEnablePerformanceInsights()
ServerlessV2ClusterInstanceProps.Builder	instanceIdentifier(String instanceIdentifier)	Sets the value of ClusterInstanceOptions.getInstanceIdentifier()
ServerlessV2ClusterInstanceProps.Builder	isFromLegacyInstanceProps(Boolean isFromLegacyInstanceProps)	Sets the value of ClusterInstanceOptions.getIsFromLegacyInstanceProps()
ServerlessV2ClusterInstanceProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of ClusterInstanceOptions.getParameterGroup()
ServerlessV2ClusterInstanceProps.Builder	parameters(Map<String,String> parameters)	Sets the value of ClusterInstanceOptions.getParameters()
ServerlessV2ClusterInstanceProps.Builder	performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)	Sets the value of ClusterInstanceOptions.getPerformanceInsightEncryptionKey()
ServerlessV2ClusterInstanceProps.Builder	performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)	Sets the value of ClusterInstanceOptions.getPerformanceInsightRetention()
ServerlessV2ClusterInstanceProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of ClusterInstanceOptions.getPreferredMaintenanceWindow()
ServerlessV2ClusterInstanceProps.Builder	publiclyAccessible(Boolean publiclyAccessible)	Sets the value of ClusterInstanceOptions.getPubliclyAccessible()
ServerlessV2ClusterInstanceProps.Builder	scaleWithWriter(Boolean scaleWithWriter)	Sets the value of ServerlessV2ClusterInstanceProps.getScaleWithWriter()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

scaleWithWriter

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder scaleWithWriter(Boolean scaleWithWriter)

Sets the value of ServerlessV2ClusterInstanceProps.getScaleWithWriter()

Parameters:

scaleWithWriter - 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

Returns:

this

allowMajorVersionUpgrade

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

Sets the value of ClusterInstanceOptions.getAllowMajorVersionUpgrade()

Parameters:

allowMajorVersionUpgrade - Whether to allow upgrade of major version for the DB instance.

Returns:

this

autoMinorVersionUpgrade

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Sets the value of ClusterInstanceOptions.getAutoMinorVersionUpgrade()

Parameters:

autoMinorVersionUpgrade - Whether to enable automatic upgrade of minor version for the DB instance.

Returns:

this

caCertificate

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder caCertificate(CaCertificate caCertificate)

Sets the value of ClusterInstanceOptions.getCaCertificate()

Parameters:

caCertificate - The identifier of the CA certificate for this DB cluster's instances. Specifying or updating this property triggers a reboot.

For RDS DB engines:

Returns:

this

enablePerformanceInsights

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)

Sets the value of ClusterInstanceOptions.getEnablePerformanceInsights()

Parameters:

enablePerformanceInsights - Whether to enable Performance Insights for the DB instance.

Returns:

this

instanceIdentifier

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder instanceIdentifier(String instanceIdentifier)

Sets the value of ClusterInstanceOptions.getInstanceIdentifier()

Parameters:

instanceIdentifier - The identifier for the database instance.

Returns:

this

isFromLegacyInstanceProps

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder isFromLegacyInstanceProps(Boolean isFromLegacyInstanceProps)

Sets the value of ClusterInstanceOptions.getIsFromLegacyInstanceProps()

Parameters:

isFromLegacyInstanceProps - Only used for migrating existing clusters from using instanceProps to writer and readers.

Returns:

this

parameterGroup

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder parameterGroup(IParameterGroup parameterGroup)

Sets the value of ClusterInstanceOptions.getParameterGroup()

Parameters:

parameterGroup - The DB parameter group to associate with the instance. This is only needed if you need to configure different parameter groups for each individual instance, otherwise you should not provide this and just use the cluster parameter group

Returns:

this

parameters

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder parameters(Map<String,String> parameters)

Sets the value of ClusterInstanceOptions.getParameters()

Parameters:

parameters - The parameters in the DBParameterGroup to create automatically. You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.

Returns:

this

performanceInsightEncryptionKey

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey)

Sets the value of ClusterInstanceOptions.getPerformanceInsightEncryptionKey()

Parameters:

performanceInsightEncryptionKey - The AWS KMS key for encryption of Performance Insights data.

Returns:

this

performanceInsightRetention

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention)

Sets the value of ClusterInstanceOptions.getPerformanceInsightRetention()

Parameters:

performanceInsightRetention - The amount of time, in days, to retain Performance Insights data.

Returns:

this

preferredMaintenanceWindow

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of ClusterInstanceOptions.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: 'Sun:23:45-Mon:00:15'

Returns:

this

publiclyAccessible

@Stability(Stable)
public ServerlessV2ClusterInstanceProps.Builder publiclyAccessible(Boolean publiclyAccessible)

Sets the value of ClusterInstanceOptions.getPubliclyAccessible()

Parameters:

publiclyAccessible - Indicates whether the DB instance is an internet-facing instance. If not specified, the cluster's vpcSubnets will be used to determine if the instance is internet-facing or not.

Returns:

this

build

@Stability(Stable)
public ServerlessV2ClusterInstanceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ServerlessV2ClusterInstanceProps>

Returns:

a new instance of ServerlessV2ClusterInstanceProps

Throws:

NullPointerException - if any required attribute was not provided