software.amazon.awssdk.services.docdb.model

Class ModifyDbInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.ModifyDbInstanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>

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

Represents the input to ModifyDBInstance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyDbInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
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 instance.
Boolean	autoMinorVersionUpgrade() This parameter does not apply to Amazon DocumentDB.
static ModifyDbInstanceRequest.Builder	builder()
String	caCertificateIdentifier() Indicates the certificate that needs to be associated with the instance.
Boolean	copyTagsToSnapshot() A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
String	dbInstanceClass() The new compute and memory capacity of the instance; for example, db.r5.large.
String	dbInstanceIdentifier() The instance identifier.
Boolean	enablePerformanceInsights() A value that indicates whether to enable Performance Insights for the DB Instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	newDBInstanceIdentifier() The new instance identifier for the instance when renaming an instance.
String	performanceInsightsKMSKeyId() The KMS key identifier for encryption of Performance Insights data.
String	preferredMaintenanceWindow() The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
Integer	promotionTier() A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyDbInstanceRequest.Builder>	serializableBuilderClass()
ModifyDbInstanceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

dbInstanceIdentifier

public final String dbInstanceIdentifier()

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

Constraints:

• Must match the identifier of an existing DBInstance.

Returns:

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

Constraints:

• Must match the identifier of an existing DBInstance.

dbInstanceClass

public final String dbInstanceClass()

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the 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:

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the 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.

applyImmediately

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

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

Default: false

Returns:

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

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

Default: false

preferredMaintenanceWindow

public final 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, changing this parameter causes a reboot of the instance. If you are 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 that 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:

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, changing this parameter causes a reboot of the instance. If you are 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 that 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.

autoMinorVersionUpgrade

public final Boolean autoMinorVersionUpgrade()

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Returns:

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

newDBInstanceIdentifier

public final String newDBInstanceIdentifier()

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set 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:

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set 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

caCertificateIdentifier

public final String caCertificateIdentifier()

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

Returns:

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

copyTagsToSnapshot

public final Boolean copyTagsToSnapshot()

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Returns:

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

promotionTier

public final Integer promotionTier()

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Returns:

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

enablePerformanceInsights

public final Boolean enablePerformanceInsights()

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

Returns:

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

performanceInsightsKMSKeyId

public final String performanceInsightsKMSKeyId()

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

Returns:

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

toBuilder

public ModifyDbInstanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static ModifyDbInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyDbInstanceRequest.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