Describe Clusters

memorydb_describe_clusters

R Documentation

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

Description

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

Usage

memorydb_describe_clusters(ClusterName, MaxResults, NextToken,
  ShowShardDetails)

Arguments

ClusterName

The name of the cluster

MaxResults

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

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

ShowShardDetails

An optional flag that can be included in the request to retrieve information about the individual shard(s).

Value

A list with the following syntax:

list(
  NextToken = "string",
  Clusters = list(
    list(
      Name = "string",
      Description = "string",
      Status = "string",
      PendingUpdates = list(
        Resharding = list(
          SlotMigration = list(
            ProgressPercentage = 123.0
          )
        ),
        ACLs = list(
          ACLToApply = "string"
        ),
        ServiceUpdates = list(
          list(
            ServiceUpdateName = "string",
            Status = "available"|"in-progress"|"complete"|"scheduled"
          )
        )
      ),
      NumberOfShards = 123,
      Shards = list(
        list(
          Name = "string",
          Status = "string",
          Slots = "string",
          Nodes = list(
            list(
              Name = "string",
              Status = "string",
              AvailabilityZone = "string",
              CreateTime = as.POSIXct(
                "2015-01-01"
              ),
              Endpoint = list(
                Address = "string",
                Port = 123
              )
            )
          ),
          NumberOfNodes = 123
        )
      ),
      AvailabilityMode = "singleaz"|"multiaz",
      ClusterEndpoint = list(
        Address = "string",
        Port = 123
      ),
      NodeType = "string",
      EngineVersion = "string",
      EnginePatchVersion = "string",
      ParameterGroupName = "string",
      ParameterGroupStatus = "string",
      SecurityGroups = list(
        list(
          SecurityGroupId = "string",
          Status = "string"
        )
      ),
      SubnetGroupName = "string",
      TLSEnabled = TRUE|FALSE,
      KmsKeyId = "string",
      ARN = "string",
      SnsTopicArn = "string",
      SnsTopicStatus = "string",
      SnapshotRetentionLimit = 123,
      MaintenanceWindow = "string",
      SnapshotWindow = "string",
      ACLName = "string",
      AutoMinorVersionUpgrade = TRUE|FALSE,
      DataTiering = "true"|"false"
    )
  )
)

Request syntax

svc$describe_clusters(
  ClusterName = "string",
  MaxResults = 123,
  NextToken = "string",
  ShowShardDetails = TRUE|FALSE
)