Delete Index Objects
Delete associated 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.
Configuration
To configure the Delete index objects module, Edit these settings.
Options
Specify the options below to configure multiple Delete index objects:
| Name | Description | Category |
|---|---|---|
| indexDeleteObjectStorageName | Object storage logical name | General |
| indexDeleteContainer | Object storage container containing index objects | General |
| indexDeleteObject | The target object whose index objects to delete from storage | General |
| indexDeleteObjectStorageArgs | Custom object storage args | Advanced |
| indexDeleteTarget | Logical name identifying the origin of 'indexDeleteObject' | Output |
General
indexDeleteObjectStorageName
Object storage logical name.
| Type | Required | Category |
|---|---|---|
| String | ✔ | General |
Identifies the object storage from which to delete the target index objects (e.g., 'AWS').
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.
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.
Advanced
indexDeleteObjectStorageArgs
Custom object storage args.
| Type | Default | Category |
|---|---|---|
| List | [] | Advanced |
Custom arguments passed as a map to the constructor of the underlying object storage. This list is expected to hold pairs of key values (e.g., args: [key1, value1, key2, value2]).
Output
indexDeleteTarget
Logical name identifying the origin of 'indexDeleteObject'.
| Type | Required | Category |
|---|---|---|
| String | ✔ | Output |
Specifies a logical name to delete TenXTemplate Filters produced for indexDeleteTargetObject under. This name commonly specifies the app which generated the events enclosed within this blob (e.g. 'acme-client').
This module is defined in delete/module.yaml.