Package software.amazon.awscdk.cfnpropertymixins.services.neptune

Class CfnDBInstanceMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowMajorVersionUpgrade

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
      Sets the value of CfnDBInstanceMixinProps.getAllowMajorVersionUpgrade()
      Parameters:
      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.

      Returns:
      this

    • allowMajorVersionUpgrade

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder allowMajorVersionUpgrade(IResolvable allowMajorVersionUpgrade)
      Sets the value of CfnDBInstanceMixinProps.getAllowMajorVersionUpgrade()
      Parameters:
      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.

      Returns:
      this

    • autoMinorVersionUpgrade

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
      Sets the value of CfnDBInstanceMixinProps.getAutoMinorVersionUpgrade()
      Parameters:
      autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically. When updating this property, some interruptions may occur.
      Returns:
      this

    • autoMinorVersionUpgrade

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
      Sets the value of CfnDBInstanceMixinProps.getAutoMinorVersionUpgrade()
      Parameters:
      autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically. When updating this property, some interruptions may occur.
      Returns:
      this

    • availabilityZone

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder availabilityZone(String availabilityZone)
      Sets the value of CfnDBInstanceMixinProps.getAvailabilityZone()
      Parameters:
      availabilityZone - Specifies the name of the Availability Zone the DB instance is located in.
      Returns:
      this

    • dbClusterIdentifier

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder dbClusterIdentifier(String dbClusterIdentifier)
      Sets the value of CfnDBInstanceMixinProps.getDbClusterIdentifier()
      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.
      Returns:
      this

    • dbInstanceClass

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder dbInstanceClass(String dbInstanceClass)
      Sets the value of CfnDBInstanceMixinProps.getDbInstanceClass()
      Parameters:
      dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance. If you update this property, some interruptions may occur.
      Returns:
      this

    • dbInstanceIdentifier

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
      Sets the value of CfnDBInstanceMixinProps.getDbInstanceIdentifier()
      Parameters:
      dbInstanceIdentifier - Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
      Returns:
      this

    • dbParameterGroupName

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder dbParameterGroupName(String dbParameterGroupName)
      Sets the value of CfnDBInstanceMixinProps.getDbParameterGroupName()
      Parameters:
      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.
      Returns:
      this

    • dbSnapshotIdentifier

      @Stability(Deprecated) @Deprecated public CfnDBInstanceMixinProps.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)
      Deprecated.
      this property has been deprecated
      Sets the value of CfnDBInstanceMixinProps.getDbSnapshotIdentifier()
      Parameters:
      dbSnapshotIdentifier - This parameter is not supported. AWS::Neptune::DBInstance does not support restoring from snapshots.

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

      Returns:
      this

    • dbSubnetGroupName

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder dbSubnetGroupName(String dbSubnetGroupName)
      Sets the value of CfnDBInstanceMixinProps.getDbSubnetGroupName()
      Parameters:
      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).
      Returns:
      this

    • preferredMaintenanceWindow

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
      Sets the value of CfnDBInstanceMixinProps.getPreferredMaintenanceWindow()
      Parameters:
      preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
      Returns:
      this

    • publiclyAccessible

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder publiclyAccessible(Boolean publiclyAccessible)
      Sets the value of CfnDBInstanceMixinProps.getPubliclyAccessible()
      Parameters:
      publiclyAccessible - Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

      When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

      Returns:
      this

    • publiclyAccessible

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder publiclyAccessible(IResolvable publiclyAccessible)
      Sets the value of CfnDBInstanceMixinProps.getPubliclyAccessible()
      Parameters:
      publiclyAccessible - Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

      When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnDBInstanceMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDBInstanceMixinProps.getTags()
      Parameters:
      tags - An arbitrary set of tags (key-value pairs) for this DB instance.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDBInstanceMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBInstanceMixinProps>
      Returns:
      a new instance of CfnDBInstanceMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided