Package software.amazon.awscdk.services.neptune

Class CfnDBInstance.Builder

java.lang.Object
software.amazon.awscdk.services.neptune.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.

    • dbInstanceClass

      @Stability(Stable) public CfnDBInstance.Builder dbInstanceClass(String dbInstanceClass)
      Contains the name of the compute and memory capacity class of the DB instance.

      If you update this property, some interruptions may occur.

      Parameters:
      dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance. This parameter is required.
      Returns:
      this

    • allowMajorVersionUpgrade

      @Stability(Stable) public CfnDBInstance.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
      Indicates that major version upgrades are allowed.

      Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.

      Parameters:
      allowMajorVersionUpgrade - Indicates that major version upgrades are allowed. This parameter is required.
      Returns:
      this

    • allowMajorVersionUpgrade

      @Stability(Stable) public CfnDBInstance.Builder allowMajorVersionUpgrade(IResolvable allowMajorVersionUpgrade)
      Indicates that major version upgrades are allowed.

      Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.

      Parameters:
      allowMajorVersionUpgrade - Indicates that major version upgrades are allowed. This parameter is required.
      Returns:
      this

    • autoMinorVersionUpgrade

      @Stability(Stable) public CfnDBInstance.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
      Indicates that minor version patches are applied automatically.

      When updating this property, some interruptions may occur.

      Parameters:
      autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically. This parameter is required.
      Returns:
      this

    • autoMinorVersionUpgrade

      @Stability(Stable) public CfnDBInstance.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
      Indicates that minor version patches are applied automatically.

      When updating this property, some interruptions may occur.

      Parameters:
      autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically. This parameter is required.
      Returns:
      this

    • availabilityZone

      @Stability(Stable) public CfnDBInstance.Builder availabilityZone(String availabilityZone)
      Specifies the name of the Availability Zone the DB instance is located in.

      Parameters:
      availabilityZone - Specifies the name of the Availability Zone the DB instance is located in. This parameter is required.
      Returns:
      this

    • dbClusterIdentifier

      @Stability(Stable) public CfnDBInstance.Builder dbClusterIdentifier(String dbClusterIdentifier)
      If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

      Parameters:
      dbClusterIdentifier - If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. This parameter is required.
      Returns:
      this

    • dbInstanceIdentifier

      @Stability(Stable) public CfnDBInstance.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
      Contains a user-supplied database identifier.

      This identifier is the unique key that identifies a DB instance.

      Parameters:
      dbInstanceIdentifier - Contains a user-supplied database identifier. This parameter is required.
      Returns:
      this

    • dbParameterGroupName

      @Stability(Stable) public CfnDBInstance.Builder dbParameterGroupName(String dbParameterGroupName)
      The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.

      If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.

      Parameters:
      dbParameterGroupName - The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. This parameter is required.
      Returns:
      this

    • dbSnapshotIdentifier

      @Stability(Stable) public CfnDBInstance.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)
      This parameter is not supported.

      AWS::Neptune::DBInstance does not support restoring from snapshots.

      AWS::Neptune::DBCluster does support restoring from snapshots.

      Parameters:
      dbSnapshotIdentifier - This parameter is not supported. This parameter is required.
      Returns:
      this

    • dbSubnetGroupName

      @Stability(Stable) public CfnDBInstance.Builder dbSubnetGroupName(String dbSubnetGroupName)
      A DB subnet group to associate with the DB instance.

      If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).

      Parameters:
      dbSubnetGroupName - A DB subnet group to associate with the DB instance. This parameter is required.
      Returns:
      this

    • preferredMaintenanceWindow

      @Stability(Stable) public CfnDBInstance.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Parameters:
      preferredMaintenanceWindow - Specifies the weekly time range 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)
      An arbitrary set of tags (key-value pairs) for this DB instance.

      Parameters:
      tags - An arbitrary set of tags (key-value pairs) for this DB 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.