@piclemx/pulumi-opensearch/role.js

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

"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Role = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Provides an OpenSearch security role resource. Please refer to the OpenSearch Access Control documentation for details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as opensearch from "@piclemx/pulumi-opensearch";
 *
 * // To set document level permissions:
 * const writer = new opensearch.Role("writer", {
 *     clusterPermissions: ["*"],
 *     indexPermissions: [{
 *         allowedActions: ["read"],
 *         documentLevelSecurity: "{\"term\": { \"readable_by\": \"${user.name}\"}}",
 *         indexPatterns: ["pub*"],
 *     }],
 *     roleName: "foo_writer",
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 *  $ pulumi import opensearch:index/role:Role writer logs_writer
 * ```
 */
class Role extends pulumi.CustomResource {
    /**
     * Get an existing Role 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, id, state, opts) {
        return new Role(name, state, Object.assign(Object.assign({}, opts), { id: id }));
    }
    /**
     * Returns true if the given object is an instance of Role.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj) {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === Role.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["clusterPermissions"] = state ? state.clusterPermissions : undefined;
            resourceInputs["description"] = state ? state.description : undefined;
            resourceInputs["indexPermissions"] = state ? state.indexPermissions : undefined;
            resourceInputs["roleName"] = state ? state.roleName : undefined;
            resourceInputs["tenantPermissions"] = state ? state.tenantPermissions : undefined;
        }
        else {
            const args = argsOrState;
            if ((!args || args.roleName === undefined) && !opts.urn) {
                throw new Error("Missing required property 'roleName'");
            }
            resourceInputs["clusterPermissions"] = args ? args.clusterPermissions : undefined;
            resourceInputs["description"] = args ? args.description : undefined;
            resourceInputs["indexPermissions"] = args ? args.indexPermissions : undefined;
            resourceInputs["roleName"] = args ? args.roleName : undefined;
            resourceInputs["tenantPermissions"] = args ? args.tenantPermissions : undefined;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(Role.__pulumiType, name, resourceInputs, opts);
    }
}
exports.Role = Role;
/** @internal */
Role.__pulumiType = 'opensearch:index/role:Role';
//# sourceMappingURL=role.js.map