CfnDBInstance.Builder

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

Enclosing class:: CfnDBInstance

public static final class CfnDBInstance.Builder
extends java.lang.Object

A fluent builder for CfnDBInstance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnDBInstance.Builder`	`autoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)` This parameter does not apply to Amazon DocumentDB.
`CfnDBInstance.Builder`	`autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)` This parameter does not apply to Amazon DocumentDB.
`CfnDBInstance.Builder`	`availabilityZone(java.lang.String availabilityZone)` The Amazon EC2 Availability Zone that the instance is created in.
`CfnDBInstance`	`build()`
`static CfnDBInstance.Builder`	`create(Construct scope, java.lang.String id)`
`CfnDBInstance.Builder`	`dbClusterIdentifier(java.lang.String dbClusterIdentifier)` The identifier of the cluster that the instance will belong to.
`CfnDBInstance.Builder`	`dbInstanceClass(java.lang.String dbInstanceClass)` The compute and memory capacity of the instance;
`CfnDBInstance.Builder`	`dbInstanceIdentifier(java.lang.String dbInstanceIdentifier)` The instance identifier.
`CfnDBInstance.Builder`	`enablePerformanceInsights(java.lang.Boolean enablePerformanceInsights)` `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
`CfnDBInstance.Builder`	`enablePerformanceInsights(IResolvable enablePerformanceInsights)` `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
`CfnDBInstance.Builder`	`preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)` The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
`CfnDBInstance.Builder`	`tags(java.util.List<? extends CfnTag> tags)` The tags to be assigned to the instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static CfnDBInstance.Builder create(Construct scope,
                                           java.lang.String id)
```
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    Returns:
    
    a new instance of CfnDBInstance.Builder.
  - dbClusterIdentifier
```
public CfnDBInstance.Builder dbClusterIdentifier(java.lang.String dbClusterIdentifier)
```
    The identifier of the cluster that the instance will belong to.
    
    Parameters:
    
    dbClusterIdentifier - The identifier of the cluster that the instance will belong to. This parameter is required.
    
    Returns:
    
    this
  - dbInstanceClass
```
public CfnDBInstance.Builder dbInstanceClass(java.lang.String dbInstanceClass)
```
    The compute and memory capacity of the instance;
    for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    
    Parameters:
    
    dbInstanceClass - The compute and memory capacity of the instance;. This parameter is required.
    
    Returns:
    
    this
  - autoMinorVersionUpgrade
```
public CfnDBInstance.Builder autoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
```
    This parameter does not apply to Amazon DocumentDB.
    Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
    Default: false
    
    Parameters:
    
    autoMinorVersionUpgrade - This parameter does not apply to Amazon DocumentDB. This parameter is required.
    
    Returns:
    
    this
  - autoMinorVersionUpgrade
```
public CfnDBInstance.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
```
    This parameter does not apply to Amazon DocumentDB.
    Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
    Default: false
    
    Parameters:
    
    autoMinorVersionUpgrade - This parameter does not apply to Amazon DocumentDB. This parameter is required.
    
    Returns:
    
    this
  - availabilityZone
```
public CfnDBInstance.Builder availabilityZone(java.lang.String 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
    
    Parameters:
    
    availabilityZone - The Amazon EC2 Availability Zone that the instance is created in. This parameter is required.
    
    Returns:
    
    this
  - dbInstanceIdentifier
```
public CfnDBInstance.Builder dbInstanceIdentifier(java.lang.String 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
    Parameters:
    
    dbInstanceIdentifier - The instance identifier. This parameter is stored as a lowercase string. This parameter is required.
    
    Returns:
    
    this
  - enablePerformanceInsights
```
public CfnDBInstance.Builder enablePerformanceInsights(java.lang.Boolean enablePerformanceInsights)
```
    `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
    
    Parameters:
    
    enablePerformanceInsights - `AWS::DocDB::DBInstance.EnablePerformanceInsights`. This parameter is required.
    
    Returns:
    
    this
  - enablePerformanceInsights
```
public CfnDBInstance.Builder enablePerformanceInsights(IResolvable enablePerformanceInsights)
```
    `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
    
    Parameters:
    
    enablePerformanceInsights - `AWS::DocDB::DBInstance.EnablePerformanceInsights`. This parameter is required.
    
    Returns:
    
    this
  - preferredMaintenanceWindow
```
public CfnDBInstance.Builder preferredMaintenanceWindow(java.lang.String 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.
    
    Parameters:
    
    preferredMaintenanceWindow - The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). This parameter is required.
    
    Returns:
    
    this
  - tags
```
public CfnDBInstance.Builder tags(java.util.List<? extends CfnTag> tags)
```
    The tags to be assigned to the instance.
    You can assign up to 10 tags to an instance.
    
    Parameters:
    
    tags - The tags to be assigned to the instance. This parameter is required.
    
    Returns:
    
    this
  - build
```
public CfnDBInstance build()
```

Class CfnDBInstance.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

dbClusterIdentifier

dbInstanceClass

autoMinorVersionUpgrade

autoMinorVersionUpgrade

availabilityZone

dbInstanceIdentifier

enablePerformanceInsights

enablePerformanceInsights

preferredMaintenanceWindow

tags

build