@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
206 lines • 8.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* const jiraMyteamXX = new signalfx.jira.Integration("jira_myteamXX", {
* name: "JiraFoo",
* enabled: false,
* authMethod: "UsernameAndPassword",
* username: "yoosername",
* password: "paasword",
* assigneeName: "testytesterson",
* assigneeDisplayName: "Testy Testerson",
* baseUrl: "https://www.example.com",
* issueType: "Story",
* projectKey: "TEST",
* });
* ```
*/
export declare class Integration extends pulumi.CustomResource {
/**
* Get an existing Integration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IntegrationState, opts?: pulumi.CustomResourceOptions): Integration;
/**
* Returns true if the given object is an instance of Integration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Integration;
/**
* The API token for the user email
*/
readonly apiToken: pulumi.Output<string | undefined>;
/**
* Jira display name for the assignee.
*/
readonly assigneeDisplayName: pulumi.Output<string | undefined>;
/**
* Jira user name for the assignee.
*/
readonly assigneeName: pulumi.Output<string>;
/**
* Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`).
*/
readonly authMethod: pulumi.Output<string>;
/**
* Base URL of the Jira instance that's integrated with SignalFx.
*/
readonly baseUrl: pulumi.Output<string>;
/**
* Whether the integration is enabled.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* 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`.
*/
readonly issueType: pulumi.Output<string>;
/**
* Name of the integration.
*/
readonly name: pulumi.Output<string>;
/**
* Password used to authenticate the Jira integration.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* Jira key of an existing project. When Jira creates a new ticket for a detector notification, the ticket is assigned to this project.
*/
readonly projectKey: pulumi.Output<string>;
/**
* Email address used to authenticate the Jira integration.
*/
readonly userEmail: pulumi.Output<string | undefined>;
/**
* User name used to authenticate the Jira integration.
*/
readonly username: pulumi.Output<string | undefined>;
/**
* Create a Integration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: IntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Integration resources.
*/
export interface IntegrationState {
/**
* The API token for the user email
*/
apiToken?: pulumi.Input<string | undefined>;
/**
* Jira display name for the assignee.
*/
assigneeDisplayName?: pulumi.Input<string | undefined>;
/**
* Jira user name for the assignee.
*/
assigneeName?: pulumi.Input<string | undefined>;
/**
* Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`).
*/
authMethod?: pulumi.Input<string | undefined>;
/**
* Base URL of the Jira instance that's integrated with SignalFx.
*/
baseUrl?: pulumi.Input<string | undefined>;
/**
* Whether the integration is enabled.
*/
enabled?: pulumi.Input<boolean | undefined>;
/**
* 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.Input<string | undefined>;
/**
* Name of the integration.
*/
name?: pulumi.Input<string | undefined>;
/**
* Password used to authenticate the Jira integration.
*/
password?: pulumi.Input<string | undefined>;
/**
* 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.Input<string | undefined>;
/**
* Email address used to authenticate the Jira integration.
*/
userEmail?: pulumi.Input<string | undefined>;
/**
* User name used to authenticate the Jira integration.
*/
username?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Integration resource.
*/
export interface IntegrationArgs {
/**
* The API token for the user email
*/
apiToken?: pulumi.Input<string | undefined>;
/**
* Jira display name for the assignee.
*/
assigneeDisplayName?: pulumi.Input<string | undefined>;
/**
* Jira user name for the assignee.
*/
assigneeName: pulumi.Input<string>;
/**
* Authentication method used when creating the Jira integration. One of `EmailAndToken` (using `userEmail` and `apiToken`) or `UsernameAndPassword` (using `username` and `password`).
*/
authMethod: pulumi.Input<string>;
/**
* Base URL of the Jira instance that's integrated with SignalFx.
*/
baseUrl: pulumi.Input<string>;
/**
* Whether the integration is enabled.
*/
enabled: pulumi.Input<boolean>;
/**
* 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.Input<string>;
/**
* Name of the integration.
*/
name?: pulumi.Input<string | undefined>;
/**
* Password used to authenticate the Jira integration.
*/
password?: pulumi.Input<string | undefined>;
/**
* 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.Input<string>;
/**
* Email address used to authenticate the Jira integration.
*/
userEmail?: pulumi.Input<string | undefined>;
/**
* User name used to authenticate the Jira integration.
*/
username?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=integration.d.ts.map