Describe Db Clusters

rds_describe_db_clusters

R Documentation

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters

Description

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Usage

rds_describe_db_clusters(DBClusterIdentifier, Filters, MaxRecords,
  Marker, IncludeShared)

Arguments

DBClusterIdentifier

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match an existing DB cluster identifier.

Filters

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

Supported Filters:

• clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

• db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100

Marker

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

IncludeShared

Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

Value

A list with the following syntax:

list(
  Marker = "string",
  DBClusters = list(
    list(
      AllocatedStorage = 123,
      AvailabilityZones = list(
        "string"
      ),
      BackupRetentionPeriod = 123,
      CharacterSetName = "string",
      DatabaseName = "string",
      DBClusterIdentifier = "string",
      DBClusterParameterGroup = "string",
      DBSubnetGroup = "string",
      Status = "string",
      AutomaticRestartTime = as.POSIXct(
        "2015-01-01"
      ),
      PercentProgress = "string",
      EarliestRestorableTime = as.POSIXct(
        "2015-01-01"
      ),
      Endpoint = "string",
      ReaderEndpoint = "string",
      CustomEndpoints = list(
        "string"
      ),
      MultiAZ = TRUE|FALSE,
      Engine = "string",
      EngineVersion = "string",
      LatestRestorableTime = as.POSIXct(
        "2015-01-01"
      ),
      Port = 123,
      MasterUsername = "string",
      DBClusterOptionGroupMemberships = list(
        list(
          DBClusterOptionGroupName = "string",
          Status = "string"
        )
      ),
      PreferredBackupWindow = "string",
      PreferredMaintenanceWindow = "string",
      ReplicationSourceIdentifier = "string",
      ReadReplicaIdentifiers = list(
        "string"
      ),
      StatusInfos = list(
        list(
          StatusType = "string",
          Normal = TRUE|FALSE,
          Status = "string",
          Message = "string"
        )
      ),
      DBClusterMembers = list(
        list(
          DBInstanceIdentifier = "string",
          IsClusterWriter = TRUE|FALSE,
          DBClusterParameterGroupStatus = "string",
          PromotionTier = 123
        )
      ),
      VpcSecurityGroups = list(
        list(
          VpcSecurityGroupId = "string",
          Status = "string"
        )
      ),
      HostedZoneId = "string",
      StorageEncrypted = TRUE|FALSE,
      KmsKeyId = "string",
      DbClusterResourceId = "string",
      DBClusterArn = "string",
      AssociatedRoles = list(
        list(
          RoleArn = "string",
          Status = "string",
          FeatureName = "string"
        )
      ),
      IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
      CloneGroupId = "string",
      ClusterCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      EarliestBacktrackTime = as.POSIXct(
        "2015-01-01"
      ),
      BacktrackWindow = 123,
      BacktrackConsumedChangeRecords = 123,
      EnabledCloudwatchLogsExports = list(
        "string"
      ),
      Capacity = 123,
      EngineMode = "string",
      ScalingConfigurationInfo = list(
        MinCapacity = 123,
        MaxCapacity = 123,
        AutoPause = TRUE|FALSE,
        SecondsUntilAutoPause = 123,
        TimeoutAction = "string",
        SecondsBeforeTimeout = 123
      ),
      RdsCustomClusterConfiguration = list(
        InterconnectSubnetId = "string",
        TransitGatewayMulticastDomainId = "string",
        ReplicaMode = "open-read-only"|"mounted"
      ),
      DeletionProtection = TRUE|FALSE,
      HttpEndpointEnabled = TRUE|FALSE,
      ActivityStreamMode = "sync"|"async",
      ActivityStreamStatus = "stopped"|"starting"|"started"|"stopping",
      ActivityStreamKmsKeyId = "string",
      ActivityStreamKinesisStreamName = "string",
      CopyTagsToSnapshot = TRUE|FALSE,
      CrossAccountClone = TRUE|FALSE,
      DomainMemberships = list(
        list(
          Domain = "string",
          Status = "string",
          FQDN = "string",
          IAMRoleName = "string",
          OU = "string",
          AuthSecretArn = "string",
          DnsIps = list(
            "string"
          )
        )
      ),
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      GlobalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown",
      GlobalWriteForwardingRequested = TRUE|FALSE,
      PendingModifiedValues = list(
        PendingCloudwatchLogsExports = list(
          LogTypesToEnable = list(
            "string"
          ),
          LogTypesToDisable = list(
            "string"
          )
        ),
        DBClusterIdentifier = "string",
        MasterUserPassword = "string",
        IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
        EngineVersion = "string",
        BackupRetentionPeriod = 123,
        AllocatedStorage = 123,
        RdsCustomClusterConfiguration = list(
          InterconnectSubnetId = "string",
          TransitGatewayMulticastDomainId = "string",
          ReplicaMode = "open-read-only"|"mounted"
        ),
        Iops = 123,
        StorageType = "string",
        CertificateDetails = list(
          CAIdentifier = "string",
          ValidTill = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      DBClusterInstanceClass = "string",
      StorageType = "string",
      Iops = 123,
      PubliclyAccessible = TRUE|FALSE,
      AutoMinorVersionUpgrade = TRUE|FALSE,
      MonitoringInterval = 123,
      MonitoringRoleArn = "string",
      PerformanceInsightsEnabled = TRUE|FALSE,
      PerformanceInsightsKMSKeyId = "string",
      PerformanceInsightsRetentionPeriod = 123,
      ServerlessV2ScalingConfiguration = list(
        MinCapacity = 123.0,
        MaxCapacity = 123.0
      ),
      NetworkType = "string",
      DBSystemId = "string",
      MasterUserSecret = list(
        SecretArn = "string",
        SecretStatus = "string",
        KmsKeyId = "string"
      ),
      IOOptimizedNextAllowedModificationTime = as.POSIXct(
        "2015-01-01"
      ),
      LocalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"requested",
      AwsBackupRecoveryPointArn = "string",
      LimitlessDatabase = list(
        Status = "active"|"not-in-use"|"enabled"|"disabled"|"enabling"|"disabling"|"modifying-max-capacity"|"error",
        MinRequiredACU = 123.0
      ),
      StorageThroughput = 123,
      CertificateDetails = list(
        CAIdentifier = "string",
        ValidTill = as.POSIXct(
          "2015-01-01"
        )
      ),
      EngineLifecycleSupport = "string"
    )
  )
)

Request syntax

svc$describe_db_clusters(
  DBClusterIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string",
  IncludeShared = TRUE|FALSE
)