Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

OssShipper

Log service data delivery management, this service provides the function of delivering data in logstore to oss product storage. Refer to details.

NOTE: Available in 1.121.0+

Example Usage

Basic Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleProject = new AliCloud.Log.Project("exampleProject", new AliCloud.Log.ProjectArgs
        {
            Description = "created by terraform",
            Tags = 
            {
                { "test", "test" },
            },
        });
        var exampleStore = new AliCloud.Log.Store("exampleStore", new AliCloud.Log.StoreArgs
        {
            Project = exampleProject.Name,
            RetentionPeriod = 3650,
            ShardCount = 3,
            AutoSplit = true,
            MaxSplitShardCount = 60,
            AppendMeta = true,
        });
        var exampleOssShipper = new AliCloud.Log.OssShipper("exampleOssShipper", new AliCloud.Log.OssShipperArgs
        {
            ProjectName = exampleProject.Name,
            LogstoreName = exampleStore.Name,
            ShipperName = "oss_shipper_name",
            OssBucket = "test_bucket",
            OssPrefix = "root",
            BufferInterval = 300,
            BufferSize = 250,
            CompressType = "none",
            PathFormat = "%Y/%m/%d/%H/%M",
            Format = "json",
            JsonEnableTag = true,
        });
    }

}
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/log"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := log.NewProject(ctx, "exampleProject", &log.ProjectArgs{
			Description: pulumi.String("created by terraform"),
			Tags: pulumi.AnyMap{
				"test": pulumi.Any("test"),
			},
		})
		if err != nil {
			return err
		}
		exampleStore, err := log.NewStore(ctx, "exampleStore", &log.StoreArgs{
			Project:            exampleProject.Name,
			RetentionPeriod:    pulumi.Int(3650),
			ShardCount:         pulumi.Int(3),
			AutoSplit:          pulumi.Bool(true),
			MaxSplitShardCount: pulumi.Int(60),
			AppendMeta:         pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = log.NewOssShipper(ctx, "exampleOssShipper", &log.OssShipperArgs{
			ProjectName:    exampleProject.Name,
			LogstoreName:   exampleStore.Name,
			ShipperName:    pulumi.String("oss_shipper_name"),
			OssBucket:      pulumi.String("test_bucket"),
			OssPrefix:      pulumi.String("root"),
			BufferInterval: pulumi.Int(300),
			BufferSize:     pulumi.Int(250),
			CompressType:   pulumi.String("none"),
			PathFormat:     pulumi.String(fmt.Sprintf("%vY/%vm/%vd/%vH/%vM", "%", "%", "%", "%", "%")),
			Format:         pulumi.String("json"),
			JsonEnableTag:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.log.Project;
import com.pulumi.alicloud.log.ProjectArgs;
import com.pulumi.alicloud.log.Store;
import com.pulumi.alicloud.log.StoreArgs;
import com.pulumi.alicloud.log.OssShipper;
import com.pulumi.alicloud.log.OssShipperArgs;
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 exampleProject = new Project("exampleProject", ProjectArgs.builder()        
            .description("created by terraform")
            .tags(Map.of("test", "test"))
            .build());

        var exampleStore = new Store("exampleStore", StoreArgs.builder()        
            .project(exampleProject.name())
            .retentionPeriod(3650)
            .shardCount(3)
            .autoSplit(true)
            .maxSplitShardCount(60)
            .appendMeta(true)
            .build());

        var exampleOssShipper = new OssShipper("exampleOssShipper", OssShipperArgs.builder()        
            .projectName(exampleProject.name())
            .logstoreName(exampleStore.name())
            .shipperName("oss_shipper_name")
            .ossBucket("test_bucket")
            .ossPrefix("root")
            .bufferInterval(300)
            .bufferSize(250)
            .compressType("none")
            .pathFormat("%Y/%m/%d/%H/%M")
            .format("json")
            .jsonEnableTag(true)
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

example_project = alicloud.log.Project("exampleProject",
    description="created by terraform",
    tags={
        "test": "test",
    })
example_store = alicloud.log.Store("exampleStore",
    project=example_project.name,
    retention_period=3650,
    shard_count=3,
    auto_split=True,
    max_split_shard_count=60,
    append_meta=True)
example_oss_shipper = alicloud.log.OssShipper("exampleOssShipper",
    project_name=example_project.name,
    logstore_name=example_store.name,
    shipper_name="oss_shipper_name",
    oss_bucket="test_bucket",
    oss_prefix="root",
    buffer_interval=300,
    buffer_size=250,
    compress_type="none",
    path_format="%Y/%m/%d/%H/%M",
    format="json",
    json_enable_tag=True)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const exampleProject = new alicloud.log.Project("exampleProject", {
    description: "created by terraform",
    tags: {
        test: "test",
    },
});
const exampleStore = new alicloud.log.Store("exampleStore", {
    project: exampleProject.name,
    retentionPeriod: 3650,
    shardCount: 3,
    autoSplit: true,
    maxSplitShardCount: 60,
    appendMeta: true,
});
const exampleOssShipper = new alicloud.log.OssShipper("exampleOssShipper", {
    projectName: exampleProject.name,
    logstoreName: exampleStore.name,
    shipperName: "oss_shipper_name",
    ossBucket: "test_bucket",
    ossPrefix: "root",
    bufferInterval: 300,
    bufferSize: 250,
    compressType: "none",
    pathFormat: `%Y/%m/%d/%H/%M`,
    format: "json",
    jsonEnableTag: true,
});
resources:
  exampleProject:
    type: alicloud:log:Project
    properties:
      description: created by terraform
      tags:
        test: test
  exampleStore:
    type: alicloud:log:Store
    properties:
      project: ${exampleProject.name}
      retentionPeriod: 3650
      shardCount: 3
      autoSplit: true
      maxSplitShardCount: 60
      appendMeta: true
  exampleOssShipper:
    type: alicloud:log:OssShipper
    properties:
      projectName: ${exampleProject.name}
      logstoreName: ${exampleStore.name}
      shipperName: oss_shipper_name
      ossBucket: test_bucket
      ossPrefix: root
      bufferInterval: 300
      bufferSize: 250
      compressType: none
      pathFormat: '%Y/%m/%d/%H/%M'
      format: json
      jsonEnableTag: true

Create OssShipper Resource

new OssShipper(name: string, args: OssShipperArgs, opts?: CustomResourceOptions);
@overload
def OssShipper(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               buffer_interval: Optional[int] = None,
               buffer_size: Optional[int] = None,
               compress_type: Optional[str] = None,
               csv_config_columns: Optional[Sequence[str]] = None,
               csv_config_delimiter: Optional[str] = None,
               csv_config_header: Optional[bool] = None,
               csv_config_linefeed: Optional[str] = None,
               csv_config_nullidentifier: Optional[str] = None,
               csv_config_quote: Optional[str] = None,
               format: Optional[str] = None,
               json_enable_tag: Optional[bool] = None,
               logstore_name: Optional[str] = None,
               oss_bucket: Optional[str] = None,
               oss_prefix: Optional[str] = None,
               parquet_configs: Optional[Sequence[OssShipperParquetConfigArgs]] = None,
               path_format: Optional[str] = None,
               project_name: Optional[str] = None,
               role_arn: Optional[str] = None,
               shipper_name: Optional[str] = None)
@overload
def OssShipper(resource_name: str,
               args: OssShipperArgs,
               opts: Optional[ResourceOptions] = None)
func NewOssShipper(ctx *Context, name string, args OssShipperArgs, opts ...ResourceOption) (*OssShipper, error)
public OssShipper(string name, OssShipperArgs args, CustomResourceOptions? opts = null)
public OssShipper(String name, OssShipperArgs args)
public OssShipper(String name, OssShipperArgs args, CustomResourceOptions options)
type: alicloud:log:OssShipper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args OssShipperArgs
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 OssShipperArgs
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 OssShipperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args OssShipperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args OssShipperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

OssShipper Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The OssShipper resource accepts the following input properties:

BufferInterval int

How often is it delivered every interval.

BufferSize int

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

Format string

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
LogstoreName string

The name of the log logstore.

OssBucket string

The name of the oss bucket.

PathFormat string

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

ProjectName string

The name of the log project. It is the only in one Alicloud account.

ShipperName string

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

CompressType string

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

CsvConfigColumns List<string>
CsvConfigDelimiter string
CsvConfigHeader bool
CsvConfigLinefeed string
CsvConfigNullidentifier string
CsvConfigQuote string
JsonEnableTag bool
OssPrefix string

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

ParquetConfigs List<Pulumi.AliCloud.Log.Inputs.OssShipperParquetConfigArgs>
RoleArn string

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

BufferInterval int

How often is it delivered every interval.

BufferSize int

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

Format string

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
LogstoreName string

The name of the log logstore.

OssBucket string

The name of the oss bucket.

PathFormat string

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

ProjectName string

The name of the log project. It is the only in one Alicloud account.

ShipperName string

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

CompressType string

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

CsvConfigColumns []string
CsvConfigDelimiter string
CsvConfigHeader bool
CsvConfigLinefeed string
CsvConfigNullidentifier string
CsvConfigQuote string
JsonEnableTag bool
OssPrefix string

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

ParquetConfigs []OssShipperParquetConfigArgs
RoleArn string

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

bufferInterval Integer

How often is it delivered every interval.

bufferSize Integer

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

format String

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
logstoreName String

The name of the log logstore.

ossBucket String

The name of the oss bucket.

pathFormat String

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

projectName String

The name of the log project. It is the only in one Alicloud account.

shipperName String

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

compressType String

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csvConfigColumns List<String>
csvConfigDelimiter String
csvConfigHeader Boolean
csvConfigLinefeed String
csvConfigNullidentifier String
csvConfigQuote String
jsonEnableTag Boolean
ossPrefix String

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquetConfigs List<OssShipperParquetConfigArgs>
roleArn String

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

bufferInterval number

How often is it delivered every interval.

bufferSize number

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

format string

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
logstoreName string

The name of the log logstore.

ossBucket string

The name of the oss bucket.

pathFormat string

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

projectName string

The name of the log project. It is the only in one Alicloud account.

shipperName string

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

compressType string

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csvConfigColumns string[]
csvConfigDelimiter string
csvConfigHeader boolean
csvConfigLinefeed string
csvConfigNullidentifier string
csvConfigQuote string
jsonEnableTag boolean
ossPrefix string

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquetConfigs OssShipperParquetConfigArgs[]
roleArn string

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

buffer_interval int

How often is it delivered every interval.

buffer_size int

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

format str

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
logstore_name str

The name of the log logstore.

oss_bucket str

The name of the oss bucket.

path_format str

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

project_name str

The name of the log project. It is the only in one Alicloud account.

shipper_name str

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

compress_type str

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csv_config_columns Sequence[str]
csv_config_delimiter str
csv_config_header bool
csv_config_linefeed str
csv_config_nullidentifier str
csv_config_quote str
json_enable_tag bool
oss_prefix str

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquet_configs Sequence[OssShipperParquetConfigArgs]
role_arn str

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

bufferInterval Number

How often is it delivered every interval.

bufferSize Number

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

format String

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
logstoreName String

The name of the log logstore.

ossBucket String

The name of the oss bucket.

pathFormat String

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

projectName String

The name of the log project. It is the only in one Alicloud account.

shipperName String

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

compressType String

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csvConfigColumns List<String>
csvConfigDelimiter String
csvConfigHeader Boolean
csvConfigLinefeed String
csvConfigNullidentifier String
csvConfigQuote String
jsonEnableTag Boolean
ossPrefix String

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquetConfigs List<Property Map>
roleArn String

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

Outputs

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

Get an existing OssShipper 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?: OssShipperState, opts?: CustomResourceOptions): OssShipper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        buffer_interval: Optional[int] = None,
        buffer_size: Optional[int] = None,
        compress_type: Optional[str] = None,
        csv_config_columns: Optional[Sequence[str]] = None,
        csv_config_delimiter: Optional[str] = None,
        csv_config_header: Optional[bool] = None,
        csv_config_linefeed: Optional[str] = None,
        csv_config_nullidentifier: Optional[str] = None,
        csv_config_quote: Optional[str] = None,
        format: Optional[str] = None,
        json_enable_tag: Optional[bool] = None,
        logstore_name: Optional[str] = None,
        oss_bucket: Optional[str] = None,
        oss_prefix: Optional[str] = None,
        parquet_configs: Optional[Sequence[OssShipperParquetConfigArgs]] = None,
        path_format: Optional[str] = None,
        project_name: Optional[str] = None,
        role_arn: Optional[str] = None,
        shipper_name: Optional[str] = None) -> OssShipper
func GetOssShipper(ctx *Context, name string, id IDInput, state *OssShipperState, opts ...ResourceOption) (*OssShipper, error)
public static OssShipper Get(string name, Input<string> id, OssShipperState? state, CustomResourceOptions? opts = null)
public static OssShipper get(String name, Output<String> id, OssShipperState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
BufferInterval int

How often is it delivered every interval.

BufferSize int

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

CompressType string

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

CsvConfigColumns List<string>
CsvConfigDelimiter string
CsvConfigHeader bool
CsvConfigLinefeed string
CsvConfigNullidentifier string
CsvConfigQuote string
Format string

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
JsonEnableTag bool
LogstoreName string

The name of the log logstore.

OssBucket string

The name of the oss bucket.

OssPrefix string

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

ParquetConfigs List<Pulumi.AliCloud.Log.Inputs.OssShipperParquetConfigArgs>
PathFormat string

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

ProjectName string

The name of the log project. It is the only in one Alicloud account.

RoleArn string

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

ShipperName string

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

BufferInterval int

How often is it delivered every interval.

BufferSize int

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

CompressType string

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

CsvConfigColumns []string
CsvConfigDelimiter string
CsvConfigHeader bool
CsvConfigLinefeed string
CsvConfigNullidentifier string
CsvConfigQuote string
Format string

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
JsonEnableTag bool
LogstoreName string

The name of the log logstore.

OssBucket string

The name of the oss bucket.

OssPrefix string

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

ParquetConfigs []OssShipperParquetConfigArgs
PathFormat string

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

ProjectName string

The name of the log project. It is the only in one Alicloud account.

RoleArn string

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

ShipperName string

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

bufferInterval Integer

How often is it delivered every interval.

bufferSize Integer

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

compressType String

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csvConfigColumns List<String>
csvConfigDelimiter String
csvConfigHeader Boolean
csvConfigLinefeed String
csvConfigNullidentifier String
csvConfigQuote String
format String

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
jsonEnableTag Boolean
logstoreName String

The name of the log logstore.

ossBucket String

The name of the oss bucket.

ossPrefix String

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquetConfigs List<OssShipperParquetConfigArgs>
pathFormat String

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

projectName String

The name of the log project. It is the only in one Alicloud account.

roleArn String

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

shipperName String

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

bufferInterval number

How often is it delivered every interval.

bufferSize number

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

compressType string

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csvConfigColumns string[]
csvConfigDelimiter string
csvConfigHeader boolean
csvConfigLinefeed string
csvConfigNullidentifier string
csvConfigQuote string
format string

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
jsonEnableTag boolean
logstoreName string

The name of the log logstore.

ossBucket string

The name of the oss bucket.

ossPrefix string

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquetConfigs OssShipperParquetConfigArgs[]
pathFormat string

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

projectName string

The name of the log project. It is the only in one Alicloud account.

roleArn string

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

shipperName string

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

buffer_interval int

How often is it delivered every interval.

buffer_size int

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

compress_type str

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csv_config_columns Sequence[str]
csv_config_delimiter str
csv_config_header bool
csv_config_linefeed str
csv_config_nullidentifier str
csv_config_quote str
format str

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
json_enable_tag bool
logstore_name str

The name of the log logstore.

oss_bucket str

The name of the oss bucket.

oss_prefix str

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquet_configs Sequence[OssShipperParquetConfigArgs]
path_format str

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

project_name str

The name of the log project. It is the only in one Alicloud account.

role_arn str

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

shipper_name str

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

bufferInterval Number

How often is it delivered every interval.

bufferSize Number

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

compressType String

OSS data storage compression method, support: none, snappy. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

csvConfigColumns List<String>
csvConfigDelimiter String
csvConfigHeader Boolean
csvConfigLinefeed String
csvConfigNullidentifier String
csvConfigQuote String
format String

Storage format, only supports three types: json, parquet, csv. According to the different format, please select the following parameters

  • format = json json_enable_tag - (Optional) Whether to deliver the label.
  • format = csv csv_config_delimiter - (Optional) Separator configuration in csv configuration format. csv_config_columns - (Optional) Field configuration in csv configuration format. csv_config_nullidentifier - (Optional) Invalid field content. csv_config_quote - (Optional) Escape character under csv configuration. csv_config_header - (Optional) Indicates whether to write the field name to the CSV file, the default value is false. csv_config_linefeed - (Optional) lineFeed in csv configuration.
  • format = parquet parquet_config - (Optional) Configure to use parquet storage format. name - (Required) The name of the key. type - (Required) Type of configuration name.
jsonEnableTag Boolean
logstoreName String

The name of the log logstore.

ossBucket String

The name of the oss bucket.

ossPrefix String

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

parquetConfigs List<Property Map>
pathFormat String

The OSS Bucket directory is dynamically generated according to the creation time of the shipper task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

projectName String

The name of the log project. It is the only in one Alicloud account.

roleArn String

Used for access control, the OSS Bucket owner creates the role mark, such as acs:ram::13234:role/logrole

shipperName String

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

Supporting Types

OssShipperParquetConfig

Name string
Type string
Name string
Type string
name String
type String
name string
type string
name str
type str
name String
type String

Import

Log oss shipper can be imported using the id or name, e.g.

 $ pulumi import alicloud:log/ossShipper:OssShipper example tf-log-project:tf-log-logstore:tf-log-shipper

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.