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

rootly.WorkflowTaskUpdateShortcutStory

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

    Manages workflow update_shortcut_story task.

    Create WorkflowTaskUpdateShortcutStory Resource

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

    Constructor syntax

    new WorkflowTaskUpdateShortcutStory(name: string, args: WorkflowTaskUpdateShortcutStoryArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskUpdateShortcutStory(resource_name: str,
                                        args: WorkflowTaskUpdateShortcutStoryArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskUpdateShortcutStory(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        task_params: Optional[WorkflowTaskUpdateShortcutStoryTaskParamsArgs] = 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 NewWorkflowTaskUpdateShortcutStory(ctx *Context, name string, args WorkflowTaskUpdateShortcutStoryArgs, opts ...ResourceOption) (*WorkflowTaskUpdateShortcutStory, error)
    public WorkflowTaskUpdateShortcutStory(string name, WorkflowTaskUpdateShortcutStoryArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskUpdateShortcutStory(String name, WorkflowTaskUpdateShortcutStoryArgs args)
    public WorkflowTaskUpdateShortcutStory(String name, WorkflowTaskUpdateShortcutStoryArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskUpdateShortcutStory
    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 WorkflowTaskUpdateShortcutStoryArgs
    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 WorkflowTaskUpdateShortcutStoryArgs
    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 WorkflowTaskUpdateShortcutStoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskUpdateShortcutStoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskUpdateShortcutStoryArgs
    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 workflowTaskUpdateShortcutStoryResource = new Rootly.WorkflowTaskUpdateShortcutStory("workflowTaskUpdateShortcutStoryResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskUpdateShortcutStoryTaskParamsArgs
        {
            Archivation = 
            {
                { "string", "any" },
            },
            StoryId = "string",
            Description = "string",
            DueDate = "string",
            Labels = "string",
            TaskType = "string",
            Title = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskUpdateShortcutStory(ctx, "workflowTaskUpdateShortcutStoryResource", &rootly.WorkflowTaskUpdateShortcutStoryArgs{
    	TaskParams: &rootly.WorkflowTaskUpdateShortcutStoryTaskParamsArgs{
    		Archivation: pulumi.Map{
    			"string": pulumi.Any("any"),
    		},
    		StoryId:     pulumi.String("string"),
    		Description: pulumi.String("string"),
    		DueDate:     pulumi.String("string"),
    		Labels:      pulumi.String("string"),
    		TaskType:    pulumi.String("string"),
    		Title:       pulumi.String("string"),
    	},
    	WorkflowId:    pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	Position:      pulumi.Int(0),
    	SkipOnFailure: pulumi.Bool(false),
    })
    
    var workflowTaskUpdateShortcutStoryResource = new WorkflowTaskUpdateShortcutStory("workflowTaskUpdateShortcutStoryResource", WorkflowTaskUpdateShortcutStoryArgs.builder()
        .taskParams(WorkflowTaskUpdateShortcutStoryTaskParamsArgs.builder()
            .archivation(Map.of("string", "any"))
            .storyId("string")
            .description("string")
            .dueDate("string")
            .labels("string")
            .taskType("string")
            .title("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_update_shortcut_story_resource = rootly.WorkflowTaskUpdateShortcutStory("workflowTaskUpdateShortcutStoryResource",
        task_params={
            "archivation": {
                "string": "any",
            },
            "story_id": "string",
            "description": "string",
            "due_date": "string",
            "labels": "string",
            "task_type": "string",
            "title": "string",
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskUpdateShortcutStoryResource = new rootly.WorkflowTaskUpdateShortcutStory("workflowTaskUpdateShortcutStoryResource", {
        taskParams: {
            archivation: {
                string: "any",
            },
            storyId: "string",
            description: "string",
            dueDate: "string",
            labels: "string",
            taskType: "string",
            title: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskUpdateShortcutStory
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            archivation:
                string: any
            description: string
            dueDate: string
            labels: string
            storyId: string
            taskType: string
            title: string
        workflowId: string
    

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

    TaskParams WorkflowTaskUpdateShortcutStoryTaskParams
    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 WorkflowTaskUpdateShortcutStoryTaskParamsArgs
    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 WorkflowTaskUpdateShortcutStoryTaskParams
    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 WorkflowTaskUpdateShortcutStoryTaskParams
    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 WorkflowTaskUpdateShortcutStoryTaskParamsArgs
    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 WorkflowTaskUpdateShortcutStory 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 WorkflowTaskUpdateShortcutStory Resource

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

    WorkflowTaskUpdateShortcutStoryTaskParams, WorkflowTaskUpdateShortcutStoryTaskParamsArgs

    Archivation Dictionary<string, object>
    Map must contain two fields, id and name. The archivation id and display name
    StoryId string
    The story id
    Description string
    The incident description
    DueDate string
    The due date
    Labels string
    The story labels
    TaskType string
    Title string
    The incident title
    Archivation map[string]interface{}
    Map must contain two fields, id and name. The archivation id and display name
    StoryId string
    The story id
    Description string
    The incident description
    DueDate string
    The due date
    Labels string
    The story labels
    TaskType string
    Title string
    The incident title
    archivation Map<String,Object>
    Map must contain two fields, id and name. The archivation id and display name
    storyId String
    The story id
    description String
    The incident description
    dueDate String
    The due date
    labels String
    The story labels
    taskType String
    title String
    The incident title
    archivation {[key: string]: any}
    Map must contain two fields, id and name. The archivation id and display name
    storyId string
    The story id
    description string
    The incident description
    dueDate string
    The due date
    labels string
    The story labels
    taskType string
    title string
    The incident title
    archivation Mapping[str, Any]
    Map must contain two fields, id and name. The archivation id and display name
    story_id str
    The story id
    description str
    The incident description
    due_date str
    The due date
    labels str
    The story labels
    task_type str
    title str
    The incident title
    archivation Map<Any>
    Map must contain two fields, id and name. The archivation id and display name
    storyId String
    The story id
    description String
    The incident description
    dueDate String
    The due date
    labels String
    The story labels
    taskType String
    title String
    The incident title

    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