Package software.amazon.awssdk.services.neptune.model

Interface ModifyDbInstanceRequest.Builder

    • Method Detail

      • dbInstanceIdentifier

        ModifyDbInstanceRequest.Builder dbInstanceIdentifier​(String dbInstanceIdentifier)

        The DB instance identifier. This value is stored as a lowercase string.

        Constraints:

        • Must match the identifier of an existing DBInstance.

        Parameters:
        dbInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

        Constraints:

        • Must match the identifier of an existing DBInstance.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocatedStorage

        ModifyDbInstanceRequest.Builder allocatedStorage​(Integer allocatedStorage)

        Not supported by Neptune.

        Parameters:
        allocatedStorage - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceClass

        ModifyDbInstanceRequest.Builder dbInstanceClass​(String dbInstanceClass)

        The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.

        If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

        Default: Uses existing setting

        Parameters:
        dbInstanceClass - The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.

        If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

        Default: Uses existing setting

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroupName

        ModifyDbInstanceRequest.Builder dbSubnetGroupName​(String dbSubnetGroupName)

        The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

        Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

        Constraints: If supplied, must match the name of an existing DBSubnetGroup.

        Example: mySubnetGroup

        Parameters:
        dbSubnetGroupName - The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

        Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

        Constraints: If supplied, must match the name of an existing DBSubnetGroup.

        Example: mySubnetGroup

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        ModifyDbInstanceRequest.Builder dbSecurityGroups​(Collection<String> dbSecurityGroups)

        A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

        Constraints:

        • If supplied, must match existing DBSecurityGroups.

        Parameters:
        dbSecurityGroups - A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

        Constraints:

        • If supplied, must match existing DBSecurityGroups.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        ModifyDbInstanceRequest.Builder dbSecurityGroups​(String... dbSecurityGroups)

        A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

        Constraints:

        • If supplied, must match existing DBSecurityGroups.

        Parameters:
        dbSecurityGroups - A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

        Constraints:

        • If supplied, must match existing DBSecurityGroups.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        ModifyDbInstanceRequest.Builder vpcSecurityGroupIds​(Collection<String> vpcSecurityGroupIds)

        A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

        Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Constraints:

        • If supplied, must match existing VpcSecurityGroupIds.

        Parameters:
        vpcSecurityGroupIds - A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

        Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Constraints:

        • If supplied, must match existing VpcSecurityGroupIds.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        ModifyDbInstanceRequest.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

        A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

        Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Constraints:

        • If supplied, must match existing VpcSecurityGroupIds.

        Parameters:
        vpcSecurityGroupIds - A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

        Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Constraints:

        • If supplied, must match existing VpcSecurityGroupIds.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • applyImmediately

        ModifyDbInstanceRequest.Builder applyImmediately​(Boolean applyImmediately)

        Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

        If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot.

        Default: false

        Parameters:
        applyImmediately - Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

        If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot.

        Default: false

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUserPassword

        ModifyDbInstanceRequest.Builder masterUserPassword​(String masterUserPassword)

        Not supported by Neptune.

        Parameters:
        masterUserPassword - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroupName

        ModifyDbInstanceRequest.Builder dbParameterGroupName​(String dbParameterGroupName)

        The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

        Default: Uses existing setting

        Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

        Parameters:
        dbParameterGroupName - The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

        Default: Uses existing setting

        Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionPeriod

        ModifyDbInstanceRequest.Builder backupRetentionPeriod​(Integer backupRetentionPeriod)

        Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Default: Uses existing setting

        Parameters:
        backupRetentionPeriod - Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Default: Uses existing setting

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredBackupWindow

        ModifyDbInstanceRequest.Builder preferredBackupWindow​(String preferredBackupWindow)

        The daily time range during which automated backups are created if automated backups are enabled.

        Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Constraints:

        • Must be in the format hh24:mi-hh24:mi

        • Must be in Universal Time Coordinated (UTC)

        • Must not conflict with the preferred maintenance window

        • Must be at least 30 minutes

        Parameters:
        preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled.

        Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

        Constraints:

        • Must be in the format hh24:mi-hh24:mi

        • Must be in Universal Time Coordinated (UTC)

        • Must not conflict with the preferred maintenance window

        • Must be at least 30 minutes

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        ModifyDbInstanceRequest.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

        Default: Uses existing setting

        Format: ddd:hh24:mi-ddd:hh24:mi

        Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

        Constraints: Must be at least 30 minutes

        Parameters:
        preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

        Default: Uses existing setting

        Format: ddd:hh24:mi-ddd:hh24:mi

        Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

        Constraints: Must be at least 30 minutes

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiAZ

        ModifyDbInstanceRequest.Builder multiAZ​(Boolean multiAZ)

        Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

        Parameters:
        multiAZ - Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        ModifyDbInstanceRequest.Builder engineVersion​(String engineVersion)

        The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.

        Parameters:
        engineVersion - The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowMajorVersionUpgrade

        ModifyDbInstanceRequest.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.

        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMinorVersionUpgrade

        ModifyDbInstanceRequest.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

        Parameters:
        autoMinorVersionUpgrade - Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • licenseModel

        ModifyDbInstanceRequest.Builder licenseModel​(String licenseModel)

        Not supported by Neptune.

        Parameters:
        licenseModel - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iops

        ModifyDbInstanceRequest.Builder iops​(Integer iops)

        The new Provisioned IOPS (I/O operations per second) value for the instance.

        Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

        Default: Uses existing setting

        Parameters:
        iops - The new Provisioned IOPS (I/O operations per second) value for the instance.

        Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

        Default: Uses existing setting

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupName

        ModifyDbInstanceRequest.Builder optionGroupName​(String optionGroupName)

        (Not supported by Neptune)

        Parameters:
        optionGroupName - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • newDBInstanceIdentifier

        ModifyDbInstanceRequest.Builder newDBInstanceIdentifier​(String newDBInstanceIdentifier)

        The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value 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:
        newDBInstanceIdentifier - The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        ModifyDbInstanceRequest.Builder storageType​(String storageType)

        Not supported.

        Parameters:
        storageType - Not supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tdeCredentialArn

        ModifyDbInstanceRequest.Builder tdeCredentialArn​(String tdeCredentialArn)

        The ARN from the key store with which to associate the instance for TDE encryption.

        Parameters:
        tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tdeCredentialPassword

        ModifyDbInstanceRequest.Builder tdeCredentialPassword​(String tdeCredentialPassword)

        The password for the given ARN from the key store in order to access the device.

        Parameters:
        tdeCredentialPassword - The password for the given ARN from the key store in order to access the device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • caCertificateIdentifier

        ModifyDbInstanceRequest.Builder caCertificateIdentifier​(String caCertificateIdentifier)

        Indicates the certificate that needs to be associated with the instance.

        Parameters:
        caCertificateIdentifier - Indicates the certificate that needs to be associated with the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domain

        ModifyDbInstanceRequest.Builder domain​(String domain)

        Not supported.

        Parameters:
        domain - Not supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTagsToSnapshot

        ModifyDbInstanceRequest.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

        True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

        Parameters:
        copyTagsToSnapshot - True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringInterval

        ModifyDbInstanceRequest.Builder monitoringInterval​(Integer monitoringInterval)

        The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

        If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

        Valid Values: 0, 1, 5, 10, 15, 30, 60

        Parameters:
        monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

        If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

        Valid Values: 0, 1, 5, 10, 15, 30, 60

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbPortNumber

        ModifyDbInstanceRequest.Builder dbPortNumber​(Integer dbPortNumber)

        The port number on which the database accepts connections.

        The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

        Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

        Default: 8182

        Parameters:
        dbPortNumber - The port number on which the database accepts connections.

        The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

        Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

        Default: 8182

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publiclyAccessible

        @Deprecated
ModifyDbInstanceRequest.Builder publiclyAccessible​(Boolean publiclyAccessible)
        Deprecated.

        This flag should no longer be used.

        Parameters:
        publiclyAccessible - This flag should no longer be used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringRoleArn

        ModifyDbInstanceRequest.Builder monitoringRoleArn​(String monitoringRoleArn)

        The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

        If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

        Parameters:
        monitoringRoleArn - The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

        If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainIAMRoleName

        ModifyDbInstanceRequest.Builder domainIAMRoleName​(String domainIAMRoleName)

        Not supported

        Parameters:
        domainIAMRoleName - Not supported
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotionTier

        ModifyDbInstanceRequest.Builder promotionTier​(Integer promotionTier)

        A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        Default: 1

        Valid Values: 0 - 15

        Parameters:
        promotionTier - A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        Default: 1

        Valid Values: 0 - 15

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableIAMDatabaseAuthentication

        ModifyDbInstanceRequest.Builder enableIAMDatabaseAuthentication​(Boolean enableIAMDatabaseAuthentication)

        True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

        You can enable IAM database authentication for the following database engines

        Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

        Default: false

        Parameters:
        enableIAMDatabaseAuthentication - True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

        You can enable IAM database authentication for the following database engines

        Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

        Default: false

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enablePerformanceInsights

        ModifyDbInstanceRequest.Builder enablePerformanceInsights​(Boolean enablePerformanceInsights)

        (Not supported by Neptune)

        Parameters:
        enablePerformanceInsights - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performanceInsightsKMSKeyId

        ModifyDbInstanceRequest.Builder performanceInsightsKMSKeyId​(String performanceInsightsKMSKeyId)

        (Not supported by Neptune)

        Parameters:
        performanceInsightsKMSKeyId - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cloudwatchLogsExportConfiguration

        ModifyDbInstanceRequest.Builder cloudwatchLogsExportConfiguration​(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)

        The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

        Parameters:
        cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtection

        ModifyDbInstanceRequest.Builder deletionProtection​(Boolean deletionProtection)

        A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.

        Parameters:
        deletionProtection - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.