Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. AutomationActionsRunner
PagerDuty v4.23.1 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-pagerduty

pagerduty.AutomationActionsRunner

Explore with Pulumi AI

PagerDuty v4.23.1 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-pagerduty

An Automation Actions runner is the method for how actions are executed. This can be done locally using an installed runner agent or as a connection to a PD Runbook Automation instance.

Only Runbook Automation (runbook) runners can be created.

Example Usage

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

const config = new pulumi.Config();
const RUNBOOK_API_KEY = config.require("RUNBOOK_API_KEY");
const example = new pagerduty.AutomationActionsRunner("example", {
    name: "Runner created via TF",
    description: "Description of the Runner created via TF",
    runnerType: "runbook",
    runbookBaseUri: "rdcat.stg",
    runbookApiKey: RUNBOOK_API_KEY,
});
Copy
import pulumi
import pulumi_pagerduty as pagerduty

config = pulumi.Config()
runboo_k__ap_i__key = config.require("RUNBOOK_API_KEY")
example = pagerduty.AutomationActionsRunner("example",
    name="Runner created via TF",
    description="Description of the Runner created via TF",
    runner_type="runbook",
    runbook_base_uri="rdcat.stg",
    runbook_api_key=runboo_k__ap_i__key)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		RUNBOOK_API_KEY := cfg.Require("RUNBOOK_API_KEY")
		_, err := pagerduty.NewAutomationActionsRunner(ctx, "example", &pagerduty.AutomationActionsRunnerArgs{
			Name:           pulumi.String("Runner created via TF"),
			Description:    pulumi.String("Description of the Runner created via TF"),
			RunnerType:     pulumi.String("runbook"),
			RunbookBaseUri: pulumi.String("rdcat.stg"),
			RunbookApiKey:  pulumi.String(RUNBOOK_API_KEY),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var RUNBOOK_API_KEY = config.Require("RUNBOOK_API_KEY");
    var example = new Pagerduty.AutomationActionsRunner("example", new()
    {
        Name = "Runner created via TF",
        Description = "Description of the Runner created via TF",
        RunnerType = "runbook",
        RunbookBaseUri = "rdcat.stg",
        RunbookApiKey = RUNBOOK_API_KEY,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.pagerduty.AutomationActionsRunner;
import com.pulumi.pagerduty.AutomationActionsRunnerArgs;
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) {
        final var config = ctx.config();
        final var RUNBOOK_API_KEY = config.get("RUNBOOK_API_KEY");
        var example = new AutomationActionsRunner("example", AutomationActionsRunnerArgs.builder()
            .name("Runner created via TF")
            .description("Description of the Runner created via TF")
            .runnerType("runbook")
            .runbookBaseUri("rdcat.stg")
            .runbookApiKey(RUNBOOK_API_KEY)
            .build());

    }
}
Copy
configuration:
  # Assumes the TF_VAR_RUNBOOK_API_KEY variable is defined in the environment
  RUNBOOK_API_KEY:
    type: string
resources:
  example:
    type: pagerduty:AutomationActionsRunner
    properties:
      name: Runner created via TF
      description: Description of the Runner created via TF
      runnerType: runbook
      runbookBaseUri: rdcat.stg
      runbookApiKey: ${RUNBOOK_API_KEY}
Copy

Create AutomationActionsRunner Resource

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

Constructor syntax

new AutomationActionsRunner(name: string, args: AutomationActionsRunnerArgs, opts?: CustomResourceOptions);
@overload
def AutomationActionsRunner(resource_name: str,
                            args: AutomationActionsRunnerArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def AutomationActionsRunner(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            runner_type: Optional[str] = None,
                            description: Optional[str] = None,
                            last_seen: Optional[str] = None,
                            name: Optional[str] = None,
                            runbook_api_key: Optional[str] = None,
                            runbook_base_uri: Optional[str] = None)
func NewAutomationActionsRunner(ctx *Context, name string, args AutomationActionsRunnerArgs, opts ...ResourceOption) (*AutomationActionsRunner, error)
public AutomationActionsRunner(string name, AutomationActionsRunnerArgs args, CustomResourceOptions? opts = null)
public AutomationActionsRunner(String name, AutomationActionsRunnerArgs args)
public AutomationActionsRunner(String name, AutomationActionsRunnerArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AutomationActionsRunnerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AutomationActionsRunnerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AutomationActionsRunnerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AutomationActionsRunnerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AutomationActionsRunnerArgs
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 automationActionsRunnerResource = new Pagerduty.AutomationActionsRunner("automationActionsRunnerResource", new()
{
    RunnerType = "string",
    Description = "string",
    LastSeen = "string",
    Name = "string",
    RunbookApiKey = "string",
    RunbookBaseUri = "string",
});
Copy
example, err := pagerduty.NewAutomationActionsRunner(ctx, "automationActionsRunnerResource", &pagerduty.AutomationActionsRunnerArgs{
	RunnerType:     pulumi.String("string"),
	Description:    pulumi.String("string"),
	LastSeen:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	RunbookApiKey:  pulumi.String("string"),
	RunbookBaseUri: pulumi.String("string"),
})
Copy
var automationActionsRunnerResource = new AutomationActionsRunner("automationActionsRunnerResource", AutomationActionsRunnerArgs.builder()
    .runnerType("string")
    .description("string")
    .lastSeen("string")
    .name("string")
    .runbookApiKey("string")
    .runbookBaseUri("string")
    .build());
Copy
automation_actions_runner_resource = pagerduty.AutomationActionsRunner("automationActionsRunnerResource",
    runner_type="string",
    description="string",
    last_seen="string",
    name="string",
    runbook_api_key="string",
    runbook_base_uri="string")
Copy
const automationActionsRunnerResource = new pagerduty.AutomationActionsRunner("automationActionsRunnerResource", {
    runnerType: "string",
    description: "string",
    lastSeen: "string",
    name: "string",
    runbookApiKey: "string",
    runbookBaseUri: "string",
});
Copy
type: pagerduty:AutomationActionsRunner
properties:
    description: string
    lastSeen: string
    name: string
    runbookApiKey: string
    runbookBaseUri: string
    runnerType: string
Copy

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

RunnerType
This property is required.
Changes to this property will trigger replacement.
string
The type of runner. The only allowed values is runbook.
Description string
The description of the runner. Max length is 1024 characters.
LastSeen string
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
Name string
The name of the runner. Max length is 255 characters.
RunbookApiKey string
The unique User API Token created in Runbook Automation.
RunbookBaseUri string
The subdomain for your Runbook Automation Instance.
RunnerType
This property is required.
Changes to this property will trigger replacement.
string
The type of runner. The only allowed values is runbook.
Description string
The description of the runner. Max length is 1024 characters.
LastSeen string
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
Name string
The name of the runner. Max length is 255 characters.
RunbookApiKey string
The unique User API Token created in Runbook Automation.
RunbookBaseUri string
The subdomain for your Runbook Automation Instance.
runnerType
This property is required.
Changes to this property will trigger replacement.
String
The type of runner. The only allowed values is runbook.
description String
The description of the runner. Max length is 1024 characters.
lastSeen String
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name String
The name of the runner. Max length is 255 characters.
runbookApiKey String
The unique User API Token created in Runbook Automation.
runbookBaseUri String
The subdomain for your Runbook Automation Instance.
runnerType
This property is required.
Changes to this property will trigger replacement.
string
The type of runner. The only allowed values is runbook.
description string
The description of the runner. Max length is 1024 characters.
lastSeen string
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name string
The name of the runner. Max length is 255 characters.
runbookApiKey string
The unique User API Token created in Runbook Automation.
runbookBaseUri string
The subdomain for your Runbook Automation Instance.
runner_type
This property is required.
Changes to this property will trigger replacement.
str
The type of runner. The only allowed values is runbook.
description str
The description of the runner. Max length is 1024 characters.
last_seen str
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name str
The name of the runner. Max length is 255 characters.
runbook_api_key str
The unique User API Token created in Runbook Automation.
runbook_base_uri str
The subdomain for your Runbook Automation Instance.
runnerType
This property is required.
Changes to this property will trigger replacement.
String
The type of runner. The only allowed values is runbook.
description String
The description of the runner. Max length is 1024 characters.
lastSeen String
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name String
The name of the runner. Max length is 255 characters.
runbookApiKey String
The unique User API Token created in Runbook Automation.
runbookBaseUri String
The subdomain for your Runbook Automation Instance.

Outputs

All input properties are implicitly available as output properties. Additionally, the AutomationActionsRunner resource produces the following output properties:

CreationTime string
The time runner was created. Represented as an ISO 8601 timestamp.
Id string
The provider-assigned unique ID for this managed resource.
Type string
The type of object. The value returned will be runner.
CreationTime string
The time runner was created. Represented as an ISO 8601 timestamp.
Id string
The provider-assigned unique ID for this managed resource.
Type string
The type of object. The value returned will be runner.
creationTime String
The time runner was created. Represented as an ISO 8601 timestamp.
id String
The provider-assigned unique ID for this managed resource.
type String
The type of object. The value returned will be runner.
creationTime string
The time runner was created. Represented as an ISO 8601 timestamp.
id string
The provider-assigned unique ID for this managed resource.
type string
The type of object. The value returned will be runner.
creation_time str
The time runner was created. Represented as an ISO 8601 timestamp.
id str
The provider-assigned unique ID for this managed resource.
type str
The type of object. The value returned will be runner.
creationTime String
The time runner was created. Represented as an ISO 8601 timestamp.
id String
The provider-assigned unique ID for this managed resource.
type String
The type of object. The value returned will be runner.

Look up Existing AutomationActionsRunner Resource

Get an existing AutomationActionsRunner 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?: AutomationActionsRunnerState, opts?: CustomResourceOptions): AutomationActionsRunner
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[str] = None,
        description: Optional[str] = None,
        last_seen: Optional[str] = None,
        name: Optional[str] = None,
        runbook_api_key: Optional[str] = None,
        runbook_base_uri: Optional[str] = None,
        runner_type: Optional[str] = None,
        type: Optional[str] = None) -> AutomationActionsRunner
func GetAutomationActionsRunner(ctx *Context, name string, id IDInput, state *AutomationActionsRunnerState, opts ...ResourceOption) (*AutomationActionsRunner, error)
public static AutomationActionsRunner Get(string name, Input<string> id, AutomationActionsRunnerState? state, CustomResourceOptions? opts = null)
public static AutomationActionsRunner get(String name, Output<String> id, AutomationActionsRunnerState state, CustomResourceOptions options)
resources:  _:    type: pagerduty:AutomationActionsRunner    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreationTime string
The time runner was created. Represented as an ISO 8601 timestamp.
Description string
The description of the runner. Max length is 1024 characters.
LastSeen string
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
Name string
The name of the runner. Max length is 255 characters.
RunbookApiKey string
The unique User API Token created in Runbook Automation.
RunbookBaseUri string
The subdomain for your Runbook Automation Instance.
RunnerType Changes to this property will trigger replacement. string
The type of runner. The only allowed values is runbook.
Type string
The type of object. The value returned will be runner.
CreationTime string
The time runner was created. Represented as an ISO 8601 timestamp.
Description string
The description of the runner. Max length is 1024 characters.
LastSeen string
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
Name string
The name of the runner. Max length is 255 characters.
RunbookApiKey string
The unique User API Token created in Runbook Automation.
RunbookBaseUri string
The subdomain for your Runbook Automation Instance.
RunnerType Changes to this property will trigger replacement. string
The type of runner. The only allowed values is runbook.
Type string
The type of object. The value returned will be runner.
creationTime String
The time runner was created. Represented as an ISO 8601 timestamp.
description String
The description of the runner. Max length is 1024 characters.
lastSeen String
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name String
The name of the runner. Max length is 255 characters.
runbookApiKey String
The unique User API Token created in Runbook Automation.
runbookBaseUri String
The subdomain for your Runbook Automation Instance.
runnerType Changes to this property will trigger replacement. String
The type of runner. The only allowed values is runbook.
type String
The type of object. The value returned will be runner.
creationTime string
The time runner was created. Represented as an ISO 8601 timestamp.
description string
The description of the runner. Max length is 1024 characters.
lastSeen string
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name string
The name of the runner. Max length is 255 characters.
runbookApiKey string
The unique User API Token created in Runbook Automation.
runbookBaseUri string
The subdomain for your Runbook Automation Instance.
runnerType Changes to this property will trigger replacement. string
The type of runner. The only allowed values is runbook.
type string
The type of object. The value returned will be runner.
creation_time str
The time runner was created. Represented as an ISO 8601 timestamp.
description str
The description of the runner. Max length is 1024 characters.
last_seen str
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name str
The name of the runner. Max length is 255 characters.
runbook_api_key str
The unique User API Token created in Runbook Automation.
runbook_base_uri str
The subdomain for your Runbook Automation Instance.
runner_type Changes to this property will trigger replacement. str
The type of runner. The only allowed values is runbook.
type str
The type of object. The value returned will be runner.
creationTime String
The time runner was created. Represented as an ISO 8601 timestamp.
description String
The description of the runner. Max length is 1024 characters.
lastSeen String
(Optional) The last time runner has been seen. Represented as an ISO 8601 timestamp.
name String
The name of the runner. Max length is 255 characters.
runbookApiKey String
The unique User API Token created in Runbook Automation.
runbookBaseUri String
The subdomain for your Runbook Automation Instance.
runnerType Changes to this property will trigger replacement. String
The type of runner. The only allowed values is runbook.
type String
The type of object. The value returned will be runner.

Import

-> In the example below the runbook_api_key attribute has been omitted to avoid resource replacement after the import.

Runners can be imported using the id, e.g.

resource “pagerduty_automation_actions_runner” “example” {

name = “Runner created via TF”

description = “Description of the Runner created via TF”

runner_type = “runbook”

runbook_base_uri = “rdcat.stg”

}

$ pulumi import pagerduty:index/automationActionsRunner:AutomationActionsRunner example 01DER7CUUBF7TH4116K0M4WKPU
Copy

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 v4.23.1 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-pagerduty