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

rootly.WorkflowTaskGetGithubCommits

Explore with Pulumi AI

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

    Manages workflow get_github_commits task.

    Create WorkflowTaskGetGithubCommits Resource

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

    Constructor syntax

    new WorkflowTaskGetGithubCommits(name: string, args: WorkflowTaskGetGithubCommitsArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskGetGithubCommits(resource_name: str,
                                     args: WorkflowTaskGetGithubCommitsArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskGetGithubCommits(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     task_params: Optional[WorkflowTaskGetGithubCommitsTaskParamsArgs] = 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 NewWorkflowTaskGetGithubCommits(ctx *Context, name string, args WorkflowTaskGetGithubCommitsArgs, opts ...ResourceOption) (*WorkflowTaskGetGithubCommits, error)
    public WorkflowTaskGetGithubCommits(string name, WorkflowTaskGetGithubCommitsArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskGetGithubCommits(String name, WorkflowTaskGetGithubCommitsArgs args)
    public WorkflowTaskGetGithubCommits(String name, WorkflowTaskGetGithubCommitsArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskGetGithubCommits
    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 WorkflowTaskGetGithubCommitsArgs
    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 WorkflowTaskGetGithubCommitsArgs
    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 WorkflowTaskGetGithubCommitsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskGetGithubCommitsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskGetGithubCommitsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var workflowTaskGetGithubCommitsResource = new Rootly.WorkflowTaskGetGithubCommits("workflowTaskGetGithubCommitsResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskGetGithubCommitsTaskParamsArgs
        {
            Branch = "string",
            PastDuration = "string",
            GithubRepositoryNames = new[]
            {
                "string",
            },
            PostToIncidentTimeline = false,
            PostToSlackChannels = new[]
            {
                new Rootly.Inputs.WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannelArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            ServiceIds = new[]
            {
                "string",
            },
            ServicesImpactedByIncident = false,
            TaskType = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskGetGithubCommits(ctx, "workflowTaskGetGithubCommitsResource", &rootly.WorkflowTaskGetGithubCommitsArgs{
    	TaskParams: &rootly.WorkflowTaskGetGithubCommitsTaskParamsArgs{
    		Branch:       pulumi.String("string"),
    		PastDuration: pulumi.String("string"),
    		GithubRepositoryNames: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PostToIncidentTimeline: pulumi.Bool(false),
    		PostToSlackChannels: rootly.WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannelArray{
    			&rootly.WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannelArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		ServiceIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		ServicesImpactedByIncident: pulumi.Bool(false),
    		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 workflowTaskGetGithubCommitsResource = new WorkflowTaskGetGithubCommits("workflowTaskGetGithubCommitsResource", WorkflowTaskGetGithubCommitsArgs.builder()
        .taskParams(WorkflowTaskGetGithubCommitsTaskParamsArgs.builder()
            .branch("string")
            .pastDuration("string")
            .githubRepositoryNames("string")
            .postToIncidentTimeline(false)
            .postToSlackChannels(WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannelArgs.builder()
                .id("string")
                .name("string")
                .build())
            .serviceIds("string")
            .servicesImpactedByIncident(false)
            .taskType("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_get_github_commits_resource = rootly.WorkflowTaskGetGithubCommits("workflowTaskGetGithubCommitsResource",
        task_params=rootly.WorkflowTaskGetGithubCommitsTaskParamsArgs(
            branch="string",
            past_duration="string",
            github_repository_names=["string"],
            post_to_incident_timeline=False,
            post_to_slack_channels=[rootly.WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannelArgs(
                id="string",
                name="string",
            )],
            service_ids=["string"],
            services_impacted_by_incident=False,
            task_type="string",
        ),
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskGetGithubCommitsResource = new rootly.WorkflowTaskGetGithubCommits("workflowTaskGetGithubCommitsResource", {
        taskParams: {
            branch: "string",
            pastDuration: "string",
            githubRepositoryNames: ["string"],
            postToIncidentTimeline: false,
            postToSlackChannels: [{
                id: "string",
                name: "string",
            }],
            serviceIds: ["string"],
            servicesImpactedByIncident: false,
            taskType: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskGetGithubCommits
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            branch: string
            githubRepositoryNames:
                - string
            pastDuration: string
            postToIncidentTimeline: false
            postToSlackChannels:
                - id: string
                  name: string
            serviceIds:
                - string
            servicesImpactedByIncident: false
            taskType: string
        workflowId: string
    

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

    TaskParams WorkflowTaskGetGithubCommitsTaskParams
    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 WorkflowTaskGetGithubCommitsTaskParamsArgs
    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 WorkflowTaskGetGithubCommitsTaskParams
    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 WorkflowTaskGetGithubCommitsTaskParams
    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 WorkflowTaskGetGithubCommitsTaskParamsArgs
    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 WorkflowTaskGetGithubCommits 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 WorkflowTaskGetGithubCommits Resource

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

    WorkflowTaskGetGithubCommitsTaskParams, WorkflowTaskGetGithubCommitsTaskParamsArgs

    Branch string
    The branch
    PastDuration string
    How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
    GithubRepositoryNames List<string>
    PostToIncidentTimeline bool
    Value must be one of true or false
    PostToSlackChannels List<WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannel>
    ServiceIds List<string>
    ServicesImpactedByIncident bool
    Value must be one of true or false
    TaskType string
    Branch string
    The branch
    PastDuration string
    How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
    GithubRepositoryNames []string
    PostToIncidentTimeline bool
    Value must be one of true or false
    PostToSlackChannels []WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannel
    ServiceIds []string
    ServicesImpactedByIncident bool
    Value must be one of true or false
    TaskType string
    branch String
    The branch
    pastDuration String
    How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
    githubRepositoryNames List<String>
    postToIncidentTimeline Boolean
    Value must be one of true or false
    postToSlackChannels List<WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannel>
    serviceIds List<String>
    servicesImpactedByIncident Boolean
    Value must be one of true or false
    taskType String
    branch string
    The branch
    pastDuration string
    How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
    githubRepositoryNames string[]
    postToIncidentTimeline boolean
    Value must be one of true or false
    postToSlackChannels WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannel[]
    serviceIds string[]
    servicesImpactedByIncident boolean
    Value must be one of true or false
    taskType string
    branch str
    The branch
    past_duration str
    How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
    github_repository_names Sequence[str]
    post_to_incident_timeline bool
    Value must be one of true or false
    post_to_slack_channels Sequence[WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannel]
    service_ids Sequence[str]
    services_impacted_by_incident bool
    Value must be one of true or false
    task_type str
    branch String
    The branch
    pastDuration String
    How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
    githubRepositoryNames List<String>
    postToIncidentTimeline Boolean
    Value must be one of true or false
    postToSlackChannels List<Property Map>
    serviceIds List<String>
    servicesImpactedByIncident Boolean
    Value must be one of true or false
    taskType String

    WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannel, WorkflowTaskGetGithubCommitsTaskParamsPostToSlackChannelArgs

    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