Package software.amazon.awscdk.services.docdb

Interface DatabaseInstanceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DatabaseInstanceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-09-06T01:36:26.335Z") @Stability(Stable) public interface DatabaseInstanceProps extends software.amazon.jsii.JsiiSerializable
Construction properties for a DatabaseInstanceNew.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.docdb.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 CaCertificate caCertificate;
 DatabaseCluster databaseCluster;
 InstanceType instanceType;
 DatabaseInstanceProps databaseInstanceProps = DatabaseInstanceProps.builder()
         .cluster(databaseCluster)
         .instanceType(instanceType)
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .caCertificate(caCertificate)
         .dbInstanceName("dbInstanceName")
         .enablePerformanceInsights(false)
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();

  • Method Details

    • getCluster

      @Stability(Stable) @NotNull IDatabaseCluster getCluster()
      The DocumentDB database cluster the instance should launch into.

    • getInstanceType

      @Stability(Stable) @NotNull InstanceType getInstanceType()
      The name of the compute and memory capacity classes.

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @Nullable default Boolean getAutoMinorVersionUpgrade()
      Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

      Default: true

    • getAvailabilityZone

      @Stability(Stable) @Nullable default String getAvailabilityZone()
      The name of the Availability Zone where the DB instance will be located.

      Default: - no preference

    • getCaCertificate

      @Stability(Stable) @Nullable default CaCertificate getCaCertificate()
      The identifier of the CA certificate for this DB instance.

      Specifying or updating this property triggers a reboot.

      Default: - DocumentDB will choose a certificate authority

      See Also:

    • getDbInstanceName

      @Stability(Stable) @Nullable default String getDbInstanceName()
      A name for the DB instance.

      If you specify a name, AWS CloudFormation converts it to lowercase.

      Default: - a CloudFormation generated name

    • getEnablePerformanceInsights

      @Stability(Stable) @Nullable default Boolean getEnablePerformanceInsights()
      A value that indicates whether to enable Performance Insights for the DB Instance.

      Default: - false

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable default String getPreferredMaintenanceWindow()
      The weekly time range (in UTC) during which system maintenance can occur.

      Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

      Default: - 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. To see the time blocks available, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#maintenance-window

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

      Default: RemovalPolicy.Retain

    • builder

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