# 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](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [dbClusterId](#API_UpdateDbCluster_RequestSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-request-dbClusterId"></a>
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](#API_UpdateDbCluster_RequestSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-request-dbInstanceType"></a>
Update the DB cluster to use the specified DB instance Type.  
Type: String  
Valid Values: `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`   
Required: No

 ** [dbParameterGroupIdentifier](#API_UpdateDbCluster_RequestSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-request-dbParameterGroupIdentifier"></a>
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](#API_UpdateDbCluster_RequestSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-request-failoverMode"></a>
Update the DB cluster's failover behavior.  
Type: String  
Valid Values: `AUTOMATIC | NO_FAILOVER`   
Required: No

 ** [logDeliveryConfiguration](#API_UpdateDbCluster_RequestSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-request-logDeliveryConfiguration"></a>
The log delivery configuration to apply to the DB cluster.  
Type: [LogDeliveryConfiguration](API_LogDeliveryConfiguration.md) object  
Required: No

 ** [port](#API_UpdateDbCluster_RequestSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-request-port"></a>
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](#API_UpdateDbCluster_ResponseSyntax) **   <a name="tsinfluxdb-UpdateDbCluster-response-dbClusterStatus"></a>
The status of the DB cluster.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-influxdb-2023-01-27/UpdateDbCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/UpdateDbCluster)