software.amazon.awssdk.services.lightsail.model

Interface UpdateRelationalDatabaseRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>, LightsailRequest.Builder, SdkBuilder<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateRelationalDatabaseRequest

public static interface UpdateRelationalDatabaseRequest.Builder
extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<UpdateRelationalDatabaseRequest.Builder,UpdateRelationalDatabaseRequest>

Method Summary

Modifier and Type	Method and Description
UpdateRelationalDatabaseRequest.Builder	applyImmediately(Boolean applyImmediately) When true, applies changes immediately.
UpdateRelationalDatabaseRequest.Builder	caCertificateIdentifier(String caCertificateIdentifier) Indicates the certificate that needs to be associated with the database.
UpdateRelationalDatabaseRequest.Builder	disableBackupRetention(Boolean disableBackupRetention) When true, disables automated backup retention for your database.
UpdateRelationalDatabaseRequest.Builder	enableBackupRetention(Boolean enableBackupRetention) When true, enables automated backup retention for your database.
UpdateRelationalDatabaseRequest.Builder	masterUserPassword(String masterUserPassword) The password for the master user of your database.
UpdateRelationalDatabaseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateRelationalDatabaseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateRelationalDatabaseRequest.Builder	preferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created for your database if automated backups are enabled.
UpdateRelationalDatabaseRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur on your database.
UpdateRelationalDatabaseRequest.Builder	publiclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for your database.
UpdateRelationalDatabaseRequest.Builder	relationalDatabaseName(String relationalDatabaseName) The name of your database to update.
UpdateRelationalDatabaseRequest.Builder	rotateMasterUserPassword(Boolean rotateMasterUserPassword) When true, the master user password is changed to a new strong password generated by Lightsail.

Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

relationalDatabaseName

UpdateRelationalDatabaseRequest.Builder relationalDatabaseName(String relationalDatabaseName)

The name of your database to update.

Parameters:

relationalDatabaseName - The name of your database to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

masterUserPassword

UpdateRelationalDatabaseRequest.Builder masterUserPassword(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

rotateMasterUserPassword

UpdateRelationalDatabaseRequest.Builder rotateMasterUserPassword(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

preferredBackupWindow

UpdateRelationalDatabaseRequest.Builder preferredBackupWindow(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

preferredMaintenanceWindow

UpdateRelationalDatabaseRequest.Builder preferredMaintenanceWindow(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 Coordinated Universal Time (UTC).

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

enableBackupRetention

UpdateRelationalDatabaseRequest.Builder enableBackupRetention(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

disableBackupRetention

UpdateRelationalDatabaseRequest.Builder disableBackupRetention(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

publiclyAccessible

UpdateRelationalDatabaseRequest.Builder publiclyAccessible(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

applyImmediately

UpdateRelationalDatabaseRequest.Builder applyImmediately(Boolean applyImmediately)

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

Default: false

Parameters:

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

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

caCertificateIdentifier

UpdateRelationalDatabaseRequest.Builder caCertificateIdentifier(String caCertificateIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateRelationalDatabaseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateRelationalDatabaseRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.