1. Packages
  2. Rootly
  3. API Docs
  4. PlaybookTask
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

rootly.PlaybookTask

Explore with Pulumi AI

Create PlaybookTask Resource

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

Constructor syntax

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

@overload
def PlaybookTask(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 task: Optional[str] = None,
                 description: Optional[str] = None,
                 playbook_id: Optional[str] = None,
                 position: Optional[int] = None)
func NewPlaybookTask(ctx *Context, name string, args PlaybookTaskArgs, opts ...ResourceOption) (*PlaybookTask, error)
public PlaybookTask(string name, PlaybookTaskArgs args, CustomResourceOptions? opts = null)
public PlaybookTask(String name, PlaybookTaskArgs args)
public PlaybookTask(String name, PlaybookTaskArgs args, CustomResourceOptions options)
type: rootly:PlaybookTask
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. PlaybookTaskArgs
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. PlaybookTaskArgs
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. PlaybookTaskArgs
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. PlaybookTaskArgs
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. PlaybookTaskArgs
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 playbookTaskResource = new Rootly.PlaybookTask("playbookTaskResource", new()
{
    Task = "string",
    Description = "string",
    PlaybookId = "string",
    Position = 0,
});
Copy
example, err := rootly.NewPlaybookTask(ctx, "playbookTaskResource", &rootly.PlaybookTaskArgs{
	Task:        pulumi.String("string"),
	Description: pulumi.String("string"),
	PlaybookId:  pulumi.String("string"),
	Position:    pulumi.Int(0),
})
Copy
var playbookTaskResource = new PlaybookTask("playbookTaskResource", PlaybookTaskArgs.builder()
    .task("string")
    .description("string")
    .playbookId("string")
    .position(0)
    .build());
Copy
playbook_task_resource = rootly.PlaybookTask("playbookTaskResource",
    task="string",
    description="string",
    playbook_id="string",
    position=0)
Copy
const playbookTaskResource = new rootly.PlaybookTask("playbookTaskResource", {
    task: "string",
    description: "string",
    playbookId: "string",
    position: 0,
});
Copy
type: rootly:PlaybookTask
properties:
    description: string
    playbookId: string
    position: 0
    task: string
Copy

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

Task This property is required. string
The task of the task
Description string
The description of task
PlaybookId Changes to this property will trigger replacement. string
Position int
The position of the task
Task This property is required. string
The task of the task
Description string
The description of task
PlaybookId Changes to this property will trigger replacement. string
Position int
The position of the task
task This property is required. String
The task of the task
description String
The description of task
playbookId Changes to this property will trigger replacement. String
position Integer
The position of the task
task This property is required. string
The task of the task
description string
The description of task
playbookId Changes to this property will trigger replacement. string
position number
The position of the task
task This property is required. str
The task of the task
description str
The description of task
playbook_id Changes to this property will trigger replacement. str
position int
The position of the task
task This property is required. String
The task of the task
description String
The description of task
playbookId Changes to this property will trigger replacement. String
position Number
The position of the task

Outputs

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

Get an existing PlaybookTask 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?: PlaybookTaskState, opts?: CustomResourceOptions): PlaybookTask
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        playbook_id: Optional[str] = None,
        position: Optional[int] = None,
        task: Optional[str] = None) -> PlaybookTask
func GetPlaybookTask(ctx *Context, name string, id IDInput, state *PlaybookTaskState, opts ...ResourceOption) (*PlaybookTask, error)
public static PlaybookTask Get(string name, Input<string> id, PlaybookTaskState? state, CustomResourceOptions? opts = null)
public static PlaybookTask get(String name, Output<String> id, PlaybookTaskState state, CustomResourceOptions options)
resources:  _:    type: rootly:PlaybookTask    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:
Description string
The description of task
PlaybookId Changes to this property will trigger replacement. string
Position int
The position of the task
Task string
The task of the task
Description string
The description of task
PlaybookId Changes to this property will trigger replacement. string
Position int
The position of the task
Task string
The task of the task
description String
The description of task
playbookId Changes to this property will trigger replacement. String
position Integer
The position of the task
task String
The task of the task
description string
The description of task
playbookId Changes to this property will trigger replacement. string
position number
The position of the task
task string
The task of the task
description str
The description of task
playbook_id Changes to this property will trigger replacement. str
position int
The position of the task
task str
The task of the task
description String
The description of task
playbookId Changes to this property will trigger replacement. String
position Number
The position of the task
task String
The task of the task

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.