@piclemx/pulumi-opensearch
Version:
A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1
81 lines (80 loc) • 2.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an OpenSearch channel configuration. Please refer to the OpenSearch channel configuration documentation for details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opensearch from "@piclemx/pulumi-opensearch";
*
* // Create a channel configuration
* const configuration1 = new opensearch.ChannelConfiguration("configuration1", {body: `{
* "config_id": "configuration_1",
* "config": {
* "name": "name",
* "description" : "description",
* "config_type" : "slack",
* "is_enabled" : true,
* "slack": {
* "url": "https://sample-slack-webhook"
* }
* }
* }
*
* `});
* ```
*
* ## Import
*
* ```sh
* $ pulumi import opensearch:index/channelConfiguration:ChannelConfiguration configuration_1 configuration_1
* ```
*/
export declare class ChannelConfiguration extends pulumi.CustomResource {
/**
* Get an existing ChannelConfiguration 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?: ChannelConfigurationState, opts?: pulumi.CustomResourceOptions): ChannelConfiguration;
/**
* Returns true if the given object is an instance of ChannelConfiguration. 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 ChannelConfiguration;
/**
* The channel configuration document
*/
readonly body: pulumi.Output<string>;
/**
* Create a ChannelConfiguration 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: ChannelConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ChannelConfiguration resources.
*/
export interface ChannelConfigurationState {
/**
* The channel configuration document
*/
body?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ChannelConfiguration resource.
*/
export interface ChannelConfigurationArgs {
/**
* The channel configuration document
*/
body: pulumi.Input<string>;
}