Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Astra DB
  3. API Docs
  4. StreamingTenant
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse
pulumiverse/pulumi-astra

astra.StreamingTenant

Explore with Pulumi AI

astra logo
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse
pulumiverse/pulumi-astra

    astra.StreamingTenant creates an Astra Streaming tenant.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Astra = Pulumiverse.Astra;

return await Deployment.RunAsync(() => 
{
    var streamingTenant_1 = new Astra.StreamingTenant("streamingTenant-1", new()
    {
        CloudProvider = "gcp",
        Region = "useast-4",
        TenantName = "terraformtest",
        Topic = "terraformtest",
        UserEmail = "seb@datastax.com",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := astra.NewStreamingTenant(ctx, "streamingTenant-1", &astra.StreamingTenantArgs{
			CloudProvider: pulumi.String("gcp"),
			Region:        pulumi.String("useast-4"),
			TenantName:    pulumi.String("terraformtest"),
			Topic:         pulumi.String("terraformtest"),
			UserEmail:     pulumi.String("seb@datastax.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.astra.StreamingTenant;
import com.pulumi.astra.StreamingTenantArgs;
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 streamingTenant_1 = new StreamingTenant("streamingTenant-1", StreamingTenantArgs.builder()        
            .cloudProvider("gcp")
            .region("useast-4")
            .tenantName("terraformtest")
            .topic("terraformtest")
            .userEmail("seb@datastax.com")
            .build());

    }
}

    import pulumi
import pulumiverse_astra as astra

streaming_tenant_1 = astra.StreamingTenant("streamingTenant-1",
    cloud_provider="gcp",
    region="useast-4",
    tenant_name="terraformtest",
    topic="terraformtest",
    user_email="seb@datastax.com")

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

const streaming_tenant_1 = new astra.StreamingTenant("streaming_tenant-1", {
    cloudProvider: "gcp",
    region: "useast-4",
    tenantName: "terraformtest",
    topic: "terraformtest",
    userEmail: "seb@datastax.com",
});

    resources:
  streamingTenant-1:
    type: astra:StreamingTenant
    properties:
      cloudProvider: gcp
      region: useast-4
      tenantName: terraformtest
      topic: terraformtest
      userEmail: seb@datastax.com

    Create StreamingTenant Resource

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

    Constructor syntax

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

@overload
def StreamingTenant(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cloud_provider: Optional[str] = None,
                    region: Optional[str] = None,
                    tenant_name: Optional[str] = None,
                    topic: Optional[str] = None,
                    user_email: Optional[str] = None,
                    deletion_protection: Optional[bool] = None)
    func NewStreamingTenant(ctx *Context, name string, args StreamingTenantArgs, opts ...ResourceOption) (*StreamingTenant, error)
    public StreamingTenant(string name, StreamingTenantArgs args, CustomResourceOptions? opts = null)
    public StreamingTenant(String name, StreamingTenantArgs args)
public StreamingTenant(String name, StreamingTenantArgs args, CustomResourceOptions options)

    type: astra:StreamingTenant
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 StreamingTenantArgs
    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 StreamingTenantArgs
    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 StreamingTenantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamingTenantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamingTenantArgs
    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 streamingTenantResource = new Astra.StreamingTenant("streamingTenantResource", new()
{
    CloudProvider = "string",
    Region = "string",
    TenantName = "string",
    Topic = "string",
    UserEmail = "string",
    DeletionProtection = false,
});

    example, err := astra.NewStreamingTenant(ctx, "streamingTenantResource", &astra.StreamingTenantArgs{
	CloudProvider:      pulumi.String("string"),
	Region:             pulumi.String("string"),
	TenantName:         pulumi.String("string"),
	Topic:              pulumi.String("string"),
	UserEmail:          pulumi.String("string"),
	DeletionProtection: pulumi.Bool(false),
})

    var streamingTenantResource = new StreamingTenant("streamingTenantResource", StreamingTenantArgs.builder()
    .cloudProvider("string")
    .region("string")
    .tenantName("string")
    .topic("string")
    .userEmail("string")
    .deletionProtection(false)
    .build());

    streaming_tenant_resource = astra.StreamingTenant("streamingTenantResource",
    cloud_provider="string",
    region="string",
    tenant_name="string",
    topic="string",
    user_email="string",
    deletion_protection=False)

    const streamingTenantResource = new astra.StreamingTenant("streamingTenantResource", {
    cloudProvider: "string",
    region: "string",
    tenantName: "string",
    topic: "string",
    userEmail: "string",
    deletionProtection: false,
});

    type: astra:StreamingTenant
properties:
    cloudProvider: string
    deletionProtection: false
    region: string
    tenantName: string
    topic: string
    userEmail: string

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

    CloudProvider string
    Cloud provider
    Region string
    cloud region
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    UserEmail string
    User email for tenant.
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    CloudProvider string
    Cloud provider
    Region string
    cloud region
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    UserEmail string
    User email for tenant.
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    cloudProvider String
    Cloud provider
    region String
    cloud region
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    userEmail String
    User email for tenant.
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    cloudProvider string
    Cloud provider
    region string
    cloud region
    tenantName string
    Streaming tenant name.
    topic string
    Streaming tenant topic.
    userEmail string
    User email for tenant.
    deletionProtection boolean
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    cloud_provider str
    Cloud provider
    region str
    cloud region
    tenant_name str
    Streaming tenant name.
    topic str
    Streaming tenant topic.
    user_email str
    User email for tenant.
    deletion_protection bool
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    cloudProvider String
    Cloud provider
    region String
    cloud region
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    userEmail String
    User email for tenant.
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.

    Outputs

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

    BrokerServiceUrl string
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    ClusterName string
    Pulsar cluster name.
    Id string
    The provider-assigned unique ID for this managed resource.
    TenantId string
    UUID for the tenant.
    UserMetricsUrl string
    URL for metrics.
    WebServiceUrl string
    URL used for administrative operations.
    WebSocketQueryParamUrl string
    URL used for web socket query parameter operations.
    WebSocketUrl string
    URL used for web socket operations.
    BrokerServiceUrl string
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    ClusterName string
    Pulsar cluster name.
    Id string
    The provider-assigned unique ID for this managed resource.
    TenantId string
    UUID for the tenant.
    UserMetricsUrl string
    URL for metrics.
    WebServiceUrl string
    URL used for administrative operations.
    WebSocketQueryParamUrl string
    URL used for web socket query parameter operations.
    WebSocketUrl string
    URL used for web socket operations.
    brokerServiceUrl String
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    clusterName String
    Pulsar cluster name.
    id String
    The provider-assigned unique ID for this managed resource.
    tenantId String
    UUID for the tenant.
    userMetricsUrl String
    URL for metrics.
    webServiceUrl String
    URL used for administrative operations.
    webSocketQueryParamUrl String
    URL used for web socket query parameter operations.
    webSocketUrl String
    URL used for web socket operations.
    brokerServiceUrl string
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    clusterName string
    Pulsar cluster name.
    id string
    The provider-assigned unique ID for this managed resource.
    tenantId string
    UUID for the tenant.
    userMetricsUrl string
    URL for metrics.
    webServiceUrl string
    URL used for administrative operations.
    webSocketQueryParamUrl string
    URL used for web socket query parameter operations.
    webSocketUrl string
    URL used for web socket operations.
    broker_service_url str
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    cluster_name str
    Pulsar cluster name.
    id str
    The provider-assigned unique ID for this managed resource.
    tenant_id str
    UUID for the tenant.
    user_metrics_url str
    URL for metrics.
    web_service_url str
    URL used for administrative operations.
    web_socket_query_param_url str
    URL used for web socket query parameter operations.
    web_socket_url str
    URL used for web socket operations.
    brokerServiceUrl String
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    clusterName String
    Pulsar cluster name.
    id String
    The provider-assigned unique ID for this managed resource.
    tenantId String
    UUID for the tenant.
    userMetricsUrl String
    URL for metrics.
    webServiceUrl String
    URL used for administrative operations.
    webSocketQueryParamUrl String
    URL used for web socket query parameter operations.
    webSocketUrl String
    URL used for web socket operations.

    Look up Existing StreamingTenant Resource

    Get an existing StreamingTenant 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?: StreamingTenantState, opts?: CustomResourceOptions): StreamingTenant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        broker_service_url: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        cluster_name: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        region: Optional[str] = None,
        tenant_id: Optional[str] = None,
        tenant_name: Optional[str] = None,
        topic: Optional[str] = None,
        user_email: Optional[str] = None,
        user_metrics_url: Optional[str] = None,
        web_service_url: Optional[str] = None,
        web_socket_query_param_url: Optional[str] = None,
        web_socket_url: Optional[str] = None) -> StreamingTenant
    func GetStreamingTenant(ctx *Context, name string, id IDInput, state *StreamingTenantState, opts ...ResourceOption) (*StreamingTenant, error)
    public static StreamingTenant Get(string name, Input<string> id, StreamingTenantState? state, CustomResourceOptions? opts = null)
    public static StreamingTenant get(String name, Output<String> id, StreamingTenantState 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:
    BrokerServiceUrl string
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    CloudProvider string
    Cloud provider
    ClusterName string
    Pulsar cluster name.
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    Region string
    cloud region
    TenantId string
    UUID for the tenant.
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    UserEmail string
    User email for tenant.
    UserMetricsUrl string
    URL for metrics.
    WebServiceUrl string
    URL used for administrative operations.
    WebSocketQueryParamUrl string
    URL used for web socket query parameter operations.
    WebSocketUrl string
    URL used for web socket operations.
    BrokerServiceUrl string
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    CloudProvider string
    Cloud provider
    ClusterName string
    Pulsar cluster name.
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    Region string
    cloud region
    TenantId string
    UUID for the tenant.
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    UserEmail string
    User email for tenant.
    UserMetricsUrl string
    URL for metrics.
    WebServiceUrl string
    URL used for administrative operations.
    WebSocketQueryParamUrl string
    URL used for web socket query parameter operations.
    WebSocketUrl string
    URL used for web socket operations.
    brokerServiceUrl String
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    cloudProvider String
    Cloud provider
    clusterName String
    Pulsar cluster name.
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    region String
    cloud region
    tenantId String
    UUID for the tenant.
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    userEmail String
    User email for tenant.
    userMetricsUrl String
    URL for metrics.
    webServiceUrl String
    URL used for administrative operations.
    webSocketQueryParamUrl String
    URL used for web socket query parameter operations.
    webSocketUrl String
    URL used for web socket operations.
    brokerServiceUrl string
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    cloudProvider string
    Cloud provider
    clusterName string
    Pulsar cluster name.
    deletionProtection boolean
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    region string
    cloud region
    tenantId string
    UUID for the tenant.
    tenantName string
    Streaming tenant name.
    topic string
    Streaming tenant topic.
    userEmail string
    User email for tenant.
    userMetricsUrl string
    URL for metrics.
    webServiceUrl string
    URL used for administrative operations.
    webSocketQueryParamUrl string
    URL used for web socket query parameter operations.
    webSocketUrl string
    URL used for web socket operations.
    broker_service_url str
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    cloud_provider str
    Cloud provider
    cluster_name str
    Pulsar cluster name.
    deletion_protection bool
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    region str
    cloud region
    tenant_id str
    UUID for the tenant.
    tenant_name str
    Streaming tenant name.
    topic str
    Streaming tenant topic.
    user_email str
    User email for tenant.
    user_metrics_url str
    URL for metrics.
    web_service_url str
    URL used for administrative operations.
    web_socket_query_param_url str
    URL used for web socket query parameter operations.
    web_socket_url str
    URL used for web socket operations.
    brokerServiceUrl String
    The Pulsar Binary Protocol URL used for production and consumption of messages.
    cloudProvider String
    Cloud provider
    clusterName String
    Pulsar cluster name.
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this tenant. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
    region String
    cloud region
    tenantId String
    UUID for the tenant.
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    userEmail String
    User email for tenant.
    userMetricsUrl String
    URL for metrics.
    webServiceUrl String
    URL used for administrative operations.
    webSocketQueryParamUrl String
    URL used for web socket query parameter operations.
    webSocketUrl String
    URL used for web socket operations.

    Import

     $ pulumi import astra:index/streamingTenant:StreamingTenant example tenant_name

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

    Package Details

    Repository
    astra pulumiverse/pulumi-astra
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the astra Terraform Provider.
    astra logo
    Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse
    pulumiverse/pulumi-astra