Package software.amazon.awssdk.services.lightsail.model

Class UpdateRelationalDatabaseRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lightsail.model.LightsailRequest
software.amazon.awssdk.services.lightsail.model.UpdateRelationalDatabaseRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateRelationalDatabaseRequest extends LightsailRequest implements ToCopyableBuilder<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>

  • Method Details

    • relationalDatabaseName

      public final String relationalDatabaseName()

      The name of your Lightsail database resource to update.

      Returns:
      The name of your Lightsail database resource to update.

    • masterUserPassword

      public final String masterUserPassword()

      The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

      MySQL

      Constraints: Must contain from 8 to 41 characters.

      PostgreSQL

      Constraints: Must contain from 8 to 128 characters.

      Returns:
      The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

      MySQL

      Constraints: Must contain from 8 to 41 characters.

      PostgreSQL

      Constraints: Must contain from 8 to 128 characters.

    • rotateMasterUserPassword

      public final Boolean rotateMasterUserPassword()

      When true, the master user password is changed to a new strong password generated by Lightsail.

      Use the get relational database master user password operation to get the new password.

      Returns:
      When true, the master user password is changed to a new strong password generated by Lightsail.

      Use the get relational database master user password operation to get the new password.

    • preferredBackupWindow

      public final String preferredBackupWindow()

      The daily time range during which automated backups are created for your database if automated backups are enabled.

      Constraints:

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

        Example: 16:00-16:30

      • Specified in Coordinated Universal 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 for your database if automated backups are enabled.

      Constraints:

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

        Example: 16:00-16:30

      • Specified in Coordinated Universal 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 on your database.

      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.

      Constraints:

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

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

      • Must be at least 30 minutes.

      • Specified in Coordinated Universal Time (UTC).

      • Example: Tue:17:00-Tue:17:30

      Returns:
      The weekly time range during which system maintenance can occur on your database.

      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.

      Constraints:

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

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

      • Must be at least 30 minutes.

      • Specified in Coordinated Universal Time (UTC).

      • Example: Tue:17:00-Tue:17:30

    • enableBackupRetention

      public final Boolean enableBackupRetention()

      When true, enables automated backup retention for your database.

      Updates are applied during the next maintenance window because this can result in an outage.

      Returns:
      When true, enables automated backup retention for your database.

      Updates are applied during the next maintenance window because this can result in an outage.

    • disableBackupRetention

      public final Boolean disableBackupRetention()

      When true, disables automated backup retention for your database.

      Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

      Updates are applied during the next maintenance window because this can result in an outage.

      Returns:
      When true, disables automated backup retention for your database.

      Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

      Updates are applied during the next maintenance window because this can result in an outage.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

      Returns:
      Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

    • applyImmediately

      public final Boolean applyImmediately()

      When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

      Default: false

      Returns:
      When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

      Default: false

    • caCertificateIdentifier

      public final String caCertificateIdentifier()

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

      Returns:
      Indicates the certificate that needs to be associated with the database.

    • relationalDatabaseBlueprintId

      public final String relationalDatabaseBlueprintId()

      This parameter is used to update the major version of the database. Enter the blueprintId for the major version that you want to update to.

      Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint IDs.

      Returns:
      This parameter is used to update the major version of the database. Enter the blueprintId for the major version that you want to update to.

      Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint IDs.

    • toBuilder

      public UpdateRelationalDatabaseRequest.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<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>
      Specified by:
      toBuilder in class LightsailRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateRelationalDatabaseRequest.Builder builder()

    • serializableBuilderClass

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