Skip to content
AWS for Query.Farm

aws.lightsail.get_relational_database_snapshot

Example SQL Queries

SELECT * FROM
aws.lightsail.get_relational_database_snapshot
WHERE
"relational_database_snapshot_name" = 'VALUE';

Description

Returns information about a specific database snapshot in Amazon Lightsail.

Table Definition

Column NameColumn Data Type
relational_database_snapshot_name Required Input Column

The name of the database snapshot for which to get information.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
relational_database_snapshot

An object describing the specified database snapshot.

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR,
    "support_code" VARCHAR,
    "created_at" TIMESTAMP_S,
    "location" STRUCT(
        "availability_zone" VARCHAR,
        "region_name" VARCHAR
    ),
    "resource_type" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "engine" VARCHAR,
    "engine_version" VARCHAR,
    "size_in_gb" BIGINT,
    "state" VARCHAR,
    "from_relational_database_name" VARCHAR,
    "from_relational_database_arn" VARCHAR,
    "from_relational_database_bundle_id" VARCHAR,
    "from_relational_database_blueprint_id" VARCHAR
)
Show child fields
relational_database_snapshot.arn

The Amazon Resource Name (ARN) of the database snapshot.

relational_database_snapshot.created_at

The timestamp when the database snapshot was created.

relational_database_snapshot.engine

The software of the database snapshot (for example, MySQL)

relational_database_snapshot.engine_version

The database engine version for the database snapshot (for example, 5.7.23).

relational_database_snapshot.from_relational_database_arn

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

relational_database_snapshot.from_relational_database_blueprint_id

The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

relational_database_snapshot.from_relational_database_bundle_id

The bundle ID of the database from which the database snapshot was created.

relational_database_snapshot.from_relational_database_name

The name of the source database from which the database snapshot was created.

relational_database_snapshot.location

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

Show child fields
relational_database_snapshot.location.availability_zone

The Availability Zone. Follows the format us-east-2a (case-sensitive).

relational_database_snapshot.location.region_name

The Amazon Web Services Region name.

relational_database_snapshot.name

The name of the database snapshot.

relational_database_snapshot.resource_type

The Lightsail resource type.

relational_database_snapshot.size_in_gb

The size of the disk in GB (for example, 32) for the database snapshot.

relational_database_snapshot.state

The state of the database snapshot.

relational_database_snapshot.support_code

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

relational_database_snapshot.tags[]
Show child fields
relational_database_snapshot.tags[].key

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@

relational_database_snapshot.tags[].value

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@