Table: aws_memorydb_cluster - Query AWS MemoryDB Clusters using SQL
AWS MemoryDB is a Redis-compatible, fully managed, in-memory database service that delivers ultra-fast performance for modern applications. It is designed for building and running real-time applications that require sub-millisecond latency. The aws_memorydb_cluster
table in Steampipe allows you to query information about MemoryDB clusters in your AWS environment. This includes details like cluster configuration, status, security, and maintenance settings.
Table Usage Guide
The aws_memorydb_cluster
table enables DevOps engineers and cloud administrators to gather detailed insights on their MemoryDB clusters. You can query various aspects of the cluster, such as its endpoint configuration, encryption settings, and shard details. This table is particularly useful for monitoring cluster health, ensuring security compliance, and managing cluster configurations.
Examples
Basic cluster information
Retrieve basic information about your AWS MemoryDB clusters, including their name, ARN, status, and node type. This can be useful for getting an overview of the clusters deployed in your AWS account.
select name, arn, status, node_type, engine_version, regionfrom aws_memorydb_cluster;
select name, arn, status, node_type, engine_version, regionfrom aws_memorydb_cluster;
List clusters with auto-minor version upgrade enabled
Identify clusters that have automatic minor version upgrades enabled, which can be useful for understanding how your clusters are being maintained and ensuring they are kept up to date.
select name, arn, auto_minor_version_upgradefrom aws_memorydb_clusterwhere auto_minor_version_upgrade = true;
select name, arn, auto_minor_version_upgradefrom aws_memorydb_clusterwhere auto_minor_version_upgrade = 1;
List multi-AZ clusters
Fetch a list of clusters that are configured with Multi-AZ for high availability. This can help in identifying which clusters have enhanced availability features enabled.
select name, arn, availability_modefrom aws_memorydb_clusterwhere availability_mode = 'multiaz';
select name, arn, availability_modefrom aws_memorydb_clusterwhere availability_mode = 'multiaz';
List clusters with encryption in transit disabled
Find clusters where encryption in transit is not enabled, which may indicate potential security risks that need to be addressed.
select name, arn, tls_enabledfrom aws_memorydb_clusterwhere tls_enabled = false;
select name, arn, tls_enabledfrom aws_memorydb_clusterwhere tls_enabled = 0;
Clusters by maintenance window
Retrieve clusters along with their scheduled maintenance windows, which is useful for planning updates and understanding potential downtime.
select name, arn, maintenance_windowfrom aws_memorydb_cluster;
select name, arn, maintenance_windowfrom aws_memorydb_cluster;
List clusters with specific node type
Query clusters that are using a particular node type, allowing you to evaluate the resource allocations and performance characteristics across your MemoryDB clusters.
select name, arn, node_typefrom aws_memorydb_clusterwhere node_type = 'db.r6gd.xlarge';
select name, arn, node_typefrom aws_memorydb_clusterwhere node_type = 'db.r6gd.xlarge';
List clusters with shard details
Retrieve detailed information about the shards within each cluster, including shard configuration and number of shards. This can help in understanding the distribution of data and load across your clusters.
select name, arn, number_of_shards, shardsfrom aws_memorydb_cluster;
select name, arn, number_of_shards, shardsfrom aws_memorydb_cluster;
Clusters with pending updates
Identify clusters that have pending updates, which may require attention to ensure the clusters are up-to-date and running optimally.
select name, arn, pending_updatesfrom aws_memorydb_clusterwhere jsonb_array_length(pending_updates) > 0;
select name, arn, pending_updatesfrom aws_memorydb_clusterwhere json_array_length(pending_updates) > 0;
List clusters with snapshot retention details
Gather information on the snapshot retention settings of your clusters to ensure that your data backup policies are being properly enforced.
select name, arn, snapshot_retention_limit, snapshot_windowfrom aws_memorydb_cluster;
select name, arn, snapshot_retention_limit, snapshot_windowfrom aws_memorydb_cluster;
Schema for aws_memorydb_cluster
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
account_id | text | =, !=, ~~, ~~*, !~~, !~~* | The AWS Account ID in which the resource is located. |
acl_name | text | The name of the Access Control List associated with this cluster. | |
akas | jsonb | Array of globally unique identifier strings (also known as) for the resource. | |
arn | text | The Amazon Resource Name (ARN) of the cluster. | |
auto_minor_version_upgrade | boolean | When set to true, the cluster will automatically receive minor engine version upgrades after launch. | |
availability_mode | text | Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz). | |
cluster_endpoint | jsonb | The cluster's configuration endpoint. | |
data_tiering | text | Enables data tiering, supported only for clusters using the r6gd node type. | |
description | text | A description of the cluster. | |
engine_patch_version | text | The Redis engine patch version used by the cluster. | |
engine_version | text | The Redis engine version used by the cluster. | |
kms_key_id | text | The ID of the KMS key used to encrypt the cluster. | |
maintenance_window | text | Specifies the weekly time range during which maintenance on the cluster is performed. | |
name | text | = | The user-supplied name of the cluster. |
node_type | text | The cluster's node type. | |
number_of_shards | bigint | The number of shards in the cluster. | |
parameter_group_name | text | The name of the parameter group used by the cluster. | |
parameter_group_status | text | The status of the parameter group used by the cluster. | |
partition | text | The AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov). | |
pending_updates | jsonb | A group of settings that are currently being applied. | |
region | text | The AWS Region in which the resource is located. | |
security_groups | jsonb | A list of security groups used by the cluster. | |
shards | jsonb | A list of shards that are members of the cluster. | |
snapshot_retention_limit | bigint | The number of days for which MemoryDB retains automatic snapshots before deleting them. | |
snapshot_window | text | The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. | |
sns_topic_arn | text | The Amazon Resource Name (ARN) of the SNS notification topic. | |
sns_topic_status | text | The SNS topic must be in Active status to receive notifications. | |
sp_connection_name | text | =, !=, ~~, ~~*, !~~, !~~* | Steampipe connection name. |
sp_ctx | jsonb | Steampipe context in JSON form. | |
status | text | The status of the cluster (e.g., Available, Updating, Creating). | |
subnet_group_name | text | The name of the subnet group used by the cluster. | |
title | text | Title of the resource. | |
tls_enabled | boolean | Indicates if In-transit encryption is enabled. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- aws
You can pass the configuration to the command with the --config
argument:
steampipe_export_aws --config '<your_config>' aws_memorydb_cluster