jira

package
v7.1.3 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 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

	// 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` or `UsernameAndPassword`
	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 or not
	Enabled pulumi.BoolOutput `pulumi:"enabled"`
	// Issue type (for example, Story) for tickets that Jira creates for detector notifications. Splunk Observability Cloud
	// 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"`
}

Splunk Observability Cloud Jira integrations. For help with this integration see [Integration with Jira](https://docs.splunk.com/observability/en/admin/notif-services/jira.html).

> **NOTE** When managing integrations, use a session token of an administrator to authenticate the Splunk 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

## Arguments

* `name` - (Required) Name of the integration. * `enabled` - (Required) Whether the integration is enabled. * `authMethod` - (Required) Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`). * `apiToken` - (Required if `authMethod` is `EmailAndToken`) The API token for the user email * `userEmail` - (Required if `authMethod` is `EmailAndToken`) Email address used to authenticate the Jira integration. * `username` - (Required if `authMethod` is `UsernameAndPassword`) User name used to authenticate the Jira integration. * `password` - (Required if `authMethod` is `UsernameAndPassword`) Password used to authenticate the Jira integration. * `baseUrl` - (Required) Base URL of the Jira instance that's integrated with SignalFx. * `issueType` - (Required) Issue type (for example, Story) for tickets that Jira creates for detector notifications. Splunk Observability Cloud validates issue types, so you must specify a type that's valid for the Jira project specified in `projectKey`. * `projectKey` - (Required) Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project. * `assigneeName` - (Required) Jira user name for the assignee. * `assigneeDisplayName` - (Optional) Jira display name for the assignee.

## Attributes

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

* `id` - The ID of the integration.

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 {
	// 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` or `UsernameAndPassword`
	AuthMethod pulumi.StringInput
	// Base URL of the Jira instance that's integrated with SignalFx.
	BaseUrl pulumi.StringInput
	// Whether the integration is enabled or not
	Enabled pulumi.BoolInput
	// Issue type (for example, Story) for tickets that Jira creates for detector notifications. Splunk Observability Cloud
	// 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 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) ApiToken 

func (o IntegrationOutput) ApiToken() pulumi.StringPtrOutput

The API token for the user email

func (IntegrationOutput) AssigneeDisplayName 

func (o IntegrationOutput) AssigneeDisplayName() pulumi.StringPtrOutput

Jira display name for the assignee

func (IntegrationOutput) AssigneeName 

func (o IntegrationOutput) AssigneeName() pulumi.StringOutput

Jira user name for the assignee

func (IntegrationOutput) AuthMethod 

func (o IntegrationOutput) AuthMethod() pulumi.StringOutput

Authentication method used when creating the Jira integration. One of `EmailAndToken` or `UsernameAndPassword`

func (IntegrationOutput) BaseUrl 

func (o IntegrationOutput) BaseUrl() pulumi.StringOutput

Base URL of the Jira instance that's integrated with SignalFx.

func (IntegrationOutput) ElementType 

func (IntegrationOutput) ElementType() reflect.Type

func (IntegrationOutput) Enabled 

func (o IntegrationOutput) Enabled() pulumi.BoolOutput

Whether the integration is enabled or not

func (IntegrationOutput) IssueType 

func (o IntegrationOutput) IssueType() pulumi.StringOutput

Issue type (for example, Story) for tickets that Jira creates for detector notifications. Splunk Observability Cloud validates issue types, so you must specify a type that's valid for the Jira project specified in `projectKey`.

func (IntegrationOutput) Name 

func (o IntegrationOutput) Name() pulumi.StringOutput

Name of the integration

func (IntegrationOutput) Password 

func (o IntegrationOutput) Password() pulumi.StringPtrOutput

Password used to authenticate the Jira integration.

func (IntegrationOutput) ProjectKey 

func (o IntegrationOutput) ProjectKey() pulumi.StringOutput

Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.

func (IntegrationOutput) ToIntegrationOutput 

func (o IntegrationOutput) ToIntegrationOutput() IntegrationOutput

func (IntegrationOutput) ToIntegrationOutputWithContext 

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

func (IntegrationOutput) UserEmail 

func (o IntegrationOutput) UserEmail() pulumi.StringPtrOutput

Email address used to authenticate the Jira integration.

func (IntegrationOutput) Username 

func (o IntegrationOutput) Username() pulumi.StringPtrOutput

User name used to authenticate the Jira integration.

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` or `UsernameAndPassword`
	AuthMethod pulumi.StringPtrInput
	// Base URL of the Jira instance that's integrated with SignalFx.
	BaseUrl pulumi.StringPtrInput
	// Whether the integration is enabled or not
	Enabled pulumi.BoolPtrInput
	// Issue type (for example, Story) for tickets that Jira creates for detector notifications. Splunk Observability Cloud
	// 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

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.