1. Packages
  2. Grafana Cloud
  3. API Docs
  4. k6
  5. Schedule
Grafana v2.14.1 published on Thursday, Nov 6, 2025 by pulumiverse

grafana.k6.Schedule

Get Started
grafana logo
Grafana v2.14.1 published on Thursday, Nov 6, 2025 by pulumiverse

    Manages a k6 schedule for automated test execution.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as grafana from "@pulumiverse/grafana";
    
    const scheduleProject = new grafana.k6.Project("schedule_project", {name: "Terraform Schedule Resource Project"});
    const scheduledTest = new grafana.k6.LoadTest("scheduled_test", {
        projectId: scheduleProject.id,
        name: "Terraform Scheduled Resource Test",
        script: `export default function() {
      console.log('Hello from scheduled k6 test!');
    }
    `,
    }, {
        dependsOn: [scheduleProject],
    });
    const cronMonthly = new grafana.k6.Schedule("cron_monthly", {
        loadTestId: scheduledTest.id,
        starts: "2024-12-25T10:00:00Z",
        cron: {
            schedule: "0 10 1 * *",
            timezone: "UTC",
        },
    });
    const daily = new grafana.k6.Schedule("daily", {
        loadTestId: scheduledTest.id,
        starts: "2024-12-25T10:00:00Z",
        recurrenceRule: {
            frequency: "DAILY",
            interval: 1,
        },
    });
    const weekly = new grafana.k6.Schedule("weekly", {
        loadTestId: scheduledTest.id,
        starts: "2024-12-25T09:00:00Z",
        recurrenceRule: {
            frequency: "WEEKLY",
            interval: 1,
            bydays: [
                "MO",
                "WE",
                "FR",
            ],
        },
    });
    // Example with YEARLY frequency and count
    const yearly = new grafana.k6.Schedule("yearly", {
        loadTestId: scheduledTest.id,
        starts: "2024-01-01T12:00:00Z",
        recurrenceRule: {
            frequency: "YEARLY",
            interval: 1,
            count: 5,
        },
    });
    // One-time schedule without recurrence
    const oneTime = new grafana.k6.Schedule("one_time", {
        loadTestId: scheduledTest.id,
        starts: "2024-12-25T15:00:00Z",
    });
    
    import pulumi
    import pulumiverse_grafana as grafana
    
    schedule_project = grafana.k6.Project("schedule_project", name="Terraform Schedule Resource Project")
    scheduled_test = grafana.k6.LoadTest("scheduled_test",
        project_id=schedule_project.id,
        name="Terraform Scheduled Resource Test",
        script="""export default function() {
      console.log('Hello from scheduled k6 test!');
    }
    """,
        opts = pulumi.ResourceOptions(depends_on=[schedule_project]))
    cron_monthly = grafana.k6.Schedule("cron_monthly",
        load_test_id=scheduled_test.id,
        starts="2024-12-25T10:00:00Z",
        cron={
            "schedule": "0 10 1 * *",
            "timezone": "UTC",
        })
    daily = grafana.k6.Schedule("daily",
        load_test_id=scheduled_test.id,
        starts="2024-12-25T10:00:00Z",
        recurrence_rule={
            "frequency": "DAILY",
            "interval": 1,
        })
    weekly = grafana.k6.Schedule("weekly",
        load_test_id=scheduled_test.id,
        starts="2024-12-25T09:00:00Z",
        recurrence_rule={
            "frequency": "WEEKLY",
            "interval": 1,
            "bydays": [
                "MO",
                "WE",
                "FR",
            ],
        })
    # Example with YEARLY frequency and count
    yearly = grafana.k6.Schedule("yearly",
        load_test_id=scheduled_test.id,
        starts="2024-01-01T12:00:00Z",
        recurrence_rule={
            "frequency": "YEARLY",
            "interval": 1,
            "count": 5,
        })
    # One-time schedule without recurrence
    one_time = grafana.k6.Schedule("one_time",
        load_test_id=scheduled_test.id,
        starts="2024-12-25T15:00:00Z")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-grafana/sdk/v2/go/grafana/k6"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		scheduleProject, err := k6.NewProject(ctx, "schedule_project", &k6.ProjectArgs{
    			Name: pulumi.String("Terraform Schedule Resource Project"),
    		})
    		if err != nil {
    			return err
    		}
    		scheduledTest, err := k6.NewLoadTest(ctx, "scheduled_test", &k6.LoadTestArgs{
    			ProjectId: scheduleProject.ID(),
    			Name:      pulumi.String("Terraform Scheduled Resource Test"),
    			Script:    pulumi.String("export default function() {\n  console.log('Hello from scheduled k6 test!');\n}\n"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			scheduleProject,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = k6.NewSchedule(ctx, "cron_monthly", &k6.ScheduleArgs{
    			LoadTestId: scheduledTest.ID(),
    			Starts:     pulumi.String("2024-12-25T10:00:00Z"),
    			Cron: &k6.ScheduleCronArgs{
    				Schedule: pulumi.String("0 10 1 * *"),
    				Timezone: pulumi.String("UTC"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = k6.NewSchedule(ctx, "daily", &k6.ScheduleArgs{
    			LoadTestId: scheduledTest.ID(),
    			Starts:     pulumi.String("2024-12-25T10:00:00Z"),
    			RecurrenceRule: &k6.ScheduleRecurrenceRuleArgs{
    				Frequency: pulumi.String("DAILY"),
    				Interval:  pulumi.Int(1),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = k6.NewSchedule(ctx, "weekly", &k6.ScheduleArgs{
    			LoadTestId: scheduledTest.ID(),
    			Starts:     pulumi.String("2024-12-25T09:00:00Z"),
    			RecurrenceRule: &k6.ScheduleRecurrenceRuleArgs{
    				Frequency: pulumi.String("WEEKLY"),
    				Interval:  pulumi.Int(1),
    				Bydays: pulumi.StringArray{
    					pulumi.String("MO"),
    					pulumi.String("WE"),
    					pulumi.String("FR"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		// Example with YEARLY frequency and count
    		_, err = k6.NewSchedule(ctx, "yearly", &k6.ScheduleArgs{
    			LoadTestId: scheduledTest.ID(),
    			Starts:     pulumi.String("2024-01-01T12:00:00Z"),
    			RecurrenceRule: &k6.ScheduleRecurrenceRuleArgs{
    				Frequency: pulumi.String("YEARLY"),
    				Interval:  pulumi.Int(1),
    				Count:     pulumi.Int(5),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		// One-time schedule without recurrence
    		_, err = k6.NewSchedule(ctx, "one_time", &k6.ScheduleArgs{
    			LoadTestId: scheduledTest.ID(),
    			Starts:     pulumi.String("2024-12-25T15:00:00Z"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Grafana = Pulumiverse.Grafana;
    
    return await Deployment.RunAsync(() => 
    {
        var scheduleProject = new Grafana.K6.Project("schedule_project", new()
        {
            Name = "Terraform Schedule Resource Project",
        });
    
        var scheduledTest = new Grafana.K6.LoadTest("scheduled_test", new()
        {
            ProjectId = scheduleProject.Id,
            Name = "Terraform Scheduled Resource Test",
            Script = @"export default function() {
      console.log('Hello from scheduled k6 test!');
    }
    ",
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                scheduleProject,
            },
        });
    
        var cronMonthly = new Grafana.K6.Schedule("cron_monthly", new()
        {
            LoadTestId = scheduledTest.Id,
            Starts = "2024-12-25T10:00:00Z",
            Cron = new Grafana.K6.Inputs.ScheduleCronArgs
            {
                Schedule = "0 10 1 * *",
                Timezone = "UTC",
            },
        });
    
        var daily = new Grafana.K6.Schedule("daily", new()
        {
            LoadTestId = scheduledTest.Id,
            Starts = "2024-12-25T10:00:00Z",
            RecurrenceRule = new Grafana.K6.Inputs.ScheduleRecurrenceRuleArgs
            {
                Frequency = "DAILY",
                Interval = 1,
            },
        });
    
        var weekly = new Grafana.K6.Schedule("weekly", new()
        {
            LoadTestId = scheduledTest.Id,
            Starts = "2024-12-25T09:00:00Z",
            RecurrenceRule = new Grafana.K6.Inputs.ScheduleRecurrenceRuleArgs
            {
                Frequency = "WEEKLY",
                Interval = 1,
                Bydays = new[]
                {
                    "MO",
                    "WE",
                    "FR",
                },
            },
        });
    
        // Example with YEARLY frequency and count
        var yearly = new Grafana.K6.Schedule("yearly", new()
        {
            LoadTestId = scheduledTest.Id,
            Starts = "2024-01-01T12:00:00Z",
            RecurrenceRule = new Grafana.K6.Inputs.ScheduleRecurrenceRuleArgs
            {
                Frequency = "YEARLY",
                Interval = 1,
                Count = 5,
            },
        });
    
        // One-time schedule without recurrence
        var oneTime = new Grafana.K6.Schedule("one_time", new()
        {
            LoadTestId = scheduledTest.Id,
            Starts = "2024-12-25T15:00:00Z",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.grafana.k6.Project;
    import com.pulumi.grafana.k6.ProjectArgs;
    import com.pulumi.grafana.k6.LoadTest;
    import com.pulumi.grafana.k6.LoadTestArgs;
    import com.pulumi.grafana.k6.Schedule;
    import com.pulumi.grafana.k6.ScheduleArgs;
    import com.pulumi.grafana.k6.inputs.ScheduleCronArgs;
    import com.pulumi.grafana.k6.inputs.ScheduleRecurrenceRuleArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var scheduleProject = new Project("scheduleProject", ProjectArgs.builder()
                .name("Terraform Schedule Resource Project")
                .build());
    
            var scheduledTest = new LoadTest("scheduledTest", LoadTestArgs.builder()
                .projectId(scheduleProject.id())
                .name("Terraform Scheduled Resource Test")
                .script("""
    export default function() {
      console.log('Hello from scheduled k6 test!');
    }
                """)
                .build(), CustomResourceOptions.builder()
                    .dependsOn(scheduleProject)
                    .build());
    
            var cronMonthly = new Schedule("cronMonthly", ScheduleArgs.builder()
                .loadTestId(scheduledTest.id())
                .starts("2024-12-25T10:00:00Z")
                .cron(ScheduleCronArgs.builder()
                    .schedule("0 10 1 * *")
                    .timezone("UTC")
                    .build())
                .build());
    
            var daily = new Schedule("daily", ScheduleArgs.builder()
                .loadTestId(scheduledTest.id())
                .starts("2024-12-25T10:00:00Z")
                .recurrenceRule(ScheduleRecurrenceRuleArgs.builder()
                    .frequency("DAILY")
                    .interval(1)
                    .build())
                .build());
    
            var weekly = new Schedule("weekly", ScheduleArgs.builder()
                .loadTestId(scheduledTest.id())
                .starts("2024-12-25T09:00:00Z")
                .recurrenceRule(ScheduleRecurrenceRuleArgs.builder()
                    .frequency("WEEKLY")
                    .interval(1)
                    .bydays(                
                        "MO",
                        "WE",
                        "FR")
                    .build())
                .build());
    
            // Example with YEARLY frequency and count
            var yearly = new Schedule("yearly", ScheduleArgs.builder()
                .loadTestId(scheduledTest.id())
                .starts("2024-01-01T12:00:00Z")
                .recurrenceRule(ScheduleRecurrenceRuleArgs.builder()
                    .frequency("YEARLY")
                    .interval(1)
                    .count(5)
                    .build())
                .build());
    
            // One-time schedule without recurrence
            var oneTime = new Schedule("oneTime", ScheduleArgs.builder()
                .loadTestId(scheduledTest.id())
                .starts("2024-12-25T15:00:00Z")
                .build());
    
        }
    }
    
    resources:
      scheduleProject:
        type: grafana:k6:Project
        name: schedule_project
        properties:
          name: Terraform Schedule Resource Project
      scheduledTest:
        type: grafana:k6:LoadTest
        name: scheduled_test
        properties:
          projectId: ${scheduleProject.id}
          name: Terraform Scheduled Resource Test
          script: |
            export default function() {
              console.log('Hello from scheduled k6 test!');
            }        
        options:
          dependsOn:
            - ${scheduleProject}
      cronMonthly:
        type: grafana:k6:Schedule
        name: cron_monthly
        properties:
          loadTestId: ${scheduledTest.id}
          starts: 2024-12-25T10:00:00Z
          cron:
            schedule: 0 10 1 * *
            timezone: UTC
      daily:
        type: grafana:k6:Schedule
        properties:
          loadTestId: ${scheduledTest.id}
          starts: 2024-12-25T10:00:00Z
          recurrenceRule:
            frequency: DAILY
            interval: 1
      weekly:
        type: grafana:k6:Schedule
        properties:
          loadTestId: ${scheduledTest.id}
          starts: 2024-12-25T09:00:00Z
          recurrenceRule:
            frequency: WEEKLY
            interval: 1
            bydays:
              - MO
              - WE
              - FR
      # Example with YEARLY frequency and count
      yearly:
        type: grafana:k6:Schedule
        properties:
          loadTestId: ${scheduledTest.id}
          starts: 2024-01-01T12:00:00Z
          recurrenceRule:
            frequency: YEARLY
            interval: 1
            count: 5
      # One-time schedule without recurrence
      oneTime:
        type: grafana:k6:Schedule
        name: one_time
        properties:
          loadTestId: ${scheduledTest.id}
          starts: 2024-12-25T15:00:00Z
    

    Create Schedule Resource

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

    Constructor syntax

    new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def Schedule(resource_name: str,
                 args: ScheduleArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Schedule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 load_test_id: Optional[str] = None,
                 starts: Optional[str] = None,
                 cron: Optional[ScheduleCronArgs] = None,
                 recurrence_rule: Optional[ScheduleRecurrenceRuleArgs] = None)
    func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)
    public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)
    public Schedule(String name, ScheduleArgs args)
    public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)
    
    type: grafana:k6:Schedule
    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 ScheduleArgs
    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 ScheduleArgs
    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 ScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduleArgs
    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 scheduleResource = new Grafana.K6.Schedule("scheduleResource", new()
    {
        LoadTestId = "string",
        Starts = "string",
        Cron = new Grafana.K6.Inputs.ScheduleCronArgs
        {
            Schedule = "string",
            Timezone = "string",
        },
        RecurrenceRule = new Grafana.K6.Inputs.ScheduleRecurrenceRuleArgs
        {
            Bydays = new[]
            {
                "string",
            },
            Count = 0,
            Frequency = "string",
            Interval = 0,
            Until = "string",
        },
    });
    
    example, err := k6.NewSchedule(ctx, "scheduleResource", &k6.ScheduleArgs{
    	LoadTestId: pulumi.String("string"),
    	Starts:     pulumi.String("string"),
    	Cron: &k6.ScheduleCronArgs{
    		Schedule: pulumi.String("string"),
    		Timezone: pulumi.String("string"),
    	},
    	RecurrenceRule: &k6.ScheduleRecurrenceRuleArgs{
    		Bydays: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Count:     pulumi.Int(0),
    		Frequency: pulumi.String("string"),
    		Interval:  pulumi.Int(0),
    		Until:     pulumi.String("string"),
    	},
    })
    
    var scheduleResource = new com.pulumi.grafana.k6.Schedule("scheduleResource", com.pulumi.grafana.k6.ScheduleArgs.builder()
        .loadTestId("string")
        .starts("string")
        .cron(ScheduleCronArgs.builder()
            .schedule("string")
            .timezone("string")
            .build())
        .recurrenceRule(ScheduleRecurrenceRuleArgs.builder()
            .bydays("string")
            .count(0)
            .frequency("string")
            .interval(0)
            .until("string")
            .build())
        .build());
    
    schedule_resource = grafana.k6.Schedule("scheduleResource",
        load_test_id="string",
        starts="string",
        cron={
            "schedule": "string",
            "timezone": "string",
        },
        recurrence_rule={
            "bydays": ["string"],
            "count": 0,
            "frequency": "string",
            "interval": 0,
            "until": "string",
        })
    
    const scheduleResource = new grafana.k6.Schedule("scheduleResource", {
        loadTestId: "string",
        starts: "string",
        cron: {
            schedule: "string",
            timezone: "string",
        },
        recurrenceRule: {
            bydays: ["string"],
            count: 0,
            frequency: "string",
            interval: 0,
            until: "string",
        },
    });
    
    type: grafana:k6:Schedule
    properties:
        cron:
            schedule: string
            timezone: string
        loadTestId: string
        recurrenceRule:
            bydays:
                - string
            count: 0
            frequency: string
            interval: 0
            until: string
        starts: string
    

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

    LoadTestId string
    The identifier of the load test to schedule.
    Starts string
    The start time for the schedule (RFC3339 format).
    Cron Pulumiverse.Grafana.K6.Inputs.ScheduleCron
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    RecurrenceRule Pulumiverse.Grafana.K6.Inputs.ScheduleRecurrenceRule
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    LoadTestId string
    The identifier of the load test to schedule.
    Starts string
    The start time for the schedule (RFC3339 format).
    Cron ScheduleCronArgs
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    RecurrenceRule ScheduleRecurrenceRuleArgs
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    loadTestId String
    The identifier of the load test to schedule.
    starts String
    The start time for the schedule (RFC3339 format).
    cron ScheduleCron
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    recurrenceRule ScheduleRecurrenceRule
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    loadTestId string
    The identifier of the load test to schedule.
    starts string
    The start time for the schedule (RFC3339 format).
    cron ScheduleCron
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    recurrenceRule ScheduleRecurrenceRule
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    load_test_id str
    The identifier of the load test to schedule.
    starts str
    The start time for the schedule (RFC3339 format).
    cron ScheduleCronArgs
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    recurrence_rule ScheduleRecurrenceRuleArgs
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    loadTestId String
    The identifier of the load test to schedule.
    starts String
    The start time for the schedule (RFC3339 format).
    cron Property Map
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    recurrenceRule Property Map
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:

    CreatedBy string
    The email of the user who created the schedule.
    Deactivated bool
    Whether the schedule is deactivated.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextRun string
    The next scheduled execution time.
    CreatedBy string
    The email of the user who created the schedule.
    Deactivated bool
    Whether the schedule is deactivated.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextRun string
    The next scheduled execution time.
    createdBy String
    The email of the user who created the schedule.
    deactivated Boolean
    Whether the schedule is deactivated.
    id String
    The provider-assigned unique ID for this managed resource.
    nextRun String
    The next scheduled execution time.
    createdBy string
    The email of the user who created the schedule.
    deactivated boolean
    Whether the schedule is deactivated.
    id string
    The provider-assigned unique ID for this managed resource.
    nextRun string
    The next scheduled execution time.
    created_by str
    The email of the user who created the schedule.
    deactivated bool
    Whether the schedule is deactivated.
    id str
    The provider-assigned unique ID for this managed resource.
    next_run str
    The next scheduled execution time.
    createdBy String
    The email of the user who created the schedule.
    deactivated Boolean
    Whether the schedule is deactivated.
    id String
    The provider-assigned unique ID for this managed resource.
    nextRun String
    The next scheduled execution time.

    Look up Existing Schedule Resource

    Get an existing Schedule 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?: ScheduleState, opts?: CustomResourceOptions): Schedule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_by: Optional[str] = None,
            cron: Optional[ScheduleCronArgs] = None,
            deactivated: Optional[bool] = None,
            load_test_id: Optional[str] = None,
            next_run: Optional[str] = None,
            recurrence_rule: Optional[ScheduleRecurrenceRuleArgs] = None,
            starts: Optional[str] = None) -> Schedule
    func GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)
    public static Schedule Get(string name, Input<string> id, ScheduleState? state, CustomResourceOptions? opts = null)
    public static Schedule get(String name, Output<String> id, ScheduleState state, CustomResourceOptions options)
    resources:  _:    type: grafana:k6:Schedule    get:      id: ${id}
    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:
    CreatedBy string
    The email of the user who created the schedule.
    Cron Pulumiverse.Grafana.K6.Inputs.ScheduleCron
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    Deactivated bool
    Whether the schedule is deactivated.
    LoadTestId string
    The identifier of the load test to schedule.
    NextRun string
    The next scheduled execution time.
    RecurrenceRule Pulumiverse.Grafana.K6.Inputs.ScheduleRecurrenceRule
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    Starts string
    The start time for the schedule (RFC3339 format).
    CreatedBy string
    The email of the user who created the schedule.
    Cron ScheduleCronArgs
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    Deactivated bool
    Whether the schedule is deactivated.
    LoadTestId string
    The identifier of the load test to schedule.
    NextRun string
    The next scheduled execution time.
    RecurrenceRule ScheduleRecurrenceRuleArgs
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    Starts string
    The start time for the schedule (RFC3339 format).
    createdBy String
    The email of the user who created the schedule.
    cron ScheduleCron
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    deactivated Boolean
    Whether the schedule is deactivated.
    loadTestId String
    The identifier of the load test to schedule.
    nextRun String
    The next scheduled execution time.
    recurrenceRule ScheduleRecurrenceRule
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    starts String
    The start time for the schedule (RFC3339 format).
    createdBy string
    The email of the user who created the schedule.
    cron ScheduleCron
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    deactivated boolean
    Whether the schedule is deactivated.
    loadTestId string
    The identifier of the load test to schedule.
    nextRun string
    The next scheduled execution time.
    recurrenceRule ScheduleRecurrenceRule
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    starts string
    The start time for the schedule (RFC3339 format).
    created_by str
    The email of the user who created the schedule.
    cron ScheduleCronArgs
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    deactivated bool
    Whether the schedule is deactivated.
    load_test_id str
    The identifier of the load test to schedule.
    next_run str
    The next scheduled execution time.
    recurrence_rule ScheduleRecurrenceRuleArgs
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    starts str
    The start time for the schedule (RFC3339 format).
    createdBy String
    The email of the user who created the schedule.
    cron Property Map
    The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    deactivated Boolean
    Whether the schedule is deactivated.
    loadTestId String
    The identifier of the load test to schedule.
    nextRun String
    The next scheduled execution time.
    recurrenceRule Property Map
    The schedule recurrence settings. If not specified, the test will run only once on the 'starts' date. Only one of recurrence_rule and cron can be set.
    starts String
    The start time for the schedule (RFC3339 format).

    Supporting Types

    ScheduleCron, ScheduleCronArgs

    Schedule string
    A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
    Timezone string
    The timezone of the cron expression. For example, UTC or Europe/London.
    Schedule string
    A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
    Timezone string
    The timezone of the cron expression. For example, UTC or Europe/London.
    schedule String
    A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
    timezone String
    The timezone of the cron expression. For example, UTC or Europe/London.
    schedule string
    A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
    timezone string
    The timezone of the cron expression. For example, UTC or Europe/London.
    schedule str
    A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
    timezone str
    The timezone of the cron expression. For example, UTC or Europe/London.
    schedule String
    A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
    timezone String
    The timezone of the cron expression. For example, UTC or Europe/London.

    ScheduleRecurrenceRule, ScheduleRecurrenceRuleArgs

    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, YEARLY).
    Interval int
    The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY). Defaults to 1.
    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, YEARLY).
    Interval int
    The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY). Defaults to 1.
    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, YEARLY).
    interval Integer
    The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY). Defaults to 1.
    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, YEARLY).
    interval number
    The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY). Defaults to 1.
    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, YEARLY).
    interval int
    The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY). Defaults to 1.
    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, YEARLY).
    interval Number
    The interval between each frequency iteration (e.g., 2 = every 2 hours for HOURLY). Defaults to 1.
    until String
    The end time for the recurrence (RFC3339 format).

    Import

    $ pulumi import grafana:k6/schedule:Schedule name "{{ load_test_id }}"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v2.14.1 published on Thursday, Nov 6, 2025 by pulumiverse
      Meet Neo: Your AI Platform Teammate