published on Thursday, May 14, 2026 by elastic
published on Thursday, May 14, 2026 by elastic
Creates or updates lifecycle policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const myIlm = new elasticstack.ElasticsearchIndexLifecycle("my_ilm", {
name: "my_ilm_policy",
hot: {
minAge: "1h",
setPriority: {
priority: 0,
},
rollover: {
maxAge: "1d",
},
readonly: {},
},
warm: {
minAge: "0ms",
setPriority: {
priority: 10,
},
readonly: {},
allocate: {
exclude: JSON.stringify({
box_type: "hot",
}),
numberOfReplicas: 1,
totalShardsPerNode: 200,
},
},
"delete": {
minAge: "2d",
"delete": {},
},
});
import pulumi
import json
import pulumi_elasticstack as elasticstack
my_ilm = elasticstack.ElasticsearchIndexLifecycle("my_ilm",
name="my_ilm_policy",
hot={
"min_age": "1h",
"set_priority": {
"priority": 0,
},
"rollover": {
"max_age": "1d",
},
"readonly": {},
},
warm={
"min_age": "0ms",
"set_priority": {
"priority": 10,
},
"readonly": {},
"allocate": {
"exclude": json.dumps({
"box_type": "hot",
}),
"number_of_replicas": 1,
"total_shards_per_node": 200,
},
},
delete={
"min_age": "2d",
"delete": {},
})
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{}{
"box_type": "hot",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = elasticstack.NewElasticsearchIndexLifecycle(ctx, "my_ilm", &elasticstack.ElasticsearchIndexLifecycleArgs{
Name: pulumi.String("my_ilm_policy"),
Hot: &elasticstack.ElasticsearchIndexLifecycleHotArgs{
MinAge: pulumi.String("1h"),
SetPriority: &elasticstack.ElasticsearchIndexLifecycleHotSetPriorityArgs{
Priority: pulumi.Float64(0),
},
Rollover: &elasticstack.ElasticsearchIndexLifecycleHotRolloverArgs{
MaxAge: pulumi.String("1d"),
},
Readonly: &elasticstack.ElasticsearchIndexLifecycleHotReadonlyArgs{},
},
Warm: &elasticstack.ElasticsearchIndexLifecycleWarmArgs{
MinAge: pulumi.String("0ms"),
SetPriority: &elasticstack.ElasticsearchIndexLifecycleWarmSetPriorityArgs{
Priority: pulumi.Float64(10),
},
Readonly: &elasticstack.ElasticsearchIndexLifecycleWarmReadonlyArgs{},
Allocate: &elasticstack.ElasticsearchIndexLifecycleWarmAllocateArgs{
Exclude: pulumi.String(json0),
NumberOfReplicas: pulumi.Float64(1),
TotalShardsPerNode: pulumi.Float64(200),
},
},
Delete: &elasticstack.ElasticsearchIndexLifecycleDeleteArgs{
MinAge: pulumi.String("2d"),
Delete: &elasticstack.ElasticsearchIndexLifecycleDeleteDeleteArgs{},
},
})
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 myIlm = new Elasticstack.ElasticsearchIndexLifecycle("my_ilm", new()
{
Name = "my_ilm_policy",
Hot = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotArgs
{
MinAge = "1h",
SetPriority = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotSetPriorityArgs
{
Priority = 0,
},
Rollover = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotRolloverArgs
{
MaxAge = "1d",
},
Readonly = null,
},
Warm = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmArgs
{
MinAge = "0ms",
SetPriority = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmSetPriorityArgs
{
Priority = 10,
},
Readonly = null,
Allocate = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmAllocateArgs
{
Exclude = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["box_type"] = "hot",
}),
NumberOfReplicas = 1,
TotalShardsPerNode = 200,
},
},
Delete = new Elasticstack.Inputs.ElasticsearchIndexLifecycleDeleteArgs
{
MinAge = "2d",
Delete = null,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchIndexLifecycle;
import com.pulumi.elasticstack.ElasticsearchIndexLifecycleArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleHotArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleHotSetPriorityArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleHotRolloverArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleHotReadonlyArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleWarmArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleWarmSetPriorityArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleWarmReadonlyArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleWarmAllocateArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleDeleteArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexLifecycleDeleteDeleteArgs;
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 myIlm = new ElasticsearchIndexLifecycle("myIlm", ElasticsearchIndexLifecycleArgs.builder()
.name("my_ilm_policy")
.hot(ElasticsearchIndexLifecycleHotArgs.builder()
.minAge("1h")
.setPriority(ElasticsearchIndexLifecycleHotSetPriorityArgs.builder()
.priority(0.0)
.build())
.rollover(ElasticsearchIndexLifecycleHotRolloverArgs.builder()
.maxAge("1d")
.build())
.readonly(ElasticsearchIndexLifecycleHotReadonlyArgs.builder()
.build())
.build())
.warm(ElasticsearchIndexLifecycleWarmArgs.builder()
.minAge("0ms")
.setPriority(ElasticsearchIndexLifecycleWarmSetPriorityArgs.builder()
.priority(10.0)
.build())
.readonly(ElasticsearchIndexLifecycleWarmReadonlyArgs.builder()
.build())
.allocate(ElasticsearchIndexLifecycleWarmAllocateArgs.builder()
.exclude(serializeJson(
jsonObject(
jsonProperty("box_type", "hot")
)))
.numberOfReplicas(1.0)
.totalShardsPerNode(200.0)
.build())
.build())
.delete(ElasticsearchIndexLifecycleDeleteArgs.builder()
.minAge("2d")
.delete(ElasticsearchIndexLifecycleDeleteDeleteArgs.builder()
.build())
.build())
.build());
}
}
resources:
myIlm:
type: elasticstack:ElasticsearchIndexLifecycle
name: my_ilm
properties:
name: my_ilm_policy
hot:
minAge: 1h
setPriority:
priority: 0
rollover:
maxAge: 1d
readonly: {}
warm:
minAge: 0ms
setPriority:
priority: 10
readonly: {}
allocate:
exclude:
fn::toJSON:
box_type: hot
numberOfReplicas: 1
totalShardsPerNode: 200
delete:
minAge: 2d
delete: {}
Example coming soon!
Create ElasticsearchIndexLifecycle Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchIndexLifecycle(name: string, args?: ElasticsearchIndexLifecycleArgs, opts?: CustomResourceOptions);@overload
def ElasticsearchIndexLifecycle(resource_name: str,
args: Optional[ElasticsearchIndexLifecycleArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchIndexLifecycle(resource_name: str,
opts: Optional[ResourceOptions] = None,
cold: Optional[ElasticsearchIndexLifecycleColdArgs] = None,
delete: Optional[ElasticsearchIndexLifecycleDeleteArgs] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchIndexLifecycleElasticsearchConnectionArgs]] = None,
force_destroy: Optional[bool] = None,
frozen: Optional[ElasticsearchIndexLifecycleFrozenArgs] = None,
hot: Optional[ElasticsearchIndexLifecycleHotArgs] = None,
metadata: Optional[str] = None,
name: Optional[str] = None,
warm: Optional[ElasticsearchIndexLifecycleWarmArgs] = None)func NewElasticsearchIndexLifecycle(ctx *Context, name string, args *ElasticsearchIndexLifecycleArgs, opts ...ResourceOption) (*ElasticsearchIndexLifecycle, error)public ElasticsearchIndexLifecycle(string name, ElasticsearchIndexLifecycleArgs? args = null, CustomResourceOptions? opts = null)
public ElasticsearchIndexLifecycle(String name, ElasticsearchIndexLifecycleArgs args)
public ElasticsearchIndexLifecycle(String name, ElasticsearchIndexLifecycleArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchIndexLifecycle
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "elasticstack_elasticsearchindexlifecycle" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ElasticsearchIndexLifecycleArgs
- 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 ElasticsearchIndexLifecycleArgs
- 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 ElasticsearchIndexLifecycleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchIndexLifecycleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchIndexLifecycleArgs
- 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 elasticsearchIndexLifecycleResource = new Elasticstack.ElasticsearchIndexLifecycle("elasticsearchIndexLifecycleResource", new()
{
Cold = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdArgs
{
Allocate = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdAllocateArgs
{
Exclude = "string",
Include = "string",
NumberOfReplicas = 0,
Require = "string",
TotalShardsPerNode = 0,
},
Downsample = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdDownsampleArgs
{
FixedInterval = "string",
WaitTimeout = "string",
},
Freeze = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdFreezeArgs
{
Enabled = false,
},
Migrate = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdMigrateArgs
{
Enabled = false,
},
MinAge = "string",
Readonly = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdReadonlyArgs
{
Enabled = false,
},
SearchableSnapshot = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdSearchableSnapshotArgs
{
ForceMergeIndex = false,
SnapshotRepository = "string",
},
SetPriority = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdSetPriorityArgs
{
Priority = 0,
},
Unfollow = new Elasticstack.Inputs.ElasticsearchIndexLifecycleColdUnfollowArgs
{
Enabled = false,
},
},
Delete = new Elasticstack.Inputs.ElasticsearchIndexLifecycleDeleteArgs
{
Delete = new Elasticstack.Inputs.ElasticsearchIndexLifecycleDeleteDeleteArgs
{
DeleteSearchableSnapshot = false,
},
MinAge = "string",
WaitForSnapshot = new Elasticstack.Inputs.ElasticsearchIndexLifecycleDeleteWaitForSnapshotArgs
{
Policy = "string",
},
},
ElasticsearchConnections = new[]
{
new Elasticstack.Inputs.ElasticsearchIndexLifecycleElasticsearchConnectionArgs
{
ApiKey = "string",
BearerToken = "string",
CaData = "string",
CaFile = "string",
CertData = "string",
CertFile = "string",
Endpoints = new[]
{
"string",
},
EsClientAuthentication = "string",
Headers =
{
{ "string", "string" },
},
Insecure = false,
KeyData = "string",
KeyFile = "string",
Password = "string",
Username = "string",
},
},
ForceDestroy = false,
Frozen = new Elasticstack.Inputs.ElasticsearchIndexLifecycleFrozenArgs
{
MinAge = "string",
SearchableSnapshot = new Elasticstack.Inputs.ElasticsearchIndexLifecycleFrozenSearchableSnapshotArgs
{
ForceMergeIndex = false,
SnapshotRepository = "string",
},
},
Hot = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotArgs
{
Downsample = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotDownsampleArgs
{
FixedInterval = "string",
WaitTimeout = "string",
},
Forcemerge = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotForcemergeArgs
{
IndexCodec = "string",
MaxNumSegments = 0,
},
MinAge = "string",
Readonly = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotReadonlyArgs
{
Enabled = false,
},
Rollover = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotRolloverArgs
{
MaxAge = "string",
MaxDocs = 0,
MaxPrimaryShardDocs = 0,
MaxPrimaryShardSize = "string",
MaxSize = "string",
MinAge = "string",
MinDocs = 0,
MinPrimaryShardDocs = 0,
MinPrimaryShardSize = "string",
MinSize = "string",
},
SearchableSnapshot = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotSearchableSnapshotArgs
{
ForceMergeIndex = false,
SnapshotRepository = "string",
},
SetPriority = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotSetPriorityArgs
{
Priority = 0,
},
Shrink = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotShrinkArgs
{
AllowWriteAfterShrink = false,
MaxPrimaryShardSize = "string",
NumberOfShards = 0,
},
Unfollow = new Elasticstack.Inputs.ElasticsearchIndexLifecycleHotUnfollowArgs
{
Enabled = false,
},
},
Metadata = "string",
Name = "string",
Warm = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmArgs
{
Allocate = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmAllocateArgs
{
Exclude = "string",
Include = "string",
NumberOfReplicas = 0,
Require = "string",
TotalShardsPerNode = 0,
},
Downsample = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmDownsampleArgs
{
FixedInterval = "string",
WaitTimeout = "string",
},
Forcemerge = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmForcemergeArgs
{
IndexCodec = "string",
MaxNumSegments = 0,
},
Migrate = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmMigrateArgs
{
Enabled = false,
},
MinAge = "string",
Readonly = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmReadonlyArgs
{
Enabled = false,
},
SetPriority = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmSetPriorityArgs
{
Priority = 0,
},
Shrink = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmShrinkArgs
{
AllowWriteAfterShrink = false,
MaxPrimaryShardSize = "string",
NumberOfShards = 0,
},
Unfollow = new Elasticstack.Inputs.ElasticsearchIndexLifecycleWarmUnfollowArgs
{
Enabled = false,
},
},
});
example, err := elasticstack.NewElasticsearchIndexLifecycle(ctx, "elasticsearchIndexLifecycleResource", &elasticstack.ElasticsearchIndexLifecycleArgs{
Cold: &elasticstack.ElasticsearchIndexLifecycleColdArgs{
Allocate: &elasticstack.ElasticsearchIndexLifecycleColdAllocateArgs{
Exclude: pulumi.String("string"),
Include: pulumi.String("string"),
NumberOfReplicas: pulumi.Float64(0),
Require: pulumi.String("string"),
TotalShardsPerNode: pulumi.Float64(0),
},
Downsample: &elasticstack.ElasticsearchIndexLifecycleColdDownsampleArgs{
FixedInterval: pulumi.String("string"),
WaitTimeout: pulumi.String("string"),
},
Freeze: &elasticstack.ElasticsearchIndexLifecycleColdFreezeArgs{
Enabled: pulumi.Bool(false),
},
Migrate: &elasticstack.ElasticsearchIndexLifecycleColdMigrateArgs{
Enabled: pulumi.Bool(false),
},
MinAge: pulumi.String("string"),
Readonly: &elasticstack.ElasticsearchIndexLifecycleColdReadonlyArgs{
Enabled: pulumi.Bool(false),
},
SearchableSnapshot: &elasticstack.ElasticsearchIndexLifecycleColdSearchableSnapshotArgs{
ForceMergeIndex: pulumi.Bool(false),
SnapshotRepository: pulumi.String("string"),
},
SetPriority: &elasticstack.ElasticsearchIndexLifecycleColdSetPriorityArgs{
Priority: pulumi.Float64(0),
},
Unfollow: &elasticstack.ElasticsearchIndexLifecycleColdUnfollowArgs{
Enabled: pulumi.Bool(false),
},
},
Delete: &elasticstack.ElasticsearchIndexLifecycleDeleteArgs{
Delete: &elasticstack.ElasticsearchIndexLifecycleDeleteDeleteArgs{
DeleteSearchableSnapshot: pulumi.Bool(false),
},
MinAge: pulumi.String("string"),
WaitForSnapshot: &elasticstack.ElasticsearchIndexLifecycleDeleteWaitForSnapshotArgs{
Policy: pulumi.String("string"),
},
},
ElasticsearchConnections: elasticstack.ElasticsearchIndexLifecycleElasticsearchConnectionArray{
&elasticstack.ElasticsearchIndexLifecycleElasticsearchConnectionArgs{
ApiKey: pulumi.String("string"),
BearerToken: pulumi.String("string"),
CaData: pulumi.String("string"),
CaFile: pulumi.String("string"),
CertData: pulumi.String("string"),
CertFile: pulumi.String("string"),
Endpoints: pulumi.StringArray{
pulumi.String("string"),
},
EsClientAuthentication: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
Insecure: pulumi.Bool(false),
KeyData: pulumi.String("string"),
KeyFile: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
},
ForceDestroy: pulumi.Bool(false),
Frozen: &elasticstack.ElasticsearchIndexLifecycleFrozenArgs{
MinAge: pulumi.String("string"),
SearchableSnapshot: &elasticstack.ElasticsearchIndexLifecycleFrozenSearchableSnapshotArgs{
ForceMergeIndex: pulumi.Bool(false),
SnapshotRepository: pulumi.String("string"),
},
},
Hot: &elasticstack.ElasticsearchIndexLifecycleHotArgs{
Downsample: &elasticstack.ElasticsearchIndexLifecycleHotDownsampleArgs{
FixedInterval: pulumi.String("string"),
WaitTimeout: pulumi.String("string"),
},
Forcemerge: &elasticstack.ElasticsearchIndexLifecycleHotForcemergeArgs{
IndexCodec: pulumi.String("string"),
MaxNumSegments: pulumi.Float64(0),
},
MinAge: pulumi.String("string"),
Readonly: &elasticstack.ElasticsearchIndexLifecycleHotReadonlyArgs{
Enabled: pulumi.Bool(false),
},
Rollover: &elasticstack.ElasticsearchIndexLifecycleHotRolloverArgs{
MaxAge: pulumi.String("string"),
MaxDocs: pulumi.Float64(0),
MaxPrimaryShardDocs: pulumi.Float64(0),
MaxPrimaryShardSize: pulumi.String("string"),
MaxSize: pulumi.String("string"),
MinAge: pulumi.String("string"),
MinDocs: pulumi.Float64(0),
MinPrimaryShardDocs: pulumi.Float64(0),
MinPrimaryShardSize: pulumi.String("string"),
MinSize: pulumi.String("string"),
},
SearchableSnapshot: &elasticstack.ElasticsearchIndexLifecycleHotSearchableSnapshotArgs{
ForceMergeIndex: pulumi.Bool(false),
SnapshotRepository: pulumi.String("string"),
},
SetPriority: &elasticstack.ElasticsearchIndexLifecycleHotSetPriorityArgs{
Priority: pulumi.Float64(0),
},
Shrink: &elasticstack.ElasticsearchIndexLifecycleHotShrinkArgs{
AllowWriteAfterShrink: pulumi.Bool(false),
MaxPrimaryShardSize: pulumi.String("string"),
NumberOfShards: pulumi.Float64(0),
},
Unfollow: &elasticstack.ElasticsearchIndexLifecycleHotUnfollowArgs{
Enabled: pulumi.Bool(false),
},
},
Metadata: pulumi.String("string"),
Name: pulumi.String("string"),
Warm: &elasticstack.ElasticsearchIndexLifecycleWarmArgs{
Allocate: &elasticstack.ElasticsearchIndexLifecycleWarmAllocateArgs{
Exclude: pulumi.String("string"),
Include: pulumi.String("string"),
NumberOfReplicas: pulumi.Float64(0),
Require: pulumi.String("string"),
TotalShardsPerNode: pulumi.Float64(0),
},
Downsample: &elasticstack.ElasticsearchIndexLifecycleWarmDownsampleArgs{
FixedInterval: pulumi.String("string"),
WaitTimeout: pulumi.String("string"),
},
Forcemerge: &elasticstack.ElasticsearchIndexLifecycleWarmForcemergeArgs{
IndexCodec: pulumi.String("string"),
MaxNumSegments: pulumi.Float64(0),
},
Migrate: &elasticstack.ElasticsearchIndexLifecycleWarmMigrateArgs{
Enabled: pulumi.Bool(false),
},
MinAge: pulumi.String("string"),
Readonly: &elasticstack.ElasticsearchIndexLifecycleWarmReadonlyArgs{
Enabled: pulumi.Bool(false),
},
SetPriority: &elasticstack.ElasticsearchIndexLifecycleWarmSetPriorityArgs{
Priority: pulumi.Float64(0),
},
Shrink: &elasticstack.ElasticsearchIndexLifecycleWarmShrinkArgs{
AllowWriteAfterShrink: pulumi.Bool(false),
MaxPrimaryShardSize: pulumi.String("string"),
NumberOfShards: pulumi.Float64(0),
},
Unfollow: &elasticstack.ElasticsearchIndexLifecycleWarmUnfollowArgs{
Enabled: pulumi.Bool(false),
},
},
})
resource "elasticstack_elasticsearchindexlifecycle" "elasticsearchIndexLifecycleResource" {
cold = {
allocate = {
exclude = "string"
include = "string"
number_of_replicas = 0
require = "string"
total_shards_per_node = 0
}
downsample = {
fixed_interval = "string"
wait_timeout = "string"
}
freeze = {
enabled = false
}
migrate = {
enabled = false
}
min_age = "string"
readonly = {
enabled = false
}
searchable_snapshot = {
force_merge_index = false
snapshot_repository = "string"
}
set_priority = {
priority = 0
}
unfollow = {
enabled = false
}
}
delete = {
delete = {
delete_searchable_snapshot = false
}
min_age = "string"
wait_for_snapshot = {
policy = "string"
}
}
elasticsearch_connections {
api_key = "string"
bearer_token = "string"
ca_data = "string"
ca_file = "string"
cert_data = "string"
cert_file = "string"
endpoints = ["string"]
es_client_authentication = "string"
headers = {
"string" = "string"
}
insecure = false
key_data = "string"
key_file = "string"
password = "string"
username = "string"
}
force_destroy = false
frozen = {
min_age = "string"
searchable_snapshot = {
force_merge_index = false
snapshot_repository = "string"
}
}
hot = {
downsample = {
fixed_interval = "string"
wait_timeout = "string"
}
forcemerge = {
index_codec = "string"
max_num_segments = 0
}
min_age = "string"
readonly = {
enabled = false
}
rollover = {
max_age = "string"
max_docs = 0
max_primary_shard_docs = 0
max_primary_shard_size = "string"
max_size = "string"
min_age = "string"
min_docs = 0
min_primary_shard_docs = 0
min_primary_shard_size = "string"
min_size = "string"
}
searchable_snapshot = {
force_merge_index = false
snapshot_repository = "string"
}
set_priority = {
priority = 0
}
shrink = {
allow_write_after_shrink = false
max_primary_shard_size = "string"
number_of_shards = 0
}
unfollow = {
enabled = false
}
}
metadata = "string"
name = "string"
warm = {
allocate = {
exclude = "string"
include = "string"
number_of_replicas = 0
require = "string"
total_shards_per_node = 0
}
downsample = {
fixed_interval = "string"
wait_timeout = "string"
}
forcemerge = {
index_codec = "string"
max_num_segments = 0
}
migrate = {
enabled = false
}
min_age = "string"
readonly = {
enabled = false
}
set_priority = {
priority = 0
}
shrink = {
allow_write_after_shrink = false
max_primary_shard_size = "string"
number_of_shards = 0
}
unfollow = {
enabled = false
}
}
}
var elasticsearchIndexLifecycleResource = new ElasticsearchIndexLifecycle("elasticsearchIndexLifecycleResource", ElasticsearchIndexLifecycleArgs.builder()
.cold(ElasticsearchIndexLifecycleColdArgs.builder()
.allocate(ElasticsearchIndexLifecycleColdAllocateArgs.builder()
.exclude("string")
.include("string")
.numberOfReplicas(0.0)
.require("string")
.totalShardsPerNode(0.0)
.build())
.downsample(ElasticsearchIndexLifecycleColdDownsampleArgs.builder()
.fixedInterval("string")
.waitTimeout("string")
.build())
.freeze(ElasticsearchIndexLifecycleColdFreezeArgs.builder()
.enabled(false)
.build())
.migrate(ElasticsearchIndexLifecycleColdMigrateArgs.builder()
.enabled(false)
.build())
.minAge("string")
.readonly(ElasticsearchIndexLifecycleColdReadonlyArgs.builder()
.enabled(false)
.build())
.searchableSnapshot(ElasticsearchIndexLifecycleColdSearchableSnapshotArgs.builder()
.forceMergeIndex(false)
.snapshotRepository("string")
.build())
.setPriority(ElasticsearchIndexLifecycleColdSetPriorityArgs.builder()
.priority(0.0)
.build())
.unfollow(ElasticsearchIndexLifecycleColdUnfollowArgs.builder()
.enabled(false)
.build())
.build())
.delete(ElasticsearchIndexLifecycleDeleteArgs.builder()
.delete(ElasticsearchIndexLifecycleDeleteDeleteArgs.builder()
.deleteSearchableSnapshot(false)
.build())
.minAge("string")
.waitForSnapshot(ElasticsearchIndexLifecycleDeleteWaitForSnapshotArgs.builder()
.policy("string")
.build())
.build())
.elasticsearchConnections(ElasticsearchIndexLifecycleElasticsearchConnectionArgs.builder()
.apiKey("string")
.bearerToken("string")
.caData("string")
.caFile("string")
.certData("string")
.certFile("string")
.endpoints("string")
.esClientAuthentication("string")
.headers(Map.of("string", "string"))
.insecure(false)
.keyData("string")
.keyFile("string")
.password("string")
.username("string")
.build())
.forceDestroy(false)
.frozen(ElasticsearchIndexLifecycleFrozenArgs.builder()
.minAge("string")
.searchableSnapshot(ElasticsearchIndexLifecycleFrozenSearchableSnapshotArgs.builder()
.forceMergeIndex(false)
.snapshotRepository("string")
.build())
.build())
.hot(ElasticsearchIndexLifecycleHotArgs.builder()
.downsample(ElasticsearchIndexLifecycleHotDownsampleArgs.builder()
.fixedInterval("string")
.waitTimeout("string")
.build())
.forcemerge(ElasticsearchIndexLifecycleHotForcemergeArgs.builder()
.indexCodec("string")
.maxNumSegments(0.0)
.build())
.minAge("string")
.readonly(ElasticsearchIndexLifecycleHotReadonlyArgs.builder()
.enabled(false)
.build())
.rollover(ElasticsearchIndexLifecycleHotRolloverArgs.builder()
.maxAge("string")
.maxDocs(0.0)
.maxPrimaryShardDocs(0.0)
.maxPrimaryShardSize("string")
.maxSize("string")
.minAge("string")
.minDocs(0.0)
.minPrimaryShardDocs(0.0)
.minPrimaryShardSize("string")
.minSize("string")
.build())
.searchableSnapshot(ElasticsearchIndexLifecycleHotSearchableSnapshotArgs.builder()
.forceMergeIndex(false)
.snapshotRepository("string")
.build())
.setPriority(ElasticsearchIndexLifecycleHotSetPriorityArgs.builder()
.priority(0.0)
.build())
.shrink(ElasticsearchIndexLifecycleHotShrinkArgs.builder()
.allowWriteAfterShrink(false)
.maxPrimaryShardSize("string")
.numberOfShards(0.0)
.build())
.unfollow(ElasticsearchIndexLifecycleHotUnfollowArgs.builder()
.enabled(false)
.build())
.build())
.metadata("string")
.name("string")
.warm(ElasticsearchIndexLifecycleWarmArgs.builder()
.allocate(ElasticsearchIndexLifecycleWarmAllocateArgs.builder()
.exclude("string")
.include("string")
.numberOfReplicas(0.0)
.require("string")
.totalShardsPerNode(0.0)
.build())
.downsample(ElasticsearchIndexLifecycleWarmDownsampleArgs.builder()
.fixedInterval("string")
.waitTimeout("string")
.build())
.forcemerge(ElasticsearchIndexLifecycleWarmForcemergeArgs.builder()
.indexCodec("string")
.maxNumSegments(0.0)
.build())
.migrate(ElasticsearchIndexLifecycleWarmMigrateArgs.builder()
.enabled(false)
.build())
.minAge("string")
.readonly(ElasticsearchIndexLifecycleWarmReadonlyArgs.builder()
.enabled(false)
.build())
.setPriority(ElasticsearchIndexLifecycleWarmSetPriorityArgs.builder()
.priority(0.0)
.build())
.shrink(ElasticsearchIndexLifecycleWarmShrinkArgs.builder()
.allowWriteAfterShrink(false)
.maxPrimaryShardSize("string")
.numberOfShards(0.0)
.build())
.unfollow(ElasticsearchIndexLifecycleWarmUnfollowArgs.builder()
.enabled(false)
.build())
.build())
.build());
elasticsearch_index_lifecycle_resource = elasticstack.ElasticsearchIndexLifecycle("elasticsearchIndexLifecycleResource",
cold={
"allocate": {
"exclude": "string",
"include": "string",
"number_of_replicas": float(0),
"require": "string",
"total_shards_per_node": float(0),
},
"downsample": {
"fixed_interval": "string",
"wait_timeout": "string",
},
"freeze": {
"enabled": False,
},
"migrate": {
"enabled": False,
},
"min_age": "string",
"readonly": {
"enabled": False,
},
"searchable_snapshot": {
"force_merge_index": False,
"snapshot_repository": "string",
},
"set_priority": {
"priority": float(0),
},
"unfollow": {
"enabled": False,
},
},
delete={
"delete": {
"delete_searchable_snapshot": False,
},
"min_age": "string",
"wait_for_snapshot": {
"policy": "string",
},
},
elasticsearch_connections=[{
"api_key": "string",
"bearer_token": "string",
"ca_data": "string",
"ca_file": "string",
"cert_data": "string",
"cert_file": "string",
"endpoints": ["string"],
"es_client_authentication": "string",
"headers": {
"string": "string",
},
"insecure": False,
"key_data": "string",
"key_file": "string",
"password": "string",
"username": "string",
}],
force_destroy=False,
frozen={
"min_age": "string",
"searchable_snapshot": {
"force_merge_index": False,
"snapshot_repository": "string",
},
},
hot={
"downsample": {
"fixed_interval": "string",
"wait_timeout": "string",
},
"forcemerge": {
"index_codec": "string",
"max_num_segments": float(0),
},
"min_age": "string",
"readonly": {
"enabled": False,
},
"rollover": {
"max_age": "string",
"max_docs": float(0),
"max_primary_shard_docs": float(0),
"max_primary_shard_size": "string",
"max_size": "string",
"min_age": "string",
"min_docs": float(0),
"min_primary_shard_docs": float(0),
"min_primary_shard_size": "string",
"min_size": "string",
},
"searchable_snapshot": {
"force_merge_index": False,
"snapshot_repository": "string",
},
"set_priority": {
"priority": float(0),
},
"shrink": {
"allow_write_after_shrink": False,
"max_primary_shard_size": "string",
"number_of_shards": float(0),
},
"unfollow": {
"enabled": False,
},
},
metadata="string",
name="string",
warm={
"allocate": {
"exclude": "string",
"include": "string",
"number_of_replicas": float(0),
"require": "string",
"total_shards_per_node": float(0),
},
"downsample": {
"fixed_interval": "string",
"wait_timeout": "string",
},
"forcemerge": {
"index_codec": "string",
"max_num_segments": float(0),
},
"migrate": {
"enabled": False,
},
"min_age": "string",
"readonly": {
"enabled": False,
},
"set_priority": {
"priority": float(0),
},
"shrink": {
"allow_write_after_shrink": False,
"max_primary_shard_size": "string",
"number_of_shards": float(0),
},
"unfollow": {
"enabled": False,
},
})
const elasticsearchIndexLifecycleResource = new elasticstack.ElasticsearchIndexLifecycle("elasticsearchIndexLifecycleResource", {
cold: {
allocate: {
exclude: "string",
include: "string",
numberOfReplicas: 0,
require: "string",
totalShardsPerNode: 0,
},
downsample: {
fixedInterval: "string",
waitTimeout: "string",
},
freeze: {
enabled: false,
},
migrate: {
enabled: false,
},
minAge: "string",
readonly: {
enabled: false,
},
searchableSnapshot: {
forceMergeIndex: false,
snapshotRepository: "string",
},
setPriority: {
priority: 0,
},
unfollow: {
enabled: false,
},
},
"delete": {
"delete": {
deleteSearchableSnapshot: false,
},
minAge: "string",
waitForSnapshot: {
policy: "string",
},
},
elasticsearchConnections: [{
apiKey: "string",
bearerToken: "string",
caData: "string",
caFile: "string",
certData: "string",
certFile: "string",
endpoints: ["string"],
esClientAuthentication: "string",
headers: {
string: "string",
},
insecure: false,
keyData: "string",
keyFile: "string",
password: "string",
username: "string",
}],
forceDestroy: false,
frozen: {
minAge: "string",
searchableSnapshot: {
forceMergeIndex: false,
snapshotRepository: "string",
},
},
hot: {
downsample: {
fixedInterval: "string",
waitTimeout: "string",
},
forcemerge: {
indexCodec: "string",
maxNumSegments: 0,
},
minAge: "string",
readonly: {
enabled: false,
},
rollover: {
maxAge: "string",
maxDocs: 0,
maxPrimaryShardDocs: 0,
maxPrimaryShardSize: "string",
maxSize: "string",
minAge: "string",
minDocs: 0,
minPrimaryShardDocs: 0,
minPrimaryShardSize: "string",
minSize: "string",
},
searchableSnapshot: {
forceMergeIndex: false,
snapshotRepository: "string",
},
setPriority: {
priority: 0,
},
shrink: {
allowWriteAfterShrink: false,
maxPrimaryShardSize: "string",
numberOfShards: 0,
},
unfollow: {
enabled: false,
},
},
metadata: "string",
name: "string",
warm: {
allocate: {
exclude: "string",
include: "string",
numberOfReplicas: 0,
require: "string",
totalShardsPerNode: 0,
},
downsample: {
fixedInterval: "string",
waitTimeout: "string",
},
forcemerge: {
indexCodec: "string",
maxNumSegments: 0,
},
migrate: {
enabled: false,
},
minAge: "string",
readonly: {
enabled: false,
},
setPriority: {
priority: 0,
},
shrink: {
allowWriteAfterShrink: false,
maxPrimaryShardSize: "string",
numberOfShards: 0,
},
unfollow: {
enabled: false,
},
},
});
type: elasticstack:ElasticsearchIndexLifecycle
properties:
cold:
allocate:
exclude: string
include: string
numberOfReplicas: 0
require: string
totalShardsPerNode: 0
downsample:
fixedInterval: string
waitTimeout: string
freeze:
enabled: false
migrate:
enabled: false
minAge: string
readonly:
enabled: false
searchableSnapshot:
forceMergeIndex: false
snapshotRepository: string
setPriority:
priority: 0
unfollow:
enabled: false
delete:
delete:
deleteSearchableSnapshot: false
minAge: string
waitForSnapshot:
policy: string
elasticsearchConnections:
- apiKey: string
bearerToken: string
caData: string
caFile: string
certData: string
certFile: string
endpoints:
- string
esClientAuthentication: string
headers:
string: string
insecure: false
keyData: string
keyFile: string
password: string
username: string
forceDestroy: false
frozen:
minAge: string
searchableSnapshot:
forceMergeIndex: false
snapshotRepository: string
hot:
downsample:
fixedInterval: string
waitTimeout: string
forcemerge:
indexCodec: string
maxNumSegments: 0
minAge: string
readonly:
enabled: false
rollover:
maxAge: string
maxDocs: 0
maxPrimaryShardDocs: 0
maxPrimaryShardSize: string
maxSize: string
minAge: string
minDocs: 0
minPrimaryShardDocs: 0
minPrimaryShardSize: string
minSize: string
searchableSnapshot:
forceMergeIndex: false
snapshotRepository: string
setPriority:
priority: 0
shrink:
allowWriteAfterShrink: false
maxPrimaryShardSize: string
numberOfShards: 0
unfollow:
enabled: false
metadata: string
name: string
warm:
allocate:
exclude: string
include: string
numberOfReplicas: 0
require: string
totalShardsPerNode: 0
downsample:
fixedInterval: string
waitTimeout: string
forcemerge:
indexCodec: string
maxNumSegments: 0
migrate:
enabled: false
minAge: string
readonly:
enabled: false
setPriority:
priority: 0
shrink:
allowWriteAfterShrink: false
maxPrimaryShardSize: string
numberOfShards: 0
unfollow:
enabled: false
ElasticsearchIndexLifecycle 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 ElasticsearchIndexLifecycle resource accepts the following input properties:
- Cold
Elasticsearch
Index Lifecycle Cold - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- Delete
Elasticsearch
Index Lifecycle Delete - The index is no longer needed and can safely be removed.
- Elasticsearch
Connections List<ElasticsearchIndex Lifecycle Elasticsearch Connection> - Elasticsearch connection configuration block.
- Force
Destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- Frozen
Elasticsearch
Index Lifecycle Frozen - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- Hot
Elasticsearch
Index Lifecycle Hot - The index is actively being updated and queried.
- Metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- Name string
- Identifier for the policy.
- Warm
Elasticsearch
Index Lifecycle Warm - The index is no longer being updated but is still being queried.
- Cold
Elasticsearch
Index Lifecycle Cold Args - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- Delete
Elasticsearch
Index Lifecycle Delete Args - The index is no longer needed and can safely be removed.
- Elasticsearch
Connections []ElasticsearchIndex Lifecycle Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Force
Destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- Frozen
Elasticsearch
Index Lifecycle Frozen Args - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- Hot
Elasticsearch
Index Lifecycle Hot Args - The index is actively being updated and queried.
- Metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- Name string
- Identifier for the policy.
- Warm
Elasticsearch
Index Lifecycle Warm Args - The index is no longer being updated but is still being queried.
- cold object
- The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete object
- The index is no longer needed and can safely be removed.
- elasticsearch_
connections list(object) - Elasticsearch connection configuration block.
- force_
destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen object
- The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot object
- The index is actively being updated and queried.
- metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- name string
- Identifier for the policy.
- warm object
- The index is no longer being updated but is still being queried.
- cold
Elasticsearch
Index Lifecycle Cold - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete
Elasticsearch
Index Lifecycle Delete - The index is no longer needed and can safely be removed.
- elasticsearch
Connections List<ElasticsearchIndex Lifecycle Elasticsearch Connection> - Elasticsearch connection configuration block.
- force
Destroy Boolean - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen
Elasticsearch
Index Lifecycle Frozen - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot
Elasticsearch
Index Lifecycle Hot - The index is actively being updated and queried.
- metadata String
- Optional user metadata about the ilm policy. Must be valid JSON document.
- name String
- Identifier for the policy.
- warm
Elasticsearch
Index Lifecycle Warm - The index is no longer being updated but is still being queried.
- cold
Elasticsearch
Index Lifecycle Cold - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete
Elasticsearch
Index Lifecycle Delete - The index is no longer needed and can safely be removed.
- elasticsearch
Connections ElasticsearchIndex Lifecycle Elasticsearch Connection[] - Elasticsearch connection configuration block.
- force
Destroy boolean - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen
Elasticsearch
Index Lifecycle Frozen - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot
Elasticsearch
Index Lifecycle Hot - The index is actively being updated and queried.
- metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- name string
- Identifier for the policy.
- warm
Elasticsearch
Index Lifecycle Warm - The index is no longer being updated but is still being queried.
- cold
Elasticsearch
Index Lifecycle Cold Args - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete
Elasticsearch
Index Lifecycle Delete Args - The index is no longer needed and can safely be removed.
- elasticsearch_
connections Sequence[ElasticsearchIndex Lifecycle Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- force_
destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen
Elasticsearch
Index Lifecycle Frozen Args - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot
Elasticsearch
Index Lifecycle Hot Args - The index is actively being updated and queried.
- metadata str
- Optional user metadata about the ilm policy. Must be valid JSON document.
- name str
- Identifier for the policy.
- warm
Elasticsearch
Index Lifecycle Warm Args - The index is no longer being updated but is still being queried.
- cold Property Map
- The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete Property Map
- The index is no longer needed and can safely be removed.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- force
Destroy Boolean - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen Property Map
- The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot Property Map
- The index is actively being updated and queried.
- metadata String
- Optional user metadata about the ilm policy. Must be valid JSON document.
- name String
- Identifier for the policy.
- warm Property Map
- The index is no longer being updated but is still being queried.
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchIndexLifecycle resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Modified
Date string - The DateTime of the last modification.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modified
Date string - The DateTime of the last modification.
- id string
- The provider-assigned unique ID for this managed resource.
- modified_
date string - The DateTime of the last modification.
- id String
- The provider-assigned unique ID for this managed resource.
- modified
Date String - The DateTime of the last modification.
- id string
- The provider-assigned unique ID for this managed resource.
- modified
Date string - The DateTime of the last modification.
- id str
- The provider-assigned unique ID for this managed resource.
- modified_
date str - The DateTime of the last modification.
- id String
- The provider-assigned unique ID for this managed resource.
- modified
Date String - The DateTime of the last modification.
Look up Existing ElasticsearchIndexLifecycle Resource
Get an existing ElasticsearchIndexLifecycle 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?: ElasticsearchIndexLifecycleState, opts?: CustomResourceOptions): ElasticsearchIndexLifecycle@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cold: Optional[ElasticsearchIndexLifecycleColdArgs] = None,
delete: Optional[ElasticsearchIndexLifecycleDeleteArgs] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchIndexLifecycleElasticsearchConnectionArgs]] = None,
force_destroy: Optional[bool] = None,
frozen: Optional[ElasticsearchIndexLifecycleFrozenArgs] = None,
hot: Optional[ElasticsearchIndexLifecycleHotArgs] = None,
metadata: Optional[str] = None,
modified_date: Optional[str] = None,
name: Optional[str] = None,
warm: Optional[ElasticsearchIndexLifecycleWarmArgs] = None) -> ElasticsearchIndexLifecyclefunc GetElasticsearchIndexLifecycle(ctx *Context, name string, id IDInput, state *ElasticsearchIndexLifecycleState, opts ...ResourceOption) (*ElasticsearchIndexLifecycle, error)public static ElasticsearchIndexLifecycle Get(string name, Input<string> id, ElasticsearchIndexLifecycleState? state, CustomResourceOptions? opts = null)public static ElasticsearchIndexLifecycle get(String name, Output<String> id, ElasticsearchIndexLifecycleState state, CustomResourceOptions options)resources: _: type: elasticstack:ElasticsearchIndexLifecycle get: id: ${id}import {
to = elasticstack_elasticsearchindexlifecycle.example
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.
- Cold
Elasticsearch
Index Lifecycle Cold - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- Delete
Elasticsearch
Index Lifecycle Delete - The index is no longer needed and can safely be removed.
- Elasticsearch
Connections List<ElasticsearchIndex Lifecycle Elasticsearch Connection> - Elasticsearch connection configuration block.
- Force
Destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- Frozen
Elasticsearch
Index Lifecycle Frozen - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- Hot
Elasticsearch
Index Lifecycle Hot - The index is actively being updated and queried.
- Metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- Modified
Date string - The DateTime of the last modification.
- Name string
- Identifier for the policy.
- Warm
Elasticsearch
Index Lifecycle Warm - The index is no longer being updated but is still being queried.
- Cold
Elasticsearch
Index Lifecycle Cold Args - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- Delete
Elasticsearch
Index Lifecycle Delete Args - The index is no longer needed and can safely be removed.
- Elasticsearch
Connections []ElasticsearchIndex Lifecycle Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Force
Destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- Frozen
Elasticsearch
Index Lifecycle Frozen Args - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- Hot
Elasticsearch
Index Lifecycle Hot Args - The index is actively being updated and queried.
- Metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- Modified
Date string - The DateTime of the last modification.
- Name string
- Identifier for the policy.
- Warm
Elasticsearch
Index Lifecycle Warm Args - The index is no longer being updated but is still being queried.
- cold object
- The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete object
- The index is no longer needed and can safely be removed.
- elasticsearch_
connections list(object) - Elasticsearch connection configuration block.
- force_
destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen object
- The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot object
- The index is actively being updated and queried.
- metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- modified_
date string - The DateTime of the last modification.
- name string
- Identifier for the policy.
- warm object
- The index is no longer being updated but is still being queried.
- cold
Elasticsearch
Index Lifecycle Cold - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete
Elasticsearch
Index Lifecycle Delete - The index is no longer needed and can safely be removed.
- elasticsearch
Connections List<ElasticsearchIndex Lifecycle Elasticsearch Connection> - Elasticsearch connection configuration block.
- force
Destroy Boolean - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen
Elasticsearch
Index Lifecycle Frozen - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot
Elasticsearch
Index Lifecycle Hot - The index is actively being updated and queried.
- metadata String
- Optional user metadata about the ilm policy. Must be valid JSON document.
- modified
Date String - The DateTime of the last modification.
- name String
- Identifier for the policy.
- warm
Elasticsearch
Index Lifecycle Warm - The index is no longer being updated but is still being queried.
- cold
Elasticsearch
Index Lifecycle Cold - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete
Elasticsearch
Index Lifecycle Delete - The index is no longer needed and can safely be removed.
- elasticsearch
Connections ElasticsearchIndex Lifecycle Elasticsearch Connection[] - Elasticsearch connection configuration block.
- force
Destroy boolean - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen
Elasticsearch
Index Lifecycle Frozen - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot
Elasticsearch
Index Lifecycle Hot - The index is actively being updated and queried.
- metadata string
- Optional user metadata about the ilm policy. Must be valid JSON document.
- modified
Date string - The DateTime of the last modification.
- name string
- Identifier for the policy.
- warm
Elasticsearch
Index Lifecycle Warm - The index is no longer being updated but is still being queried.
- cold
Elasticsearch
Index Lifecycle Cold Args - The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete
Elasticsearch
Index Lifecycle Delete Args - The index is no longer needed and can safely be removed.
- elasticsearch_
connections Sequence[ElasticsearchIndex Lifecycle Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- force_
destroy bool - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen
Elasticsearch
Index Lifecycle Frozen Args - The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot
Elasticsearch
Index Lifecycle Hot Args - The index is actively being updated and queried.
- metadata str
- Optional user metadata about the ilm policy. Must be valid JSON document.
- modified_
date str - The DateTime of the last modification.
- name str
- Identifier for the policy.
- warm
Elasticsearch
Index Lifecycle Warm Args - The index is no longer being updated but is still being queried.
- cold Property Map
- The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it is okay if those queries are slower.
- delete Property Map
- The index is no longer needed and can safely be removed.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- force
Destroy Boolean - When true, the provider will clear index.lifecycle.name from any indices that reference this policy before deleting the policy.
- frozen Property Map
- The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it is okay if those queries are extremely slow.
- hot Property Map
- The index is actively being updated and queried.
- metadata String
- Optional user metadata about the ilm policy. Must be valid JSON document.
- modified
Date String - The DateTime of the last modification.
- name String
- Identifier for the policy.
- warm Property Map
- The index is no longer being updated but is still being queried.
Supporting Types
ElasticsearchIndexLifecycleCold, ElasticsearchIndexLifecycleColdArgs
- Allocate
Elasticsearch
Index Lifecycle Cold Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- Downsample
Elasticsearch
Index Lifecycle Cold Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- Freeze
Elasticsearch
Index Lifecycle Cold Freeze - Freeze the index to minimize its memory footprint.
- Migrate
Elasticsearch
Index Lifecycle Cold Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Readonly
Elasticsearch
Index Lifecycle Cold Readonly - Makes the index read-only.
- Searchable
Snapshot ElasticsearchIndex Lifecycle Cold Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- Set
Priority ElasticsearchIndex Lifecycle Cold Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- Unfollow
Elasticsearch
Index Lifecycle Cold Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- Allocate
Elasticsearch
Index Lifecycle Cold Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- Downsample
Elasticsearch
Index Lifecycle Cold Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- Freeze
Elasticsearch
Index Lifecycle Cold Freeze - Freeze the index to minimize its memory footprint.
- Migrate
Elasticsearch
Index Lifecycle Cold Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Readonly
Elasticsearch
Index Lifecycle Cold Readonly - Makes the index read-only.
- Searchable
Snapshot ElasticsearchIndex Lifecycle Cold Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- Set
Priority ElasticsearchIndex Lifecycle Cold Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- Unfollow
Elasticsearch
Index Lifecycle Cold Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate object
- Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample object
- Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- freeze object
- Freeze the index to minimize its memory footprint.
- migrate object
- Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min_
age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly object
- Makes the index read-only.
- searchable_
snapshot object - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set_
priority object - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- unfollow object
- Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate
Elasticsearch
Index Lifecycle Cold Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample
Elasticsearch
Index Lifecycle Cold Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- freeze
Elasticsearch
Index Lifecycle Cold Freeze - Freeze the index to minimize its memory footprint.
- migrate
Elasticsearch
Index Lifecycle Cold Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Cold Readonly - Makes the index read-only.
- searchable
Snapshot ElasticsearchIndex Lifecycle Cold Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set
Priority ElasticsearchIndex Lifecycle Cold Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- unfollow
Elasticsearch
Index Lifecycle Cold Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate
Elasticsearch
Index Lifecycle Cold Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample
Elasticsearch
Index Lifecycle Cold Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- freeze
Elasticsearch
Index Lifecycle Cold Freeze - Freeze the index to minimize its memory footprint.
- migrate
Elasticsearch
Index Lifecycle Cold Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Cold Readonly - Makes the index read-only.
- searchable
Snapshot ElasticsearchIndex Lifecycle Cold Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set
Priority ElasticsearchIndex Lifecycle Cold Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- unfollow
Elasticsearch
Index Lifecycle Cold Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate
Elasticsearch
Index Lifecycle Cold Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample
Elasticsearch
Index Lifecycle Cold Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- freeze
Elasticsearch
Index Lifecycle Cold Freeze - Freeze the index to minimize its memory footprint.
- migrate
Elasticsearch
Index Lifecycle Cold Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min_
age str - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Cold Readonly - Makes the index read-only.
- searchable_
snapshot ElasticsearchIndex Lifecycle Cold Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set_
priority ElasticsearchIndex Lifecycle Cold Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- unfollow
Elasticsearch
Index Lifecycle Cold Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate Property Map
- Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample Property Map
- Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- freeze Property Map
- Freeze the index to minimize its memory footprint.
- migrate Property Map
- Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly Property Map
- Makes the index read-only.
- searchable
Snapshot Property Map - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set
Priority Property Map - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- unfollow Property Map
- Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
ElasticsearchIndexLifecycleColdAllocate, ElasticsearchIndexLifecycleColdAllocateArgs
- Exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- Include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- Number
Of doubleReplicas - Number of replicas to assign to the index. Default:
0 - Require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- Total
Shards doublePer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- Exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- Include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- Number
Of float64Replicas - Number of replicas to assign to the index. Default:
0 - Require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- Total
Shards float64Per Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number_
of_ numberreplicas - Number of replicas to assign to the index. Default:
0 - require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total_
shards_ numberper_ node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude String
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include String
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number
Of DoubleReplicas - Number of replicas to assign to the index. Default:
0 - require String
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total
Shards DoublePer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number
Of numberReplicas - Number of replicas to assign to the index. Default:
0 - require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total
Shards numberPer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude str
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include str
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number_
of_ floatreplicas - Number of replicas to assign to the index. Default:
0 - require str
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total_
shards_ floatper_ node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude String
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include String
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number
Of NumberReplicas - Number of replicas to assign to the index. Default:
0 - require String
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total
Shards NumberPer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
ElasticsearchIndexLifecycleColdDownsample, ElasticsearchIndexLifecycleColdDownsampleArgs
- Fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - Wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- Fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - Wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed_
interval string - Downsampling interval. Required when the
downsampleaction is configured. - wait_
timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval String - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout String - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed_
interval str - Downsampling interval. Required when the
downsampleaction is configured. - wait_
timeout str - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval String - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout String - Maximum time to wait for the downsample operation to complete before timing out.
ElasticsearchIndexLifecycleColdFreeze, ElasticsearchIndexLifecycleColdFreezeArgs
- Enabled bool
- Controls whether ILM freezes the index.
- Enabled bool
- Controls whether ILM freezes the index.
- enabled bool
- Controls whether ILM freezes the index.
- enabled Boolean
- Controls whether ILM freezes the index.
- enabled boolean
- Controls whether ILM freezes the index.
- enabled bool
- Controls whether ILM freezes the index.
- enabled Boolean
- Controls whether ILM freezes the index.
ElasticsearchIndexLifecycleColdMigrate, ElasticsearchIndexLifecycleColdMigrateArgs
- Enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- Enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- enabled Boolean
- Controls whether ILM automatically migrates the index during this phase.
- enabled boolean
- Controls whether ILM automatically migrates the index during this phase.
- enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- enabled Boolean
- Controls whether ILM automatically migrates the index during this phase.
ElasticsearchIndexLifecycleColdReadonly, ElasticsearchIndexLifecycleColdReadonlyArgs
- Enabled bool
- Controls whether ILM makes the index read-only.
- Enabled bool
- Controls whether ILM makes the index read-only.
- enabled bool
- Controls whether ILM makes the index read-only.
- enabled Boolean
- Controls whether ILM makes the index read-only.
- enabled boolean
- Controls whether ILM makes the index read-only.
- enabled bool
- Controls whether ILM makes the index read-only.
- enabled Boolean
- Controls whether ILM makes the index read-only.
ElasticsearchIndexLifecycleColdSearchableSnapshot, ElasticsearchIndexLifecycleColdSearchableSnapshotArgs
- Force
Merge boolIndex - Force merges the managed index to one segment.
- Snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- Force
Merge boolIndex - Force merges the managed index to one segment.
- Snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force_
merge_ boolindex - Force merges the managed index to one segment.
- snapshot_
repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge BooleanIndex - Force merges the managed index to one segment.
- snapshot
Repository String - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge booleanIndex - Force merges the managed index to one segment.
- snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force_
merge_ boolindex - Force merges the managed index to one segment.
- snapshot_
repository str - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge BooleanIndex - Force merges the managed index to one segment.
- snapshot
Repository String - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
ElasticsearchIndexLifecycleColdSetPriority, ElasticsearchIndexLifecycleColdSetPriorityArgs
- Priority double
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- Priority float64
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority Double
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority float
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority Number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
ElasticsearchIndexLifecycleColdUnfollow, ElasticsearchIndexLifecycleColdUnfollowArgs
- Enabled bool
- Controls whether ILM makes the follower index a regular one.
- Enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled Boolean
- Controls whether ILM makes the follower index a regular one.
- enabled boolean
- Controls whether ILM makes the follower index a regular one.
- enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled Boolean
- Controls whether ILM makes the follower index a regular one.
ElasticsearchIndexLifecycleDelete, ElasticsearchIndexLifecycleDeleteArgs
- Delete
Elasticsearch
Index Lifecycle Delete Delete - Permanently removes the index.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Wait
For ElasticsearchSnapshot Index Lifecycle Delete Wait For Snapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
- Delete
Elasticsearch
Index Lifecycle Delete Delete - Permanently removes the index.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Wait
For ElasticsearchSnapshot Index Lifecycle Delete Wait For Snapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
- delete object
- Permanently removes the index.
- min_
age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- wait_
for_ objectsnapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
- delete
Elasticsearch
Index Lifecycle Delete Delete - Permanently removes the index.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- wait
For ElasticsearchSnapshot Index Lifecycle Delete Wait For Snapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
- delete
Elasticsearch
Index Lifecycle Delete Delete - Permanently removes the index.
- min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- wait
For ElasticsearchSnapshot Index Lifecycle Delete Wait For Snapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
- delete
Elasticsearch
Index Lifecycle Delete Delete - Permanently removes the index.
- min_
age str - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- wait_
for_ Elasticsearchsnapshot Index Lifecycle Delete Wait For Snapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
- delete Property Map
- Permanently removes the index.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- wait
For Property MapSnapshot - Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.
ElasticsearchIndexLifecycleDeleteDelete, ElasticsearchIndexLifecycleDeleteDeleteArgs
- Delete
Searchable boolSnapshot - Deletes the searchable snapshot created in a previous phase.
- Delete
Searchable boolSnapshot - Deletes the searchable snapshot created in a previous phase.
- delete_
searchable_ boolsnapshot - Deletes the searchable snapshot created in a previous phase.
- delete
Searchable BooleanSnapshot - Deletes the searchable snapshot created in a previous phase.
- delete
Searchable booleanSnapshot - Deletes the searchable snapshot created in a previous phase.
- delete_
searchable_ boolsnapshot - Deletes the searchable snapshot created in a previous phase.
- delete
Searchable BooleanSnapshot - Deletes the searchable snapshot created in a previous phase.
ElasticsearchIndexLifecycleDeleteWaitForSnapshot, ElasticsearchIndexLifecycleDeleteWaitForSnapshotArgs
- Policy string
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
- Policy string
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
- policy string
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
- policy String
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
- policy string
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
- policy str
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
- policy String
- Name of the SLM policy that the delete action should wait for. Required when the
wait_for_snapshotaction is configured.
ElasticsearchIndexLifecycleElasticsearchConnection, ElasticsearchIndexLifecycleElasticsearchConnectionArgs
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints List<string>
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Headers Dictionary<string, string>
- A list of headers to be sent with each request to Elasticsearch.
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints []string
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Headers map[string]string
- A list of headers to be sent with each request to Elasticsearch.
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- api_
key string - API Key to use for authentication to Elasticsearch
- bearer_
token string - Bearer Token to use for authentication to Elasticsearch
- ca_
data string - PEM-encoded custom Certificate Authority certificate
- ca_
file string - Path to a custom Certificate Authority certificate
- cert_
data string - PEM encoded certificate for client auth
- cert_
file string - Path to a file containing the PEM encoded certificate for client auth
- endpoints list(string)
- es_
client_ stringauthentication - ES Client Authentication field to be used with the JWT token
- headers map(string)
- A list of headers to be sent with each request to Elasticsearch.
- insecure bool
- Disable TLS certificate validation
- key_
data string - PEM encoded private key for client auth
- key_
file string - Path to a file containing the PEM encoded private key for client auth
- password string
- Password to use for API authentication to Elasticsearch.
- username string
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- headers Map<String,String>
- A list of headers to be sent with each request to Elasticsearch.
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
- api
Key string - API Key to use for authentication to Elasticsearch
- bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- ca
Data string - PEM-encoded custom Certificate Authority certificate
- ca
File string - Path to a custom Certificate Authority certificate
- cert
Data string - PEM encoded certificate for client auth
- cert
File string - Path to a file containing the PEM encoded certificate for client auth
- endpoints string[]
- es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- headers {[key: string]: string}
- A list of headers to be sent with each request to Elasticsearch.
- insecure boolean
- Disable TLS certificate validation
- key
Data string - PEM encoded private key for client auth
- key
File string - Path to a file containing the PEM encoded private key for client auth
- password string
- Password to use for API authentication to Elasticsearch.
- username string
- Username to use for API authentication to Elasticsearch.
- api_
key str - API Key to use for authentication to Elasticsearch
- bearer_
token str - Bearer Token to use for authentication to Elasticsearch
- ca_
data str - PEM-encoded custom Certificate Authority certificate
- ca_
file str - Path to a custom Certificate Authority certificate
- cert_
data str - PEM encoded certificate for client auth
- cert_
file str - Path to a file containing the PEM encoded certificate for client auth
- endpoints Sequence[str]
- es_
client_ strauthentication - ES Client Authentication field to be used with the JWT token
- headers Mapping[str, str]
- A list of headers to be sent with each request to Elasticsearch.
- insecure bool
- Disable TLS certificate validation
- key_
data str - PEM encoded private key for client auth
- key_
file str - Path to a file containing the PEM encoded private key for client auth
- password str
- Password to use for API authentication to Elasticsearch.
- username str
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- headers Map<String>
- A list of headers to be sent with each request to Elasticsearch.
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
ElasticsearchIndexLifecycleFrozen, ElasticsearchIndexLifecycleFrozenArgs
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Searchable
Snapshot ElasticsearchIndex Lifecycle Frozen Searchable Snapshot - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Searchable
Snapshot ElasticsearchIndex Lifecycle Frozen Searchable Snapshot - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- min_
age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- searchable_
snapshot object - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- searchable
Snapshot ElasticsearchIndex Lifecycle Frozen Searchable Snapshot - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- searchable
Snapshot ElasticsearchIndex Lifecycle Frozen Searchable Snapshot - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- min_
age str - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- searchable_
snapshot ElasticsearchIndex Lifecycle Frozen Searchable Snapshot - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- searchable
Snapshot Property Map - Required in the
frozenphase. Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
ElasticsearchIndexLifecycleFrozenSearchableSnapshot, ElasticsearchIndexLifecycleFrozenSearchableSnapshotArgs
- Force
Merge boolIndex - Force merges the managed index to one segment.
- Snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- Force
Merge boolIndex - Force merges the managed index to one segment.
- Snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force_
merge_ boolindex - Force merges the managed index to one segment.
- snapshot_
repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge BooleanIndex - Force merges the managed index to one segment.
- snapshot
Repository String - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge booleanIndex - Force merges the managed index to one segment.
- snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force_
merge_ boolindex - Force merges the managed index to one segment.
- snapshot_
repository str - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge BooleanIndex - Force merges the managed index to one segment.
- snapshot
Repository String - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
ElasticsearchIndexLifecycleHot, ElasticsearchIndexLifecycleHotArgs
- Downsample
Elasticsearch
Index Lifecycle Hot Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- Forcemerge
Elasticsearch
Index Lifecycle Hot Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Readonly
Elasticsearch
Index Lifecycle Hot Readonly - Makes the index read-only.
- Rollover
Elasticsearch
Index Lifecycle Hot Rollover - Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- Searchable
Snapshot ElasticsearchIndex Lifecycle Hot Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- Set
Priority ElasticsearchIndex Lifecycle Hot Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- Shrink
Elasticsearch
Index Lifecycle Hot Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- Unfollow
Elasticsearch
Index Lifecycle Hot Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- Downsample
Elasticsearch
Index Lifecycle Hot Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- Forcemerge
Elasticsearch
Index Lifecycle Hot Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Readonly
Elasticsearch
Index Lifecycle Hot Readonly - Makes the index read-only.
- Rollover
Elasticsearch
Index Lifecycle Hot Rollover - Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- Searchable
Snapshot ElasticsearchIndex Lifecycle Hot Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- Set
Priority ElasticsearchIndex Lifecycle Hot Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- Shrink
Elasticsearch
Index Lifecycle Hot Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- Unfollow
Elasticsearch
Index Lifecycle Hot Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- downsample object
- Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge object
- Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- min_
age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly object
- Makes the index read-only.
- rollover object
- Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- searchable_
snapshot object - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set_
priority object - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink object
- Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow object
- Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- downsample
Elasticsearch
Index Lifecycle Hot Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge
Elasticsearch
Index Lifecycle Hot Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Hot Readonly - Makes the index read-only.
- rollover
Elasticsearch
Index Lifecycle Hot Rollover - Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- searchable
Snapshot ElasticsearchIndex Lifecycle Hot Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set
Priority ElasticsearchIndex Lifecycle Hot Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink
Elasticsearch
Index Lifecycle Hot Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow
Elasticsearch
Index Lifecycle Hot Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- downsample
Elasticsearch
Index Lifecycle Hot Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge
Elasticsearch
Index Lifecycle Hot Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Hot Readonly - Makes the index read-only.
- rollover
Elasticsearch
Index Lifecycle Hot Rollover - Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- searchable
Snapshot ElasticsearchIndex Lifecycle Hot Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set
Priority ElasticsearchIndex Lifecycle Hot Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink
Elasticsearch
Index Lifecycle Hot Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow
Elasticsearch
Index Lifecycle Hot Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- downsample
Elasticsearch
Index Lifecycle Hot Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge
Elasticsearch
Index Lifecycle Hot Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- min_
age str - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Hot Readonly - Makes the index read-only.
- rollover
Elasticsearch
Index Lifecycle Hot Rollover - Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- searchable_
snapshot ElasticsearchIndex Lifecycle Hot Searchable Snapshot - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set_
priority ElasticsearchIndex Lifecycle Hot Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink
Elasticsearch
Index Lifecycle Hot Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow
Elasticsearch
Index Lifecycle Hot Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- downsample Property Map
- Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge Property Map
- Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly Property Map
- Makes the index read-only.
- rollover Property Map
- Rolls over a target to a new index when the existing index meets one or more of the rollover conditions.
- searchable
Snapshot Property Map - Takes a snapshot of the managed index in the configured repository and mounts it as a searchable snapshot.
- set
Priority Property Map - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink Property Map
- Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow Property Map
- Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
ElasticsearchIndexLifecycleHotDownsample, ElasticsearchIndexLifecycleHotDownsampleArgs
- Fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - Wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- Fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - Wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed_
interval string - Downsampling interval. Required when the
downsampleaction is configured. - wait_
timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval String - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout String - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed_
interval str - Downsampling interval. Required when the
downsampleaction is configured. - wait_
timeout str - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval String - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout String - Maximum time to wait for the downsample operation to complete before timing out.
ElasticsearchIndexLifecycleHotForcemerge, ElasticsearchIndexLifecycleHotForcemergeArgs
- Index
Codec string - Codec used to compress the document store.
- Max
Num doubleSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- Index
Codec string - Codec used to compress the document store.
- Max
Num float64Segments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index_
codec string - Codec used to compress the document store.
- max_
num_ numbersegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index
Codec String - Codec used to compress the document store.
- max
Num DoubleSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index
Codec string - Codec used to compress the document store.
- max
Num numberSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index_
codec str - Codec used to compress the document store.
- max_
num_ floatsegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index
Codec String - Codec used to compress the document store.
- max
Num NumberSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
ElasticsearchIndexLifecycleHotReadonly, ElasticsearchIndexLifecycleHotReadonlyArgs
- Enabled bool
- Controls whether ILM makes the index read-only.
- Enabled bool
- Controls whether ILM makes the index read-only.
- enabled bool
- Controls whether ILM makes the index read-only.
- enabled Boolean
- Controls whether ILM makes the index read-only.
- enabled boolean
- Controls whether ILM makes the index read-only.
- enabled bool
- Controls whether ILM makes the index read-only.
- enabled Boolean
- Controls whether ILM makes the index read-only.
ElasticsearchIndexLifecycleHotRollover, ElasticsearchIndexLifecycleHotRolloverArgs
- Max
Age string - Triggers rollover after the maximum elapsed time from index creation is reached.
- Max
Docs double - Triggers rollover after the specified maximum number of documents is reached.
- Max
Primary doubleShard Docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- Max
Primary stringShard Size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- Max
Size string - Triggers rollover when the index reaches a certain size.
- Min
Age string - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- Min
Docs double - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- Min
Primary doubleShard Docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- Min
Primary stringShard Size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- Min
Size string - Prevents rollover until the index reaches a certain size.
- Max
Age string - Triggers rollover after the maximum elapsed time from index creation is reached.
- Max
Docs float64 - Triggers rollover after the specified maximum number of documents is reached.
- Max
Primary float64Shard Docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- Max
Primary stringShard Size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- Max
Size string - Triggers rollover when the index reaches a certain size.
- Min
Age string - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- Min
Docs float64 - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- Min
Primary float64Shard Docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- Min
Primary stringShard Size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- Min
Size string - Prevents rollover until the index reaches a certain size.
- max_
age string - Triggers rollover after the maximum elapsed time from index creation is reached.
- max_
docs number - Triggers rollover after the specified maximum number of documents is reached.
- max_
primary_ numbershard_ docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- max_
primary_ stringshard_ size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- max_
size string - Triggers rollover when the index reaches a certain size.
- min_
age string - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- min_
docs number - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- min_
primary_ numbershard_ docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- min_
primary_ stringshard_ size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- min_
size string - Prevents rollover until the index reaches a certain size.
- max
Age String - Triggers rollover after the maximum elapsed time from index creation is reached.
- max
Docs Double - Triggers rollover after the specified maximum number of documents is reached.
- max
Primary DoubleShard Docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- max
Primary StringShard Size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- max
Size String - Triggers rollover when the index reaches a certain size.
- min
Age String - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- min
Docs Double - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- min
Primary DoubleShard Docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- min
Primary StringShard Size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- min
Size String - Prevents rollover until the index reaches a certain size.
- max
Age string - Triggers rollover after the maximum elapsed time from index creation is reached.
- max
Docs number - Triggers rollover after the specified maximum number of documents is reached.
- max
Primary numberShard Docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- max
Primary stringShard Size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- max
Size string - Triggers rollover when the index reaches a certain size.
- min
Age string - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- min
Docs number - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- min
Primary numberShard Docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- min
Primary stringShard Size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- min
Size string - Prevents rollover until the index reaches a certain size.
- max_
age str - Triggers rollover after the maximum elapsed time from index creation is reached.
- max_
docs float - Triggers rollover after the specified maximum number of documents is reached.
- max_
primary_ floatshard_ docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- max_
primary_ strshard_ size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- max_
size str - Triggers rollover when the index reaches a certain size.
- min_
age str - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- min_
docs float - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- min_
primary_ floatshard_ docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- min_
primary_ strshard_ size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- min_
size str - Prevents rollover until the index reaches a certain size.
- max
Age String - Triggers rollover after the maximum elapsed time from index creation is reached.
- max
Docs Number - Triggers rollover after the specified maximum number of documents is reached.
- max
Primary NumberShard Docs - Triggers rollover when the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.2
- max
Primary StringShard Size - Triggers rollover when the largest primary shard in the index reaches a certain size.
- max
Size String - Triggers rollover when the index reaches a certain size.
- min
Age String - Prevents rollover until after the minimum elapsed time from index creation is reached. Supported from Elasticsearch version 8.4
- min
Docs Number - Prevents rollover until after the specified minimum number of documents is reached. Supported from Elasticsearch version 8.4
- min
Primary NumberShard Docs - Prevents rollover until the largest primary shard in the index reaches a certain number of documents. Supported from Elasticsearch version 8.4
- min
Primary StringShard Size - Prevents rollover until the largest primary shard in the index reaches a certain size. Supported from Elasticsearch version 8.4
- min
Size String - Prevents rollover until the index reaches a certain size.
ElasticsearchIndexLifecycleHotSearchableSnapshot, ElasticsearchIndexLifecycleHotSearchableSnapshotArgs
- Force
Merge boolIndex - Force merges the managed index to one segment.
- Snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- Force
Merge boolIndex - Force merges the managed index to one segment.
- Snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force_
merge_ boolindex - Force merges the managed index to one segment.
- snapshot_
repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge BooleanIndex - Force merges the managed index to one segment.
- snapshot
Repository String - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge booleanIndex - Force merges the managed index to one segment.
- snapshot
Repository string - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force_
merge_ boolindex - Force merges the managed index to one segment.
- snapshot_
repository str - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
- force
Merge BooleanIndex - Force merges the managed index to one segment.
- snapshot
Repository String - Repository used to store the snapshot. Required when the
searchable_snapshotaction is configured.
ElasticsearchIndexLifecycleHotSetPriority, ElasticsearchIndexLifecycleHotSetPriorityArgs
- Priority double
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- Priority float64
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority Double
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority float
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority Number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
ElasticsearchIndexLifecycleHotShrink, ElasticsearchIndexLifecycleHotShrinkArgs
- Allow
Write boolAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- Max
Primary stringShard Size - The max primary shard size for the target index.
- Number
Of doubleShards - Number of shards to shrink to.
- Allow
Write boolAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- Max
Primary stringShard Size - The max primary shard size for the target index.
- Number
Of float64Shards - Number of shards to shrink to.
- allow_
write_ boolafter_ shrink - If true, the shrunken index is made writable by removing the write block.
- max_
primary_ stringshard_ size - The max primary shard size for the target index.
- number_
of_ numbershards - Number of shards to shrink to.
- allow
Write BooleanAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- max
Primary StringShard Size - The max primary shard size for the target index.
- number
Of DoubleShards - Number of shards to shrink to.
- allow
Write booleanAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- max
Primary stringShard Size - The max primary shard size for the target index.
- number
Of numberShards - Number of shards to shrink to.
- allow_
write_ boolafter_ shrink - If true, the shrunken index is made writable by removing the write block.
- max_
primary_ strshard_ size - The max primary shard size for the target index.
- number_
of_ floatshards - Number of shards to shrink to.
- allow
Write BooleanAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- max
Primary StringShard Size - The max primary shard size for the target index.
- number
Of NumberShards - Number of shards to shrink to.
ElasticsearchIndexLifecycleHotUnfollow, ElasticsearchIndexLifecycleHotUnfollowArgs
- Enabled bool
- Controls whether ILM makes the follower index a regular one.
- Enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled Boolean
- Controls whether ILM makes the follower index a regular one.
- enabled boolean
- Controls whether ILM makes the follower index a regular one.
- enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled Boolean
- Controls whether ILM makes the follower index a regular one.
ElasticsearchIndexLifecycleWarm, ElasticsearchIndexLifecycleWarmArgs
- Allocate
Elasticsearch
Index Lifecycle Warm Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- Downsample
Elasticsearch
Index Lifecycle Warm Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- Forcemerge
Elasticsearch
Index Lifecycle Warm Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- Migrate
Elasticsearch
Index Lifecycle Warm Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Readonly
Elasticsearch
Index Lifecycle Warm Readonly - Makes the index read-only.
- Set
Priority ElasticsearchIndex Lifecycle Warm Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- Shrink
Elasticsearch
Index Lifecycle Warm Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- Unfollow
Elasticsearch
Index Lifecycle Warm Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- Allocate
Elasticsearch
Index Lifecycle Warm Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- Downsample
Elasticsearch
Index Lifecycle Warm Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- Forcemerge
Elasticsearch
Index Lifecycle Warm Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- Migrate
Elasticsearch
Index Lifecycle Warm Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- Min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- Readonly
Elasticsearch
Index Lifecycle Warm Readonly - Makes the index read-only.
- Set
Priority ElasticsearchIndex Lifecycle Warm Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- Shrink
Elasticsearch
Index Lifecycle Warm Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- Unfollow
Elasticsearch
Index Lifecycle Warm Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate object
- Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample object
- Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge object
- Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- migrate object
- Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min_
age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly object
- Makes the index read-only.
- set_
priority object - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink object
- Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow object
- Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate
Elasticsearch
Index Lifecycle Warm Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample
Elasticsearch
Index Lifecycle Warm Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge
Elasticsearch
Index Lifecycle Warm Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- migrate
Elasticsearch
Index Lifecycle Warm Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Warm Readonly - Makes the index read-only.
- set
Priority ElasticsearchIndex Lifecycle Warm Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink
Elasticsearch
Index Lifecycle Warm Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow
Elasticsearch
Index Lifecycle Warm Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate
Elasticsearch
Index Lifecycle Warm Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample
Elasticsearch
Index Lifecycle Warm Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge
Elasticsearch
Index Lifecycle Warm Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- migrate
Elasticsearch
Index Lifecycle Warm Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min
Age string - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Warm Readonly - Makes the index read-only.
- set
Priority ElasticsearchIndex Lifecycle Warm Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink
Elasticsearch
Index Lifecycle Warm Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow
Elasticsearch
Index Lifecycle Warm Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate
Elasticsearch
Index Lifecycle Warm Allocate - Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample
Elasticsearch
Index Lifecycle Warm Downsample - Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge
Elasticsearch
Index Lifecycle Warm Forcemerge - Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- migrate
Elasticsearch
Index Lifecycle Warm Migrate - Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min_
age str - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly
Elasticsearch
Index Lifecycle Warm Readonly - Makes the index read-only.
- set_
priority ElasticsearchIndex Lifecycle Warm Set Priority - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink
Elasticsearch
Index Lifecycle Warm Shrink - Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow
Elasticsearch
Index Lifecycle Warm Unfollow - Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
- allocate Property Map
- Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas.
- downsample Property Map
- Roll up documents within a fixed interval to a single summary document. Reduces the index footprint by storing time series data at reduced granularity.
- forcemerge Property Map
- Force merges the index into the specified maximum number of segments. This action makes the index read-only.
- migrate Property Map
- Moves the index to the data tier that corresponds to the current phase by updating the "index.routing.allocation.include.tierpreference" index setting.
- min
Age String - ILM moves indices through the lifecycle according to their age. To control the timing of these transitions, you set a minimum age for each phase.
- readonly Property Map
- Makes the index read-only.
- set
Priority Property Map - Sets the priority of the index as soon as the policy enters the hot, warm, or cold phase. Higher priority indices are recovered before indices with lower priorities following a node restart. Default priority is 1.
- shrink Property Map
- Sets a source index to read-only and shrinks it into a new index with fewer primary shards.
- unfollow Property Map
- Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action.
ElasticsearchIndexLifecycleWarmAllocate, ElasticsearchIndexLifecycleWarmAllocateArgs
- Exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- Include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- Number
Of doubleReplicas - Number of replicas to assign to the index. Default:
0 - Require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- Total
Shards doublePer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- Exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- Include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- Number
Of float64Replicas - Number of replicas to assign to the index. Default:
0 - Require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- Total
Shards float64Per Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number_
of_ numberreplicas - Number of replicas to assign to the index. Default:
0 - require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total_
shards_ numberper_ node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude String
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include String
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number
Of DoubleReplicas - Number of replicas to assign to the index. Default:
0 - require String
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total
Shards DoublePer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude string
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include string
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number
Of numberReplicas - Number of replicas to assign to the index. Default:
0 - require string
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total
Shards numberPer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude str
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include str
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number_
of_ floatreplicas - Number of replicas to assign to the index. Default:
0 - require str
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total_
shards_ floatper_ node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
- exclude String
- Assigns an index to nodes that have none of the specified custom attributes. Must be valid JSON document.
- include String
- Assigns an index to nodes that have at least one of the specified custom attributes. Must be valid JSON document.
- number
Of NumberReplicas - Number of replicas to assign to the index. Default:
0 - require String
- Assigns an index to nodes that have all of the specified custom attributes. Must be valid JSON document.
- total
Shards NumberPer Node - The maximum number of shards for the index on a single Elasticsearch node. Defaults to
-1(unlimited).
ElasticsearchIndexLifecycleWarmDownsample, ElasticsearchIndexLifecycleWarmDownsampleArgs
- Fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - Wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- Fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - Wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed_
interval string - Downsampling interval. Required when the
downsampleaction is configured. - wait_
timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval String - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout String - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval string - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout string - Maximum time to wait for the downsample operation to complete before timing out.
- fixed_
interval str - Downsampling interval. Required when the
downsampleaction is configured. - wait_
timeout str - Maximum time to wait for the downsample operation to complete before timing out.
- fixed
Interval String - Downsampling interval. Required when the
downsampleaction is configured. - wait
Timeout String - Maximum time to wait for the downsample operation to complete before timing out.
ElasticsearchIndexLifecycleWarmForcemerge, ElasticsearchIndexLifecycleWarmForcemergeArgs
- Index
Codec string - Codec used to compress the document store.
- Max
Num doubleSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- Index
Codec string - Codec used to compress the document store.
- Max
Num float64Segments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index_
codec string - Codec used to compress the document store.
- max_
num_ numbersegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index
Codec String - Codec used to compress the document store.
- max
Num DoubleSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index
Codec string - Codec used to compress the document store.
- max
Num numberSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index_
codec str - Codec used to compress the document store.
- max_
num_ floatsegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
- index
Codec String - Codec used to compress the document store.
- max
Num NumberSegments - Number of segments to merge to. To fully merge the index, set to 1. Required when the
forcemergeaction is configured.
ElasticsearchIndexLifecycleWarmMigrate, ElasticsearchIndexLifecycleWarmMigrateArgs
- Enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- Enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- enabled Boolean
- Controls whether ILM automatically migrates the index during this phase.
- enabled boolean
- Controls whether ILM automatically migrates the index during this phase.
- enabled bool
- Controls whether ILM automatically migrates the index during this phase.
- enabled Boolean
- Controls whether ILM automatically migrates the index during this phase.
ElasticsearchIndexLifecycleWarmReadonly, ElasticsearchIndexLifecycleWarmReadonlyArgs
- Enabled bool
- Controls whether ILM makes the index read-only.
- Enabled bool
- Controls whether ILM makes the index read-only.
- enabled bool
- Controls whether ILM makes the index read-only.
- enabled Boolean
- Controls whether ILM makes the index read-only.
- enabled boolean
- Controls whether ILM makes the index read-only.
- enabled bool
- Controls whether ILM makes the index read-only.
- enabled Boolean
- Controls whether ILM makes the index read-only.
ElasticsearchIndexLifecycleWarmSetPriority, ElasticsearchIndexLifecycleWarmSetPriorityArgs
- Priority double
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- Priority float64
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority Double
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority float
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
- priority Number
- The priority for the index. Must be 0 or greater. Required when the
set_priorityaction is configured.
ElasticsearchIndexLifecycleWarmShrink, ElasticsearchIndexLifecycleWarmShrinkArgs
- Allow
Write boolAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- Max
Primary stringShard Size - The max primary shard size for the target index.
- Number
Of doubleShards - Number of shards to shrink to.
- Allow
Write boolAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- Max
Primary stringShard Size - The max primary shard size for the target index.
- Number
Of float64Shards - Number of shards to shrink to.
- allow_
write_ boolafter_ shrink - If true, the shrunken index is made writable by removing the write block.
- max_
primary_ stringshard_ size - The max primary shard size for the target index.
- number_
of_ numbershards - Number of shards to shrink to.
- allow
Write BooleanAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- max
Primary StringShard Size - The max primary shard size for the target index.
- number
Of DoubleShards - Number of shards to shrink to.
- allow
Write booleanAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- max
Primary stringShard Size - The max primary shard size for the target index.
- number
Of numberShards - Number of shards to shrink to.
- allow_
write_ boolafter_ shrink - If true, the shrunken index is made writable by removing the write block.
- max_
primary_ strshard_ size - The max primary shard size for the target index.
- number_
of_ floatshards - Number of shards to shrink to.
- allow
Write BooleanAfter Shrink - If true, the shrunken index is made writable by removing the write block.
- max
Primary StringShard Size - The max primary shard size for the target index.
- number
Of NumberShards - Number of shards to shrink to.
ElasticsearchIndexLifecycleWarmUnfollow, ElasticsearchIndexLifecycleWarmUnfollowArgs
- Enabled bool
- Controls whether ILM makes the follower index a regular one.
- Enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled Boolean
- Controls whether ILM makes the follower index a regular one.
- enabled boolean
- Controls whether ILM makes the follower index a regular one.
- enabled bool
- Controls whether ILM makes the follower index a regular one.
- enabled Boolean
- Controls whether ILM makes the follower index a regular one.
Import
The pulumi import command can be used, for example:
$ pulumi import elasticstack:index/elasticsearchIndexLifecycle:ElasticsearchIndexLifecycle my_ilm <cluster_uuid>/<ilm_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.
published on Thursday, May 14, 2026 by elastic
