Package software.amazon.awscdk.services.neptune

Class DatabaseInstance.Builder

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

  • Method Details

    • create

      @Stability(Experimental) public static DatabaseInstance.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of DatabaseInstance.Builder.

    • cluster

      @Stability(Experimental) public DatabaseInstance.Builder cluster(IDatabaseCluster cluster)
      (experimental) The Neptune database cluster the instance should launch into.

      Parameters:
      cluster - The Neptune database cluster the instance should launch into. This parameter is required.
      Returns:
      this

    • instanceType

      @Stability(Experimental) public DatabaseInstance.Builder instanceType(InstanceType instanceType)
      (experimental) What type of instance to start for the replicas.

      Parameters:
      instanceType - What type of instance to start for the replicas. This parameter is required.
      Returns:
      this

    • availabilityZone

      @Stability(Experimental) public DatabaseInstance.Builder availabilityZone(String availabilityZone)
      (experimental) The name of the Availability Zone where the DB instance will be located.

      Default: - no preference

      Parameters:
      availabilityZone - The name of the Availability Zone where the DB instance will be located. This parameter is required.
      Returns:
      this

    • dbInstanceName

      @Stability(Experimental) public DatabaseInstance.Builder dbInstanceName(String dbInstanceName)
      (experimental) A name for the DB instance.

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

      Default: - a CloudFormation generated name

      Parameters:
      dbInstanceName - A name for the DB instance. This parameter is required.
      Returns:
      this

    • parameterGroup

      @Stability(Experimental) public DatabaseInstance.Builder parameterGroup(IParameterGroup parameterGroup)
      (experimental) The DB parameter group to associate with the instance.

      Default: no parameter group

      Parameters:
      parameterGroup - The DB parameter group to associate with the instance. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Experimental) public DatabaseInstance.Builder removalPolicy(RemovalPolicy removalPolicy)
      (experimental) The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

      Default: RemovalPolicy.Retain

      Parameters:
      removalPolicy - The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. This parameter is required.
      Returns:
      this

    • build

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