Skip to content

Describe Clusters

dax_describe_clusters R Documentation

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

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.

Usage

dax_describe_clusters(ClusterNames, MaxResults, NextToken)

Arguments

ClusterNames

The names of the DAX clusters being described.

MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Clusters = list(
    list(
      ClusterName = "string",
      Description = "string",
      ClusterArn = "string",
      TotalNodes = 123,
      ActiveNodes = 123,
      NodeType = "string",
      Status = "string",
      ClusterDiscoveryEndpoint = list(
        Address = "string",
        Port = 123,
        URL = "string"
      ),
      NodeIdsToRemove = list(
        "string"
      ),
      Nodes = list(
        list(
          NodeId = "string",
          Endpoint = list(
            Address = "string",
            Port = 123,
            URL = "string"
          ),
          NodeCreateTime = as.POSIXct(
            "2015-01-01"
          ),
          AvailabilityZone = "string",
          NodeStatus = "string",
          ParameterGroupStatus = "string"
        )
      ),
      PreferredMaintenanceWindow = "string",
      NotificationConfiguration = list(
        TopicArn = "string",
        TopicStatus = "string"
      ),
      SubnetGroup = "string",
      SecurityGroups = list(
        list(
          SecurityGroupIdentifier = "string",
          Status = "string"
        )
      ),
      IamRoleArn = "string",
      ParameterGroup = list(
        ParameterGroupName = "string",
        ParameterApplyStatus = "string",
        NodeIdsToReboot = list(
          "string"
        )
      ),
      SSEDescription = list(
        Status = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"
      ),
      ClusterEndpointEncryptionType = "NONE"|"TLS"
    )
  )
)

Request syntax

svc$describe_clusters(
  ClusterNames = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)