Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateDbCluster

Updates a Timestream for InfluxDB cluster.

Request Syntax


{
   "dbClusterId": "string",
   "dbInstanceType": "string",
   "dbParameterGroupIdentifier": "string",
   "failoverMode": "string",
   "logDeliveryConfiguration": { 
      "s3Configuration": { 
         "bucketName": "string",
         "enabled": boolean
      }
   },
   "port": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

dbClusterId

Service-generated unique identifier of the DB cluster to update.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-zA-Z0-9]+

Required: Yes

dbInstanceType

Update the DB cluster to use the specified DB instance Type.

Type: String

Required: No

dbParameterGroupIdentifier

Update the DB cluster to use the specified DB parameter group.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-zA-Z0-9]+

Required: No

failoverMode

Update the DB cluster's failover behavior.

Type: String

Valid Values: AUTOMATIC | NO_FAILOVER

Required: No

logDeliveryConfiguration

The log delivery configuration to apply to the DB cluster.

Type: LogDeliveryConfiguration object

Required: No

port

Update the DB cluster to use the specified port.

Type: Integer

Valid Range: Minimum value of 1024. Maximum value of 65535.

Required: No

Response Syntax


{
   "dbClusterStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

dbClusterStatus

The status of the DB cluster.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The request conflicts with an existing resource in Timestream for InfluxDB.

resourceId: The identifier for the Timestream for InfluxDB resource associated with the request.
resourceType: The type of Timestream for InfluxDB resource associated with the request.

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found or does not exist.

resourceId: The identifier for the Timestream for InfluxDB resource associated with the request.
resourceType: The type of Timestream for InfluxDB resource associated with the request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds the caller should wait before retrying.

HTTP Status Code: 400

ValidationException

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

reason: The reason that validation failed.

HTTP Status Code: 400