AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeDBClusters operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.DescribeDBClustersRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeDBClustersRequest : AmazonRDSRequest
         IAmazonWebServiceRequest

The DescribeDBClustersRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeDBClustersRequest()

Properties

NameTypeDescription
Public Property DBClusterIdentifier System.String

Gets and sets the property 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.

Public Property Filters System.Collections.Generic.List<Amazon.RDS.Model.Filter>

Gets and sets the property 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.

Public Property IncludeShared System.Boolean

Gets and sets the property IncludeShared.

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

Public Property Marker System.String

Gets and sets the property Marker.

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

Public Property MaxRecords System.Int32

Gets and sets the property 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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5