@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
131 lines (130 loc) • 4.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const base = pagerduty.getIncidentType({
* displayName: "Base Incident",
* });
* const example = new pagerduty.IncidentType("example", {
* name: "backoffice",
* displayName: "Backoffice Incident",
* parentType: base.then(base => base.id),
* description: "Internal incidents not facing customer",
* });
* ```
*
* ## Import
*
* Services can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/incidentType:IncidentType main P12345
* ```
*/
export declare class IncidentType extends pulumi.CustomResource {
/**
* Get an existing IncidentType 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?: IncidentTypeState, opts?: pulumi.CustomResourceOptions): IncidentType;
/**
* Returns true if the given object is an instance of IncidentType. 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 IncidentType;
/**
* A succinct description of the Incident Type.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The display name of the Incident Type. Usage of the prefixes PD, PagerDuty, or the suffixes Default, or (Default) is prohibited.
*/
readonly displayName: pulumi.Output<string>;
/**
* State of this Incident Type object. Defaults to true if not provided.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* The name of the Incident Type. Usage of the suffix `_default` is prohibited. This cannot be changed once the incident type has been created.
*/
readonly name: pulumi.Output<string>;
/**
* The parent type of the Incident Type. Either name or id of the parent type can be used.
*/
readonly parentType: pulumi.Output<string>;
/**
* A string that determines the schema of the object.
*/
readonly type: pulumi.Output<string>;
/**
* Create a IncidentType 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: IncidentTypeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IncidentType resources.
*/
export interface IncidentTypeState {
/**
* A succinct description of the Incident Type.
*/
description?: pulumi.Input<string>;
/**
* The display name of the Incident Type. Usage of the prefixes PD, PagerDuty, or the suffixes Default, or (Default) is prohibited.
*/
displayName?: pulumi.Input<string>;
/**
* State of this Incident Type object. Defaults to true if not provided.
*/
enabled?: pulumi.Input<boolean>;
/**
* The name of the Incident Type. Usage of the suffix `_default` is prohibited. This cannot be changed once the incident type has been created.
*/
name?: pulumi.Input<string>;
/**
* The parent type of the Incident Type. Either name or id of the parent type can be used.
*/
parentType?: pulumi.Input<string>;
/**
* A string that determines the schema of the object.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IncidentType resource.
*/
export interface IncidentTypeArgs {
/**
* A succinct description of the Incident Type.
*/
description?: pulumi.Input<string>;
/**
* The display name of the Incident Type. Usage of the prefixes PD, PagerDuty, or the suffixes Default, or (Default) is prohibited.
*/
displayName: pulumi.Input<string>;
/**
* State of this Incident Type object. Defaults to true if not provided.
*/
enabled?: pulumi.Input<boolean>;
/**
* The name of the Incident Type. Usage of the suffix `_default` is prohibited. This cannot be changed once the incident type has been created.
*/
name?: pulumi.Input<string>;
/**
* The parent type of the Incident Type. Either name or id of the parent type can be used.
*/
parentType: pulumi.Input<string>;
}