import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetDbClusterInput, GetDbClusterOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetDbClusterCommand}. */ export interface GetDbClusterCommandInput extends GetDbClusterInput { } /** * @public * * The output of {@link GetDbClusterCommand}. */ export interface GetDbClusterCommandOutput extends GetDbClusterOutput, __MetadataBearer { } declare const GetDbClusterCommand_base: { new (input: GetDbClusterCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetDbClusterCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Retrieves information about a Timestream for InfluxDB cluster.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { TimestreamInfluxDBClient, GetDbClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import * // const { TimestreamInfluxDBClient, GetDbClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import * // import type { TimestreamInfluxDBClientConfig } from "@aws-sdk/client-timestream-influxdb"; * const config = {}; // type is TimestreamInfluxDBClientConfig * const client = new TimestreamInfluxDBClient(config); * const input = { // GetDbClusterInput * dbClusterId: "STRING_VALUE", // required * }; * const command = new GetDbClusterCommand(input); * const response = await client.send(command); * // { // GetDbClusterOutput * // id: "STRING_VALUE", // required * // name: "STRING_VALUE", // required * // arn: "STRING_VALUE", // required * // status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED", * // endpoint: "STRING_VALUE", * // readerEndpoint: "STRING_VALUE", * // port: Number("int"), * // deploymentType: "MULTI_NODE_READ_REPLICAS", * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge" || "db.influx.24xlarge", * // networkType: "IPV4" || "DUAL", * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", * // allocatedStorage: Number("int"), * // engineType: "INFLUXDB_V2" || "INFLUXDB_V3_CORE" || "INFLUXDB_V3_ENTERPRISE", * // publiclyAccessible: true || false, * // dbParameterGroupIdentifier: "STRING_VALUE", * // effectiveDbParameterGroupIdentifier: "STRING_VALUE", * // logDeliveryConfiguration: { // LogDeliveryConfiguration * // s3Configuration: { // S3Configuration * // bucketName: "STRING_VALUE", // required * // enabled: true || false, // required * // }, * // }, * // maintenanceSchedule: { // MaintenanceSchedule * // timezone: "STRING_VALUE", // required * // preferredMaintenanceWindow: "STRING_VALUE", // required * // }, * // lastMaintenanceTime: new Date("TIMESTAMP"), * // nextMaintenanceTime: new Date("TIMESTAMP"), * // influxAuthParametersSecretArn: "STRING_VALUE", * // vpcSubnetIds: [ // VpcSubnetIdList * // "STRING_VALUE", * // ], * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList * // "STRING_VALUE", * // ], * // failoverMode: "AUTOMATIC" || "NO_FAILOVER", * // clusterConfiguration: { // ClusterConfiguration * // ingestQueryInstances: Number("int"), * // queryOnlyInstances: Number("int"), * // dedicatedCompactor: true || false, * // }, * // dbBackupConfigurations: [ // DbBackupConfigurationOutputList * // { // DbBackupConfigurationOutput * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required * // retentionDays: Number("int"), // required * // enabled: true || false, // required * // customSchedule: "STRING_VALUE", * // nextAutomatedBackupTime: new Date("TIMESTAMP"), * // }, * // ], * // kmsKeyId: "STRING_VALUE", * // }; * * ``` * * @param GetDbClusterCommandInput - {@link GetDbClusterCommandInput} * @returns {@link GetDbClusterCommandOutput} * @see {@link GetDbClusterCommandInput} for command's `input` shape. * @see {@link GetDbClusterCommandOutput} for command's `response` shape. * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link InternalServerException} (server fault) *

The request processing has failed because of an unknown error, exception or failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

The requested resource was not found or does not exist.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by Timestream for InfluxDB.

* * @throws {@link TimestreamInfluxDBServiceException} *

Base exception class for all service exceptions from TimestreamInfluxDB service.

* * * @public */ export declare class GetDbClusterCommand extends GetDbClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetDbClusterInput; output: GetDbClusterOutput; }; sdk: { input: GetDbClusterCommandInput; output: GetDbClusterCommandOutput; }; }; }