:doc:`TimestreamInfluxDB <../../timestream-influxdb>` / Client / update_db_cluster

*****************
update_db_cluster
*****************



.. py:method:: TimestreamInfluxDB.Client.update_db_cluster(**kwargs)

  

  Updates a Timestream for InfluxDB cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbCluster>`_  


  **Request Syntax**
  ::

    response = client.update_db_cluster(
        dbClusterId='string',
        logDeliveryConfiguration={
            's3Configuration': {
                'bucketName': 'string',
                'enabled': True|False
            }
        },
        dbParameterGroupIdentifier='string',
        port=123,
        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',
        failoverMode='AUTOMATIC'|'NO_FAILOVER'
    )
    
  :type dbClusterId: string
  :param dbClusterId: **[REQUIRED]** 

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

    

  
  :type logDeliveryConfiguration: dict
  :param logDeliveryConfiguration: 

    The log delivery configuration to apply to the DB cluster.

    

  
    - **s3Configuration** *(dict) --* **[REQUIRED]** 

      Configuration for S3 bucket log delivery.

      

    
      - **bucketName** *(string) --* **[REQUIRED]** 

        The name of the S3 bucket to deliver logs to.

        

      
      - **enabled** *(boolean) --* **[REQUIRED]** 

        Indicates whether log delivery to the S3 bucket is enabled.

        

      
    
  
  :type dbParameterGroupIdentifier: string
  :param dbParameterGroupIdentifier: 

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

    

  
  :type port: integer
  :param port: 

    Update the DB cluster to use the specified port.

    

  
  :type dbInstanceType: string
  :param dbInstanceType: 

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

    

  
  :type failoverMode: string
  :param failoverMode: 

    Update the DB cluster's failover behavior.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'|'MAINTENANCE'|'UPDATING_INSTANCE_TYPE'|'REBOOTING'|'REBOOT_FAILED'|'PARTIALLY_AVAILABLE'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **dbClusterStatus** *(string) --* 

        The status of the DB cluster.

        
  
  **Exceptions**
  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ValidationException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.InternalServerException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ConflictException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ThrottlingException`

  