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

Interface ModifyDbClusterRequest.Builder

    • Method Detail

      • dbClusterIdentifier

        ModifyDbClusterRequest.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

        Constraints:

        • Must match the identifier of an existing DBCluster.

        Parameters:
        dbClusterIdentifier - The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

        Constraints:

        • Must match the identifier of an existing DBCluster.

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

      • newDBClusterIdentifier

        ModifyDbClusterRequest.Builder newDBClusterIdentifier​(String newDBClusterIdentifier)

        The new DB cluster identifier for the DB cluster when renaming a DB cluster. 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: my-cluster2

        Parameters:
        newDBClusterIdentifier - The new DB cluster identifier for the DB cluster when renaming a DB cluster. 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: my-cluster2

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

      • applyImmediately

        ModifyDbClusterRequest.Builder applyImmediately​(Boolean applyImmediately)

        A value that 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 cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

        The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

        Default: false

        Parameters:
        applyImmediately - A value that 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 cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

        The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

        Default: false

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

      • backupRetentionPeriod

        ModifyDbClusterRequest.Builder backupRetentionPeriod​(Integer backupRetentionPeriod)

        The number of days for which automated backups are retained. You must specify a minimum value of 1.

        Default: 1

        Constraints:

        • Must be a value from 1 to 35

        Parameters:
        backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

        Default: 1

        Constraints:

        • Must be a value from 1 to 35

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

      • dbClusterParameterGroupName

        ModifyDbClusterRequest.Builder dbClusterParameterGroupName​(String dbClusterParameterGroupName)

        The name of the DB cluster parameter group to use for the DB cluster.

        Parameters:
        dbClusterParameterGroupName - The name of the DB cluster parameter group to use for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

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

        A list of VPC security groups that the DB cluster will belong to.

        Parameters:
        vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        ModifyDbClusterRequest.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

        A list of VPC security groups that the DB cluster will belong to.

        Parameters:
        vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        ModifyDbClusterRequest.Builder port​(Integer port)

        The port number on which the DB cluster accepts connections.

        Constraints: Value must be 1150-65535

        Default: The same port as the original DB cluster.

        Parameters:
        port - The port number on which the DB cluster accepts connections.

        Constraints: Value must be 1150-65535

        Default: The same port as the original DB cluster.

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

      • masterUserPassword

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

      • optionGroupName

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

      • preferredBackupWindow

        ModifyDbClusterRequest.Builder preferredBackupWindow​(String preferredBackupWindow)

        The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region.

        Constraints:

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

        • Must be in Universal Coordinated Time (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, using the BackupRetentionPeriod parameter.

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region.

        Constraints:

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

        • Must be in Universal Coordinated Time (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

        ModifyDbClusterRequest.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.

        Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

        Constraints: Minimum 30-minute window.

        Parameters:
        preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.

        Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

        Constraints: Minimum 30-minute window.

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

      • enableIAMDatabaseAuthentication

        ModifyDbClusterRequest.Builder enableIAMDatabaseAuthentication​(Boolean enableIAMDatabaseAuthentication)

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

        Default: false

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

        Default: false

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

      • engineVersion

        ModifyDbClusterRequest.Builder engineVersion​(String engineVersion)

        The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

        For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

        Parameters:
        engineVersion - The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

        For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

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

      • allowMajorVersionUpgrade

        ModifyDbClusterRequest.Builder allowMajorVersionUpgrade​(Boolean allowMajorVersionUpgrade)

        A value that indicates whether upgrades between different major versions are allowed.

        Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

        Parameters:
        allowMajorVersionUpgrade - A value that indicates whether upgrades between different major versions are allowed.

        Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

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

      • dbInstanceParameterGroupName

        ModifyDbClusterRequest.Builder dbInstanceParameterGroupName​(String dbInstanceParameterGroupName)

        The name of the DB parameter group to apply to all instances of the DB cluster.

        When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

        Default: The existing name setting

        Constraints:

        • The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

        • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

        Parameters:
        dbInstanceParameterGroupName - The name of the DB parameter group to apply to all instances of the DB cluster.

        When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

        Default: The existing name setting

        Constraints:

        • The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

        • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

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

      • deletionProtection

        ModifyDbClusterRequest.Builder deletionProtection​(Boolean deletionProtection)

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

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

      • copyTagsToSnapshot

        ModifyDbClusterRequest.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

        Parameters:
        copyTagsToSnapshot - If set to true, tags are copied to any snapshot of the DB cluster that is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverlessV2ScalingConfiguration

        ModifyDbClusterRequest.Builder serverlessV2ScalingConfiguration​(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)

        Contains the scaling configuration of a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        Parameters:
        serverlessV2ScalingConfiguration - Contains the scaling configuration of a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

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

      • storageType

        ModifyDbClusterRequest.Builder storageType​(String storageType)

        The storage type to associate with the DB cluster.

        Valid Values:

        • standard | iopt1

        Default:

        • standard

        Parameters:
        storageType - The storage type to associate with the DB cluster.

        Valid Values:

        • standard | iopt1

        Default:

        • standard

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