Upstash

v0.0.21 published on Thursday, Aug 4, 2022 by Upstash

KafkaCluster

Example Usage

using Pulumi;
using Upstash = Pulumi.Upstash;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleCluster = new Upstash.KafkaCluster("exampleCluster", new Upstash.KafkaClusterArgs
        {
            ClusterName = "TerraformCluster",
            Multizone = false,
            Region = "eu-west-1",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upstash.NewKafkaCluster(ctx, "exampleCluster", &upstash.KafkaClusterArgs{
			ClusterName: pulumi.String("TerraformCluster"),
			Multizone:   pulumi.Bool(false),
			Region:      pulumi.String("eu-west-1"),
		})
		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 exampleCluster = new KafkaCluster("exampleCluster", KafkaClusterArgs.builder()        
            .clusterName("TerraformCluster")
            .multizone(false)
            .region("eu-west-1")
            .build());

    }
}
import pulumi
import upstash_pulumi as upstash

example_cluster = upstash.KafkaCluster("exampleCluster",
    cluster_name="TerraformCluster",
    multizone=False,
    region="eu-west-1")
import * as pulumi from "@pulumi/pulumi";
import * as upstash from "@pulumi/upstash";

const exampleCluster = new upstash.KafkaCluster("exampleCluster", {
    clusterName: "TerraformCluster",
    multizone: false,
    region: "eu-west-1",
});
resources:
  exampleCluster:
    type: upstash:KafkaCluster
    properties:
      clusterName: TerraformCluster
      multizone: false
      region: eu-west-1

Create KafkaCluster Resource

new KafkaCluster(name: string, args: KafkaClusterArgs, opts?: CustomResourceOptions);
@overload
def KafkaCluster(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cluster_name: Optional[str] = None,
                 multizone: Optional[bool] = None,
                 region: Optional[str] = None)
@overload
def KafkaCluster(resource_name: str,
                 args: KafkaClusterArgs,
                 opts: Optional[ResourceOptions] = None)
func NewKafkaCluster(ctx *Context, name string, args KafkaClusterArgs, opts ...ResourceOption) (*KafkaCluster, error)
public KafkaCluster(string name, KafkaClusterArgs args, CustomResourceOptions? opts = null)
public KafkaCluster(String name, KafkaClusterArgs args)
public KafkaCluster(String name, KafkaClusterArgs args, CustomResourceOptions options)
type: upstash:KafkaCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args KafkaClusterArgs
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 KafkaClusterArgs
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 KafkaClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KafkaClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args KafkaClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

KafkaCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The KafkaCluster resource accepts the following input properties:

ClusterName string

Name of the cluster

Region string

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

Multizone bool

Whether cluster has multizone attribute

ClusterName string

Name of the cluster

Region string

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

Multizone bool

Whether cluster has multizone attribute

clusterName String

Name of the cluster

region String

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

multizone Boolean

Whether cluster has multizone attribute

clusterName string

Name of the cluster

region string

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

multizone boolean

Whether cluster has multizone attribute

cluster_name str

Name of the cluster

region str

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

multizone bool

Whether cluster has multizone attribute

clusterName String

Name of the cluster

region String

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

multizone Boolean

Whether cluster has multizone attribute

Outputs

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

ClusterId string

Unique Cluster ID for created cluster

CreationTime int

Creation time of the cluster

Id string

The provider-assigned unique ID for this managed resource.

MaxMessageSize int

Max Message Size for the cluster

MaxMessagesPerSecond int

Max Messages Per Second for the cluster

MaxPartitions int

Max Partitions for the cluster

MaxRetentionSize int

Max Retention Size of the cluster

MaxRetentionTime int

Max Retention Time of the cluster

Password string

Password for the cluster

RestEndpoint string

REST Endpoint of the cluster

State string

State, where the cluster is originated

TcpEndpoint string

TCP Endpoint of the cluster

Type string

Type of the cluster

Username string

Base64 encoded username for the cluster

ClusterId string

Unique Cluster ID for created cluster

CreationTime int

Creation time of the cluster

Id string

The provider-assigned unique ID for this managed resource.

MaxMessageSize int

Max Message Size for the cluster

MaxMessagesPerSecond int

Max Messages Per Second for the cluster

MaxPartitions int

Max Partitions for the cluster

MaxRetentionSize int

Max Retention Size of the cluster

MaxRetentionTime int

Max Retention Time of the cluster

Password string

Password for the cluster

RestEndpoint string

REST Endpoint of the cluster

State string

State, where the cluster is originated

TcpEndpoint string

TCP Endpoint of the cluster

Type string

Type of the cluster

Username string

Base64 encoded username for the cluster

clusterId String

Unique Cluster ID for created cluster

creationTime Integer

Creation time of the cluster

id String

The provider-assigned unique ID for this managed resource.

maxMessageSize Integer

Max Message Size for the cluster

maxMessagesPerSecond Integer

Max Messages Per Second for the cluster

maxPartitions Integer

Max Partitions for the cluster

maxRetentionSize Integer

Max Retention Size of the cluster

maxRetentionTime Integer

Max Retention Time of the cluster

password String

Password for the cluster

restEndpoint String

REST Endpoint of the cluster

state String

State, where the cluster is originated

tcpEndpoint String

TCP Endpoint of the cluster

type String

Type of the cluster

username String

Base64 encoded username for the cluster

clusterId string

Unique Cluster ID for created cluster

creationTime number

Creation time of the cluster

id string

The provider-assigned unique ID for this managed resource.

maxMessageSize number

Max Message Size for the cluster

maxMessagesPerSecond number

Max Messages Per Second for the cluster

maxPartitions number

Max Partitions for the cluster

maxRetentionSize number

Max Retention Size of the cluster

maxRetentionTime number

Max Retention Time of the cluster

password string

Password for the cluster

restEndpoint string

REST Endpoint of the cluster

state string

State, where the cluster is originated

tcpEndpoint string

TCP Endpoint of the cluster

type string

Type of the cluster

username string

Base64 encoded username for the cluster

cluster_id str

Unique Cluster ID for created cluster

creation_time int

Creation time of the cluster

id str

The provider-assigned unique ID for this managed resource.

max_message_size int

Max Message Size for the cluster

max_messages_per_second int

Max Messages Per Second for the cluster

max_partitions int

Max Partitions for the cluster

max_retention_size int

Max Retention Size of the cluster

max_retention_time int

Max Retention Time of the cluster

password str

Password for the cluster

rest_endpoint str

REST Endpoint of the cluster

state str

State, where the cluster is originated

tcp_endpoint str

TCP Endpoint of the cluster

type str

Type of the cluster

username str

Base64 encoded username for the cluster

clusterId String

Unique Cluster ID for created cluster

creationTime Number

Creation time of the cluster

id String

The provider-assigned unique ID for this managed resource.

maxMessageSize Number

Max Message Size for the cluster

maxMessagesPerSecond Number

Max Messages Per Second for the cluster

maxPartitions Number

Max Partitions for the cluster

maxRetentionSize Number

Max Retention Size of the cluster

maxRetentionTime Number

Max Retention Time of the cluster

password String

Password for the cluster

restEndpoint String

REST Endpoint of the cluster

state String

State, where the cluster is originated

tcpEndpoint String

TCP Endpoint of the cluster

type String

Type of the cluster

username String

Base64 encoded username for the cluster

Look up Existing KafkaCluster Resource

Get an existing KafkaCluster 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?: KafkaClusterState, opts?: CustomResourceOptions): KafkaCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        creation_time: Optional[int] = None,
        max_message_size: Optional[int] = None,
        max_messages_per_second: Optional[int] = None,
        max_partitions: Optional[int] = None,
        max_retention_size: Optional[int] = None,
        max_retention_time: Optional[int] = None,
        multizone: Optional[bool] = None,
        password: Optional[str] = None,
        region: Optional[str] = None,
        rest_endpoint: Optional[str] = None,
        state: Optional[str] = None,
        tcp_endpoint: Optional[str] = None,
        type: Optional[str] = None,
        username: Optional[str] = None) -> KafkaCluster
func GetKafkaCluster(ctx *Context, name string, id IDInput, state *KafkaClusterState, opts ...ResourceOption) (*KafkaCluster, error)
public static KafkaCluster Get(string name, Input<string> id, KafkaClusterState? state, CustomResourceOptions? opts = null)
public static KafkaCluster get(String name, Output<String> id, KafkaClusterState 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:
ClusterId string

Unique Cluster ID for created cluster

ClusterName string

Name of the cluster

CreationTime int

Creation time of the cluster

MaxMessageSize int

Max Message Size for the cluster

MaxMessagesPerSecond int

Max Messages Per Second for the cluster

MaxPartitions int

Max Partitions for the cluster

MaxRetentionSize int

Max Retention Size of the cluster

MaxRetentionTime int

Max Retention Time of the cluster

Multizone bool

Whether cluster has multizone attribute

Password string

Password for the cluster

Region string

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

RestEndpoint string

REST Endpoint of the cluster

State string

State, where the cluster is originated

TcpEndpoint string

TCP Endpoint of the cluster

Type string

Type of the cluster

Username string

Base64 encoded username for the cluster

ClusterId string

Unique Cluster ID for created cluster

ClusterName string

Name of the cluster

CreationTime int

Creation time of the cluster

MaxMessageSize int

Max Message Size for the cluster

MaxMessagesPerSecond int

Max Messages Per Second for the cluster

MaxPartitions int

Max Partitions for the cluster

MaxRetentionSize int

Max Retention Size of the cluster

MaxRetentionTime int

Max Retention Time of the cluster

Multizone bool

Whether cluster has multizone attribute

Password string

Password for the cluster

Region string

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

RestEndpoint string

REST Endpoint of the cluster

State string

State, where the cluster is originated

TcpEndpoint string

TCP Endpoint of the cluster

Type string

Type of the cluster

Username string

Base64 encoded username for the cluster

clusterId String

Unique Cluster ID for created cluster

clusterName String

Name of the cluster

creationTime Integer

Creation time of the cluster

maxMessageSize Integer

Max Message Size for the cluster

maxMessagesPerSecond Integer

Max Messages Per Second for the cluster

maxPartitions Integer

Max Partitions for the cluster

maxRetentionSize Integer

Max Retention Size of the cluster

maxRetentionTime Integer

Max Retention Time of the cluster

multizone Boolean

Whether cluster has multizone attribute

password String

Password for the cluster

region String

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

restEndpoint String

REST Endpoint of the cluster

state String

State, where the cluster is originated

tcpEndpoint String

TCP Endpoint of the cluster

type String

Type of the cluster

username String

Base64 encoded username for the cluster

clusterId string

Unique Cluster ID for created cluster

clusterName string

Name of the cluster

creationTime number

Creation time of the cluster

maxMessageSize number

Max Message Size for the cluster

maxMessagesPerSecond number

Max Messages Per Second for the cluster

maxPartitions number

Max Partitions for the cluster

maxRetentionSize number

Max Retention Size of the cluster

maxRetentionTime number

Max Retention Time of the cluster

multizone boolean

Whether cluster has multizone attribute

password string

Password for the cluster

region string

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

restEndpoint string

REST Endpoint of the cluster

state string

State, where the cluster is originated

tcpEndpoint string

TCP Endpoint of the cluster

type string

Type of the cluster

username string

Base64 encoded username for the cluster

cluster_id str

Unique Cluster ID for created cluster

cluster_name str

Name of the cluster

creation_time int

Creation time of the cluster

max_message_size int

Max Message Size for the cluster

max_messages_per_second int

Max Messages Per Second for the cluster

max_partitions int

Max Partitions for the cluster

max_retention_size int

Max Retention Size of the cluster

max_retention_time int

Max Retention Time of the cluster

multizone bool

Whether cluster has multizone attribute

password str

Password for the cluster

region str

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

rest_endpoint str

REST Endpoint of the cluster

state str

State, where the cluster is originated

tcp_endpoint str

TCP Endpoint of the cluster

type str

Type of the cluster

username str

Base64 encoded username for the cluster

clusterId String

Unique Cluster ID for created cluster

clusterName String

Name of the cluster

creationTime Number

Creation time of the cluster

maxMessageSize Number

Max Message Size for the cluster

maxMessagesPerSecond Number

Max Messages Per Second for the cluster

maxPartitions Number

Max Partitions for the cluster

maxRetentionSize Number

Max Retention Size of the cluster

maxRetentionTime Number

Max Retention Time of the cluster

multizone Boolean

Whether cluster has multizone attribute

password String

Password for the cluster

region String

region of the cluster. Possible values (may change) are: "eu-west-1", "us-east-1"

restEndpoint String

REST Endpoint of the cluster

state String

State, where the cluster is originated

tcpEndpoint String

TCP Endpoint of the cluster

type String

Type of the cluster

username String

Base64 encoded username for the cluster

Package Details

Repository
https://github.com/upstash/upstash-pulumi-provider
License
Apache-2.0
Notes

This Pulumi package is based on the upstash Terraform Provider.