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(value="software.amazon.awssdk:codegen")
public final class UpdateRelationalDatabaseRequest
extends LightsailRequest
implements ToCopyableBuilder<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateRelationalDatabaseRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	applyImmediately() When true, applies changes immediately.
static UpdateRelationalDatabaseRequest.Builder	builder()
Boolean	disableBackupRetention() When true, disables automated backup retention for your database.
Boolean	enableBackupRetention() When true, enables automated backup retention for your database.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	masterUserPassword() The password for the master user of your database.
String	preferredBackupWindow() The daily time range during which automated backups are created for your database if automated backups are enabled.
String	preferredMaintenanceWindow() The weekly time range during which system maintenance can occur on your database.
Boolean	publiclyAccessible() Specifies the accessibility options for your database.
String	relationalDatabaseName() The name of your database to update.
Boolean	rotateMasterUserPassword() When true, the master user password is changed to a new strong password generated by Lightsail.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateRelationalDatabaseRequest.Builder>	serializableBuilderClass()
UpdateRelationalDatabaseRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

relationalDatabaseName

public String relationalDatabaseName()

The name of your database to update.

Returns:

The name of your database to update.

masterUserPassword

public String masterUserPassword()

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

Constraints: Must contain 8 to 41 characters.

Returns:

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

Constraints: Must contain 8 to 41 characters.

rotateMasterUserPassword

public 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 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 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 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 Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

preferredMaintenanceWindow

public 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 AWS 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 Universal Coordinated 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 AWS 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 Universal Coordinated Time (UTC).

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

enableBackupRetention

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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