describeDbClusters
abstract suspend fun describeDbClusters(input: DescribeDbClustersRequest = DescribeDbClustersRequest { }): DescribeDbClustersResponse
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.
Samples
fun main() {
//sampleStart
// The following example retrieves the details of the specified DB cluster.
val resp = rdsClient.describeDbClusters {
dbClusterIdentifier = "mydbcluster"
}
//sampleEnd
}
fun main() {
//sampleStart
// The following example retrieves the details of the specified Aurora PostgreSQL DB cluster configured
// without VPC networking and with internet access gateway enabled. IAM database authentication is required
// when VPC networking is disabled and internet access gateway is enabled.
val resp = rdsClient.describeDbClusters {
dbClusterIdentifier = "my-vpcless-cluster"
}
//sampleEnd
}