software.amazon.awssdk.services.neptune.model

Class ModifyDbClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptune.model.NeptuneRequest

software.amazon.awssdk.services.neptune.model.ModifyDbClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyDbClusterRequest
extends NeptuneRequest
implements ToCopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyDbClusterRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowMajorVersionUpgrade() A value that indicates whether upgrades between different major versions are allowed.
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.
Integer	backupRetentionPeriod() The number of days for which automated backups are retained.
static ModifyDbClusterRequest.Builder	builder()
CloudwatchLogsExportConfiguration	cloudwatchLogsExportConfiguration() The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Boolean	copyTagsToSnapshot() If set to true, tags are copied to any snapshot of the DB cluster that is created.
String	dbClusterIdentifier() The DB cluster identifier for the cluster being modified.
String	dbClusterParameterGroupName() The name of the DB cluster parameter group to use for the DB cluster.
String	dbInstanceParameterGroupName() The name of the DB parameter group to apply to all instances of the DB cluster.
Boolean	deletionProtection() A value that indicates whether the DB cluster has deletion protection enabled.
Boolean	enableIAMDatabaseAuthentication() True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
String	engineVersion() The version number of the database engine to which you want to upgrade.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVpcSecurityGroupIds() For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
String	masterUserPassword() Not supported by Neptune.
String	newDBClusterIdentifier() The new DB cluster identifier for the DB cluster when renaming a DB cluster.
String	optionGroupName() Not supported by Neptune.
Integer	port() The port number on which the DB cluster accepts connections.
String	preferredBackupWindow() The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
String	preferredMaintenanceWindow() The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyDbClusterRequest.Builder>	serializableBuilderClass()
ServerlessV2ScalingConfiguration	serverlessV2ScalingConfiguration() Returns the value of the ServerlessV2ScalingConfiguration property for this object.
ModifyDbClusterRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	vpcSecurityGroupIds() A list of VPC security groups that the DB cluster will belong to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbClusterIdentifier

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

Returns:

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

Constraints:

• Must match the identifier of an existing DBCluster.

newDBClusterIdentifier

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

Returns:

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

applyImmediately

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

Returns:

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

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 DB cluster parameter group to use for the DB cluster.

Returns:

The name of the DB cluster parameter group to use for the DB 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 VPC security groups that the DB 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 VPC security groups that the DB cluster will belong to.

port

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

Returns:

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.

masterUserPassword

public final String masterUserPassword()

Not supported by Neptune.

Returns:

Not supported by Neptune.

optionGroupName

public final String optionGroupName()

Not supported by Neptune.

Returns:

Not supported by Neptune.

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

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

Constraints: Minimum 30-minute window.

enableIAMDatabaseAuthentication

public final Boolean enableIAMDatabaseAuthentication()

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

Default: false

Returns:

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

Default: false

cloudwatchLogsExportConfiguration

public final CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration()

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

Returns:

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

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 the ApplyImmediately parameter is set to true.

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

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 the ApplyImmediately parameter is set to true.

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

allowMajorVersionUpgrade

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

Returns:

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.

dbInstanceParameterGroupName

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

Returns:

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.

deletionProtection

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

Returns:

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.

copyTagsToSnapshot

public final Boolean copyTagsToSnapshot()

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

Returns:

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

serverlessV2ScalingConfiguration

public final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()

Returns the value of the ServerlessV2ScalingConfiguration property for this object.

Returns:

The value of the ServerlessV2ScalingConfiguration property for this object.

toBuilder

public ModifyDbClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>

Specified by:

toBuilder in class NeptuneRequest

builder

public static ModifyDbClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyDbClusterRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo