- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateDbClusterCommand
Updates a Timestream for InfluxDB cluster.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { TimestreamInfluxDBClient, UpdateDbClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
// const { TimestreamInfluxDBClient, UpdateDbClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
const client = new TimestreamInfluxDBClient(config);
const input = { // UpdateDbClusterInput
dbClusterId: "STRING_VALUE", // required
logDeliveryConfiguration: { // LogDeliveryConfiguration
s3Configuration: { // S3Configuration
bucketName: "STRING_VALUE", // required
enabled: true || false, // required
},
},
dbParameterGroupIdentifier: "STRING_VALUE",
port: Number("int"),
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",
failoverMode: "AUTOMATIC" || "NO_FAILOVER",
};
const command = new UpdateDbClusterCommand(input);
const response = await client.send(command);
// { // UpdateDbClusterOutput
// dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED",
// };
UpdateDbClusterCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
dbClusterId Required | string | undefined | Service-generated unique identifier of the DB cluster to update. |
dbInstanceType | DbInstanceType | undefined | Update the DB cluster to use the specified DB instance Type. |
dbParameterGroupIdentifier | string | undefined | Update the DB cluster to use the specified DB parameter group. |
failoverMode | FailoverMode | undefined | Update the DB cluster's failover behavior. |
logDeliveryConfiguration | LogDeliveryConfiguration | undefined | The log delivery configuration to apply to the DB cluster. |
port | number | undefined | Update the DB cluster to use the specified port. |
UpdateDbClusterCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
dbClusterStatus | ClusterStatus | undefined | The status of the DB cluster. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | The request conflicts with an existing resource in Timestream for InfluxDB. |
InternalServerException | server | The request processing has failed because of an unknown error, exception or failure. |
ResourceNotFoundException | client | The requested resource was not found or does not exist. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by Timestream for InfluxDB. |
TimestreamInfluxDBServiceException | Base exception class for all service exceptions from TimestreamInfluxDB service. |