AWS CLI Command Reference

[ aws . timestream-influxdb ]

delete-db-backup

Description

Deletes a Timestream for InfluxDB backup.

See also: AWS API Documentation

Synopsis

  delete-db-backup
--identifier <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

--identifier (string) [required]

The identifier of the backup to delete.

Constraints:

  • min: 3
  • max: 64
  • 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

id -> (string)

Service-generated unique identifier of the deleted backup.

Constraints:

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

name -> (string)

The customer-provided name of the deleted backup.

Constraints:

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

arn -> (string)

The Amazon Resource Name (ARN) of the deleted backup.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group|db\-backup)/[a-zA-Z0-9]{3,64}

status -> (string)

The current status of the backup.

Possible values:

  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • DELETING
  • DELETED

createdAt -> (timestamp)

The time when the backup was created.

expiresAfter -> (string)

The date after which the backup was set to be automatically deleted.

Constraints:

  • pattern: \d{4}-\d{2}-\d{2}

dbResourceId -> (string)

The identifier of the DB resource that the backup was created from.

Constraints:

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

type -> (string)

The type of backup.

Possible values:

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

engineType -> (string)

The engine type of the resource that the backup was created from.

Possible values:

  • INFLUXDB_V2
  • INFLUXDB_V3_CORE
  • INFLUXDB_V3_ENTERPRISE

deploymentType -> (string)

The deployment type of the resource that the backup was created from.

Possible values:

  • SINGLE_AZ
  • WITH_MULTIAZ_STANDBY
  • MULTI_NODE_READ_REPLICAS

kmsKeyId -> (string)

The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.

Constraints:

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

clusterConfiguration -> (structure)

The cluster configuration of the resource at the time of backup.

ingestQueryInstances -> (integer)

The number of instances in the DbCluster which can both ingest and query.

queryOnlyInstances -> (integer)

The number of instances in the DbCluster which can only query.

dedicatedCompactor -> (boolean)

Indicates if the compactor instance is a standalone instance or not.

dbParameterGroupId -> (string)

The identifier of the DB parameter group associated with the backup.

Constraints:

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

dbInstanceType -> (string)

The DB instance type of the resource at the time of backup.

Possible values:

  • 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

logDeliveryConfiguration -> (structure)

The log delivery configuration of the resource at the time of backup.

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.

failoverMode -> (string)

The failover mode of the resource at the time of backup.

Possible values:

  • AUTOMATIC
  • NO_FAILOVER

dbStorageType -> (string)

The storage type of the resource at the time of backup.

Possible values:

  • InfluxIOIncludedT1
  • InfluxIOIncludedT2
  • InfluxIOIncludedT3

allocatedStorage -> (integer)

The allocated storage of the resource at the time of backup, in GiB.

Constraints:

  • min: 20
  • max: 15360

vpcSubnetIds -> (list)

The VPC subnet IDs associated with the resource at the time of backup.

Constraints:

  • min: 1
  • max: 6

(string)

Constraints:

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

vpcSecurityGroupIds -> (list)

The VPC security group IDs associated with the resource at the time of backup.

Constraints:

  • min: 1
  • max: 5

(string)

Constraints:

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

publiclyAccessible -> (boolean)

Indicates whether the resource was publicly accessible at the time of backup.

port -> (integer)

The port number of the resource at the time of backup.

networkType -> (string)

The network type of the resource at the time of backup.

Possible values:

  • IPV4
  • DUAL

influxAuthParametersSecretArn -> (string)

The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.

maintenanceSchedule -> (structure)

The maintenance schedule of the resource at the time of backup.

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
© Copyright 2026, Amazon Web Services. Created using Sphinx.