1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. Addon
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi

pagerduty.Addon

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi

    With add-ons, third-party developers can write their own add-ons to PagerDuty’s UI. Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that’s available to users from a drop-down menu.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as pagerduty from "@pulumi/pagerduty";
    
    const example = new pagerduty.Addon("example", {
        name: "Internal Status Page",
        src: "https://intranet.example.com/status",
    });
    
    import pulumi
    import pulumi_pagerduty as pagerduty
    
    example = pagerduty.Addon("example",
        name="Internal Status Page",
        src="https://intranet.example.com/status")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pagerduty.NewAddon(ctx, "example", &pagerduty.AddonArgs{
    			Name: pulumi.String("Internal Status Page"),
    			Src:  pulumi.String("https://intranet.example.com/status"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Pagerduty = Pulumi.Pagerduty;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Pagerduty.Addon("example", new()
        {
            Name = "Internal Status Page",
            Src = "https://intranet.example.com/status",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.pagerduty.Addon;
    import com.pulumi.pagerduty.AddonArgs;
    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 example = new Addon("example", AddonArgs.builder()
                .name("Internal Status Page")
                .src("https://intranet.example.com/status")
                .build());
    
        }
    }
    
    resources:
      example:
        type: pagerduty:Addon
        properties:
          name: Internal Status Page
          src: https://intranet.example.com/status
    

    Create Addon Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Addon(name: string, args: AddonArgs, opts?: CustomResourceOptions);
    @overload
    def Addon(resource_name: str,
              args: AddonArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Addon(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              src: Optional[str] = None,
              name: Optional[str] = None)
    func NewAddon(ctx *Context, name string, args AddonArgs, opts ...ResourceOption) (*Addon, error)
    public Addon(string name, AddonArgs args, CustomResourceOptions? opts = null)
    public Addon(String name, AddonArgs args)
    public Addon(String name, AddonArgs args, CustomResourceOptions options)
    
    type: pagerduty:Addon
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var addonResource = new Pagerduty.Addon("addonResource", new()
    {
        Src = "string",
        Name = "string",
    });
    
    example, err := pagerduty.NewAddon(ctx, "addonResource", &pagerduty.AddonArgs{
    	Src:  pulumi.String("string"),
    	Name: pulumi.String("string"),
    })
    
    var addonResource = new Addon("addonResource", AddonArgs.builder()
        .src("string")
        .name("string")
        .build());
    
    addon_resource = pagerduty.Addon("addonResource",
        src="string",
        name="string")
    
    const addonResource = new pagerduty.Addon("addonResource", {
        src: "string",
        name: "string",
    });
    
    type: pagerduty:Addon
    properties:
        name: string
        src: string
    

    Addon Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Addon resource accepts the following input properties:

    Src string
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    Name string
    The name of the add-on.
    Src string
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    Name string
    The name of the add-on.
    src String
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name String
    The name of the add-on.
    src string
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name string
    The name of the add-on.
    src str
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name str
    The name of the add-on.
    src String
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name String
    The name of the add-on.

    Outputs

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

    Get an existing Addon 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?: AddonState, opts?: CustomResourceOptions): Addon
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            src: Optional[str] = None) -> Addon
    func GetAddon(ctx *Context, name string, id IDInput, state *AddonState, opts ...ResourceOption) (*Addon, error)
    public static Addon Get(string name, Input<string> id, AddonState? state, CustomResourceOptions? opts = null)
    public static Addon get(String name, Output<String> id, AddonState 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:
    Name string
    The name of the add-on.
    Src string
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    Name string
    The name of the add-on.
    Src string
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name String
    The name of the add-on.
    src String
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name string
    The name of the add-on.
    src string
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name str
    The name of the add-on.
    src str
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
    name String
    The name of the add-on.
    src String
    The source URL to display in a frame in the PagerDuty UI. HTTPS is required.

    Import

    Add-ons can be imported using the id, e.g.

    $ pulumi import pagerduty:index/addon:Addon example P3DH5M6
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi