@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
156 lines • 7.76 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ServiceNow integrations. For help with this integration see [Integration with ServiceNow](https://docs.splunk.com/observability/en/admin/notif-services/servicenow.html).
*
* > **NOTE** When managing integrations, use a session token of an administrator to authenticate the 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 serviceNowMyteam = new signalfx.servicenow.Integration("service_now_myteam", {
* name: "ServiceNow - My Team",
* enabled: false,
* username: "thisis_me",
* password: "youd0ntsee1t",
* instanceName: "myinst.service-now.com",
* issueType: "Incident",
* alertTriggeredPayloadTemplate: "{\"short_description\": \"{{{messageTitle}}} (customized)\"}",
* alertResolvedPayloadTemplate: "{\"close_notes\": \"{{{messageTitle}}} (customized close msg)\"}",
* });
* ```
*/
export declare class Integration extends pulumi.CustomResource {
/**
* Get an existing Integration 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?: IntegrationState, opts?: pulumi.CustomResourceOptions): Integration;
/**
* Returns true if the given object is an instance of Integration. 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 Integration;
/**
* A template that Observability Cloud uses to create the ServiceNow PUT JSON payloads when an alert is cleared in ServiceNow. Use this optional field to send the values of Observability Cloud alert properties to specific fields in ServiceNow. See [API reference](https://dev.splunk.com/observability/reference/api/integrations/latest) for details.
*/
readonly alertResolvedPayloadTemplate: pulumi.Output<string | undefined>;
/**
* A template that Observability Cloud uses to create the ServiceNow POST JSON payloads when an alert sends a notification to ServiceNow. Use this optional field to send the values of Observability Cloud alert properties to specific fields in ServiceNow. See [API reference](https://dev.splunk.com/observability/reference/api/integrations/latest) for details.
*/
readonly alertTriggeredPayloadTemplate: pulumi.Output<string | undefined>;
/**
* Whether the integration is enabled.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Name of the ServiceNow instance, for example `myinst.service-now.com`.
*/
readonly instanceName: pulumi.Output<string>;
/**
* The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.
*/
readonly issueType: pulumi.Output<string>;
/**
* Name of the integration.
*/
readonly name: pulumi.Output<string>;
/**
* Password used to authenticate the ServiceNow integration.
*/
readonly password: pulumi.Output<string>;
/**
* User name used to authenticate the ServiceNow integration.
*/
readonly username: pulumi.Output<string>;
/**
* Create a Integration 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: IntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Integration resources.
*/
export interface IntegrationState {
/**
* A template that Observability Cloud uses to create the ServiceNow PUT JSON payloads when an alert is cleared in ServiceNow. Use this optional field to send the values of Observability Cloud alert properties to specific fields in ServiceNow. See [API reference](https://dev.splunk.com/observability/reference/api/integrations/latest) for details.
*/
alertResolvedPayloadTemplate?: pulumi.Input<string | undefined>;
/**
* A template that Observability Cloud uses to create the ServiceNow POST JSON payloads when an alert sends a notification to ServiceNow. Use this optional field to send the values of Observability Cloud alert properties to specific fields in ServiceNow. See [API reference](https://dev.splunk.com/observability/reference/api/integrations/latest) for details.
*/
alertTriggeredPayloadTemplate?: pulumi.Input<string | undefined>;
/**
* Whether the integration is enabled.
*/
enabled?: pulumi.Input<boolean | undefined>;
/**
* Name of the ServiceNow instance, for example `myinst.service-now.com`.
*/
instanceName?: pulumi.Input<string | undefined>;
/**
* The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.
*/
issueType?: pulumi.Input<string | undefined>;
/**
* Name of the integration.
*/
name?: pulumi.Input<string | undefined>;
/**
* Password used to authenticate the ServiceNow integration.
*/
password?: pulumi.Input<string | undefined>;
/**
* User name used to authenticate the ServiceNow integration.
*/
username?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Integration resource.
*/
export interface IntegrationArgs {
/**
* A template that Observability Cloud uses to create the ServiceNow PUT JSON payloads when an alert is cleared in ServiceNow. Use this optional field to send the values of Observability Cloud alert properties to specific fields in ServiceNow. See [API reference](https://dev.splunk.com/observability/reference/api/integrations/latest) for details.
*/
alertResolvedPayloadTemplate?: pulumi.Input<string | undefined>;
/**
* A template that Observability Cloud uses to create the ServiceNow POST JSON payloads when an alert sends a notification to ServiceNow. Use this optional field to send the values of Observability Cloud alert properties to specific fields in ServiceNow. See [API reference](https://dev.splunk.com/observability/reference/api/integrations/latest) for details.
*/
alertTriggeredPayloadTemplate?: pulumi.Input<string | undefined>;
/**
* Whether the integration is enabled.
*/
enabled: pulumi.Input<boolean>;
/**
* Name of the ServiceNow instance, for example `myinst.service-now.com`.
*/
instanceName: pulumi.Input<string>;
/**
* The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.
*/
issueType: pulumi.Input<string>;
/**
* Name of the integration.
*/
name?: pulumi.Input<string | undefined>;
/**
* Password used to authenticate the ServiceNow integration.
*/
password: pulumi.Input<string>;
/**
* User name used to authenticate the ServiceNow integration.
*/
username: pulumi.Input<string>;
}
//# sourceMappingURL=integration.d.ts.map