Modifying a read replica cluster for Amazon Timestream for InfluxDB - Amazon Timestream
Modify a read replica clusterSettings for modifying read replica clusters
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon Timestream for LiveAnalytics will no longer be open to new customers starting June 20, 2025. If you would like to use Amazon Timestream for LiveAnalytics, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Timestream for LiveAnalytics availability change.

Modifying a read replica cluster for Amazon Timestream for InfluxDB

A read replica cluster has a writer DB instance and a reader DB instance in separate Availability Zones. Read replica clusters provide high availability, increased capacity for read workloads, and faster failover when compared to Multi-AZ deployments. For more information about read replica clusters, see Overview of Amazon Timestream for InfluxDB read replica clusters.

You can modify a read replica cluster to change its settings.

Important

You can't modify the DB instances within a read replica cluster. All modifications must be done at the DB cluster level.

You can modify a read replica cluster using the Amazon Web Services Management Console, the Amazon CLI, or the Amazon Timestream for InfluxDB API.

Modify a read replica cluster for Amazon Timestream for InfluxDB

Using the Amazon Web Services Management Console

To modify a read replica DB cluster using the console:

  1. Sign in to the Amazon Web Services Management Console and open the Amazon Timestream console.

  2. In the navigation pane, choose InfluxDB databases and then choose the read replica cluster you want to modify.

  3. Choose Modify. The Modify DB cluster page appears.

  4. Choose any of the settings that you want. For information about each setting, see Settings for modifying read replica clusters.

  5. After you have made your changes, choose Continue and check the summary of modifications.

  6. On the confirmation page, review your changes. If they're correct, choose Modify DB cluster to save your changes. Alternatively, choose Back to edit your changes or Cancel to cancel your changes.

Important

Currently Amazon Timestream for InfluxDB only supports Apply Immediately updates for the read replica cluster. If you confirm the changes, your DB cluster will incur downtime while the changes are being applied.

Using the Amazon CLI

To modify a DB instance using the Amazon Command Line Interface, use the update-db-cluster command with the following parameters. Replace each user input placeholder with your own information.

aws timestream-influxdb update-db-cluster \
      --region region \
      --db-cluster-id db-cluster-id \                      
      --db-instance-type db.influx.4xlarge \
      --port 10000 \
      --failover mode NO_FAILOVER

Settings for modifying read replica clusters

For details about settings that you can use to modify a read replica cluster, see the following table. For more information about the Amazon CLI options, see update-db-cluster.

Console setting Setting description CLI option and Timestream for InfluxDB API parameter
Database port

The port number on which InfluxDB accepts connections.

Valid Values: 1024-65535

Default: 8086

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

CLI option: --port

API parameter: port
DB instance type The compute and memory capacity of each DB instance in your Timestream for InfluxDB DB cluster, for example db.influx.xlarge. If possible, choose a DB instance class large enough that a typical query working set can be held in memory. When working sets are held in memory, the system can avoid writing to disk, which improves performance.

CLI option: --db-instance-type

API parameter: dbInstanceType
DB cluster parameter group The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

CLI option: --db-parameter-group-identifier

API parameter: dbParameterGroupIdentifier
Log exports

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

Configuration for S3 bucket log delivery: s3Configuration -> (structure)

The name of the S3 bucket to deliver logs to: bucketName -> (string)

Indicate whether log delivery to the S3 bucket is enabled: enabled -> (boolean)

Shorthand syntax: s3Configuration={bucketName=string, enabled=boolean}

CLI option: --log-delivery-configuration

API parameter: logDeliveryConfiguration
Failover mode Configure how your cluster responds to a primary instance failure using the following options:

AUTOMATIC: If the primary instance fails, the system automatically promotes a read replica to become the new primary instance.

NO_FAILOVER: If the primary instance fails, the system attempts to restore the primary instance without promoting a read replica. The cluster remains unavailable until the primary instance is restored.

CLI option: --failover-mode

API parameter: failoverMode