@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
300 lines (299 loc) • 12.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource manages Site Webhooks.
*
* A Site Webhook is a configuration that allows real-time events and data from a specific site to be pushed to a provided url.\
* It enables the collection of information about various topics such as device events, alarms, audits, client sessions and location updates at the site level.\
* The Webhook can be set up and customized using the Mist API, allowing users to receive and analyze specific data from a particular site.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as junipermist from "@pulumi/juniper-mist";
*
* const webhookOne = new junipermist.site.Webhook("webhook_one", {
* siteId: terraformSite.id,
* name: "webhook_one",
* type: "http-post",
* url: "https://myserver.com:4321/",
* verifyCert: false,
* enabled: true,
* topics: [
* "device-events",
* "alarms",
* "audits",
* "client-join",
* "client-info",
* "client-sessions",
* "device-updowns",
* "mxedge-events",
* "nac-events",
* "nac-accounting",
* ],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `mist_site_webhook` with:
*
* Site Webhook can be imported by specifying the site_id and the webhook_id
*
* ```sh
* $ pulumi import junipermist:site/webhook:Webhook webhook_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
* ```
*/
export declare class Webhook extends pulumi.CustomResource {
/**
* Get an existing Webhook 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?: WebhookState, opts?: pulumi.CustomResourceOptions): Webhook;
/**
* Returns true if the given object is an instance of Webhook. 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 Webhook;
/**
* Only if `type`==`asset-raw-rssi`. List of ids to associated asset filters. These filters will be applied to messages routed to a filtered-asset-rssi webhook
*/
readonly assetfilterIds: pulumi.Output<string[] | undefined>;
/**
* Whether webhook is enabled
*/
readonly enabled: pulumi.Output<boolean>;
/**
* If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
*/
readonly headers: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the webhook
*/
readonly name: pulumi.Output<string>;
/**
* Required when `oauth2GrantType`==`clientCredentials`
*/
readonly oauth2ClientId: pulumi.Output<string | undefined>;
/**
* Required when `oauth2GrantType`==`clientCredentials`
*/
readonly oauth2ClientSecret: pulumi.Output<string | undefined>;
/**
* required when `type`==`oauth2`. enum: `clientCredentials`, `password`
*/
readonly oauth2GrantType: pulumi.Output<string | undefined>;
/**
* Required when `oauth2GrantType`==`password`
*/
readonly oauth2Password: pulumi.Output<string | undefined>;
/**
* Required when `type`==`oauth2`, if provided, will be used in the token request
*/
readonly oauth2Scopes: pulumi.Output<string[] | undefined>;
/**
* Required when `type`==`oauth2`
*/
readonly oauth2TokenUrl: pulumi.Output<string | undefined>;
/**
* Required when `oauth2GrantType`==`password`
*/
readonly oauth2Username: pulumi.Output<string | undefined>;
readonly orgId: pulumi.Output<string>;
/**
* Only if `type`=`http-post`
*/
readonly secret: pulumi.Output<string | undefined>;
/**
* Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see List Webhook Topics)
*/
readonly singleEventPerMessage: pulumi.Output<boolean | undefined>;
readonly siteId: pulumi.Output<string>;
/**
* Required if `type`=`splunk`. If splunkToken is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
*/
readonly splunkToken: pulumi.Output<string | undefined>;
/**
* enum: `alarms`, `asset-raw`, `asset-raw-rssi`, `audits`, `client-info`, `client-join`, `client-latency`, `client-sessions`, `device-events`, `device-updowns`, `discovered-raw-rssi`, `guest-authorizations`, `location`, `location-asset`, `location-centrak`, `location-client`, `location-sdk`, `location-unclient`, `mxedge-events`, `nac-accounting`, `nac-events`, `occupancy-alerts`, `rssizone`, `sdkclient-scan-data`, `vbeacon`, `wifi-conn-raw`, `wifi-unconn-raw`, `zone`
*/
readonly topics: pulumi.Output<string[]>;
/**
* enum: `aws-sns`, `google-pubsub`, `http-post`, `oauth2`, `splunk`
*/
readonly type: pulumi.Output<string>;
readonly url: pulumi.Output<string>;
/**
* When url uses HTTPS, whether to verify the certificate
*/
readonly verifyCert: pulumi.Output<boolean>;
/**
* Create a Webhook 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: WebhookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Webhook resources.
*/
export interface WebhookState {
/**
* Only if `type`==`asset-raw-rssi`. List of ids to associated asset filters. These filters will be applied to messages routed to a filtered-asset-rssi webhook
*/
assetfilterIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Whether webhook is enabled
*/
enabled?: pulumi.Input<boolean>;
/**
* If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
*/
headers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the webhook
*/
name?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`clientCredentials`
*/
oauth2ClientId?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`clientCredentials`
*/
oauth2ClientSecret?: pulumi.Input<string>;
/**
* required when `type`==`oauth2`. enum: `clientCredentials`, `password`
*/
oauth2GrantType?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`password`
*/
oauth2Password?: pulumi.Input<string>;
/**
* Required when `type`==`oauth2`, if provided, will be used in the token request
*/
oauth2Scopes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Required when `type`==`oauth2`
*/
oauth2TokenUrl?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`password`
*/
oauth2Username?: pulumi.Input<string>;
orgId?: pulumi.Input<string>;
/**
* Only if `type`=`http-post`
*/
secret?: pulumi.Input<string>;
/**
* Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see List Webhook Topics)
*/
singleEventPerMessage?: pulumi.Input<boolean>;
siteId?: pulumi.Input<string>;
/**
* Required if `type`=`splunk`. If splunkToken is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
*/
splunkToken?: pulumi.Input<string>;
/**
* enum: `alarms`, `asset-raw`, `asset-raw-rssi`, `audits`, `client-info`, `client-join`, `client-latency`, `client-sessions`, `device-events`, `device-updowns`, `discovered-raw-rssi`, `guest-authorizations`, `location`, `location-asset`, `location-centrak`, `location-client`, `location-sdk`, `location-unclient`, `mxedge-events`, `nac-accounting`, `nac-events`, `occupancy-alerts`, `rssizone`, `sdkclient-scan-data`, `vbeacon`, `wifi-conn-raw`, `wifi-unconn-raw`, `zone`
*/
topics?: pulumi.Input<pulumi.Input<string>[]>;
/**
* enum: `aws-sns`, `google-pubsub`, `http-post`, `oauth2`, `splunk`
*/
type?: pulumi.Input<string>;
url?: pulumi.Input<string>;
/**
* When url uses HTTPS, whether to verify the certificate
*/
verifyCert?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a Webhook resource.
*/
export interface WebhookArgs {
/**
* Only if `type`==`asset-raw-rssi`. List of ids to associated asset filters. These filters will be applied to messages routed to a filtered-asset-rssi webhook
*/
assetfilterIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Whether webhook is enabled
*/
enabled?: pulumi.Input<boolean>;
/**
* If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
*/
headers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the webhook
*/
name?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`clientCredentials`
*/
oauth2ClientId?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`clientCredentials`
*/
oauth2ClientSecret?: pulumi.Input<string>;
/**
* required when `type`==`oauth2`. enum: `clientCredentials`, `password`
*/
oauth2GrantType?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`password`
*/
oauth2Password?: pulumi.Input<string>;
/**
* Required when `type`==`oauth2`, if provided, will be used in the token request
*/
oauth2Scopes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Required when `type`==`oauth2`
*/
oauth2TokenUrl?: pulumi.Input<string>;
/**
* Required when `oauth2GrantType`==`password`
*/
oauth2Username?: pulumi.Input<string>;
/**
* Only if `type`=`http-post`
*/
secret?: pulumi.Input<string>;
/**
* Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see List Webhook Topics)
*/
singleEventPerMessage?: pulumi.Input<boolean>;
siteId: pulumi.Input<string>;
/**
* Required if `type`=`splunk`. If splunkToken is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
*/
splunkToken?: pulumi.Input<string>;
/**
* enum: `alarms`, `asset-raw`, `asset-raw-rssi`, `audits`, `client-info`, `client-join`, `client-latency`, `client-sessions`, `device-events`, `device-updowns`, `discovered-raw-rssi`, `guest-authorizations`, `location`, `location-asset`, `location-centrak`, `location-client`, `location-sdk`, `location-unclient`, `mxedge-events`, `nac-accounting`, `nac-events`, `occupancy-alerts`, `rssizone`, `sdkclient-scan-data`, `vbeacon`, `wifi-conn-raw`, `wifi-unconn-raw`, `zone`
*/
topics: pulumi.Input<pulumi.Input<string>[]>;
/**
* enum: `aws-sns`, `google-pubsub`, `http-post`, `oauth2`, `splunk`
*/
type?: pulumi.Input<string>;
url: pulumi.Input<string>;
/**
* When url uses HTTPS, whether to verify the certificate
*/
verifyCert?: pulumi.Input<boolean>;
}