@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
106 lines (105 loc) • 3.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Incident Custom Field Option is a specific value that can be used for an [Incident Custom Field](https://support.pagerduty.com/docs/custom-fields-on-incidents) that only allow values from a set of fixed options,
* i.e. has the `fieldType` of `singleValueFixed` or `multiValueFixed`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const sreEnvironment = new pagerduty.IncidentCustomField("sre_environment", {
* name: "environment",
* displayName: "Environment",
* dataType: "string",
* fieldType: "single_value_fixed",
* });
* const devEnvironment = new pagerduty.IncidentCustomFieldOption("dev_environment", {
* field: sreEnvironment.id,
* dataType: "string",
* value: "dev",
* });
* const stageEnvironment = new pagerduty.IncidentCustomFieldOption("stage_environment", {
* field: sreEnvironment.id,
* dataType: "string",
* value: "stage",
* });
* const prodEnvironment = new pagerduty.IncidentCustomFieldOption("prod_environment", {
* field: sreEnvironment.id,
* dataType: "string",
* value: "prod",
* });
* ```
*/
export declare class IncidentCustomFieldOption extends pulumi.CustomResource {
/**
* Get an existing IncidentCustomFieldOption 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?: IncidentCustomFieldOptionState, opts?: pulumi.CustomResourceOptions): IncidentCustomFieldOption;
/**
* Returns true if the given object is an instance of IncidentCustomFieldOption. 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 IncidentCustomFieldOption;
/**
* The datatype of the field option. Only `string` is allowed here at present.
*/
readonly dataType: pulumi.Output<string>;
/**
* The ID of the field.
*/
readonly field: pulumi.Output<string>;
/**
* The allowed value.
*/
readonly value: pulumi.Output<string>;
/**
* Create a IncidentCustomFieldOption 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: IncidentCustomFieldOptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IncidentCustomFieldOption resources.
*/
export interface IncidentCustomFieldOptionState {
/**
* The datatype of the field option. Only `string` is allowed here at present.
*/
dataType?: pulumi.Input<string>;
/**
* The ID of the field.
*/
field?: pulumi.Input<string>;
/**
* The allowed value.
*/
value?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IncidentCustomFieldOption resource.
*/
export interface IncidentCustomFieldOptionArgs {
/**
* The datatype of the field option. Only `string` is allowed here at present.
*/
dataType: pulumi.Input<string>;
/**
* The ID of the field.
*/
field: pulumi.Input<string>;
/**
* The allowed value.
*/
value: pulumi.Input<string>;
}