Logstore のインデックスを作成するために ALIYUN::SLS::Index を使用する - Resource Orchestration Service

ALIYUN::SLS::Index は、Simple Log Service (SLS) Logstore のインデックスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::SLS::Index",
  "Properties": {
    "ProjectName": String,
    "FullTextIndex": Map,
    "LogstoreName": String,
    "KeyIndices": List,
    "LogReduce": Boolean
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ProjectName	String	はい	いいえ	SLS プロジェクトの名前。	名前は 3 ～ 63 文字で、小文字、数字、ハイフン (-)、およびアンダースコア (_) を使用できます。小文字または数字で始める必要があります。
FullTextIndex	Map	はい	はい	フルテキストインデックスの構成。	詳細については、「FullTextIndex プロパティ」をご参照ください。
LogstoreName	String	はい	いいえ	Logstore の名前。	なし。
KeyIndices	List	いいえ	はい	フィールドインデックスの構成。	FullTextIndex と KeyIndices の少なくとも 1 つを指定する必要があります。詳細については、このトピックの「KeyIndices プロパティ」セクションをご参照ください。
LogReduce	Boolean	いいえ	はい	LogReduce 機能を有効にするかどうかを指定します。	有効な値： true false (デフォルト)

FullTextIndex 構文

"FullTextIndex": {
  "CaseSensitive": Boolean,
  "Delimiter": String,
  "IncludeChinese": Boolean,
  "Enable": Boolean
}

FullTextIndex プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Enable	Boolean	はい	はい	フルテキストインデックス機能を有効にするかどうかを指定します。	有効な値： true (デフォルト) false
CaseSensitive	Boolean	いいえ	はい	テキストの大文字と小文字を区別するかどうかを指定します。	有効な値： true false (デフォルト)
Delimiter	String	いいえ	はい	デリミタ。	次の特殊文字がサポートされています。 `,'";=()[]{}?@&<>/:\n\t\r`
IncludeChinese	Boolean	いいえ	はい	テキストに中国語の文字が含まれているかどうかを指定します。	有効な値： true false (デフォルト)

KeyIndices 構文

"KeyIndices": [
  {
    "Name": String,
    "EnableAnalytics": Boolean,
    "Delimiter": String,
    "CaseSensitive": Boolean,
    "JsonKeyIndices": List,
    "Alias": String,
    "IncludeChinese": String,
    "Type": String
  }
]

KeyIndices プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Name	String	はい	はい	フィールドの名前。	ピリオド (.) で区切ったネスト形式の名前を指定できます。例：k1.k2.k3。
EnableAnalytics	Boolean	いいえ	はい	フィールドの統計分析機能を有効にするかどうかを指定します。	有効な値： true (デフォルト) false
Delimiter	String	いいえ	はい	デリミタ。	次の特殊文字がサポートされています。 `,'";=()[]{}?@&<>/:\n\t\r`
CaseSensitive	Boolean	いいえ	はい	フィールドの大文字と小文字を区別するかどうかを指定します。	有効な値： true false (デフォルト) このプロパティは、Type が `text` または `json` に設定されている場合にのみ有効になります。
JsonKeyIndices	List	いいえ	はい	JSON インデックスの構成。フォーマット：`[{"key1": "value1", "key2": "value2", ...}]`。	サポートされているキーは、Name、Alias、Type、および EnableAnalytics です。詳細については、「JsonKeyIndices プロパティ」をご参照ください。
Alias	String	いいえ	はい	フィールドのエイリアス。	なし。
IncludeChinese	Boolean	いいえ	はい	フィールドに中国語の文字が含まれているかどうかを指定します。	有効な値： true false (デフォルト) このプロパティは、Type が text に設定されている場合にのみ有効になります。
Type	String	はい	はい	フィールドタイプ。	有効な値： `text` (デフォルト) `long` `double` `json`

JsonKeyIndices 構文

"JsonKeyIndices": [
  {
    "Type": String,
    "Alias": String,
    "EnableAnalytics": Boolean,
    "Name": String
  }
]

JsonKeyIndices プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Name	String	はい	はい	フィールドの名前。	なし。
EnableAnalytics	Boolean	いいえ	はい	フィールドの統計分析機能を有効にするかどうかを指定します。	有効な値： true false
Alias	String	いいえ	はい	フィールドのエイリアス。	なし。
Type	String	はい	はい	フィールドタイプ。	なし。

戻り値

Fn::GetAtt

なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: SLS インデックスのテスト
Parameters: {}
Resources:
  LogIndex:
    Type: ALIYUN::SLS::Index
    Properties:
      ProjectName: TestProject
      FullTextIndex:
        CaseSensitive: true
      LogstoreName: TestLogstore
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "SLS インデックスのテスト",
  "Parameters": {
  },
  "Resources": {
    "LogIndex": {
      "Type": "ALIYUN::SLS::Index",
      "Properties": {
        "ProjectName": "TestProject",
        "FullTextIndex": {
          "CaseSensitive": true
        },
        "LogstoreName": "TestLogstore"
      }
    }
  },
  "Outputs": {
  }
}