elasticsearchTransform.ts

// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
import * as utilities from "./utilities";

export class ElasticsearchTransform extends pulumi.CustomResource {
    /**
     * Get an existing ElasticsearchTransform 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.
     */
    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ElasticsearchTransformState, opts?: pulumi.CustomResourceOptions): ElasticsearchTransform {
        return new ElasticsearchTransform(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'elasticstack:index/elasticsearchTransform:ElasticsearchTransform';

    /**
     * Returns true if the given object is an instance of ElasticsearchTransform.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    public static isInstance(obj: any): obj is ElasticsearchTransform {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === ElasticsearchTransform.__pulumiType;
    }

    /**
     * Specifies whether the transform checkpoint ranges should be optimized for performance.
     */
    declare public readonly alignCheckpoints: pulumi.Output<boolean | undefined>;
    /**
     * Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
     */
    declare public readonly datesAsEpochMillis: pulumi.Output<boolean | undefined>;
    /**
     * Specifies whether the transform should deduce the destination index mappings from the transform config.
     */
    declare public readonly deduceMappings: pulumi.Output<boolean | undefined>;
    /**
     * When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may
     * be desired if the source index does not exist until after the transform is created. Default is `false`
     */
    declare public readonly deferValidation: pulumi.Output<boolean | undefined>;
    /**
     * Free text description of the transform.
     */
    declare public readonly description: pulumi.Output<string | undefined>;
    /**
     * The destination for the transform.
     */
    declare public readonly destination: pulumi.Output<outputs.ElasticsearchTransformDestination>;
    /**
     * Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
     */
    declare public readonly docsPerSecond: pulumi.Output<number | undefined>;
    /**
     * Controls whether the transform should be started or stopped. Default is `false` (stopped).
     */
    declare public readonly enabled: pulumi.Output<boolean | undefined>;
    /**
     * The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
     * `1m`.
     */
    declare public readonly frequency: pulumi.Output<string | undefined>;
    /**
     * The latest method transforms the data by finding the latest document for each unique key. JSON definition expected.
     * Either 'pivot' or 'latest' must be present.
     */
    declare public readonly latest: pulumi.Output<string | undefined>;
    /**
     * Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
     */
    declare public readonly maxPageSearchSize: pulumi.Output<number | undefined>;
    /**
     * Defines optional transform metadata.
     */
    declare public readonly metadata: pulumi.Output<string | undefined>;
    /**
     * Name of the transform you wish to create.
     */
    declare public readonly name: pulumi.Output<string>;
    /**
     * Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value
     * is the cluster-level setting num_transform_failure_retries.
     */
    declare public readonly numFailureRetries: pulumi.Output<number | undefined>;
    /**
     * The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or
     * 'latest' must be present.
     */
    declare public readonly pivot: pulumi.Output<string | undefined>;
    /**
     * Defines a retention policy for the transform.
     */
    declare public readonly retentionPolicy: pulumi.Output<outputs.ElasticsearchTransformRetentionPolicy | undefined>;
    /**
     * The source of the data for the transform.
     */
    declare public readonly source: pulumi.Output<outputs.ElasticsearchTransformSource>;
    /**
     * Defines the properties transforms require to run continuously.
     */
    declare public readonly sync: pulumi.Output<outputs.ElasticsearchTransformSync | undefined>;
    /**
     * Period to wait for a response from Elasticsearch when performing any management operation. If no response is received
     * before the timeout expires, the operation fails and returns an error. Defaults to `30s`.
     */
    declare public readonly timeout: pulumi.Output<string | undefined>;
    /**
     * In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
     */
    declare public readonly unattended: pulumi.Output<boolean | undefined>;

    /**
     * Create a ElasticsearchTransform 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: ElasticsearchTransformArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: ElasticsearchTransformArgs | ElasticsearchTransformState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as ElasticsearchTransformState | undefined;
            resourceInputs["alignCheckpoints"] = state?.alignCheckpoints;
            resourceInputs["datesAsEpochMillis"] = state?.datesAsEpochMillis;
            resourceInputs["deduceMappings"] = state?.deduceMappings;
            resourceInputs["deferValidation"] = state?.deferValidation;
            resourceInputs["description"] = state?.description;
            resourceInputs["destination"] = state?.destination;
            resourceInputs["docsPerSecond"] = state?.docsPerSecond;
            resourceInputs["enabled"] = state?.enabled;
            resourceInputs["frequency"] = state?.frequency;
            resourceInputs["latest"] = state?.latest;
            resourceInputs["maxPageSearchSize"] = state?.maxPageSearchSize;
            resourceInputs["metadata"] = state?.metadata;
            resourceInputs["name"] = state?.name;
            resourceInputs["numFailureRetries"] = state?.numFailureRetries;
            resourceInputs["pivot"] = state?.pivot;
            resourceInputs["retentionPolicy"] = state?.retentionPolicy;
            resourceInputs["source"] = state?.source;
            resourceInputs["sync"] = state?.sync;
            resourceInputs["timeout"] = state?.timeout;
            resourceInputs["unattended"] = state?.unattended;
        } else {
            const args = argsOrState as ElasticsearchTransformArgs | undefined;
            if (args?.destination === undefined && !opts.urn) {
                throw new Error("Missing required property 'destination'");
            }
            if (args?.source === undefined && !opts.urn) {
                throw new Error("Missing required property 'source'");
            }
            resourceInputs["alignCheckpoints"] = args?.alignCheckpoints;
            resourceInputs["datesAsEpochMillis"] = args?.datesAsEpochMillis;
            resourceInputs["deduceMappings"] = args?.deduceMappings;
            resourceInputs["deferValidation"] = args?.deferValidation;
            resourceInputs["description"] = args?.description;
            resourceInputs["destination"] = args?.destination;
            resourceInputs["docsPerSecond"] = args?.docsPerSecond;
            resourceInputs["enabled"] = args?.enabled;
            resourceInputs["frequency"] = args?.frequency;
            resourceInputs["latest"] = args?.latest;
            resourceInputs["maxPageSearchSize"] = args?.maxPageSearchSize;
            resourceInputs["metadata"] = args?.metadata;
            resourceInputs["name"] = args?.name;
            resourceInputs["numFailureRetries"] = args?.numFailureRetries;
            resourceInputs["pivot"] = args?.pivot;
            resourceInputs["retentionPolicy"] = args?.retentionPolicy;
            resourceInputs["source"] = args?.source;
            resourceInputs["sync"] = args?.sync;
            resourceInputs["timeout"] = args?.timeout;
            resourceInputs["unattended"] = args?.unattended;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(ElasticsearchTransform.__pulumiType, name, resourceInputs, opts, false /*dependency*/, utilities.getPackage());
    }
}

/**
 * Input properties used for looking up and filtering ElasticsearchTransform resources.
 */
export interface ElasticsearchTransformState {
    /**
     * Specifies whether the transform checkpoint ranges should be optimized for performance.
     */
    alignCheckpoints?: pulumi.Input<boolean>;
    /**
     * Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
     */
    datesAsEpochMillis?: pulumi.Input<boolean>;
    /**
     * Specifies whether the transform should deduce the destination index mappings from the transform config.
     */
    deduceMappings?: pulumi.Input<boolean>;
    /**
     * When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may
     * be desired if the source index does not exist until after the transform is created. Default is `false`
     */
    deferValidation?: pulumi.Input<boolean>;
    /**
     * Free text description of the transform.
     */
    description?: pulumi.Input<string>;
    /**
     * The destination for the transform.
     */
    destination?: pulumi.Input<inputs.ElasticsearchTransformDestination>;
    /**
     * Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
     */
    docsPerSecond?: pulumi.Input<number>;
    /**
     * Controls whether the transform should be started or stopped. Default is `false` (stopped).
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
     * `1m`.
     */
    frequency?: pulumi.Input<string>;
    /**
     * The latest method transforms the data by finding the latest document for each unique key. JSON definition expected.
     * Either 'pivot' or 'latest' must be present.
     */
    latest?: pulumi.Input<string>;
    /**
     * Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
     */
    maxPageSearchSize?: pulumi.Input<number>;
    /**
     * Defines optional transform metadata.
     */
    metadata?: pulumi.Input<string>;
    /**
     * Name of the transform you wish to create.
     */
    name?: pulumi.Input<string>;
    /**
     * Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value
     * is the cluster-level setting num_transform_failure_retries.
     */
    numFailureRetries?: pulumi.Input<number>;
    /**
     * The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or
     * 'latest' must be present.
     */
    pivot?: pulumi.Input<string>;
    /**
     * Defines a retention policy for the transform.
     */
    retentionPolicy?: pulumi.Input<inputs.ElasticsearchTransformRetentionPolicy>;
    /**
     * The source of the data for the transform.
     */
    source?: pulumi.Input<inputs.ElasticsearchTransformSource>;
    /**
     * Defines the properties transforms require to run continuously.
     */
    sync?: pulumi.Input<inputs.ElasticsearchTransformSync>;
    /**
     * Period to wait for a response from Elasticsearch when performing any management operation. If no response is received
     * before the timeout expires, the operation fails and returns an error. Defaults to `30s`.
     */
    timeout?: pulumi.Input<string>;
    /**
     * In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
     */
    unattended?: pulumi.Input<boolean>;
}

/**
 * The set of arguments for constructing a ElasticsearchTransform resource.
 */
export interface ElasticsearchTransformArgs {
    /**
     * Specifies whether the transform checkpoint ranges should be optimized for performance.
     */
    alignCheckpoints?: pulumi.Input<boolean>;
    /**
     * Defines if dates in the output should be written as ISO formatted string (default) or as millis since epoch.
     */
    datesAsEpochMillis?: pulumi.Input<boolean>;
    /**
     * Specifies whether the transform should deduce the destination index mappings from the transform config.
     */
    deduceMappings?: pulumi.Input<boolean>;
    /**
     * When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may
     * be desired if the source index does not exist until after the transform is created. Default is `false`
     */
    deferValidation?: pulumi.Input<boolean>;
    /**
     * Free text description of the transform.
     */
    description?: pulumi.Input<string>;
    /**
     * The destination for the transform.
     */
    destination: pulumi.Input<inputs.ElasticsearchTransformDestination>;
    /**
     * Specifies a limit on the number of input documents per second. Default (unset) value disables throttling.
     */
    docsPerSecond?: pulumi.Input<number>;
    /**
     * Controls whether the transform should be started or stopped. Default is `false` (stopped).
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The interval between checks for changes in the source indices when the transform is running continuously. Defaults to
     * `1m`.
     */
    frequency?: pulumi.Input<string>;
    /**
     * The latest method transforms the data by finding the latest document for each unique key. JSON definition expected.
     * Either 'pivot' or 'latest' must be present.
     */
    latest?: pulumi.Input<string>;
    /**
     * Defines the initial page size to use for the composite aggregation for each checkpoint. Default is 500.
     */
    maxPageSearchSize?: pulumi.Input<number>;
    /**
     * Defines optional transform metadata.
     */
    metadata?: pulumi.Input<string>;
    /**
     * Name of the transform you wish to create.
     */
    name?: pulumi.Input<string>;
    /**
     * Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value
     * is the cluster-level setting num_transform_failure_retries.
     */
    numFailureRetries?: pulumi.Input<number>;
    /**
     * The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or
     * 'latest' must be present.
     */
    pivot?: pulumi.Input<string>;
    /**
     * Defines a retention policy for the transform.
     */
    retentionPolicy?: pulumi.Input<inputs.ElasticsearchTransformRetentionPolicy>;
    /**
     * The source of the data for the transform.
     */
    source: pulumi.Input<inputs.ElasticsearchTransformSource>;
    /**
     * Defines the properties transforms require to run continuously.
     */
    sync?: pulumi.Input<inputs.ElasticsearchTransformSync>;
    /**
     * Period to wait for a response from Elasticsearch when performing any management operation. If no response is received
     * before the timeout expires, the operation fails and returns an error. Defaults to `30s`.
     */
    timeout?: pulumi.Input<string>;
    /**
     * In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails.
     */
    unattended?: pulumi.Input<boolean>;
}