Package software.amazon.awscdk.services.docdb

Interface CfnDBInstanceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDBInstanceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.900Z") @Stability(Stable) public interface CfnDBInstanceProps extends software.amazon.jsii.JsiiSerializable
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();

  • Method Details

    • getDbClusterIdentifier

      @Stability(Stable) @NotNull String getDbClusterIdentifier()
      The identifier of the cluster that the instance will belong to.

    • getDbInstanceClass

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default Object getEnablePerformanceInsights()
      AWS::DocDB::DBInstance.EnablePerformanceInsights.

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The tags to be assigned to the instance.

      You can assign up to 10 tags to an instance.

    • builder

      @Stability(Stable) static CfnDBInstanceProps.Builder builder()
      Returns:
      a CfnDBInstanceProps.Builder of CfnDBInstanceProps