PagerDuty v3.9.0, Mar 14 23

pagerduty.CustomFieldSchema

A Custom Field Schema is a set of Custom Fields which can be set on an incident.

The Custom Fields feature is currently available in Early Access.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;

return await Deployment.RunAsync(() => 
{
    var csImpact = new Pagerduty.CustomField("csImpact", new()
    {
        Datatype = "string",
    });

    var mySchema = new Pagerduty.CustomFieldSchema("mySchema", new()
    {
        Description = "Fields used on incidents",
        Title = "My Schema",
    });

});

package main

import (
	"github.com/pulumi/pulumi-pagerduty/sdk/v3/go/pagerduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := pagerduty.NewCustomField(ctx, "csImpact", &pagerduty.CustomFieldArgs{
			Datatype: pulumi.String("string"),
		})
		if err != nil {
			return err
		}
		_, err = pagerduty.NewCustomFieldSchema(ctx, "mySchema", &pagerduty.CustomFieldSchemaArgs{
			Description: pulumi.String("Fields used on incidents"),
			Title:       pulumi.String("My Schema"),
		})
		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.pagerduty.CustomField;
import com.pulumi.pagerduty.CustomFieldArgs;
import com.pulumi.pagerduty.CustomFieldSchema;
import com.pulumi.pagerduty.CustomFieldSchemaArgs;
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 csImpact = new CustomField("csImpact", CustomFieldArgs.builder()        
            .datatype("string")
            .build());

        var mySchema = new CustomFieldSchema("mySchema", CustomFieldSchemaArgs.builder()        
            .description("Fields used on incidents")
            .title("My Schema")
            .build());

    }
}

import pulumi
import pulumi_pagerduty as pagerduty

cs_impact = pagerduty.CustomField("csImpact", datatype="string")
my_schema = pagerduty.CustomFieldSchema("mySchema",
    description="Fields used on incidents",
    title="My Schema")

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

const csImpact = new pagerduty.CustomField("csImpact", {datatype: "string"});
const mySchema = new pagerduty.CustomFieldSchema("mySchema", {
    description: "Fields used on incidents",
    title: "My Schema",
});

resources:
  csImpact:
    type: pagerduty:CustomField
    properties:
      datatype: string
  mySchema:
    type: pagerduty:CustomFieldSchema
    properties:
      description: Fields used on incidents
      title: My Schema

Create CustomFieldSchema Resource

new CustomFieldSchema(name: string, args: CustomFieldSchemaArgs, opts?: CustomResourceOptions);

@overload
def CustomFieldSchema(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      title: Optional[str] = None)
@overload
def CustomFieldSchema(resource_name: str,
                      args: CustomFieldSchemaArgs,
                      opts: Optional[ResourceOptions] = None)

func NewCustomFieldSchema(ctx *Context, name string, args CustomFieldSchemaArgs, opts ...ResourceOption) (*CustomFieldSchema, error)

public CustomFieldSchema(string name, CustomFieldSchemaArgs args, CustomResourceOptions? opts = null)

public CustomFieldSchema(String name, CustomFieldSchemaArgs args)
public CustomFieldSchema(String name, CustomFieldSchemaArgs args, CustomResourceOptions options)

type: pagerduty:CustomFieldSchema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomFieldSchemaArgs: 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 CustomFieldSchemaArgs: 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 CustomFieldSchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomFieldSchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CustomFieldSchemaArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

CustomFieldSchema 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 CustomFieldSchema resource accepts the following input properties:

Title string: The title of the field schema.
Description string: The description of the field schema.

Title string: The title of the field schema.
Description string: The description of the field schema.

title String: The title of the field schema.
description String: The description of the field schema.

title string: The title of the field schema.
description string: The description of the field schema.

title str: The title of the field schema.
description str: The description of the field schema.

title String: The title of the field schema.
description String: The description of the field schema.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomFieldSchema 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 CustomFieldSchema Resource

Get an existing CustomFieldSchema 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?: CustomFieldSchemaState, opts?: CustomResourceOptions): CustomFieldSchema

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        title: Optional[str] = None) -> CustomFieldSchema

func GetCustomFieldSchema(ctx *Context, name string, id IDInput, state *CustomFieldSchemaState, opts ...ResourceOption) (*CustomFieldSchema, error)

public static CustomFieldSchema Get(string name, Input<string> id, CustomFieldSchemaState? state, CustomResourceOptions? opts = null)

public static CustomFieldSchema get(String name, Output<String> id, CustomFieldSchemaState 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:

Description string: The description of the field schema.
Title string: The title of the field schema.

Description string: The description of the field schema.
Title string: The title of the field schema.

description String: The description of the field schema.
title String: The title of the field schema.

description string: The description of the field schema.
title string: The title of the field schema.

description str: The description of the field schema.
title str: The title of the field schema.

description String: The description of the field schema.
title String: The title of the field schema.

Import

Fields schemas can be imported using the id, e.g.

 $ pulumi import pagerduty:index/customFieldSchema:CustomFieldSchema my_schema PLBP09X

Package Details

Repository: PagerDuty pulumi/pulumi-pagerduty
License: Apache-2.0
Notes: This Pulumi package is based on the pagerduty Terraform Provider.