ALIYUN::SLS::Logstore资源类型语法与属性-资源编排-阿里云

ALIYUN::SLS::Logstore类型用于在日志项目下创建日志库。

语法

{
  "Type": "ALIYUN::SLS::Logstore",
  "Properties": {
    "ProjectName": String,
    "ShardCount": Integer,
    "AutoSplit": Boolean,
    "MaxSplitShard": Integer,
    "LogstoreName": String,
    "AppendMeta": Boolean,
    "TTL": Integer,
    "EnableTracking": Boolean,
    "PreserveStorage": Boolean,
    "EncryptConf": Map,
    "Mode": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
ProjectName	String	是	否	要创建的日志库所属日志项目的名称。	长度为3~63个字符。支持小写英文字母、数字、短划线（-）、下划线（_）。必须以小写英文字母或数字开头和结尾。
ShardCount	Integer	否	是	分区个数。	取值范围：1~100。默认值：2。单位：个。
MaxSplitShard	Integer	否	是	自动分裂时，分裂出最大的分区个数。	取值范围：1~64。当autoSplit为true时，必须指定MaxSplitShard。
LogstoreName	String	是	否	日志库的名称。	在一个日志项目中，日志库的名称必须具有唯一性。长度为3~36个字符。支持小写英文字母、数字、短划线（-）、下划线（_）。必须以小写英文字母或数字开头和结尾。
AutoSplit	Boolean	否	是	是否自动分裂分区。	取值： true：自动分裂分区。 false（默认值）：不自动分裂分区。
TTL	Integer	否	是	数据的保存时间。	取值范围：1~3600。默认值：30。单位：天。
EnableTracking	Boolean	否	是	是否开启WebTracking采集信息。	支持采集各种浏览器以及iOS或Android App的信息。取值： true：开启WebTracking采集信息。 false（默认值）：不开启WebTracking采集信息。
PreserveStorage	Boolean	否	是	是否永久保存日志。	取值： true：永久保存日志。如果取值为true，则TTL的设置不生效。 false（默认值）：不永久保存日志。
Mode	String	否	是	Logstore的类型。	取值： standard（标准型）：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。 query（查询型）：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。
AppendMeta	Boolean	否	是	接收日志后，是否自动添加客户端外网IP和日志到达时间。	取值： true：自动添加客户端外网IP和日志到达时间。 false（默认值）：不自动添加客户端外网IP和日志到达时间。
EncryptConf	Map	否	否	数据加密配置。	更多信息，请参见EncryptConf语法和EncryptConf属性。

EncryptConf语法

"EncryptConf": {
    "Enable": Boolean,
    "EncryptType": String,
    "UserCmkInfo": Map
}

EncryptConf属性

属性名称	类型	必须	允许更新	描述	约束
Enable	Boolean	是	否	是否启用数据加密。	取值： true：启用数据加密。 false（默认值）：不启用数据加密。
EncryptType	String	是	否	加密算法。	取值： default：AES算法。 m4：国密算法。说明关于数据加密的更多信息，请参见数据加密。
UserCmkInfo	Map	否	否	如果指定了UserCmkInfo，则使用自带密钥（BYOK）加密或解密数据。否则，将使用日志服务的服务密钥。	更多信息，请参见UserCmkInfo语法和UserCmkInfo属性。

UserCmkInfo语法

"UserCmkInfo": {
    "CmkKeyId": String,
    "Arn": String,
    "RegionId": String
  }

UserCmkInfo属性

属性名称	类型	必须	允许更新	描述	约束
CmkKeyId	String	是	否	BYOK密钥所属的CMK的ID。	无
RegionId	String	是	否	CMK所在区域的ID。	无
Arn	String	是	否	RAM角色的ARN。	关于如何获取RAM角色的ARN的更多信息，请参见创建OSS投递任务（旧版）。

返回值

Fn::GetAtt

LogstoreName：日志库名称。
ProjectName：日志项目的名称。

示例

`YAML`格式

ROSTemplateFormatVersion: '2015-09-01'
Description: Test SLS Logstore
Parameters: {}
Resources:
  SlsLogStore:
    Type: ALIYUN::SLS::Logstore
    Properties:
      LogstoreName: mytest
      PreserveStorage: true
      ProjectName: TestProject
      AppendMeta: true
      MaxSplitShard: 64
      AutoSplit: true
      EnableTracking: false
      ShardCount: 2
Outputs: {}

`JSON`格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test SLS Logstore",
  "Parameters": {
  },
  "Resources": {
    "SlsLogStore": {
      "Type": "ALIYUN::SLS::Logstore",
      "Properties": {
        "LogstoreName": "mytest",
        "PreserveStorage": true,
        "ProjectName": "TestProject",
        "AppendMeta": true,
        "MaxSplitShard": 64,
        "AutoSplit": true,
        "EnableTracking": false,
        "ShardCount": 2
      }
    }
  },
  "Outputs": {
  }
}

更多示例，请参见创建日志项目、创建日志库、创建索引、配置Logtail参数、创建日志服务ECS机器组、将日志配置应用于机器组、创建日志配置、将查询结果保存为快速查询和创建告警的组合示例：YAML示例。

语法

属性

EncryptConf语法

EncryptConf属性

UserCmkInfo语法

UserCmkInfo属性

返回值

示例

YAML格式

JSON格式

`YAML`格式

`JSON`格式