1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. DisStream
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.DisStream

Explore with Pulumi AI

Manages DIS Stream resource within FlexibleEngine.

Example Usage

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

const stream = new flexibleengine.DisStream("stream", {partitionCount: 3});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

stream = flexibleengine.DisStream("stream", partition_count=3)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := flexibleengine.NewDisStream(ctx, "stream", &flexibleengine.DisStreamArgs{
			PartitionCount: pulumi.Float64(3),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var stream = new Flexibleengine.DisStream("stream", new()
    {
        PartitionCount = 3,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.DisStream;
import com.pulumi.flexibleengine.DisStreamArgs;
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 stream = new DisStream("stream", DisStreamArgs.builder()
            .partitionCount(3)
            .build());

    }
}
Copy
resources:
  stream:
    type: flexibleengine:DisStream
    properties:
      partitionCount: 3
Copy

Create DisStream Resource

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

Constructor syntax

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

@overload
def DisStream(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              partition_count: Optional[float] = None,
              data_duration: Optional[float] = None,
              dis_stream_id: Optional[str] = None,
              name: Optional[str] = None,
              region: Optional[str] = None,
              type: Optional[str] = None)
func NewDisStream(ctx *Context, name string, args DisStreamArgs, opts ...ResourceOption) (*DisStream, error)
public DisStream(string name, DisStreamArgs args, CustomResourceOptions? opts = null)
public DisStream(String name, DisStreamArgs args)
public DisStream(String name, DisStreamArgs args, CustomResourceOptions options)
type: flexibleengine:DisStream
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. DisStreamArgs
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. DisStreamArgs
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. DisStreamArgs
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. DisStreamArgs
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. DisStreamArgs
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 disStreamResource = new Flexibleengine.DisStream("disStreamResource", new()
{
    PartitionCount = 0,
    DataDuration = 0,
    DisStreamId = "string",
    Name = "string",
    Region = "string",
    Type = "string",
});
Copy
example, err := flexibleengine.NewDisStream(ctx, "disStreamResource", &flexibleengine.DisStreamArgs{
	PartitionCount: pulumi.Float64(0),
	DataDuration:   pulumi.Float64(0),
	DisStreamId:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	Region:         pulumi.String("string"),
	Type:           pulumi.String("string"),
})
Copy
var disStreamResource = new DisStream("disStreamResource", DisStreamArgs.builder()
    .partitionCount(0)
    .dataDuration(0)
    .disStreamId("string")
    .name("string")
    .region("string")
    .type("string")
    .build());
Copy
dis_stream_resource = flexibleengine.DisStream("disStreamResource",
    partition_count=0,
    data_duration=0,
    dis_stream_id="string",
    name="string",
    region="string",
    type="string")
Copy
const disStreamResource = new flexibleengine.DisStream("disStreamResource", {
    partitionCount: 0,
    dataDuration: 0,
    disStreamId: "string",
    name: "string",
    region: "string",
    type: "string",
});
Copy
type: flexibleengine:DisStream
properties:
    dataDuration: 0
    disStreamId: string
    name: string
    partitionCount: 0
    region: string
    type: string
Copy

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

PartitionCount This property is required. double
Specifies the number of the expect partitions. Changing this will create a new resource.
DataDuration double
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
DisStreamId string
The ID of the partition.
Name string
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
Region string
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
Type string

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

PartitionCount This property is required. float64
Specifies the number of the expect partitions. Changing this will create a new resource.
DataDuration float64
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
DisStreamId string
The ID of the partition.
Name string
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
Region string
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
Type string

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

partitionCount This property is required. Double
Specifies the number of the expect partitions. Changing this will create a new resource.
dataDuration Double
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
disStreamId String
The ID of the partition.
name String
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
region String
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
type String

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

partitionCount This property is required. number
Specifies the number of the expect partitions. Changing this will create a new resource.
dataDuration number
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
disStreamId string
The ID of the partition.
name string
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
region string
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
type string

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

partition_count This property is required. float
Specifies the number of the expect partitions. Changing this will create a new resource.
data_duration float
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
dis_stream_id str
The ID of the partition.
name str
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
region str
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
type str

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

partitionCount This property is required. Number
Specifies the number of the expect partitions. Changing this will create a new resource.
dataDuration Number
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
disStreamId String
The ID of the partition.
name String
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
region String
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
type String

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Partitions List<DisStreamPartition>
The information of stream partitions. The partitions object structure is documented below.
Status string
The status of the partition.
Id string
The provider-assigned unique ID for this managed resource.
Partitions []DisStreamPartition
The information of stream partitions. The partitions object structure is documented below.
Status string
The status of the partition.
id String
The provider-assigned unique ID for this managed resource.
partitions List<DisStreamPartition>
The information of stream partitions. The partitions object structure is documented below.
status String
The status of the partition.
id string
The provider-assigned unique ID for this managed resource.
partitions DisStreamPartition[]
The information of stream partitions. The partitions object structure is documented below.
status string
The status of the partition.
id str
The provider-assigned unique ID for this managed resource.
partitions Sequence[DisStreamPartition]
The information of stream partitions. The partitions object structure is documented below.
status str
The status of the partition.
id String
The provider-assigned unique ID for this managed resource.
partitions List<Property Map>
The information of stream partitions. The partitions object structure is documented below.
status String
The status of the partition.

Look up Existing DisStream Resource

Get an existing DisStream 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?: DisStreamState, opts?: CustomResourceOptions): DisStream
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_duration: Optional[float] = None,
        dis_stream_id: Optional[str] = None,
        name: Optional[str] = None,
        partition_count: Optional[float] = None,
        partitions: Optional[Sequence[DisStreamPartitionArgs]] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        type: Optional[str] = None) -> DisStream
func GetDisStream(ctx *Context, name string, id IDInput, state *DisStreamState, opts ...ResourceOption) (*DisStream, error)
public static DisStream Get(string name, Input<string> id, DisStreamState? state, CustomResourceOptions? opts = null)
public static DisStream get(String name, Output<String> id, DisStreamState state, CustomResourceOptions options)
resources:  _:    type: flexibleengine:DisStream    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:
DataDuration double
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
DisStreamId string
The ID of the partition.
Name string
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
PartitionCount double
Specifies the number of the expect partitions. Changing this will create a new resource.
Partitions List<DisStreamPartition>
The information of stream partitions. The partitions object structure is documented below.
Region string
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
Status string
The status of the partition.
Type string

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

DataDuration float64
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
DisStreamId string
The ID of the partition.
Name string
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
PartitionCount float64
Specifies the number of the expect partitions. Changing this will create a new resource.
Partitions []DisStreamPartitionArgs
The information of stream partitions. The partitions object structure is documented below.
Region string
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
Status string
The status of the partition.
Type string

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

dataDuration Double
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
disStreamId String
The ID of the partition.
name String
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
partitionCount Double
Specifies the number of the expect partitions. Changing this will create a new resource.
partitions List<DisStreamPartition>
The information of stream partitions. The partitions object structure is documented below.
region String
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
status String
The status of the partition.
type String

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

dataDuration number
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
disStreamId string
The ID of the partition.
name string
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
partitionCount number
Specifies the number of the expect partitions. Changing this will create a new resource.
partitions DisStreamPartition[]
The information of stream partitions. The partitions object structure is documented below.
region string
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
status string
The status of the partition.
type string

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

data_duration float
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
dis_stream_id str
The ID of the partition.
name str
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
partition_count float
Specifies the number of the expect partitions. Changing this will create a new resource.
partitions Sequence[DisStreamPartitionArgs]
The information of stream partitions. The partitions object structure is documented below.
region str
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
status str
The status of the partition.
type str

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

dataDuration Number
Specifies the number of hours for which data from the stream will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.
disStreamId String
The ID of the partition.
name String
Specifies the name of the DIS stream to be created. Changing this will create a new resource.
partitionCount Number
Specifies the number of the expect partitions. Changing this will create a new resource.
partitions List<Property Map>
The information of stream partitions. The partitions object structure is documented below.
region String
Specifies the region in which to create the DIS stream resource. If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.
status String
The status of the partition.
type String

Specifies the Stream type. The value can be COMMON or ADVANCED. Defaults to COMMON. Changing this will create a new resource.

  • COMMON stream: Each partition supports a read speed of up to 2 MB/s and a write speed of up to 1000 records/s and 1 MB/s.

  • ADVANCED stream: Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

Supporting Types

DisStreamPartition
, DisStreamPartitionArgs

HashRange This property is required. string
Possible value range of the hash key used by each partition.
Id This property is required. string
The ID of the partition.
SequenceNumberRange This property is required. string
Sequence number range of each partition.
Status This property is required. string
The status of the partition.
HashRange This property is required. string
Possible value range of the hash key used by each partition.
Id This property is required. string
The ID of the partition.
SequenceNumberRange This property is required. string
Sequence number range of each partition.
Status This property is required. string
The status of the partition.
hashRange This property is required. String
Possible value range of the hash key used by each partition.
id This property is required. String
The ID of the partition.
sequenceNumberRange This property is required. String
Sequence number range of each partition.
status This property is required. String
The status of the partition.
hashRange This property is required. string
Possible value range of the hash key used by each partition.
id This property is required. string
The ID of the partition.
sequenceNumberRange This property is required. string
Sequence number range of each partition.
status This property is required. string
The status of the partition.
hash_range This property is required. str
Possible value range of the hash key used by each partition.
id This property is required. str
The ID of the partition.
sequence_number_range This property is required. str
Sequence number range of each partition.
status This property is required. str
The status of the partition.
hashRange This property is required. String
Possible value range of the hash key used by each partition.
id This property is required. String
The ID of the partition.
sequenceNumberRange This property is required. String
Sequence number range of each partition.
status This property is required. String
The status of the partition.

Import

Dis stream can be imported by name. For example,

$ pulumi import flexibleengine:index/disStream:DisStream example dis-demo
Copy

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

Package Details

Repository
flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes
This Pulumi package is based on the flexibleengine Terraform Provider.