Package software.amazon.awssdk.services.docdb.model

Class ModifyDbClusterRequest

    • Method Detail

      • dbClusterIdentifier

        public final String dbClusterIdentifier()

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

        Constraints:

        • Must match the identifier of an existing DBCluster.

        Returns:
        The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

        Constraints:

        • Must match the identifier of an existing DBCluster.

      • newDBClusterIdentifier

        public final String newDBClusterIdentifier()

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

      • applyImmediately

        public final Boolean applyImmediately()

        A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

        The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword 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:
        A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

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

        Default: false

      • backupRetentionPeriod

        public final 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.

        Returns:
        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.

      • dbClusterParameterGroupName

        public final String dbClusterParameterGroupName()

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

        Returns:
        The name of the cluster parameter group to use for the cluster.

      • hasVpcSecurityGroupIds

        public final boolean hasVpcSecurityGroupIds()
        For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • vpcSecurityGroupIds

        public final List<String> vpcSecurityGroupIds()

        A list of virtual private cloud (VPC) security groups that the cluster will belong to.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

        Returns:
        A list of virtual private cloud (VPC) security groups that the cluster will belong to.

      • port

        public final Integer port()

        The port number on which the cluster accepts connections.

        Constraints: Must be a value from 1150 to 65535.

        Default: The same port as the original cluster.

        Returns:
        The port number on which the cluster accepts connections.

        Constraints: Must be a value from 1150 to 65535.

        Default: The same port as the original cluster.

      • masterUserPassword

        public final String masterUserPassword()

        The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

        Constraints: Must contain from 8 to 100 characters.

        Returns:
        The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

        Constraints: Must contain from 8 to 100 characters.

      • preferredBackupWindow

        public final 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 Web Services 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:
        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 Web Services 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.

      • preferredMaintenanceWindow

        public final 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 Web Services Region, occurring on a random day of the week.

        Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

        Constraints: Minimum 30-minute window.

        Returns:
        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 Web Services Region, occurring on a random day of the week.

        Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

        Constraints: Minimum 30-minute window.

      • cloudwatchLogsExportConfiguration

        public final CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration()

        The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

        Returns:
        The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

      • engineVersion

        public final 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 ApplyImmediately is enabled.

        To list all of the available engine versions for Amazon DocumentDB use the following command:

        aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

        Returns:
        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 ApplyImmediately is enabled.

        To list all of the available engine versions for Amazon DocumentDB use the following command:

        aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

      • allowMajorVersionUpgrade

        public final Boolean allowMajorVersionUpgrade()

        A value that indicates whether major version upgrades are allowed.

        Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

        Returns:
        A value that indicates whether major version upgrades are allowed.

        Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

      • deletionProtection

        public final Boolean deletionProtection()

        Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

        Returns:
        Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

      • storageType

        public final String storageType()

        The storage type to associate with the DB cluster.

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

        Returns:
        The storage type to associate with the DB cluster.

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object