@pulumi/pagerduty/getServiceCustomField.d.ts

A Pulumi package for creating and managing pagerduty cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Use this data source to get information about a specific Service Custom Field that has been configured in your PagerDuty account.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pagerduty from "@pulumi/pagerduty";
 *
 * const regions = pagerduty.getServiceCustomField({
 *     displayName: "AWS Regions",
 * });
 * ```
 */
export declare function getServiceCustomField(args: GetServiceCustomFieldArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceCustomFieldResult>;
/**
 * A collection of arguments for invoking getServiceCustomField.
 */
export interface GetServiceCustomFieldArgs {
    /**
     * The human-readable name of the field to look up. This must be unique across an account.
     */
    displayName: string;
}
/**
 * A collection of values returned by getServiceCustomField.
 */
export interface GetServiceCustomFieldResult {
    /**
     * The data type of the field option.
     */
    readonly dataType: string;
    readonly defaultValue: string;
    /**
     * A description of the data this field contains.
     */
    readonly description: string;
    readonly displayName: string;
    /**
     * Whether the field is enabled.
     */
    readonly enabled: boolean;
    /**
     * The options for the custom field. Only applies to `singleValueFixed` and `multiValueFixed` field types. Each field option contains:
     */
    readonly fieldOptions: outputs.GetServiceCustomFieldFieldOption[];
    /**
     * The type of data this field contains. In combination with the dataType field.
     */
    readonly fieldType: string;
    /**
     * The ID of the found field.
     */
    readonly id: string;
    /**
     * The name of the field. Contains ASCII characters, specifically lowercase letters, digits, and underscores.
     */
    readonly name: string;
    /**
     * The API show URL at which the object is accessible.
     */
    readonly self: string;
    /**
     * A short-form, server-generated string that provides succinct, important information about the field.
     */
    readonly summary: string;
    /**
     * API object type.
     */
    readonly type: string;
}
/**
 * Use this data source to get information about a specific Service Custom Field that has been configured in your PagerDuty account.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pagerduty from "@pulumi/pagerduty";
 *
 * const regions = pagerduty.getServiceCustomField({
 *     displayName: "AWS Regions",
 * });
 * ```
 */
export declare function getServiceCustomFieldOutput(args: GetServiceCustomFieldOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceCustomFieldResult>;
/**
 * A collection of arguments for invoking getServiceCustomField.
 */
export interface GetServiceCustomFieldOutputArgs {
    /**
     * The human-readable name of the field to look up. This must be unique across an account.
     */
    displayName: pulumi.Input<string>;
}