Docs Packages
  1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowTaskRedisClient
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.WorkflowTaskRedisClient

Explore with Pulumi AI

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

    Manages workflow redis_client task.

    Create WorkflowTaskRedisClient Resource

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

    Constructor syntax

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

@overload
def WorkflowTaskRedisClient(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            task_params: Optional[WorkflowTaskRedisClientTaskParamsArgs] = 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 NewWorkflowTaskRedisClient(ctx *Context, name string, args WorkflowTaskRedisClientArgs, opts ...ResourceOption) (*WorkflowTaskRedisClient, error)
    public WorkflowTaskRedisClient(string name, WorkflowTaskRedisClientArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskRedisClient(String name, WorkflowTaskRedisClientArgs args)
public WorkflowTaskRedisClient(String name, WorkflowTaskRedisClientArgs args, CustomResourceOptions options)

    type: rootly:WorkflowTaskRedisClient
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 WorkflowTaskRedisClientArgs
    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 WorkflowTaskRedisClientArgs
    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 WorkflowTaskRedisClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskRedisClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskRedisClientArgs
    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 workflowTaskRedisClientResource = new Rootly.WorkflowTaskRedisClient("workflowTaskRedisClientResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskRedisClientTaskParamsArgs
    {
        Commands = "string",
        Url = "string",
        EventMessage = "string",
        EventUrl = "string",
        PostToIncidentTimeline = false,
        PostToSlackChannels = new[]
        {
            new Rootly.Inputs.WorkflowTaskRedisClientTaskParamsPostToSlackChannelArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskRedisClient(ctx, "workflowTaskRedisClientResource", &rootly.WorkflowTaskRedisClientArgs{
	TaskParams: &rootly.WorkflowTaskRedisClientTaskParamsArgs{
		Commands:               pulumi.String("string"),
		Url:                    pulumi.String("string"),
		EventMessage:           pulumi.String("string"),
		EventUrl:               pulumi.String("string"),
		PostToIncidentTimeline: pulumi.Bool(false),
		PostToSlackChannels: rootly.WorkflowTaskRedisClientTaskParamsPostToSlackChannelArray{
			&rootly.WorkflowTaskRedisClientTaskParamsPostToSlackChannelArgs{
				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 workflowTaskRedisClientResource = new WorkflowTaskRedisClient("workflowTaskRedisClientResource", WorkflowTaskRedisClientArgs.builder()
    .taskParams(WorkflowTaskRedisClientTaskParamsArgs.builder()
        .commands("string")
        .url("string")
        .eventMessage("string")
        .eventUrl("string")
        .postToIncidentTimeline(false)
        .postToSlackChannels(WorkflowTaskRedisClientTaskParamsPostToSlackChannelArgs.builder()
            .id("string")
            .name("string")
            .build())
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_redis_client_resource = rootly.WorkflowTaskRedisClient("workflowTaskRedisClientResource",
    task_params=rootly.WorkflowTaskRedisClientTaskParamsArgs(
        commands="string",
        url="string",
        event_message="string",
        event_url="string",
        post_to_incident_timeline=False,
        post_to_slack_channels=[rootly.WorkflowTaskRedisClientTaskParamsPostToSlackChannelArgs(
            id="string",
            name="string",
        )],
        task_type="string",
    ),
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskRedisClientResource = new rootly.WorkflowTaskRedisClient("workflowTaskRedisClientResource", {
    taskParams: {
        commands: "string",
        url: "string",
        eventMessage: "string",
        eventUrl: "string",
        postToIncidentTimeline: false,
        postToSlackChannels: [{
            id: "string",
            name: "string",
        }],
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskRedisClient
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        commands: string
        eventMessage: string
        eventUrl: string
        postToIncidentTimeline: false
        postToSlackChannels:
            - id: string
              name: string
        taskType: string
        url: string
    workflowId: string

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

    TaskParams WorkflowTaskRedisClientTaskParams
    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 WorkflowTaskRedisClientTaskParamsArgs
    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 WorkflowTaskRedisClientTaskParams
    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 WorkflowTaskRedisClientTaskParams
    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 WorkflowTaskRedisClientTaskParamsArgs
    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 WorkflowTaskRedisClient 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 WorkflowTaskRedisClient Resource

    Get an existing WorkflowTaskRedisClient 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?: WorkflowTaskRedisClientState, opts?: CustomResourceOptions): WorkflowTaskRedisClient
    @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[WorkflowTaskRedisClientTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskRedisClient
    func GetWorkflowTaskRedisClient(ctx *Context, name string, id IDInput, state *WorkflowTaskRedisClientState, opts ...ResourceOption) (*WorkflowTaskRedisClient, error)
    public static WorkflowTaskRedisClient Get(string name, Input<string> id, WorkflowTaskRedisClientState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskRedisClient get(String name, Output<String> id, WorkflowTaskRedisClientState 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 WorkflowTaskRedisClientTaskParams
    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 WorkflowTaskRedisClientTaskParamsArgs
    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 WorkflowTaskRedisClientTaskParams
    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 WorkflowTaskRedisClientTaskParams
    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 WorkflowTaskRedisClientTaskParamsArgs
    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

    WorkflowTaskRedisClientTaskParams, WorkflowTaskRedisClientTaskParamsArgs

    commands String
    url String
    eventMessage String
    eventUrl String
    postToIncidentTimeline Boolean
    Value must be one of true or false
    postToSlackChannels List<Property Map>
    taskType String

    WorkflowTaskRedisClientTaskParamsPostToSlackChannel, WorkflowTaskRedisClientTaskParamsPostToSlackChannelArgs

    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