Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowTaskHTTPClient
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.WorkflowTaskHTTPClient

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

    Manages workflow http_client task.

    Create WorkflowTaskHTTPClient Resource

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

    Constructor syntax

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

@overload
def WorkflowTaskHTTPClient(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           task_params: Optional[WorkflowTaskHTTPClientTaskParamsArgs] = None,
                           workflow_id: Optional[str] = None,
                           enabled: Optional[bool] = None,
                           name: Optional[str] = None,
                           position: Optional[int] = None,
                           skip_on_failure: Optional[bool] = None)
    func NewWorkflowTaskHTTPClient(ctx *Context, name string, args WorkflowTaskHTTPClientArgs, opts ...ResourceOption) (*WorkflowTaskHTTPClient, error)
    public WorkflowTaskHTTPClient(string name, WorkflowTaskHTTPClientArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskHTTPClient(String name, WorkflowTaskHTTPClientArgs args)
public WorkflowTaskHTTPClient(String name, WorkflowTaskHTTPClientArgs args, CustomResourceOptions options)

    type: rootly:WorkflowTaskHTTPClient
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 WorkflowTaskHTTPClientArgs
    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 WorkflowTaskHTTPClientArgs
    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 WorkflowTaskHTTPClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskHTTPClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskHTTPClientArgs
    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 workflowTaskHTTPClientResource = new Rootly.WorkflowTaskHTTPClient("workflowTaskHTTPClientResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskHTTPClientTaskParamsArgs
    {
        SucceedOnStatus = "string",
        Url = "string",
        Body = "string",
        EventMessage = "string",
        EventUrl = "string",
        Headers = "string",
        Method = "string",
        Params = "string",
        PostToIncidentTimeline = false,
        PostToSlackChannels = new[]
        {
            new Rootly.Inputs.WorkflowTaskHTTPClientTaskParamsPostToSlackChannelArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskHTTPClient(ctx, "workflowTaskHTTPClientResource", &rootly.WorkflowTaskHTTPClientArgs{
	TaskParams: &rootly.WorkflowTaskHTTPClientTaskParamsArgs{
		SucceedOnStatus:        pulumi.String("string"),
		Url:                    pulumi.String("string"),
		Body:                   pulumi.String("string"),
		EventMessage:           pulumi.String("string"),
		EventUrl:               pulumi.String("string"),
		Headers:                pulumi.String("string"),
		Method:                 pulumi.String("string"),
		Params:                 pulumi.String("string"),
		PostToIncidentTimeline: pulumi.Bool(false),
		PostToSlackChannels: rootly.WorkflowTaskHTTPClientTaskParamsPostToSlackChannelArray{
			&rootly.WorkflowTaskHTTPClientTaskParamsPostToSlackChannelArgs{
				Id:   pulumi.String("string"),
				Name: pulumi.String("string"),
			},
		},
		TaskType: pulumi.String("string"),
	},
	WorkflowId:    pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Name:          pulumi.String("string"),
	Position:      pulumi.Int(0),
	SkipOnFailure: pulumi.Bool(false),
})

    var workflowTaskHTTPClientResource = new WorkflowTaskHTTPClient("workflowTaskHTTPClientResource", WorkflowTaskHTTPClientArgs.builder()
    .taskParams(WorkflowTaskHTTPClientTaskParamsArgs.builder()
        .succeedOnStatus("string")
        .url("string")
        .body("string")
        .eventMessage("string")
        .eventUrl("string")
        .headers("string")
        .method("string")
        .params("string")
        .postToIncidentTimeline(false)
        .postToSlackChannels(WorkflowTaskHTTPClientTaskParamsPostToSlackChannelArgs.builder()
            .id("string")
            .name("string")
            .build())
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_http_client_resource = rootly.WorkflowTaskHTTPClient("workflowTaskHTTPClientResource",
    task_params={
        "succeed_on_status": "string",
        "url": "string",
        "body": "string",
        "event_message": "string",
        "event_url": "string",
        "headers": "string",
        "method": "string",
        "params": "string",
        "post_to_incident_timeline": False,
        "post_to_slack_channels": [{
            "id": "string",
            "name": "string",
        }],
        "task_type": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskHTTPClientResource = new rootly.WorkflowTaskHTTPClient("workflowTaskHTTPClientResource", {
    taskParams: {
        succeedOnStatus: "string",
        url: "string",
        body: "string",
        eventMessage: "string",
        eventUrl: "string",
        headers: "string",
        method: "string",
        params: "string",
        postToIncidentTimeline: false,
        postToSlackChannels: [{
            id: "string",
            name: "string",
        }],
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskHTTPClient
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        body: string
        eventMessage: string
        eventUrl: string
        headers: string
        method: string
        params: string
        postToIncidentTimeline: false
        postToSlackChannels:
            - id: string
              name: string
        succeedOnStatus: string
        taskType: string
        url: string
    workflowId: string

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

    TaskParams WorkflowTaskHTTPClientTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskHTTPClientTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    taskParams WorkflowTaskHTTPClientTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskHTTPClientTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    Name of the workflow task
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    task_params WorkflowTaskHTTPClientTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    Name of the workflow task
    position int
    The position of the workflow task (1 being top of list)
    skip_on_failure bool
    Skip workflow task if any failures
    taskParams Property Map
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Number
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures

    Outputs

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

    Get an existing WorkflowTaskHTTPClient 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?: WorkflowTaskHTTPClientState, opts?: CustomResourceOptions): WorkflowTaskHTTPClient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        skip_on_failure: Optional[bool] = None,
        task_params: Optional[WorkflowTaskHTTPClientTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskHTTPClient
    func GetWorkflowTaskHTTPClient(ctx *Context, name string, id IDInput, state *WorkflowTaskHTTPClientState, opts ...ResourceOption) (*WorkflowTaskHTTPClient, error)
    public static WorkflowTaskHTTPClient Get(string name, Input<string> id, WorkflowTaskHTTPClientState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskHTTPClient get(String name, Output<String> id, WorkflowTaskHTTPClientState 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:
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskHTTPClientTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskHTTPClientTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskHTTPClientTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    Name of the workflow task
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskHTTPClientTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    Name of the workflow task
    position int
    The position of the workflow task (1 being top of list)
    skip_on_failure bool
    Skip workflow task if any failures
    task_params WorkflowTaskHTTPClientTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Number
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams Property Map
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow

    Supporting Types

    WorkflowTaskHTTPClientTaskParams, WorkflowTaskHTTPClientTaskParamsArgs

    SucceedOnStatus string
    HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]
    Url string
    URL endpoint
    Body string
    HTTP body
    EventMessage string
    EventUrl string
    Headers string
    JSON map of HTTP headers
    Method string
    HTTP method. Value must be one of GET, POST, PUT, DELETE, OPTIONS.
    Params string
    JSON map of HTTP query parameters
    PostToIncidentTimeline bool
    Value must be one of true or false
    PostToSlackChannels List<WorkflowTaskHTTPClientTaskParamsPostToSlackChannel>
    TaskType string
    SucceedOnStatus string
    HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]
    Url string
    URL endpoint
    Body string
    HTTP body
    EventMessage string
    EventUrl string
    Headers string
    JSON map of HTTP headers
    Method string
    HTTP method. Value must be one of GET, POST, PUT, DELETE, OPTIONS.
    Params string
    JSON map of HTTP query parameters
    PostToIncidentTimeline bool
    Value must be one of true or false
    PostToSlackChannels []WorkflowTaskHTTPClientTaskParamsPostToSlackChannel
    TaskType string
    succeedOnStatus String
    HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]
    url String
    URL endpoint
    body String
    HTTP body
    eventMessage String
    eventUrl String
    headers String
    JSON map of HTTP headers
    method String
    HTTP method. Value must be one of GET, POST, PUT, DELETE, OPTIONS.
    params String
    JSON map of HTTP query parameters
    postToIncidentTimeline Boolean
    Value must be one of true or false
    postToSlackChannels List<WorkflowTaskHTTPClientTaskParamsPostToSlackChannel>
    taskType String
    succeedOnStatus string
    HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]
    url string
    URL endpoint
    body string
    HTTP body
    eventMessage string
    eventUrl string
    headers string
    JSON map of HTTP headers
    method string
    HTTP method. Value must be one of GET, POST, PUT, DELETE, OPTIONS.
    params string
    JSON map of HTTP query parameters
    postToIncidentTimeline boolean
    Value must be one of true or false
    postToSlackChannels WorkflowTaskHTTPClientTaskParamsPostToSlackChannel[]
    taskType string
    succeed_on_status str
    HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]
    url str
    URL endpoint
    body str
    HTTP body
    event_message str
    event_url str
    headers str
    JSON map of HTTP headers
    method str
    HTTP method. Value must be one of GET, POST, PUT, DELETE, OPTIONS.
    params str
    JSON map of HTTP query parameters
    post_to_incident_timeline bool
    Value must be one of true or false
    post_to_slack_channels Sequence[WorkflowTaskHTTPClientTaskParamsPostToSlackChannel]
    task_type str
    succeedOnStatus String
    HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]
    url String
    URL endpoint
    body String
    HTTP body
    eventMessage String
    eventUrl String
    headers String
    JSON map of HTTP headers
    method String
    HTTP method. Value must be one of GET, POST, PUT, DELETE, OPTIONS.
    params String
    JSON map of HTTP query parameters
    postToIncidentTimeline Boolean
    Value must be one of true or false
    postToSlackChannels List<Property Map>
    taskType String

    WorkflowTaskHTTPClientTaskParamsPostToSlackChannel, WorkflowTaskHTTPClientTaskParamsPostToSlackChannelArgs

    Id string
    Name string
    Id string
    Name string
    id String
    name String
    id string
    name string
    id str
    name str
    id String
    name String

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
    rootlyhq/pulumi-rootly