Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. EtlTask
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.tls.EtlTask

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage tls etl task

    Example Usage

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

const foo = new volcengine.tls.EtlTask("foo", {
    description: "for-tf-test",
    dslType: "NORMAL",
    enable: true,
    fromTime: 1750649545,
    script: "",
    sourceTopicId: "8ba48bd7-2493-4300-b1d0-cb7xxxxxxx",
    targetResources: [
        {
            alias: "tf-test-1",
            topicId: "b966e41a-d6a6-4999-bd75-39962xxxxxx",
        },
        {
            alias: "tf-test-2",
            topicId: "0ed72ac8-9531-4967-b216-ac3xxxxx",
        },
    ],
    taskType: "Resident",
    toTime: 1750735958,
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.tls.EtlTask("foo",
    description="for-tf-test",
    dsl_type="NORMAL",
    enable=True,
    from_time=1750649545,
    script="",
    source_topic_id="8ba48bd7-2493-4300-b1d0-cb7xxxxxxx",
    target_resources=[
        volcengine.tls.EtlTaskTargetResourceArgs(
            alias="tf-test-1",
            topic_id="b966e41a-d6a6-4999-bd75-39962xxxxxx",
        ),
        volcengine.tls.EtlTaskTargetResourceArgs(
            alias="tf-test-2",
            topic_id="0ed72ac8-9531-4967-b216-ac3xxxxx",
        ),
    ],
    task_type="Resident",
    to_time=1750735958)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.NewEtlTask(ctx, "foo", &tls.EtlTaskArgs{
			Description:   pulumi.String("for-tf-test"),
			DslType:       pulumi.String("NORMAL"),
			Enable:        pulumi.Bool(true),
			FromTime:      pulumi.Int(1750649545),
			Script:        pulumi.String(""),
			SourceTopicId: pulumi.String("8ba48bd7-2493-4300-b1d0-cb7xxxxxxx"),
			TargetResources: tls.EtlTaskTargetResourceArray{
				&tls.EtlTaskTargetResourceArgs{
					Alias:   pulumi.String("tf-test-1"),
					TopicId: pulumi.String("b966e41a-d6a6-4999-bd75-39962xxxxxx"),
				},
				&tls.EtlTaskTargetResourceArgs{
					Alias:   pulumi.String("tf-test-2"),
					TopicId: pulumi.String("0ed72ac8-9531-4967-b216-ac3xxxxx"),
				},
			},
			TaskType: pulumi.String("Resident"),
			ToTime:   pulumi.Int(1750735958),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Tls.EtlTask("foo", new()
    {
        Description = "for-tf-test",
        DslType = "NORMAL",
        Enable = true,
        FromTime = 1750649545,
        Script = "",
        SourceTopicId = "8ba48bd7-2493-4300-b1d0-cb7xxxxxxx",
        TargetResources = new[]
        {
            new Volcengine.Tls.Inputs.EtlTaskTargetResourceArgs
            {
                Alias = "tf-test-1",
                TopicId = "b966e41a-d6a6-4999-bd75-39962xxxxxx",
            },
            new Volcengine.Tls.Inputs.EtlTaskTargetResourceArgs
            {
                Alias = "tf-test-2",
                TopicId = "0ed72ac8-9531-4967-b216-ac3xxxxx",
            },
        },
        TaskType = "Resident",
        ToTime = 1750735958,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.EtlTask;
import com.pulumi.volcengine.tls.EtlTaskArgs;
import com.pulumi.volcengine.tls.inputs.EtlTaskTargetResourceArgs;
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 foo = new EtlTask("foo", EtlTaskArgs.builder()        
            .description("for-tf-test")
            .dslType("NORMAL")
            .enable("true")
            .fromTime(1750649545)
            .script("")
            .sourceTopicId("8ba48bd7-2493-4300-b1d0-cb7xxxxxxx")
            .targetResources(            
                EtlTaskTargetResourceArgs.builder()
                    .alias("tf-test-1")
                    .topicId("b966e41a-d6a6-4999-bd75-39962xxxxxx")
                    .build(),
                EtlTaskTargetResourceArgs.builder()
                    .alias("tf-test-2")
                    .topicId("0ed72ac8-9531-4967-b216-ac3xxxxx")
                    .build())
            .taskType("Resident")
            .toTime(1750735958)
            .build());

    }
}

    resources:
  foo:
    type: volcengine:tls:EtlTask
    properties:
      description: for-tf-test
      dslType: NORMAL
      enable: 'true'
      fromTime: 1.750649545e+09
      script:
      sourceTopicId: 8ba48bd7-2493-4300-b1d0-cb7xxxxxxx
      targetResources:
        - alias: tf-test-1
          topicId: b966e41a-d6a6-4999-bd75-39962xxxxxx
        - alias: tf-test-2
          topicId: 0ed72ac8-9531-4967-b216-ac3xxxxx
      taskType: Resident
      toTime: 1.750735958e+09

    Create EtlTask Resource

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

    Constructor syntax

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

@overload
def EtlTask(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            dsl_type: Optional[str] = None,
            enable: Optional[bool] = None,
            script: Optional[str] = None,
            source_topic_id: Optional[str] = None,
            target_resources: Optional[Sequence[EtlTaskTargetResourceArgs]] = None,
            task_type: Optional[str] = None,
            description: Optional[str] = None,
            from_time: Optional[int] = None,
            name: Optional[str] = None,
            to_time: Optional[int] = None)
    func NewEtlTask(ctx *Context, name string, args EtlTaskArgs, opts ...ResourceOption) (*EtlTask, error)
    public EtlTask(string name, EtlTaskArgs args, CustomResourceOptions? opts = null)
    public EtlTask(String name, EtlTaskArgs args)
public EtlTask(String name, EtlTaskArgs args, CustomResourceOptions options)

    type: volcengine:tls:EtlTask
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 EtlTaskArgs
    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 EtlTaskArgs
    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 EtlTaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EtlTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EtlTaskArgs
    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 etlTaskResource = new Volcengine.Tls.EtlTask("etlTaskResource", new()
{
    DslType = "string",
    Enable = false,
    Script = "string",
    SourceTopicId = "string",
    TargetResources = new[]
    {
        new Volcengine.Tls.Inputs.EtlTaskTargetResourceArgs
        {
            Alias = "string",
            TopicId = "string",
            RoleTrn = "string",
        },
    },
    TaskType = "string",
    Description = "string",
    FromTime = 0,
    Name = "string",
    ToTime = 0,
});

    example, err := tls.NewEtlTask(ctx, "etlTaskResource", &tls.EtlTaskArgs{
	DslType:       pulumi.String("string"),
	Enable:        pulumi.Bool(false),
	Script:        pulumi.String("string"),
	SourceTopicId: pulumi.String("string"),
	TargetResources: tls.EtlTaskTargetResourceArray{
		&tls.EtlTaskTargetResourceArgs{
			Alias:   pulumi.String("string"),
			TopicId: pulumi.String("string"),
			RoleTrn: pulumi.String("string"),
		},
	},
	TaskType:    pulumi.String("string"),
	Description: pulumi.String("string"),
	FromTime:    pulumi.Int(0),
	Name:        pulumi.String("string"),
	ToTime:      pulumi.Int(0),
})

    var etlTaskResource = new EtlTask("etlTaskResource", EtlTaskArgs.builder()
    .dslType("string")
    .enable(false)
    .script("string")
    .sourceTopicId("string")
    .targetResources(EtlTaskTargetResourceArgs.builder()
        .alias("string")
        .topicId("string")
        .roleTrn("string")
        .build())
    .taskType("string")
    .description("string")
    .fromTime(0)
    .name("string")
    .toTime(0)
    .build());

    etl_task_resource = volcengine.tls.EtlTask("etlTaskResource",
    dsl_type="string",
    enable=False,
    script="string",
    source_topic_id="string",
    target_resources=[{
        "alias": "string",
        "topic_id": "string",
        "role_trn": "string",
    }],
    task_type="string",
    description="string",
    from_time=0,
    name="string",
    to_time=0)

    const etlTaskResource = new volcengine.tls.EtlTask("etlTaskResource", {
    dslType: "string",
    enable: false,
    script: "string",
    sourceTopicId: "string",
    targetResources: [{
        alias: "string",
        topicId: "string",
        roleTrn: "string",
    }],
    taskType: "string",
    description: "string",
    fromTime: 0,
    name: "string",
    toTime: 0,
});

    type: volcengine:tls:EtlTask
properties:
    description: string
    dslType: string
    enable: false
    fromTime: 0
    name: string
    script: string
    sourceTopicId: string
    targetResources:
        - alias: string
          roleTrn: string
          topicId: string
    taskType: string
    toTime: 0

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

    DslType string
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Enable bool
    Whether to enable the data processing task.
    Script string
    Processing rules.
    SourceTopicId string
    The log topic where the log to be processed is located.
    TargetResources List<EtlTaskTargetResource>
    Output the relevant information of the target.
    TaskType string
    The task type is fixed as Resident.
    Description string
    A simple description of the data processing task.
    FromTime int
    The start time of the data to be processed.
    Name string
    The name of the processing task.
    ToTime int
    The end time of the data to be processed.
    DslType string
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Enable bool
    Whether to enable the data processing task.
    Script string
    Processing rules.
    SourceTopicId string
    The log topic where the log to be processed is located.
    TargetResources []EtlTaskTargetResourceArgs
    Output the relevant information of the target.
    TaskType string
    The task type is fixed as Resident.
    Description string
    A simple description of the data processing task.
    FromTime int
    The start time of the data to be processed.
    Name string
    The name of the processing task.
    ToTime int
    The end time of the data to be processed.
    dslType String
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable Boolean
    Whether to enable the data processing task.
    script String
    Processing rules.
    sourceTopicId String
    The log topic where the log to be processed is located.
    targetResources List<EtlTaskTargetResource>
    Output the relevant information of the target.
    taskType String
    The task type is fixed as Resident.
    description String
    A simple description of the data processing task.
    fromTime Integer
    The start time of the data to be processed.
    name String
    The name of the processing task.
    toTime Integer
    The end time of the data to be processed.
    dslType string
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable boolean
    Whether to enable the data processing task.
    script string
    Processing rules.
    sourceTopicId string
    The log topic where the log to be processed is located.
    targetResources EtlTaskTargetResource[]
    Output the relevant information of the target.
    taskType string
    The task type is fixed as Resident.
    description string
    A simple description of the data processing task.
    fromTime number
    The start time of the data to be processed.
    name string
    The name of the processing task.
    toTime number
    The end time of the data to be processed.
    dsl_type str
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable bool
    Whether to enable the data processing task.
    script str
    Processing rules.
    source_topic_id str
    The log topic where the log to be processed is located.
    target_resources Sequence[EtlTaskTargetResourceArgs]
    Output the relevant information of the target.
    task_type str
    The task type is fixed as Resident.
    description str
    A simple description of the data processing task.
    from_time int
    The start time of the data to be processed.
    name str
    The name of the processing task.
    to_time int
    The end time of the data to be processed.
    dslType String
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable Boolean
    Whether to enable the data processing task.
    script String
    Processing rules.
    sourceTopicId String
    The log topic where the log to be processed is located.
    targetResources List<Property Map>
    Output the relevant information of the target.
    taskType String
    The task type is fixed as Resident.
    description String
    A simple description of the data processing task.
    fromTime Number
    The start time of the data to be processed.
    name String
    The name of the processing task.
    toTime Number
    The end time of the data to be processed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EtlTask 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 EtlTask Resource

    Get an existing EtlTask 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?: EtlTaskState, opts?: CustomResourceOptions): EtlTask
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dsl_type: Optional[str] = None,
        enable: Optional[bool] = None,
        from_time: Optional[int] = None,
        name: Optional[str] = None,
        script: Optional[str] = None,
        source_topic_id: Optional[str] = None,
        target_resources: Optional[Sequence[EtlTaskTargetResourceArgs]] = None,
        task_type: Optional[str] = None,
        to_time: Optional[int] = None) -> EtlTask
    func GetEtlTask(ctx *Context, name string, id IDInput, state *EtlTaskState, opts ...ResourceOption) (*EtlTask, error)
    public static EtlTask Get(string name, Input<string> id, EtlTaskState? state, CustomResourceOptions? opts = null)
    public static EtlTask get(String name, Output<String> id, EtlTaskState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:tls:EtlTask    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:
    Description string
    A simple description of the data processing task.
    DslType string
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Enable bool
    Whether to enable the data processing task.
    FromTime int
    The start time of the data to be processed.
    Name string
    The name of the processing task.
    Script string
    Processing rules.
    SourceTopicId string
    The log topic where the log to be processed is located.
    TargetResources List<EtlTaskTargetResource>
    Output the relevant information of the target.
    TaskType string
    The task type is fixed as Resident.
    ToTime int
    The end time of the data to be processed.
    Description string
    A simple description of the data processing task.
    DslType string
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Enable bool
    Whether to enable the data processing task.
    FromTime int
    The start time of the data to be processed.
    Name string
    The name of the processing task.
    Script string
    Processing rules.
    SourceTopicId string
    The log topic where the log to be processed is located.
    TargetResources []EtlTaskTargetResourceArgs
    Output the relevant information of the target.
    TaskType string
    The task type is fixed as Resident.
    ToTime int
    The end time of the data to be processed.
    description String
    A simple description of the data processing task.
    dslType String
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable Boolean
    Whether to enable the data processing task.
    fromTime Integer
    The start time of the data to be processed.
    name String
    The name of the processing task.
    script String
    Processing rules.
    sourceTopicId String
    The log topic where the log to be processed is located.
    targetResources List<EtlTaskTargetResource>
    Output the relevant information of the target.
    taskType String
    The task type is fixed as Resident.
    toTime Integer
    The end time of the data to be processed.
    description string
    A simple description of the data processing task.
    dslType string
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable boolean
    Whether to enable the data processing task.
    fromTime number
    The start time of the data to be processed.
    name string
    The name of the processing task.
    script string
    Processing rules.
    sourceTopicId string
    The log topic where the log to be processed is located.
    targetResources EtlTaskTargetResource[]
    Output the relevant information of the target.
    taskType string
    The task type is fixed as Resident.
    toTime number
    The end time of the data to be processed.
    description str
    A simple description of the data processing task.
    dsl_type str
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable bool
    Whether to enable the data processing task.
    from_time int
    The start time of the data to be processed.
    name str
    The name of the processing task.
    script str
    Processing rules.
    source_topic_id str
    The log topic where the log to be processed is located.
    target_resources Sequence[EtlTaskTargetResourceArgs]
    Output the relevant information of the target.
    task_type str
    The task type is fixed as Resident.
    to_time int
    The end time of the data to be processed.
    description String
    A simple description of the data processing task.
    dslType String
    DSL type, fixed as NORMAL. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    enable Boolean
    Whether to enable the data processing task.
    fromTime Number
    The start time of the data to be processed.
    name String
    The name of the processing task.
    script String
    Processing rules.
    sourceTopicId String
    The log topic where the log to be processed is located.
    targetResources List<Property Map>
    Output the relevant information of the target.
    taskType String
    The task type is fixed as Resident.
    toTime Number
    The end time of the data to be processed.

    Supporting Types

    EtlTaskTargetResource, EtlTaskTargetResourceArgs

    Alias string
    Customize the name of the output target, which needs to be used to refer to the output target in the data processing rules.
    TopicId string
    Log topics used for storing processed logs.
    RoleTrn string
    Cross-account authorized character names.
    Alias string
    Customize the name of the output target, which needs to be used to refer to the output target in the data processing rules.
    TopicId string
    Log topics used for storing processed logs.
    RoleTrn string
    Cross-account authorized character names.
    alias String
    Customize the name of the output target, which needs to be used to refer to the output target in the data processing rules.
    topicId String
    Log topics used for storing processed logs.
    roleTrn String
    Cross-account authorized character names.
    alias string
    Customize the name of the output target, which needs to be used to refer to the output target in the data processing rules.
    topicId string
    Log topics used for storing processed logs.
    roleTrn string
    Cross-account authorized character names.
    alias str
    Customize the name of the output target, which needs to be used to refer to the output target in the data processing rules.
    topic_id str
    Log topics used for storing processed logs.
    role_trn str
    Cross-account authorized character names.
    alias String
    Customize the name of the output target, which needs to be used to refer to the output target in the data processing rules.
    topicId String
    Log topics used for storing processed logs.
    roleTrn String
    Cross-account authorized character names.

    Import

    EtlTask can be imported using the id, e.g.

    $ pulumi import volcengine:tls/etlTask:EtlTask default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
    volcengine/pulumi-volcengine