Class CfnDBInstanceProps.Builder
java.lang.Object
software.amazon.awscdk.services.neptune.CfnDBInstanceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBInstanceProps>
- Enclosing interface:
CfnDBInstanceProps
@Stability(Stable)
public static final class CfnDBInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBInstanceProps>
A builder for
CfnDBInstanceProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowMajorVersionUpgrade
(Boolean allowMajorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAllowMajorVersionUpgrade()
allowMajorVersionUpgrade
(IResolvable allowMajorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAllowMajorVersionUpgrade()
autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()
autoMinorVersionUpgrade
(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()
availabilityZone
(String availabilityZone) Sets the value ofCfnDBInstanceProps.getAvailabilityZone()
build()
Builds the configured instance.dbClusterIdentifier
(String dbClusterIdentifier) Sets the value ofCfnDBInstanceProps.getDbClusterIdentifier()
dbInstanceClass
(String dbInstanceClass) Sets the value ofCfnDBInstanceProps.getDbInstanceClass()
dbInstanceIdentifier
(String dbInstanceIdentifier) Sets the value ofCfnDBInstanceProps.getDbInstanceIdentifier()
dbParameterGroupName
(String dbParameterGroupName) Sets the value ofCfnDBInstanceProps.getDbParameterGroupName()
dbSnapshotIdentifier
(String dbSnapshotIdentifier) Sets the value ofCfnDBInstanceProps.getDbSnapshotIdentifier()
dbSubnetGroupName
(String dbSubnetGroupName) Sets the value ofCfnDBInstanceProps.getDbSubnetGroupName()
preferredMaintenanceWindow
(String preferredMaintenanceWindow) Sets the value ofCfnDBInstanceProps.getPreferredMaintenanceWindow()
Sets the value ofCfnDBInstanceProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
dbInstanceClass
Sets the value ofCfnDBInstanceProps.getDbInstanceClass()
- Parameters:
dbInstanceClass
- Contains the name of the compute and memory capacity class of the DB instance. This parameter is required. If you update this property, some interruptions may occur.- Returns:
this
-
allowMajorVersionUpgrade
@Stability(Stable) public CfnDBInstanceProps.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) Sets the value ofCfnDBInstanceProps.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 CfnDBInstanceProps.Builder allowMajorVersionUpgrade(IResolvable allowMajorVersionUpgrade) Sets the value ofCfnDBInstanceProps.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 CfnDBInstanceProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.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 CfnDBInstanceProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnDBInstanceProps.getAutoMinorVersionUpgrade()
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically. When updating this property, some interruptions may occur.- Returns:
this
-
availabilityZone
Sets the value ofCfnDBInstanceProps.getAvailabilityZone()
- Parameters:
availabilityZone
- Specifies the name of the Availability Zone the DB instance is located in.- Returns:
this
-
dbClusterIdentifier
@Stability(Stable) public CfnDBInstanceProps.Builder dbClusterIdentifier(String dbClusterIdentifier) Sets the value ofCfnDBInstanceProps.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
-
dbInstanceIdentifier
@Stability(Stable) public CfnDBInstanceProps.Builder dbInstanceIdentifier(String dbInstanceIdentifier) Sets the value ofCfnDBInstanceProps.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 CfnDBInstanceProps.Builder dbParameterGroupName(String dbParameterGroupName) Sets the value ofCfnDBInstanceProps.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(Stable) public CfnDBInstanceProps.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier) Sets the value ofCfnDBInstanceProps.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
Sets the value ofCfnDBInstanceProps.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 CfnDBInstanceProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofCfnDBInstanceProps.getPreferredMaintenanceWindow()
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).- Returns:
this
-
tags
Sets the value ofCfnDBInstanceProps.getTags()
- Parameters:
tags
- An arbitrary set of tags (key-value pairs) for this DB instance.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDBInstanceProps>
- Returns:
- a new instance of
CfnDBInstanceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-