Skip to content

RelationalDatabase

Source code in docs_src/capo_lightsail/types/relational_database.py
class RelationalDatabase(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The unique name of the database resource in Lightsail.</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the database.</p>"""
    support_code: NotRequired["capo_lightsail.types.string.string"]
    """<p>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.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the database was created. Formatted in Unix time.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The Region name and Availability Zone where the database is located.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The Lightsail resource type for the database (for example, <code>RelationalDatabase</code>).</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>"""
    relational_database_blueprint_id: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The blueprint ID for the database. A blueprint describes the major engine version of a database.</p>"""
    relational_database_bundle_id: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The bundle ID for the database. A bundle describes the performance specifications for your database.</p>"""
    master_database_name: NotRequired["capo_lightsail.types.string.string"]
    """<p>The name of the master database created when the Lightsail database resource is created.</p>"""
    hardware: NotRequired[
        "capo_lightsail.types.relational_database_hardware.RelationalDatabaseHardware"
    ]
    """<p>Describes the hardware of the database.</p>"""
    state: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>Describes the current state of the database.</p>"""
    secondary_availability_zone: NotRequired["capo_lightsail.types.string.string"]
    """<p>Describes the secondary Availability Zone of a high availability database.</p> <p>The secondary database is used for failover support of a high availability database.</p>"""
    backup_retention_enabled: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value indicating whether automated backup retention is enabled for the database.</p>"""
    pending_modified_values: NotRequired[
        "capo_lightsail.types.pending_modified_relational_database_values.PendingModifiedRelationalDatabaseValues"
    ]
    """<p>Describes pending database value modifications.</p>"""
    engine: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The database software (for example, <code>MySQL</code>).</p>"""
    engine_version: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The database engine version (for example, <code>5.7.23</code>).</p>"""
    latest_restorable_time: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The latest point in time to which the database can be restored. Formatted in Unix time.</p>"""
    master_username: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The master user name of the database.</p>"""
    parameter_apply_status: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The status of parameter updates for the database.</p>"""
    preferred_backup_window: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The daily time range during which automated backups are created for the database (for example, <code>16:00-16:30</code>).</p>"""
    preferred_maintenance_window: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The weekly time range during which system maintenance can occur on the database.</p> <p>In the format <code>ddd:hh24:mi-ddd:hh24:mi</code>. For example, <code>Tue:17:00-Tue:17:30</code>.</p>"""
    publicly_accessible: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value indicating whether the database is publicly accessible.</p>"""
    master_endpoint: NotRequired[
        "capo_lightsail.types.relational_database_endpoint.RelationalDatabaseEndpoint"
    ]
    """<p>The master endpoint for the database.</p>"""
    pending_maintenance_actions: NotRequired[
        "capo_lightsail.types.pending_maintenance_action_list.PendingMaintenanceActionList"
    ]
    """<p>Describes the pending maintenance actions for the database.</p>"""
    ca_certificate_identifier: NotRequired["capo_lightsail.types.string.string"]
    """<p>The certificate associated with the database.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the database.

backup_retention_enabled instance-attribute

backup_retention_enabled: NotRequired[boolean]

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

ca_certificate_identifier instance-attribute

ca_certificate_identifier: NotRequired[string]

The certificate associated with the database.

created_at instance-attribute

created_at: NotRequired[IsoDate]

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

engine instance-attribute

engine: NotRequired[NonEmptyString]

The database software (for example, MySQL).

engine_version instance-attribute

engine_version: NotRequired[NonEmptyString]

The database engine version (for example, 5.7.23).

hardware instance-attribute

hardware: NotRequired[RelationalDatabaseHardware]

Describes the hardware of the database.

latest_restorable_time instance-attribute

latest_restorable_time: NotRequired[IsoDate]

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

location instance-attribute

location: NotRequired[ResourceLocation]

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

master_database_name instance-attribute

master_database_name: NotRequired[string]

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

master_endpoint instance-attribute

master_endpoint: NotRequired[RelationalDatabaseEndpoint]

The master endpoint for the database.

master_username instance-attribute

master_username: NotRequired[NonEmptyString]

The master user name of the database.

name instance-attribute

name: NotRequired[ResourceName]

The unique name of the database resource in Lightsail.

parameter_apply_status instance-attribute

parameter_apply_status: NotRequired[NonEmptyString]

The status of parameter updates for the database.

pending_maintenance_actions instance-attribute

pending_maintenance_actions: NotRequired[PendingMaintenanceActionList]

Describes the pending maintenance actions for the database.

pending_modified_values instance-attribute

pending_modified_values: NotRequired[PendingModifiedRelationalDatabaseValues]

Describes pending database value modifications.

preferred_backup_window instance-attribute

preferred_backup_window: NotRequired[NonEmptyString]

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

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[NonEmptyString]

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.

publicly_accessible instance-attribute

publicly_accessible: NotRequired[boolean]

A Boolean value indicating whether the database is publicly accessible.

relational_database_blueprint_id instance-attribute

relational_database_blueprint_id: NotRequired[NonEmptyString]

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

relational_database_bundle_id instance-attribute

relational_database_bundle_id: NotRequired[NonEmptyString]

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

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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

secondary_availability_zone instance-attribute

secondary_availability_zone: NotRequired[string]

Describes the secondary Availability Zone of a high availability database.

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

state instance-attribute

state: NotRequired[NonEmptyString]

Describes the current state of the database.

support_code instance-attribute

support_code: NotRequired[string]

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.

tags instance-attribute

tags: NotRequired[TagList]

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