Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. jira
  5. Integration
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.jira.Integration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi
pulumi/pulumi-signalfx

    Splunk Observability Cloud Jira integrations. For help with this integration see Integration with Jira.

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

    Example

    import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";

const jiraMyteamXX = new signalfx.jira.Integration("jiraMyteamXX", {
    assigneeDisplayName: "Testy Testerson",
    assigneeName: "testytesterson",
    authMethod: "UsernameAndPassword",
    baseUrl: "https://www.example.com",
    enabled: false,
    issueType: "Story",
    password: "paasword",
    projectKey: "TEST",
    username: "yoosername",
});

    import pulumi
import pulumi_signalfx as signalfx

jira_myteam_xx = signalfx.jira.Integration("jiraMyteamXX",
    assignee_display_name="Testy Testerson",
    assignee_name="testytesterson",
    auth_method="UsernameAndPassword",
    base_url="https://www.example.com",
    enabled=False,
    issue_type="Story",
    password="paasword",
    project_key="TEST",
    username="yoosername")

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

return await Deployment.RunAsync(() => 
{
    var jiraMyteamXX = new SignalFx.Jira.Integration("jiraMyteamXX", new()
    {
        AssigneeDisplayName = "Testy Testerson",
        AssigneeName = "testytesterson",
        AuthMethod = "UsernameAndPassword",
        BaseUrl = "https://www.example.com",
        Enabled = false,
        IssueType = "Story",
        Password = "paasword",
        ProjectKey = "TEST",
        Username = "yoosername",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx/jira"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.jira.Integration;
import com.pulumi.signalfx.jira.IntegrationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var jiraMyteamXX = new Integration("jiraMyteamXX", IntegrationArgs.builder()        
            .assigneeDisplayName("Testy Testerson")
            .assigneeName("testytesterson")
            .authMethod("UsernameAndPassword")
            .baseUrl("https://www.example.com")
            .enabled(false)
            .issueType("Story")
            .password("paasword")
            .projectKey("TEST")
            .username("yoosername")
            .build());

    }
}

    resources:
  jiraMyteamXX:
    type: signalfx:jira:Integration
    properties:
      assigneeDisplayName: Testy Testerson
      assigneeName: testytesterson
      authMethod: UsernameAndPassword
      baseUrl: https://www.example.com
      enabled: false
      issueType: Story
      password: paasword
      projectKey: TEST
      username: yoosername

    Arguments

    • name - (Required) Name of the integration.
    • enabled - (Required) Whether the integration is enabled.
    • auth_method - (Required) Authentication method used when creating the Jira integration. One of EmailAndToken (using user_email and api_token) or UsernameAndPassword (using username and password).
    • api_token - (Required if auth_method is EmailAndToken) The API token for the user email
    • user_email - (Required if auth_method is EmailAndToken) Email address used to authenticate the Jira integration.
    • username - (Required if auth_method is UsernameAndPassword) User name used to authenticate the Jira integration.
    • password - (Required if auth_method is UsernameAndPassword) Password used to authenticate the Jira integration.
    • base_url - (Required) Base URL of the Jira instance that’s integrated with SignalFx.
    • issue_type - (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.
    • project_key - (Required) Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    • assignee_name - (Required) Jira user name for the assignee.
    • assignee_display_name - (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.

    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,
                assignee_name: Optional[str] = None,
                auth_method: Optional[str] = None,
                base_url: Optional[str] = None,
                enabled: Optional[bool] = None,
                issue_type: Optional[str] = None,
                project_key: Optional[str] = None,
                api_token: Optional[str] = None,
                assignee_display_name: Optional[str] = None,
                name: Optional[str] = None,
                password: Optional[str] = None,
                user_email: Optional[str] = None,
                username: 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:jira: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 exampleintegrationResourceResourceFromJiraintegration = new SignalFx.Jira.Integration("exampleintegrationResourceResourceFromJiraintegration", new()
{
    AssigneeName = "string",
    AuthMethod = "string",
    BaseUrl = "string",
    Enabled = false,
    IssueType = "string",
    ProjectKey = "string",
    ApiToken = "string",
    AssigneeDisplayName = "string",
    Name = "string",
    Password = "string",
    UserEmail = "string",
    Username = "string",
});

    example, err := jira.NewIntegration(ctx, "exampleintegrationResourceResourceFromJiraintegration", &jira.IntegrationArgs{
	AssigneeName:        pulumi.String("string"),
	AuthMethod:          pulumi.String("string"),
	BaseUrl:             pulumi.String("string"),
	Enabled:             pulumi.Bool(false),
	IssueType:           pulumi.String("string"),
	ProjectKey:          pulumi.String("string"),
	ApiToken:            pulumi.String("string"),
	AssigneeDisplayName: pulumi.String("string"),
	Name:                pulumi.String("string"),
	Password:            pulumi.String("string"),
	UserEmail:           pulumi.String("string"),
	Username:            pulumi.String("string"),
})

    var exampleintegrationResourceResourceFromJiraintegration = new Integration("exampleintegrationResourceResourceFromJiraintegration", IntegrationArgs.builder()        
    .assigneeName("string")
    .authMethod("string")
    .baseUrl("string")
    .enabled(false)
    .issueType("string")
    .projectKey("string")
    .apiToken("string")
    .assigneeDisplayName("string")
    .name("string")
    .password("string")
    .userEmail("string")
    .username("string")
    .build());

    exampleintegration_resource_resource_from_jiraintegration = signalfx.jira.Integration("exampleintegrationResourceResourceFromJiraintegration",
    assignee_name="string",
    auth_method="string",
    base_url="string",
    enabled=False,
    issue_type="string",
    project_key="string",
    api_token="string",
    assignee_display_name="string",
    name="string",
    password="string",
    user_email="string",
    username="string")

    const exampleintegrationResourceResourceFromJiraintegration = new signalfx.jira.Integration("exampleintegrationResourceResourceFromJiraintegration", {
    assigneeName: "string",
    authMethod: "string",
    baseUrl: "string",
    enabled: false,
    issueType: "string",
    projectKey: "string",
    apiToken: "string",
    assigneeDisplayName: "string",
    name: "string",
    password: "string",
    userEmail: "string",
    username: "string",
});

    type: signalfx:jira:Integration
properties:
    apiToken: string
    assigneeDisplayName: string
    assigneeName: string
    authMethod: string
    baseUrl: string
    enabled: false
    issueType: string
    name: string
    password: string
    projectKey: string
    userEmail: 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:

    AssigneeName string
    Jira user name for the assignee
    AuthMethod string
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    BaseUrl string
    Base URL of the Jira instance that's integrated with SignalFx.
    Enabled bool
    Whether the integration is enabled or not
    IssueType string
    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 string
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    ApiToken string
    The API token for the user email
    AssigneeDisplayName string
    Jira display name for the assignee
    Name string
    Name of the integration
    Password string
    Password used to authenticate the Jira integration.
    UserEmail string
    Email address used to authenticate the Jira integration.
    Username string
    User name used to authenticate the Jira integration.
    AssigneeName string
    Jira user name for the assignee
    AuthMethod string
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    BaseUrl string
    Base URL of the Jira instance that's integrated with SignalFx.
    Enabled bool
    Whether the integration is enabled or not
    IssueType string
    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 string
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    ApiToken string
    The API token for the user email
    AssigneeDisplayName string
    Jira display name for the assignee
    Name string
    Name of the integration
    Password string
    Password used to authenticate the Jira integration.
    UserEmail string
    Email address used to authenticate the Jira integration.
    Username string
    User name used to authenticate the Jira integration.
    assigneeName String
    Jira user name for the assignee
    authMethod String
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    baseUrl String
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled Boolean
    Whether the integration is enabled or not
    issueType String
    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 String
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    apiToken String
    The API token for the user email
    assigneeDisplayName String
    Jira display name for the assignee
    name String
    Name of the integration
    password String
    Password used to authenticate the Jira integration.
    userEmail String
    Email address used to authenticate the Jira integration.
    username String
    User name used to authenticate the Jira integration.
    assigneeName string
    Jira user name for the assignee
    authMethod string
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    baseUrl string
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled boolean
    Whether the integration is enabled or not
    issueType string
    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 string
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    apiToken string
    The API token for the user email
    assigneeDisplayName string
    Jira display name for the assignee
    name string
    Name of the integration
    password string
    Password used to authenticate the Jira integration.
    userEmail string
    Email address used to authenticate the Jira integration.
    username string
    User name used to authenticate the Jira integration.
    assignee_name str
    Jira user name for the assignee
    auth_method str
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    base_url str
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled bool
    Whether the integration is enabled or not
    issue_type str
    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.
    project_key str
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    api_token str
    The API token for the user email
    assignee_display_name str
    Jira display name for the assignee
    name str
    Name of the integration
    password str
    Password used to authenticate the Jira integration.
    user_email str
    Email address used to authenticate the Jira integration.
    username str
    User name used to authenticate the Jira integration.
    assigneeName String
    Jira user name for the assignee
    authMethod String
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    baseUrl String
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled Boolean
    Whether the integration is enabled or not
    issueType String
    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 String
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    apiToken String
    The API token for the user email
    assigneeDisplayName String
    Jira display name for the assignee
    name String
    Name of the integration
    password String
    Password used to authenticate the Jira integration.
    userEmail String
    Email address used to authenticate the Jira integration.
    username String
    User name used to authenticate the Jira 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,
        api_token: Optional[str] = None,
        assignee_display_name: Optional[str] = None,
        assignee_name: Optional[str] = None,
        auth_method: Optional[str] = None,
        base_url: Optional[str] = None,
        enabled: Optional[bool] = None,
        issue_type: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        project_key: Optional[str] = None,
        user_email: 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:
    ApiToken string
    The API token for the user email
    AssigneeDisplayName string
    Jira display name for the assignee
    AssigneeName string
    Jira user name for the assignee
    AuthMethod string
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    BaseUrl string
    Base URL of the Jira instance that's integrated with SignalFx.
    Enabled bool
    Whether the integration is enabled or not
    IssueType string
    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.
    Name string
    Name of the integration
    Password string
    Password used to authenticate the Jira integration.
    ProjectKey string
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    UserEmail string
    Email address used to authenticate the Jira integration.
    Username string
    User name used to authenticate the Jira integration.
    ApiToken string
    The API token for the user email
    AssigneeDisplayName string
    Jira display name for the assignee
    AssigneeName string
    Jira user name for the assignee
    AuthMethod string
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    BaseUrl string
    Base URL of the Jira instance that's integrated with SignalFx.
    Enabled bool
    Whether the integration is enabled or not
    IssueType string
    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.
    Name string
    Name of the integration
    Password string
    Password used to authenticate the Jira integration.
    ProjectKey string
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    UserEmail string
    Email address used to authenticate the Jira integration.
    Username string
    User name used to authenticate the Jira integration.
    apiToken String
    The API token for the user email
    assigneeDisplayName String
    Jira display name for the assignee
    assigneeName String
    Jira user name for the assignee
    authMethod String
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    baseUrl String
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled Boolean
    Whether the integration is enabled or not
    issueType String
    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.
    name String
    Name of the integration
    password String
    Password used to authenticate the Jira integration.
    projectKey String
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    userEmail String
    Email address used to authenticate the Jira integration.
    username String
    User name used to authenticate the Jira integration.
    apiToken string
    The API token for the user email
    assigneeDisplayName string
    Jira display name for the assignee
    assigneeName string
    Jira user name for the assignee
    authMethod string
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    baseUrl string
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled boolean
    Whether the integration is enabled or not
    issueType string
    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.
    name string
    Name of the integration
    password string
    Password used to authenticate the Jira integration.
    projectKey string
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    userEmail string
    Email address used to authenticate the Jira integration.
    username string
    User name used to authenticate the Jira integration.
    api_token str
    The API token for the user email
    assignee_display_name str
    Jira display name for the assignee
    assignee_name str
    Jira user name for the assignee
    auth_method str
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    base_url str
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled bool
    Whether the integration is enabled or not
    issue_type str
    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.
    name str
    Name of the integration
    password str
    Password used to authenticate the Jira integration.
    project_key str
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    user_email str
    Email address used to authenticate the Jira integration.
    username str
    User name used to authenticate the Jira integration.
    apiToken String
    The API token for the user email
    assigneeDisplayName String
    Jira display name for the assignee
    assigneeName String
    Jira user name for the assignee
    authMethod String
    Authentication method used when creating the Jira integration. One of EmailAndToken or UsernameAndPassword
    baseUrl String
    Base URL of the Jira instance that's integrated with SignalFx.
    enabled Boolean
    Whether the integration is enabled or not
    issueType String
    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.
    name String
    Name of the integration
    password String
    Password used to authenticate the Jira integration.
    projectKey String
    Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
    userEmail String
    Email address used to authenticate the Jira integration.
    username String
    User name used to authenticate the Jira 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.1 published on Tuesday, Feb 27, 2024 by Pulumi
    pulumi/pulumi-signalfx