Grafana v2.12.0, Oct 17 25

Grafana v2.12.0 published on Friday, Oct 17, 2025 by pulumiverse

grafana.k6.getSchedule

Grafana v2.12.0 published on Friday, Oct 17, 2025 by pulumiverse

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  scheduleProject:
    type: grafana:k6:Project
    name: schedule_project
    properties:
      name: Terraform Schedule Test Project
  scheduleLoadTest:
    type: grafana:k6:LoadTest
    name: schedule_load_test
    properties:
      projectId: ${scheduleProject.id}
      name: Terraform Test Load Test for Schedule
      script: |
        export default function() {
          console.log('Hello from k6 schedule test!');
        }        
    options:
      dependsOn:
        - ${scheduleProject}
  testSchedule:
    type: grafana:k6:Schedule
    name: test_schedule
    properties:
      loadTestId: ${scheduleLoadTest.id}
      starts: 2024-12-25T10:00:00Z
      recurrenceRule:
        - frequency: MONTHLY
          interval: 12
          count: 100
    options:
      dependsOn:
        - ${scheduleLoadTest}
variables:
  fromLoadTest:
    fn::invoke:
      function: grafana:k6:getSchedule
      arguments:
        loadTestId: ${scheduleLoadTest.id}
outputs:
  completeScheduleInfo:
    id: ${fromLoadTest.id}
    loadTestId: ${fromLoadTest.loadTestId}
    starts: ${fromLoadTest.starts}
    deactivated: ${fromLoadTest.deactivated}
    nextRun: ${fromLoadTest.nextRun}
    createdBy: ${fromLoadTest.createdBy}
    recurrenceRule: ${fromLoadTest.recurrenceRule}

Using getSchedule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOptions): Output<GetScheduleResult>

def get_schedule(load_test_id: Optional[str] = None,
                 recurrence_rule: Optional[GetScheduleRecurrenceRule] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(load_test_id: Optional[pulumi.Input[str]] = None,
                 recurrence_rule: Optional[pulumi.Input[GetScheduleRecurrenceRuleArgs]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetScheduleResult]

func LookupSchedule(ctx *Context, args *LookupScheduleArgs, opts ...InvokeOption) (*LookupScheduleResult, error)
func LookupScheduleOutput(ctx *Context, args *LookupScheduleOutputArgs, opts ...InvokeOption) LookupScheduleResultOutput

> Note: This function is named LookupSchedule in the Go SDK.

public static class GetSchedule 
{
    public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
public static Output<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)

fn::invoke:
  function: grafana:k6/getSchedule:getSchedule
  arguments:
    # arguments dictionary

The following arguments are supported:

LoadTestId string: The identifier of the load test to retrieve the schedule for.
RecurrenceRule Pulumiverse.Grafana.K6.Inputs.GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

LoadTestId string: The identifier of the load test to retrieve the schedule for.
RecurrenceRule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

loadTestId String: The identifier of the load test to retrieve the schedule for.
recurrenceRule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

loadTestId string: The identifier of the load test to retrieve the schedule for.
recurrenceRule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

load_test_id str: The identifier of the load test to retrieve the schedule for.
recurrence_rule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

loadTestId String: The identifier of the load test to retrieve the schedule for.
recurrenceRule Property Map: The schedule recurrence settings. If null, the test will run only once on the starts date.

getSchedule Result

The following output properties are available:

CreatedBy string: The email of the user who created the schedule.
Deactivated bool: Whether the schedule is deactivated.
Id string: Numeric identifier of the schedule.
LoadTestId string: The identifier of the load test to retrieve the schedule for.
NextRun string: The next scheduled execution time.
Starts string: The start time for the schedule (RFC3339 format).
RecurrenceRule Pulumiverse.Grafana.K6.Outputs.GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

CreatedBy string: The email of the user who created the schedule.
Deactivated bool: Whether the schedule is deactivated.
Id string: Numeric identifier of the schedule.
LoadTestId string: The identifier of the load test to retrieve the schedule for.
NextRun string: The next scheduled execution time.
Starts string: The start time for the schedule (RFC3339 format).
RecurrenceRule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

createdBy String: The email of the user who created the schedule.
deactivated Boolean: Whether the schedule is deactivated.
id String: Numeric identifier of the schedule.
loadTestId String: The identifier of the load test to retrieve the schedule for.
nextRun String: The next scheduled execution time.
starts String: The start time for the schedule (RFC3339 format).
recurrenceRule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

createdBy string: The email of the user who created the schedule.
deactivated boolean: Whether the schedule is deactivated.
id string: Numeric identifier of the schedule.
loadTestId string: The identifier of the load test to retrieve the schedule for.
nextRun string: The next scheduled execution time.
starts string: The start time for the schedule (RFC3339 format).
recurrenceRule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

created_by str: The email of the user who created the schedule.
deactivated bool: Whether the schedule is deactivated.
id str: Numeric identifier of the schedule.
load_test_id str: The identifier of the load test to retrieve the schedule for.
next_run str: The next scheduled execution time.
starts str: The start time for the schedule (RFC3339 format).
recurrence_rule GetScheduleRecurrenceRule: The schedule recurrence settings. If null, the test will run only once on the starts date.

createdBy String: The email of the user who created the schedule.
deactivated Boolean: Whether the schedule is deactivated.
id String: Numeric identifier of the schedule.
loadTestId String: The identifier of the load test to retrieve the schedule for.
nextRun String: The next scheduled execution time.
starts String: The start time for the schedule (RFC3339 format).
recurrenceRule Property Map: The schedule recurrence settings. If null, the test will run only once on the starts date.

Supporting Types

GetScheduleRecurrenceRule

Bydays List<string>: The weekdays when the 'WEEKLY' recurrence will be applied (e.g., ['MO', 'WE', 'FR']). Cannot be set for other frequencies.
Count int: How many times the recurrence will repeat.
Frequency string: The frequency of the schedule (HOURLY, DAILY, WEEKLY, MONTHLY).
Interval int: The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY).
Until string: The end time for the recurrence (RFC3339 format).

Bydays []string: The weekdays when the 'WEEKLY' recurrence will be applied (e.g., ['MO', 'WE', 'FR']). Cannot be set for other frequencies.
Count int: How many times the recurrence will repeat.
Frequency string: The frequency of the schedule (HOURLY, DAILY, WEEKLY, MONTHLY).
Interval int: The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY).
Until string: The end time for the recurrence (RFC3339 format).

bydays List<String>: The weekdays when the 'WEEKLY' recurrence will be applied (e.g., ['MO', 'WE', 'FR']). Cannot be set for other frequencies.
count Integer: How many times the recurrence will repeat.
frequency String: The frequency of the schedule (HOURLY, DAILY, WEEKLY, MONTHLY).
interval Integer: The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY).
until String: The end time for the recurrence (RFC3339 format).

bydays string[]: The weekdays when the 'WEEKLY' recurrence will be applied (e.g., ['MO', 'WE', 'FR']). Cannot be set for other frequencies.
count number: How many times the recurrence will repeat.
frequency string: The frequency of the schedule (HOURLY, DAILY, WEEKLY, MONTHLY).
interval number: The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY).
until string: The end time for the recurrence (RFC3339 format).

bydays Sequence[str]: The weekdays when the 'WEEKLY' recurrence will be applied (e.g., ['MO', 'WE', 'FR']). Cannot be set for other frequencies.
count int: How many times the recurrence will repeat.
frequency str: The frequency of the schedule (HOURLY, DAILY, WEEKLY, MONTHLY).
interval int: The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY).
until str: The end time for the recurrence (RFC3339 format).

bydays List<String>: The weekdays when the 'WEEKLY' recurrence will be applied (e.g., ['MO', 'WE', 'FR']). Cannot be set for other frequencies.
count Number: How many times the recurrence will repeat.
frequency String: The frequency of the schedule (HOURLY, DAILY, WEEKLY, MONTHLY).
interval Number: The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY).
until String: The end time for the recurrence (RFC3339 format).

Package Details

Repository: grafana pulumiverse/pulumi-grafana
License: Apache-2.0
Notes: This Pulumi package is based on the grafana Terraform Provider.

Grafana v2.12.0 published on Friday, Oct 17, 2025 by pulumiverse

pulumiverse/pulumi-grafana

grafana.k6.getSchedule

On this page

On this page

Example Usage

Using getSchedule

getSchedule Result

Supporting Types

GetScheduleRecurrenceRule

Package Details

On this page

On this page