1. Packages
  2. Upstash
  3. API Docs
  4. QStashScheduleV2
Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash

upstash.QStashScheduleV2

Explore with Pulumi AI

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

    Create QStashScheduleV2 Resource

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

    Constructor syntax

    new QStashScheduleV2(name: string, args: QStashScheduleV2Args, opts?: CustomResourceOptions);
    @overload
    def QStashScheduleV2(resource_name: str,
                         args: QStashScheduleV2Args,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def QStashScheduleV2(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cron: Optional[str] = None,
                         destination: Optional[str] = None,
                         body: Optional[str] = None,
                         callback: Optional[str] = None,
                         content_type: Optional[str] = None,
                         delay: Optional[str] = None,
                         forward_headers: Optional[Mapping[str, str]] = None,
                         method: Optional[str] = None,
                         retries: Optional[int] = None)
    func NewQStashScheduleV2(ctx *Context, name string, args QStashScheduleV2Args, opts ...ResourceOption) (*QStashScheduleV2, error)
    public QStashScheduleV2(string name, QStashScheduleV2Args args, CustomResourceOptions? opts = null)
    public QStashScheduleV2(String name, QStashScheduleV2Args args)
    public QStashScheduleV2(String name, QStashScheduleV2Args args, CustomResourceOptions options)
    
    type: upstash:QStashScheduleV2
    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 QStashScheduleV2Args
    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 QStashScheduleV2Args
    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 QStashScheduleV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QStashScheduleV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QStashScheduleV2Args
    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 qstashScheduleV2Resource = new Upstash.QStashScheduleV2("qstashScheduleV2Resource", new()
    {
        Cron = "string",
        Destination = "string",
        Body = "string",
        Callback = "string",
        ContentType = "string",
        Delay = "string",
        ForwardHeaders = 
        {
            { "string", "string" },
        },
        Method = "string",
        Retries = 0,
    });
    
    example, err := upstash.NewQStashScheduleV2(ctx, "qstashScheduleV2Resource", &upstash.QStashScheduleV2Args{
    	Cron:        pulumi.String("string"),
    	Destination: pulumi.String("string"),
    	Body:        pulumi.String("string"),
    	Callback:    pulumi.String("string"),
    	ContentType: pulumi.String("string"),
    	Delay:       pulumi.String("string"),
    	ForwardHeaders: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Method:  pulumi.String("string"),
    	Retries: pulumi.Int(0),
    })
    
    var qstashScheduleV2Resource = new QStashScheduleV2("qstashScheduleV2Resource", QStashScheduleV2Args.builder()
        .cron("string")
        .destination("string")
        .body("string")
        .callback("string")
        .contentType("string")
        .delay("string")
        .forwardHeaders(Map.of("string", "string"))
        .method("string")
        .retries(0)
        .build());
    
    qstash_schedule_v2_resource = upstash.QStashScheduleV2("qstashScheduleV2Resource",
        cron="string",
        destination="string",
        body="string",
        callback="string",
        content_type="string",
        delay="string",
        forward_headers={
            "string": "string",
        },
        method="string",
        retries=0)
    
    const qstashScheduleV2Resource = new upstash.QStashScheduleV2("qstashScheduleV2Resource", {
        cron: "string",
        destination: "string",
        body: "string",
        callback: "string",
        contentType: "string",
        delay: "string",
        forwardHeaders: {
            string: "string",
        },
        method: "string",
        retries: 0,
    });
    
    type: upstash:QStashScheduleV2
    properties:
        body: string
        callback: string
        contentType: string
        cron: string
        delay: string
        destination: string
        forwardHeaders:
            string: string
        method: string
        retries: 0
    

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

    Cron string
    Cron string for Qstash Schedule
    Destination string
    Destination for Qstash Schedule. Either Topic Name 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.
    ContentType string
    Content type for Qstash Scheduling.
    Delay string
    Delay for Qstash Schedule. Delay should be given in seconds
    ForwardHeaders Dictionary<string, string>
    Forward headers to your API
    Method string
    Method of Http Request on QStash
    Retries int
    Retries for Qstash Schedule requests.
    Cron string
    Cron string for Qstash Schedule
    Destination string
    Destination for Qstash Schedule. Either Topic Name 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.
    ContentType string
    Content type for Qstash Scheduling.
    Delay string
    Delay for Qstash Schedule. Delay should be given in seconds
    ForwardHeaders map[string]string
    Forward headers to your API
    Method string
    Method of Http Request on QStash
    Retries int
    Retries for Qstash Schedule requests.
    cron String
    Cron string for Qstash Schedule
    destination String
    Destination for Qstash Schedule. Either Topic Name 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.
    contentType String
    Content type for Qstash Scheduling.
    delay String
    Delay for Qstash Schedule. Delay should be given in seconds
    forwardHeaders Map<String,String>
    Forward headers to your API
    method String
    Method of Http Request on QStash
    retries Integer
    Retries for Qstash Schedule requests.
    cron string
    Cron string for Qstash Schedule
    destination string
    Destination for Qstash Schedule. Either Topic Name 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.
    contentType string
    Content type for Qstash Scheduling.
    delay string
    Delay for Qstash Schedule. Delay should be given in seconds
    forwardHeaders {[key: string]: string}
    Forward headers to your API
    method string
    Method of Http Request on QStash
    retries number
    Retries for Qstash Schedule requests.
    cron str
    Cron string for Qstash Schedule
    destination str
    Destination for Qstash Schedule. Either Topic Name 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_type str
    Content type for Qstash Scheduling.
    delay str
    Delay for Qstash Schedule. Delay should be given in seconds
    forward_headers Mapping[str, str]
    Forward headers to your API
    method str
    Method of Http Request on QStash
    retries int
    Retries for Qstash Schedule requests.
    cron String
    Cron string for Qstash Schedule
    destination String
    Destination for Qstash Schedule. Either Topic Name 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.
    contentType String
    Content type for Qstash Scheduling.
    delay String
    Delay for Qstash Schedule. Delay should be given in seconds
    forwardHeaders Map<String>
    Forward headers to your API
    method String
    Method of Http Request on QStash
    retries Number
    Retries for Qstash Schedule requests.

    Outputs

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

    CreatedAt int
    Creation time for Qstash Schedule.
    Header string
    Headers for the 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.
    Header string
    Headers for the 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.
    header String
    Headers for the 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.
    header string
    Headers for the 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.
    header str
    Headers for the 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.
    header String
    Headers for the 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 QStashScheduleV2 Resource

    Get an existing QStashScheduleV2 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?: QStashScheduleV2State, opts?: CustomResourceOptions): QStashScheduleV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            body: Optional[str] = None,
            callback: Optional[str] = None,
            content_type: Optional[str] = None,
            created_at: Optional[int] = None,
            cron: Optional[str] = None,
            delay: Optional[str] = None,
            destination: Optional[str] = None,
            forward_headers: Optional[Mapping[str, str]] = None,
            header: Optional[str] = None,
            method: Optional[str] = None,
            retries: Optional[int] = None,
            schedule_id: Optional[str] = None) -> QStashScheduleV2
    func GetQStashScheduleV2(ctx *Context, name string, id IDInput, state *QStashScheduleV2State, opts ...ResourceOption) (*QStashScheduleV2, error)
    public static QStashScheduleV2 Get(string name, Input<string> id, QStashScheduleV2State? state, CustomResourceOptions? opts = null)
    public static QStashScheduleV2 get(String name, Output<String> id, QStashScheduleV2State 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.
    ContentType string
    Content type for Qstash Scheduling.
    CreatedAt int
    Creation time for Qstash Schedule.
    Cron string
    Cron string for Qstash Schedule
    Delay string
    Delay for Qstash Schedule. Delay should be given in seconds
    Destination string
    Destination for Qstash Schedule. Either Topic Name or valid URL
    ForwardHeaders Dictionary<string, string>
    Forward headers to your API
    Header string
    Headers for the QStash schedule
    Method string
    Method of Http Request on QStash
    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.
    ContentType string
    Content type for Qstash Scheduling.
    CreatedAt int
    Creation time for Qstash Schedule.
    Cron string
    Cron string for Qstash Schedule
    Delay string
    Delay for Qstash Schedule. Delay should be given in seconds
    Destination string
    Destination for Qstash Schedule. Either Topic Name or valid URL
    ForwardHeaders map[string]string
    Forward headers to your API
    Header string
    Headers for the QStash schedule
    Method string
    Method of Http Request on QStash
    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.
    contentType String
    Content type for Qstash Scheduling.
    createdAt Integer
    Creation time for Qstash Schedule.
    cron String
    Cron string for Qstash Schedule
    delay String
    Delay for Qstash Schedule. Delay should be given in seconds
    destination String
    Destination for Qstash Schedule. Either Topic Name or valid URL
    forwardHeaders Map<String,String>
    Forward headers to your API
    header String
    Headers for the QStash schedule
    method String
    Method of Http Request on QStash
    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.
    contentType string
    Content type for Qstash Scheduling.
    createdAt number
    Creation time for Qstash Schedule.
    cron string
    Cron string for Qstash Schedule
    delay string
    Delay for Qstash Schedule. Delay should be given in seconds
    destination string
    Destination for Qstash Schedule. Either Topic Name or valid URL
    forwardHeaders {[key: string]: string}
    Forward headers to your API
    header string
    Headers for the QStash schedule
    method string
    Method of Http Request on QStash
    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_type str
    Content type for Qstash Scheduling.
    created_at int
    Creation time for Qstash Schedule.
    cron str
    Cron string for Qstash Schedule
    delay str
    Delay for Qstash Schedule. Delay should be given in seconds
    destination str
    Destination for Qstash Schedule. Either Topic Name or valid URL
    forward_headers Mapping[str, str]
    Forward headers to your API
    header str
    Headers for the QStash schedule
    method str
    Method of Http Request on QStash
    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.
    contentType String
    Content type for Qstash Scheduling.
    createdAt Number
    Creation time for Qstash Schedule.
    cron String
    Cron string for Qstash Schedule
    delay String
    Delay for Qstash Schedule. Delay should be given in seconds
    destination String
    Destination for Qstash Schedule. Either Topic Name or valid URL
    forwardHeaders Map<String>
    Forward headers to your API
    header String
    Headers for the QStash schedule
    method String
    Method of Http Request on QStash
    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