You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::UpdateRelationalDatabaseRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateRelationalDatabaseRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  relational_database_name: "ResourceName", # required
  master_user_password: "SensitiveString",
  rotate_master_user_password: false,
  preferred_backup_window: "string",
  preferred_maintenance_window: "string",
  enable_backup_retention: false,
  disable_backup_retention: false,
  publicly_accessible: false,
  apply_immediately: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

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

Default: false

Returns:

  • (Boolean)

    When true, applies changes immediately.

#disable_backup_retentionBoolean

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:

  • (Boolean)

    When true, disables automated backup retention for your database.

#enable_backup_retentionBoolean

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:

  • (Boolean)

    When true, enables automated backup retention for your database.

#master_user_passwordString

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:

  • (String)

    The password for the master user of your database.

#preferred_backup_windowString

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:

  • (String)

    The daily time range during which automated backups are created for your database if automated backups are enabled.

#preferred_maintenance_windowString

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:

  • (String)

    The weekly time range during which system maintenance can occur on your database.

#publicly_accessibleBoolean

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:

  • (Boolean)

    Specifies the accessibility options for your database.

#relational_database_nameString

The name of your database to update.

Returns:

  • (String)

    The name of your database to update.

#rotate_master_user_passwordBoolean

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:

  • (Boolean)

    When true, the master user password is changed to a new strong password generated by Lightsail.