AWS CLI Command Reference

[ aws . timestream-influxdb ]

restore-from-db-backup

Description

Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.

See also: AWS API Documentation

Synopsis

  restore-from-db-backup
--name <value>
--db-backup-id <value>
[--restore-to-time <value>]
[--restore-mode <value>]
[--vpc-subnet-ids <value>]
[--vpc-security-group-ids <value>]
[--publicly-accessible | --no-publicly-accessible]
[--log-delivery-configuration <value>]
[--maintenance-schedule <value>]
[--tags <value>]
[--port <value>]
[--network-type <value>]
[--deployment-type <value>]
[--db-backup-configurations <value>]
[--kms-key-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--name (string) [required]

The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.

Constraints:

  • min: 3
  • max: 40
  • pattern: [a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*

--db-backup-id (string) [required]

The identifier of the backup to restore from.

Constraints:

  • min: 3
  • max: 64
  • pattern: [a-zA-Z0-9]+

--restore-to-time (timestamp)

The point in time to restore to, for continuous backups. Must be within the backup’s retention window.

--restore-mode (string)

Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.

Possible values:

  • NEW_RESOURCE
  • REPLACE_EXISTING

--vpc-subnet-ids (list)

A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup.

Constraints:

  • min: 1
  • max: 6

(string)

Constraints:

  • min: 0
  • max: 64
  • pattern: subnet-[a-z0-9]+

Syntax:

"string" "string" ...

--vpc-security-group-ids (list)

A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup.

Constraints:

  • min: 1
  • max: 5

(string)

Constraints:

  • min: 0
  • max: 64
  • pattern: sg-[a-z0-9]+

Syntax:

"string" "string" ...

--publicly-accessible | --no-publicly-accessible (boolean)

Specifies whether the restored resource is publicly accessible.

--log-delivery-configuration (structure)

Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource.

s3Configuration -> (structure) [required]

Configuration for S3 bucket log delivery.

bucketName -> (string) [required]

The name of the S3 bucket to deliver logs to.

Constraints:

  • min: 3
  • max: 63
  • pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

enabled -> (boolean) [required]

Indicates whether log delivery to the S3 bucket is enabled.

Shorthand Syntax:

s3Configuration={bucketName=string,enabled=boolean}

JSON Syntax:

{
  "s3Configuration": {
    "bucketName": "string",
    "enabled": true|false
  }
}

--maintenance-schedule (structure)

The maintenance schedule for the restored resource.

timezone -> (string) [required]

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

Constraints:

  • min: 1
  • max: 64
  • pattern: (UTC|[A-Za-z_]+/[A-Za-z0-9_]+(/[A-Za-z0-9_]+)?)

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.

Constraints:

  • min: 0
  • max: 19
  • pattern: $|^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d

Shorthand Syntax:

timezone=string,preferredMaintenanceWindow=string

JSON Syntax:

{
  "timezone": "string",
  "preferredMaintenanceWindow": "string"
}

--tags (map)

A list of key-value pairs to associate with the restored resource.

Constraints:

  • min: 1
  • max: 200

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--port (integer)

The port number on which the restored InfluxDB resource accepts connections.

Constraints:

  • min: 1024
  • max: 65535

--network-type (string)

Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.

Possible values:

  • IPV4
  • DUAL

--deployment-type (string)

Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.

Possible values:

  • SINGLE_AZ
  • WITH_MULTIAZ_STANDBY
  • MULTI_NODE_READ_REPLICAS

--db-backup-configurations (list)

A list of backup configurations to apply to the restored resource.

Constraints:

  • min: 1
  • max: 4

(structure)

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.

Possible values:

  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • CUSTOM_SCHEDULE
  • CONTINUOUS

retentionDays -> (integer) [required]

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

Constraints:

  • min: 1
  • max: 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.

Constraints:

  • min: 9
  • max: 256
  • pattern: cron\(\S+ \S+ \S+ \S+ \S+ \S+\)

Shorthand Syntax:

type=string,retentionDays=integer,enabled=boolean,customSchedule=string ...

JSON Syntax:

[
  {
    "type": "HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"CUSTOM_SCHEDULE"|"CONTINUOUS",
    "retentionDays": integer,
    "enabled": true|false,
    "customSchedule": "string"
  }
  ...
]

--kms-key-id (string)

The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN.

Constraints:

  • min: 1
  • max: 2048
  • pattern: [a-zA-Z0-9:/_\-]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

restoredDbResourceId -> (string)

The identifier of the restored DB resource.

Constraints:

  • min: 3
  • max: 64
  • pattern: [a-zA-Z0-9]+

restoreStatus -> (string)

The status of the restore operation.

Possible values:

  • RESTORING

resourceType -> (string)

The type of the restored resource. Valid values are DB_INSTANCE and DB_CLUSTER.

Possible values:

  • DB_INSTANCE
  • DB_CLUSTER

engineType -> (string)

The engine type of the restored resource.

Possible values:

  • INFLUXDB_V2
  • INFLUXDB_V3_CORE
  • INFLUXDB_V3_ENTERPRISE

deploymentType -> (string)

The deployment type of the restored resource.

Possible values:

  • SINGLE_AZ
  • WITH_MULTIAZ_STANDBY
  • MULTI_NODE_READ_REPLICAS
© Copyright 2026, Amazon Web Services. Created using Sphinx.