Skip to content

Describe Global Clusters

rds_describe_global_clusters R Documentation

Returns information about Aurora global database clusters

Description

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Usage

rds_describe_global_clusters(GlobalClusterIdentifier, Filters,
  MaxRecords, Marker)

Arguments

GlobalClusterIdentifier

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.
Filters

A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

Currently, the only supported filter is region.

If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.
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.

Default: 100

Constraints: Minimum 20, maximum 100.
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",
      EngineLifecycleSupport = "string",
      DatabaseName = "string",
      StorageEncrypted = TRUE|FALSE,
      DeletionProtection = TRUE|FALSE,
      GlobalClusterMembers = list(
        list(
          DBClusterArn = "string",
          Readers = list(
            "string"
          ),
          IsWriter = TRUE|FALSE,
          GlobalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown",
          SynchronizationStatus = "connected"|"pending-resync"
        )
      ),
      Endpoint = "string",
      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"
)