Skip to content

aws.elasticache.describe_cache_clusters

Example SQL Queries

SELECT * FROM
aws.elasticache.describe_cache_clusters;

Description

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

Table Definition

Column NameColumn Data Type
cache_cluster_id Input Column

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

VARCHAR
show_cache_clusters_not_in_replication_groups Input Column

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis OSS clusters.

BOOLEAN
show_cache_node_info Input Column

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

BOOLEAN
_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
arn

The ARN (Amazon Resource Name) of the cache cluster.

VARCHAR
at_rest_encryption_enabled

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

BOOLEAN
auth_token_enabled

A flag that enables using an AuthToken (password) when issuing Redis OSS commands.

Default: false

BOOLEAN
auth_token_last_modified_date

The date the auth token was last modified

TIMESTAMP_S
auto_minor_version_upgrade

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

BOOLEAN
cache_cluster_create_time

The date and time when the cluster was created.

TIMESTAMP_S
cache_cluster_status

The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

VARCHAR
cache_node_type

The name of the compute and memory capacity node type for the cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

      For region availability, see Supported Node Types

      M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

      For region availability, see Supported Node Types

      R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.

VARCHAR
cache_nodes

A list of cache nodes that are members of the cluster.

STRUCT(
"cache_node_id" VARCHAR,
"cache_node_status" VARCHAR,
"cache_node_create_time" TIMESTAMP_S,
"endpoint" STRUCT(
"address" VARCHAR,
"port" BIGINT
),
"parameter_group_status" VARCHAR,
"source_cache_node_id" VARCHAR,
"customer_availability_zone" VARCHAR,
"customer_outpost_arn" VARCHAR
)[]
Show child fields
cache_nodes[]
Show child fields
cache_nodes[].cache_node_create_time

The date and time when the cache node was created.

cache_nodes[].cache_node_id

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's Amazon account.

cache_nodes[].cache_node_status

The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

cache_nodes[].customer_availability_zone

The Availability Zone where this node was created and now resides.

cache_nodes[].customer_outpost_arn

The customer outpost ARN of the cache node.

cache_nodes[].endpoint

The hostname for connecting to this cache node.

Show child fields
cache_nodes[].endpoint.address

The DNS hostname of the cache node.

cache_nodes[].endpoint.port

The port number that the cache engine is listening on.

cache_nodes[].parameter_group_status

The status of the parameter group applied to this cache node.

cache_nodes[].source_cache_node_id

The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

cache_parameter_group

Status of the cache parameter group.

STRUCT(
"cache_parameter_group_name" VARCHAR,
"parameter_apply_status" VARCHAR,
"cache_node_ids_to_reboot" VARCHAR[]
)
Show child fields
cache_parameter_group.cache_node_ids_to_reboot[]
cache_parameter_group.cache_parameter_group_name

The name of the cache parameter group.

cache_parameter_group.parameter_apply_status

The status of parameter updates.

cache_security_groups

A list of cache security group elements, composed of name and status sub-elements.

STRUCT(
"cache_security_group_name" VARCHAR,
"status" VARCHAR
)[]
Show child fields
cache_security_groups[]
Show child fields
cache_security_groups[].cache_security_group_name

The name of the cache security group.

cache_security_groups[].status

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

cache_subnet_group_name

The name of the cache subnet group associated with the cluster.

VARCHAR
client_download_landing_page

The URL of the web page where you can download the latest ElastiCache client library.

VARCHAR
configuration_endpoint

Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

STRUCT(
"address" VARCHAR,
"port" BIGINT
)
Show child fields
configuration_endpoint.address

The DNS hostname of the cache node.

configuration_endpoint.port

The port number that the cache engine is listening on.

engine

The name of the cache engine (memcached or redis) to be used for this cluster.

VARCHAR
engine_version

The version of the cache engine that is used in this cluster.

VARCHAR
ip_discovery

The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

VARCHAR
log_delivery_configurations

Returns the destination, format and type of the logs.

STRUCT(
"log_type" VARCHAR,
"destination_type" VARCHAR,
"destination_details" STRUCT(
"cloud_watch_logs_details" STRUCT(
"log_group" VARCHAR
),
"kinesis_firehose_details" STRUCT(
"delivery_stream" VARCHAR
)
),
"log_format" VARCHAR,
"status" VARCHAR,
"message" VARCHAR
)[]
Show child fields
log_delivery_configurations[]
Show child fields
log_delivery_configurations[].destination_details

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

Show child fields
log_delivery_configurations[].destination_details.cloud_watch_logs_details

The configuration details of the CloudWatch Logs destination.

Show child fields
log_delivery_configurations[].destination_details.cloud_watch_logs_details.log_group

The name of the CloudWatch Logs log group.

log_delivery_configurations[].destination_details.kinesis_firehose_details

The configuration details of the Kinesis Data Firehose destination.

Show child fields
log_delivery_configurations[].destination_details.kinesis_firehose_details.delivery_stream

The name of the Kinesis Data Firehose delivery stream.

log_delivery_configurations[].destination_type

Returns the destination type, either cloudwatch-logs or kinesis-firehose.

log_delivery_configurations[].log_format

Returns the log format, either JSON or TEXT.

log_delivery_configurations[].log_type

Refers to slow-log or engine-log.

log_delivery_configurations[].message

Returns an error message for the log delivery configuration.

log_delivery_configurations[].status

Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

network_type

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

VARCHAR
notification_configuration

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

STRUCT(
"topic_arn" VARCHAR,
"topic_status" VARCHAR
)
Show child fields
notification_configuration.topic_arn

The Amazon Resource Name (ARN) that identifies the topic.

notification_configuration.topic_status

The current state of the topic.

num_cache_nodes

The number of cache nodes in the cluster.

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

BIGINT
pending_modified_values

A group of settings that are applied to the cluster in the future, or that are currently being applied.

STRUCT(
"num_cache_nodes" BIGINT,
"cache_node_ids_to_remove" VARCHAR[],
"engine_version" VARCHAR,
"cache_node_type" VARCHAR,
"auth_token_status" VARCHAR,
"log_delivery_configurations" STRUCT(
"log_type" VARCHAR,
"destination_type" VARCHAR,
"destination_details" STRUCT(
"cloud_watch_logs_details" STRUCT(
"log_group" VARCHAR
),
"kinesis_firehose_details" STRUCT(
"delivery_stream" VARCHAR
)
),
"log_format" VARCHAR
)[],
"transit_encryption_enabled" BOOLEAN,
"transit_encryption_mode" VARCHAR
)
Show child fields
pending_modified_values.auth_token_status

The auth token status

pending_modified_values.cache_node_ids_to_remove[]
pending_modified_values.cache_node_type

The cache node type that this cluster or replication group is scaled to.

pending_modified_values.engine_version

The new cache engine version that the cluster runs.

pending_modified_values.log_delivery_configurations[]
Show child fields
pending_modified_values.log_delivery_configurations[].destination_details

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

Show child fields
pending_modified_values.log_delivery_configurations[].destination_details.cloud_watch_logs_details

The configuration details of the CloudWatch Logs destination.

Show child fields
pending_modified_values.log_delivery_configurations[].destination_details.cloud_watch_logs_details.log_group

The name of the CloudWatch Logs log group.

pending_modified_values.log_delivery_configurations[].destination_details.kinesis_firehose_details

The configuration details of the Kinesis Data Firehose destination.

Show child fields
pending_modified_values.log_delivery_configurations[].destination_details.kinesis_firehose_details.delivery_stream

The name of the Kinesis Data Firehose delivery stream.

pending_modified_values.log_delivery_configurations[].destination_type

Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

pending_modified_values.log_delivery_configurations[].log_format

Returns the log format, either JSON or TEXT

pending_modified_values.log_delivery_configurations[].log_type

Refers to slow-log or engine-log..

pending_modified_values.num_cache_nodes

The new number of cache nodes for the cluster.

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

pending_modified_values.transit_encryption_enabled

A flag that enables in-transit encryption when set to true.

pending_modified_values.transit_encryption_mode

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

preferred_availability_zone

The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

VARCHAR
preferred_maintenance_window

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

VARCHAR
preferred_outpost_arn

The outpost ARN in which the cache cluster is created.

VARCHAR
replication_group_id

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

VARCHAR
replication_group_log_delivery_enabled

A boolean value indicating whether log delivery is enabled for the replication group.

BOOLEAN
security_groups

A list of VPC Security Groups associated with the cluster.

STRUCT(
"security_group_id" VARCHAR,
"status" VARCHAR
)[]
Show child fields
security_groups[]
Show child fields
security_groups[].security_group_id

The identifier of the cache security group.

security_groups[].status

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

snapshot_retention_limit

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

BIGINT
snapshot_window

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Example: 05:00-09:00

VARCHAR
transit_encryption_enabled

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

BOOLEAN
transit_encryption_mode

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

VARCHAR