Package software.amazon.awscdk.services.docdb

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDBInstanceProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of CfnDBInstanceProps.getAutoMinorVersionUpgrade()
CfnDBInstanceProps.Builder	autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)	Sets the value of CfnDBInstanceProps.getAutoMinorVersionUpgrade()
CfnDBInstanceProps.Builder	availabilityZone(String availabilityZone)	Sets the value of CfnDBInstanceProps.getAvailabilityZone()
CfnDBInstanceProps	build()	Builds the configured instance.
CfnDBInstanceProps.Builder	caCertificateIdentifier(String caCertificateIdentifier)	Sets the value of CfnDBInstanceProps.getCaCertificateIdentifier()
CfnDBInstanceProps.Builder	certificateRotationRestart(Boolean certificateRotationRestart)	Sets the value of CfnDBInstanceProps.getCertificateRotationRestart()
CfnDBInstanceProps.Builder	certificateRotationRestart(IResolvable certificateRotationRestart)	Sets the value of CfnDBInstanceProps.getCertificateRotationRestart()
CfnDBInstanceProps.Builder	dbClusterIdentifier(String dbClusterIdentifier)	Sets the value of CfnDBInstanceProps.getDbClusterIdentifier()
CfnDBInstanceProps.Builder	dbInstanceClass(String dbInstanceClass)	Sets the value of CfnDBInstanceProps.getDbInstanceClass()
CfnDBInstanceProps.Builder	dbInstanceIdentifier(String dbInstanceIdentifier)	Sets the value of CfnDBInstanceProps.getDbInstanceIdentifier()
CfnDBInstanceProps.Builder	enablePerformanceInsights(Boolean enablePerformanceInsights)	Sets the value of CfnDBInstanceProps.getEnablePerformanceInsights()
CfnDBInstanceProps.Builder	enablePerformanceInsights(IResolvable enablePerformanceInsights)	Sets the value of CfnDBInstanceProps.getEnablePerformanceInsights()
CfnDBInstanceProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of CfnDBInstanceProps.getPreferredMaintenanceWindow()
CfnDBInstanceProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDBInstanceProps.getTags()

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

dbClusterIdentifier

@Stability(Stable)
public CfnDBInstanceProps.Builder dbClusterIdentifier(String dbClusterIdentifier)

Sets the value of CfnDBInstanceProps.getDbClusterIdentifier()

Parameters:

dbClusterIdentifier - The identifier of the cluster that the instance will belong to. This parameter is required.

Returns:

this

dbInstanceClass

@Stability(Stable)
public CfnDBInstanceProps.Builder dbInstanceClass(String dbInstanceClass)

Sets the value of CfnDBInstanceProps.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 of CfnDBInstanceProps.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 of CfnDBInstanceProps.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

@Stability(Stable)
public CfnDBInstanceProps.Builder availabilityZone(String availabilityZone)

Sets the value of CfnDBInstanceProps.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

caCertificateIdentifier

@Stability(Stable)
public CfnDBInstanceProps.Builder caCertificateIdentifier(String caCertificateIdentifier)

Sets the value of CfnDBInstanceProps.getCaCertificateIdentifier()

Parameters:

caCertificateIdentifier - The CA certificate identifier to use for the DB instance's server certificate. For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

Returns:

this

certificateRotationRestart

@Stability(Stable)
public CfnDBInstanceProps.Builder certificateRotationRestart(Boolean certificateRotationRestart)

Sets the value of CfnDBInstanceProps.getCertificateRotationRestart()

Parameters:

certificateRotationRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

Returns:

this

certificateRotationRestart

@Stability(Stable)
public CfnDBInstanceProps.Builder certificateRotationRestart(IResolvable certificateRotationRestart)

Sets the value of CfnDBInstanceProps.getCertificateRotationRestart()

Parameters:

certificateRotationRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

Returns:

this

dbInstanceIdentifier

@Stability(Stable)
public CfnDBInstanceProps.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

Sets the value of CfnDBInstanceProps.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 of CfnDBInstanceProps.getEnablePerformanceInsights()

Parameters:

enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .

Returns:

this

enablePerformanceInsights

@Stability(Stable)
public CfnDBInstanceProps.Builder enablePerformanceInsights(IResolvable enablePerformanceInsights)

Sets the value of CfnDBInstanceProps.getEnablePerformanceInsights()

Parameters:

enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .

Returns:

this

preferredMaintenanceWindow

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

Sets the value of CfnDBInstanceProps.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:mi

The 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

@Stability(Stable)
public CfnDBInstanceProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDBInstanceProps.getTags()

Parameters:

tags - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Returns:

this

build

@Stability(Stable)
public CfnDBInstanceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDBInstanceProps

Throws:

NullPointerException - if any required attribute was not provided