elasticsearchSnapshotLifecycle.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 ElasticsearchSnapshotLifecycle extends pulumi.CustomResource {
    /**
     * Get an existing ElasticsearchSnapshotLifecycle 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?: ElasticsearchSnapshotLifecycleState, opts?: pulumi.CustomResourceOptions): ElasticsearchSnapshotLifecycle {
        return new ElasticsearchSnapshotLifecycle(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'elasticstack:index/elasticsearchSnapshotLifecycle:ElasticsearchSnapshotLifecycle';

    /**
     * Returns true if the given object is an instance of ElasticsearchSnapshotLifecycle.  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 ElasticsearchSnapshotLifecycle {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === ElasticsearchSnapshotLifecycle.__pulumiType;
    }

    /**
     * Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the
     * Elasticsearch connection via the provider configuration instead.
     *
     * @deprecated Deprecated
     */
    declare public readonly elasticsearchConnection: pulumi.Output<outputs.ElasticsearchSnapshotLifecycleElasticsearchConnection | undefined>;
    /**
     * Determines how wildcard patterns in the `indices` parameter match data streams and indices. Supports comma-separated
     * values, such as `closed,hidden`.
     */
    declare public readonly expandWildcards: pulumi.Output<string | undefined>;
    /**
     * Time period after which a snapshot is considered expired and eligible for deletion.
     */
    declare public readonly expireAfter: pulumi.Output<string | undefined>;
    /**
     * Feature states to include in the snapshot.
     */
    declare public readonly featureStates: pulumi.Output<string[]>;
    /**
     * If `false`, the snapshot fails if any data stream or index in indices is missing or closed. If `true`, the snapshot
     * ignores missing or closed data streams and indices.
     */
    declare public readonly ignoreUnavailable: pulumi.Output<boolean | undefined>;
    /**
     * If `true`, include the cluster state in the snapshot.
     */
    declare public readonly includeGlobalState: pulumi.Output<boolean | undefined>;
    /**
     * Comma-separated list of data streams and indices to include in the snapshot.
     */
    declare public readonly indices: pulumi.Output<string[]>;
    /**
     * Maximum number of snapshots to retain, even if the snapshots have not yet expired.
     */
    declare public readonly maxCount: pulumi.Output<number | undefined>;
    /**
     * Attaches arbitrary metadata to the snapshot.
     */
    declare public readonly metadata: pulumi.Output<string>;
    /**
     * Minimum number of snapshots to retain, even if the snapshots have expired.
     */
    declare public readonly minCount: pulumi.Output<number | undefined>;
    /**
     * ID for the snapshot lifecycle policy you want to create or update.
     */
    declare public readonly name: pulumi.Output<string>;
    /**
     * If `false`, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards
     * available.
     */
    declare public readonly partial: pulumi.Output<boolean | undefined>;
    /**
     * Repository used to store snapshots created by this policy.
     */
    declare public readonly repository: pulumi.Output<string>;
    /**
     * Periodic or absolute schedule at which the policy creates snapshots.
     */
    declare public readonly schedule: pulumi.Output<string>;
    /**
     * Name automatically assigned to each snapshot created by the policy.
     */
    declare public readonly snapshotName: pulumi.Output<string | undefined>;

    /**
     * Create a ElasticsearchSnapshotLifecycle 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: ElasticsearchSnapshotLifecycleArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: ElasticsearchSnapshotLifecycleArgs | ElasticsearchSnapshotLifecycleState, opts?: pulumi.CustomResourceOptions) {
        let resourceInputs: pulumi.Inputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState as ElasticsearchSnapshotLifecycleState | undefined;
            resourceInputs["elasticsearchConnection"] = state?.elasticsearchConnection;
            resourceInputs["expandWildcards"] = state?.expandWildcards;
            resourceInputs["expireAfter"] = state?.expireAfter;
            resourceInputs["featureStates"] = state?.featureStates;
            resourceInputs["ignoreUnavailable"] = state?.ignoreUnavailable;
            resourceInputs["includeGlobalState"] = state?.includeGlobalState;
            resourceInputs["indices"] = state?.indices;
            resourceInputs["maxCount"] = state?.maxCount;
            resourceInputs["metadata"] = state?.metadata;
            resourceInputs["minCount"] = state?.minCount;
            resourceInputs["name"] = state?.name;
            resourceInputs["partial"] = state?.partial;
            resourceInputs["repository"] = state?.repository;
            resourceInputs["schedule"] = state?.schedule;
            resourceInputs["snapshotName"] = state?.snapshotName;
        } else {
            const args = argsOrState as ElasticsearchSnapshotLifecycleArgs | undefined;
            if (args?.repository === undefined && !opts.urn) {
                throw new Error("Missing required property 'repository'");
            }
            if (args?.schedule === undefined && !opts.urn) {
                throw new Error("Missing required property 'schedule'");
            }
            resourceInputs["elasticsearchConnection"] = args?.elasticsearchConnection;
            resourceInputs["expandWildcards"] = args?.expandWildcards;
            resourceInputs["expireAfter"] = args?.expireAfter;
            resourceInputs["featureStates"] = args?.featureStates;
            resourceInputs["ignoreUnavailable"] = args?.ignoreUnavailable;
            resourceInputs["includeGlobalState"] = args?.includeGlobalState;
            resourceInputs["indices"] = args?.indices;
            resourceInputs["maxCount"] = args?.maxCount;
            resourceInputs["metadata"] = args?.metadata;
            resourceInputs["minCount"] = args?.minCount;
            resourceInputs["name"] = args?.name;
            resourceInputs["partial"] = args?.partial;
            resourceInputs["repository"] = args?.repository;
            resourceInputs["schedule"] = args?.schedule;
            resourceInputs["snapshotName"] = args?.snapshotName;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(ElasticsearchSnapshotLifecycle.__pulumiType, name, resourceInputs, opts, false /*dependency*/, utilities.getPackage());
    }
}

/**
 * Input properties used for looking up and filtering ElasticsearchSnapshotLifecycle resources.
 */
export interface ElasticsearchSnapshotLifecycleState {
    /**
     * Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the
     * Elasticsearch connection via the provider configuration instead.
     *
     * @deprecated Deprecated
     */
    elasticsearchConnection?: pulumi.Input<inputs.ElasticsearchSnapshotLifecycleElasticsearchConnection>;
    /**
     * Determines how wildcard patterns in the `indices` parameter match data streams and indices. Supports comma-separated
     * values, such as `closed,hidden`.
     */
    expandWildcards?: pulumi.Input<string>;
    /**
     * Time period after which a snapshot is considered expired and eligible for deletion.
     */
    expireAfter?: pulumi.Input<string>;
    /**
     * Feature states to include in the snapshot.
     */
    featureStates?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * If `false`, the snapshot fails if any data stream or index in indices is missing or closed. If `true`, the snapshot
     * ignores missing or closed data streams and indices.
     */
    ignoreUnavailable?: pulumi.Input<boolean>;
    /**
     * If `true`, include the cluster state in the snapshot.
     */
    includeGlobalState?: pulumi.Input<boolean>;
    /**
     * Comma-separated list of data streams and indices to include in the snapshot.
     */
    indices?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Maximum number of snapshots to retain, even if the snapshots have not yet expired.
     */
    maxCount?: pulumi.Input<number>;
    /**
     * Attaches arbitrary metadata to the snapshot.
     */
    metadata?: pulumi.Input<string>;
    /**
     * Minimum number of snapshots to retain, even if the snapshots have expired.
     */
    minCount?: pulumi.Input<number>;
    /**
     * ID for the snapshot lifecycle policy you want to create or update.
     */
    name?: pulumi.Input<string>;
    /**
     * If `false`, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards
     * available.
     */
    partial?: pulumi.Input<boolean>;
    /**
     * Repository used to store snapshots created by this policy.
     */
    repository?: pulumi.Input<string>;
    /**
     * Periodic or absolute schedule at which the policy creates snapshots.
     */
    schedule?: pulumi.Input<string>;
    /**
     * Name automatically assigned to each snapshot created by the policy.
     */
    snapshotName?: pulumi.Input<string>;
}

/**
 * The set of arguments for constructing a ElasticsearchSnapshotLifecycle resource.
 */
export interface ElasticsearchSnapshotLifecycleArgs {
    /**
     * Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the
     * Elasticsearch connection via the provider configuration instead.
     *
     * @deprecated Deprecated
     */
    elasticsearchConnection?: pulumi.Input<inputs.ElasticsearchSnapshotLifecycleElasticsearchConnection>;
    /**
     * Determines how wildcard patterns in the `indices` parameter match data streams and indices. Supports comma-separated
     * values, such as `closed,hidden`.
     */
    expandWildcards?: pulumi.Input<string>;
    /**
     * Time period after which a snapshot is considered expired and eligible for deletion.
     */
    expireAfter?: pulumi.Input<string>;
    /**
     * Feature states to include in the snapshot.
     */
    featureStates?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * If `false`, the snapshot fails if any data stream or index in indices is missing or closed. If `true`, the snapshot
     * ignores missing or closed data streams and indices.
     */
    ignoreUnavailable?: pulumi.Input<boolean>;
    /**
     * If `true`, include the cluster state in the snapshot.
     */
    includeGlobalState?: pulumi.Input<boolean>;
    /**
     * Comma-separated list of data streams and indices to include in the snapshot.
     */
    indices?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Maximum number of snapshots to retain, even if the snapshots have not yet expired.
     */
    maxCount?: pulumi.Input<number>;
    /**
     * Attaches arbitrary metadata to the snapshot.
     */
    metadata?: pulumi.Input<string>;
    /**
     * Minimum number of snapshots to retain, even if the snapshots have expired.
     */
    minCount?: pulumi.Input<number>;
    /**
     * ID for the snapshot lifecycle policy you want to create or update.
     */
    name?: pulumi.Input<string>;
    /**
     * If `false`, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards
     * available.
     */
    partial?: pulumi.Input<boolean>;
    /**
     * Repository used to store snapshots created by this policy.
     */
    repository: pulumi.Input<string>;
    /**
     * Periodic or absolute schedule at which the policy creates snapshots.
     */
    schedule: pulumi.Input<string>;
    /**
     * Name automatically assigned to each snapshot created by the policy.
     */
    snapshotName?: pulumi.Input<string>;
}