TimestreamInfluxDB / Client / delete_db_backup

delete_db_backup

TimestreamInfluxDB.Client.delete_db_backup(**kwargs)

Deletes a Timestream for InfluxDB backup.

See also: AWS API Documentation

Request Syntax

response = client.delete_db_backup(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

The identifier of the backup to delete.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
    'createdAt': datetime(2015, 1, 1),
    'expiresAfter': 'string',
    'dbResourceId': 'string',
    'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'ON_DEMAND'|'CONTINUOUS',
    'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
    'kmsKeyId': 'string',
    'clusterConfiguration': {
        'ingestQueryInstances': 123,
        'queryOnlyInstances': 123,
        'dedicatedCompactor': True|False
    },
    'dbParameterGroupId': 'string',
    'dbInstanceType': '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': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'vpcSubnetIds': [
        'string',
    ],
    'vpcSecurityGroupIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'port': 123,
    'networkType': 'IPV4'|'DUAL',
    'influxAuthParametersSecretArn': 'string',
    'maintenanceSchedule': {
        'timezone': 'string',
        'preferredMaintenanceWindow': 'string'
    }
}

Response Structure

  • (dict) –

    • id (string) –

      Service-generated unique identifier of the deleted backup.

    • name (string) –

      The customer-provided name of the deleted backup.

    • arn (string) –

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

    • status (string) –

      The current status of the backup.

    • createdAt (datetime) –

      The time when the backup was created.

    • expiresAfter (string) –

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

    • dbResourceId (string) –

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

    • type (string) –

      The type of backup.

    • engineType (string) –

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

    • deploymentType (string) –

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

    • kmsKeyId (string) –

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

    • clusterConfiguration (dict) –

      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.

    • dbInstanceType (string) –

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

    • logDeliveryConfiguration (dict) –

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

      • s3Configuration (dict) –

        Configuration for S3 bucket log delivery.

        • bucketName (string) –

          The name of the S3 bucket to deliver logs to.

        • enabled (boolean) –

          Indicates whether log delivery to the S3 bucket is enabled.

    • failoverMode (string) –

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

    • dbStorageType (string) –

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

    • allocatedStorage (integer) –

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

    • vpcSubnetIds (list) –

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

      • (string) –

    • vpcSecurityGroupIds (list) –

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

      • (string) –

    • 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.

    • influxAuthParametersSecretArn (string) –

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

    • maintenanceSchedule (dict) –

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

      • timezone (string) –

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

      • preferredMaintenanceWindow (string) –

        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.

Exceptions