@pulumi/signalfx/webhookIntegration.d.ts

A Pulumi package for creating and managing SignalFx resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Splunk Observability Cloud webhook integration.
 *
 * > **NOTE** When managing integrations, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator). Otherwise you'll receive a 4xx error.
 *
 * ## Example
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as signalfx from "@pulumi/signalfx";
 *
 * const webhookMyteam = new signalfx.WebhookIntegration("webhook_myteam", {
 *     name: "Webhook - My Team",
 *     enabled: true,
 *     url: "https://www.example.com",
 *     sharedSecret: "abc1234",
 *     method: "POST",
 *     payloadTemplate: `{
 *   "incidentId": "{{{incidentId}}}"
 * }
 * `,
 *     headers: [{
 *         headerKey: "some_header",
 *         headerValue: "value_for_that_header",
 *     }],
 * });
 * ```
 */
export declare class WebhookIntegration extends pulumi.CustomResource {
    /**
     * Get an existing WebhookIntegration 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?: WebhookIntegrationState, opts?: pulumi.CustomResourceOptions): WebhookIntegration;
    /**
     * Returns true if the given object is an instance of WebhookIntegration.  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 WebhookIntegration;
    /**
     * Whether the integration is enabled.
     */
    readonly enabled: pulumi.Output<boolean>;
    /**
     * A header to send with the request
     */
    readonly headers: pulumi.Output<outputs.WebhookIntegrationHeader[] | undefined>;
    /**
     * HTTP method used for the webhook request, such as 'GET', 'POST' and 'PUT'
     */
    readonly method: pulumi.Output<string | undefined>;
    /**
     * Name of the integration.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Template for the payload to be sent with the webhook request in JSON format
     */
    readonly payloadTemplate: pulumi.Output<string | undefined>;
    readonly sharedSecret: pulumi.Output<string | undefined>;
    /**
     * The URL to request
     */
    readonly url: pulumi.Output<string | undefined>;
    /**
     * Create a WebhookIntegration 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: WebhookIntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering WebhookIntegration resources.
 */
export interface WebhookIntegrationState {
    /**
     * Whether the integration is enabled.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * A header to send with the request
     */
    headers?: pulumi.Input<pulumi.Input<inputs.WebhookIntegrationHeader>[]>;
    /**
     * HTTP method used for the webhook request, such as 'GET', 'POST' and 'PUT'
     */
    method?: pulumi.Input<string>;
    /**
     * Name of the integration.
     */
    name?: pulumi.Input<string>;
    /**
     * Template for the payload to be sent with the webhook request in JSON format
     */
    payloadTemplate?: pulumi.Input<string>;
    sharedSecret?: pulumi.Input<string>;
    /**
     * The URL to request
     */
    url?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a WebhookIntegration resource.
 */
export interface WebhookIntegrationArgs {
    /**
     * Whether the integration is enabled.
     */
    enabled: pulumi.Input<boolean>;
    /**
     * A header to send with the request
     */
    headers?: pulumi.Input<pulumi.Input<inputs.WebhookIntegrationHeader>[]>;
    /**
     * HTTP method used for the webhook request, such as 'GET', 'POST' and 'PUT'
     */
    method?: pulumi.Input<string>;
    /**
     * Name of the integration.
     */
    name?: pulumi.Input<string>;
    /**
     * Template for the payload to be sent with the webhook request in JSON format
     */
    payloadTemplate?: pulumi.Input<string>;
    sharedSecret?: pulumi.Input<string>;
    /**
     * The URL to request
     */
    url?: pulumi.Input<string>;
}