@piclemx/pulumi-opensearch/dashboardTenant.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 dashboard tenant resource. Please refer to the OpenSearch documentation for details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as opensearch from "@piclemx/pulumi-opensearch";
 *
 * // Create a tenant
 * const test = new opensearch.DashboardTenant("test", {
 *     description: "test tenant",
 *     tenantName: "test",
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 *  $ pulumi import opensearch:index/dashboardTenant:DashboardTenant writer test
 * ```
 */
export declare class DashboardTenant extends pulumi.CustomResource {
    /**
     * Get an existing DashboardTenant 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?: DashboardTenantState, opts?: pulumi.CustomResourceOptions): DashboardTenant;
    /**
     * Returns true if the given object is an instance of DashboardTenant.  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 DashboardTenant;
    /**
     * Description of the tenant.
     */
    readonly description: pulumi.Output<string | undefined>;
    readonly index: pulumi.Output<string>;
    /**
     * The name of the tenant.
     */
    readonly tenantName: pulumi.Output<string>;
    /**
     * Create a DashboardTenant 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: DashboardTenantArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DashboardTenant resources.
 */
export interface DashboardTenantState {
    /**
     * Description of the tenant.
     */
    description?: pulumi.Input<string>;
    index?: pulumi.Input<string>;
    /**
     * The name of the tenant.
     */
    tenantName?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DashboardTenant resource.
 */
export interface DashboardTenantArgs {
    /**
     * Description of the tenant.
     */
    description?: pulumi.Input<string>;
    /**
     * The name of the tenant.
     */
    tenantName: pulumi.Input<string>;
}