SLS プロジェクトにログストアを作成するための ALIYUN::SLS::Logstore の使用方法 - Resource Orchestration Service

ALIYUN::SLS::Logstore は、Simple Log Service (SLS) プロジェクトにログストアを作成するために使用されます。

構文

{
  "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	はい	いいえ	ログストアを作成する SLS プロジェクトの名前。	名前は 3 ～ 63 文字の長さでなければなりません。小文字、数字、ハイフン（-）、およびアンダースコア（_）を含めることができます。小文字または数字で開始および終了する必要があります。
ShardCount	Integer	いいえ	はい	シャードの数。	有効な値: 1 ～ 100。デフォルト値: 2。
MaxSplitShard	Integer	いいえ	はい	自動分割中に取得できるシャードの最大数。	有効な値: 1 ～ 64。 AutoSplit を true に設定する場合は、MaxSplitShard を指定する必要があります。
LogstoreName	String	はい	いいえ	ログストア名。	ログストア名は、SLS プロジェクト内で一意である必要があります。名前は 3 ～ 36 文字の長さでなければなりません。小文字、数字、ハイフン（-）、およびアンダースコア（_）を含めることができます。小文字または数字で開始および終了する必要があります。
AutoSplit	Boolean	いいえ	はい	シャードを自動的に分割するかどうかを指定します。	有効な値: true false (デフォルト)
TTL	Integer	いいえ	はい	データの保持期間。	有効な値: 1 ～ 3600。デフォルト値: 30。単位: 日。
EnableTracking	Boolean	いいえ	はい	Web トラッキングを有効にするかどうかを指定します。	Web トラッキングを使用して、Web ブラウザー、iOS アプリケーション、Android アプリケーションに関する情報を収集できます。有効な値: true false (デフォルト)
PreserveStorage	Boolean	いいえ	はい	ログを永続的に保持するかどうかを指定します。	有効な値: true: ログを永続的に保持します。PreserveStorage が true に設定されている場合、TTL プロパティは有効になりません。 false (デフォルト): ログを永続的に保持しません。
Mode	String	いいえ	はい	ログストアのタイプ。	有効な値: standard: 標準ログストア。このタイプのログストアは、SLS のログ分析機能をサポートしており、リアルタイムモニタリングやインタラクティブ分析などのシナリオに適しています。このタイプのログストアを使用して、包括的な可観測性システムを構築できます。 query: クエリログストア。このタイプのログストアは、高パフォーマンスのクエリをサポートしています。クエリログストアのインデックストラフィック料金は、標準ログストアのインデックストラフィック料金の約半分です。クエリログストアは SQL 分析をサポートしていません。クエリログストアは、データ量が大きく、ログの保持期間が長く、ログ分析が不要なシナリオに適しています。ログが数週間または数か月間保存される場合、ログの保持期間は長いと見なされます。
AppendMeta	Boolean	いいえ	はい	ログを受信した後、クライアントのパブリック IP アドレスとログの到着時刻を自動的に追加するかどうかを指定します。	有効な値: true false (デフォルト)
EncryptConf	Map	いいえ	いいえ	データ暗号化の構成。	詳細については、「EncryptConf 構文」および「EncryptConf プロパティ」をご参照ください。

EncryptConf 構文

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

EncryptConf プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Enable	Boolean	はい	いいえ	データ暗号化を有効にするかどうかを指定します。	有効な値: true false (デフォルト)
EncryptType	String	はい	いいえ	暗号化アルゴリズム。	有効な値: default: 高度暗号化標準 (AES) アルゴリズム m4: 中国暗号アルゴリズム説明詳細については、「データ暗号化」をご参照ください。
UserCmkInfo	Map	いいえ	いいえ	データの暗号化または復号化に使用される Bring Your Own Key (BYOK) メソッド。 UserCmkInfo を空のままにすると、SLS のサービスキーを使用してデータが暗号化または復号化されます。	詳細については、「UserCmkInfo 構文」および「UserCmkInfo プロパティ」をご参照ください。

UserCmkInfo 構文

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

UserCmkInfo プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
CmkKeyId	String	はい	いいえ	BYOK キーが属するカスタマーマスターキー (CMK) の ID。	なし。
RegionId	String	はい	いいえ	CMK が属するリージョンの ID。	なし。
Arn	String	はい	いいえ	Resource Access Management (RAM) ロールの Alibaba Cloud Resource Name (ARN)。	RAM ロールの ARN をクエリする方法の詳細については、「Simple Log Service から OSS にログデータを配信する」をご参照ください。

戻り値

Fn::GetAtt

LogstoreName: ログストア名。
ProjectName: SLS プロジェクトの名前。

例

`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": {
  }
}

その他の例については、sls.yml をご覧ください。例では、ALIYUN::SLS::Project、ALIYUN::SLS::Logstore、ALIYUN::SLS::Index、ALIYUN::SLS::LogtailConfig、ALIYUN::SLS::MachineGroup、ALIYUN::SLS::ApplyConfigToMachineGroup、ALIYUN::ApiGateway::LogConfig、ALIYUN::SLS::Savedsearch、および ALIYUN::SLS::Alert というリソースタイプが使用されています。

構文