1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. PagerdutyConnector
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.PagerdutyConnector

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for creating a PagerDuty connector.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Harness.Platform.PagerdutyConnector("test", new()
        {
            ApiTokenRef = "account.secret_id",
            DelegateSelectors = new[]
            {
                "harness-delegate",
            },
            Description = "test",
            Identifier = "identifier",
            Tags = new[]
            {
                "foo:bar",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewPagerdutyConnector(ctx, "test", &platform.PagerdutyConnectorArgs{
    			ApiTokenRef: pulumi.String("account.secret_id"),
    			DelegateSelectors: pulumi.StringArray{
    				pulumi.String("harness-delegate"),
    			},
    			Description: pulumi.String("test"),
    			Identifier:  pulumi.String("identifier"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    		})
    		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.harness.platform.PagerdutyConnector;
    import com.pulumi.harness.platform.PagerdutyConnectorArgs;
    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 test = new PagerdutyConnector("test", PagerdutyConnectorArgs.builder()        
                .apiTokenRef("account.secret_id")
                .delegateSelectors("harness-delegate")
                .description("test")
                .identifier("identifier")
                .tags("foo:bar")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    test = harness.platform.PagerdutyConnector("test",
        api_token_ref="account.secret_id",
        delegate_selectors=["harness-delegate"],
        description="test",
        identifier="identifier",
        tags=["foo:bar"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    const test = new harness.platform.PagerdutyConnector("test", {
        apiTokenRef: "account.secret_id",
        delegateSelectors: ["harness-delegate"],
        description: "test",
        identifier: "identifier",
        tags: ["foo:bar"],
    });
    
    resources:
      test:
        type: harness:platform:PagerdutyConnector
        properties:
          apiTokenRef: account.secret_id
          delegateSelectors:
            - harness-delegate
          description: test
          identifier: identifier
          tags:
            - foo:bar
    

    Create PagerdutyConnector Resource

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

    Constructor syntax

    new PagerdutyConnector(name: string, args: PagerdutyConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def PagerdutyConnector(resource_name: str,
                           args: PagerdutyConnectorArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def PagerdutyConnector(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           api_token_ref: Optional[str] = None,
                           identifier: Optional[str] = None,
                           delegate_selectors: Optional[Sequence[str]] = None,
                           description: Optional[str] = None,
                           name: Optional[str] = None,
                           org_id: Optional[str] = None,
                           project_id: Optional[str] = None,
                           tags: Optional[Sequence[str]] = None)
    func NewPagerdutyConnector(ctx *Context, name string, args PagerdutyConnectorArgs, opts ...ResourceOption) (*PagerdutyConnector, error)
    public PagerdutyConnector(string name, PagerdutyConnectorArgs args, CustomResourceOptions? opts = null)
    public PagerdutyConnector(String name, PagerdutyConnectorArgs args)
    public PagerdutyConnector(String name, PagerdutyConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:PagerdutyConnector
    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 PagerdutyConnectorArgs
    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 PagerdutyConnectorArgs
    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 PagerdutyConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PagerdutyConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PagerdutyConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var pagerdutyConnectorResource = new Harness.Platform.PagerdutyConnector("pagerdutyConnectorResource", new()
    {
        ApiTokenRef = "string",
        Identifier = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
        Description = "string",
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewPagerdutyConnector(ctx, "pagerdutyConnectorResource", &platform.PagerdutyConnectorArgs{
    	ApiTokenRef: pulumi.String("string"),
    	Identifier:  pulumi.String("string"),
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var pagerdutyConnectorResource = new PagerdutyConnector("pagerdutyConnectorResource", PagerdutyConnectorArgs.builder()        
        .apiTokenRef("string")
        .identifier("string")
        .delegateSelectors("string")
        .description("string")
        .name("string")
        .orgId("string")
        .projectId("string")
        .tags("string")
        .build());
    
    pagerduty_connector_resource = harness.platform.PagerdutyConnector("pagerdutyConnectorResource",
        api_token_ref="string",
        identifier="string",
        delegate_selectors=["string"],
        description="string",
        name="string",
        org_id="string",
        project_id="string",
        tags=["string"])
    
    const pagerdutyConnectorResource = new harness.platform.PagerdutyConnector("pagerdutyConnectorResource", {
        apiTokenRef: "string",
        identifier: "string",
        delegateSelectors: ["string"],
        description: "string",
        name: "string",
        orgId: "string",
        projectId: "string",
        tags: ["string"],
    });
    
    type: harness:platform:PagerdutyConnector
    properties:
        apiTokenRef: string
        delegateSelectors:
            - string
        description: string
        identifier: string
        name: string
        orgId: string
        projectId: string
        tags:
            - string
    

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

    ApiTokenRef string
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Identifier string
    Unique identifier of the resource.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    ApiTokenRef string
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Identifier string
    Unique identifier of the resource.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    apiTokenRef String
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier String
    Unique identifier of the resource.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    apiTokenRef string
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier string
    Unique identifier of the resource.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    api_token_ref str
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier str
    Unique identifier of the resource.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    apiTokenRef String
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier String
    Unique identifier of the resource.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    Get an existing PagerdutyConnector 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?: PagerdutyConnectorState, opts?: CustomResourceOptions): PagerdutyConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_token_ref: Optional[str] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> PagerdutyConnector
    func GetPagerdutyConnector(ctx *Context, name string, id IDInput, state *PagerdutyConnectorState, opts ...ResourceOption) (*PagerdutyConnector, error)
    public static PagerdutyConnector Get(string name, Input<string> id, PagerdutyConnectorState? state, CustomResourceOptions? opts = null)
    public static PagerdutyConnector get(String name, Output<String> id, PagerdutyConnectorState 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:
    ApiTokenRef string
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    ApiTokenRef string
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    apiTokenRef String
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    apiTokenRef string
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    api_token_ref str
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    apiTokenRef String
    Reference to the Harness secret containing the api token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Import

    Import account level pagerduty connector

     $ pulumi import harness:platform/pagerdutyConnector:PagerdutyConnector example <connector_id>
    

    Import org level pagerduty connector

     $ pulumi import harness:platform/pagerdutyConnector:PagerdutyConnector example <ord_id>/<connector_id>
    

    Import project level pagerduty connector

     $ pulumi import harness:platform/pagerdutyConnector:PagerdutyConnector example <org_id>/<project_id>/<connector_id>
    

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

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs