servicenow

package
v7.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Integration 

type Integration struct {
	pulumi.CustomResourceState

	// 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.StringPtrOutput `pulumi:"alertResolvedPayloadTemplate"`
	// 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.StringPtrOutput `pulumi:"alertTriggeredPayloadTemplate"`
	// Whether the integration is enabled.
	Enabled pulumi.BoolOutput `pulumi:"enabled"`
	// Name of the ServiceNow instance, for example `myinst.service-now.com`.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.
	IssueType pulumi.StringOutput `pulumi:"issueType"`
	// Name of the integration.
	Name pulumi.StringOutput `pulumi:"name"`
	// Password used to authenticate the ServiceNow integration.
	Password pulumi.StringOutput `pulumi:"password"`
	// User name used to authenticate the ServiceNow integration.
	Username pulumi.StringOutput `pulumi:"username"`
}

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

```go package main

import ( 

"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx/servicenow"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicenow.NewIntegration(ctx, "service_now_myteam", &servicenow.IntegrationArgs{
			Name:                          pulumi.String("ServiceNow - My Team"),
			Enabled:                       pulumi.Bool(false),
			Username:                      pulumi.String("thisis_me"),
			Password:                      pulumi.String("youd0ntsee1t"),
			InstanceName:                  pulumi.String("myinst.service-now.com"),
			IssueType:                     pulumi.String("Incident"),
			AlertTriggeredPayloadTemplate: pulumi.String("{\"short_description\": \"{{{messageTitle}}} (customized)\"}"),
			AlertResolvedPayloadTemplate:  pulumi.String("{\"close_notes\": \"{{{messageTitle}}} (customized close msg)\"}"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetIntegration 

func GetIntegration(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IntegrationState, opts ...pulumi.ResourceOption) (*Integration, error)

GetIntegration gets an existing Integration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIntegration 

func NewIntegration(ctx *pulumi.Context,
	name string, args *IntegrationArgs, opts ...pulumi.ResourceOption) (*Integration, error)

NewIntegration registers a new resource with the given unique name, arguments, and options.

func (*Integration) ElementType 

func (*Integration) ElementType() reflect.Type

func (*Integration) ToIntegrationOutput 

func (i *Integration) ToIntegrationOutput() IntegrationOutput

func (*Integration) ToIntegrationOutputWithContext 

func (i *Integration) ToIntegrationOutputWithContext(ctx context.Context) IntegrationOutput

type IntegrationArgs 

type IntegrationArgs struct {
	// 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.StringPtrInput
	// 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.StringPtrInput
	// Whether the integration is enabled.
	Enabled pulumi.BoolInput
	// Name of the ServiceNow instance, for example `myinst.service-now.com`.
	InstanceName pulumi.StringInput
	// The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.
	IssueType pulumi.StringInput
	// Name of the integration.
	Name pulumi.StringPtrInput
	// Password used to authenticate the ServiceNow integration.
	Password pulumi.StringInput
	// User name used to authenticate the ServiceNow integration.
	Username pulumi.StringInput
}

The set of arguments for constructing a Integration resource.

func (IntegrationArgs) ElementType 

func (IntegrationArgs) ElementType() reflect.Type

type IntegrationArray 

type IntegrationArray []IntegrationInput

func (IntegrationArray) ElementType 

func (IntegrationArray) ElementType() reflect.Type

func (IntegrationArray) ToIntegrationArrayOutput 

func (i IntegrationArray) ToIntegrationArrayOutput() IntegrationArrayOutput

func (IntegrationArray) ToIntegrationArrayOutputWithContext 

func (i IntegrationArray) ToIntegrationArrayOutputWithContext(ctx context.Context) IntegrationArrayOutput

type IntegrationArrayInput 

type IntegrationArrayInput interface {
	pulumi.Input

	ToIntegrationArrayOutput() IntegrationArrayOutput
	ToIntegrationArrayOutputWithContext(context.Context) IntegrationArrayOutput
}

IntegrationArrayInput is an input type that accepts IntegrationArray and IntegrationArrayOutput values. You can construct a concrete instance of `IntegrationArrayInput` via: 

IntegrationArray{ IntegrationArgs{...} }

type IntegrationArrayOutput 

type IntegrationArrayOutput struct{ *pulumi.OutputState }

func (IntegrationArrayOutput) ElementType 

func (IntegrationArrayOutput) ElementType() reflect.Type

func (IntegrationArrayOutput) Index 

func (o IntegrationArrayOutput) Index(i pulumi.IntInput) IntegrationOutput

func (IntegrationArrayOutput) ToIntegrationArrayOutput 

func (o IntegrationArrayOutput) ToIntegrationArrayOutput() IntegrationArrayOutput

func (IntegrationArrayOutput) ToIntegrationArrayOutputWithContext 

func (o IntegrationArrayOutput) ToIntegrationArrayOutputWithContext(ctx context.Context) IntegrationArrayOutput

type IntegrationInput 

type IntegrationInput interface {
	pulumi.Input

	ToIntegrationOutput() IntegrationOutput
	ToIntegrationOutputWithContext(ctx context.Context) IntegrationOutput
}

type IntegrationMap 

type IntegrationMap map[string]IntegrationInput

func (IntegrationMap) ElementType 

func (IntegrationMap) ElementType() reflect.Type

func (IntegrationMap) ToIntegrationMapOutput 

func (i IntegrationMap) ToIntegrationMapOutput() IntegrationMapOutput

func (IntegrationMap) ToIntegrationMapOutputWithContext 

func (i IntegrationMap) ToIntegrationMapOutputWithContext(ctx context.Context) IntegrationMapOutput

type IntegrationMapInput 

type IntegrationMapInput interface {
	pulumi.Input

	ToIntegrationMapOutput() IntegrationMapOutput
	ToIntegrationMapOutputWithContext(context.Context) IntegrationMapOutput
}

IntegrationMapInput is an input type that accepts IntegrationMap and IntegrationMapOutput values. You can construct a concrete instance of `IntegrationMapInput` via: 

IntegrationMap{ "key": IntegrationArgs{...} }

type IntegrationMapOutput 

type IntegrationMapOutput struct{ *pulumi.OutputState }

func (IntegrationMapOutput) ElementType 

func (IntegrationMapOutput) ElementType() reflect.Type

func (IntegrationMapOutput) MapIndex 

func (o IntegrationMapOutput) MapIndex(k pulumi.StringInput) IntegrationOutput

func (IntegrationMapOutput) ToIntegrationMapOutput 

func (o IntegrationMapOutput) ToIntegrationMapOutput() IntegrationMapOutput

func (IntegrationMapOutput) ToIntegrationMapOutputWithContext 

func (o IntegrationMapOutput) ToIntegrationMapOutputWithContext(ctx context.Context) IntegrationMapOutput

type IntegrationOutput 

type IntegrationOutput struct{ *pulumi.OutputState }

func (IntegrationOutput) AlertResolvedPayloadTemplate 

func (o IntegrationOutput) AlertResolvedPayloadTemplate() pulumi.StringPtrOutput

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.

func (IntegrationOutput) AlertTriggeredPayloadTemplate 

func (o IntegrationOutput) AlertTriggeredPayloadTemplate() pulumi.StringPtrOutput

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.

func (IntegrationOutput) ElementType 

func (IntegrationOutput) ElementType() reflect.Type

func (IntegrationOutput) Enabled 

func (o IntegrationOutput) Enabled() pulumi.BoolOutput

Whether the integration is enabled.

func (IntegrationOutput) InstanceName 

func (o IntegrationOutput) InstanceName() pulumi.StringOutput

Name of the ServiceNow instance, for example `myinst.service-now.com`.

func (IntegrationOutput) IssueType 

func (o IntegrationOutput) IssueType() pulumi.StringOutput

The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.

func (IntegrationOutput) Name 

func (o IntegrationOutput) Name() pulumi.StringOutput

Name of the integration.

func (IntegrationOutput) Password 

func (o IntegrationOutput) Password() pulumi.StringOutput

Password used to authenticate the ServiceNow integration.

func (IntegrationOutput) ToIntegrationOutput 

func (o IntegrationOutput) ToIntegrationOutput() IntegrationOutput

func (IntegrationOutput) ToIntegrationOutputWithContext 

func (o IntegrationOutput) ToIntegrationOutputWithContext(ctx context.Context) IntegrationOutput

func (IntegrationOutput) Username 

func (o IntegrationOutput) Username() pulumi.StringOutput

User name used to authenticate the ServiceNow integration.

type IntegrationState 

type IntegrationState struct {
	// 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.StringPtrInput
	// 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.StringPtrInput
	// Whether the integration is enabled.
	Enabled pulumi.BoolPtrInput
	// Name of the ServiceNow instance, for example `myinst.service-now.com`.
	InstanceName pulumi.StringPtrInput
	// The type of issue in standard ITIL terminology. The allowed values are `Incident` and `Problem`.
	IssueType pulumi.StringPtrInput
	// Name of the integration.
	Name pulumi.StringPtrInput
	// Password used to authenticate the ServiceNow integration.
	Password pulumi.StringPtrInput
	// User name used to authenticate the ServiceNow integration.
	Username pulumi.StringPtrInput
}

func (IntegrationState) ElementType 

func (IntegrationState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.