Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. DisDumpTaskV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.DisDumpTaskV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

    Up-to-date reference of API arguments for DIS dump task you can get at documentation portal

    Manages a DIS Dump Task in the OpenTelekomCloud DIS Service.

    Example Usage

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

const stream1 = new opentelekomcloud.DisStreamV2("stream1", {
    partitionCount: 3,
    streamType: "COMMON",
    retentionPeriod: 24,
    autoScaleMinPartitionCount: 1,
    autoScaleMaxPartitionCount: 4,
    compressionFormat: "zip",
    dataType: "BLOB",
    tags: {
        foo: "bar",
    },
});
const app1 = new opentelekomcloud.DisAppV2("app1", {});
const bucket = new opentelekomcloud.ObsBucket("bucket", {
    bucket: "my-dis-bucket",
    storageClass: "STANDARD",
    acl: "private",
});
const task1 = new opentelekomcloud.DisDumpTaskV2("task1", {
    streamName: stream1.name,
    destination: "OBS",
    obsDestinationDescriptors: [{
        taskName: "my_task",
        agencyName: "dis_admin_agency",
        deliverTimeInterval: 30,
        consumerStrategy: "LATEST",
        filePrefix: "_pf",
        partitionFormat: "yyyy/MM/dd/HH/mm",
        obsBucketPath: bucket.bucket,
        destinationFileType: "text",
        recordDelimiter: "|",
    }],
});

    import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

stream1 = opentelekomcloud.DisStreamV2("stream1",
    partition_count=3,
    stream_type="COMMON",
    retention_period=24,
    auto_scale_min_partition_count=1,
    auto_scale_max_partition_count=4,
    compression_format="zip",
    data_type="BLOB",
    tags={
        "foo": "bar",
    })
app1 = opentelekomcloud.DisAppV2("app1")
bucket = opentelekomcloud.ObsBucket("bucket",
    bucket="my-dis-bucket",
    storage_class="STANDARD",
    acl="private")
task1 = opentelekomcloud.DisDumpTaskV2("task1",
    stream_name=stream1.name,
    destination="OBS",
    obs_destination_descriptors=[{
        "task_name": "my_task",
        "agency_name": "dis_admin_agency",
        "deliver_time_interval": 30,
        "consumer_strategy": "LATEST",
        "file_prefix": "_pf",
        "partition_format": "yyyy/MM/dd/HH/mm",
        "obs_bucket_path": bucket.bucket,
        "destination_file_type": "text",
        "record_delimiter": "|",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		stream1, err := opentelekomcloud.NewDisStreamV2(ctx, "stream1", &opentelekomcloud.DisStreamV2Args{
			PartitionCount:             pulumi.Float64(3),
			StreamType:                 pulumi.String("COMMON"),
			RetentionPeriod:            pulumi.Float64(24),
			AutoScaleMinPartitionCount: pulumi.Float64(1),
			AutoScaleMaxPartitionCount: pulumi.Float64(4),
			CompressionFormat:          pulumi.String("zip"),
			DataType:                   pulumi.String("BLOB"),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewDisAppV2(ctx, "app1", nil)
		if err != nil {
			return err
		}
		bucket, err := opentelekomcloud.NewObsBucket(ctx, "bucket", &opentelekomcloud.ObsBucketArgs{
			Bucket:       pulumi.String("my-dis-bucket"),
			StorageClass: pulumi.String("STANDARD"),
			Acl:          pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewDisDumpTaskV2(ctx, "task1", &opentelekomcloud.DisDumpTaskV2Args{
			StreamName:  stream1.Name,
			Destination: pulumi.String("OBS"),
			ObsDestinationDescriptors: opentelekomcloud.DisDumpTaskV2ObsDestinationDescriptorArray{
				&opentelekomcloud.DisDumpTaskV2ObsDestinationDescriptorArgs{
					TaskName:            pulumi.String("my_task"),
					AgencyName:          pulumi.String("dis_admin_agency"),
					DeliverTimeInterval: pulumi.Float64(30),
					ConsumerStrategy:    pulumi.String("LATEST"),
					FilePrefix:          pulumi.String("_pf"),
					PartitionFormat:     pulumi.String("yyyy/MM/dd/HH/mm"),
					ObsBucketPath:       bucket.Bucket,
					DestinationFileType: pulumi.String("text"),
					RecordDelimiter:     pulumi.String("|"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var stream1 = new Opentelekomcloud.DisStreamV2("stream1", new()
    {
        PartitionCount = 3,
        StreamType = "COMMON",
        RetentionPeriod = 24,
        AutoScaleMinPartitionCount = 1,
        AutoScaleMaxPartitionCount = 4,
        CompressionFormat = "zip",
        DataType = "BLOB",
        Tags = 
        {
            { "foo", "bar" },
        },
    });

    var app1 = new Opentelekomcloud.DisAppV2("app1");

    var bucket = new Opentelekomcloud.ObsBucket("bucket", new()
    {
        Bucket = "my-dis-bucket",
        StorageClass = "STANDARD",
        Acl = "private",
    });

    var task1 = new Opentelekomcloud.DisDumpTaskV2("task1", new()
    {
        StreamName = stream1.Name,
        Destination = "OBS",
        ObsDestinationDescriptors = new[]
        {
            new Opentelekomcloud.Inputs.DisDumpTaskV2ObsDestinationDescriptorArgs
            {
                TaskName = "my_task",
                AgencyName = "dis_admin_agency",
                DeliverTimeInterval = 30,
                ConsumerStrategy = "LATEST",
                FilePrefix = "_pf",
                PartitionFormat = "yyyy/MM/dd/HH/mm",
                ObsBucketPath = bucket.Bucket,
                DestinationFileType = "text",
                RecordDelimiter = "|",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.DisStreamV2;
import com.pulumi.opentelekomcloud.DisStreamV2Args;
import com.pulumi.opentelekomcloud.DisAppV2;
import com.pulumi.opentelekomcloud.ObsBucket;
import com.pulumi.opentelekomcloud.ObsBucketArgs;
import com.pulumi.opentelekomcloud.DisDumpTaskV2;
import com.pulumi.opentelekomcloud.DisDumpTaskV2Args;
import com.pulumi.opentelekomcloud.inputs.DisDumpTaskV2ObsDestinationDescriptorArgs;
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 stream1 = new DisStreamV2("stream1", DisStreamV2Args.builder()
            .partitionCount(3)
            .streamType("COMMON")
            .retentionPeriod(24)
            .autoScaleMinPartitionCount(1)
            .autoScaleMaxPartitionCount(4)
            .compressionFormat("zip")
            .dataType("BLOB")
            .tags(Map.of("foo", "bar"))
            .build());

        var app1 = new DisAppV2("app1");

        var bucket = new ObsBucket("bucket", ObsBucketArgs.builder()
            .bucket("my-dis-bucket")
            .storageClass("STANDARD")
            .acl("private")
            .build());

        var task1 = new DisDumpTaskV2("task1", DisDumpTaskV2Args.builder()
            .streamName(stream1.name())
            .destination("OBS")
            .obsDestinationDescriptors(DisDumpTaskV2ObsDestinationDescriptorArgs.builder()
                .taskName("my_task")
                .agencyName("dis_admin_agency")
                .deliverTimeInterval(30)
                .consumerStrategy("LATEST")
                .filePrefix("_pf")
                .partitionFormat("yyyy/MM/dd/HH/mm")
                .obsBucketPath(bucket.bucket())
                .destinationFileType("text")
                .recordDelimiter("|")
                .build())
            .build());

    }
}

    resources:
  stream1:
    type: opentelekomcloud:DisStreamV2
    properties:
      partitionCount: 3
      streamType: COMMON
      retentionPeriod: 24
      autoScaleMinPartitionCount: 1
      autoScaleMaxPartitionCount: 4
      compressionFormat: zip
      dataType: BLOB
      tags:
        foo: bar
  app1:
    type: opentelekomcloud:DisAppV2
  bucket:
    type: opentelekomcloud:ObsBucket
    properties:
      bucket: my-dis-bucket
      storageClass: STANDARD
      acl: private
  task1:
    type: opentelekomcloud:DisDumpTaskV2
    properties:
      streamName: ${stream1.name}
      destination: OBS
      obsDestinationDescriptors:
        - taskName: my_task
          agencyName: dis_admin_agency
          deliverTimeInterval: 30
          consumerStrategy: LATEST
          filePrefix: _pf
          partitionFormat: yyyy/MM/dd/HH/mm
          obsBucketPath: ${bucket.bucket}
          destinationFileType: text
          recordDelimiter: '|'

    Create DisDumpTaskV2 Resource

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

    Constructor syntax

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

@overload
def DisDumpTaskV2(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  stream_name: Optional[str] = None,
                  action: Optional[str] = None,
                  destination: Optional[str] = None,
                  dis_dump_task_v2_id: Optional[str] = None,
                  obs_destination_descriptors: Optional[Sequence[DisDumpTaskV2ObsDestinationDescriptorArgs]] = None,
                  obs_processing_schemas: Optional[Sequence[DisDumpTaskV2ObsProcessingSchemaArgs]] = None,
                  timeouts: Optional[DisDumpTaskV2TimeoutsArgs] = None)
    func NewDisDumpTaskV2(ctx *Context, name string, args DisDumpTaskV2Args, opts ...ResourceOption) (*DisDumpTaskV2, error)
    public DisDumpTaskV2(string name, DisDumpTaskV2Args args, CustomResourceOptions? opts = null)
    public DisDumpTaskV2(String name, DisDumpTaskV2Args args)
public DisDumpTaskV2(String name, DisDumpTaskV2Args args, CustomResourceOptions options)

    type: opentelekomcloud:DisDumpTaskV2
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 DisDumpTaskV2Args
    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 DisDumpTaskV2Args
    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 DisDumpTaskV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DisDumpTaskV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DisDumpTaskV2Args
    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 disDumpTaskV2Resource = new Opentelekomcloud.DisDumpTaskV2("disDumpTaskV2Resource", new()
{
    StreamName = "string",
    Action = "string",
    Destination = "string",
    DisDumpTaskV2Id = "string",
    ObsDestinationDescriptors = new[]
    {
        new Opentelekomcloud.Inputs.DisDumpTaskV2ObsDestinationDescriptorArgs
        {
            AgencyName = "string",
            DeliverTimeInterval = 0,
            ObsBucketPath = "string",
            TaskName = "string",
            ConsumerStrategy = "string",
            DestinationFileType = "string",
            FilePrefix = "string",
            PartitionFormat = "string",
            RecordDelimiter = "string",
        },
    },
    ObsProcessingSchemas = new[]
    {
        new Opentelekomcloud.Inputs.DisDumpTaskV2ObsProcessingSchemaArgs
        {
            TimestampName = "string",
            TimestampType = "string",
            TimestampFormat = "string",
        },
    },
    Timeouts = new Opentelekomcloud.Inputs.DisDumpTaskV2TimeoutsArgs
    {
        Update = "string",
    },
});

    example, err := opentelekomcloud.NewDisDumpTaskV2(ctx, "disDumpTaskV2Resource", &opentelekomcloud.DisDumpTaskV2Args{
	StreamName:      pulumi.String("string"),
	Action:          pulumi.String("string"),
	Destination:     pulumi.String("string"),
	DisDumpTaskV2Id: pulumi.String("string"),
	ObsDestinationDescriptors: opentelekomcloud.DisDumpTaskV2ObsDestinationDescriptorArray{
		&opentelekomcloud.DisDumpTaskV2ObsDestinationDescriptorArgs{
			AgencyName:          pulumi.String("string"),
			DeliverTimeInterval: pulumi.Float64(0),
			ObsBucketPath:       pulumi.String("string"),
			TaskName:            pulumi.String("string"),
			ConsumerStrategy:    pulumi.String("string"),
			DestinationFileType: pulumi.String("string"),
			FilePrefix:          pulumi.String("string"),
			PartitionFormat:     pulumi.String("string"),
			RecordDelimiter:     pulumi.String("string"),
		},
	},
	ObsProcessingSchemas: opentelekomcloud.DisDumpTaskV2ObsProcessingSchemaArray{
		&opentelekomcloud.DisDumpTaskV2ObsProcessingSchemaArgs{
			TimestampName:   pulumi.String("string"),
			TimestampType:   pulumi.String("string"),
			TimestampFormat: pulumi.String("string"),
		},
	},
	Timeouts: &opentelekomcloud.DisDumpTaskV2TimeoutsArgs{
		Update: pulumi.String("string"),
	},
})

    var disDumpTaskV2Resource = new DisDumpTaskV2("disDumpTaskV2Resource", DisDumpTaskV2Args.builder()
    .streamName("string")
    .action("string")
    .destination("string")
    .disDumpTaskV2Id("string")
    .obsDestinationDescriptors(DisDumpTaskV2ObsDestinationDescriptorArgs.builder()
        .agencyName("string")
        .deliverTimeInterval(0)
        .obsBucketPath("string")
        .taskName("string")
        .consumerStrategy("string")
        .destinationFileType("string")
        .filePrefix("string")
        .partitionFormat("string")
        .recordDelimiter("string")
        .build())
    .obsProcessingSchemas(DisDumpTaskV2ObsProcessingSchemaArgs.builder()
        .timestampName("string")
        .timestampType("string")
        .timestampFormat("string")
        .build())
    .timeouts(DisDumpTaskV2TimeoutsArgs.builder()
        .update("string")
        .build())
    .build());

    dis_dump_task_v2_resource = opentelekomcloud.DisDumpTaskV2("disDumpTaskV2Resource",
    stream_name="string",
    action="string",
    destination="string",
    dis_dump_task_v2_id="string",
    obs_destination_descriptors=[{
        "agency_name": "string",
        "deliver_time_interval": 0,
        "obs_bucket_path": "string",
        "task_name": "string",
        "consumer_strategy": "string",
        "destination_file_type": "string",
        "file_prefix": "string",
        "partition_format": "string",
        "record_delimiter": "string",
    }],
    obs_processing_schemas=[{
        "timestamp_name": "string",
        "timestamp_type": "string",
        "timestamp_format": "string",
    }],
    timeouts={
        "update": "string",
    })

    const disDumpTaskV2Resource = new opentelekomcloud.DisDumpTaskV2("disDumpTaskV2Resource", {
    streamName: "string",
    action: "string",
    destination: "string",
    disDumpTaskV2Id: "string",
    obsDestinationDescriptors: [{
        agencyName: "string",
        deliverTimeInterval: 0,
        obsBucketPath: "string",
        taskName: "string",
        consumerStrategy: "string",
        destinationFileType: "string",
        filePrefix: "string",
        partitionFormat: "string",
        recordDelimiter: "string",
    }],
    obsProcessingSchemas: [{
        timestampName: "string",
        timestampType: "string",
        timestampFormat: "string",
    }],
    timeouts: {
        update: "string",
    },
});

    type: opentelekomcloud:DisDumpTaskV2
properties:
    action: string
    destination: string
    disDumpTaskV2Id: string
    obsDestinationDescriptors:
        - agencyName: string
          consumerStrategy: string
          deliverTimeInterval: 0
          destinationFileType: string
          filePrefix: string
          obsBucketPath: string
          partitionFormat: string
          recordDelimiter: string
          taskName: string
    obsProcessingSchemas:
        - timestampFormat: string
          timestampName: string
          timestampType: string
    streamName: string
    timeouts:
        update: string

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

    StreamName string
    Name of the stream.
    Action string
    Dump task operation. The value can only be start or stop.
    Destination string
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    DisDumpTaskV2Id string
    Unique identifier of the partition.
    ObsDestinationDescriptors List<DisDumpTaskV2ObsDestinationDescriptor>
    Parameter list of OBS to which data in the DIS stream will be dumped.
    ObsProcessingSchemas List<DisDumpTaskV2ObsProcessingSchema>
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    Timeouts DisDumpTaskV2Timeouts
    StreamName string
    Name of the stream.
    Action string
    Dump task operation. The value can only be start or stop.
    Destination string
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    DisDumpTaskV2Id string
    Unique identifier of the partition.
    ObsDestinationDescriptors []DisDumpTaskV2ObsDestinationDescriptorArgs
    Parameter list of OBS to which data in the DIS stream will be dumped.
    ObsProcessingSchemas []DisDumpTaskV2ObsProcessingSchemaArgs
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    Timeouts DisDumpTaskV2TimeoutsArgs
    streamName String
    Name of the stream.
    action String
    Dump task operation. The value can only be start or stop.
    destination String
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    disDumpTaskV2Id String
    Unique identifier of the partition.
    obsDestinationDescriptors List<DisDumpTaskV2ObsDestinationDescriptor>
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obsProcessingSchemas List<DisDumpTaskV2ObsProcessingSchema>
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    timeouts DisDumpTaskV2Timeouts
    streamName string
    Name of the stream.
    action string
    Dump task operation. The value can only be start or stop.
    destination string
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    disDumpTaskV2Id string
    Unique identifier of the partition.
    obsDestinationDescriptors DisDumpTaskV2ObsDestinationDescriptor[]
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obsProcessingSchemas DisDumpTaskV2ObsProcessingSchema[]
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    timeouts DisDumpTaskV2Timeouts
    stream_name str
    Name of the stream.
    action str
    Dump task operation. The value can only be start or stop.
    destination str
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    dis_dump_task_v2_id str
    Unique identifier of the partition.
    obs_destination_descriptors Sequence[DisDumpTaskV2ObsDestinationDescriptorArgs]
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obs_processing_schemas Sequence[DisDumpTaskV2ObsProcessingSchemaArgs]
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    timeouts DisDumpTaskV2TimeoutsArgs
    streamName String
    Name of the stream.
    action String
    Dump task operation. The value can only be start or stop.
    destination String
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    disDumpTaskV2Id String
    Unique identifier of the partition.
    obsDestinationDescriptors List<Property Map>
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obsProcessingSchemas List<Property Map>
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    timeouts Property Map

    Outputs

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

    CreatedAt double
    Time when the dump task is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastTransferTimestamp double
    Latest dump time of the dump task.
    Name string
    Name of the dump task.
    Partitions List<DisDumpTaskV2Partition>
    List of partition dump details.
    Status string
    Current status of the partition.
    TaskId string
    ID of the dump task.
    CreatedAt float64
    Time when the dump task is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastTransferTimestamp float64
    Latest dump time of the dump task.
    Name string
    Name of the dump task.
    Partitions []DisDumpTaskV2Partition
    List of partition dump details.
    Status string
    Current status of the partition.
    TaskId string
    ID of the dump task.
    createdAt Double
    Time when the dump task is created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastTransferTimestamp Double
    Latest dump time of the dump task.
    name String
    Name of the dump task.
    partitions List<DisDumpTaskV2Partition>
    List of partition dump details.
    status String
    Current status of the partition.
    taskId String
    ID of the dump task.
    createdAt number
    Time when the dump task is created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastTransferTimestamp number
    Latest dump time of the dump task.
    name string
    Name of the dump task.
    partitions DisDumpTaskV2Partition[]
    List of partition dump details.
    status string
    Current status of the partition.
    taskId string
    ID of the dump task.
    created_at float
    Time when the dump task is created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_transfer_timestamp float
    Latest dump time of the dump task.
    name str
    Name of the dump task.
    partitions Sequence[DisDumpTaskV2Partition]
    List of partition dump details.
    status str
    Current status of the partition.
    task_id str
    ID of the dump task.
    createdAt Number
    Time when the dump task is created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastTransferTimestamp Number
    Latest dump time of the dump task.
    name String
    Name of the dump task.
    partitions List<Property Map>
    List of partition dump details.
    status String
    Current status of the partition.
    taskId String
    ID of the dump task.

    Look up Existing DisDumpTaskV2 Resource

    Get an existing DisDumpTaskV2 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?: DisDumpTaskV2State, opts?: CustomResourceOptions): DisDumpTaskV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        created_at: Optional[float] = None,
        destination: Optional[str] = None,
        dis_dump_task_v2_id: Optional[str] = None,
        last_transfer_timestamp: Optional[float] = None,
        name: Optional[str] = None,
        obs_destination_descriptors: Optional[Sequence[DisDumpTaskV2ObsDestinationDescriptorArgs]] = None,
        obs_processing_schemas: Optional[Sequence[DisDumpTaskV2ObsProcessingSchemaArgs]] = None,
        partitions: Optional[Sequence[DisDumpTaskV2PartitionArgs]] = None,
        status: Optional[str] = None,
        stream_name: Optional[str] = None,
        task_id: Optional[str] = None,
        timeouts: Optional[DisDumpTaskV2TimeoutsArgs] = None) -> DisDumpTaskV2
    func GetDisDumpTaskV2(ctx *Context, name string, id IDInput, state *DisDumpTaskV2State, opts ...ResourceOption) (*DisDumpTaskV2, error)
    public static DisDumpTaskV2 Get(string name, Input<string> id, DisDumpTaskV2State? state, CustomResourceOptions? opts = null)
    public static DisDumpTaskV2 get(String name, Output<String> id, DisDumpTaskV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:DisDumpTaskV2    get:      id: ${id}
    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:
    Action string
    Dump task operation. The value can only be start or stop.
    CreatedAt double
    Time when the dump task is created.
    Destination string
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    DisDumpTaskV2Id string
    Unique identifier of the partition.
    LastTransferTimestamp double
    Latest dump time of the dump task.
    Name string
    Name of the dump task.
    ObsDestinationDescriptors List<DisDumpTaskV2ObsDestinationDescriptor>
    Parameter list of OBS to which data in the DIS stream will be dumped.
    ObsProcessingSchemas List<DisDumpTaskV2ObsProcessingSchema>
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    Partitions List<DisDumpTaskV2Partition>
    List of partition dump details.
    Status string
    Current status of the partition.
    StreamName string
    Name of the stream.
    TaskId string
    ID of the dump task.
    Timeouts DisDumpTaskV2Timeouts
    Action string
    Dump task operation. The value can only be start or stop.
    CreatedAt float64
    Time when the dump task is created.
    Destination string
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    DisDumpTaskV2Id string
    Unique identifier of the partition.
    LastTransferTimestamp float64
    Latest dump time of the dump task.
    Name string
    Name of the dump task.
    ObsDestinationDescriptors []DisDumpTaskV2ObsDestinationDescriptorArgs
    Parameter list of OBS to which data in the DIS stream will be dumped.
    ObsProcessingSchemas []DisDumpTaskV2ObsProcessingSchemaArgs
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    Partitions []DisDumpTaskV2PartitionArgs
    List of partition dump details.
    Status string
    Current status of the partition.
    StreamName string
    Name of the stream.
    TaskId string
    ID of the dump task.
    Timeouts DisDumpTaskV2TimeoutsArgs
    action String
    Dump task operation. The value can only be start or stop.
    createdAt Double
    Time when the dump task is created.
    destination String
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    disDumpTaskV2Id String
    Unique identifier of the partition.
    lastTransferTimestamp Double
    Latest dump time of the dump task.
    name String
    Name of the dump task.
    obsDestinationDescriptors List<DisDumpTaskV2ObsDestinationDescriptor>
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obsProcessingSchemas List<DisDumpTaskV2ObsProcessingSchema>
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    partitions List<DisDumpTaskV2Partition>
    List of partition dump details.
    status String
    Current status of the partition.
    streamName String
    Name of the stream.
    taskId String
    ID of the dump task.
    timeouts DisDumpTaskV2Timeouts
    action string
    Dump task operation. The value can only be start or stop.
    createdAt number
    Time when the dump task is created.
    destination string
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    disDumpTaskV2Id string
    Unique identifier of the partition.
    lastTransferTimestamp number
    Latest dump time of the dump task.
    name string
    Name of the dump task.
    obsDestinationDescriptors DisDumpTaskV2ObsDestinationDescriptor[]
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obsProcessingSchemas DisDumpTaskV2ObsProcessingSchema[]
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    partitions DisDumpTaskV2Partition[]
    List of partition dump details.
    status string
    Current status of the partition.
    streamName string
    Name of the stream.
    taskId string
    ID of the dump task.
    timeouts DisDumpTaskV2Timeouts
    action str
    Dump task operation. The value can only be start or stop.
    created_at float
    Time when the dump task is created.
    destination str
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    dis_dump_task_v2_id str
    Unique identifier of the partition.
    last_transfer_timestamp float
    Latest dump time of the dump task.
    name str
    Name of the dump task.
    obs_destination_descriptors Sequence[DisDumpTaskV2ObsDestinationDescriptorArgs]
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obs_processing_schemas Sequence[DisDumpTaskV2ObsProcessingSchemaArgs]
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    partitions Sequence[DisDumpTaskV2PartitionArgs]
    List of partition dump details.
    status str
    Current status of the partition.
    stream_name str
    Name of the stream.
    task_id str
    ID of the dump task.
    timeouts DisDumpTaskV2TimeoutsArgs
    action String
    Dump task operation. The value can only be start or stop.
    createdAt Number
    Time when the dump task is created.
    destination String
    Dump destination. Possible values: OBS: Data is dumped to OBS.
    disDumpTaskV2Id String
    Unique identifier of the partition.
    lastTransferTimestamp Number
    Latest dump time of the dump task.
    name String
    Name of the dump task.
    obsDestinationDescriptors List<Property Map>
    Parameter list of OBS to which data in the DIS stream will be dumped.
    obsProcessingSchemas List<Property Map>
    Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.
    partitions List<Property Map>
    List of partition dump details.
    status String
    Current status of the partition.
    streamName String
    Name of the stream.
    taskId String
    ID of the dump task.
    timeouts Property Map

    Supporting Types

    DisDumpTaskV2ObsDestinationDescriptor, DisDumpTaskV2ObsDestinationDescriptorArgs

    AgencyName string
    Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:

    • Agency Type: Cloud service
    • Cloud Service: DIS
    • Validity Period: unlimited
    • Scope: Global service
    • Project: OBS.
    • Select the Tenant Administrator role for the global service project.
    DeliverTimeInterval double
    User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated. Value range: 30-900.
    ObsBucketPath string
    Name of the OBS bucket used to store data from the DIS stream.
    TaskName string
    Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
    ConsumerStrategy string
    Offset. LATEST: Maximum offset, indicating that the latest data will be extracted. TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
    DestinationFileType string
    Dump file format. Possible values: text
    FilePrefix string
    Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
    PartitionFormat string
    Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created). Possible values:
    RecordDelimiter string
    Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
    AgencyName string
    Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:

    • Agency Type: Cloud service
    • Cloud Service: DIS
    • Validity Period: unlimited
    • Scope: Global service
    • Project: OBS.
    • Select the Tenant Administrator role for the global service project.
    DeliverTimeInterval float64
    User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated. Value range: 30-900.
    ObsBucketPath string
    Name of the OBS bucket used to store data from the DIS stream.
    TaskName string
    Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
    ConsumerStrategy string
    Offset. LATEST: Maximum offset, indicating that the latest data will be extracted. TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
    DestinationFileType string
    Dump file format. Possible values: text
    FilePrefix string
    Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
    PartitionFormat string
    Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created). Possible values:
    RecordDelimiter string
    Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
    agencyName String
    Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:

    • Agency Type: Cloud service
    • Cloud Service: DIS
    • Validity Period: unlimited
    • Scope: Global service
    • Project: OBS.
    • Select the Tenant Administrator role for the global service project.
    deliverTimeInterval Double
    User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated. Value range: 30-900.
    obsBucketPath String
    Name of the OBS bucket used to store data from the DIS stream.
    taskName String
    Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
    consumerStrategy String
    Offset. LATEST: Maximum offset, indicating that the latest data will be extracted. TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
    destinationFileType String
    Dump file format. Possible values: text
    filePrefix String
    Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
    partitionFormat String
    Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created). Possible values:
    recordDelimiter String
    Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
    agencyName string
    Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:

    • Agency Type: Cloud service
    • Cloud Service: DIS
    • Validity Period: unlimited
    • Scope: Global service
    • Project: OBS.
    • Select the Tenant Administrator role for the global service project.
    deliverTimeInterval number
    User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated. Value range: 30-900.
    obsBucketPath string
    Name of the OBS bucket used to store data from the DIS stream.
    taskName string
    Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
    consumerStrategy string
    Offset. LATEST: Maximum offset, indicating that the latest data will be extracted. TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
    destinationFileType string
    Dump file format. Possible values: text
    filePrefix string
    Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
    partitionFormat string
    Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created). Possible values:
    recordDelimiter string
    Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
    agency_name str
    Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:

    • Agency Type: Cloud service
    • Cloud Service: DIS
    • Validity Period: unlimited
    • Scope: Global service
    • Project: OBS.
    • Select the Tenant Administrator role for the global service project.
    deliver_time_interval float
    User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated. Value range: 30-900.
    obs_bucket_path str
    Name of the OBS bucket used to store data from the DIS stream.
    task_name str
    Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
    consumer_strategy str
    Offset. LATEST: Maximum offset, indicating that the latest data will be extracted. TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
    destination_file_type str
    Dump file format. Possible values: text
    file_prefix str
    Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
    partition_format str
    Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created). Possible values:
    record_delimiter str
    Delimiter for the dump file, which is used to separate the user data that is written into the dump file.
    agencyName String
    Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:

    • Agency Type: Cloud service
    • Cloud Service: DIS
    • Validity Period: unlimited
    • Scope: Global service
    • Project: OBS.
    • Select the Tenant Administrator role for the global service project.
    deliverTimeInterval Number
    User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated. Value range: 30-900.
    obsBucketPath String
    Name of the OBS bucket used to store data from the DIS stream.
    taskName String
    Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.
    consumerStrategy String
    Offset. LATEST: Maximum offset, indicating that the latest data will be extracted. TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.
    destinationFileType String
    Dump file format. Possible values: text
    filePrefix String
    Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.
    partitionFormat String
    Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created). Possible values:
    recordDelimiter String
    Delimiter for the dump file, which is used to separate the user data that is written into the dump file.

    DisDumpTaskV2ObsProcessingSchema, DisDumpTaskV2ObsProcessingSchemaArgs

    TimestampName string
    Attribute name of the source data timestamp.
    TimestampType string
    Type of the source data timestamp. Possible values:

    • String
    • Timestamp
    TimestampFormat string
    OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.

    • yyyy/MM/dd HH:mm:ss Possible values:
    • MM/dd/yyyy HH:mm:ss
    • dd/MM/yyyy HH:mm:ss
    • yyyy-MM-dd HH:mm:ss
    • MM-dd-yyyy HH:mm:ss
    • dd-MM-yyyy HH:mm:ss
    TimestampName string
    Attribute name of the source data timestamp.
    TimestampType string
    Type of the source data timestamp. Possible values:

    • String
    • Timestamp
    TimestampFormat string
    OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.

    • yyyy/MM/dd HH:mm:ss Possible values:
    • MM/dd/yyyy HH:mm:ss
    • dd/MM/yyyy HH:mm:ss
    • yyyy-MM-dd HH:mm:ss
    • MM-dd-yyyy HH:mm:ss
    • dd-MM-yyyy HH:mm:ss
    timestampName String
    Attribute name of the source data timestamp.
    timestampType String
    Type of the source data timestamp. Possible values:

    • String
    • Timestamp
    timestampFormat String
    OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.

    • yyyy/MM/dd HH:mm:ss Possible values:
    • MM/dd/yyyy HH:mm:ss
    • dd/MM/yyyy HH:mm:ss
    • yyyy-MM-dd HH:mm:ss
    • MM-dd-yyyy HH:mm:ss
    • dd-MM-yyyy HH:mm:ss
    timestampName string
    Attribute name of the source data timestamp.
    timestampType string
    Type of the source data timestamp. Possible values:

    • String
    • Timestamp
    timestampFormat string
    OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.

    • yyyy/MM/dd HH:mm:ss Possible values:
    • MM/dd/yyyy HH:mm:ss
    • dd/MM/yyyy HH:mm:ss
    • yyyy-MM-dd HH:mm:ss
    • MM-dd-yyyy HH:mm:ss
    • dd-MM-yyyy HH:mm:ss
    timestamp_name str
    Attribute name of the source data timestamp.
    timestamp_type str
    Type of the source data timestamp. Possible values:

    • String
    • Timestamp
    timestamp_format str
    OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.

    • yyyy/MM/dd HH:mm:ss Possible values:
    • MM/dd/yyyy HH:mm:ss
    • dd/MM/yyyy HH:mm:ss
    • yyyy-MM-dd HH:mm:ss
    • MM-dd-yyyy HH:mm:ss
    • dd-MM-yyyy HH:mm:ss
    timestampName String
    Attribute name of the source data timestamp.
    timestampType String
    Type of the source data timestamp. Possible values:

    • String
    • Timestamp
    timestampFormat String
    OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.

    • yyyy/MM/dd HH:mm:ss Possible values:
    • MM/dd/yyyy HH:mm:ss
    • dd/MM/yyyy HH:mm:ss
    • yyyy-MM-dd HH:mm:ss
    • MM-dd-yyyy HH:mm:ss
    • dd-MM-yyyy HH:mm:ss

    DisDumpTaskV2Partition, DisDumpTaskV2PartitionArgs

    HashRange string
    Possible value range of the hash key used by the partition.
    Id string
    Unique identifier of the partition.
    ParentPartitions string
    Parent partition.
    SequenceNumberRange string
    Sequence number range of the partition.
    Status string
    Current status of the partition.
    HashRange string
    Possible value range of the hash key used by the partition.
    Id string
    Unique identifier of the partition.
    ParentPartitions string
    Parent partition.
    SequenceNumberRange string
    Sequence number range of the partition.
    Status string
    Current status of the partition.
    hashRange String
    Possible value range of the hash key used by the partition.
    id String
    Unique identifier of the partition.
    parentPartitions String
    Parent partition.
    sequenceNumberRange String
    Sequence number range of the partition.
    status String
    Current status of the partition.
    hashRange string
    Possible value range of the hash key used by the partition.
    id string
    Unique identifier of the partition.
    parentPartitions string
    Parent partition.
    sequenceNumberRange string
    Sequence number range of the partition.
    status string
    Current status of the partition.
    hash_range str
    Possible value range of the hash key used by the partition.
    id str
    Unique identifier of the partition.
    parent_partitions str
    Parent partition.
    sequence_number_range str
    Sequence number range of the partition.
    status str
    Current status of the partition.
    hashRange String
    Possible value range of the hash key used by the partition.
    id String
    Unique identifier of the partition.
    parentPartitions String
    Parent partition.
    sequenceNumberRange String
    Sequence number range of the partition.
    status String
    Current status of the partition.

    DisDumpTaskV2Timeouts, DisDumpTaskV2TimeoutsArgs

    Update string
    Update string
    update String
    update string
    update str
    update String

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
    opentelekomcloud/terraform-provider-opentelekomcloud