Skip to content

UpdateRelationalDatabaseRequest

Source code in docs_src/capo_lightsail/types/update_relational_database_request.py
class UpdateRelationalDatabaseRequest(TypedDict, closed=True):
    relational_database_name: "capo_lightsail.types.resource_name.ResourceName"
    """<p>The name of your Lightsail database resource to update.</p>"""
    master_user_password: NotRequired[
        "capo_lightsail.types.sensitive_string.SensitiveString"
    ]
    """<p>The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p>My<b>SQL</b> </p> <p>Constraints: Must contain from 8 to 41 characters.</p> <p> <b>PostgreSQL</b> </p> <p>Constraints: Must contain from 8 to 128 characters.</p>"""
    rotate_master_user_password: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>When <code>true</code>, the master user password is changed to a new strong password generated by Lightsail.</p> <p>Use the <code>get relational database master user password</code> operation to get the new password.</p>"""
    preferred_backup_window: NotRequired["capo_lightsail.types.string.string"]
    """<p>The daily time range during which automated backups are created for your database if automated backups are enabled.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>hh24:mi-hh24:mi</code> format.</p> <p>Example: <code>16:00-16:30</code> </p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"""
    preferred_maintenance_window: NotRequired["capo_lightsail.types.string.string"]
    """<p>The weekly time range during which system maintenance can occur on your database.</p> <p>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.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</p> </li> <li> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Example: <code>Tue:17:00-Tue:17:30</code> </p> </li> </ul>"""
    enable_backup_retention: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>When <code>true</code>, enables automated backup retention for your database.</p> <p>Updates are applied during the next maintenance window because this can result in an outage.</p>"""
    disable_backup_retention: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>When <code>true</code>, disables automated backup retention for your database.</p> <p>Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the <code>create relational database snapshot</code> operation.</p> <p>Updates are applied during the next maintenance window because this can result in an outage.</p>"""
    publicly_accessible: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>Specifies the accessibility options for your database. A value of <code>true</code> specifies a database that is available to resources outside of your Lightsail account. A value of <code>false</code> specifies a database that is available only to your Lightsail resources in the same region as your database.</p>"""
    apply_immediately: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>When <code>true</code>, applies changes immediately. When <code>false</code>, applies changes during the preferred maintenance window. Some changes may cause an outage.</p> <p>Default: <code>false</code> </p>"""
    ca_certificate_identifier: NotRequired["capo_lightsail.types.string.string"]
    """<p>Indicates the certificate that needs to be associated with the database.</p>"""
    relational_database_blueprint_id: NotRequired["capo_lightsail.types.string.string"]
    """<p>This parameter is used to update the major version of the database. Enter the <code>blueprintId</code> for the major version that you want to update to.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRelationalDatabaseBlueprints.html">GetRelationalDatabaseBlueprints</a> action to get a list of available blueprint IDs.</p>"""

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

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

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.

rotate_master_user_password instance-attribute

rotate_master_user_password: NotRequired[boolean]

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.