Skip to content
AWS for Query.Farm

aws.dax.describe_clusters

Example SQL Queries

SELECT * FROM
aws.dax.describe_clusters;

Description

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

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

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

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

Table Definition

Column NameColumn Data Type
cluster_names Input Column

The names of the DAX clusters being described.

VARCHAR[]
Show child fields
cluster_names[]
_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
active_nodes

The number of nodes in the cluster that are active (i.e., capable of serving requests).

BIGINT
cluster_arn

The Amazon Resource Name (ARN) that uniquely identifies the cluster. 

VARCHAR
cluster_discovery_endpoint

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

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

The DNS hostname of the endpoint.

cluster_discovery_endpoint.port

The port number that applications should use to connect to the endpoint.

cluster_discovery_endpoint.url

The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.

cluster_endpoint_encryption_type

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

VARCHAR
cluster_name

The name of the DAX cluster.

VARCHAR
description

The description of the cluster.

VARCHAR
iam_role_arn

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

VARCHAR
node_ids_to_remove

A list of nodes to be removed from the cluster.

VARCHAR[]
Show child fields
node_ids_to_remove[]
node_type

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

VARCHAR
nodes

A list of nodes that are currently in the cluster.

STRUCT(
    "node_id" VARCHAR,
    "endpoint" STRUCT(
        "address" VARCHAR,
        "port" BIGINT,
        "url" VARCHAR
    ),
    "node_create_time" TIMESTAMP_S,
    "availability_zone" VARCHAR,
    "node_status" VARCHAR,
    "parameter_group_status" VARCHAR
)[]
Show child fields
nodes[]
Show child fields
nodes[].availability_zone

The Availability Zone (AZ) in which the node has been deployed.

nodes[].endpoint

The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Show child fields
nodes[].endpoint.address

The DNS hostname of the endpoint.

nodes[].endpoint.port

The port number that applications should use to connect to the endpoint.

nodes[].endpoint.url

The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.

nodes[].node_create_time

The date and time (in UNIX epoch format) when the node was launched.

nodes[].node_id

A system-generated identifier for the node.

nodes[].node_status

The current status of the node. For example: available.

nodes[].parameter_group_status

The status of the parameter group associated with this node. For example, in-sync.

notification_configuration

Describes a notification topic and its status. Notification topics are used for publishing DAX 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. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

parameter_group

The parameter group being used by nodes in the cluster.

STRUCT(
    "parameter_group_name" VARCHAR,
    "parameter_apply_status" VARCHAR,
    "node_ids_to_reboot" VARCHAR[]
)
Show child fields
parameter_group.node_ids_to_reboot[]
parameter_group.parameter_apply_status

The status of parameter updates.

parameter_group.parameter_group_name

The name of the parameter group.

preferred_maintenance_window

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

VARCHAR
security_groups

A list of security groups, and the status of each, for the nodes in the cluster.

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

The unique ID for this security group.

security_groups[].status

The status of this security group.

sse_description

The description of the server-side encryption status on the specified DAX cluster.

STRUCT(
    "status" VARCHAR
)
Show child fields
sse_description.status

The current state of server-side encryption:

  • ENABLING - Server-side encryption is being enabled.

  • ENABLED - Server-side encryption is enabled.

  • DISABLING - Server-side encryption is being disabled.

  • DISABLED - Server-side encryption is disabled.

status

The current status of the cluster.

VARCHAR
subnet_group

The subnet group where the DAX cluster is running.

VARCHAR
total_nodes

The total number of nodes in the cluster.

BIGINT