import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DBClusterMessage, DescribeDBClustersMessage } from "../models/models_0"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDBClustersCommand}. */ export interface DescribeDBClustersCommandInput extends DescribeDBClustersMessage { } /** * @public * * The output of {@link DescribeDBClustersCommand}. */ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __MetadataBearer { } declare const DescribeDBClustersCommand_base: { new (input: DescribeDBClustersCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeDBClustersCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, DescribeDBClustersCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, DescribeDBClustersCommand } = require("@aws-sdk/client-rds"); // CommonJS import * // import type { RDSClientConfig } from "@aws-sdk/client-rds"; * const config = {}; // type is RDSClientConfig * const client = new RDSClient(config); * const input = { // DescribeDBClustersMessage * DBClusterIdentifier: "STRING_VALUE", * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * IncludeShared: true || false, * }; * const command = new DescribeDBClustersCommand(input); * const response = await client.send(command); * // { // DBClusterMessage * // Marker: "STRING_VALUE", * // DBClusters: [ // DBClusterList * // { // DBCluster * // AllocatedStorage: Number("int"), * // AvailabilityZones: [ // AvailabilityZones * // "STRING_VALUE", * // ], * // BackupRetentionPeriod: Number("int"), * // CharacterSetName: "STRING_VALUE", * // DatabaseName: "STRING_VALUE", * // DBClusterIdentifier: "STRING_VALUE", * // DBClusterParameterGroup: "STRING_VALUE", * // DBSubnetGroup: "STRING_VALUE", * // Status: "STRING_VALUE", * // PercentProgress: "STRING_VALUE", * // EarliestRestorableTime: new Date("TIMESTAMP"), * // Endpoint: "STRING_VALUE", * // ReaderEndpoint: "STRING_VALUE", * // CustomEndpoints: [ // StringList * // "STRING_VALUE", * // ], * // MultiAZ: true || false, * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LatestRestorableTime: new Date("TIMESTAMP"), * // Port: Number("int"), * // MasterUsername: "STRING_VALUE", * // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships * // { // DBClusterOptionGroupStatus * // DBClusterOptionGroupName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // PreferredBackupWindow: "STRING_VALUE", * // PreferredMaintenanceWindow: "STRING_VALUE", * // UpgradeRolloutOrder: "first" || "second" || "last", * // ReplicationSourceIdentifier: "STRING_VALUE", * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList * // "STRING_VALUE", * // ], * // StatusInfos: [ // DBClusterStatusInfoList * // { // DBClusterStatusInfo * // StatusType: "STRING_VALUE", * // Normal: true || false, * // Status: "STRING_VALUE", * // Message: "STRING_VALUE", * // }, * // ], * // DBClusterMembers: [ // DBClusterMemberList * // { // DBClusterMember * // DBInstanceIdentifier: "STRING_VALUE", * // IsClusterWriter: true || false, * // DBClusterParameterGroupStatus: "STRING_VALUE", * // PromotionTier: Number("int"), * // }, * // ], * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // HostedZoneId: "STRING_VALUE", * // StorageEncrypted: true || false, * // StorageEncryptionType: "none" || "sse-kms" || "sse-rds", * // KmsKeyId: "STRING_VALUE", * // DbClusterResourceId: "STRING_VALUE", * // DBClusterArn: "STRING_VALUE", * // AssociatedRoles: [ // DBClusterRoles * // { // DBClusterRole * // RoleArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // FeatureName: "STRING_VALUE", * // }, * // ], * // IAMDatabaseAuthenticationEnabled: true || false, * // CloneGroupId: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // EarliestBacktrackTime: new Date("TIMESTAMP"), * // BacktrackWindow: Number("long"), * // BacktrackConsumedChangeRecords: Number("long"), * // EnabledCloudwatchLogsExports: [ // LogTypeList * // "STRING_VALUE", * // ], * // Capacity: Number("int"), * // PendingModifiedValues: { // ClusterPendingModifiedValues * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports * // LogTypesToEnable: [ * // "STRING_VALUE", * // ], * // LogTypesToDisable: [ * // "STRING_VALUE", * // ], * // }, * // DBClusterIdentifier: "STRING_VALUE", * // MasterUserPassword: "STRING_VALUE", * // IAMDatabaseAuthenticationEnabled: true || false, * // EngineVersion: "STRING_VALUE", * // BackupRetentionPeriod: Number("int"), * // StorageType: "STRING_VALUE", * // AllocatedStorage: Number("int"), * // RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration * // InterconnectSubnetId: "STRING_VALUE", * // TransitGatewayMulticastDomainId: "STRING_VALUE", * // ReplicaMode: "open-read-only" || "mounted", * // }, * // Iops: Number("int"), * // CertificateDetails: { // CertificateDetails * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // }, * // EngineMode: "STRING_VALUE", * // ScalingConfigurationInfo: { // ScalingConfigurationInfo * // MinCapacity: Number("int"), * // MaxCapacity: Number("int"), * // AutoPause: true || false, * // SecondsUntilAutoPause: Number("int"), * // TimeoutAction: "STRING_VALUE", * // SecondsBeforeTimeout: Number("int"), * // }, * // RdsCustomClusterConfiguration: { * // InterconnectSubnetId: "STRING_VALUE", * // TransitGatewayMulticastDomainId: "STRING_VALUE", * // ReplicaMode: "open-read-only" || "mounted", * // }, * // DBClusterInstanceClass: "STRING_VALUE", * // StorageType: "STRING_VALUE", * // Iops: Number("int"), * // StorageThroughput: Number("int"), * // IOOptimizedNextAllowedModificationTime: new Date("TIMESTAMP"), * // PubliclyAccessible: true || false, * // AutoMinorVersionUpgrade: true || false, * // DeletionProtection: true || false, * // HttpEndpointEnabled: true || false, * // ActivityStreamMode: "sync" || "async", * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping", * // ActivityStreamKmsKeyId: "STRING_VALUE", * // ActivityStreamKinesisStreamName: "STRING_VALUE", * // CopyTagsToSnapshot: true || false, * // CrossAccountClone: true || false, * // DomainMemberships: [ // DomainMembershipList * // { // DomainMembership * // Domain: "STRING_VALUE", * // Status: "STRING_VALUE", * // FQDN: "STRING_VALUE", * // IAMRoleName: "STRING_VALUE", * // OU: "STRING_VALUE", * // AuthSecretArn: "STRING_VALUE", * // DnsIps: [ * // "STRING_VALUE", * // ], * // }, * // ], * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // GlobalClusterIdentifier: "STRING_VALUE", * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", * // GlobalWriteForwardingRequested: true || false, * // NetworkType: "STRING_VALUE", * // AutomaticRestartTime: new Date("TIMESTAMP"), * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo * // MinCapacity: Number("double"), * // MaxCapacity: Number("double"), * // SecondsUntilAutoPause: Number("int"), * // }, * // ServerlessV2PlatformVersion: "STRING_VALUE", * // MonitoringInterval: Number("int"), * // MonitoringRoleArn: "STRING_VALUE", * // DatabaseInsightsMode: "standard" || "advanced", * // PerformanceInsightsEnabled: true || false, * // PerformanceInsightsKMSKeyId: "STRING_VALUE", * // PerformanceInsightsRetentionPeriod: Number("int"), * // DBSystemId: "STRING_VALUE", * // MasterUserSecret: { // MasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // LocalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "requested", * // AwsBackupRecoveryPointArn: "STRING_VALUE", * // LimitlessDatabase: { // LimitlessDatabase * // Status: "active" || "not-in-use" || "enabled" || "disabled" || "enabling" || "disabling" || "modifying-max-capacity" || "error", * // MinRequiredACU: Number("double"), * // }, * // ClusterScalabilityType: "standard" || "limitless", * // CertificateDetails: { * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // EngineLifecycleSupport: "STRING_VALUE", * // VPCNetworkingEnabled: true || false, * // InternetAccessGatewayEnabled: true || false, * // }, * // ], * // }; * * ``` * * @param DescribeDBClustersCommandInput - {@link DescribeDBClustersCommandInput} * @returns {@link DescribeDBClustersCommandOutput} * @see {@link DescribeDBClustersCommandInput} for command's `input` shape. * @see {@link DescribeDBClustersCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link DBClusterNotFoundFault} (client fault) *

DBClusterIdentifier doesn't refer to an existing DB cluster.

* * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To describe a DB cluster * ```javascript * // The following example retrieves the details of the specified DB cluster. * const input = { * DBClusterIdentifier: "mydbcluster" * }; * const command = new DescribeDBClustersCommand(input); * const response = await client.send(command); * /* response is * { * DBClusters: [ * { * AllocatedStorage: 1, * AssociatedRoles: [], * AvailabilityZones: [ * "us-east-1a", * "us-east-1b", * "us-east-1e" * ], * BackupRetentionPeriod: 1, * ClusterCreateTime: "2019-04-15T14:18:42.785Z", * DBClusterArn: "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", * DBClusterIdentifier: "mydbcluster", * DBClusterMembers: [ * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "dbinstance3", * IsClusterWriter: false, * PromotionTier: 1 * }, * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "dbinstance1", * IsClusterWriter: false, * PromotionTier: 1 * }, * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "dbinstance2", * IsClusterWriter: false, * PromotionTier: 1 * }, * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "mydbcluster", * IsClusterWriter: false, * PromotionTier: 1 * }, * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "mydbcluster-us-east-1b", * IsClusterWriter: false, * PromotionTier: 1 * }, * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "mydbcluster", * IsClusterWriter: true, * PromotionTier: 1 * } * ], * DBClusterParameterGroup: "default.aurora-mysql5.7", * DBSubnetGroup: "default", * DatabaseName: "mydbcluster", * DbClusterResourceId: "cluster-AKIAIOSFODNN7EXAMPLE", * DeletionProtection: false, * EarliestRestorableTime: "2019-06-19T09:16:28.210Z", * Endpoint: "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", * Engine: "aurora-mysql", * EngineMode: "provisioned", * EngineVersion: "5.7.mysql_aurora.2.04.2", * HostedZoneId: "Z2R2ITUGPM61AM", * HttpEndpointEnabled: false, * IAMDatabaseAuthenticationEnabled: false, * KmsKeyId: "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", * LatestRestorableTime: "2019-06-20T22:38:14.908Z", * MasterUsername: "myadmin", * MultiAZ: true, * Port: 3306, * PreferredBackupWindow: "09:09-09:39", * PreferredMaintenanceWindow: "sat:04:09-sat:04:39", * ReadReplicaIdentifiers: [], * ReaderEndpoint: "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", * Status: "available", * StorageEncrypted: true, * VpcSecurityGroups: [ * { * Status: "active", * VpcSecurityGroupId: "sg-0b9130572daf3dc16" * } * ] * } * ] * } * *\/ * ``` * * @example To describe an Aurora DB cluster without VPC networking * ```javascript * // 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. * const input = { * DBClusterIdentifier: "my-vpcless-cluster" * }; * const command = new DescribeDBClustersCommand(input); * const response = await client.send(command); * /* response is * { * DBClusters: [ * { * ActivityStreamStatus: "stopped", * AllocatedStorage: 1, * AssociatedRoles: [], * AutoMinorVersionUpgrade: true, * AvailabilityZones: [ * "us-east-1d", * "us-east-1a", * "us-east-1c" * ], * BackupRetentionPeriod: 1, * ClusterCreateTime: "2026-03-09T20:53:24.054Z", * CopyTagsToSnapshot: false, * CrossAccountClone: false, * DBClusterArn: "arn:aws:rds:us-east-1:123456789012:cluster:my-vpcless-cluster", * DBClusterIdentifier: "my-vpcless-cluster", * DBClusterMembers: [], * DBClusterParameterGroup: "default.aurora-postgresql17", * DatabaseInsightsMode: "standard", * DbClusterResourceId: "cluster-AHX35HFI2YV26F3XVXVVO3MEHU", * DeletionProtection: false, * DomainMemberships: [], * EarliestRestorableTime: "2026-03-09T20:53:39.652Z", * Engine: "aurora-postgresql", * EngineLifecycleSupport: "open-source-rds-extended-support", * EngineMode: "provisioned", * EngineVersion: "17.4", * HttpEndpointEnabled: false, * IAMDatabaseAuthenticationEnabled: true, * InternetAccessGatewayEnabled: true, * LatestRestorableTime: "2026-03-09T20:53:39.652Z", * LocalWriteForwardingStatus: "disabled", * MasterUsername: "postgres", * MultiAZ: false, * Port: 5432, * PreferredBackupWindow: "07:13-07:43", * PreferredMaintenanceWindow: "mon:07:55-mon:08:25", * ReadReplicaIdentifiers: [], * ServerlessV2PlatformVersion: "3", * ServerlessV2ScalingConfiguration: { * MaxCapacity: 128.0, * MinCapacity: 1.0 * }, * Status: "available", * StorageEncrypted: false, * StorageEncryptionType: "sse-rds", * TagList: [], * UpgradeRolloutOrder: "second", * VPCNetworkingEnabled: false, * VpcSecurityGroups: [] * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeDBClustersCommand extends DescribeDBClustersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDBClustersMessage; output: DBClusterMessage; }; sdk: { input: DescribeDBClustersCommandInput; output: DescribeDBClustersCommandOutput; }; }; }