UpdateRelationalDatabaseRequest
¶
Source code in docs_src/capo_lightsail/types/update_relational_database_request.py
apply_immediately
instance-attribute
¶
apply_immediately: NotRequired[boolean]
When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.
Default: false
ca_certificate_identifier
instance-attribute
¶
ca_certificate_identifier: NotRequired[string]
Indicates the certificate that needs to be associated with the database.
disable_backup_retention
instance-attribute
¶
disable_backup_retention: NotRequired[boolean]
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.
enable_backup_retention
instance-attribute
¶
enable_backup_retention: NotRequired[boolean]
When true, enables automated backup retention for your database.
Updates are applied during the next maintenance window because this can result in an outage.
master_user_password
instance-attribute
¶
master_user_password: NotRequired[SensitiveString]
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.
preferred_backup_window
instance-attribute
¶
preferred_backup_window: NotRequired[string]
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:miformat.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.
preferred_maintenance_window
instance-attribute
¶
preferred_maintenance_window: NotRequired[string]
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:miformat. -
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
publicly_accessible
instance-attribute
¶
publicly_accessible: NotRequired[boolean]
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.
relational_database_blueprint_id
instance-attribute
¶
relational_database_blueprint_id: NotRequired[string]
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.
relational_database_name
instance-attribute
¶
relational_database_name: ResourceName
The name of your Lightsail database resource to update.