Skip to content
AWS for Query.Farm

aws.opsworks.describe_rds_db_instances

Example SQL Queries

SELECT * FROM
aws.opsworks.describe_rds_db_instances
WHERE
"stack_id" = 'VALUE';

Description

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Table Definition

Column NameColumn Data Type
stack_id Required Input Column

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

VARCHAR
rds_db_instance_arns Input Column

An array containing the ARNs of the instances to be described.

VARCHAR[]
Show child fields
rds_db_instance_arns[]
_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
rds_db_instances

An a array of RdsDbInstance objects that describe the instances.

STRUCT(
    "rds_db_instance_arn" VARCHAR,
    "db_instance_identifier" VARCHAR,
    "db_user" VARCHAR,
    "db_password" VARCHAR,
    "region" VARCHAR,
    "address" VARCHAR,
    "engine" VARCHAR,
    "stack_id" VARCHAR,
    "missing_on_rds" BOOLEAN
)[]
Show child fields
rds_db_instances[]
Show child fields
rds_db_instances[].address

The instance's address.

rds_db_instances[].db_instance_identifier

The database instance identifier.

rds_db_instances[].db_password

OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

rds_db_instances[].db_user

The master user name.

rds_db_instances[].engine

The instance's database engine.

rds_db_instances[].missing_on_rds

Set to true if OpsWorks Stacks is unable to discover the Amazon RDS instance. OpsWorks Stacks attempts to discover the instance only once. If this value is set to true, you must deregister the instance, and then register it again.

rds_db_instances[].rds_db_instance_arn

The instance's ARN.

rds_db_instances[].region

The instance's Amazon Web Services Region.

rds_db_instances[].stack_id

The ID of the stack with which the instance is registered.