CfnDBInstanceProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.docdb.CfnDBInstanceProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnDBInstanceProps>

Enclosing interface:: CfnDBInstanceProps

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

A builder for CfnDBInstanceProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`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 Detail
  - Builder
```
public Builder()
```
- Method Detail
  - dbClusterIdentifier
```
@Stability(value=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(value=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(value=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(value=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(value=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
  - dbInstanceIdentifier
```
@Stability(value=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(value=Stable)
public CfnDBInstanceProps.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
```
    Sets the value of CfnDBInstanceProps.getEnablePerformanceInsights()
    
    Parameters:
    
    enablePerformanceInsights - `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
    
    Returns:
    
    this
  - enablePerformanceInsights
```
@Stability(value=Stable)
public CfnDBInstanceProps.Builder enablePerformanceInsights(IResolvable enablePerformanceInsights)
```
    Sets the value of CfnDBInstanceProps.getEnablePerformanceInsights()
    
    Parameters:
    
    enablePerformanceInsights - `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
    
    Returns:
    
    this
  - preferredMaintenanceWindow
```
@Stability(value=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(value=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(value=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

Class CfnDBInstanceProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

dbClusterIdentifier

dbInstanceClass

autoMinorVersionUpgrade

autoMinorVersionUpgrade

availabilityZone

dbInstanceIdentifier

enablePerformanceInsights

enablePerformanceInsights

preferredMaintenanceWindow

tags

build