PagerDuty v3.10.2, May 30 23
PagerDuty v3.10.2, May 30 23
pagerduty.AutomationActionsRunner
Explore with Pulumi AI
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
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var rUNBOOKAPIKEY = config.Require("rUNBOOKAPIKEY");
var example = new Pagerduty.AutomationActionsRunner("example", new()
{
Description = "Description of the Runner created via TF",
RunnerType = "runbook",
RunbookBaseUri = "rdcat.stg",
RunbookApiKey = rUNBOOKAPIKEY,
});
});
package main
import (
"github.com/pulumi/pulumi-pagerduty/sdk/v3/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, "")
rUNBOOKAPIKEY := cfg.Require("rUNBOOKAPIKEY")
_, err := pagerduty.NewAutomationActionsRunner(ctx, "example", &pagerduty.AutomationActionsRunnerArgs{
Description: pulumi.String("Description of the Runner created via TF"),
RunnerType: pulumi.String("runbook"),
RunbookBaseUri: pulumi.String("rdcat.stg"),
RunbookApiKey: pulumi.String(rUNBOOKAPIKEY),
})
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.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 rUNBOOKAPIKEY = config.get("rUNBOOKAPIKEY");
var example = new AutomationActionsRunner("example", AutomationActionsRunnerArgs.builder()
.description("Description of the Runner created via TF")
.runnerType("runbook")
.runbookBaseUri("rdcat.stg")
.runbookApiKey(rUNBOOKAPIKEY)
.build());
}
}
import pulumi
import pulumi_pagerduty as pagerduty
config = pulumi.Config()
r_unbookapikey = config.require("rUNBOOKAPIKEY")
example = pagerduty.AutomationActionsRunner("example",
description="Description of the Runner created via TF",
runner_type="runbook",
runbook_base_uri="rdcat.stg",
runbook_api_key=r_unbookapikey)
import * as pulumi from "@pulumi/pulumi";
import * as pagerduty from "@pulumi/pagerduty";
const config = new pulumi.Config();
const rUNBOOKAPIKEY = config.require("rUNBOOKAPIKEY");
const example = new pagerduty.AutomationActionsRunner("example", {
description: "Description of the Runner created via TF",
runnerType: "runbook",
runbookBaseUri: "rdcat.stg",
runbookApiKey: rUNBOOKAPIKEY,
});
configuration:
# Assumes the TF_VAR_RUNBOOK_API_KEY variable is defined in the environment
rUNBOOKAPIKEY:
type: string
resources:
example:
type: pagerduty:AutomationActionsRunner
properties:
description: Description of the Runner created via TF
runnerType: runbook
runbookBaseUri: rdcat.stg
runbookApiKey: ${rUNBOOKAPIKEY}
Create AutomationActionsRunner Resource
new AutomationActionsRunner(name: string, args: AutomationActionsRunnerArgs, opts?: CustomResourceOptions);
@overload
def AutomationActionsRunner(resource_name: str,
opts: Optional[ResourceOptions] = 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)
@overload
def AutomationActionsRunner(resource_name: str,
args: AutomationActionsRunnerArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args AutomationActionsRunnerArgs
- 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 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 string
- The unique name of the resource.
- args AutomationActionsRunnerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AutomationActionsRunnerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AutomationActionsRunnerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The AutomationActionsRunner resource accepts the following input properties:
- Runner
Type string The type of runner. The only allowed values is
runbook
.- Description string
The description of the runner. Max length is 1024 characters.
- Last
Seen 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.
- Runbook
Api stringKey The unique User API Token created in Runbook Automation.
- Runbook
Base stringUri The subdomain for your Runbook Automation Instance.
- Runner
Type string The type of runner. The only allowed values is
runbook
.- Description string
The description of the runner. Max length is 1024 characters.
- Last
Seen 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.
- Runbook
Api stringKey The unique User API Token created in Runbook Automation.
- Runbook
Base stringUri The subdomain for your Runbook Automation Instance.
- runner
Type String The type of runner. The only allowed values is
runbook
.- description String
The description of the runner. Max length is 1024 characters.
- last
Seen 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.
- runbook
Api StringKey The unique User API Token created in Runbook Automation.
- runbook
Base StringUri The subdomain for your Runbook Automation Instance.
- runner
Type string The type of runner. The only allowed values is
runbook
.- description string
The description of the runner. Max length is 1024 characters.
- last
Seen 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.
- runbook
Api stringKey The unique User API Token created in Runbook Automation.
- runbook
Base stringUri The subdomain for your Runbook Automation Instance.
- runner_
type 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_ strkey The unique User API Token created in Runbook Automation.
- runbook_
base_ struri The subdomain for your Runbook Automation Instance.
- runner
Type String The type of runner. The only allowed values is
runbook
.- description String
The description of the runner. Max length is 1024 characters.
- last
Seen 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.
- runbook
Api StringKey The unique User API Token created in Runbook Automation.
- runbook
Base StringUri 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:
- Creation
Time 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 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 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 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
.
- creation
Time 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)
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.
- Creation
Time string The time runner was created. Represented as an ISO 8601 timestamp.
- Description string
The description of the runner. Max length is 1024 characters.
- Last
Seen 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.
- Runbook
Api stringKey The unique User API Token created in Runbook Automation.
- Runbook
Base stringUri The subdomain for your Runbook Automation Instance.
- Runner
Type 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 string The time runner was created. Represented as an ISO 8601 timestamp.
- Description string
The description of the runner. Max length is 1024 characters.
- Last
Seen 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.
- Runbook
Api stringKey The unique User API Token created in Runbook Automation.
- Runbook
Base stringUri The subdomain for your Runbook Automation Instance.
- Runner
Type 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 String The time runner was created. Represented as an ISO 8601 timestamp.
- description String
The description of the runner. Max length is 1024 characters.
- last
Seen 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.
- runbook
Api StringKey The unique User API Token created in Runbook Automation.
- runbook
Base StringUri The subdomain for your Runbook Automation Instance.
- runner
Type 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 string The time runner was created. Represented as an ISO 8601 timestamp.
- description string
The description of the runner. Max length is 1024 characters.
- last
Seen 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.
- runbook
Api stringKey The unique User API Token created in Runbook Automation.
- runbook
Base stringUri The subdomain for your Runbook Automation Instance.
- runner
Type 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_ strkey The unique User API Token created in Runbook Automation.
- runbook_
base_ struri The subdomain for your Runbook Automation Instance.
- runner_
type str The type of runner. The only allowed values is
runbook
.- type str
The type of object. The value returned will be
runner
.
- creation
Time String The time runner was created. Represented as an ISO 8601 timestamp.
- description String
The description of the runner. Max length is 1024 characters.
- last
Seen 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.
- runbook
Api StringKey The unique User API Token created in Runbook Automation.
- runbook
Base StringUri The subdomain for your Runbook Automation Instance.
- runner
Type 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
Package Details
- Repository
- PagerDuty pulumi/pulumi-pagerduty
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
pagerduty
Terraform Provider.