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

upstash.QStashEndpoint

Explore with Pulumi AI

Example Usage

using Pulumi;
using Upstash = Pulumi.Upstash;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleQstashEndpoint = new Upstash.QStashEndpoint("exampleQstashEndpoint", new Upstash.QStashEndpointArgs
        {
            Url = "https://***.***",
            TopicId = resource.Upstash_qstash_topic.ExampleQstashTopic.Topic_id,
        });
    }

}
Copy
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.NewQStashEndpoint(ctx, "exampleQstashEndpoint", &upstash.QStashEndpointArgs{
			Url:     pulumi.String("https://***.***"),
			TopicId: pulumi.Any(resource.Upstash_qstash_topic.ExampleQstashTopic.Topic_id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleQstashEndpoint = new QStashEndpoint("exampleQstashEndpoint", QStashEndpointArgs.builder()        
            .url("https://***.***")
            .topicId(resource.upstash_qstash_topic().exampleQstashTopic().topic_id())
            .build());

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

const exampleQstashEndpoint = new upstash.QStashEndpoint("exampleQstashEndpoint", {
    url: "https://***.***",
    topicId: resource.upstash_qstash_topic.exampleQstashTopic.topic_id,
});
Copy
import pulumi
import upstash_pulumi as upstash

example_qstash_endpoint = upstash.QStashEndpoint("exampleQstashEndpoint",
    url="https://***.***",
    topic_id=resource["upstash_qstash_topic"]["exampleQstashTopic"]["topic_id"])
Copy
resources:
  exampleQstashEndpoint:
    type: upstash:QStashEndpoint
    properties:
      url: https://***.***
      topicId: ${resource.upstash_qstash_topic.exampleQstashTopic.topic_id}
Copy

Create QStashEndpoint Resource

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

Constructor syntax

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

@overload
def QStashEndpoint(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   topic_id: Optional[str] = None,
                   url: Optional[str] = None)
func NewQStashEndpoint(ctx *Context, name string, args QStashEndpointArgs, opts ...ResourceOption) (*QStashEndpoint, error)
public QStashEndpoint(string name, QStashEndpointArgs args, CustomResourceOptions? opts = null)
public QStashEndpoint(String name, QStashEndpointArgs args)
public QStashEndpoint(String name, QStashEndpointArgs args, CustomResourceOptions options)
type: upstash:QStashEndpoint
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. QStashEndpointArgs
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. QStashEndpointArgs
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. QStashEndpointArgs
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. QStashEndpointArgs
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. QStashEndpointArgs
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 qstashEndpointResource = new Upstash.QStashEndpoint("qstashEndpointResource", new()
{
    TopicId = "string",
    Url = "string",
});
Copy
example, err := upstash.NewQStashEndpoint(ctx, "qstashEndpointResource", &upstash.QStashEndpointArgs{
	TopicId: pulumi.String("string"),
	Url:     pulumi.String("string"),
})
Copy
var qstashEndpointResource = new QStashEndpoint("qstashEndpointResource", QStashEndpointArgs.builder()
    .topicId("string")
    .url("string")
    .build());
Copy
qstash_endpoint_resource = upstash.QStashEndpoint("qstashEndpointResource",
    topic_id="string",
    url="string")
Copy
const qstashEndpointResource = new upstash.QStashEndpoint("qstashEndpointResource", {
    topicId: "string",
    url: "string",
});
Copy
type: upstash:QStashEndpoint
properties:
    topicId: string
    url: string
Copy

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

TopicId
This property is required.
Changes to this property will trigger replacement.
string
Topic Id that the endpoint is added to
Url This property is required. string
URL of the endpoint
TopicId
This property is required.
Changes to this property will trigger replacement.
string
Topic Id that the endpoint is added to
Url This property is required. string
URL of the endpoint
topicId
This property is required.
Changes to this property will trigger replacement.
String
Topic Id that the endpoint is added to
url This property is required. String
URL of the endpoint
topicId
This property is required.
Changes to this property will trigger replacement.
string
Topic Id that the endpoint is added to
url This property is required. string
URL of the endpoint
topic_id
This property is required.
Changes to this property will trigger replacement.
str
Topic Id that the endpoint is added to
url This property is required. str
URL of the endpoint
topicId
This property is required.
Changes to this property will trigger replacement.
String
Topic Id that the endpoint is added to
url This property is required. String
URL of the endpoint

Outputs

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

EndpointId string
Unique Qstash Endpoint ID
Id string
The provider-assigned unique ID for this managed resource.
TopicName string
Unique Qstash Topic Name for Endpoint
EndpointId string
Unique Qstash Endpoint ID
Id string
The provider-assigned unique ID for this managed resource.
TopicName string
Unique Qstash Topic Name for Endpoint
endpointId String
Unique Qstash Endpoint ID
id String
The provider-assigned unique ID for this managed resource.
topicName String
Unique Qstash Topic Name for Endpoint
endpointId string
Unique Qstash Endpoint ID
id string
The provider-assigned unique ID for this managed resource.
topicName string
Unique Qstash Topic Name for Endpoint
endpoint_id str
Unique Qstash Endpoint ID
id str
The provider-assigned unique ID for this managed resource.
topic_name str
Unique Qstash Topic Name for Endpoint
endpointId String
Unique Qstash Endpoint ID
id String
The provider-assigned unique ID for this managed resource.
topicName String
Unique Qstash Topic Name for Endpoint

Look up Existing QStashEndpoint Resource

Get an existing QStashEndpoint 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?: QStashEndpointState, opts?: CustomResourceOptions): QStashEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint_id: Optional[str] = None,
        topic_id: Optional[str] = None,
        topic_name: Optional[str] = None,
        url: Optional[str] = None) -> QStashEndpoint
func GetQStashEndpoint(ctx *Context, name string, id IDInput, state *QStashEndpointState, opts ...ResourceOption) (*QStashEndpoint, error)
public static QStashEndpoint Get(string name, Input<string> id, QStashEndpointState? state, CustomResourceOptions? opts = null)
public static QStashEndpoint get(String name, Output<String> id, QStashEndpointState state, CustomResourceOptions options)
resources:  _:    type: upstash:QStashEndpoint    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:
EndpointId string
Unique Qstash Endpoint ID
TopicId Changes to this property will trigger replacement. string
Topic Id that the endpoint is added to
TopicName string
Unique Qstash Topic Name for Endpoint
Url string
URL of the endpoint
EndpointId string
Unique Qstash Endpoint ID
TopicId Changes to this property will trigger replacement. string
Topic Id that the endpoint is added to
TopicName string
Unique Qstash Topic Name for Endpoint
Url string
URL of the endpoint
endpointId String
Unique Qstash Endpoint ID
topicId Changes to this property will trigger replacement. String
Topic Id that the endpoint is added to
topicName String
Unique Qstash Topic Name for Endpoint
url String
URL of the endpoint
endpointId string
Unique Qstash Endpoint ID
topicId Changes to this property will trigger replacement. string
Topic Id that the endpoint is added to
topicName string
Unique Qstash Topic Name for Endpoint
url string
URL of the endpoint
endpoint_id str
Unique Qstash Endpoint ID
topic_id Changes to this property will trigger replacement. str
Topic Id that the endpoint is added to
topic_name str
Unique Qstash Topic Name for Endpoint
url str
URL of the endpoint
endpointId String
Unique Qstash Endpoint ID
topicId Changes to this property will trigger replacement. String
Topic Id that the endpoint is added to
topicName String
Unique Qstash Topic Name for Endpoint
url String
URL of the endpoint

Package Details

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