Provides a resource to manage tls download task
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";
const foo = new volcengine.tls.DownloadTask("foo", {
topicId: "3c57a110-399a-43b3-bc3c-5d60e065239a",
taskName: "tf-test-download",
query: "*",
startTime: 1768448896,
endTime: 1768450896,
compression: "gzip",
dataFormat: "json",
limit: 1000000,
sort: "asc",
allowIncomplete: false,
taskType: 1,
logContextInfos: {
source: "your ip",
contextFlow: "1768450893021#4258909d8fc97e7d-286d6d5f6966623c-6943",
packageOffset: 4833728523,
},
});
export const tlsDownloadTaskId = foo.taskId;
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.tls.DownloadTask("foo",
topic_id="3c57a110-399a-43b3-bc3c-5d60e065239a",
task_name="tf-test-download",
query="*",
start_time=1768448896,
end_time=1768450896,
compression="gzip",
data_format="json",
limit=1000000,
sort="asc",
allow_incomplete=False,
task_type=1,
log_context_infos=volcengine.tls.DownloadTaskLogContextInfosArgs(
source="your ip",
context_flow="1768450893021#4258909d8fc97e7d-286d6d5f6966623c-6943",
package_offset=4833728523,
))
pulumi.export("tlsDownloadTaskId", foo.task_id)
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 {
foo, err := tls.NewDownloadTask(ctx, "foo", &tls.DownloadTaskArgs{
TopicId: pulumi.String("3c57a110-399a-43b3-bc3c-5d60e065239a"),
TaskName: pulumi.String("tf-test-download"),
Query: pulumi.String("*"),
StartTime: pulumi.Int(1768448896),
EndTime: pulumi.Int(1768450896),
Compression: pulumi.String("gzip"),
DataFormat: pulumi.String("json"),
Limit: pulumi.Int(1000000),
Sort: pulumi.String("asc"),
AllowIncomplete: pulumi.Bool(false),
TaskType: pulumi.Int(1),
LogContextInfos: &tls.DownloadTaskLogContextInfosArgs{
Source: pulumi.String("your ip"),
ContextFlow: pulumi.String("1768450893021#4258909d8fc97e7d-286d6d5f6966623c-6943"),
PackageOffset: pulumi.Int(4833728523),
},
})
if err != nil {
return err
}
ctx.Export("tlsDownloadTaskId", foo.TaskId)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = new Volcengine.Tls.DownloadTask("foo", new()
{
TopicId = "3c57a110-399a-43b3-bc3c-5d60e065239a",
TaskName = "tf-test-download",
Query = "*",
StartTime = 1768448896,
EndTime = 1768450896,
Compression = "gzip",
DataFormat = "json",
Limit = 1000000,
Sort = "asc",
AllowIncomplete = false,
TaskType = 1,
LogContextInfos = new Volcengine.Tls.Inputs.DownloadTaskLogContextInfosArgs
{
Source = "your ip",
ContextFlow = "1768450893021#4258909d8fc97e7d-286d6d5f6966623c-6943",
PackageOffset = 4833728523,
},
});
return new Dictionary<string, object?>
{
["tlsDownloadTaskId"] = foo.TaskId,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.DownloadTask;
import com.pulumi.volcengine.tls.DownloadTaskArgs;
import com.pulumi.volcengine.tls.inputs.DownloadTaskLogContextInfosArgs;
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 DownloadTask("foo", DownloadTaskArgs.builder()
.topicId("3c57a110-399a-43b3-bc3c-5d60e065239a")
.taskName("tf-test-download")
.query("*")
.startTime(1768448896)
.endTime(1768450896)
.compression("gzip")
.dataFormat("json")
.limit(1000000)
.sort("asc")
.allowIncomplete(false)
.taskType(1)
.logContextInfos(DownloadTaskLogContextInfosArgs.builder()
.source("your ip")
.contextFlow("1768450893021#4258909d8fc97e7d-286d6d5f6966623c-6943")
.packageOffset("4833728523")
.build())
.build());
ctx.export("tlsDownloadTaskId", foo.taskId());
}
}
resources:
foo:
type: volcengine:tls:DownloadTask
properties:
topicId: 3c57a110-399a-43b3-bc3c-5d60e065239a
taskName: tf-test-download
query: '*'
startTime: 1.768448896e+09
endTime: 1.768450896e+09
compression: gzip
dataFormat: json
limit: 1e+06
sort: asc
allowIncomplete: false
taskType: 1
logContextInfos:
source: your ip
contextFlow: 1768450893021#4258909d8fc97e7d-286d6d5f6966623c-6943
packageOffset: '4833728523'
outputs:
tlsDownloadTaskId: ${foo.taskId}
Create DownloadTask Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DownloadTask(name: string, args: DownloadTaskArgs, opts?: CustomResourceOptions);@overload
def DownloadTask(resource_name: str,
args: DownloadTaskArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DownloadTask(resource_name: str,
opts: Optional[ResourceOptions] = None,
end_time: Optional[int] = None,
start_time: Optional[int] = None,
task_name: Optional[str] = None,
task_type: Optional[int] = None,
topic_id: Optional[str] = None,
allow_incomplete: Optional[bool] = None,
compression: Optional[str] = None,
data_format: Optional[str] = None,
limit: Optional[int] = None,
log_context_infos: Optional[DownloadTaskLogContextInfosArgs] = None,
query: Optional[str] = None,
sort: Optional[str] = None)func NewDownloadTask(ctx *Context, name string, args DownloadTaskArgs, opts ...ResourceOption) (*DownloadTask, error)public DownloadTask(string name, DownloadTaskArgs args, CustomResourceOptions? opts = null)
public DownloadTask(String name, DownloadTaskArgs args)
public DownloadTask(String name, DownloadTaskArgs args, CustomResourceOptions options)
type: volcengine:tls:DownloadTask
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 DownloadTaskArgs
- 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 DownloadTaskArgs
- 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 DownloadTaskArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DownloadTaskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DownloadTaskArgs
- 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 downloadTaskResource = new Volcengine.Tls.DownloadTask("downloadTaskResource", new()
{
EndTime = 0,
StartTime = 0,
TaskName = "string",
TaskType = 0,
TopicId = "string",
AllowIncomplete = false,
Compression = "string",
DataFormat = "string",
Limit = 0,
LogContextInfos = new Volcengine.Tls.Inputs.DownloadTaskLogContextInfosArgs
{
ContextFlow = "string",
PackageOffset = 0,
Source = "string",
},
Query = "string",
Sort = "string",
});
example, err := tls.NewDownloadTask(ctx, "downloadTaskResource", &tls.DownloadTaskArgs{
EndTime: pulumi.Int(0),
StartTime: pulumi.Int(0),
TaskName: pulumi.String("string"),
TaskType: pulumi.Int(0),
TopicId: pulumi.String("string"),
AllowIncomplete: pulumi.Bool(false),
Compression: pulumi.String("string"),
DataFormat: pulumi.String("string"),
Limit: pulumi.Int(0),
LogContextInfos: &tls.DownloadTaskLogContextInfosArgs{
ContextFlow: pulumi.String("string"),
PackageOffset: pulumi.Int(0),
Source: pulumi.String("string"),
},
Query: pulumi.String("string"),
Sort: pulumi.String("string"),
})
var downloadTaskResource = new DownloadTask("downloadTaskResource", DownloadTaskArgs.builder()
.endTime(0)
.startTime(0)
.taskName("string")
.taskType(0)
.topicId("string")
.allowIncomplete(false)
.compression("string")
.dataFormat("string")
.limit(0)
.logContextInfos(DownloadTaskLogContextInfosArgs.builder()
.contextFlow("string")
.packageOffset(0)
.source("string")
.build())
.query("string")
.sort("string")
.build());
download_task_resource = volcengine.tls.DownloadTask("downloadTaskResource",
end_time=0,
start_time=0,
task_name="string",
task_type=0,
topic_id="string",
allow_incomplete=False,
compression="string",
data_format="string",
limit=0,
log_context_infos={
"context_flow": "string",
"package_offset": 0,
"source": "string",
},
query="string",
sort="string")
const downloadTaskResource = new volcengine.tls.DownloadTask("downloadTaskResource", {
endTime: 0,
startTime: 0,
taskName: "string",
taskType: 0,
topicId: "string",
allowIncomplete: false,
compression: "string",
dataFormat: "string",
limit: 0,
logContextInfos: {
contextFlow: "string",
packageOffset: 0,
source: "string",
},
query: "string",
sort: "string",
});
type: volcengine:tls:DownloadTask
properties:
allowIncomplete: false
compression: string
dataFormat: string
endTime: 0
limit: 0
logContextInfos:
contextFlow: string
packageOffset: 0
source: string
query: string
sort: string
startTime: 0
taskName: string
taskType: 0
topicId: string
DownloadTask 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 DownloadTask resource accepts the following input properties:
- End
Time int - The end time of the log data to download, in Unix timestamp format.
- Start
Time int - The start time of the log data to download, in Unix timestamp format.
- Task
Name string - The name of the download task.
- Task
Type int - The type of the download task.
- Topic
Id string - The ID of the log topic to which the download task belongs.
- Allow
Incomplete bool - Whether to allow incomplete download.
- Compression string
- The compression format of the downloaded file. Valid values: gzip.
- Data
Format string - The data format of the downloaded file. Valid values: csv, json.
- Limit int
- The maximum number of log entries to download.
- Log
Context DownloadInfos Task Log Context Infos - The info of the log context.
- Query string
- The query statement for the download task.
- Sort string
- The sorting order of the log data. Valid values: asc, desc.
- End
Time int - The end time of the log data to download, in Unix timestamp format.
- Start
Time int - The start time of the log data to download, in Unix timestamp format.
- Task
Name string - The name of the download task.
- Task
Type int - The type of the download task.
- Topic
Id string - The ID of the log topic to which the download task belongs.
- Allow
Incomplete bool - Whether to allow incomplete download.
- Compression string
- The compression format of the downloaded file. Valid values: gzip.
- Data
Format string - The data format of the downloaded file. Valid values: csv, json.
- Limit int
- The maximum number of log entries to download.
- Log
Context DownloadInfos Task Log Context Infos Args - The info of the log context.
- Query string
- The query statement for the download task.
- Sort string
- The sorting order of the log data. Valid values: asc, desc.
- end
Time Integer - The end time of the log data to download, in Unix timestamp format.
- start
Time Integer - The start time of the log data to download, in Unix timestamp format.
- task
Name String - The name of the download task.
- task
Type Integer - The type of the download task.
- topic
Id String - The ID of the log topic to which the download task belongs.
- allow
Incomplete Boolean - Whether to allow incomplete download.
- compression String
- The compression format of the downloaded file. Valid values: gzip.
- data
Format String - The data format of the downloaded file. Valid values: csv, json.
- limit Integer
- The maximum number of log entries to download.
- log
Context DownloadInfos Task Log Context Infos - The info of the log context.
- query String
- The query statement for the download task.
- sort String
- The sorting order of the log data. Valid values: asc, desc.
- end
Time number - The end time of the log data to download, in Unix timestamp format.
- start
Time number - The start time of the log data to download, in Unix timestamp format.
- task
Name string - The name of the download task.
- task
Type number - The type of the download task.
- topic
Id string - The ID of the log topic to which the download task belongs.
- allow
Incomplete boolean - Whether to allow incomplete download.
- compression string
- The compression format of the downloaded file. Valid values: gzip.
- data
Format string - The data format of the downloaded file. Valid values: csv, json.
- limit number
- The maximum number of log entries to download.
- log
Context DownloadInfos Task Log Context Infos - The info of the log context.
- query string
- The query statement for the download task.
- sort string
- The sorting order of the log data. Valid values: asc, desc.
- end_
time int - The end time of the log data to download, in Unix timestamp format.
- start_
time int - The start time of the log data to download, in Unix timestamp format.
- task_
name str - The name of the download task.
- task_
type int - The type of the download task.
- topic_
id str - The ID of the log topic to which the download task belongs.
- allow_
incomplete bool - Whether to allow incomplete download.
- compression str
- The compression format of the downloaded file. Valid values: gzip.
- data_
format str - The data format of the downloaded file. Valid values: csv, json.
- limit int
- The maximum number of log entries to download.
- log_
context_ Downloadinfos Task Log Context Infos Args - The info of the log context.
- query str
- The query statement for the download task.
- sort str
- The sorting order of the log data. Valid values: asc, desc.
- end
Time Number - The end time of the log data to download, in Unix timestamp format.
- start
Time Number - The start time of the log data to download, in Unix timestamp format.
- task
Name String - The name of the download task.
- task
Type Number - The type of the download task.
- topic
Id String - The ID of the log topic to which the download task belongs.
- allow
Incomplete Boolean - Whether to allow incomplete download.
- compression String
- The compression format of the downloaded file. Valid values: gzip.
- data
Format String - The data format of the downloaded file. Valid values: csv, json.
- limit Number
- The maximum number of log entries to download.
- log
Context Property MapInfos - The info of the log context.
- query String
- The query statement for the download task.
- sort String
- The sorting order of the log data. Valid values: asc, desc.
Outputs
All input properties are implicitly available as output properties. Additionally, the DownloadTask resource produces the following output properties:
- Download
Url string - The download URL for the completed task.
- Id string
- The provider-assigned unique ID for this managed resource.
- Task
Id string - The ID of the download task.
- Task
Status string - The status of the download task.
- Download
Url string - The download URL for the completed task.
- Id string
- The provider-assigned unique ID for this managed resource.
- Task
Id string - The ID of the download task.
- Task
Status string - The status of the download task.
- download
Url String - The download URL for the completed task.
- id String
- The provider-assigned unique ID for this managed resource.
- task
Id String - The ID of the download task.
- task
Status String - The status of the download task.
- download
Url string - The download URL for the completed task.
- id string
- The provider-assigned unique ID for this managed resource.
- task
Id string - The ID of the download task.
- task
Status string - The status of the download task.
- download_
url str - The download URL for the completed task.
- id str
- The provider-assigned unique ID for this managed resource.
- task_
id str - The ID of the download task.
- task_
status str - The status of the download task.
- download
Url String - The download URL for the completed task.
- id String
- The provider-assigned unique ID for this managed resource.
- task
Id String - The ID of the download task.
- task
Status String - The status of the download task.
Look up Existing DownloadTask Resource
Get an existing DownloadTask 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?: DownloadTaskState, opts?: CustomResourceOptions): DownloadTask@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_incomplete: Optional[bool] = None,
compression: Optional[str] = None,
data_format: Optional[str] = None,
download_url: Optional[str] = None,
end_time: Optional[int] = None,
limit: Optional[int] = None,
log_context_infos: Optional[DownloadTaskLogContextInfosArgs] = None,
query: Optional[str] = None,
sort: Optional[str] = None,
start_time: Optional[int] = None,
task_id: Optional[str] = None,
task_name: Optional[str] = None,
task_status: Optional[str] = None,
task_type: Optional[int] = None,
topic_id: Optional[str] = None) -> DownloadTaskfunc GetDownloadTask(ctx *Context, name string, id IDInput, state *DownloadTaskState, opts ...ResourceOption) (*DownloadTask, error)public static DownloadTask Get(string name, Input<string> id, DownloadTaskState? state, CustomResourceOptions? opts = null)public static DownloadTask get(String name, Output<String> id, DownloadTaskState state, CustomResourceOptions options)resources: _: type: volcengine:tls:DownloadTask 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.
- Allow
Incomplete bool - Whether to allow incomplete download.
- Compression string
- The compression format of the downloaded file. Valid values: gzip.
- Data
Format string - The data format of the downloaded file. Valid values: csv, json.
- Download
Url string - The download URL for the completed task.
- End
Time int - The end time of the log data to download, in Unix timestamp format.
- Limit int
- The maximum number of log entries to download.
- Log
Context DownloadInfos Task Log Context Infos - The info of the log context.
- Query string
- The query statement for the download task.
- Sort string
- The sorting order of the log data. Valid values: asc, desc.
- Start
Time int - The start time of the log data to download, in Unix timestamp format.
- Task
Id string - The ID of the download task.
- Task
Name string - The name of the download task.
- Task
Status string - The status of the download task.
- Task
Type int - The type of the download task.
- Topic
Id string - The ID of the log topic to which the download task belongs.
- Allow
Incomplete bool - Whether to allow incomplete download.
- Compression string
- The compression format of the downloaded file. Valid values: gzip.
- Data
Format string - The data format of the downloaded file. Valid values: csv, json.
- Download
Url string - The download URL for the completed task.
- End
Time int - The end time of the log data to download, in Unix timestamp format.
- Limit int
- The maximum number of log entries to download.
- Log
Context DownloadInfos Task Log Context Infos Args - The info of the log context.
- Query string
- The query statement for the download task.
- Sort string
- The sorting order of the log data. Valid values: asc, desc.
- Start
Time int - The start time of the log data to download, in Unix timestamp format.
- Task
Id string - The ID of the download task.
- Task
Name string - The name of the download task.
- Task
Status string - The status of the download task.
- Task
Type int - The type of the download task.
- Topic
Id string - The ID of the log topic to which the download task belongs.
- allow
Incomplete Boolean - Whether to allow incomplete download.
- compression String
- The compression format of the downloaded file. Valid values: gzip.
- data
Format String - The data format of the downloaded file. Valid values: csv, json.
- download
Url String - The download URL for the completed task.
- end
Time Integer - The end time of the log data to download, in Unix timestamp format.
- limit Integer
- The maximum number of log entries to download.
- log
Context DownloadInfos Task Log Context Infos - The info of the log context.
- query String
- The query statement for the download task.
- sort String
- The sorting order of the log data. Valid values: asc, desc.
- start
Time Integer - The start time of the log data to download, in Unix timestamp format.
- task
Id String - The ID of the download task.
- task
Name String - The name of the download task.
- task
Status String - The status of the download task.
- task
Type Integer - The type of the download task.
- topic
Id String - The ID of the log topic to which the download task belongs.
- allow
Incomplete boolean - Whether to allow incomplete download.
- compression string
- The compression format of the downloaded file. Valid values: gzip.
- data
Format string - The data format of the downloaded file. Valid values: csv, json.
- download
Url string - The download URL for the completed task.
- end
Time number - The end time of the log data to download, in Unix timestamp format.
- limit number
- The maximum number of log entries to download.
- log
Context DownloadInfos Task Log Context Infos - The info of the log context.
- query string
- The query statement for the download task.
- sort string
- The sorting order of the log data. Valid values: asc, desc.
- start
Time number - The start time of the log data to download, in Unix timestamp format.
- task
Id string - The ID of the download task.
- task
Name string - The name of the download task.
- task
Status string - The status of the download task.
- task
Type number - The type of the download task.
- topic
Id string - The ID of the log topic to which the download task belongs.
- allow_
incomplete bool - Whether to allow incomplete download.
- compression str
- The compression format of the downloaded file. Valid values: gzip.
- data_
format str - The data format of the downloaded file. Valid values: csv, json.
- download_
url str - The download URL for the completed task.
- end_
time int - The end time of the log data to download, in Unix timestamp format.
- limit int
- The maximum number of log entries to download.
- log_
context_ Downloadinfos Task Log Context Infos Args - The info of the log context.
- query str
- The query statement for the download task.
- sort str
- The sorting order of the log data. Valid values: asc, desc.
- start_
time int - The start time of the log data to download, in Unix timestamp format.
- task_
id str - The ID of the download task.
- task_
name str - The name of the download task.
- task_
status str - The status of the download task.
- task_
type int - The type of the download task.
- topic_
id str - The ID of the log topic to which the download task belongs.
- allow
Incomplete Boolean - Whether to allow incomplete download.
- compression String
- The compression format of the downloaded file. Valid values: gzip.
- data
Format String - The data format of the downloaded file. Valid values: csv, json.
- download
Url String - The download URL for the completed task.
- end
Time Number - The end time of the log data to download, in Unix timestamp format.
- limit Number
- The maximum number of log entries to download.
- log
Context Property MapInfos - The info of the log context.
- query String
- The query statement for the download task.
- sort String
- The sorting order of the log data. Valid values: asc, desc.
- start
Time Number - The start time of the log data to download, in Unix timestamp format.
- task
Id String - The ID of the download task.
- task
Name String - The name of the download task.
- task
Status String - The status of the download task.
- task
Type Number - The type of the download task.
- topic
Id String - The ID of the log topic to which the download task belongs.
Supporting Types
DownloadTaskLogContextInfos, DownloadTaskLogContextInfosArgs
- Context
Flow string - The context flow of the log.
- Package
Offset int - The package offset of the log.
- Source string
- The source of the log.
- Context
Flow string - The context flow of the log.
- Package
Offset int - The package offset of the log.
- Source string
- The source of the log.
- context
Flow String - The context flow of the log.
- package
Offset Integer - The package offset of the log.
- source String
- The source of the log.
- context
Flow string - The context flow of the log.
- package
Offset number - The package offset of the log.
- source string
- The source of the log.
- context_
flow str - The context flow of the log.
- package_
offset int - The package offset of the log.
- source str
- The source of the log.
- context
Flow String - The context flow of the log.
- package
Offset Number - The package offset of the log.
- source String
- The source of the log.
Import
tls download task can be imported using the topic_id and task_id, e.g.
$ pulumi import volcengine:tls/downloadTask:DownloadTask default topic-123456:task-1234567890
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
volcengineTerraform Provider.
