Package software.amazon.awscdk.services.docdb

Class CfnDBInstance.Builder

java.lang.Object
software.amazon.awscdk.services.docdb.CfnDBInstance.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBInstance>
Enclosing class:
CfnDBInstance
@Stability(Stable) public static final class CfnDBInstance.Builder extends Object implements software.amazon.jsii.Builder<CfnDBInstance>
A fluent builder for CfnDBInstance.

  • Method Details

    • create

      @Stability(Stable) public static CfnDBInstance.Builder create(Construct scope, 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

      @Stability(Stable) public CfnDBInstance.Builder dbClusterIdentifier(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

      @Stability(Stable) public CfnDBInstance.Builder dbInstanceClass(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

      @Stability(Stable) public CfnDBInstance.Builder autoMinorVersionUpgrade(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

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

      @Stability(Stable) public CfnDBInstance.Builder availabilityZone(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

      @Stability(Stable) public CfnDBInstance.Builder dbInstanceIdentifier(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

      @Stability(Stable) public CfnDBInstance.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
      AWS::DocDB::DBInstance.EnablePerformanceInsights.

      Parameters:
      enablePerformanceInsights - AWS::DocDB::DBInstance.EnablePerformanceInsights. This parameter is required.
      Returns:
      this

    • enablePerformanceInsights

      @Stability(Stable) public CfnDBInstance.Builder enablePerformanceInsights(IResolvable enablePerformanceInsights)
      AWS::DocDB::DBInstance.EnablePerformanceInsights.

      Parameters:
      enablePerformanceInsights - AWS::DocDB::DBInstance.EnablePerformanceInsights. This parameter is required.
      Returns:
      this

    • preferredMaintenanceWindow

      @Stability(Stable) public CfnDBInstance.Builder preferredMaintenanceWindow(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

      @Stability(Stable) public CfnDBInstance.Builder tags(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

      @Stability(Stable) public CfnDBInstance build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBInstance>
      Returns:
      a newly built instance of CfnDBInstance.