Skip to content
AWS for Query.Farm

aws.timestream_influxdb.get_db_instance

Example SQL Queries

SELECT * FROM
aws.timestream_influxdb.get_db_instance
WHERE
"identifier" = 'VALUE';

Description

Returns a Timestream for InfluxDB DB instance.

Table Definition

Column NameColumn Data Type
identifier Required Input Column

The id of the DB instance.

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.

allocated_storage

The amount of storage allocated for your DB storage type (in gibibytes).

BIGINT
arn

The Amazon Resource Name (ARN) of the DB instance.

VARCHAR
availability_zone

The Availability Zone in which the DB instance resides.

VARCHAR
db_instance_type

The Timestream for InfluxDB instance type that InfluxDB runs on.

VARCHAR
db_parameter_group_identifier

The id of the DB parameter group assigned to your DB instance.

VARCHAR
db_storage_type

The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

VARCHAR
deployment_type

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

VARCHAR
endpoint

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

VARCHAR
id

A service-generated unique identifier.

VARCHAR
influx_auth_parameters_secret_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

VARCHAR
log_delivery_configuration

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

STRUCT(
    "s3_configuration" STRUCT(
        "bucket_name" VARCHAR,
        "enabled" BOOLEAN
    )
)
Show child fields
log_delivery_configuration.s3_configuration

Configuration for S3 bucket log delivery.

Show child fields
log_delivery_configuration.s3_configuration.bucket_name

The name of the S3 bucket to deliver logs to.

log_delivery_configuration.s3_configuration.enabled

Indicates whether log delivery to the S3 bucket is enabled.

name

The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

VARCHAR
publicly_accessible

Indicates if the DB instance has a public IP to facilitate access.

BOOLEAN
secondary_availability_zone

The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

VARCHAR
status

The status of the DB instance.

VARCHAR
vpc_security_group_ids

A list of VPC security group IDs associated with the DB instance.

VARCHAR[]
Show child fields
vpc_security_group_ids[]
vpc_subnet_ids

A list of VPC subnet IDs associated with the DB instance.

VARCHAR[]
Show child fields
vpc_subnet_ids[]