@piclemx/pulumi-opensearch/ismPolicyMapping.d.ts

A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides an OpenSearch Index State Management (ISM) policy. Please refer to the OpenSearch ISM documentation for details.
 *
 * !> `opensearch.IsmPolicyMapping` is deprecated in OpenSearch 1.x please use the `opensearch.IsmPolicy` resource and specify the `ismTemplate` attribute in the policies instead.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as opensearch from "@piclemx/pulumi-opensearch";
 *
 * const test = new opensearch.IsmPolicyMapping("test", {
 *     indexes: "test_index",
 *     policyId: "policy_1",
 *     state: "delete",
 * });
 * ```
 *
 * ## Import
 *
 * Import by poilcy_id
 *
 * ```sh
 *  $ pulumi import opensearch:index/ismPolicyMapping:IsmPolicyMapping test policy_1
 * ```
 */
export declare class IsmPolicyMapping extends pulumi.CustomResource {
    /**
     * Get an existing IsmPolicyMapping 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?: IsmPolicyMappingState, opts?: pulumi.CustomResourceOptions): IsmPolicyMapping;
    /**
     * Returns true if the given object is an instance of IsmPolicyMapping.  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 IsmPolicyMapping;
    /**
     * When updating multiple indices, you might want to include a state filter to only affect certain managed indices. The background process only applies the change if the index is currently in the state specified.
     */
    readonly includes: pulumi.Output<{
        [key: string]: any;
    }[] | undefined>;
    /**
     * Name of the index to apply the policy to. You can use an index pattern to update multiple indices at once.
     */
    readonly indexes: pulumi.Output<string>;
    readonly isSafe: pulumi.Output<boolean | undefined>;
    readonly managedIndexes: pulumi.Output<string[]>;
    /**
     * The name of the policy.
     */
    readonly policyId: pulumi.Output<string>;
    /**
     * After a change in policy takes place, specify the state for the index to transition to
     */
    readonly state: pulumi.Output<string | undefined>;
    /**
     * Create a IsmPolicyMapping 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: IsmPolicyMappingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IsmPolicyMapping resources.
 */
export interface IsmPolicyMappingState {
    /**
     * When updating multiple indices, you might want to include a state filter to only affect certain managed indices. The background process only applies the change if the index is currently in the state specified.
     */
    includes?: pulumi.Input<pulumi.Input<{
        [key: string]: any;
    }>[]>;
    /**
     * Name of the index to apply the policy to. You can use an index pattern to update multiple indices at once.
     */
    indexes?: pulumi.Input<string>;
    isSafe?: pulumi.Input<boolean>;
    managedIndexes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The name of the policy.
     */
    policyId?: pulumi.Input<string>;
    /**
     * After a change in policy takes place, specify the state for the index to transition to
     */
    state?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IsmPolicyMapping resource.
 */
export interface IsmPolicyMappingArgs {
    /**
     * When updating multiple indices, you might want to include a state filter to only affect certain managed indices. The background process only applies the change if the index is currently in the state specified.
     */
    includes?: pulumi.Input<pulumi.Input<{
        [key: string]: any;
    }>[]>;
    /**
     * Name of the index to apply the policy to. You can use an index pattern to update multiple indices at once.
     */
    indexes: pulumi.Input<string>;
    isSafe?: pulumi.Input<boolean>;
    managedIndexes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The name of the policy.
     */
    policyId: pulumi.Input<string>;
    /**
     * After a change in policy takes place, specify the state for the index to transition to
     */
    state?: pulumi.Input<string>;
}