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'|'db.influx.24xlarge',
    failoverMode='AUTOMATIC'|'NO_FAILOVER',
    maintenanceSchedule={
        'timezone': 'string',
        'preferredMaintenanceWindow': 'string'
    },
    dbBackupConfigurations=[
        {
            'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
            'retentionDays': 123,
            'enabled': True|False,
            'customSchedule': 'string'
        },
    ]
)
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.

  • maintenanceSchedule (dict) –

    Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.

    • timezone (string) – [REQUIRED]

      The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.

    • preferredMaintenanceWindow (string) – [REQUIRED]

      The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.

  • dbBackupConfigurations (list) –

    A list of backup configurations to update for the DB cluster.

    • (dict) –

      Specifies the configuration for an automated backup schedule.

      • type (string) – [REQUIRED]

        The type of automated backup schedule. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, and CONTINUOUS.

      • retentionDays (integer) – [REQUIRED]

        The number of days to retain automated backups. Valid values are 1 to 365.

      • enabled (boolean) – [REQUIRED]

        Specifies whether this backup configuration is enabled.

      • customSchedule (string) –

        A custom cron schedule expression for the backup. Required when type is CUSTOM_SCHEDULE.

Return type:

dict

Returns:

Response Syntax

{
    'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'|'MAINTENANCE'|'UPDATING_INSTANCE_TYPE'|'REBOOTING'|'REBOOT_FAILED'|'PARTIALLY_AVAILABLE'|'RESTORING'|'RESTORE_FAILED'
}

Response Structure

  • (dict) –

    • dbClusterStatus (string) –

      The status of the DB cluster.

Exceptions