@piclemx/pulumi-opensearch
Version:
A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1
119 lines (118 loc) • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opensearch from "@piclemx/pulumi-opensearch";
*
* const test = new opensearch.AuditConfig("test", {
* audit: {
* disabledRestCategories: [
* "GRANTED_PRIVILEGES",
* "AUTHENTICATED",
* ],
* disabledTransportCategories: [
* "GRANTED_PRIVILEGES",
* "AUTHENTICATED",
* ],
* enableRest: true,
* enableTransport: true,
* excludeSensitiveHeaders: true,
* ignoreRequests: [
* "SearchRequest",
* "indices:data/read/*",
* "/_cluster/health",
* ],
* ignoreUsers: ["dashboardserver"],
* logRequestBody: true,
* resolveBulkRequests: true,
* resolveIndices: true,
* },
* compliance: {
* enabled: true,
* externalConfig: false,
* internalConfig: true,
* readIgnoreUsers: ["read-ignore-1"],
* readMetadataOnly: true,
* readWatchedFields: [
* {
* fields: [
* "field-1",
* "field-2",
* ],
* index: "read-index-1",
* },
* {
* fields: ["field-3"],
* index: "read-index-2",
* },
* ],
* writeIgnoreUsers: ["write-ignore-1"],
* writeLogDiffs: false,
* writeMetadataOnly: true,
* writeWatchedIndices: [
* "write-index-1",
* "write-index-2",
* "log-*",
* "*",
* ],
* },
* enabled: true,
* });
* ```
*
* ## Import
*
* Import by name
*
* ```sh
* $ pulumi import opensearch:index/auditConfig:AuditConfig test_config my-config
* ```
*/
export declare class AuditConfig extends pulumi.CustomResource {
/**
* Get an existing AuditConfig 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?: AuditConfigState, opts?: pulumi.CustomResourceOptions): AuditConfig;
/**
* Returns true if the given object is an instance of AuditConfig. 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 AuditConfig;
readonly audit: pulumi.Output<outputs.AuditConfigAudit | undefined>;
readonly compliance: pulumi.Output<outputs.AuditConfigCompliance | undefined>;
readonly enabled: pulumi.Output<boolean>;
/**
* Create a AuditConfig 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: AuditConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AuditConfig resources.
*/
export interface AuditConfigState {
audit?: pulumi.Input<inputs.AuditConfigAudit>;
compliance?: pulumi.Input<inputs.AuditConfigCompliance>;
enabled?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a AuditConfig resource.
*/
export interface AuditConfigArgs {
audit?: pulumi.Input<inputs.AuditConfigAudit>;
compliance?: pulumi.Input<inputs.AuditConfigCompliance>;
enabled: pulumi.Input<boolean>;
}