Class ClusterInstanceOptions.Builder
java.lang.Object
software.amazon.awscdk.services.rds.ClusterInstanceOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<ClusterInstanceOptions>
- Enclosing interface:
ClusterInstanceOptions
@Stability(Stable)
public static final class ClusterInstanceOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ClusterInstanceOptions>
A builder for
ClusterInstanceOptions
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowMajorVersionUpgrade
(Boolean allowMajorVersionUpgrade) Sets the value ofClusterInstanceOptions.getAllowMajorVersionUpgrade()
applyImmediately
(Boolean applyImmediately) Sets the value ofClusterInstanceOptions.getApplyImmediately()
autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Sets the value ofClusterInstanceOptions.getAutoMinorVersionUpgrade()
availabilityZone
(String availabilityZone) Sets the value ofClusterInstanceOptions.getAvailabilityZone()
build()
Builds the configured instance.caCertificate
(CaCertificate caCertificate) Sets the value ofClusterInstanceOptions.getCaCertificate()
enablePerformanceInsights
(Boolean enablePerformanceInsights) Sets the value ofClusterInstanceOptions.getEnablePerformanceInsights()
instanceIdentifier
(String instanceIdentifier) Sets the value ofClusterInstanceOptions.getInstanceIdentifier()
isFromLegacyInstanceProps
(Boolean isFromLegacyInstanceProps) Sets the value ofClusterInstanceOptions.getIsFromLegacyInstanceProps()
parameterGroup
(IParameterGroup parameterGroup) Sets the value ofClusterInstanceOptions.getParameterGroup()
parameters
(Map<String, String> parameters) Sets the value ofClusterInstanceOptions.getParameters()
performanceInsightEncryptionKey
(IKey performanceInsightEncryptionKey) Sets the value ofClusterInstanceOptions.getPerformanceInsightEncryptionKey()
performanceInsightRetention
(PerformanceInsightRetention performanceInsightRetention) Sets the value ofClusterInstanceOptions.getPerformanceInsightRetention()
preferredMaintenanceWindow
(String preferredMaintenanceWindow) Sets the value ofClusterInstanceOptions.getPreferredMaintenanceWindow()
publiclyAccessible
(Boolean publiclyAccessible) Sets the value ofClusterInstanceOptions.getPubliclyAccessible()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowMajorVersionUpgrade
@Stability(Stable) public ClusterInstanceOptions.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) Sets the value ofClusterInstanceOptions.getAllowMajorVersionUpgrade()
- Parameters:
allowMajorVersionUpgrade
- Whether to allow upgrade of major version for the DB instance.- Returns:
this
-
applyImmediately
Sets the value ofClusterInstanceOptions.getApplyImmediately()
- Parameters:
applyImmediately
- Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of thepreferredMaintenanceWindow
setting. If set tofalse
, changes are applied during the next maintenance window.Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.
This property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.
- Returns:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public ClusterInstanceOptions.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Sets the value ofClusterInstanceOptions.getAutoMinorVersionUpgrade()
- Parameters:
autoMinorVersionUpgrade
- Whether to enable automatic upgrade of minor version for the DB instance.- Returns:
this
-
availabilityZone
Sets the value ofClusterInstanceOptions.getAvailabilityZone()
- Parameters:
availabilityZone
- The Availability Zone (AZ) where the database will be created. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.- Returns:
this
-
caCertificate
Sets the value ofClusterInstanceOptions.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 ClusterInstanceOptions.Builder enablePerformanceInsights(Boolean enablePerformanceInsights) Sets the value ofClusterInstanceOptions.getEnablePerformanceInsights()
- Parameters:
enablePerformanceInsights
- Whether to enable Performance Insights for the DB instance.- Returns:
this
-
instanceIdentifier
@Stability(Stable) public ClusterInstanceOptions.Builder instanceIdentifier(String instanceIdentifier) Sets the value ofClusterInstanceOptions.getInstanceIdentifier()
- Parameters:
instanceIdentifier
- The identifier for the database instance.- Returns:
this
-
isFromLegacyInstanceProps
@Stability(Stable) public ClusterInstanceOptions.Builder isFromLegacyInstanceProps(Boolean isFromLegacyInstanceProps) Sets the value ofClusterInstanceOptions.getIsFromLegacyInstanceProps()
- Parameters:
isFromLegacyInstanceProps
- Only used for migrating existing clusters from usinginstanceProps
towriter
andreaders
.- Returns:
this
-
parameterGroup
@Stability(Stable) public ClusterInstanceOptions.Builder parameterGroup(IParameterGroup parameterGroup) Sets the value ofClusterInstanceOptions.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
Sets the value ofClusterInstanceOptions.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 ClusterInstanceOptions.Builder performanceInsightEncryptionKey(IKey performanceInsightEncryptionKey) Sets the value ofClusterInstanceOptions.getPerformanceInsightEncryptionKey()
- Parameters:
performanceInsightEncryptionKey
- The AWS KMS key for encryption of Performance Insights data.- Returns:
this
-
performanceInsightRetention
@Stability(Stable) public ClusterInstanceOptions.Builder performanceInsightRetention(PerformanceInsightRetention performanceInsightRetention) Sets the value ofClusterInstanceOptions.getPerformanceInsightRetention()
- Parameters:
performanceInsightRetention
- The amount of time, in days, to retain Performance Insights data.- Returns:
this
-
preferredMaintenanceWindow
@Stability(Stable) public ClusterInstanceOptions.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofClusterInstanceOptions.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 ClusterInstanceOptions.Builder publiclyAccessible(Boolean publiclyAccessible) Sets the value ofClusterInstanceOptions.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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<ClusterInstanceOptions>
- Returns:
- a new instance of
ClusterInstanceOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-