Skip to content
AWS for Query.Farm

aws.elasticache.describe_user_groups

Example SQL Queries

SELECT * FROM
aws.elasticache.describe_user_groups;

Description

Returns a list of user groups.

Table Definition

Column NameColumn Data Type
user_group_id Input Column

The ID of the user group.

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 user group.

VARCHAR
engine

The current supported value is Redis user. 

VARCHAR
minimum_engine_version

The minimum engine version required, which is Redis OSS 6.0

VARCHAR
pending_changes

A list of updates being applied to the user group.

STRUCT(
    "user_ids_to_remove" VARCHAR[],
    "user_ids_to_add" VARCHAR[]
)
Show child fields
pending_changes.user_ids_to_add[]
pending_changes.user_ids_to_remove[]
replication_groups

A list of replication groups that the user group can access.

VARCHAR[]
Show child fields
replication_groups[]
serverless_caches

Indicates which serverless caches the specified user group is associated with. Available for Redis OSS and Serverless Memcached only.

VARCHAR[]
Show child fields
serverless_caches[]
status

Indicates user group status. Can be "creating", "active", "modifying", "deleting".

VARCHAR
user_ids

The list of user IDs that belong to the user group.

VARCHAR[]
Show child fields
user_ids[]