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

Inherits:

Struct

Object
Struct
Aws::Lightsail::Types::UpdateRelationalDatabaseRequest

show all

Defined in:: gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[:master_user_password]

Instance Attribute Summary collapse

#apply_immediately ⇒ Boolean
When true, applies changes immediately.
#ca_certificate_identifier ⇒ String
Indicates the certificate that needs to be associated with the database.
#disable_backup_retention ⇒ Boolean
When true, disables automated backup retention for your database.
#enable_backup_retention ⇒ Boolean
When true, enables automated backup retention for your database.
#master_user_password ⇒ String
The password for the master user.
#preferred_backup_window ⇒ String
The daily time range during which automated backups are created for your database if automated backups are enabled.
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur on your database.
#publicly_accessible ⇒ Boolean
Specifies the accessibility options for your database.
#relational_database_blueprint_id ⇒ String
This parameter is used to update the major version of the database.
#relational_database_name ⇒ String
The name of your Lightsail database resource to update.
#rotate_master_user_password ⇒ Boolean
When true, the master user password is changed to a new strong password generated by Lightsail.

Instance Attribute Details

#apply_immediately ⇒ `Boolean`

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

Default: false

Returns:

(Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#ca_certificate_identifier ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#disable_backup_retention ⇒ `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.

Returns:

(Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#enable_backup_retention ⇒ `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.

Returns:

(Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_user_password ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#preferred_backup_window ⇒ `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.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `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

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#publicly_accessible ⇒ `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.

Returns:

(Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#relational_database_blueprint_id ⇒ `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.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#relational_database_name ⇒ `String`

The name of your Lightsail database resource to update.

Returns:

(String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#rotate_master_user_password ⇒ `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.

Returns:

(Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15020

class UpdateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :master_user_password,
  :rotate_master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_backup_retention,
  :disable_backup_retention,
  :publicly_accessible,
  :apply_immediately,
  :ca_certificate_identifier,
  :relational_database_blueprint_id)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

#ca_certificate_identifier ⇒ String

#disable_backup_retention ⇒ Boolean

#enable_backup_retention ⇒ Boolean

#master_user_password ⇒ String

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#publicly_accessible ⇒ Boolean

#relational_database_blueprint_id ⇒ String

#relational_database_name ⇒ String

#rotate_master_user_password ⇒ Boolean

#apply_immediately ⇒ `Boolean`

#ca_certificate_identifier ⇒ `String`

#disable_backup_retention ⇒ `Boolean`

#enable_backup_retention ⇒ `Boolean`

#master_user_password ⇒ `String`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#publicly_accessible ⇒ `Boolean`

#relational_database_blueprint_id ⇒ `String`

#relational_database_name ⇒ `String`

#rotate_master_user_password ⇒ `Boolean`