jira

Documentation

Index

• type Integration
  • func GetIntegration(ctx *pulumi.Context, name string, id pulumi.IDInput, state *IntegrationState, ...) (*Integration, error)
  • func NewIntegration(ctx *pulumi.Context, name string, args *IntegrationArgs, ...) (*Integration, error)
• type IntegrationArgs
  • func (IntegrationArgs) ElementType() reflect.Type
• type IntegrationState
  • func (IntegrationState) ElementType() reflect.Type

Types

type Integration

type Integration struct {
	pulumi.CustomResourceState

	// The API token for the user email
	ApiToken pulumi.StringPtrOutput `pulumi:"apiToken"`
	// Jira display name for the assignee.
	AssigneeDisplayName pulumi.StringPtrOutput `pulumi:"assigneeDisplayName"`
	// Jira user name for the assignee.
	AssigneeName pulumi.StringOutput `pulumi:"assigneeName"`
	// Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`).
	AuthMethod pulumi.StringOutput `pulumi:"authMethod"`
	// Base URL of the Jira instance that's integrated with SignalFx.
	BaseUrl pulumi.StringOutput `pulumi:"baseUrl"`
	// Whether the integration is enabled.
	Enabled pulumi.BoolOutput `pulumi:"enabled"`
	// Issue type (for example, Story) for tickets that Jira creates for detector notifications. SignalFx validates issue types, so you must specify a type that's valid for the Jira project specified in `projectKey`.
	IssueType pulumi.StringOutput `pulumi:"issueType"`
	// Name of the integration.
	Name pulumi.StringOutput `pulumi:"name"`
	// Password used to authenticate the Jira integration.
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
	ProjectKey pulumi.StringOutput `pulumi:"projectKey"`
	// Email address used to authenticate the Jira integration.
	UserEmail pulumi.StringPtrOutput `pulumi:"userEmail"`
	// User name used to authenticate the Jira integration.
	Username pulumi.StringPtrOutput `pulumi:"username"`
}

SignalFx Jira integrations. For help with this integration see [Integration with Jira](https://docs.signalfx.com/en/latest/admin-guide/integrate-notifications.html#integrate-with-jira).

> **NOTE** When managing integrations you'll need to use an admin token to authenticate the SignalFx provider. Otherwise you'll receive a 4xx error.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-signalfx/sdk/v2/go/signalfx/jira"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := jira.NewIntegration(ctx, "jiraMyteamXX", &jira.IntegrationArgs{
			AssigneeDisplayName: pulumi.String("Testy Testerson"),
			AssigneeName:        pulumi.String("testytesterson"),
			AuthMethod:          pulumi.String("UsernameAndPassword"),
			BaseUrl:             pulumi.String("https://www.example.com"),
			Enabled:             pulumi.Bool(false),
			IssueType:           pulumi.String("Story"),
			Password:            pulumi.String("paasword"),
			ProjectKey:          pulumi.String("TEST"),
			Username:            pulumi.String("yoosername"),
		})
		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.

type IntegrationArgs

type IntegrationArgs struct {
	// The API token for the user email
	ApiToken pulumi.StringPtrInput
	// Jira display name for the assignee.
	AssigneeDisplayName pulumi.StringPtrInput
	// Jira user name for the assignee.
	AssigneeName pulumi.StringInput
	// Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`).
	AuthMethod pulumi.StringInput
	// Base URL of the Jira instance that's integrated with SignalFx.
	BaseUrl pulumi.StringInput
	// Whether the integration is enabled.
	Enabled pulumi.BoolInput
	// Issue type (for example, Story) for tickets that Jira creates for detector notifications. SignalFx validates issue types, so you must specify a type that's valid for the Jira project specified in `projectKey`.
	IssueType pulumi.StringInput
	// Name of the integration.
	Name pulumi.StringPtrInput
	// Password used to authenticate the Jira integration.
	Password pulumi.StringPtrInput
	// Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
	ProjectKey pulumi.StringInput
	// Email address used to authenticate the Jira integration.
	UserEmail pulumi.StringPtrInput
	// User name used to authenticate the Jira integration.
	Username pulumi.StringPtrInput
}

The set of arguments for constructing a Integration resource.

func (IntegrationArgs) ElementType

func (IntegrationArgs) ElementType() reflect.Type

type IntegrationState

type IntegrationState struct {
	// The API token for the user email
	ApiToken pulumi.StringPtrInput
	// Jira display name for the assignee.
	AssigneeDisplayName pulumi.StringPtrInput
	// Jira user name for the assignee.
	AssigneeName pulumi.StringPtrInput
	// Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`).
	AuthMethod pulumi.StringPtrInput
	// Base URL of the Jira instance that's integrated with SignalFx.
	BaseUrl pulumi.StringPtrInput
	// Whether the integration is enabled.
	Enabled pulumi.BoolPtrInput
	// Issue type (for example, Story) for tickets that Jira creates for detector notifications. SignalFx validates issue types, so you must specify a type that's valid for the Jira project specified in `projectKey`.
	IssueType pulumi.StringPtrInput
	// Name of the integration.
	Name pulumi.StringPtrInput
	// Password used to authenticate the Jira integration.
	Password pulumi.StringPtrInput
	// Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
	ProjectKey pulumi.StringPtrInput
	// Email address used to authenticate the Jira integration.
	UserEmail pulumi.StringPtrInput
	// User name used to authenticate the Jira integration.
	Username pulumi.StringPtrInput
}

func (IntegrationState) ElementType

func (IntegrationState) ElementType() reflect.Type