TimestreamInfluxDB / Client / update_db_cluster

update_db_cluster#

TimestreamInfluxDB.Client.update_db_cluster(**kwargs)#

Updates a Timestream for InfluxDB cluster.

See also: AWS API Documentation

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',
    failoverMode='AUTOMATIC'|'NO_FAILOVER'
)
Parameters:

  • dbClusterId (string) –

    [REQUIRED]

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

  • logDeliveryConfiguration (dict) –

    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.

  • dbParameterGroupIdentifier (string) – Update the DB cluster to use the specified DB parameter group.

  • port (integer) – Update the DB cluster to use the specified port.

  • dbInstanceType (string) – Update the DB cluster to use the specified DB instance Type.

  • failoverMode (string) – Update the DB cluster’s failover behavior.

Return type:

dict

Returns:

Response Syntax

{
    'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'
}

Response Structure

  • (dict) –

    • dbClusterStatus (string) –

      The status of the DB cluster.

Exceptions