Skip to content

Describe Multi Region Clusters

memorydb_describe_multi_region_clusters R Documentation

Returns details about one or more multi-Region clusters

Description

Returns details about one or more multi-Region clusters.

Usage

memorydb_describe_multi_region_clusters(MultiRegionClusterName,
  MaxResults, NextToken, ShowClusterDetails)

Arguments

MultiRegionClusterName

The name of a specific multi-Region cluster to describe.

MaxResults

The maximum number of results to return.

NextToken

A token to specify where to start paginating.

ShowClusterDetails

Details about the multi-Region cluster.

Value

A list with the following syntax:

list(
  NextToken = "string",
  MultiRegionClusters = list(
    list(
      MultiRegionClusterName = "string",
      Description = "string",
      Status = "string",
      NodeType = "string",
      Engine = "string",
      EngineVersion = "string",
      NumberOfShards = 123,
      Clusters = list(
        list(
          ClusterName = "string",
          Region = "string",
          Status = "string",
          ARN = "string"
        )
      ),
      MultiRegionParameterGroupName = "string",
      TLSEnabled = TRUE|FALSE,
      ARN = "string"
    )
  )
)

Request syntax

svc$describe_multi_region_clusters(
  MultiRegionClusterName = "string",
  MaxResults = 123,
  NextToken = "string",
  ShowClusterDetails = TRUE|FALSE
)