Skip to content
AWS for Query.Farm

aws.elasticache.describe_serverless_caches

Example SQL Queries

SELECT * FROM
aws.elasticache.describe_serverless_caches;

Description

Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.

Table Definition

Column NameColumn Data Type
serverless_cache_name Input Column

The unique identifier of the serverless cache.

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
arn

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

VARCHAR
cache_usage_limits

The cache usage limit for the serverless cache.

STRUCT(
    "data_storage" STRUCT(
        "maximum" BIGINT,
        "minimum" BIGINT,
        "unit" VARCHAR
    ),
    "ecpu_per_second" STRUCT(
        "maximum" BIGINT,
        "minimum" BIGINT
    )
)
Show child fields
cache_usage_limits.data_storage

The maximum data storage limit in the cache, expressed in Gigabytes.

Show child fields
cache_usage_limits.data_storage.maximum

The upper limit for data storage the cache is set to use.

cache_usage_limits.data_storage.minimum

The lower limit for data storage the cache is set to use.

cache_usage_limits.data_storage.unit

The unit that the storage is measured in, in GB.

cache_usage_limits.ecpu_per_second

The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.

Show child fields
cache_usage_limits.ecpu_per_second.maximum

The configuration for the maximum number of ECPUs the cache can consume per second.

cache_usage_limits.ecpu_per_second.minimum

The configuration for the minimum number of ECPUs the cache should be able consume per second.

create_time

When the serverless cache was created. 

TIMESTAMP_S
daily_snapshot_time

The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis OSS and Serverless Memcached only.

VARCHAR
description

A description of the serverless cache.

VARCHAR
endpoint

Represents the information required for client programs to connect to a cache node. This value is read-only.

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

The DNS hostname of the cache node.

endpoint.port

The port number that the cache engine is listening on.

engine

The engine the serverless cache is compatible with.

VARCHAR
full_engine_version

The name and version number of the engine the serverless cache is compatible with.

VARCHAR
kms_key_id

The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

VARCHAR
major_engine_version

The version number of the engine the serverless cache is compatible with.

VARCHAR
reader_endpoint

Represents the information required for client programs to connect to a cache node. This value is read-only.

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

The DNS hostname of the cache node.

reader_endpoint.port

The port number that the cache engine is listening on.

security_group_ids

The IDs of the EC2 security groups associated with the serverless cache.

VARCHAR[]
Show child fields
security_group_ids[]
snapshot_retention_limit

The current setting for the number of serverless cache snapshots the system will retain. Available for Redis OSS and Serverless Memcached only.

BIGINT
status

The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

VARCHAR
subnet_ids

If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.

VARCHAR[]
Show child fields
subnet_ids[]
user_group_id

The identifier of the user group associated with the serverless cache. Available for Redis OSS only. Default is NULL.

VARCHAR