software.amazon.awscdk.services.docdb

Interface CfnDBInstanceProps

All Known Implementing Classes:

CfnDBInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:28:01.849Z")
public interface CfnDBInstanceProps

Properties for defining a `CfnDBInstance`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.docdb.*;
 CfnDBInstanceProps cfnDBInstanceProps = CfnDBInstanceProps.builder()
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbInstanceClass("dbInstanceClass")
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .enablePerformanceInsights(false)
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDBInstanceProps.Builder A builder for CfnDBInstanceProps
static class	CfnDBInstanceProps.Jsii$Proxy An implementation for CfnDBInstanceProps

Method Summary

Modifier and Type	Method and Description
static CfnDBInstanceProps.Builder	builder()
default java.lang.Object	getAutoMinorVersionUpgrade() This parameter does not apply to Amazon DocumentDB.
default java.lang.String	getAvailabilityZone() The Amazon EC2 Availability Zone that the instance is created in.
java.lang.String	getDbClusterIdentifier() The identifier of the cluster that the instance will belong to.
java.lang.String	getDbInstanceClass() The compute and memory capacity of the instance;
default java.lang.String	getDbInstanceIdentifier() The instance identifier.
default java.lang.Object	getEnablePerformanceInsights() `AWS::DocDB::DBInstance.EnablePerformanceInsights`.
default java.lang.String	getPreferredMaintenanceWindow() The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
default java.util.List<CfnTag>	getTags() The tags to be assigned to the instance.

Method Detail

getDbClusterIdentifier

java.lang.String getDbClusterIdentifier()

The identifier of the cluster that the instance will belong to.

getDbInstanceClass

java.lang.String getDbInstanceClass()

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.

getAutoMinorVersionUpgrade

default java.lang.Object getAutoMinorVersionUpgrade()

This parameter does not apply to Amazon DocumentDB.

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

getAvailabilityZone

default java.lang.String getAvailabilityZone()

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

getDbInstanceIdentifier

default java.lang.String getDbInstanceIdentifier()

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

getEnablePerformanceInsights

default java.lang.Object getEnablePerformanceInsights()

`AWS::DocDB::DBInstance.EnablePerformanceInsights`.

getPreferredMaintenanceWindow

default java.lang.String getPreferredMaintenanceWindow()

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.

getTags

default java.util.List<CfnTag> getTags()

The tags to be assigned to the instance.

You can assign up to 10 tags to an instance.

builder

static CfnDBInstanceProps.Builder builder()

Returns:

a CfnDBInstanceProps.Builder of CfnDBInstanceProps