Creates and manages Machine Learning anomaly detection jobs. See the ML Job API documentation for more details.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
// Basic anomaly detection job
const example = new elasticstack.ElasticsearchMlAnomalyDetectionJob("example", {
jobId: "example-anomaly-detector",
description: "Example anomaly detection job for monitoring web traffic",
groups: [
"web",
"monitoring",
],
analysisConfig: {
bucketSpan: "15m",
detectors: [
{
"function": "count",
detectorDescription: "Count anomalies in web traffic",
},
{
"function": "mean",
fieldName: "response_time",
detectorDescription: "Mean response time anomalies",
},
],
influencers: [
"client_ip",
"status_code",
],
},
dataDescription: {
timeField: "@timestamp",
timeFormat: "epoch_ms",
},
analysisLimits: {
modelMemoryLimit: "100mb",
},
modelPlotConfig: {
enabled: true,
},
modelSnapshotRetentionDays: 30,
resultsRetentionDays: 90,
});
import pulumi
import pulumi_elasticstack as elasticstack
# Basic anomaly detection job
example = elasticstack.ElasticsearchMlAnomalyDetectionJob("example",
job_id="example-anomaly-detector",
description="Example anomaly detection job for monitoring web traffic",
groups=[
"web",
"monitoring",
],
analysis_config={
"bucket_span": "15m",
"detectors": [
{
"function": "count",
"detector_description": "Count anomalies in web traffic",
},
{
"function": "mean",
"field_name": "response_time",
"detector_description": "Mean response time anomalies",
},
],
"influencers": [
"client_ip",
"status_code",
],
},
data_description={
"time_field": "@timestamp",
"time_format": "epoch_ms",
},
analysis_limits={
"model_memory_limit": "100mb",
},
model_plot_config={
"enabled": True,
},
model_snapshot_retention_days=30,
results_retention_days=90)
package main
import (
"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 {
// Basic anomaly detection job
_, err := elasticstack.NewElasticsearchMlAnomalyDetectionJob(ctx, "example", &elasticstack.ElasticsearchMlAnomalyDetectionJobArgs{
JobId: pulumi.String("example-anomaly-detector"),
Description: pulumi.String("Example anomaly detection job for monitoring web traffic"),
Groups: pulumi.StringArray{
pulumi.String("web"),
pulumi.String("monitoring"),
},
AnalysisConfig: &elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs{
BucketSpan: pulumi.String("15m"),
Detectors: elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArray{
&elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs{
Function: pulumi.String("count"),
DetectorDescription: pulumi.String("Count anomalies in web traffic"),
},
&elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs{
Function: pulumi.String("mean"),
FieldName: pulumi.String("response_time"),
DetectorDescription: pulumi.String("Mean response time anomalies"),
},
},
Influencers: pulumi.StringArray{
pulumi.String("client_ip"),
pulumi.String("status_code"),
},
},
DataDescription: &elasticstack.ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs{
TimeField: pulumi.String("@timestamp"),
TimeFormat: pulumi.String("epoch_ms"),
},
AnalysisLimits: &elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs{
ModelMemoryLimit: pulumi.String("100mb"),
},
ModelPlotConfig: &elasticstack.ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs{
Enabled: pulumi.Bool(true),
},
ModelSnapshotRetentionDays: pulumi.Float64(30),
ResultsRetentionDays: pulumi.Float64(90),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
// Basic anomaly detection job
var example = new Elasticstack.ElasticsearchMlAnomalyDetectionJob("example", new()
{
JobId = "example-anomaly-detector",
Description = "Example anomaly detection job for monitoring web traffic",
Groups = new[]
{
"web",
"monitoring",
},
AnalysisConfig = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs
{
BucketSpan = "15m",
Detectors = new[]
{
new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs
{
Function = "count",
DetectorDescription = "Count anomalies in web traffic",
},
new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs
{
Function = "mean",
FieldName = "response_time",
DetectorDescription = "Mean response time anomalies",
},
},
Influencers = new[]
{
"client_ip",
"status_code",
},
},
DataDescription = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs
{
TimeField = "@timestamp",
TimeFormat = "epoch_ms",
},
AnalysisLimits = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs
{
ModelMemoryLimit = "100mb",
},
ModelPlotConfig = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs
{
Enabled = true,
},
ModelSnapshotRetentionDays = 30,
ResultsRetentionDays = 90,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchMlAnomalyDetectionJob;
import com.pulumi.elasticstack.ElasticsearchMlAnomalyDetectionJobArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs;
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) {
// Basic anomaly detection job
var example = new ElasticsearchMlAnomalyDetectionJob("example", ElasticsearchMlAnomalyDetectionJobArgs.builder()
.jobId("example-anomaly-detector")
.description("Example anomaly detection job for monitoring web traffic")
.groups(
"web",
"monitoring")
.analysisConfig(ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs.builder()
.bucketSpan("15m")
.detectors(
ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs.builder()
.function("count")
.detectorDescription("Count anomalies in web traffic")
.build(),
ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs.builder()
.function("mean")
.fieldName("response_time")
.detectorDescription("Mean response time anomalies")
.build())
.influencers(
"client_ip",
"status_code")
.build())
.dataDescription(ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs.builder()
.timeField("@timestamp")
.timeFormat("epoch_ms")
.build())
.analysisLimits(ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs.builder()
.modelMemoryLimit("100mb")
.build())
.modelPlotConfig(ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs.builder()
.enabled(true)
.build())
.modelSnapshotRetentionDays(30.0)
.resultsRetentionDays(90.0)
.build());
}
}
resources:
# Basic anomaly detection job
example:
type: elasticstack:ElasticsearchMlAnomalyDetectionJob
properties:
jobId: example-anomaly-detector
description: Example anomaly detection job for monitoring web traffic
groups:
- web
- monitoring
analysisConfig:
bucketSpan: 15m
detectors:
- function: count
detectorDescription: Count anomalies in web traffic
- function: mean
fieldName: response_time
detectorDescription: Mean response time anomalies
influencers:
- client_ip
- status_code
dataDescription:
timeField: '@timestamp'
timeFormat: epoch_ms
analysisLimits:
modelMemoryLimit: 100mb
modelPlotConfig:
enabled: true
modelSnapshotRetentionDays: 30
resultsRetentionDays: 90
Create ElasticsearchMlAnomalyDetectionJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchMlAnomalyDetectionJob(name: string, args: ElasticsearchMlAnomalyDetectionJobArgs, opts?: CustomResourceOptions);@overload
def ElasticsearchMlAnomalyDetectionJob(resource_name: str,
args: ElasticsearchMlAnomalyDetectionJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchMlAnomalyDetectionJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_description: Optional[ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs] = None,
analysis_config: Optional[ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs] = None,
job_id: Optional[str] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchMlAnomalyDetectionJobElasticsearchConnectionArgs]] = None,
custom_settings: Optional[str] = None,
daily_model_snapshot_retention_after_days: Optional[float] = None,
background_persist_interval: Optional[str] = None,
description: Optional[str] = None,
allow_lazy_open: Optional[bool] = None,
groups: Optional[Sequence[str]] = None,
analysis_limits: Optional[ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs] = None,
model_plot_config: Optional[ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs] = None,
model_snapshot_retention_days: Optional[float] = None,
renormalization_window_days: Optional[float] = None,
results_index_name: Optional[str] = None,
results_retention_days: Optional[float] = None)func NewElasticsearchMlAnomalyDetectionJob(ctx *Context, name string, args ElasticsearchMlAnomalyDetectionJobArgs, opts ...ResourceOption) (*ElasticsearchMlAnomalyDetectionJob, error)public ElasticsearchMlAnomalyDetectionJob(string name, ElasticsearchMlAnomalyDetectionJobArgs args, CustomResourceOptions? opts = null)
public ElasticsearchMlAnomalyDetectionJob(String name, ElasticsearchMlAnomalyDetectionJobArgs args)
public ElasticsearchMlAnomalyDetectionJob(String name, ElasticsearchMlAnomalyDetectionJobArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchMlAnomalyDetectionJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ElasticsearchMlAnomalyDetectionJobArgs
- 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 ElasticsearchMlAnomalyDetectionJobArgs
- 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 ElasticsearchMlAnomalyDetectionJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchMlAnomalyDetectionJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchMlAnomalyDetectionJobArgs
- 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 elasticsearchMlAnomalyDetectionJobResource = new Elasticstack.ElasticsearchMlAnomalyDetectionJob("elasticsearchMlAnomalyDetectionJobResource", new()
{
DataDescription = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs
{
TimeField = "string",
TimeFormat = "string",
},
AnalysisConfig = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs
{
Detectors = new[]
{
new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs
{
Function = "string",
ByFieldName = "string",
CustomRules = new[]
{
new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleArgs
{
Actions = new[]
{
"string",
},
Conditions = new[]
{
new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleConditionArgs
{
AppliesTo = "string",
Operator = "string",
Value = 0,
},
},
},
},
DetectorDescription = "string",
ExcludeFrequent = "string",
FieldName = "string",
OverFieldName = "string",
PartitionFieldName = "string",
UseNull = false,
},
},
BucketSpan = "string",
CategorizationFieldName = "string",
CategorizationFilters = new[]
{
"string",
},
Influencers = new[]
{
"string",
},
Latency = "string",
ModelPruneWindow = "string",
MultivariateByFields = false,
PerPartitionCategorization = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisConfigPerPartitionCategorizationArgs
{
Enabled = false,
StopOnWarn = false,
},
SummaryCountFieldName = "string",
},
JobId = "string",
CustomSettings = "string",
DailyModelSnapshotRetentionAfterDays = 0,
BackgroundPersistInterval = "string",
Description = "string",
AllowLazyOpen = false,
Groups = new[]
{
"string",
},
AnalysisLimits = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs
{
CategorizationExamplesLimit = 0,
ModelMemoryLimit = "string",
},
ModelPlotConfig = new Elasticstack.Inputs.ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs
{
AnnotationsEnabled = false,
Enabled = false,
Terms = "string",
},
ModelSnapshotRetentionDays = 0,
RenormalizationWindowDays = 0,
ResultsIndexName = "string",
ResultsRetentionDays = 0,
});
example, err := elasticstack.NewElasticsearchMlAnomalyDetectionJob(ctx, "elasticsearchMlAnomalyDetectionJobResource", &elasticstack.ElasticsearchMlAnomalyDetectionJobArgs{
DataDescription: &elasticstack.ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs{
TimeField: pulumi.String("string"),
TimeFormat: pulumi.String("string"),
},
AnalysisConfig: &elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs{
Detectors: elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArray{
&elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs{
Function: pulumi.String("string"),
ByFieldName: pulumi.String("string"),
CustomRules: elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleArray{
&elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleArgs{
Actions: pulumi.StringArray{
pulumi.String("string"),
},
Conditions: elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleConditionArray{
&elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleConditionArgs{
AppliesTo: pulumi.String("string"),
Operator: pulumi.String("string"),
Value: pulumi.Float64(0),
},
},
},
},
DetectorDescription: pulumi.String("string"),
ExcludeFrequent: pulumi.String("string"),
FieldName: pulumi.String("string"),
OverFieldName: pulumi.String("string"),
PartitionFieldName: pulumi.String("string"),
UseNull: pulumi.Bool(false),
},
},
BucketSpan: pulumi.String("string"),
CategorizationFieldName: pulumi.String("string"),
CategorizationFilters: pulumi.StringArray{
pulumi.String("string"),
},
Influencers: pulumi.StringArray{
pulumi.String("string"),
},
Latency: pulumi.String("string"),
ModelPruneWindow: pulumi.String("string"),
MultivariateByFields: pulumi.Bool(false),
PerPartitionCategorization: &elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisConfigPerPartitionCategorizationArgs{
Enabled: pulumi.Bool(false),
StopOnWarn: pulumi.Bool(false),
},
SummaryCountFieldName: pulumi.String("string"),
},
JobId: pulumi.String("string"),
CustomSettings: pulumi.String("string"),
DailyModelSnapshotRetentionAfterDays: pulumi.Float64(0),
BackgroundPersistInterval: pulumi.String("string"),
Description: pulumi.String("string"),
AllowLazyOpen: pulumi.Bool(false),
Groups: pulumi.StringArray{
pulumi.String("string"),
},
AnalysisLimits: &elasticstack.ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs{
CategorizationExamplesLimit: pulumi.Float64(0),
ModelMemoryLimit: pulumi.String("string"),
},
ModelPlotConfig: &elasticstack.ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs{
AnnotationsEnabled: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Terms: pulumi.String("string"),
},
ModelSnapshotRetentionDays: pulumi.Float64(0),
RenormalizationWindowDays: pulumi.Float64(0),
ResultsIndexName: pulumi.String("string"),
ResultsRetentionDays: pulumi.Float64(0),
})
var elasticsearchMlAnomalyDetectionJobResource = new ElasticsearchMlAnomalyDetectionJob("elasticsearchMlAnomalyDetectionJobResource", ElasticsearchMlAnomalyDetectionJobArgs.builder()
.dataDescription(ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs.builder()
.timeField("string")
.timeFormat("string")
.build())
.analysisConfig(ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs.builder()
.detectors(ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs.builder()
.function("string")
.byFieldName("string")
.customRules(ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleArgs.builder()
.actions("string")
.conditions(ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleConditionArgs.builder()
.appliesTo("string")
.operator("string")
.value(0.0)
.build())
.build())
.detectorDescription("string")
.excludeFrequent("string")
.fieldName("string")
.overFieldName("string")
.partitionFieldName("string")
.useNull(false)
.build())
.bucketSpan("string")
.categorizationFieldName("string")
.categorizationFilters("string")
.influencers("string")
.latency("string")
.modelPruneWindow("string")
.multivariateByFields(false)
.perPartitionCategorization(ElasticsearchMlAnomalyDetectionJobAnalysisConfigPerPartitionCategorizationArgs.builder()
.enabled(false)
.stopOnWarn(false)
.build())
.summaryCountFieldName("string")
.build())
.jobId("string")
.customSettings("string")
.dailyModelSnapshotRetentionAfterDays(0.0)
.backgroundPersistInterval("string")
.description("string")
.allowLazyOpen(false)
.groups("string")
.analysisLimits(ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs.builder()
.categorizationExamplesLimit(0.0)
.modelMemoryLimit("string")
.build())
.modelPlotConfig(ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs.builder()
.annotationsEnabled(false)
.enabled(false)
.terms("string")
.build())
.modelSnapshotRetentionDays(0.0)
.renormalizationWindowDays(0.0)
.resultsIndexName("string")
.resultsRetentionDays(0.0)
.build());
elasticsearch_ml_anomaly_detection_job_resource = elasticstack.ElasticsearchMlAnomalyDetectionJob("elasticsearchMlAnomalyDetectionJobResource",
data_description={
"time_field": "string",
"time_format": "string",
},
analysis_config={
"detectors": [{
"function": "string",
"by_field_name": "string",
"custom_rules": [{
"actions": ["string"],
"conditions": [{
"applies_to": "string",
"operator": "string",
"value": 0,
}],
}],
"detector_description": "string",
"exclude_frequent": "string",
"field_name": "string",
"over_field_name": "string",
"partition_field_name": "string",
"use_null": False,
}],
"bucket_span": "string",
"categorization_field_name": "string",
"categorization_filters": ["string"],
"influencers": ["string"],
"latency": "string",
"model_prune_window": "string",
"multivariate_by_fields": False,
"per_partition_categorization": {
"enabled": False,
"stop_on_warn": False,
},
"summary_count_field_name": "string",
},
job_id="string",
custom_settings="string",
daily_model_snapshot_retention_after_days=0,
background_persist_interval="string",
description="string",
allow_lazy_open=False,
groups=["string"],
analysis_limits={
"categorization_examples_limit": 0,
"model_memory_limit": "string",
},
model_plot_config={
"annotations_enabled": False,
"enabled": False,
"terms": "string",
},
model_snapshot_retention_days=0,
renormalization_window_days=0,
results_index_name="string",
results_retention_days=0)
const elasticsearchMlAnomalyDetectionJobResource = new elasticstack.ElasticsearchMlAnomalyDetectionJob("elasticsearchMlAnomalyDetectionJobResource", {
dataDescription: {
timeField: "string",
timeFormat: "string",
},
analysisConfig: {
detectors: [{
"function": "string",
byFieldName: "string",
customRules: [{
actions: ["string"],
conditions: [{
appliesTo: "string",
operator: "string",
value: 0,
}],
}],
detectorDescription: "string",
excludeFrequent: "string",
fieldName: "string",
overFieldName: "string",
partitionFieldName: "string",
useNull: false,
}],
bucketSpan: "string",
categorizationFieldName: "string",
categorizationFilters: ["string"],
influencers: ["string"],
latency: "string",
modelPruneWindow: "string",
multivariateByFields: false,
perPartitionCategorization: {
enabled: false,
stopOnWarn: false,
},
summaryCountFieldName: "string",
},
jobId: "string",
customSettings: "string",
dailyModelSnapshotRetentionAfterDays: 0,
backgroundPersistInterval: "string",
description: "string",
allowLazyOpen: false,
groups: ["string"],
analysisLimits: {
categorizationExamplesLimit: 0,
modelMemoryLimit: "string",
},
modelPlotConfig: {
annotationsEnabled: false,
enabled: false,
terms: "string",
},
modelSnapshotRetentionDays: 0,
renormalizationWindowDays: 0,
resultsIndexName: "string",
resultsRetentionDays: 0,
});
type: elasticstack:ElasticsearchMlAnomalyDetectionJob
properties:
allowLazyOpen: false
analysisConfig:
bucketSpan: string
categorizationFieldName: string
categorizationFilters:
- string
detectors:
- byFieldName: string
customRules:
- actions:
- string
conditions:
- appliesTo: string
operator: string
value: 0
detectorDescription: string
excludeFrequent: string
fieldName: string
function: string
overFieldName: string
partitionFieldName: string
useNull: false
influencers:
- string
latency: string
modelPruneWindow: string
multivariateByFields: false
perPartitionCategorization:
enabled: false
stopOnWarn: false
summaryCountFieldName: string
analysisLimits:
categorizationExamplesLimit: 0
modelMemoryLimit: string
backgroundPersistInterval: string
customSettings: string
dailyModelSnapshotRetentionAfterDays: 0
dataDescription:
timeField: string
timeFormat: string
description: string
groups:
- string
jobId: string
modelPlotConfig:
annotationsEnabled: false
enabled: false
terms: string
modelSnapshotRetentionDays: 0
renormalizationWindowDays: 0
resultsIndexName: string
resultsRetentionDays: 0
ElasticsearchMlAnomalyDetectionJob 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 ElasticsearchMlAnomalyDetectionJob resource accepts the following input properties:
- Analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- Data
Description ElasticsearchMl Anomaly Detection Job Data Description - Defines the format of the input data when you send data to the job by using the post data API.
- Job
Id string - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- Allow
Lazy boolOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- Analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits - Limits can be applied for the resources required to hold the mathematical models in memory.
- Background
Persist stringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- Custom
Settings string - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- Daily
Model doubleSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Description string
- A description of the job.
- Elasticsearch
Connections List<ElasticsearchMl Anomaly Detection Job Elasticsearch Connection> - Elasticsearch connection configuration block.
- Groups List<string>
- A set of job groups. A job can belong to no groups or many.
- Model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- Model
Snapshot doubleRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Renormalization
Window doubleDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- Results
Index stringName - A text string that affects the name of the machine learning results index.
- Results
Retention doubleDays - Advanced configuration option. The period of time (in days) that results are retained.
- Analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config Args - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- Data
Description ElasticsearchMl Anomaly Detection Job Data Description Args - Defines the format of the input data when you send data to the job by using the post data API.
- Job
Id string - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- Allow
Lazy boolOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- Analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits Args - Limits can be applied for the resources required to hold the mathematical models in memory.
- Background
Persist stringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- Custom
Settings string - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- Daily
Model float64Snapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Description string
- A description of the job.
- Elasticsearch
Connections []ElasticsearchMl Anomaly Detection Job Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Groups []string
- A set of job groups. A job can belong to no groups or many.
- Model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config Args - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- Model
Snapshot float64Retention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Renormalization
Window float64Days - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- Results
Index stringName - A text string that affects the name of the machine learning results index.
- Results
Retention float64Days - Advanced configuration option. The period of time (in days) that results are retained.
- analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- data
Description ElasticsearchMl Anomaly Detection Job Data Description - Defines the format of the input data when you send data to the job by using the post data API.
- job
Id String - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- allow
Lazy BooleanOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits - Limits can be applied for the resources required to hold the mathematical models in memory.
- background
Persist StringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- custom
Settings String - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily
Model DoubleSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- description String
- A description of the job.
- elasticsearch
Connections List<ElasticsearchMl Anomaly Detection Job Elasticsearch Connection> - Elasticsearch connection configuration block.
- groups List<String>
- A set of job groups. A job can belong to no groups or many.
- model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model
Snapshot DoubleRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization
Window DoubleDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results
Index StringName - A text string that affects the name of the machine learning results index.
- results
Retention DoubleDays - Advanced configuration option. The period of time (in days) that results are retained.
- analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- data
Description ElasticsearchMl Anomaly Detection Job Data Description - Defines the format of the input data when you send data to the job by using the post data API.
- job
Id string - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- allow
Lazy booleanOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits - Limits can be applied for the resources required to hold the mathematical models in memory.
- background
Persist stringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- custom
Settings string - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily
Model numberSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- description string
- A description of the job.
- elasticsearch
Connections ElasticsearchMl Anomaly Detection Job Elasticsearch Connection[] - Elasticsearch connection configuration block.
- groups string[]
- A set of job groups. A job can belong to no groups or many.
- model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model
Snapshot numberRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization
Window numberDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results
Index stringName - A text string that affects the name of the machine learning results index.
- results
Retention numberDays - Advanced configuration option. The period of time (in days) that results are retained.
- analysis_
config ElasticsearchMl Anomaly Detection Job Analysis Config Args - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- data_
description ElasticsearchMl Anomaly Detection Job Data Description Args - Defines the format of the input data when you send data to the job by using the post data API.
- job_
id str - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- allow_
lazy_ boolopen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis_
limits ElasticsearchMl Anomaly Detection Job Analysis Limits Args - Limits can be applied for the resources required to hold the mathematical models in memory.
- background_
persist_ strinterval - Advanced configuration option. The time between each periodic persistence of the model.
- custom_
settings str - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily_
model_ floatsnapshot_ retention_ after_ days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- description str
- A description of the job.
- elasticsearch_
connections Sequence[ElasticsearchMl Anomaly Detection Job Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- groups Sequence[str]
- A set of job groups. A job can belong to no groups or many.
- model_
plot_ Elasticsearchconfig Ml Anomaly Detection Job Model Plot Config Args - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model_
snapshot_ floatretention_ days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization_
window_ floatdays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results_
index_ strname - A text string that affects the name of the machine learning results index.
- results_
retention_ floatdays - Advanced configuration option. The period of time (in days) that results are retained.
- analysis
Config Property Map - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- data
Description Property Map - Defines the format of the input data when you send data to the job by using the post data API.
- job
Id String - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- allow
Lazy BooleanOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis
Limits Property Map - Limits can be applied for the resources required to hold the mathematical models in memory.
- background
Persist StringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- custom
Settings String - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily
Model NumberSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- description String
- A description of the job.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- groups List<String>
- A set of job groups. A job can belong to no groups or many.
- model
Plot Property MapConfig - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model
Snapshot NumberRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization
Window NumberDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results
Index StringName - A text string that affects the name of the machine learning results index.
- results
Retention NumberDays - Advanced configuration option. The period of time (in days) that results are retained.
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchMlAnomalyDetectionJob resource produces the following output properties:
- Create
Time string - The time the job was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Job
Type string - Reserved for future use, currently set to anomaly_detector.
- Job
Version string - The version of Elasticsearch when the job was created.
- Model
Snapshot stringId - A numerical character string that uniquely identifies the model snapshot.
- Create
Time string - The time the job was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Job
Type string - Reserved for future use, currently set to anomaly_detector.
- Job
Version string - The version of Elasticsearch when the job was created.
- Model
Snapshot stringId - A numerical character string that uniquely identifies the model snapshot.
- create
Time String - The time the job was created.
- id String
- The provider-assigned unique ID for this managed resource.
- job
Type String - Reserved for future use, currently set to anomaly_detector.
- job
Version String - The version of Elasticsearch when the job was created.
- model
Snapshot StringId - A numerical character string that uniquely identifies the model snapshot.
- create
Time string - The time the job was created.
- id string
- The provider-assigned unique ID for this managed resource.
- job
Type string - Reserved for future use, currently set to anomaly_detector.
- job
Version string - The version of Elasticsearch when the job was created.
- model
Snapshot stringId - A numerical character string that uniquely identifies the model snapshot.
- create_
time str - The time the job was created.
- id str
- The provider-assigned unique ID for this managed resource.
- job_
type str - Reserved for future use, currently set to anomaly_detector.
- job_
version str - The version of Elasticsearch when the job was created.
- model_
snapshot_ strid - A numerical character string that uniquely identifies the model snapshot.
- create
Time String - The time the job was created.
- id String
- The provider-assigned unique ID for this managed resource.
- job
Type String - Reserved for future use, currently set to anomaly_detector.
- job
Version String - The version of Elasticsearch when the job was created.
- model
Snapshot StringId - A numerical character string that uniquely identifies the model snapshot.
Look up Existing ElasticsearchMlAnomalyDetectionJob Resource
Get an existing ElasticsearchMlAnomalyDetectionJob 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?: ElasticsearchMlAnomalyDetectionJobState, opts?: CustomResourceOptions): ElasticsearchMlAnomalyDetectionJob@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_lazy_open: Optional[bool] = None,
analysis_config: Optional[ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs] = None,
analysis_limits: Optional[ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs] = None,
background_persist_interval: Optional[str] = None,
create_time: Optional[str] = None,
custom_settings: Optional[str] = None,
daily_model_snapshot_retention_after_days: Optional[float] = None,
data_description: Optional[ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs] = None,
description: Optional[str] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchMlAnomalyDetectionJobElasticsearchConnectionArgs]] = None,
groups: Optional[Sequence[str]] = None,
job_id: Optional[str] = None,
job_type: Optional[str] = None,
job_version: Optional[str] = None,
model_plot_config: Optional[ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs] = None,
model_snapshot_id: Optional[str] = None,
model_snapshot_retention_days: Optional[float] = None,
renormalization_window_days: Optional[float] = None,
results_index_name: Optional[str] = None,
results_retention_days: Optional[float] = None) -> ElasticsearchMlAnomalyDetectionJobfunc GetElasticsearchMlAnomalyDetectionJob(ctx *Context, name string, id IDInput, state *ElasticsearchMlAnomalyDetectionJobState, opts ...ResourceOption) (*ElasticsearchMlAnomalyDetectionJob, error)public static ElasticsearchMlAnomalyDetectionJob Get(string name, Input<string> id, ElasticsearchMlAnomalyDetectionJobState? state, CustomResourceOptions? opts = null)public static ElasticsearchMlAnomalyDetectionJob get(String name, Output<String> id, ElasticsearchMlAnomalyDetectionJobState state, CustomResourceOptions options)resources: _: type: elasticstack:ElasticsearchMlAnomalyDetectionJob get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allow
Lazy boolOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- Analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- Analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits - Limits can be applied for the resources required to hold the mathematical models in memory.
- Background
Persist stringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- Create
Time string - The time the job was created.
- Custom
Settings string - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- Daily
Model doubleSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Data
Description ElasticsearchMl Anomaly Detection Job Data Description - Defines the format of the input data when you send data to the job by using the post data API.
- Description string
- A description of the job.
- Elasticsearch
Connections List<ElasticsearchMl Anomaly Detection Job Elasticsearch Connection> - Elasticsearch connection configuration block.
- Groups List<string>
- A set of job groups. A job can belong to no groups or many.
- Job
Id string - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- Job
Type string - Reserved for future use, currently set to anomaly_detector.
- Job
Version string - The version of Elasticsearch when the job was created.
- Model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- Model
Snapshot stringId - A numerical character string that uniquely identifies the model snapshot.
- Model
Snapshot doubleRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Renormalization
Window doubleDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- Results
Index stringName - A text string that affects the name of the machine learning results index.
- Results
Retention doubleDays - Advanced configuration option. The period of time (in days) that results are retained.
- Allow
Lazy boolOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- Analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config Args - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- Analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits Args - Limits can be applied for the resources required to hold the mathematical models in memory.
- Background
Persist stringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- Create
Time string - The time the job was created.
- Custom
Settings string - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- Daily
Model float64Snapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Data
Description ElasticsearchMl Anomaly Detection Job Data Description Args - Defines the format of the input data when you send data to the job by using the post data API.
- Description string
- A description of the job.
- Elasticsearch
Connections []ElasticsearchMl Anomaly Detection Job Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Groups []string
- A set of job groups. A job can belong to no groups or many.
- Job
Id string - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- Job
Type string - Reserved for future use, currently set to anomaly_detector.
- Job
Version string - The version of Elasticsearch when the job was created.
- Model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config Args - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- Model
Snapshot stringId - A numerical character string that uniquely identifies the model snapshot.
- Model
Snapshot float64Retention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- Renormalization
Window float64Days - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- Results
Index stringName - A text string that affects the name of the machine learning results index.
- Results
Retention float64Days - Advanced configuration option. The period of time (in days) that results are retained.
- allow
Lazy BooleanOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits - Limits can be applied for the resources required to hold the mathematical models in memory.
- background
Persist StringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- create
Time String - The time the job was created.
- custom
Settings String - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily
Model DoubleSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- data
Description ElasticsearchMl Anomaly Detection Job Data Description - Defines the format of the input data when you send data to the job by using the post data API.
- description String
- A description of the job.
- elasticsearch
Connections List<ElasticsearchMl Anomaly Detection Job Elasticsearch Connection> - Elasticsearch connection configuration block.
- groups List<String>
- A set of job groups. A job can belong to no groups or many.
- job
Id String - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- job
Type String - Reserved for future use, currently set to anomaly_detector.
- job
Version String - The version of Elasticsearch when the job was created.
- model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model
Snapshot StringId - A numerical character string that uniquely identifies the model snapshot.
- model
Snapshot DoubleRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization
Window DoubleDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results
Index StringName - A text string that affects the name of the machine learning results index.
- results
Retention DoubleDays - Advanced configuration option. The period of time (in days) that results are retained.
- allow
Lazy booleanOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis
Config ElasticsearchMl Anomaly Detection Job Analysis Config - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- analysis
Limits ElasticsearchMl Anomaly Detection Job Analysis Limits - Limits can be applied for the resources required to hold the mathematical models in memory.
- background
Persist stringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- create
Time string - The time the job was created.
- custom
Settings string - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily
Model numberSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- data
Description ElasticsearchMl Anomaly Detection Job Data Description - Defines the format of the input data when you send data to the job by using the post data API.
- description string
- A description of the job.
- elasticsearch
Connections ElasticsearchMl Anomaly Detection Job Elasticsearch Connection[] - Elasticsearch connection configuration block.
- groups string[]
- A set of job groups. A job can belong to no groups or many.
- job
Id string - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- job
Type string - Reserved for future use, currently set to anomaly_detector.
- job
Version string - The version of Elasticsearch when the job was created.
- model
Plot ElasticsearchConfig Ml Anomaly Detection Job Model Plot Config - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model
Snapshot stringId - A numerical character string that uniquely identifies the model snapshot.
- model
Snapshot numberRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization
Window numberDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results
Index stringName - A text string that affects the name of the machine learning results index.
- results
Retention numberDays - Advanced configuration option. The period of time (in days) that results are retained.
- allow_
lazy_ boolopen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis_
config ElasticsearchMl Anomaly Detection Job Analysis Config Args - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- analysis_
limits ElasticsearchMl Anomaly Detection Job Analysis Limits Args - Limits can be applied for the resources required to hold the mathematical models in memory.
- background_
persist_ strinterval - Advanced configuration option. The time between each periodic persistence of the model.
- create_
time str - The time the job was created.
- custom_
settings str - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily_
model_ floatsnapshot_ retention_ after_ days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- data_
description ElasticsearchMl Anomaly Detection Job Data Description Args - Defines the format of the input data when you send data to the job by using the post data API.
- description str
- A description of the job.
- elasticsearch_
connections Sequence[ElasticsearchMl Anomaly Detection Job Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- groups Sequence[str]
- A set of job groups. A job can belong to no groups or many.
- job_
id str - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- job_
type str - Reserved for future use, currently set to anomaly_detector.
- job_
version str - The version of Elasticsearch when the job was created.
- model_
plot_ Elasticsearchconfig Ml Anomaly Detection Job Model Plot Config Args - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model_
snapshot_ strid - A numerical character string that uniquely identifies the model snapshot.
- model_
snapshot_ floatretention_ days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization_
window_ floatdays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results_
index_ strname - A text string that affects the name of the machine learning results index.
- results_
retention_ floatdays - Advanced configuration option. The period of time (in days) that results are retained.
- allow
Lazy BooleanOpen - Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.
- analysis
Config Property Map - Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.
- analysis
Limits Property Map - Limits can be applied for the resources required to hold the mathematical models in memory.
- background
Persist StringInterval - Advanced configuration option. The time between each periodic persistence of the model.
- create
Time String - The time the job was created.
- custom
Settings String - Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information.
- daily
Model NumberSnapshot Retention After Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- data
Description Property Map - Defines the format of the input data when you send data to the job by using the post data API.
- description String
- A description of the job.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- groups List<String>
- A set of job groups. A job can belong to no groups or many.
- job
Id String - The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
- job
Type String - Reserved for future use, currently set to anomaly_detector.
- job
Version String - The version of Elasticsearch when the job was created.
- model
Plot Property MapConfig - This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection.
- model
Snapshot StringId - A numerical character string that uniquely identifies the model snapshot.
- model
Snapshot NumberRetention Days - Advanced configuration option, which affects the automatic removal of old model snapshots for this job.
- renormalization
Window NumberDays - Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.
- results
Index StringName - A text string that affects the name of the machine learning results index.
- results
Retention NumberDays - Advanced configuration option. The period of time (in days) that results are retained.
Supporting Types
ElasticsearchMlAnomalyDetectionJobAnalysisConfig, ElasticsearchMlAnomalyDetectionJobAnalysisConfigArgs
- Detectors
List<Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector> - Detector configuration objects. Detectors identify the anomaly detection functions and the fields on which they operate.
- Bucket
Span string - The size of the interval that the analysis is aggregated into, typically between 15m and 1h. If the anomaly detector is expecting to see data at near real-time frequency, then the bucketspan should be set to a value around 10 times the time between ingested documents. For example, if data comes every second, bucketspan should be 10s; if data comes every 5 minutes, bucketspan should be 50m. For sparse or batch data, use larger bucketspan values.
- Categorization
Field stringName - For categorization jobs only. The name of the field to categorize.
- Categorization
Filters List<string> - For categorization jobs only. An array of regular expressions. A categorization message is matched against each regex in the order they are listed in the array.
- Influencers List<string>
- A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration.
- Latency string
- The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second.
- Model
Prune stringWindow - Advanced configuration option. The time interval (in days) between pruning the model.
- Multivariate
By boolFields - This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
- Per
Partition ElasticsearchCategorization Ml Anomaly Detection Job Analysis Config Per Partition Categorization - Settings related to how categorization interacts with partition fields.
- Summary
Count stringField Name - If this property is specified, the data that is fed to the job is expected to be pre-summarized.
- Detectors
[]Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector - Detector configuration objects. Detectors identify the anomaly detection functions and the fields on which they operate.
- Bucket
Span string - The size of the interval that the analysis is aggregated into, typically between 15m and 1h. If the anomaly detector is expecting to see data at near real-time frequency, then the bucketspan should be set to a value around 10 times the time between ingested documents. For example, if data comes every second, bucketspan should be 10s; if data comes every 5 minutes, bucketspan should be 50m. For sparse or batch data, use larger bucketspan values.
- Categorization
Field stringName - For categorization jobs only. The name of the field to categorize.
- Categorization
Filters []string - For categorization jobs only. An array of regular expressions. A categorization message is matched against each regex in the order they are listed in the array.
- Influencers []string
- A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration.
- Latency string
- The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second.
- Model
Prune stringWindow - Advanced configuration option. The time interval (in days) between pruning the model.
- Multivariate
By boolFields - This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
- Per
Partition ElasticsearchCategorization Ml Anomaly Detection Job Analysis Config Per Partition Categorization - Settings related to how categorization interacts with partition fields.
- Summary
Count stringField Name - If this property is specified, the data that is fed to the job is expected to be pre-summarized.
- detectors
List<Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector> - Detector configuration objects. Detectors identify the anomaly detection functions and the fields on which they operate.
- bucket
Span String - The size of the interval that the analysis is aggregated into, typically between 15m and 1h. If the anomaly detector is expecting to see data at near real-time frequency, then the bucketspan should be set to a value around 10 times the time between ingested documents. For example, if data comes every second, bucketspan should be 10s; if data comes every 5 minutes, bucketspan should be 50m. For sparse or batch data, use larger bucketspan values.
- categorization
Field StringName - For categorization jobs only. The name of the field to categorize.
- categorization
Filters List<String> - For categorization jobs only. An array of regular expressions. A categorization message is matched against each regex in the order they are listed in the array.
- influencers List<String>
- A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration.
- latency String
- The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second.
- model
Prune StringWindow - Advanced configuration option. The time interval (in days) between pruning the model.
- multivariate
By BooleanFields - This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
- per
Partition ElasticsearchCategorization Ml Anomaly Detection Job Analysis Config Per Partition Categorization - Settings related to how categorization interacts with partition fields.
- summary
Count StringField Name - If this property is specified, the data that is fed to the job is expected to be pre-summarized.
- detectors
Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector[] - Detector configuration objects. Detectors identify the anomaly detection functions and the fields on which they operate.
- bucket
Span string - The size of the interval that the analysis is aggregated into, typically between 15m and 1h. If the anomaly detector is expecting to see data at near real-time frequency, then the bucketspan should be set to a value around 10 times the time between ingested documents. For example, if data comes every second, bucketspan should be 10s; if data comes every 5 minutes, bucketspan should be 50m. For sparse or batch data, use larger bucketspan values.
- categorization
Field stringName - For categorization jobs only. The name of the field to categorize.
- categorization
Filters string[] - For categorization jobs only. An array of regular expressions. A categorization message is matched against each regex in the order they are listed in the array.
- influencers string[]
- A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration.
- latency string
- The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second.
- model
Prune stringWindow - Advanced configuration option. The time interval (in days) between pruning the model.
- multivariate
By booleanFields - This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
- per
Partition ElasticsearchCategorization Ml Anomaly Detection Job Analysis Config Per Partition Categorization - Settings related to how categorization interacts with partition fields.
- summary
Count stringField Name - If this property is specified, the data that is fed to the job is expected to be pre-summarized.
- detectors
Sequence[Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector] - Detector configuration objects. Detectors identify the anomaly detection functions and the fields on which they operate.
- bucket_
span str - The size of the interval that the analysis is aggregated into, typically between 15m and 1h. If the anomaly detector is expecting to see data at near real-time frequency, then the bucketspan should be set to a value around 10 times the time between ingested documents. For example, if data comes every second, bucketspan should be 10s; if data comes every 5 minutes, bucketspan should be 50m. For sparse or batch data, use larger bucketspan values.
- categorization_
field_ strname - For categorization jobs only. The name of the field to categorize.
- categorization_
filters Sequence[str] - For categorization jobs only. An array of regular expressions. A categorization message is matched against each regex in the order they are listed in the array.
- influencers Sequence[str]
- A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration.
- latency str
- The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second.
- model_
prune_ strwindow - Advanced configuration option. The time interval (in days) between pruning the model.
- multivariate_
by_ boolfields - This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
- per_
partition_ Elasticsearchcategorization Ml Anomaly Detection Job Analysis Config Per Partition Categorization - Settings related to how categorization interacts with partition fields.
- summary_
count_ strfield_ name - If this property is specified, the data that is fed to the job is expected to be pre-summarized.
- detectors List<Property Map>
- Detector configuration objects. Detectors identify the anomaly detection functions and the fields on which they operate.
- bucket
Span String - The size of the interval that the analysis is aggregated into, typically between 15m and 1h. If the anomaly detector is expecting to see data at near real-time frequency, then the bucketspan should be set to a value around 10 times the time between ingested documents. For example, if data comes every second, bucketspan should be 10s; if data comes every 5 minutes, bucketspan should be 50m. For sparse or batch data, use larger bucketspan values.
- categorization
Field StringName - For categorization jobs only. The name of the field to categorize.
- categorization
Filters List<String> - For categorization jobs only. An array of regular expressions. A categorization message is matched against each regex in the order they are listed in the array.
- influencers List<String>
- A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration.
- latency String
- The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second.
- model
Prune StringWindow - Advanced configuration option. The time interval (in days) between pruning the model.
- multivariate
By BooleanFields - This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features.
- per
Partition Property MapCategorization - Settings related to how categorization interacts with partition fields.
- summary
Count StringField Name - If this property is specified, the data that is fed to the job is expected to be pre-summarized.
ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetector, ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorArgs
- Function string
- The analysis function that is used. For example, count, rare, mean, min, max, sum.
- By
Field stringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.
- Custom
Rules List<ElasticsearchMl Anomaly Detection Job Analysis Config Detector Custom Rule> - Custom rules enable you to customize the way detectors operate.
- Detector
Description string - A description of the detector.
- Exclude
Frequent string - Contains one of the following values: all, none, by, or over.
- Field
Name string - The field that the detector function analyzes. Some functions require a field. Functions that don't require a field are count, rare, and freq_rare.
- Over
Field stringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.
- Partition
Field stringName - The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.
- Use
Null bool - Defines whether a new series is used as the null series when there is no value for the by or partition fields.
- Function string
- The analysis function that is used. For example, count, rare, mean, min, max, sum.
- By
Field stringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.
- Custom
Rules []ElasticsearchMl Anomaly Detection Job Analysis Config Detector Custom Rule - Custom rules enable you to customize the way detectors operate.
- Detector
Description string - A description of the detector.
- Exclude
Frequent string - Contains one of the following values: all, none, by, or over.
- Field
Name string - The field that the detector function analyzes. Some functions require a field. Functions that don't require a field are count, rare, and freq_rare.
- Over
Field stringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.
- Partition
Field stringName - The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.
- Use
Null bool - Defines whether a new series is used as the null series when there is no value for the by or partition fields.
- function String
- The analysis function that is used. For example, count, rare, mean, min, max, sum.
- by
Field StringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.
- custom
Rules List<ElasticsearchMl Anomaly Detection Job Analysis Config Detector Custom Rule> - Custom rules enable you to customize the way detectors operate.
- detector
Description String - A description of the detector.
- exclude
Frequent String - Contains one of the following values: all, none, by, or over.
- field
Name String - The field that the detector function analyzes. Some functions require a field. Functions that don't require a field are count, rare, and freq_rare.
- over
Field StringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.
- partition
Field StringName - The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.
- use
Null Boolean - Defines whether a new series is used as the null series when there is no value for the by or partition fields.
- function string
- The analysis function that is used. For example, count, rare, mean, min, max, sum.
- by
Field stringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.
- custom
Rules ElasticsearchMl Anomaly Detection Job Analysis Config Detector Custom Rule[] - Custom rules enable you to customize the way detectors operate.
- detector
Description string - A description of the detector.
- exclude
Frequent string - Contains one of the following values: all, none, by, or over.
- field
Name string - The field that the detector function analyzes. Some functions require a field. Functions that don't require a field are count, rare, and freq_rare.
- over
Field stringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.
- partition
Field stringName - The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.
- use
Null boolean - Defines whether a new series is used as the null series when there is no value for the by or partition fields.
- function str
- The analysis function that is used. For example, count, rare, mean, min, max, sum.
- by_
field_ strname - The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.
- custom_
rules Sequence[ElasticsearchMl Anomaly Detection Job Analysis Config Detector Custom Rule] - Custom rules enable you to customize the way detectors operate.
- detector_
description str - A description of the detector.
- exclude_
frequent str - Contains one of the following values: all, none, by, or over.
- field_
name str - The field that the detector function analyzes. Some functions require a field. Functions that don't require a field are count, rare, and freq_rare.
- over_
field_ strname - The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.
- partition_
field_ strname - The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.
- use_
null bool - Defines whether a new series is used as the null series when there is no value for the by or partition fields.
- function String
- The analysis function that is used. For example, count, rare, mean, min, max, sum.
- by
Field StringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.
- custom
Rules List<Property Map> - Custom rules enable you to customize the way detectors operate.
- detector
Description String - A description of the detector.
- exclude
Frequent String - Contains one of the following values: all, none, by, or over.
- field
Name String - The field that the detector function analyzes. Some functions require a field. Functions that don't require a field are count, rare, and freq_rare.
- over
Field StringName - The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.
- partition
Field StringName - The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.
- use
Null Boolean - Defines whether a new series is used as the null series when there is no value for the by or partition fields.
ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRule, ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleArgs
- Actions List<string>
- The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.
- Conditions
List<Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector Custom Rule Condition> - An array of numeric conditions when the rule applies.
- Actions []string
- The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.
- Conditions
[]Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector Custom Rule Condition - An array of numeric conditions when the rule applies.
- actions List<String>
- The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.
- conditions
List<Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector Custom Rule Condition> - An array of numeric conditions when the rule applies.
- actions string[]
- The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.
- conditions
Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector Custom Rule Condition[] - An array of numeric conditions when the rule applies.
- actions Sequence[str]
- The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.
- conditions
Sequence[Elasticsearch
Ml Anomaly Detection Job Analysis Config Detector Custom Rule Condition] - An array of numeric conditions when the rule applies.
- actions List<String>
- The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.
- conditions List<Property Map>
- An array of numeric conditions when the rule applies.
ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleCondition, ElasticsearchMlAnomalyDetectionJobAnalysisConfigDetectorCustomRuleConditionArgs
- applies_
to str - Specifies the result property to which the condition applies.
- operator str
- Specifies the condition operator.
- value float
- The value that is compared against the applies_to field using the operator.
ElasticsearchMlAnomalyDetectionJobAnalysisConfigPerPartitionCategorization, ElasticsearchMlAnomalyDetectionJobAnalysisConfigPerPartitionCategorizationArgs
- Enabled bool
- To enable this setting, you must also set the partitionfieldname property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.
- Stop
On boolWarn - This setting can be set to true only if per-partition categorization is enabled.
- Enabled bool
- To enable this setting, you must also set the partitionfieldname property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.
- Stop
On boolWarn - This setting can be set to true only if per-partition categorization is enabled.
- enabled Boolean
- To enable this setting, you must also set the partitionfieldname property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.
- stop
On BooleanWarn - This setting can be set to true only if per-partition categorization is enabled.
- enabled boolean
- To enable this setting, you must also set the partitionfieldname property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.
- stop
On booleanWarn - This setting can be set to true only if per-partition categorization is enabled.
- enabled bool
- To enable this setting, you must also set the partitionfieldname property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.
- stop_
on_ boolwarn - This setting can be set to true only if per-partition categorization is enabled.
- enabled Boolean
- To enable this setting, you must also set the partitionfieldname property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.
- stop
On BooleanWarn - This setting can be set to true only if per-partition categorization is enabled.
ElasticsearchMlAnomalyDetectionJobAnalysisLimits, ElasticsearchMlAnomalyDetectionJobAnalysisLimitsArgs
- Categorization
Examples doubleLimit - The maximum number of examples stored per category in memory and in the results data store.
- Model
Memory stringLimit - The approximate maximum amount of memory resources that are required for analytical processing.
- Categorization
Examples float64Limit - The maximum number of examples stored per category in memory and in the results data store.
- Model
Memory stringLimit - The approximate maximum amount of memory resources that are required for analytical processing.
- categorization
Examples DoubleLimit - The maximum number of examples stored per category in memory and in the results data store.
- model
Memory StringLimit - The approximate maximum amount of memory resources that are required for analytical processing.
- categorization
Examples numberLimit - The maximum number of examples stored per category in memory and in the results data store.
- model
Memory stringLimit - The approximate maximum amount of memory resources that are required for analytical processing.
- categorization_
examples_ floatlimit - The maximum number of examples stored per category in memory and in the results data store.
- model_
memory_ strlimit - The approximate maximum amount of memory resources that are required for analytical processing.
- categorization
Examples NumberLimit - The maximum number of examples stored per category in memory and in the results data store.
- model
Memory StringLimit - The approximate maximum amount of memory resources that are required for analytical processing.
ElasticsearchMlAnomalyDetectionJobDataDescription, ElasticsearchMlAnomalyDetectionJobDataDescriptionArgs
- Time
Field string - The name of the field that contains the timestamp.
- Time
Format string - The time format, which can be epoch, epoch_ms, or a custom pattern.
- Time
Field string - The name of the field that contains the timestamp.
- Time
Format string - The time format, which can be epoch, epoch_ms, or a custom pattern.
- time
Field String - The name of the field that contains the timestamp.
- time
Format String - The time format, which can be epoch, epoch_ms, or a custom pattern.
- time
Field string - The name of the field that contains the timestamp.
- time
Format string - The time format, which can be epoch, epoch_ms, or a custom pattern.
- time_
field str - The name of the field that contains the timestamp.
- time_
format str - The time format, which can be epoch, epoch_ms, or a custom pattern.
- time
Field String - The name of the field that contains the timestamp.
- time
Format String - The time format, which can be epoch, epoch_ms, or a custom pattern.
ElasticsearchMlAnomalyDetectionJobElasticsearchConnection, ElasticsearchMlAnomalyDetectionJobElasticsearchConnectionArgs
- 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,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.
ElasticsearchMlAnomalyDetectionJobModelPlotConfig, ElasticsearchMlAnomalyDetectionJobModelPlotConfigArgs
- Annotations
Enabled bool - If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.
- Enabled bool
- If true, enables calculation and storage of the model bounds for each entity that is being analyzed.
- Terms string
- Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied.
- Annotations
Enabled bool - If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.
- Enabled bool
- If true, enables calculation and storage of the model bounds for each entity that is being analyzed.
- Terms string
- Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied.
- annotations
Enabled Boolean - If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.
- enabled Boolean
- If true, enables calculation and storage of the model bounds for each entity that is being analyzed.
- terms String
- Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied.
- annotations
Enabled boolean - If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.
- enabled boolean
- If true, enables calculation and storage of the model bounds for each entity that is being analyzed.
- terms string
- Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied.
- annotations_
enabled bool - If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.
- enabled bool
- If true, enables calculation and storage of the model bounds for each entity that is being analyzed.
- terms str
- Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied.
- annotations
Enabled Boolean - If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.
- enabled Boolean
- If true, enables calculation and storage of the model bounds for each entity that is being analyzed.
- terms String
- Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
