@piclemx/pulumi-opensearch/snapshotRepository.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 snapshot repository resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as opensearch from "@piclemx/pulumi-opensearch";
 *
 * // Create a snapshot repository
 * const repo = new opensearch.SnapshotRepository("repo", {
 *     settings: {
 *         bucket: "es-index-backups",
 *         region: "us-east-1",
 *         role_arn: "arn:aws:iam::123456789012:role/MyRole",
 *     },
 *     type: "s3",
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 *  $ pulumi import opensearch:index/snapshotRepository:SnapshotRepository repo es-index-backups
 * ```
 */
export declare class SnapshotRepository extends pulumi.CustomResource {
    /**
     * Get an existing SnapshotRepository 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?: SnapshotRepositoryState, opts?: pulumi.CustomResourceOptions): SnapshotRepository;
    /**
     * Returns true if the given object is an instance of SnapshotRepository.  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 SnapshotRepository;
    /**
     * The name of the repository.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The settings map applicable for the backend, see official documentation for plugins.
     */
    readonly settings: pulumi.Output<{
        [key: string]: any;
    } | undefined>;
    /**
     * The name of the repository backend (required plugins must be installed).
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a SnapshotRepository 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: SnapshotRepositoryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SnapshotRepository resources.
 */
export interface SnapshotRepositoryState {
    /**
     * The name of the repository.
     */
    name?: pulumi.Input<string>;
    /**
     * The settings map applicable for the backend, see official documentation for plugins.
     */
    settings?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The name of the repository backend (required plugins must be installed).
     */
    type?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SnapshotRepository resource.
 */
export interface SnapshotRepositoryArgs {
    /**
     * The name of the repository.
     */
    name?: pulumi.Input<string>;
    /**
     * The settings map applicable for the backend, see official documentation for plugins.
     */
    settings?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The name of the repository backend (required plugins must be installed).
     */
    type: pulumi.Input<string>;
}