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

Class: Aws::Lightsail::Types::RelationalDatabase

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

Overview

Describes a database.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the database.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the database.

#backup_retention_enabledBoolean

A Boolean value indicating whether automated backup retention is enabled for the database.

Returns:

  • (Boolean)

    A Boolean value indicating whether automated backup retention is enabled for the database.

#created_atTime

The timestamp when the database was created. Formatted in Unix time.

Returns:

  • (Time)

    The timestamp when the database was created.

#engineString

The database software (for example, MySQL).

Returns:

  • (String)

    The database software (for example, MySQL).

#engine_versionString

The database engine version (for example, 5.7.23).

Returns:

  • (String)

    The database engine version (for example, 5.7.23).

#hardwareTypes::RelationalDatabaseHardware

Describes the hardware of the database.

Returns:

#latest_restorable_timeTime

The latest point in time to which the database can be restored. Formatted in Unix time.

Returns:

  • (Time)

    The latest point in time to which the database can be restored.

#locationTypes::ResourceLocation

The Region name and Availability Zone where the database is located.

Returns:

#master_database_nameString

The name of the master database created when the Lightsail database resource is created.

Returns:

  • (String)

    The name of the master database created when the Lightsail database resource is created.

#master_endpointTypes::RelationalDatabaseEndpoint

The master endpoint for the database.

Returns:

#master_usernameString

The master user name of the database.

Returns:

  • (String)

    The master user name of the database.

#nameString

The unique name of the database resource in Lightsail.

Returns:

  • (String)

    The unique name of the database resource in Lightsail.

#parameter_apply_statusString

The status of parameter updates for the database.

Returns:

  • (String)

    The status of parameter updates for the database.

#pending_maintenance_actionsArray<Types::PendingMaintenanceAction>

Describes the pending maintenance actions for the database.

Returns:

#pending_modified_valuesTypes::PendingModifiedRelationalDatabaseValues

Describes pending database value modifications.

Returns:

#preferred_backup_windowString

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

Returns:

  • (String)

    The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

#preferred_maintenance_windowString

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

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

Returns:

  • (String)

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

#publicly_accessibleBoolean

A Boolean value indicating whether the database is publicly accessible.

Returns:

  • (Boolean)

    A Boolean value indicating whether the database is publicly accessible.

#relational_database_blueprint_idString

The blueprint ID for the database. A blueprint describes the major engine version of a database.

Returns:

  • (String)

    The blueprint ID for the database.

#relational_database_bundle_idString

The bundle ID for the database. A bundle describes the performance specifications for your database.

Returns:

  • (String)

    The bundle ID for the database.

#resource_typeString

The Lightsail resource type for the database (for example, RelationalDatabase).

Possible values:

  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord

Returns:

  • (String)

    The Lightsail resource type for the database (for example, RelationalDatabase).

#secondary_availability_zoneString

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

Returns:

  • (String)

    Describes the secondary Availability Zone of a high availability database.

#stateString

Describes the current state of the database.

Returns:

  • (String)

    Describes the current state of the database.

#support_codeString

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Returns:

  • (String)

    The support code for the database.

#tagsArray<Types::Tag>

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Returns:

  • (Array<Types::Tag>)

    The tag keys and optional values for the resource.