Skip to content

update_db_instance

update_db_instance(
    identifier: DbInstanceIdentifier,
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
    log_delivery_configuration: Optional[LogDeliveryConfiguration] = None,
    db_parameter_group_identifier: Optional[DbParameterGroupIdentifier] = None,
    port: Optional[Port] = None,
    db_instance_type: Optional[DbInstanceType] = None,
    deployment_type: Optional[DeploymentType] = None,
    db_storage_type: Optional[DbStorageType] = None,
    allocated_storage: Optional[AllocatedStorage] = None,
    maintenance_schedule: Optional[MaintenanceSchedule] = None,
    db_backup_configurations: Optional[DbBackupConfigurationInputList] = None,
) -> UpdateDbInstanceOutput

Updates a Timestream for InfluxDB DB instance.

Parameters:

  • identifier (DbInstanceIdentifier) –

    The id of the DB instance.

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

    Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

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

    The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

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

    The port number on which InfluxDB accepts connections.

    If you change the Port value, your database restarts immediately.

    Valid Values: 1024-65535

    Default: 8086

    Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680

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

    The Timestream for InfluxDB DB instance type to run InfluxDB on.

  • deployment_type (Optional[DeploymentType], default: None ) –

    Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

  • db_storage_type (Optional[DbStorageType], default: None ) –

    The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

  • allocated_storage (Optional[AllocatedStorage], default: None ) –

    The amount of storage to allocate for your DB storage type (in gibibytes).

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

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

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

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

Raises:

Source code in docs_src/capo_timestream_influxdb/_services/timestream_influx_db.py
def update_db_instance(
    self,
    identifier: "capo_timestream_influxdb.types.db_instance_identifier.DbInstanceIdentifier",
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = 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,
    deployment_type: Optional[
        "capo_timestream_influxdb.types.deployment_type.DeploymentType"
    ] = None,
    db_storage_type: Optional[
        "capo_timestream_influxdb.types.db_storage_type.DbStorageType"
    ] = None,
    allocated_storage: Optional[
        "capo_timestream_influxdb.types.allocated_storage.AllocatedStorage"
    ] = 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_instance_output.UpdateDbInstanceOutput":
    """<p>Updates a Timestream for InfluxDB DB instance.</p>

    Args:
        identifier: <p>The id of the DB instance.</p>
        log_delivery_configuration: <p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>
        db_parameter_group_identifier: <p>The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.</p>
        port: <p>The port number on which InfluxDB accepts connections.</p> <p>If you change the Port value, your database restarts immediately.</p> <p>Valid Values: 1024-65535</p> <p>Default: 8086</p> <p>Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680</p>
        db_instance_type: <p>The Timestream for InfluxDB DB instance type to run InfluxDB on.</p>
        deployment_type: <p>Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.</p>
        db_storage_type: <p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>
        allocated_storage: <p>The amount of storage to allocate for your DB storage type (in gibibytes).</p>
        maintenance_schedule: <p>Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone.</p>
        db_backup_configurations: <p>A list of backup configurations to update for the DB instance.</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.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_influxdb.types.update_db_instance_input.UpdateDbInstanceInput]",
    ) -> OperationResponse[
        "capo_timestream_influxdb.types.update_db_instance_output.UpdateDbInstanceOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.update_db_instance

        output, http_response = (
            capo_timestream_influxdb._operations.amazon_timestream_influx_db.update_db_instance.update_db_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDbInstance")
    )
    input_: capo_timestream_influxdb.types.update_db_instance_input.UpdateDbInstanceInput = {
        "identifier": identifier
    }
    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 deployment_type is not None:
        input_["deployment_type"] = deployment_type
    if db_storage_type is not None:
        input_["db_storage_type"] = db_storage_type
    if allocated_storage is not None:
        input_["allocated_storage"] = allocated_storage
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output