Docs Home
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elasticstack.ElasticsearchTransform
Explore with Pulumi AI
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
Creates, updates, starts and stops a transform. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/transforms.html
NOTE: Some transform settings require a minimum Elasticsearch version. Such settings will be ignored when applied to versions below the required one (a warning will be issued in the logs).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const transformWithPivot = new elasticstack.ElasticsearchTransform("transformWithPivot", {
description: "A meaningful description",
source: {
indices: ["names_or_patterns_for_input_index"],
},
destination: {
index: "destination_index_for_transform",
aliases: [
{
alias: "test_alias_1",
moveOnCreation: true,
},
{
alias: "test_alias_2",
moveOnCreation: false,
},
],
},
pivot: JSON.stringify({
group_by: {
customer_id: {
terms: {
field: "customer_id",
missing_bucket: true,
},
},
},
aggregations: {
max_price: {
max: {
field: "taxful_total_price",
},
},
},
}),
frequency: "5m",
retentionPolicy: {
time: {
field: "order_date",
maxAge: "30d",
},
},
sync: {
time: {
field: "order_date",
delay: "10s",
},
},
maxPageSearchSize: 2000,
enabled: false,
deferValidation: false,
});
import pulumi
import json
import pulumi_elasticstack as elasticstack
transform_with_pivot = elasticstack.ElasticsearchTransform("transformWithPivot",
description="A meaningful description",
source={
"indices": ["names_or_patterns_for_input_index"],
},
destination={
"index": "destination_index_for_transform",
"aliases": [
{
"alias": "test_alias_1",
"move_on_creation": True,
},
{
"alias": "test_alias_2",
"move_on_creation": False,
},
],
},
pivot=json.dumps({
"group_by": {
"customer_id": {
"terms": {
"field": "customer_id",
"missing_bucket": True,
},
},
},
"aggregations": {
"max_price": {
"max": {
"field": "taxful_total_price",
},
},
},
}),
frequency="5m",
retention_policy={
"time": {
"field": "order_date",
"max_age": "30d",
},
},
sync={
"time": {
"field": "order_date",
"delay": "10s",
},
},
max_page_search_size=2000,
enabled=False,
defer_validation=False)
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"group_by": map[string]interface{}{
"customer_id": map[string]interface{}{
"terms": map[string]interface{}{
"field": "customer_id",
"missing_bucket": true,
},
},
},
"aggregations": map[string]interface{}{
"max_price": map[string]interface{}{
"max": map[string]interface{}{
"field": "taxful_total_price",
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = elasticstack.NewElasticsearchTransform(ctx, "transformWithPivot", &elasticstack.ElasticsearchTransformArgs{
Description: pulumi.String("A meaningful description"),
Source: &elasticstack.ElasticsearchTransformSourceArgs{
Indices: pulumi.StringArray{
pulumi.String("names_or_patterns_for_input_index"),
},
},
Destination: &elasticstack.ElasticsearchTransformDestinationArgs{
Index: pulumi.String("destination_index_for_transform"),
Aliases: elasticstack.ElasticsearchTransformDestinationAliasArray{
&elasticstack.ElasticsearchTransformDestinationAliasArgs{
Alias: pulumi.String("test_alias_1"),
MoveOnCreation: pulumi.Bool(true),
},
&elasticstack.ElasticsearchTransformDestinationAliasArgs{
Alias: pulumi.String("test_alias_2"),
MoveOnCreation: pulumi.Bool(false),
},
},
},
Pivot: pulumi.String(json0),
Frequency: pulumi.String("5m"),
RetentionPolicy: &elasticstack.ElasticsearchTransformRetentionPolicyArgs{
Time: &elasticstack.ElasticsearchTransformRetentionPolicyTimeArgs{
Field: pulumi.String("order_date"),
MaxAge: pulumi.String("30d"),
},
},
Sync: &elasticstack.ElasticsearchTransformSyncArgs{
Time: &elasticstack.ElasticsearchTransformSyncTimeArgs{
Field: pulumi.String("order_date"),
Delay: pulumi.String("10s"),
},
},
MaxPageSearchSize: pulumi.Float64(2000),
Enabled: pulumi.Bool(false),
DeferValidation: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
var transformWithPivot = new Elasticstack.ElasticsearchTransform("transformWithPivot", new()
{
Description = "A meaningful description",
Source = new Elasticstack.Inputs.ElasticsearchTransformSourceArgs
{
Indices = new[]
{
"names_or_patterns_for_input_index",
},
},
Destination = new Elasticstack.Inputs.ElasticsearchTransformDestinationArgs
{
Index = "destination_index_for_transform",
Aliases = new[]
{
new Elasticstack.Inputs.ElasticsearchTransformDestinationAliasArgs
{
Alias = "test_alias_1",
MoveOnCreation = true,
},
new Elasticstack.Inputs.ElasticsearchTransformDestinationAliasArgs
{
Alias = "test_alias_2",
MoveOnCreation = false,
},
},
},
Pivot = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["group_by"] = new Dictionary<string, object?>
{
["customer_id"] = new Dictionary<string, object?>
{
["terms"] = new Dictionary<string, object?>
{
["field"] = "customer_id",
["missing_bucket"] = true,
},
},
},
["aggregations"] = new Dictionary<string, object?>
{
["max_price"] = new Dictionary<string, object?>
{
["max"] = new Dictionary<string, object?>
{
["field"] = "taxful_total_price",
},
},
},
}),
Frequency = "5m",
RetentionPolicy = new Elasticstack.Inputs.ElasticsearchTransformRetentionPolicyArgs
{
Time = new Elasticstack.Inputs.ElasticsearchTransformRetentionPolicyTimeArgs
{
Field = "order_date",
MaxAge = "30d",
},
},
Sync = new Elasticstack.Inputs.ElasticsearchTransformSyncArgs
{
Time = new Elasticstack.Inputs.ElasticsearchTransformSyncTimeArgs
{
Field = "order_date",
Delay = "10s",
},
},
MaxPageSearchSize = 2000,
Enabled = false,
DeferValidation = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchTransform;
import com.pulumi.elasticstack.ElasticsearchTransformArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchTransformSourceArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchTransformDestinationArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchTransformRetentionPolicyArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchTransformRetentionPolicyTimeArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchTransformSyncArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchTransformSyncTimeArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var transformWithPivot = new ElasticsearchTransform("transformWithPivot", ElasticsearchTransformArgs.builder()
.description("A meaningful description")
.source(ElasticsearchTransformSourceArgs.builder()
.indices("names_or_patterns_for_input_index")
.build())
.destination(ElasticsearchTransformDestinationArgs.builder()
.index("destination_index_for_transform")
.aliases(
ElasticsearchTransformDestinationAliasArgs.builder()
.alias("test_alias_1")
.moveOnCreation(true)
.build(),
ElasticsearchTransformDestinationAliasArgs.builder()
.alias("test_alias_2")
.moveOnCreation(false)
.build())
.build())
.pivot(serializeJson(
jsonObject(
jsonProperty("group_by", jsonObject(
jsonProperty("customer_id", jsonObject(
jsonProperty("terms", jsonObject(
jsonProperty("field", "customer_id"),
jsonProperty("missing_bucket", true)
))
))
)),
jsonProperty("aggregations", jsonObject(
jsonProperty("max_price", jsonObject(
jsonProperty("max", jsonObject(
jsonProperty("field", "taxful_total_price")
))
))
))
)))
.frequency("5m")
.retentionPolicy(ElasticsearchTransformRetentionPolicyArgs.builder()
.time(ElasticsearchTransformRetentionPolicyTimeArgs.builder()
.field("order_date")
.maxAge("30d")
.build())
.build())
.sync(ElasticsearchTransformSyncArgs.builder()
.time(ElasticsearchTransformSyncTimeArgs.builder()
.field("order_date")
.delay("10s")
.build())
.build())
.maxPageSearchSize(2000)
.enabled(false)
.deferValidation(false)
.build());
}
}
resources:
transformWithPivot:
type: elasticstack:ElasticsearchTransform
properties:
description: A meaningful description
source:
indices:
- names_or_patterns_for_input_index
destination:
index: destination_index_for_transform
aliases:
- alias: test_alias_1
moveOnCreation: true
- alias: test_alias_2
moveOnCreation: false
pivot:
fn::toJSON:
group_by:
customer_id:
terms:
field: customer_id
missing_bucket: true
aggregations:
max_price:
max:
field: taxful_total_price
frequency: 5m
retentionPolicy:
time:
field: order_date
maxAge: 30d
sync:
time:
field: order_date
delay: 10s
maxPageSearchSize: 2000
enabled: false
deferValidation: false
Create ElasticsearchTransform Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchTransform(name: string, args: ElasticsearchTransformArgs, opts?: CustomResourceOptions);@overload
def ElasticsearchTransform(resource_name: str,
args: ElasticsearchTransformArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchTransform(resource_name: str,
opts: Optional[ResourceOptions] = None,
destination: Optional[ElasticsearchTransformDestinationArgs] = None,
source: Optional[ElasticsearchTransformSourceArgs] = None,
max_page_search_size: Optional[float] = None,
metadata: Optional[str] = None,
description: Optional[str] = None,
deduce_mappings: Optional[bool] = None,
docs_per_second: Optional[float] = None,
enabled: Optional[bool] = None,
frequency: Optional[str] = None,
latest: Optional[str] = None,
align_checkpoints: Optional[bool] = None,
defer_validation: Optional[bool] = None,
name: Optional[str] = None,
num_failure_retries: Optional[float] = None,
pivot: Optional[str] = None,
retention_policy: Optional[ElasticsearchTransformRetentionPolicyArgs] = None,
dates_as_epoch_millis: Optional[bool] = None,
sync: Optional[ElasticsearchTransformSyncArgs] = None,
timeout: Optional[str] = None,
unattended: Optional[bool] = None)func NewElasticsearchTransform(ctx *Context, name string, args ElasticsearchTransformArgs, opts ...ResourceOption) (*ElasticsearchTransform, error)public ElasticsearchTransform(string name, ElasticsearchTransformArgs args, CustomResourceOptions? opts = null)
public ElasticsearchTransform(String name, ElasticsearchTransformArgs args)
public ElasticsearchTransform(String name, ElasticsearchTransformArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchTransform
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ElasticsearchTransformArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ElasticsearchTransformArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ElasticsearchTransformArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchTransformArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchTransformArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var elasticsearchTransformResource = new Elasticstack.ElasticsearchTransform("elasticsearchTransformResource", new()
{
Destination = new Elasticstack.Inputs.ElasticsearchTransformDestinationArgs
{
Index = "string",
Aliases = new[]
{
new Elasticstack.Inputs.ElasticsearchTransformDestinationAliasArgs
{
Alias = "string",
MoveOnCreation = false,
},
},
Pipeline = "string",
},
Source = new Elasticstack.Inputs.ElasticsearchTransformSourceArgs
{
Indices = new[]
{
"string",
},
Query = "string",
RuntimeMappings = "string",
},
MaxPageSearchSize = 0,
Metadata = "string",
Description = "string",
DeduceMappings = false,
DocsPerSecond = 0,
Enabled = false,
Frequency = "string",
Latest = "string",
AlignCheckpoints = false,
DeferValidation = false,
Name = "string",
NumFailureRetries = 0,
Pivot = "string",
RetentionPolicy = new Elasticstack.Inputs.ElasticsearchTransformRetentionPolicyArgs
{
Time = new Elasticstack.Inputs.ElasticsearchTransformRetentionPolicyTimeArgs
{
Field = "string",
MaxAge = "string",
},
},
DatesAsEpochMillis = false,
Sync = new Elasticstack.Inputs.ElasticsearchTransformSyncArgs
{
Time = new Elasticstack.Inputs.ElasticsearchTransformSyncTimeArgs
{
Field = "string",
Delay = "string",
},
},
Timeout = "string",
Unattended = false,
});
example, err := elasticstack.NewElasticsearchTransform(ctx, "elasticsearchTransformResource", &elasticstack.ElasticsearchTransformArgs{
Destination: &elasticstack.ElasticsearchTransformDestinationArgs{
Index: pulumi.String("string"),
Aliases: elasticstack.ElasticsearchTransformDestinationAliasArray{
&elasticstack.ElasticsearchTransformDestinationAliasArgs{
Alias: pulumi.String("string"),
MoveOnCreation: pulumi.Bool(false),
},
},
Pipeline: pulumi.String("string"),
},
Source: &elasticstack.ElasticsearchTransformSourceArgs{
Indices: pulumi.StringArray{
pulumi.String("string"),
},
Query: pulumi.String("string"),
RuntimeMappings: pulumi.String("string"),
},
MaxPageSearchSize: pulumi.Float64(0),
Metadata: pulumi.String("string"),
Description: pulumi.String("string"),
DeduceMappings: pulumi.Bool(false),
DocsPerSecond: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
Frequency: pulumi.String("string"),
Latest: pulumi.String("string"),
AlignCheckpoints: pulumi.Bool(false),
DeferValidation: pulumi.Bool(false),
Name: pulumi.String("string"),
NumFailureRetries: pulumi.Float64(0),
Pivot: pulumi.String("string"),
RetentionPolicy: &elasticstack.ElasticsearchTransformRetentionPolicyArgs{
Time: &elasticstack.ElasticsearchTransformRetentionPolicyTimeArgs{
Field: pulumi.String("string"),
MaxAge: pulumi.String("string"),
},
},
DatesAsEpochMillis: pulumi.Bool(false),
Sync: &elasticstack.ElasticsearchTransformSyncArgs{
Time: &elasticstack.ElasticsearchTransformSyncTimeArgs{
Field: pulumi.String("string"),
Delay: pulumi.String("string"),
},
},
Timeout: pulumi.String("string"),
Unattended: pulumi.Bool(false),
})
var elasticsearchTransformResource = new ElasticsearchTransform("elasticsearchTransformResource", ElasticsearchTransformArgs.builder()
.destination(ElasticsearchTransformDestinationArgs.builder()
.index("string")
.aliases(ElasticsearchTransformDestinationAliasArgs.builder()
.alias("string")
.moveOnCreation(false)
.build())
.pipeline("string")
.build())
.source(ElasticsearchTransformSourceArgs.builder()
.indices("string")
.query("string")
.runtimeMappings("string")
.build())
.maxPageSearchSize(0)
.metadata("string")
.description("string")
.deduceMappings(false)
.docsPerSecond(0)
.enabled(false)
.frequency("string")
.latest("string")
.alignCheckpoints(false)
.deferValidation(false)
.name("string")
.numFailureRetries(0)
.pivot("string")
.retentionPolicy(ElasticsearchTransformRetentionPolicyArgs.builder()
.time(ElasticsearchTransformRetentionPolicyTimeArgs.builder()
.field("string")
.maxAge("string")
.build())
.build())
.datesAsEpochMillis(false)
.sync(ElasticsearchTransformSyncArgs.builder()
.time(ElasticsearchTransformSyncTimeArgs.builder()
.field("string")
.delay("string")
.build())
.build())
.timeout("string")
.unattended(false)
.build());
elasticsearch_transform_resource = elasticstack.ElasticsearchTransform("elasticsearchTransformResource",
destination={
"index": "string",
"aliases": [{
"alias": "string",
"move_on_creation": False,
}],
"pipeline": "string",
},
source={
"indices": ["string"],
"query": "string",
"runtime_mappings": "string",
},
max_page_search_size=0,
metadata="string",
description="string",
deduce_mappings=False,
docs_per_second=0,
enabled=False,
frequency="string",
latest="string",
align_checkpoints=False,
defer_validation=False,
name="string",
num_failure_retries=0,
pivot="string",
retention_policy={
"time": {
"field": "string",
"max_age": "string",
},
},
dates_as_epoch_millis=False,
sync={
"time": {
"field": "string",
"delay": "string",
},
},
timeout="string",
unattended=False)
const elasticsearchTransformResource = new elasticstack.ElasticsearchTransform("elasticsearchTransformResource", {
destination: {
index: "string",
aliases: [{
alias: "string",
moveOnCreation: false,
}],
pipeline: "string",
},
source: {
indices: ["string"],
query: "string",
runtimeMappings: "string",
},
maxPageSearchSize: 0,
metadata: "string",
description: "string",
deduceMappings: false,
docsPerSecond: 0,
enabled: false,
frequency: "string",
latest: "string",
alignCheckpoints: false,
deferValidation: false,
name: "string",
numFailureRetries: 0,
pivot: "string",
retentionPolicy: {
time: {
field: "string",
maxAge: "string",
},
},
datesAsEpochMillis: false,
sync: {
time: {
field: "string",
delay: "string",
},
},
timeout: "string",
unattended: false,
});
type: elasticstack:ElasticsearchTransform
properties:
alignCheckpoints: false
datesAsEpochMillis: false
deduceMappings: false
deferValidation: false
description: string
destination:
aliases:
- alias: string
moveOnCreation: false
index: string
pipeline: string
docsPerSecond: 0
enabled: false
frequency: string
latest: string
maxPageSearchSize: 0
metadata: string
name: string
numFailureRetries: 0
pivot: string
retentionPolicy:
time:
field: string
maxAge: string
source:
indices:
- string
query: string
runtimeMappings: string
sync:
time:
delay: string
field: string
timeout: string
unattended: false
ElasticsearchTransform Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ElasticsearchTransform resource accepts the following input properties:
- Destination
Elasticsearch
Transform Destination - The destination for the transform.
- Source
Elasticsearch
Transform Source - The source of the data for the transform.
- Align
Checkpoints bool - Specifies whether the transform checkpoint ranges should be optimized for performance.
- Dates
As boolEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- Deduce
Mappings bool - Specifies whether the transform should deduce the destination index mappings from the transform config.
- Defer
Validation bool - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - Description string
- Free text description of the transform.
- Docs
Per doubleSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- Enabled bool
- Controls whether the transform should be started or stopped. Default is
false(stopped). - Frequency string
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - Latest string
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Max
Page doubleSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- Metadata string
- Defines optional transform metadata.
- Name string
- Name of the transform you wish to create.
- Num
Failure doubleRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- Pivot string
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Retention
Policy ElasticsearchTransform Retention Policy - Defines a retention policy for the transform.
- Sync
Elasticsearch
Transform Sync - Defines the properties transforms require to run continuously.
- Timeout string
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - Unattended bool
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- Destination
Elasticsearch
Transform Destination Args - The destination for the transform.
- Source
Elasticsearch
Transform Source Args - The source of the data for the transform.
- Align
Checkpoints bool - Specifies whether the transform checkpoint ranges should be optimized for performance.
- Dates
As boolEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- Deduce
Mappings bool - Specifies whether the transform should deduce the destination index mappings from the transform config.
- Defer
Validation bool - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - Description string
- Free text description of the transform.
- Docs
Per float64Second - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- Enabled bool
- Controls whether the transform should be started or stopped. Default is
false(stopped). - Frequency string
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - Latest string
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Max
Page float64Search Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- Metadata string
- Defines optional transform metadata.
- Name string
- Name of the transform you wish to create.
- Num
Failure float64Retries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- Pivot string
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Retention
Policy ElasticsearchTransform Retention Policy Args - Defines a retention policy for the transform.
- Sync
Elasticsearch
Transform Sync Args - Defines the properties transforms require to run continuously.
- Timeout string
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - Unattended bool
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- destination
Elasticsearch
Transform Destination - The destination for the transform.
- source
Elasticsearch
Transform Source - The source of the data for the transform.
- align
Checkpoints Boolean - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates
As BooleanEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce
Mappings Boolean - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer
Validation Boolean - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description String
- Free text description of the transform.
- docs
Per DoubleSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled Boolean
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency String
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest String
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max
Page DoubleSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata String
- Defines optional transform metadata.
- name String
- Name of the transform you wish to create.
- num
Failure DoubleRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot String
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention
Policy ElasticsearchTransform Retention Policy - Defines a retention policy for the transform.
- sync
Elasticsearch
Transform Sync - Defines the properties transforms require to run continuously.
- timeout String
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended Boolean
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- destination
Elasticsearch
Transform Destination - The destination for the transform.
- source
Elasticsearch
Transform Source - The source of the data for the transform.
- align
Checkpoints boolean - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates
As booleanEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce
Mappings boolean - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer
Validation boolean - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description string
- Free text description of the transform.
- docs
Per numberSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled boolean
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency string
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest string
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max
Page numberSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata string
- Defines optional transform metadata.
- name string
- Name of the transform you wish to create.
- num
Failure numberRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot string
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention
Policy ElasticsearchTransform Retention Policy - Defines a retention policy for the transform.
- sync
Elasticsearch
Transform Sync - Defines the properties transforms require to run continuously.
- timeout string
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended boolean
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- destination
Elasticsearch
Transform Destination Args - The destination for the transform.
- source
Elasticsearch
Transform Source Args - The source of the data for the transform.
- align_
checkpoints bool - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates_
as_ boolepoch_ millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce_
mappings bool - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer_
validation bool - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description str
- Free text description of the transform.
- docs_
per_ floatsecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled bool
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency str
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest str
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max_
page_ floatsearch_ size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata str
- Defines optional transform metadata.
- name str
- Name of the transform you wish to create.
- num_
failure_ floatretries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot str
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention_
policy ElasticsearchTransform Retention Policy Args - Defines a retention policy for the transform.
- sync
Elasticsearch
Transform Sync Args - Defines the properties transforms require to run continuously.
- timeout str
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended bool
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- destination Property Map
- The destination for the transform.
- source Property Map
- The source of the data for the transform.
- align
Checkpoints Boolean - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates
As BooleanEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce
Mappings Boolean - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer
Validation Boolean - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description String
- Free text description of the transform.
- docs
Per NumberSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled Boolean
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency String
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest String
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max
Page NumberSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata String
- Defines optional transform metadata.
- name String
- Name of the transform you wish to create.
- num
Failure NumberRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot String
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention
Policy Property Map - Defines a retention policy for the transform.
- sync Property Map
- Defines the properties transforms require to run continuously.
- timeout String
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended Boolean
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchTransform resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ElasticsearchTransform Resource
Get an existing ElasticsearchTransform resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ElasticsearchTransformState, opts?: CustomResourceOptions): ElasticsearchTransform@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
align_checkpoints: Optional[bool] = None,
dates_as_epoch_millis: Optional[bool] = None,
deduce_mappings: Optional[bool] = None,
defer_validation: Optional[bool] = None,
description: Optional[str] = None,
destination: Optional[ElasticsearchTransformDestinationArgs] = None,
docs_per_second: Optional[float] = None,
enabled: Optional[bool] = None,
frequency: Optional[str] = None,
latest: Optional[str] = None,
max_page_search_size: Optional[float] = None,
metadata: Optional[str] = None,
name: Optional[str] = None,
num_failure_retries: Optional[float] = None,
pivot: Optional[str] = None,
retention_policy: Optional[ElasticsearchTransformRetentionPolicyArgs] = None,
source: Optional[ElasticsearchTransformSourceArgs] = None,
sync: Optional[ElasticsearchTransformSyncArgs] = None,
timeout: Optional[str] = None,
unattended: Optional[bool] = None) -> ElasticsearchTransformfunc GetElasticsearchTransform(ctx *Context, name string, id IDInput, state *ElasticsearchTransformState, opts ...ResourceOption) (*ElasticsearchTransform, error)public static ElasticsearchTransform Get(string name, Input<string> id, ElasticsearchTransformState? state, CustomResourceOptions? opts = null)public static ElasticsearchTransform get(String name, Output<String> id, ElasticsearchTransformState state, CustomResourceOptions options)resources: _: type: elasticstack:ElasticsearchTransform get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Align
Checkpoints bool - Specifies whether the transform checkpoint ranges should be optimized for performance.
- Dates
As boolEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- Deduce
Mappings bool - Specifies whether the transform should deduce the destination index mappings from the transform config.
- Defer
Validation bool - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - Description string
- Free text description of the transform.
- Destination
Elasticsearch
Transform Destination - The destination for the transform.
- Docs
Per doubleSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- Enabled bool
- Controls whether the transform should be started or stopped. Default is
false(stopped). - Frequency string
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - Latest string
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Max
Page doubleSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- Metadata string
- Defines optional transform metadata.
- Name string
- Name of the transform you wish to create.
- Num
Failure doubleRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- Pivot string
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Retention
Policy ElasticsearchTransform Retention Policy - Defines a retention policy for the transform.
- Source
Elasticsearch
Transform Source - The source of the data for the transform.
- Sync
Elasticsearch
Transform Sync - Defines the properties transforms require to run continuously.
- Timeout string
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - Unattended bool
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- Align
Checkpoints bool - Specifies whether the transform checkpoint ranges should be optimized for performance.
- Dates
As boolEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- Deduce
Mappings bool - Specifies whether the transform should deduce the destination index mappings from the transform config.
- Defer
Validation bool - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - Description string
- Free text description of the transform.
- Destination
Elasticsearch
Transform Destination Args - The destination for the transform.
- Docs
Per float64Second - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- Enabled bool
- Controls whether the transform should be started or stopped. Default is
false(stopped). - Frequency string
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - Latest string
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Max
Page float64Search Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- Metadata string
- Defines optional transform metadata.
- Name string
- Name of the transform you wish to create.
- Num
Failure float64Retries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- Pivot string
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- Retention
Policy ElasticsearchTransform Retention Policy Args - Defines a retention policy for the transform.
- Source
Elasticsearch
Transform Source Args - The source of the data for the transform.
- Sync
Elasticsearch
Transform Sync Args - Defines the properties transforms require to run continuously.
- Timeout string
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - Unattended bool
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- align
Checkpoints Boolean - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates
As BooleanEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce
Mappings Boolean - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer
Validation Boolean - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description String
- Free text description of the transform.
- destination
Elasticsearch
Transform Destination - The destination for the transform.
- docs
Per DoubleSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled Boolean
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency String
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest String
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max
Page DoubleSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata String
- Defines optional transform metadata.
- name String
- Name of the transform you wish to create.
- num
Failure DoubleRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot String
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention
Policy ElasticsearchTransform Retention Policy - Defines a retention policy for the transform.
- source
Elasticsearch
Transform Source - The source of the data for the transform.
- sync
Elasticsearch
Transform Sync - Defines the properties transforms require to run continuously.
- timeout String
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended Boolean
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- align
Checkpoints boolean - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates
As booleanEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce
Mappings boolean - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer
Validation boolean - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description string
- Free text description of the transform.
- destination
Elasticsearch
Transform Destination - The destination for the transform.
- docs
Per numberSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled boolean
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency string
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest string
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max
Page numberSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata string
- Defines optional transform metadata.
- name string
- Name of the transform you wish to create.
- num
Failure numberRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot string
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention
Policy ElasticsearchTransform Retention Policy - Defines a retention policy for the transform.
- source
Elasticsearch
Transform Source - The source of the data for the transform.
- sync
Elasticsearch
Transform Sync - Defines the properties transforms require to run continuously.
- timeout string
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended boolean
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- align_
checkpoints bool - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates_
as_ boolepoch_ millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce_
mappings bool - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer_
validation bool - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description str
- Free text description of the transform.
- destination
Elasticsearch
Transform Destination Args - The destination for the transform.
- docs_
per_ floatsecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled bool
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency str
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest str
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max_
page_ floatsearch_ size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata str
- Defines optional transform metadata.
- name str
- Name of the transform you wish to create.
- num_
failure_ floatretries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot str
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention_
policy ElasticsearchTransform Retention Policy Args - Defines a retention policy for the transform.
- source
Elasticsearch
Transform Source Args - The source of the data for the transform.
- sync
Elasticsearch
Transform Sync Args - Defines the properties transforms require to run continuously.
- timeout str
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended bool
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
- align
Checkpoints Boolean - Specifies whether the transform checkpoint ranges should be optimized for performance.
- dates
As BooleanEpoch Millis - Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
- deduce
Mappings Boolean - Specifies whether the transform should deduce the destination index mappings from the transform config.
- defer
Validation Boolean - When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created. Default is
false - description String
- Free text description of the transform.
- destination Property Map
- The destination for the transform.
- docs
Per NumberSecond - Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
- enabled Boolean
- Controls whether the transform should be started or stopped. Default is
false(stopped). - frequency String
- The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
1m. - latest String
- The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
- max
Page NumberSearch Size - Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
- metadata String
- Defines optional transform metadata.
- name String
- Name of the transform you wish to create.
- num
Failure NumberRetries - Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting numtransformfailure_retries.
- pivot String
- The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
- retention
Policy Property Map - Defines a retention policy for the transform.
- source Property Map
- The source of the data for the transform.
- sync Property Map
- Defines the properties transforms require to run continuously.
- timeout String
- Period to wait for a response from Elasticsearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to
30s. - unattended Boolean
- In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
Supporting Types
ElasticsearchTransformDestination, ElasticsearchTransformDestinationArgs
- Index string
- The destination index for the transform.
- Aliases
List<Elasticsearch
Transform Destination Alias> - The aliases that the destination index for the transform should have.
- Pipeline string
- The unique identifier for an ingest pipeline.
- Index string
- The destination index for the transform.
- Aliases
[]Elasticsearch
Transform Destination Alias - The aliases that the destination index for the transform should have.
- Pipeline string
- The unique identifier for an ingest pipeline.
- index String
- The destination index for the transform.
- aliases
List<Elasticsearch
Transform Destination Alias> - The aliases that the destination index for the transform should have.
- pipeline String
- The unique identifier for an ingest pipeline.
- index string
- The destination index for the transform.
- aliases
Elasticsearch
Transform Destination Alias[] - The aliases that the destination index for the transform should have.
- pipeline string
- The unique identifier for an ingest pipeline.
- index str
- The destination index for the transform.
- aliases
Sequence[Elasticsearch
Transform Destination Alias] - The aliases that the destination index for the transform should have.
- pipeline str
- The unique identifier for an ingest pipeline.
- index String
- The destination index for the transform.
- aliases List<Property Map>
- The aliases that the destination index for the transform should have.
- pipeline String
- The unique identifier for an ingest pipeline.
ElasticsearchTransformDestinationAlias, ElasticsearchTransformDestinationAliasArgs
- Alias string
- The name of the alias.
- Move
On boolCreation - Whether the destination index should be the only index in this alias. Defaults to false.
- Alias string
- The name of the alias.
- Move
On boolCreation - Whether the destination index should be the only index in this alias. Defaults to false.
- alias String
- The name of the alias.
- move
On BooleanCreation - Whether the destination index should be the only index in this alias. Defaults to false.
- alias string
- The name of the alias.
- move
On booleanCreation - Whether the destination index should be the only index in this alias. Defaults to false.
- alias str
- The name of the alias.
- move_
on_ boolcreation - Whether the destination index should be the only index in this alias. Defaults to false.
- alias String
- The name of the alias.
- move
On BooleanCreation - Whether the destination index should be the only index in this alias. Defaults to false.
ElasticsearchTransformRetentionPolicy, ElasticsearchTransformRetentionPolicyArgs
- Time
Elasticsearch
Transform Retention Policy Time - Specifies that the transform uses a time field to set the retention policy. This is currently the only supported option.
- Time
Elasticsearch
Transform Retention Policy Time - Specifies that the transform uses a time field to set the retention policy. This is currently the only supported option.
- time
Elasticsearch
Transform Retention Policy Time - Specifies that the transform uses a time field to set the retention policy. This is currently the only supported option.
- time
Elasticsearch
Transform Retention Policy Time - Specifies that the transform uses a time field to set the retention policy. This is currently the only supported option.
- time
Elasticsearch
Transform Retention Policy Time - Specifies that the transform uses a time field to set the retention policy. This is currently the only supported option.
- time Property Map
- Specifies that the transform uses a time field to set the retention policy. This is currently the only supported option.
ElasticsearchTransformRetentionPolicyTime, ElasticsearchTransformRetentionPolicyTimeArgs
ElasticsearchTransformSource, ElasticsearchTransformSourceArgs
- Indices List<string>
- The source indices for the transform.
- Query string
- A query clause that retrieves a subset of data from the source index.
- Runtime
Mappings string - Definitions of search-time runtime fields that can be used by the transform.
- Indices []string
- The source indices for the transform.
- Query string
- A query clause that retrieves a subset of data from the source index.
- Runtime
Mappings string - Definitions of search-time runtime fields that can be used by the transform.
- indices List<String>
- The source indices for the transform.
- query String
- A query clause that retrieves a subset of data from the source index.
- runtime
Mappings String - Definitions of search-time runtime fields that can be used by the transform.
- indices string[]
- The source indices for the transform.
- query string
- A query clause that retrieves a subset of data from the source index.
- runtime
Mappings string - Definitions of search-time runtime fields that can be used by the transform.
- indices Sequence[str]
- The source indices for the transform.
- query str
- A query clause that retrieves a subset of data from the source index.
- runtime_
mappings str - Definitions of search-time runtime fields that can be used by the transform.
- indices List<String>
- The source indices for the transform.
- query String
- A query clause that retrieves a subset of data from the source index.
- runtime
Mappings String - Definitions of search-time runtime fields that can be used by the transform.
ElasticsearchTransformSync, ElasticsearchTransformSyncArgs
- Time
Elasticsearch
Transform Sync Time - Specifies that the transform uses a time field to synchronize the source and destination indices. This is currently the only supported option.
- Time
Elasticsearch
Transform Sync Time - Specifies that the transform uses a time field to synchronize the source and destination indices. This is currently the only supported option.
- time
Elasticsearch
Transform Sync Time - Specifies that the transform uses a time field to synchronize the source and destination indices. This is currently the only supported option.
- time
Elasticsearch
Transform Sync Time - Specifies that the transform uses a time field to synchronize the source and destination indices. This is currently the only supported option.
- time
Elasticsearch
Transform Sync Time - Specifies that the transform uses a time field to synchronize the source and destination indices. This is currently the only supported option.
- time Property Map
- Specifies that the transform uses a time field to synchronize the source and destination indices. This is currently the only supported option.
ElasticsearchTransformSyncTime, ElasticsearchTransformSyncTimeArgs
Import
$ pulumi import elasticstack:index/elasticsearchTransform:ElasticsearchTransform my_new_transform <cluster_uuid>/<transform_name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic