Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Upstash
  3. API Docs
  4. QStashSchedule
Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash
upstash/pulumi-upstash

upstash.QStashSchedule

Explore with Pulumi AI

upstash logo
Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash
upstash/pulumi-upstash

    Example Usage

    using Pulumi;
using Upstash = Pulumi.Upstash;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleQstashSchedule = new Upstash.QStashSchedule("exampleQstashSchedule", new Upstash.QStashScheduleArgs
        {
            Destination = resource.Upstash_qstash_topic.ExampleQstashTopic.Topic_id,
            Cron = "* * * * */2",
        });
        // or simply provide a link
        // destination = "https://***.***"
    }

}

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/upstash/pulumi-upstash/sdk/go/upstash"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upstash.NewQStashSchedule(ctx, "exampleQstashSchedule", &upstash.QStashScheduleArgs{
			Destination: pulumi.Any(resource.Upstash_qstash_topic.ExampleQstashTopic.Topic_id),
			Cron:        pulumi.String("* * * * */2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleQstashSchedule = new QStashSchedule("exampleQstashSchedule", QStashScheduleArgs.builder()        
            .destination(resource.upstash_qstash_topic().exampleQstashTopic().topic_id())
            .cron("* * * * */2")
            .build());

    }
}

    import pulumi
import upstash_pulumi as upstash

example_qstash_schedule = upstash.QStashSchedule("exampleQstashSchedule",
    destination=resource["upstash_qstash_topic"]["exampleQstashTopic"]["topic_id"],
    cron="* * * * */2")
# or simply provide a link
# destination = "https://***.***"

    import * as pulumi from "@pulumi/pulumi";
import * as pulumi from "@upstash/pulumi";

const exampleQstashSchedule = new upstash.QStashSchedule("exampleQstashSchedule", {
    destination: resource.upstash_qstash_topic.exampleQstashTopic.topic_id,
    cron: "* * * * */2",
});
// or simply provide a link
// destination = "https://***.***"

    resources:
  exampleQstashSchedule:
    type: upstash:QStashSchedule
    properties:
      destination: ${resource.upstash_qstash_topic.exampleQstashTopic.topic_id}
      cron: '* * * * */2'

    Create QStashSchedule Resource

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

    Constructor syntax

    new QStashSchedule(name: string, args: QStashScheduleArgs, opts?: CustomResourceOptions);
    @overload
def QStashSchedule(resource_name: str,
                   args: QStashScheduleArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def QStashSchedule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cron: Optional[str] = None,
                   destination: Optional[str] = None,
                   body: Optional[str] = None,
                   callback: Optional[str] = None,
                   content_based_deduplication: Optional[bool] = None,
                   content_type: Optional[str] = None,
                   deduplication_id: Optional[str] = None,
                   delay: Optional[str] = None,
                   forward_headers: Optional[Mapping[str, str]] = None,
                   not_before: Optional[int] = None,
                   retries: Optional[int] = None)
    func NewQStashSchedule(ctx *Context, name string, args QStashScheduleArgs, opts ...ResourceOption) (*QStashSchedule, error)
    public QStashSchedule(string name, QStashScheduleArgs args, CustomResourceOptions? opts = null)
    public QStashSchedule(String name, QStashScheduleArgs args)
public QStashSchedule(String name, QStashScheduleArgs args, CustomResourceOptions options)

    type: upstash:QStashSchedule
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 QStashScheduleArgs
    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 QStashScheduleArgs
    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 QStashScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QStashScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QStashScheduleArgs
    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 qstashScheduleResource = new Upstash.QStashSchedule("qstashScheduleResource", new()
{
    Cron = "string",
    Destination = "string",
    Body = "string",
    Callback = "string",
    ContentBasedDeduplication = false,
    ContentType = "string",
    DeduplicationId = "string",
    Delay = "string",
    ForwardHeaders = 
    {
        { "string", "string" },
    },
    NotBefore = 0,
    Retries = 0,
});

    example, err := upstash.NewQStashSchedule(ctx, "qstashScheduleResource", &upstash.QStashScheduleArgs{
	Cron:                      pulumi.String("string"),
	Destination:               pulumi.String("string"),
	Body:                      pulumi.String("string"),
	Callback:                  pulumi.String("string"),
	ContentBasedDeduplication: pulumi.Bool(false),
	ContentType:               pulumi.String("string"),
	DeduplicationId:           pulumi.String("string"),
	Delay:                     pulumi.String("string"),
	ForwardHeaders: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NotBefore: pulumi.Int(0),
	Retries:   pulumi.Int(0),
})

    var qstashScheduleResource = new QStashSchedule("qstashScheduleResource", QStashScheduleArgs.builder()
    .cron("string")
    .destination("string")
    .body("string")
    .callback("string")
    .contentBasedDeduplication(false)
    .contentType("string")
    .deduplicationId("string")
    .delay("string")
    .forwardHeaders(Map.of("string", "string"))
    .notBefore(0)
    .retries(0)
    .build());

    qstash_schedule_resource = upstash.QStashSchedule("qstashScheduleResource",
    cron="string",
    destination="string",
    body="string",
    callback="string",
    content_based_deduplication=False,
    content_type="string",
    deduplication_id="string",
    delay="string",
    forward_headers={
        "string": "string",
    },
    not_before=0,
    retries=0)

    const qstashScheduleResource = new upstash.QStashSchedule("qstashScheduleResource", {
    cron: "string",
    destination: "string",
    body: "string",
    callback: "string",
    contentBasedDeduplication: false,
    contentType: "string",
    deduplicationId: "string",
    delay: "string",
    forwardHeaders: {
        string: "string",
    },
    notBefore: 0,
    retries: 0,
});

    type: upstash:QStashSchedule
properties:
    body: string
    callback: string
    contentBasedDeduplication: false
    contentType: string
    cron: string
    deduplicationId: string
    delay: string
    destination: string
    forwardHeaders:
        string: string
    notBefore: 0
    retries: 0

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

    Cron string
    Cron string for Qstash Schedule
    Destination string
    Destination for Qstash Schedule. Either Topic ID or valid URL
    Body string
    Body to send for the POST request in string format. Needs escaping () double quotes.
    Callback string
    Callback URL for Qstash Schedule.
    ContentBasedDeduplication bool
    Content Based Deduplication (bool) for Qstash Scheduling.
    ContentType string
    Content type for Qstash Scheduling.
    DeduplicationId string
    Deduplication ID for Qstash Scheduling.
    Delay string
    Delay for Qstash Schedule.
    ForwardHeaders Dictionary<string, string>
    Forward headers to your API
    NotBefore int
    Start time for Qstash Scheduling.
    Retries int
    Retries for Qstash Schedule requests.
    Cron string
    Cron string for Qstash Schedule
    Destination string
    Destination for Qstash Schedule. Either Topic ID or valid URL
    Body string
    Body to send for the POST request in string format. Needs escaping () double quotes.
    Callback string
    Callback URL for Qstash Schedule.
    ContentBasedDeduplication bool
    Content Based Deduplication (bool) for Qstash Scheduling.
    ContentType string
    Content type for Qstash Scheduling.
    DeduplicationId string
    Deduplication ID for Qstash Scheduling.
    Delay string
    Delay for Qstash Schedule.
    ForwardHeaders map[string]string
    Forward headers to your API
    NotBefore int
    Start time for Qstash Scheduling.
    Retries int
    Retries for Qstash Schedule requests.
    cron String
    Cron string for Qstash Schedule
    destination String
    Destination for Qstash Schedule. Either Topic ID or valid URL
    body String
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback String
    Callback URL for Qstash Schedule.
    contentBasedDeduplication Boolean
    Content Based Deduplication (bool) for Qstash Scheduling.
    contentType String
    Content type for Qstash Scheduling.
    deduplicationId String
    Deduplication ID for Qstash Scheduling.
    delay String
    Delay for Qstash Schedule.
    forwardHeaders Map<String,String>
    Forward headers to your API
    notBefore Integer
    Start time for Qstash Scheduling.
    retries Integer
    Retries for Qstash Schedule requests.
    cron string
    Cron string for Qstash Schedule
    destination string
    Destination for Qstash Schedule. Either Topic ID or valid URL
    body string
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback string
    Callback URL for Qstash Schedule.
    contentBasedDeduplication boolean
    Content Based Deduplication (bool) for Qstash Scheduling.
    contentType string
    Content type for Qstash Scheduling.
    deduplicationId string
    Deduplication ID for Qstash Scheduling.
    delay string
    Delay for Qstash Schedule.
    forwardHeaders {[key: string]: string}
    Forward headers to your API
    notBefore number
    Start time for Qstash Scheduling.
    retries number
    Retries for Qstash Schedule requests.
    cron str
    Cron string for Qstash Schedule
    destination str
    Destination for Qstash Schedule. Either Topic ID or valid URL
    body str
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback str
    Callback URL for Qstash Schedule.
    content_based_deduplication bool
    Content Based Deduplication (bool) for Qstash Scheduling.
    content_type str
    Content type for Qstash Scheduling.
    deduplication_id str
    Deduplication ID for Qstash Scheduling.
    delay str
    Delay for Qstash Schedule.
    forward_headers Mapping[str, str]
    Forward headers to your API
    not_before int
    Start time for Qstash Scheduling.
    retries int
    Retries for Qstash Schedule requests.
    cron String
    Cron string for Qstash Schedule
    destination String
    Destination for Qstash Schedule. Either Topic ID or valid URL
    body String
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback String
    Callback URL for Qstash Schedule.
    contentBasedDeduplication Boolean
    Content Based Deduplication (bool) for Qstash Scheduling.
    contentType String
    Content type for Qstash Scheduling.
    deduplicationId String
    Deduplication ID for Qstash Scheduling.
    delay String
    Delay for Qstash Schedule.
    forwardHeaders Map<String>
    Forward headers to your API
    notBefore Number
    Start time for Qstash Scheduling.
    retries Number
    Retries for Qstash Schedule requests.

    Outputs

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

    CreatedAt int
    Creation time for Qstash Schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduleId string
    Unique Qstash Schedule ID for requested schedule
    CreatedAt int
    Creation time for Qstash Schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduleId string
    Unique Qstash Schedule ID for requested schedule
    createdAt Integer
    Creation time for Qstash Schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    scheduleId String
    Unique Qstash Schedule ID for requested schedule
    createdAt number
    Creation time for Qstash Schedule.
    id string
    The provider-assigned unique ID for this managed resource.
    scheduleId string
    Unique Qstash Schedule ID for requested schedule
    created_at int
    Creation time for Qstash Schedule.
    id str
    The provider-assigned unique ID for this managed resource.
    schedule_id str
    Unique Qstash Schedule ID for requested schedule
    createdAt Number
    Creation time for Qstash Schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    scheduleId String
    Unique Qstash Schedule ID for requested schedule

    Look up Existing QStashSchedule Resource

    Get an existing QStashSchedule 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?: QStashScheduleState, opts?: CustomResourceOptions): QStashSchedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        callback: Optional[str] = None,
        content_based_deduplication: Optional[bool] = None,
        content_type: Optional[str] = None,
        created_at: Optional[int] = None,
        cron: Optional[str] = None,
        deduplication_id: Optional[str] = None,
        delay: Optional[str] = None,
        destination: Optional[str] = None,
        forward_headers: Optional[Mapping[str, str]] = None,
        not_before: Optional[int] = None,
        retries: Optional[int] = None,
        schedule_id: Optional[str] = None) -> QStashSchedule
    func GetQStashSchedule(ctx *Context, name string, id IDInput, state *QStashScheduleState, opts ...ResourceOption) (*QStashSchedule, error)
    public static QStashSchedule Get(string name, Input<string> id, QStashScheduleState? state, CustomResourceOptions? opts = null)
    public static QStashSchedule get(String name, Output<String> id, QStashScheduleState 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:
    Body string
    Body to send for the POST request in string format. Needs escaping () double quotes.
    Callback string
    Callback URL for Qstash Schedule.
    ContentBasedDeduplication bool
    Content Based Deduplication (bool) for Qstash Scheduling.
    ContentType string
    Content type for Qstash Scheduling.
    CreatedAt int
    Creation time for Qstash Schedule.
    Cron string
    Cron string for Qstash Schedule
    DeduplicationId string
    Deduplication ID for Qstash Scheduling.
    Delay string
    Delay for Qstash Schedule.
    Destination string
    Destination for Qstash Schedule. Either Topic ID or valid URL
    ForwardHeaders Dictionary<string, string>
    Forward headers to your API
    NotBefore int
    Start time for Qstash Scheduling.
    Retries int
    Retries for Qstash Schedule requests.
    ScheduleId string
    Unique Qstash Schedule ID for requested schedule
    Body string
    Body to send for the POST request in string format. Needs escaping () double quotes.
    Callback string
    Callback URL for Qstash Schedule.
    ContentBasedDeduplication bool
    Content Based Deduplication (bool) for Qstash Scheduling.
    ContentType string
    Content type for Qstash Scheduling.
    CreatedAt int
    Creation time for Qstash Schedule.
    Cron string
    Cron string for Qstash Schedule
    DeduplicationId string
    Deduplication ID for Qstash Scheduling.
    Delay string
    Delay for Qstash Schedule.
    Destination string
    Destination for Qstash Schedule. Either Topic ID or valid URL
    ForwardHeaders map[string]string
    Forward headers to your API
    NotBefore int
    Start time for Qstash Scheduling.
    Retries int
    Retries for Qstash Schedule requests.
    ScheduleId string
    Unique Qstash Schedule ID for requested schedule
    body String
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback String
    Callback URL for Qstash Schedule.
    contentBasedDeduplication Boolean
    Content Based Deduplication (bool) for Qstash Scheduling.
    contentType String
    Content type for Qstash Scheduling.
    createdAt Integer
    Creation time for Qstash Schedule.
    cron String
    Cron string for Qstash Schedule
    deduplicationId String
    Deduplication ID for Qstash Scheduling.
    delay String
    Delay for Qstash Schedule.
    destination String
    Destination for Qstash Schedule. Either Topic ID or valid URL
    forwardHeaders Map<String,String>
    Forward headers to your API
    notBefore Integer
    Start time for Qstash Scheduling.
    retries Integer
    Retries for Qstash Schedule requests.
    scheduleId String
    Unique Qstash Schedule ID for requested schedule
    body string
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback string
    Callback URL for Qstash Schedule.
    contentBasedDeduplication boolean
    Content Based Deduplication (bool) for Qstash Scheduling.
    contentType string
    Content type for Qstash Scheduling.
    createdAt number
    Creation time for Qstash Schedule.
    cron string
    Cron string for Qstash Schedule
    deduplicationId string
    Deduplication ID for Qstash Scheduling.
    delay string
    Delay for Qstash Schedule.
    destination string
    Destination for Qstash Schedule. Either Topic ID or valid URL
    forwardHeaders {[key: string]: string}
    Forward headers to your API
    notBefore number
    Start time for Qstash Scheduling.
    retries number
    Retries for Qstash Schedule requests.
    scheduleId string
    Unique Qstash Schedule ID for requested schedule
    body str
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback str
    Callback URL for Qstash Schedule.
    content_based_deduplication bool
    Content Based Deduplication (bool) for Qstash Scheduling.
    content_type str
    Content type for Qstash Scheduling.
    created_at int
    Creation time for Qstash Schedule.
    cron str
    Cron string for Qstash Schedule
    deduplication_id str
    Deduplication ID for Qstash Scheduling.
    delay str
    Delay for Qstash Schedule.
    destination str
    Destination for Qstash Schedule. Either Topic ID or valid URL
    forward_headers Mapping[str, str]
    Forward headers to your API
    not_before int
    Start time for Qstash Scheduling.
    retries int
    Retries for Qstash Schedule requests.
    schedule_id str
    Unique Qstash Schedule ID for requested schedule
    body String
    Body to send for the POST request in string format. Needs escaping () double quotes.
    callback String
    Callback URL for Qstash Schedule.
    contentBasedDeduplication Boolean
    Content Based Deduplication (bool) for Qstash Scheduling.
    contentType String
    Content type for Qstash Scheduling.
    createdAt Number
    Creation time for Qstash Schedule.
    cron String
    Cron string for Qstash Schedule
    deduplicationId String
    Deduplication ID for Qstash Scheduling.
    delay String
    Delay for Qstash Schedule.
    destination String
    Destination for Qstash Schedule. Either Topic ID or valid URL
    forwardHeaders Map<String>
    Forward headers to your API
    notBefore Number
    Start time for Qstash Scheduling.
    retries Number
    Retries for Qstash Schedule requests.
    scheduleId String
    Unique Qstash Schedule ID for requested schedule

    Package Details

    Repository
    upstash upstash/pulumi-upstash
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upstash Terraform Provider.
    upstash logo
    Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash
    upstash/pulumi-upstash