AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateRelationalDatabase operation. Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lightsail.AmazonLightsailRequest
      Amazon.Lightsail.Model.UpdateRelationalDatabaseRequest

Namespace: Amazon.Lightsail.Model
Assembly: AWSSDK.Lightsail.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateRelationalDatabaseRequest : AmazonLightsailRequest
         IAmazonWebServiceRequest

The UpdateRelationalDatabaseRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ApplyImmediately System.Boolean

Gets and sets the property ApplyImmediately.

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

Default: false

Public Property CaCertificateIdentifier System.String

Gets and sets the property CaCertificateIdentifier.

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

Public Property DisableBackupRetention System.Boolean

Gets and sets the property 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.

Public Property EnableBackupRetention System.Boolean

Gets and sets the property 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.

Public Property MasterUserPassword System.String

Gets and sets the property 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.

Public Property PreferredBackupWindow System.String

Gets and sets the property 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.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property 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

Public Property PubliclyAccessible System.Boolean

Gets and sets the property 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.

Public Property RelationalDatabaseBlueprintId System.String

Gets and sets the property 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.

Public Property RelationalDatabaseName System.String

Gets and sets the property RelationalDatabaseName.

The name of your Lightsail database resource to update.

Public Property RotateMasterUserPassword System.Boolean

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5