Skip to content

Returns information about Amazon DocumentDB global clusters

Description

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

Usage

docdb_describe_global_clusters(GlobalClusterIdentifier, Filters,
  MaxRecords, Marker)

Arguments

  • GlobalClusterIdentifier

    The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

  • Filters

    A filter that specifies one or more global DB clusters to describe.

    Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

  • MaxRecords

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

  • Marker

    An optional pagination token provided by a previous describe_global_clusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

list(
  Marker = "string",
  GlobalClusters = list(
    list(
      GlobalClusterIdentifier = "string",
      GlobalClusterResourceId = "string",
      GlobalClusterArn = "string",
      Status = "string",
      Engine = "string",
      EngineVersion = "string",
      DatabaseName = "string",
      StorageEncrypted = TRUE|FALSE,
      DeletionProtection = TRUE|FALSE,
      GlobalClusterMembers = list(
        list(
          DBClusterArn = "string",
          Readers = list(
            "string"
          ),
          IsWriter = TRUE|FALSE,
          SynchronizationStatus = "connected"|"pending-resync"
        )
      ),
      FailoverState = list(
        Status = "pending"|"failing-over"|"cancelling",
        FromDbClusterArn = "string",
        ToDbClusterArn = "string",
        IsDataLossAllowed = TRUE|FALSE
      ),
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_global_clusters(
  GlobalClusterIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)