1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ClsCosShipper
tencentcloud 1.81.187 published on Monday, Apr 28, 2025 by tencentcloudstack

tencentcloud.ClsCosShipper

Explore with Pulumi AI

Provides a resource to create a cls cos shipper.

Example Usage

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

const info = tencentcloud.getUserInfo({});
const appId = info.then(info => info.appId);
const exampleCosBucket = new tencentcloud.CosBucket("exampleCosBucket", {
    bucket: appId.then(appId => `private-bucket-${appId}`),
    acl: "private",
});
const exampleClsLogset = new tencentcloud.ClsLogset("exampleClsLogset", {
    logsetName: "tf-example",
    tags: {
        createBy: "Terraform",
    },
});
const exampleClsTopic = new tencentcloud.ClsTopic("exampleClsTopic", {
    topicName: "tf-example",
    logsetId: exampleClsLogset.clsLogsetId,
    autoSplit: false,
    maxSplitPartitions: 20,
    partitionCount: 1,
    period: 10,
    storageType: "hot",
    tags: {
        createBy: "Terraform",
    },
});
const exampleClsCosShipper = new tencentcloud.ClsCosShipper("exampleClsCosShipper", {
    bucket: exampleCosBucket.cosBucketId,
    topicId: exampleClsTopic.clsTopicId,
    interval: 300,
    maxSize: 200,
    partition: "/%Y/%m/%d/%H/",
    prefix: "ap-guangzhou-fffsasad-1649734752",
    shipperName: "ap-guangzhou-fffsasad-1649734752",
    compress: {
        format: "lzop",
    },
    content: {
        format: "json",
        json: {
            enableTag: true,
            metaFields: [
                "__FILENAME__",
                "__SOURCE__",
                "__TIMESTAMP__",
            ],
        },
    },
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

info = tencentcloud.get_user_info()
app_id = info.app_id
example_cos_bucket = tencentcloud.CosBucket("exampleCosBucket",
    bucket=f"private-bucket-{app_id}",
    acl="private")
example_cls_logset = tencentcloud.ClsLogset("exampleClsLogset",
    logset_name="tf-example",
    tags={
        "createBy": "Terraform",
    })
example_cls_topic = tencentcloud.ClsTopic("exampleClsTopic",
    topic_name="tf-example",
    logset_id=example_cls_logset.cls_logset_id,
    auto_split=False,
    max_split_partitions=20,
    partition_count=1,
    period=10,
    storage_type="hot",
    tags={
        "createBy": "Terraform",
    })
example_cls_cos_shipper = tencentcloud.ClsCosShipper("exampleClsCosShipper",
    bucket=example_cos_bucket.cos_bucket_id,
    topic_id=example_cls_topic.cls_topic_id,
    interval=300,
    max_size=200,
    partition="/%Y/%m/%d/%H/",
    prefix="ap-guangzhou-fffsasad-1649734752",
    shipper_name="ap-guangzhou-fffsasad-1649734752",
    compress={
        "format": "lzop",
    },
    content={
        "format": "json",
        "json": {
            "enable_tag": True,
            "meta_fields": [
                "__FILENAME__",
                "__SOURCE__",
                "__TIMESTAMP__",
            ],
        },
    })
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		info, err := tencentcloud.GetUserInfo(ctx, &tencentcloud.GetUserInfoArgs{}, nil)
		if err != nil {
			return err
		}
		appId := info.AppId
		exampleCosBucket, err := tencentcloud.NewCosBucket(ctx, "exampleCosBucket", &tencentcloud.CosBucketArgs{
			Bucket: pulumi.Sprintf("private-bucket-%v", appId),
			Acl:    pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		exampleClsLogset, err := tencentcloud.NewClsLogset(ctx, "exampleClsLogset", &tencentcloud.ClsLogsetArgs{
			LogsetName: pulumi.String("tf-example"),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		exampleClsTopic, err := tencentcloud.NewClsTopic(ctx, "exampleClsTopic", &tencentcloud.ClsTopicArgs{
			TopicName:          pulumi.String("tf-example"),
			LogsetId:           exampleClsLogset.ClsLogsetId,
			AutoSplit:          pulumi.Bool(false),
			MaxSplitPartitions: pulumi.Float64(20),
			PartitionCount:     pulumi.Float64(1),
			Period:             pulumi.Float64(10),
			StorageType:        pulumi.String("hot"),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewClsCosShipper(ctx, "exampleClsCosShipper", &tencentcloud.ClsCosShipperArgs{
			Bucket:      exampleCosBucket.CosBucketId,
			TopicId:     exampleClsTopic.ClsTopicId,
			Interval:    pulumi.Float64(300),
			MaxSize:     pulumi.Float64(200),
			Partition:   pulumi.String("/%Y/%m/%d/%H/"),
			Prefix:      pulumi.String("ap-guangzhou-fffsasad-1649734752"),
			ShipperName: pulumi.String("ap-guangzhou-fffsasad-1649734752"),
			Compress: &tencentcloud.ClsCosShipperCompressArgs{
				Format: pulumi.String("lzop"),
			},
			Content: &tencentcloud.ClsCosShipperContentArgs{
				Format: pulumi.String("json"),
				Json: &tencentcloud.ClsCosShipperContentJsonArgs{
					EnableTag: pulumi.Bool(true),
					MetaFields: pulumi.StringArray{
						pulumi.String("__FILENAME__"),
						pulumi.String("__SOURCE__"),
						pulumi.String("__TIMESTAMP__"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var info = Tencentcloud.GetUserInfo.Invoke();

    var appId = info.Apply(getUserInfoResult => getUserInfoResult.AppId);

    var exampleCosBucket = new Tencentcloud.CosBucket("exampleCosBucket", new()
    {
        Bucket = appId.Apply(appId => $"private-bucket-{appId}"),
        Acl = "private",
    });

    var exampleClsLogset = new Tencentcloud.ClsLogset("exampleClsLogset", new()
    {
        LogsetName = "tf-example",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

    var exampleClsTopic = new Tencentcloud.ClsTopic("exampleClsTopic", new()
    {
        TopicName = "tf-example",
        LogsetId = exampleClsLogset.ClsLogsetId,
        AutoSplit = false,
        MaxSplitPartitions = 20,
        PartitionCount = 1,
        Period = 10,
        StorageType = "hot",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

    var exampleClsCosShipper = new Tencentcloud.ClsCosShipper("exampleClsCosShipper", new()
    {
        Bucket = exampleCosBucket.CosBucketId,
        TopicId = exampleClsTopic.ClsTopicId,
        Interval = 300,
        MaxSize = 200,
        Partition = "/%Y/%m/%d/%H/",
        Prefix = "ap-guangzhou-fffsasad-1649734752",
        ShipperName = "ap-guangzhou-fffsasad-1649734752",
        Compress = new Tencentcloud.Inputs.ClsCosShipperCompressArgs
        {
            Format = "lzop",
        },
        Content = new Tencentcloud.Inputs.ClsCosShipperContentArgs
        {
            Format = "json",
            Json = new Tencentcloud.Inputs.ClsCosShipperContentJsonArgs
            {
                EnableTag = true,
                MetaFields = new[]
                {
                    "__FILENAME__",
                    "__SOURCE__",
                    "__TIMESTAMP__",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetUserInfoArgs;
import com.pulumi.tencentcloud.CosBucket;
import com.pulumi.tencentcloud.CosBucketArgs;
import com.pulumi.tencentcloud.ClsLogset;
import com.pulumi.tencentcloud.ClsLogsetArgs;
import com.pulumi.tencentcloud.ClsTopic;
import com.pulumi.tencentcloud.ClsTopicArgs;
import com.pulumi.tencentcloud.ClsCosShipper;
import com.pulumi.tencentcloud.ClsCosShipperArgs;
import com.pulumi.tencentcloud.inputs.ClsCosShipperCompressArgs;
import com.pulumi.tencentcloud.inputs.ClsCosShipperContentArgs;
import com.pulumi.tencentcloud.inputs.ClsCosShipperContentJsonArgs;
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) {
        final var info = TencentcloudFunctions.getUserInfo();

        final var appId = info.applyValue(getUserInfoResult -> getUserInfoResult.appId());

        var exampleCosBucket = new CosBucket("exampleCosBucket", CosBucketArgs.builder()
            .bucket(String.format("private-bucket-%s", appId))
            .acl("private")
            .build());

        var exampleClsLogset = new ClsLogset("exampleClsLogset", ClsLogsetArgs.builder()
            .logsetName("tf-example")
            .tags(Map.of("createBy", "Terraform"))
            .build());

        var exampleClsTopic = new ClsTopic("exampleClsTopic", ClsTopicArgs.builder()
            .topicName("tf-example")
            .logsetId(exampleClsLogset.clsLogsetId())
            .autoSplit(false)
            .maxSplitPartitions(20)
            .partitionCount(1)
            .period(10)
            .storageType("hot")
            .tags(Map.of("createBy", "Terraform"))
            .build());

        var exampleClsCosShipper = new ClsCosShipper("exampleClsCosShipper", ClsCosShipperArgs.builder()
            .bucket(exampleCosBucket.cosBucketId())
            .topicId(exampleClsTopic.clsTopicId())
            .interval(300)
            .maxSize(200)
            .partition("/%Y/%m/%d/%H/")
            .prefix("ap-guangzhou-fffsasad-1649734752")
            .shipperName("ap-guangzhou-fffsasad-1649734752")
            .compress(ClsCosShipperCompressArgs.builder()
                .format("lzop")
                .build())
            .content(ClsCosShipperContentArgs.builder()
                .format("json")
                .json(ClsCosShipperContentJsonArgs.builder()
                    .enableTag(true)
                    .metaFields(                    
                        "__FILENAME__",
                        "__SOURCE__",
                        "__TIMESTAMP__")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  exampleCosBucket:
    type: tencentcloud:CosBucket
    properties:
      bucket: private-bucket-${appId}
      acl: private
  exampleClsLogset:
    type: tencentcloud:ClsLogset
    properties:
      logsetName: tf-example
      tags:
        createBy: Terraform
  exampleClsTopic:
    type: tencentcloud:ClsTopic
    properties:
      topicName: tf-example
      logsetId: ${exampleClsLogset.clsLogsetId}
      autoSplit: false
      maxSplitPartitions: 20
      partitionCount: 1
      period: 10
      storageType: hot
      tags:
        createBy: Terraform
  exampleClsCosShipper:
    type: tencentcloud:ClsCosShipper
    properties:
      bucket: ${exampleCosBucket.cosBucketId}
      topicId: ${exampleClsTopic.clsTopicId}
      interval: 300
      maxSize: 200
      partition: /%Y/%m/%d/%H/
      prefix: ap-guangzhou-fffsasad-1649734752
      shipperName: ap-guangzhou-fffsasad-1649734752
      compress:
        format: lzop
      content:
        format: json
        json:
          enableTag: true
          metaFields:
            - __FILENAME__
            - __SOURCE__
            - __TIMESTAMP__
variables:
  info:
    fn::invoke:
      function: tencentcloud:getUserInfo
      arguments: {}
  appId: ${info.appId}
Copy

Create ClsCosShipper Resource

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

Constructor syntax

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

@overload
def ClsCosShipper(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  bucket: Optional[str] = None,
                  topic_id: Optional[str] = None,
                  shipper_name: Optional[str] = None,
                  prefix: Optional[str] = None,
                  filter_rules: Optional[Sequence[ClsCosShipperFilterRuleArgs]] = None,
                  filename_mode: Optional[float] = None,
                  end_time: Optional[float] = None,
                  interval: Optional[float] = None,
                  max_size: Optional[float] = None,
                  partition: Optional[str] = None,
                  content: Optional[ClsCosShipperContentArgs] = None,
                  compress: Optional[ClsCosShipperCompressArgs] = None,
                  start_time: Optional[float] = None,
                  storage_type: Optional[str] = None,
                  cls_cos_shipper_id: Optional[str] = None)
func NewClsCosShipper(ctx *Context, name string, args ClsCosShipperArgs, opts ...ResourceOption) (*ClsCosShipper, error)
public ClsCosShipper(string name, ClsCosShipperArgs args, CustomResourceOptions? opts = null)
public ClsCosShipper(String name, ClsCosShipperArgs args)
public ClsCosShipper(String name, ClsCosShipperArgs args, CustomResourceOptions options)
type: tencentcloud:ClsCosShipper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClsCosShipperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClsCosShipperArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClsCosShipperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClsCosShipperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClsCosShipperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Bucket This property is required. string
Destination bucket in the shipping rule to be created.
Prefix This property is required. string
Prefix of the shipping directory in the shipping rule to be created.
ShipperName This property is required. string
Shipping rule name.
TopicId This property is required. string
ID of the log topic to which the shipping rule to be created belongs.
ClsCosShipperId string
ID of the resource.
Compress ClsCosShipperCompress
Compression configuration of shipped log.
Content ClsCosShipperContent
Format configuration of shipped log content.
EndTime double
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
FilenameMode double
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
FilterRules List<ClsCosShipperFilterRule>
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
Interval double
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
MaxSize double
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
Partition string
Partition rule of shipped log, which can be represented in strftime time format.
StartTime double
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
StorageType string
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
Bucket This property is required. string
Destination bucket in the shipping rule to be created.
Prefix This property is required. string
Prefix of the shipping directory in the shipping rule to be created.
ShipperName This property is required. string
Shipping rule name.
TopicId This property is required. string
ID of the log topic to which the shipping rule to be created belongs.
ClsCosShipperId string
ID of the resource.
Compress ClsCosShipperCompressArgs
Compression configuration of shipped log.
Content ClsCosShipperContentArgs
Format configuration of shipped log content.
EndTime float64
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
FilenameMode float64
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
FilterRules []ClsCosShipperFilterRuleArgs
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
Interval float64
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
MaxSize float64
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
Partition string
Partition rule of shipped log, which can be represented in strftime time format.
StartTime float64
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
StorageType string
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
bucket This property is required. String
Destination bucket in the shipping rule to be created.
prefix This property is required. String
Prefix of the shipping directory in the shipping rule to be created.
shipperName This property is required. String
Shipping rule name.
topicId This property is required. String
ID of the log topic to which the shipping rule to be created belongs.
clsCosShipperId String
ID of the resource.
compress ClsCosShipperCompress
Compression configuration of shipped log.
content ClsCosShipperContent
Format configuration of shipped log content.
endTime Double
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filenameMode Double
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filterRules List<ClsCosShipperFilterRule>
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval Double
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
maxSize Double
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition String
Partition rule of shipped log, which can be represented in strftime time format.
startTime Double
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storageType String
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
bucket This property is required. string
Destination bucket in the shipping rule to be created.
prefix This property is required. string
Prefix of the shipping directory in the shipping rule to be created.
shipperName This property is required. string
Shipping rule name.
topicId This property is required. string
ID of the log topic to which the shipping rule to be created belongs.
clsCosShipperId string
ID of the resource.
compress ClsCosShipperCompress
Compression configuration of shipped log.
content ClsCosShipperContent
Format configuration of shipped log content.
endTime number
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filenameMode number
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filterRules ClsCosShipperFilterRule[]
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval number
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
maxSize number
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition string
Partition rule of shipped log, which can be represented in strftime time format.
startTime number
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storageType string
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
bucket This property is required. str
Destination bucket in the shipping rule to be created.
prefix This property is required. str
Prefix of the shipping directory in the shipping rule to be created.
shipper_name This property is required. str
Shipping rule name.
topic_id This property is required. str
ID of the log topic to which the shipping rule to be created belongs.
cls_cos_shipper_id str
ID of the resource.
compress ClsCosShipperCompressArgs
Compression configuration of shipped log.
content ClsCosShipperContentArgs
Format configuration of shipped log content.
end_time float
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filename_mode float
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filter_rules Sequence[ClsCosShipperFilterRuleArgs]
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval float
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
max_size float
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition str
Partition rule of shipped log, which can be represented in strftime time format.
start_time float
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storage_type str
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
bucket This property is required. String
Destination bucket in the shipping rule to be created.
prefix This property is required. String
Prefix of the shipping directory in the shipping rule to be created.
shipperName This property is required. String
Shipping rule name.
topicId This property is required. String
ID of the log topic to which the shipping rule to be created belongs.
clsCosShipperId String
ID of the resource.
compress Property Map
Compression configuration of shipped log.
content Property Map
Format configuration of shipped log content.
endTime Number
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filenameMode Number
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filterRules List<Property Map>
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval Number
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
maxSize Number
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition String
Partition rule of shipped log, which can be represented in strftime time format.
startTime Number
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storageType String
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.

Outputs

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

Get an existing ClsCosShipper 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?: ClsCosShipperState, opts?: CustomResourceOptions): ClsCosShipper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        cls_cos_shipper_id: Optional[str] = None,
        compress: Optional[ClsCosShipperCompressArgs] = None,
        content: Optional[ClsCosShipperContentArgs] = None,
        end_time: Optional[float] = None,
        filename_mode: Optional[float] = None,
        filter_rules: Optional[Sequence[ClsCosShipperFilterRuleArgs]] = None,
        interval: Optional[float] = None,
        max_size: Optional[float] = None,
        partition: Optional[str] = None,
        prefix: Optional[str] = None,
        shipper_name: Optional[str] = None,
        start_time: Optional[float] = None,
        storage_type: Optional[str] = None,
        topic_id: Optional[str] = None) -> ClsCosShipper
func GetClsCosShipper(ctx *Context, name string, id IDInput, state *ClsCosShipperState, opts ...ResourceOption) (*ClsCosShipper, error)
public static ClsCosShipper Get(string name, Input<string> id, ClsCosShipperState? state, CustomResourceOptions? opts = null)
public static ClsCosShipper get(String name, Output<String> id, ClsCosShipperState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:ClsCosShipper    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Bucket string
Destination bucket in the shipping rule to be created.
ClsCosShipperId string
ID of the resource.
Compress ClsCosShipperCompress
Compression configuration of shipped log.
Content ClsCosShipperContent
Format configuration of shipped log content.
EndTime double
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
FilenameMode double
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
FilterRules List<ClsCosShipperFilterRule>
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
Interval double
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
MaxSize double
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
Partition string
Partition rule of shipped log, which can be represented in strftime time format.
Prefix string
Prefix of the shipping directory in the shipping rule to be created.
ShipperName string
Shipping rule name.
StartTime double
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
StorageType string
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
TopicId string
ID of the log topic to which the shipping rule to be created belongs.
Bucket string
Destination bucket in the shipping rule to be created.
ClsCosShipperId string
ID of the resource.
Compress ClsCosShipperCompressArgs
Compression configuration of shipped log.
Content ClsCosShipperContentArgs
Format configuration of shipped log content.
EndTime float64
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
FilenameMode float64
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
FilterRules []ClsCosShipperFilterRuleArgs
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
Interval float64
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
MaxSize float64
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
Partition string
Partition rule of shipped log, which can be represented in strftime time format.
Prefix string
Prefix of the shipping directory in the shipping rule to be created.
ShipperName string
Shipping rule name.
StartTime float64
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
StorageType string
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
TopicId string
ID of the log topic to which the shipping rule to be created belongs.
bucket String
Destination bucket in the shipping rule to be created.
clsCosShipperId String
ID of the resource.
compress ClsCosShipperCompress
Compression configuration of shipped log.
content ClsCosShipperContent
Format configuration of shipped log content.
endTime Double
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filenameMode Double
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filterRules List<ClsCosShipperFilterRule>
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval Double
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
maxSize Double
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition String
Partition rule of shipped log, which can be represented in strftime time format.
prefix String
Prefix of the shipping directory in the shipping rule to be created.
shipperName String
Shipping rule name.
startTime Double
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storageType String
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
topicId String
ID of the log topic to which the shipping rule to be created belongs.
bucket string
Destination bucket in the shipping rule to be created.
clsCosShipperId string
ID of the resource.
compress ClsCosShipperCompress
Compression configuration of shipped log.
content ClsCosShipperContent
Format configuration of shipped log content.
endTime number
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filenameMode number
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filterRules ClsCosShipperFilterRule[]
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval number
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
maxSize number
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition string
Partition rule of shipped log, which can be represented in strftime time format.
prefix string
Prefix of the shipping directory in the shipping rule to be created.
shipperName string
Shipping rule name.
startTime number
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storageType string
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
topicId string
ID of the log topic to which the shipping rule to be created belongs.
bucket str
Destination bucket in the shipping rule to be created.
cls_cos_shipper_id str
ID of the resource.
compress ClsCosShipperCompressArgs
Compression configuration of shipped log.
content ClsCosShipperContentArgs
Format configuration of shipped log content.
end_time float
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filename_mode float
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filter_rules Sequence[ClsCosShipperFilterRuleArgs]
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval float
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
max_size float
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition str
Partition rule of shipped log, which can be represented in strftime time format.
prefix str
Prefix of the shipping directory in the shipping rule to be created.
shipper_name str
Shipping rule name.
start_time float
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storage_type str
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
topic_id str
ID of the log topic to which the shipping rule to be created belongs.
bucket String
Destination bucket in the shipping rule to be created.
clsCosShipperId String
ID of the resource.
compress Property Map
Compression configuration of shipped log.
content Property Map
Format configuration of shipped log content.
endTime Number
End time for data shipping, which cannot be set to a future time. If you do not specify this parameter, it indicates continuous data shipping.
filenameMode Number
Naming a shipping file. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.
filterRules List<Property Map>
Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
interval Number
Shipping time interval in seconds. Default value: 300. Value range: 300~900.
maxSize Number
Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256.
partition String
Partition rule of shipped log, which can be represented in strftime time format.
prefix String
Prefix of the shipping directory in the shipping rule to be created.
shipperName String
Shipping rule name.
startTime Number
Start time for data shipping, which cannot be earlier than the lifecycle start time of the log topic. If you do not specify this parameter, it will be set to the time when you create the data shipping task.
storageType String
COS bucket storage type. support: STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, STANDARD, MAZ_STANDARD, MAZ_STANDARD_IA, INTELLIGENT_TIERING.
topicId String
ID of the log topic to which the shipping rule to be created belongs.

Supporting Types

ClsCosShipperCompress
, ClsCosShipperCompressArgs

Format This property is required. string
Compression format. Valid values: gzip, lzop, none (no compression).
Format This property is required. string
Compression format. Valid values: gzip, lzop, none (no compression).
format This property is required. String
Compression format. Valid values: gzip, lzop, none (no compression).
format This property is required. string
Compression format. Valid values: gzip, lzop, none (no compression).
format This property is required. str
Compression format. Valid values: gzip, lzop, none (no compression).
format This property is required. String
Compression format. Valid values: gzip, lzop, none (no compression).

ClsCosShipperContent
, ClsCosShipperContentArgs

Format This property is required. string
Content format. Valid values: json, csv.
Csv ClsCosShipperContentCsv
CSV format content description.Note: this field may return null, indicating that no valid values can be obtained.
Json ClsCosShipperContentJson
JSON format content description.Note: this field may return null, indicating that no valid values can be obtained.
Format This property is required. string
Content format. Valid values: json, csv.
Csv ClsCosShipperContentCsv
CSV format content description.Note: this field may return null, indicating that no valid values can be obtained.
Json ClsCosShipperContentJson
JSON format content description.Note: this field may return null, indicating that no valid values can be obtained.
format This property is required. String
Content format. Valid values: json, csv.
csv ClsCosShipperContentCsv
CSV format content description.Note: this field may return null, indicating that no valid values can be obtained.
json ClsCosShipperContentJson
JSON format content description.Note: this field may return null, indicating that no valid values can be obtained.
format This property is required. string
Content format. Valid values: json, csv.
csv ClsCosShipperContentCsv
CSV format content description.Note: this field may return null, indicating that no valid values can be obtained.
json ClsCosShipperContentJson
JSON format content description.Note: this field may return null, indicating that no valid values can be obtained.
format This property is required. str
Content format. Valid values: json, csv.
csv ClsCosShipperContentCsv
CSV format content description.Note: this field may return null, indicating that no valid values can be obtained.
json ClsCosShipperContentJson
JSON format content description.Note: this field may return null, indicating that no valid values can be obtained.
format This property is required. String
Content format. Valid values: json, csv.
csv Property Map
CSV format content description.Note: this field may return null, indicating that no valid values can be obtained.
json Property Map
JSON format content description.Note: this field may return null, indicating that no valid values can be obtained.

ClsCosShipperContentCsv
, ClsCosShipperContentCsvArgs

Delimiter This property is required. string
Field delimiter.
EscapeChar This property is required. string
Field delimiter.
Keys This property is required. List<string>
Names of keys.Note: this field may return null, indicating that no valid values can be obtained.
NonExistingField This property is required. string
Content used to populate non-existing fields.
PrintKey This property is required. bool
Whether to print key on the first row of the CSV file.
Delimiter This property is required. string
Field delimiter.
EscapeChar This property is required. string
Field delimiter.
Keys This property is required. []string
Names of keys.Note: this field may return null, indicating that no valid values can be obtained.
NonExistingField This property is required. string
Content used to populate non-existing fields.
PrintKey This property is required. bool
Whether to print key on the first row of the CSV file.
delimiter This property is required. String
Field delimiter.
escapeChar This property is required. String
Field delimiter.
keys This property is required. List<String>
Names of keys.Note: this field may return null, indicating that no valid values can be obtained.
nonExistingField This property is required. String
Content used to populate non-existing fields.
printKey This property is required. Boolean
Whether to print key on the first row of the CSV file.
delimiter This property is required. string
Field delimiter.
escapeChar This property is required. string
Field delimiter.
keys This property is required. string[]
Names of keys.Note: this field may return null, indicating that no valid values can be obtained.
nonExistingField This property is required. string
Content used to populate non-existing fields.
printKey This property is required. boolean
Whether to print key on the first row of the CSV file.
delimiter This property is required. str
Field delimiter.
escape_char This property is required. str
Field delimiter.
keys This property is required. Sequence[str]
Names of keys.Note: this field may return null, indicating that no valid values can be obtained.
non_existing_field This property is required. str
Content used to populate non-existing fields.
print_key This property is required. bool
Whether to print key on the first row of the CSV file.
delimiter This property is required. String
Field delimiter.
escapeChar This property is required. String
Field delimiter.
keys This property is required. List<String>
Names of keys.Note: this field may return null, indicating that no valid values can be obtained.
nonExistingField This property is required. String
Content used to populate non-existing fields.
printKey This property is required. Boolean
Whether to print key on the first row of the CSV file.

ClsCosShipperContentJson
, ClsCosShipperContentJsonArgs

EnableTag This property is required. bool
Enablement flag.
MetaFields This property is required. List<string>
Metadata information list Note: this field may return null, indicating that no valid values can be obtained..
EnableTag This property is required. bool
Enablement flag.
MetaFields This property is required. []string
Metadata information list Note: this field may return null, indicating that no valid values can be obtained..
enableTag This property is required. Boolean
Enablement flag.
metaFields This property is required. List<String>
Metadata information list Note: this field may return null, indicating that no valid values can be obtained..
enableTag This property is required. boolean
Enablement flag.
metaFields This property is required. string[]
Metadata information list Note: this field may return null, indicating that no valid values can be obtained..
enable_tag This property is required. bool
Enablement flag.
meta_fields This property is required. Sequence[str]
Metadata information list Note: this field may return null, indicating that no valid values can be obtained..
enableTag This property is required. Boolean
Enablement flag.
metaFields This property is required. List<String>
Metadata information list Note: this field may return null, indicating that no valid values can be obtained..

ClsCosShipperFilterRule
, ClsCosShipperFilterRuleArgs

Key This property is required. string
Filter rule key.
Regex This property is required. string
Filter rule.
Value This property is required. string
Filter rule value.
Key This property is required. string
Filter rule key.
Regex This property is required. string
Filter rule.
Value This property is required. string
Filter rule value.
key This property is required. String
Filter rule key.
regex This property is required. String
Filter rule.
value This property is required. String
Filter rule value.
key This property is required. string
Filter rule key.
regex This property is required. string
Filter rule.
value This property is required. string
Filter rule value.
key This property is required. str
Filter rule key.
regex This property is required. str
Filter rule.
value This property is required. str
Filter rule value.
key This property is required. String
Filter rule key.
regex This property is required. String
Filter rule.
value This property is required. String
Filter rule value.

Import

cls cos shipper can be imported using the id, e.g.

$ pulumi import tencentcloud:index/clsCosShipper:ClsCosShipper example 5d1b7b2a-c163-4c48-bb01-9ee00584d761
Copy

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

Package Details

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