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

rootly.WorkflowTaskGetGithubCommits

Explore with Pulumi AI

Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-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 This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskGetGithubCommitsArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskGetGithubCommitsArgs
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. WorkflowTaskGetGithubCommitsArgs
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. WorkflowTaskGetGithubCommitsArgs
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 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,
});
Copy
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),
})
Copy
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());
Copy
workflow_task_get_github_commits_resource = rootly.WorkflowTaskGetGithubCommits("workflowTaskGetGithubCommitsResource",
    task_params={
        "branch": "string",
        "past_duration": "string",
        "github_repository_names": ["string"],
        "post_to_incident_timeline": False,
        "post_to_slack_channels": [{
            "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)
Copy
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,
});
Copy
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
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkflowTaskGetGithubCommits resource accepts the following input properties:

TaskParams This property is required. WorkflowTaskGetGithubCommitsTaskParams
The parameters for this workflow task.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetGithubCommitsTaskParamsArgs
The parameters for this workflow task.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetGithubCommitsTaskParams
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetGithubCommitsTaskParams
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetGithubCommitsTaskParamsArgs
The parameters for this workflow task.
workflow_id
This property is required.
Changes to this property will trigger replacement.
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 This property is required. Property Map
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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)
resources:  _:    type: rootly:WorkflowTaskGetGithubCommits    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:
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The ID of the parent workflow

Supporting Types

WorkflowTaskGetGithubCommitsTaskParams
, WorkflowTaskGetGithubCommitsTaskParamsArgs

Branch This property is required. string
The branch
PastDuration This property is required. 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 This property is required. string
The branch
PastDuration This property is required. 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 This property is required. String
The branch
pastDuration This property is required. 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 This property is required. string
The branch
pastDuration This property is required. 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 This property is required. str
The branch
past_duration This property is required. 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 This property is required. String
The branch
pastDuration This property is required. 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 This property is required. string
Name This property is required. string
Id This property is required. string
Name This property is required. string
id This property is required. String
name This property is required. String
id This property is required. string
name This property is required. string
id This property is required. str
name This property is required. str
id This property is required. String
name This property is required. String

Package Details

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