1. Packages
  2. Astra DB
  3. API Docs
  4. StreamingTopic
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse

astra.StreamingTopic

Explore with Pulumi AI

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

    astra.StreamingTopic creates an Astra Streaming topic.

    Create StreamingTopic Resource

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

    Constructor syntax

    new StreamingTopic(name: string, args: StreamingTopicArgs, opts?: CustomResourceOptions);
    @overload
    def StreamingTopic(resource_name: str,
                       args: StreamingTopicArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def StreamingTopic(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cloud_provider: Optional[str] = None,
                       namespace: Optional[str] = None,
                       region: Optional[str] = None,
                       tenant_name: Optional[str] = None,
                       topic: Optional[str] = None,
                       deletion_protection: Optional[bool] = None)
    func NewStreamingTopic(ctx *Context, name string, args StreamingTopicArgs, opts ...ResourceOption) (*StreamingTopic, error)
    public StreamingTopic(string name, StreamingTopicArgs args, CustomResourceOptions? opts = null)
    public StreamingTopic(String name, StreamingTopicArgs args)
    public StreamingTopic(String name, StreamingTopicArgs args, CustomResourceOptions options)
    
    type: astra:StreamingTopic
    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 StreamingTopicArgs
    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 StreamingTopicArgs
    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 StreamingTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamingTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamingTopicArgs
    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 streamingTopicResource = new Astra.StreamingTopic("streamingTopicResource", new()
    {
        CloudProvider = "string",
        Namespace = "string",
        Region = "string",
        TenantName = "string",
        Topic = "string",
        DeletionProtection = false,
    });
    
    example, err := astra.NewStreamingTopic(ctx, "streamingTopicResource", &astra.StreamingTopicArgs{
    	CloudProvider:      pulumi.String("string"),
    	Namespace:          pulumi.String("string"),
    	Region:             pulumi.String("string"),
    	TenantName:         pulumi.String("string"),
    	Topic:              pulumi.String("string"),
    	DeletionProtection: pulumi.Bool(false),
    })
    
    var streamingTopicResource = new StreamingTopic("streamingTopicResource", StreamingTopicArgs.builder()
        .cloudProvider("string")
        .namespace("string")
        .region("string")
        .tenantName("string")
        .topic("string")
        .deletionProtection(false)
        .build());
    
    streaming_topic_resource = astra.StreamingTopic("streamingTopicResource",
        cloud_provider="string",
        namespace="string",
        region="string",
        tenant_name="string",
        topic="string",
        deletion_protection=False)
    
    const streamingTopicResource = new astra.StreamingTopic("streamingTopicResource", {
        cloudProvider: "string",
        namespace: "string",
        region: "string",
        tenantName: "string",
        topic: "string",
        deletionProtection: false,
    });
    
    type: astra:StreamingTopic
    properties:
        cloudProvider: string
        deletionProtection: false
        namespace: string
        region: string
        tenantName: string
        topic: string
    

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

    CloudProvider string
    Cloud provider
    Namespace string
    Pulsar Namespace
    Region string
    cloud region
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this streaming topic. 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
    Namespace string
    Pulsar Namespace
    Region string
    cloud region
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this streaming topic. 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
    namespace String
    Pulsar Namespace
    region String
    cloud region
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this streaming topic. 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
    namespace string
    Pulsar Namespace
    region string
    cloud region
    tenantName string
    Streaming tenant name.
    topic string
    Streaming tenant topic.
    deletionProtection boolean
    Whether or not to allow Terraform to destroy this streaming topic. 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
    namespace str
    Pulsar Namespace
    region str
    cloud region
    tenant_name str
    Streaming tenant name.
    topic str
    Streaming tenant topic.
    deletion_protection bool
    Whether or not to allow Terraform to destroy this streaming topic. 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
    namespace String
    Pulsar Namespace
    region String
    cloud region
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this streaming topic. 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 StreamingTopic resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StreamingTopic Resource

    Get an existing StreamingTopic 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?: StreamingTopicState, opts?: CustomResourceOptions): StreamingTopic
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cloud_provider: Optional[str] = None,
            deletion_protection: Optional[bool] = None,
            namespace: Optional[str] = None,
            region: Optional[str] = None,
            tenant_name: Optional[str] = None,
            topic: Optional[str] = None) -> StreamingTopic
    func GetStreamingTopic(ctx *Context, name string, id IDInput, state *StreamingTopicState, opts ...ResourceOption) (*StreamingTopic, error)
    public static StreamingTopic Get(string name, Input<string> id, StreamingTopicState? state, CustomResourceOptions? opts = null)
    public static StreamingTopic get(String name, Output<String> id, StreamingTopicState 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:
    CloudProvider string
    Cloud provider
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this streaming topic. 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.
    Namespace string
    Pulsar Namespace
    Region string
    cloud region
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    CloudProvider string
    Cloud provider
    DeletionProtection bool
    Whether or not to allow Terraform to destroy this streaming topic. 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.
    Namespace string
    Pulsar Namespace
    Region string
    cloud region
    TenantName string
    Streaming tenant name.
    Topic string
    Streaming tenant topic.
    cloudProvider String
    Cloud provider
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this streaming topic. 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.
    namespace String
    Pulsar Namespace
    region String
    cloud region
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.
    cloudProvider string
    Cloud provider
    deletionProtection boolean
    Whether or not to allow Terraform to destroy this streaming topic. 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.
    namespace string
    Pulsar Namespace
    region string
    cloud region
    tenantName string
    Streaming tenant name.
    topic string
    Streaming tenant topic.
    cloud_provider str
    Cloud provider
    deletion_protection bool
    Whether or not to allow Terraform to destroy this streaming topic. 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.
    namespace str
    Pulsar Namespace
    region str
    cloud region
    tenant_name str
    Streaming tenant name.
    topic str
    Streaming tenant topic.
    cloudProvider String
    Cloud provider
    deletionProtection Boolean
    Whether or not to allow Terraform to destroy this streaming topic. 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.
    namespace String
    Pulsar Namespace
    region String
    cloud region
    tenantName String
    Streaming tenant name.
    topic String
    Streaming tenant topic.

    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