Skip to content

update_db_cluster async

update_db_cluster(
    db_cluster_id: DbClusterId,
    *,
    config_overrides: Optional[AsyncTimestreamInfluxDBClientConfig] = None,
    log_delivery_configuration: Optional[LogDeliveryConfiguration] = None,
    db_parameter_group_identifier: Optional[DbParameterGroupIdentifier] = None,
    port: Optional[Port] = None,
    db_instance_type: Optional[DbInstanceType] = None,
    failover_mode: Optional[FailoverMode] = None,
    maintenance_schedule: Optional[MaintenanceSchedule] = None,
    db_backup_configurations: Optional[DbBackupConfigurationInputList] = None,
) -> UpdateDbClusterOutput

Updates a Timestream for InfluxDB cluster.

Parameters:

  • db_cluster_id (DbClusterId) –

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

  • log_delivery_configuration (Optional[LogDeliveryConfiguration], default: None ) –

    The log delivery configuration to apply to the DB cluster.

  • db_parameter_group_identifier (Optional[DbParameterGroupIdentifier], default: None ) –

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

  • port (Optional[Port], default: None ) –

    Update the DB cluster to use the specified port.

  • db_instance_type (Optional[DbInstanceType], default: None ) –

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

  • failover_mode (Optional[FailoverMode], default: None ) –

    Update the DB cluster's failover behavior.

  • maintenance_schedule (Optional[MaintenanceSchedule], default: None ) –

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

  • db_backup_configurations (Optional[DbBackupConfigurationInputList], default: None ) –

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

Raises:

Source code in docs_src/capo_timestream_influxdb/_services/async_timestream_influx_db.py
async def update_db_cluster(
    self,
    db_cluster_id: "capo_timestream_influxdb.types.db_cluster_id.DbClusterId",
    *,
    config_overrides: Optional[AsyncTimestreamInfluxDBClientConfig] = None,
    log_delivery_configuration: Optional[
        "capo_timestream_influxdb.types.log_delivery_configuration.LogDeliveryConfiguration"
    ] = None,
    db_parameter_group_identifier: Optional[
        "capo_timestream_influxdb.types.db_parameter_group_identifier.DbParameterGroupIdentifier"
    ] = None,
    port: Optional["capo_timestream_influxdb.types.port.Port"] = None,
    db_instance_type: Optional[
        "capo_timestream_influxdb.types.db_instance_type.DbInstanceType"
    ] = None,
    failover_mode: Optional[
        "capo_timestream_influxdb.types.failover_mode.FailoverMode"
    ] = None,
    maintenance_schedule: Optional[
        "capo_timestream_influxdb.types.maintenance_schedule.MaintenanceSchedule"
    ] = None,
    db_backup_configurations: Optional[
        "capo_timestream_influxdb.types.db_backup_configuration_input_list.DbBackupConfigurationInputList"
    ] = None,
) -> (
    "capo_timestream_influxdb.types.update_db_cluster_output.UpdateDbClusterOutput"
):
    """<p>Updates a Timestream for InfluxDB cluster.</p>

    Args:
        db_cluster_id: <p>Service-generated unique identifier of the DB cluster to update.</p>
        log_delivery_configuration: <p>The log delivery configuration to apply to the DB cluster.</p>
        db_parameter_group_identifier: <p>Update the DB cluster to use the specified DB parameter group.</p>
        port: <p>Update the DB cluster to use the specified port.</p>
        db_instance_type: <p>Update the DB cluster to use the specified DB instance Type.</p>
        failover_mode: <p>Update the DB cluster's failover behavior.</p>
        maintenance_schedule: <p>Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.</p>
        db_backup_configurations: <p>A list of backup configurations to update for the DB cluster.</p>

    Raises:
        capo_timestream_influxdb.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_timestream_influxdb.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_timestream_influxdb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found or does not exist.</p>
        capo_timestream_influxdb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_timestream_influxdb.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_timestream_influxdb.types.update_db_cluster_input.UpdateDbClusterInput]",
    ) -> AsyncOperationResponse[
        "capo_timestream_influxdb.types.update_db_cluster_output.UpdateDbClusterOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.update_db_cluster

        (
            output,
            http_response,
        ) = await capo_timestream_influxdb._operations.amazon_timestream_influx_db.update_db_cluster.async_update_db_cluster(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDbCluster")
    )
    input_: capo_timestream_influxdb.types.update_db_cluster_input.UpdateDbClusterInput = {
        "db_cluster_id": db_cluster_id
    }
    if log_delivery_configuration is not None:
        input_["log_delivery_configuration"] = log_delivery_configuration
    if db_parameter_group_identifier is not None:
        input_["db_parameter_group_identifier"] = db_parameter_group_identifier
    if port is not None:
        input_["port"] = port
    if db_instance_type is not None:
        input_["db_instance_type"] = db_instance_type
    if failover_mode is not None:
        input_["failover_mode"] = failover_mode
    if maintenance_schedule is not None:
        input_["maintenance_schedule"] = maintenance_schedule
    if db_backup_configurations is not None:
        input_["db_backup_configurations"] = db_backup_configurations

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output