Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. servicenow
  5. Integration
SignalFx v7.1.2 published on Tuesday, Apr 23, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.servicenow.Integration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.2 published on Tuesday, Apr 23, 2024 by Pulumi
pulumi/pulumi-signalfx

    ServiceNow integrations. For help with this integration see Integration with ServiceNow.

    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. Otherwise you’ll receive a 4xx error.

    Example

    resource "signalfx_service_now_integration" "service_now_myteam" {
  name    = "ServiceNow - My Team"
  enabled = false

  username = "thisis_me"
  password = "youd0ntsee1t"
  
  instance_name = "myinst.service-now.com"
  issue_type    = "Incident"

  alert_triggered_payload_template = "{\"short_description\": \"{{{messageTitle}}} (customized)\"}"
  alert_resolved_payload_template  = "{\"close_notes\": \"{{{messageTitle}}} (customized close msg)\"}"
}

    Arguments

    • name - (Required) Name of the integration.
    • enabled - (Required) Whether the integration is enabled.
    • username - (Required) User name used to authenticate the ServiceNow integration.
    • password - (Required) Password used to authenticate the ServiceNow integration.
    • instance_name - (Required) Name of the ServiceNow instance, for example myinst.service-now.com.
    • issue_type - (Required) The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    • alert_triggered_payload_template - (Optional) 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 for details.
    • alert_resolved_payload_template - (Optional) 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 for details.

    Attributes

    In a addition to all arguments above, the following attributes are exported:

    • id - The ID of the integration.

    Create Integration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
    @overload
def Integration(resource_name: str,
                args: IntegrationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                enabled: Optional[bool] = None,
                instance_name: Optional[str] = None,
                issue_type: Optional[str] = None,
                password: Optional[str] = None,
                username: Optional[str] = None,
                alert_resolved_payload_template: Optional[str] = None,
                alert_triggered_payload_template: Optional[str] = None,
                name: Optional[str] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: signalfx:servicenow:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleintegrationResourceResourceFromServicenowintegration = new SignalFx.ServiceNow.Integration("exampleintegrationResourceResourceFromServicenowintegration", new()
{
    Enabled = false,
    InstanceName = "string",
    IssueType = "string",
    Password = "string",
    Username = "string",
    AlertResolvedPayloadTemplate = "string",
    AlertTriggeredPayloadTemplate = "string",
    Name = "string",
});

    example, err := servicenow.NewIntegration(ctx, "exampleintegrationResourceResourceFromServicenowintegration", &servicenow.IntegrationArgs{
	Enabled:                       pulumi.Bool(false),
	InstanceName:                  pulumi.String("string"),
	IssueType:                     pulumi.String("string"),
	Password:                      pulumi.String("string"),
	Username:                      pulumi.String("string"),
	AlertResolvedPayloadTemplate:  pulumi.String("string"),
	AlertTriggeredPayloadTemplate: pulumi.String("string"),
	Name:                          pulumi.String("string"),
})

    var exampleintegrationResourceResourceFromServicenowintegration = new Integration("exampleintegrationResourceResourceFromServicenowintegration", IntegrationArgs.builder()        
    .enabled(false)
    .instanceName("string")
    .issueType("string")
    .password("string")
    .username("string")
    .alertResolvedPayloadTemplate("string")
    .alertTriggeredPayloadTemplate("string")
    .name("string")
    .build());

    exampleintegration_resource_resource_from_servicenowintegration = signalfx.servicenow.Integration("exampleintegrationResourceResourceFromServicenowintegration",
    enabled=False,
    instance_name="string",
    issue_type="string",
    password="string",
    username="string",
    alert_resolved_payload_template="string",
    alert_triggered_payload_template="string",
    name="string")

    const exampleintegrationResourceResourceFromServicenowintegration = new signalfx.servicenow.Integration("exampleintegrationResourceResourceFromServicenowintegration", {
    enabled: false,
    instanceName: "string",
    issueType: "string",
    password: "string",
    username: "string",
    alertResolvedPayloadTemplate: "string",
    alertTriggeredPayloadTemplate: "string",
    name: "string",
});

    type: signalfx:servicenow:Integration
properties:
    alertResolvedPayloadTemplate: string
    alertTriggeredPayloadTemplate: string
    enabled: false
    instanceName: string
    issueType: string
    name: string
    password: string
    username: string

    Integration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Integration resource accepts the following input properties:

    Enabled bool
    Whether the integration is enabled
    InstanceName string
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    IssueType string
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    Password string
    Password used to authenticate the ServiceNow integration.
    Username string
    User name used to authenticate the ServiceNow integration.
    AlertResolvedPayloadTemplate string
    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 for details.
    AlertTriggeredPayloadTemplate string
    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 for details.
    Name string
    Name of the integration
    Enabled bool
    Whether the integration is enabled
    InstanceName string
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    IssueType string
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    Password string
    Password used to authenticate the ServiceNow integration.
    Username string
    User name used to authenticate the ServiceNow integration.
    AlertResolvedPayloadTemplate string
    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 for details.
    AlertTriggeredPayloadTemplate string
    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 for details.
    Name string
    Name of the integration
    enabled Boolean
    Whether the integration is enabled
    instanceName String
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issueType String
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    password String
    Password used to authenticate the ServiceNow integration.
    username String
    User name used to authenticate the ServiceNow integration.
    alertResolvedPayloadTemplate String
    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 for details.
    alertTriggeredPayloadTemplate String
    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 for details.
    name String
    Name of the integration
    enabled boolean
    Whether the integration is enabled
    instanceName string
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issueType string
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    password string
    Password used to authenticate the ServiceNow integration.
    username string
    User name used to authenticate the ServiceNow integration.
    alertResolvedPayloadTemplate string
    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 for details.
    alertTriggeredPayloadTemplate string
    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 for details.
    name string
    Name of the integration
    enabled bool
    Whether the integration is enabled
    instance_name str
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issue_type str
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    password str
    Password used to authenticate the ServiceNow integration.
    username str
    User name used to authenticate the ServiceNow integration.
    alert_resolved_payload_template str
    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 for details.
    alert_triggered_payload_template str
    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 for details.
    name str
    Name of the integration
    enabled Boolean
    Whether the integration is enabled
    instanceName String
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issueType String
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    password String
    Password used to authenticate the ServiceNow integration.
    username String
    User name used to authenticate the ServiceNow integration.
    alertResolvedPayloadTemplate String
    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 for details.
    alertTriggeredPayloadTemplate String
    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 for details.
    name String
    Name of the integration

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Integration Resource

    Get an existing Integration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IntegrationState, opts?: CustomResourceOptions): Integration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alert_resolved_payload_template: Optional[str] = None,
        alert_triggered_payload_template: Optional[str] = None,
        enabled: Optional[bool] = None,
        instance_name: Optional[str] = None,
        issue_type: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        username: Optional[str] = None) -> Integration
    func GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)
    public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)
    public static Integration get(String name, Output<String> id, IntegrationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlertResolvedPayloadTemplate string
    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 for details.
    AlertTriggeredPayloadTemplate string
    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 for details.
    Enabled bool
    Whether the integration is enabled
    InstanceName string
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    IssueType string
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    Name string
    Name of the integration
    Password string
    Password used to authenticate the ServiceNow integration.
    Username string
    User name used to authenticate the ServiceNow integration.
    AlertResolvedPayloadTemplate string
    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 for details.
    AlertTriggeredPayloadTemplate string
    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 for details.
    Enabled bool
    Whether the integration is enabled
    InstanceName string
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    IssueType string
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    Name string
    Name of the integration
    Password string
    Password used to authenticate the ServiceNow integration.
    Username string
    User name used to authenticate the ServiceNow integration.
    alertResolvedPayloadTemplate String
    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 for details.
    alertTriggeredPayloadTemplate String
    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 for details.
    enabled Boolean
    Whether the integration is enabled
    instanceName String
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issueType String
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    name String
    Name of the integration
    password String
    Password used to authenticate the ServiceNow integration.
    username String
    User name used to authenticate the ServiceNow integration.
    alertResolvedPayloadTemplate string
    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 for details.
    alertTriggeredPayloadTemplate string
    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 for details.
    enabled boolean
    Whether the integration is enabled
    instanceName string
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issueType string
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    name string
    Name of the integration
    password string
    Password used to authenticate the ServiceNow integration.
    username string
    User name used to authenticate the ServiceNow integration.
    alert_resolved_payload_template str
    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 for details.
    alert_triggered_payload_template str
    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 for details.
    enabled bool
    Whether the integration is enabled
    instance_name str
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issue_type str
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    name str
    Name of the integration
    password str
    Password used to authenticate the ServiceNow integration.
    username str
    User name used to authenticate the ServiceNow integration.
    alertResolvedPayloadTemplate String
    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 for details.
    alertTriggeredPayloadTemplate String
    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 for details.
    enabled Boolean
    Whether the integration is enabled
    instanceName String
    Name of the ServiceNow instance, for example myInstances.service-now.com.
    issueType String
    The type of issue in standard ITIL terminology. The allowed values are Incident and Problem.
    name String
    Name of the integration
    password String
    Password used to authenticate the ServiceNow integration.
    username String
    User name used to authenticate the ServiceNow integration.

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.2 published on Tuesday, Apr 23, 2024 by Pulumi
    pulumi/pulumi-signalfx