@pulumi/sumologic/connection.d.ts

A Pulumi package for creating and managing sumologic cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides the ability to create, read, delete, update connections.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sumologic from "@pulumi/sumologic";
 *
 * const connection = new sumologic.Connection("connection", {
 *     type: "WebhookConnection",
 *     name: "test-connection",
 *     description: "My description",
 *     url: "https://connection-endpoint.com",
 *     headers: {
 *         "X-Header": "my-header",
 *     },
 *     customHeaders: {
 *         "X-custom": "my-custom-header",
 *     },
 *     defaultPayload: `{
 *   "client" : "Sumo Logic",
 *   "eventType" : "{{Name}}",
 *   "description" : "{{Description}}",
 *   "search_url" : "{{QueryUrl}}",
 *   "num_records" : "{{NumRawResults}}",
 *   "search_results" : "{{AggregateResultsJson}}"
 * }
 * `,
 *     resolutionPayload: `{
 *   "client" : "Sumo Logic",
 *   "eventType" : "{{Name}}",
 *   "description" : "{{Description}}",
 *   "search_url" : "{{QueryUrl}}"
 * }
 * `,
 *     webhookType: "Webhook",
 * });
 * ```
 *
 * ## Import
 *
 * Connections can be imported using the connection id, e.g.:
 *
 * hcl
 *
 * ```sh
 * $ pulumi import sumologic:index/connection:Connection test 1234567890
 * ```
 */
export declare class Connection extends pulumi.CustomResource {
    /**
     * Get an existing Connection 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?: ConnectionState, opts?: pulumi.CustomResourceOptions): Connection;
    /**
     * Returns true if the given object is an instance of Connection.  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 Connection;
    /**
     * The subtype of the connection. Valid values are `Incident` and `Event`. NOTE: This is only used for the `ServiceNow` webhook type.
     */
    readonly connectionSubtype: pulumi.Output<string | undefined>;
    /**
     * Map of custom webhook headers
     */
    readonly customHeaders: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Default payload of the webhook.
     */
    readonly defaultPayload: pulumi.Output<string>;
    /**
     * Description of the connection.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Map of access authorization headers.
     */
    readonly headers: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Name of connection. Name should be a valid alphanumeric value.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Resolution payload of the webhook.
     */
    readonly resolutionPayload: pulumi.Output<string>;
    /**
     * Type of connection. Only `WebhookConnection` is implemented right now.
     */
    readonly type: pulumi.Output<string>;
    /**
     * URL for the webhook connection.
     */
    readonly url: pulumi.Output<string>;
    /**
     * Type of webhook. Valid values are `AWSLambda`, `Azure`, `Datadog`, `HipChat`, `Jira`, `PagerDuty`, `Slack`, `Webhook`, `NewRelic`, `MicrosoftTeams`, `ServiceNow`, and `SumoCloudSOAR`. Default: `Webhook`
     *
     * Additional data provided in state
     */
    readonly webhookType: pulumi.Output<string | undefined>;
    /**
     * Create a Connection 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: ConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Connection resources.
 */
export interface ConnectionState {
    /**
     * The subtype of the connection. Valid values are `Incident` and `Event`. NOTE: This is only used for the `ServiceNow` webhook type.
     */
    connectionSubtype?: pulumi.Input<string>;
    /**
     * Map of custom webhook headers
     */
    customHeaders?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Default payload of the webhook.
     */
    defaultPayload?: pulumi.Input<string>;
    /**
     * Description of the connection.
     */
    description?: pulumi.Input<string>;
    /**
     * Map of access authorization headers.
     */
    headers?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of connection. Name should be a valid alphanumeric value.
     */
    name?: pulumi.Input<string>;
    /**
     * Resolution payload of the webhook.
     */
    resolutionPayload?: pulumi.Input<string>;
    /**
     * Type of connection. Only `WebhookConnection` is implemented right now.
     */
    type?: pulumi.Input<string>;
    /**
     * URL for the webhook connection.
     */
    url?: pulumi.Input<string>;
    /**
     * Type of webhook. Valid values are `AWSLambda`, `Azure`, `Datadog`, `HipChat`, `Jira`, `PagerDuty`, `Slack`, `Webhook`, `NewRelic`, `MicrosoftTeams`, `ServiceNow`, and `SumoCloudSOAR`. Default: `Webhook`
     *
     * Additional data provided in state
     */
    webhookType?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Connection resource.
 */
export interface ConnectionArgs {
    /**
     * The subtype of the connection. Valid values are `Incident` and `Event`. NOTE: This is only used for the `ServiceNow` webhook type.
     */
    connectionSubtype?: pulumi.Input<string>;
    /**
     * Map of custom webhook headers
     */
    customHeaders?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Default payload of the webhook.
     */
    defaultPayload: pulumi.Input<string>;
    /**
     * Description of the connection.
     */
    description?: pulumi.Input<string>;
    /**
     * Map of access authorization headers.
     */
    headers?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of connection. Name should be a valid alphanumeric value.
     */
    name?: pulumi.Input<string>;
    /**
     * Resolution payload of the webhook.
     */
    resolutionPayload?: pulumi.Input<string>;
    /**
     * Type of connection. Only `WebhookConnection` is implemented right now.
     */
    type: pulumi.Input<string>;
    /**
     * URL for the webhook connection.
     */
    url: pulumi.Input<string>;
    /**
     * Type of webhook. Valid values are `AWSLambda`, `Azure`, `Datadog`, `HipChat`, `Jira`, `PagerDuty`, `Slack`, `Webhook`, `NewRelic`, `MicrosoftTeams`, `ServiceNow`, and `SumoCloudSOAR`. Default: `Webhook`
     *
     * Additional data provided in state
     */
    webhookType?: pulumi.Input<string>;
}