Class CfnDBInstanceProps.Builder
java.lang.Object
software.amazon.awscdk.services.docdb.CfnDBInstanceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBInstanceProps>
- Enclosing interface:
- CfnDBInstanceProps
@Stability(Stable)
public static final class CfnDBInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBInstanceProps>
A builder for
CfnDBInstanceProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionautoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()availabilityZone(String availabilityZone) Sets the value ofCfnDBInstanceProps.getAvailabilityZone()build()Builds the configured instance.dbClusterIdentifier(String dbClusterIdentifier) Sets the value ofCfnDBInstanceProps.getDbClusterIdentifier()dbInstanceClass(String dbInstanceClass) Sets the value ofCfnDBInstanceProps.getDbInstanceClass()dbInstanceIdentifier(String dbInstanceIdentifier) Sets the value ofCfnDBInstanceProps.getDbInstanceIdentifier()enablePerformanceInsights(Boolean enablePerformanceInsights) Sets the value ofCfnDBInstanceProps.getEnablePerformanceInsights()enablePerformanceInsights(IResolvable enablePerformanceInsights) Sets the value ofCfnDBInstanceProps.getEnablePerformanceInsights()preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofCfnDBInstanceProps.getPreferredMaintenanceWindow()Sets the value ofCfnDBInstanceProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
dbClusterIdentifier
@Stability(Stable) public CfnDBInstanceProps.Builder dbClusterIdentifier(String dbClusterIdentifier) Sets the value ofCfnDBInstanceProps.getDbClusterIdentifier()- Parameters:
dbClusterIdentifier- The identifier of the cluster that the instance will belong to. This parameter is required.- Returns:
this
-
dbInstanceClass
Sets the value ofCfnDBInstanceProps.getDbInstanceClass()- Parameters:
dbInstanceClass- The compute and memory capacity of the instance;. This parameter is required. for example,db.m4.large. If you change the class of an instance there can be some interruption in the cluster's service.- Returns:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnDBInstanceProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()- Parameters:
autoMinorVersionUpgrade- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.Default:
false- Returns:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnDBInstanceProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()- Parameters:
autoMinorVersionUpgrade- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.Default:
false- Returns:
this
-
availabilityZone
Sets the value ofCfnDBInstanceProps.getAvailabilityZone()- Parameters:
availabilityZone- The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .Example:
us-east-1d- Returns:
this
-
dbInstanceIdentifier
@Stability(Stable) public CfnDBInstanceProps.Builder dbInstanceIdentifier(String dbInstanceIdentifier) Sets the value ofCfnDBInstanceProps.getDbInstanceIdentifier()- Parameters:
dbInstanceIdentifier- The instance identifier. This parameter is stored as a lowercase string. Constraints:- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance- Returns:
this
-
enablePerformanceInsights
@Stability(Stable) public CfnDBInstanceProps.Builder enablePerformanceInsights(Boolean enablePerformanceInsights) Sets the value ofCfnDBInstanceProps.getEnablePerformanceInsights()- Parameters:
enablePerformanceInsights-AWS::DocDB::DBInstance.EnablePerformanceInsights.- Returns:
this
-
enablePerformanceInsights
@Stability(Stable) public CfnDBInstanceProps.Builder enablePerformanceInsights(IResolvable enablePerformanceInsights) Sets the value ofCfnDBInstanceProps.getEnablePerformanceInsights()- Parameters:
enablePerformanceInsights-AWS::DocDB::DBInstance.EnablePerformanceInsights.- Returns:
this
-
preferredMaintenanceWindow
@Stability(Stable) public CfnDBInstanceProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofCfnDBInstanceProps.getPreferredMaintenanceWindow()- Parameters:
preferredMaintenanceWindow- The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:ddd:hh24:mi-ddd:hh24:miThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- Returns:
this
-
tags
Sets the value ofCfnDBInstanceProps.getTags()- Parameters:
tags- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDBInstanceProps>- Returns:
- a new instance of
CfnDBInstanceProps - Throws:
NullPointerException- if any required attribute was not provided
-