stack es transform put-transform cli command
Auth required
Idempotent
Scope: global
elastic stack es transform put-transform \
--transform-id <transform-id> \
--dest <dest> \
--source <source> \
[options]
Create a transform.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--transform-idstringrequired- Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.
--deststringrequired- The destination for the transform.
--sourcestringrequired- The source of the data for the transform.
--[no-]defer-validation- When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks.
--timeoutstring- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
--descriptionstring- Free text description of the transform.
--frequencystring- The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is
1sand the maximum is1h. --lateststring- The latest method transforms the data by finding the latest document for each unique key.
--metastring- Defines optional transform metadata.
--pivotstring- The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.
--retention-policystring- Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.
--settingsstring- Defines optional transform settings.
--syncstring- Defines the properties transforms require to run continuously.
--input-filestring- path to a JSON file to use as command input
--[no-]dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--[no-]json-
output as JSON