Package 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("software.amazon.awssdk:codegen") public final class ModifyDbInstanceRequest extends DocDbRequest implements ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>

Represents the input to ModifyDBInstance.

  • Method Details

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

    • certificateRotationRestart

      public final Boolean certificateRotationRestart()

      Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

      By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

      Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

      If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

      Returns:
      Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

      By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

      Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

      If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

    • toBuilder

      public ModifyDbInstanceRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>
      Specified by:
      toBuilder in class DocDbRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.