@piclemx/pulumi-opensearch
Version:
A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1
111 lines (110 loc) • 3.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an OpenSearch anonaly detection. Please refer to the OpenSearch anomaly detection documentation for details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opensearch from "@piclemx/pulumi-opensearch";
*
* const foo = new opensearch.AnomalyDetection("foo", {body: `{
* "name": "foo",
* "description": "Test detector",
* "time_field": "@timestamp",
* "indices": [
* "security-auditlog*"
* ],
* "feature_attributes": [
* {
* "feature_name": "test",
* "feature_enabled": true,
* "aggregation_query": {
* "test": {
* "value_count": {
* "field": "audit_category.keyword"
* }
* }
* }
* }
* ],
* "filter_query": {
* "bool": {
* "filter": [
* {
* "range": {
* "value": {
* "gt": 1
* }
* }
* }
* ],
* "adjust_pure_negative": true,
* "boost": 1
* }
* },
* "detection_interval": {
* "period": {
* "interval": 1,
* "unit": "Minutes"
* }
* },
* "window_delay": {
* "period": {
* "interval": 1,
* "unit": "Minutes"
* }
* },
* "result_index" : "opensearch-ad-plugin-result-test"
* }
*
* `});
* ```
*/
export declare class AnomalyDetection extends pulumi.CustomResource {
/**
* Get an existing AnomalyDetection resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AnomalyDetectionState, opts?: pulumi.CustomResourceOptions): AnomalyDetection;
/**
* Returns true if the given object is an instance of AnomalyDetection. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AnomalyDetection;
/**
* The anomaly detection document
*/
readonly body: pulumi.Output<string>;
/**
* Create a AnomalyDetection resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AnomalyDetectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AnomalyDetection resources.
*/
export interface AnomalyDetectionState {
/**
* The anomaly detection document
*/
body?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AnomalyDetection resource.
*/
export interface AnomalyDetectionArgs {
/**
* The anomaly detection document
*/
body: pulumi.Input<string>;
}