---
title: "Delete Index Objects"
description: "Delete index objects for target blob"
source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/input/objectStorage/index/delete/module.yaml"
icon: "material/target"
hidden: "true"

---
Delete associated [TenXTemplate Filters](https://doc.log10x.com/run/input/objectStorage/index/#tenxtemplate-filters) associated with a target blob. This module executes when an storage object (e.g., S3 object) is deleted from its container and as part of the clean its previously generated index objects are removed as well as part of a deletion trigger.

## :material-wrench-outline: Configuration

To configure the Delete index objects module, [:material-cog: Edit](https://doc.log10x.com/config/app/ "Learn how to edit app and module configurations") these settings.  

## :material-menu: Options

Specify the options below to [configure](/config "configure") multiple Delete index objects:

|Name|Description|Category|
|---|---|---|
|[indexDeleteObjectStorageName](#indexdeleteobjectstoragename "object storage logical name")|Object storage logical name|General|
|[indexDeleteContainer](#indexdeletecontainer "Object storage container containing index objects")|Object storage container containing index objects|General|
|[indexDeleteObject](#indexdeleteobject "the target object whose index objects to delete from storage")|The target object whose index objects to delete from storage|General|
|[indexDeleteObjectStorageArgs](#indexdeleteobjectstorageargs "custom object storage args")|Custom object storage args|Advanced|
|[indexDeleteTarget](#indexdeletetarget "logical name identifying the origin of 'indexDeleteObject'")|Logical name identifying the origin of 'indexDeleteObject'|Output|

### General

#### :material-menu-right-outline:**`indexDeleteObjectStorageName`**

Object storage logical name.

|Type|Required|Category|
|---|---|---|
|String|✔|General|

Identifies the [object storage](https://doc.log10x.com/run/input/objectStorage#objectstorageccessclassname)
from which to delete the target index objects (e.g., 'AWS').


#### :material-menu-right-outline:**`indexDeleteContainer`**

Object storage container containing index objects.

|Type|Required|Category|
|---|---|---|
|String|✔|General|

Specifies the object storage container (e.g., AWS S3 bucket)
name from which to delete [TenXTemplate Filters](https://doc.log10x.com/run/input/objectStorage/index/#tenxtemplate-filters).


#### :material-menu-right-outline:**`indexDeleteObject`**

The target object whose index objects to delete from storage.

|Type|Required|Category|
|---|---|---|
|String|✔|General|

Sets the name of the object (e.g., log file) whose associated index objects to delete from [indexDeleteContainer](https://doc.log10x.com/run/input/objectStorage/index/delete/#indexdeletecontainer "Object storage container containing index objects").


### Advanced

#### :material-menu-right-outline:**`indexDeleteObjectStorageArgs`**

Custom object storage args.

|Type|Default|Category|
|---|---|---|
|List|\[\]|Advanced|

Custom arguments passed as a map to the constructor of the underlying [object storage](https://doc.log10x.com/run/input/objectStorage/index/delete/#queryobjectobjectstoragename).
This list is expected to hold pairs of key values (e.g., args: \[key1, value1, key2, value2\]).


### Output

#### :material-menu-right-outline:**`indexDeleteTarget`**

Logical name identifying the origin of 'indexDeleteObject'.

|Type|Required|Category|
|---|---|---|
|String|✔|Output|

Specifies a logical name to delete [TenXTemplate Filters](https://doc.log10x.com/run/input/objectStorage/index/#TenXTemplate-filters) produced for [indexDeleteTargetObject](https://doc.log10x.com/run/input/objectStorage/index/delete/#indexdeletetargetObject) under.
This name commonly specifies the app which generated the events enclosed within this blob (e.g. 'acme-client').


<br/>:material-github: This module is defined in [delete/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/input/objectStorage/index/delete/module.yaml "delete/module.yaml"){target="\_blank"}.

