翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# パイプ宣言
<a name="pipe-object-declarations"></a>

を使用する*パイプ宣言*を使用してソースを接続します（[ソース宣言](source-object-declarations.md)を参照) をシンク ([シンク宣言](sink-object-declarations.md)Microsoft Windows の Amazon Kinesis エージェントの。パイプ宣言は、JSON オブジェクトとして表されます。Kinesis Agent for Windows が起動した後、ログ、イベント、またはメトリクスは特定のパイプのソースから収集されます。その後、それらはそのパイプに関連付けられているシンクを使用してさまざまな AWS のサービスにストリーミングされます。

以下は パイプ宣言の例です。

```
{
   "Id": "MyAppLogToCloudWatchLogs", 
   "SourceRef": "MyAppLog", 
   "SinkRef": "MyCloudWatchLogsSink" 
}
```

**Topics**
+ [パイプの設定](#kinesis-agent-pipe-configuration)
+ [Windows メトリックパイプ用の Kinesis エージェントの設定](#kinesis-agent-metric-pipe-configuration)

## パイプの設定
<a name="kinesis-agent-pipe-configuration"></a>

すべてのパイプ宣言には、次のキーと値のペアを含めることができます。

`Id`  
パイプの名前を指定します (必須)。これは、設定ファイル内で一意である必要があります。

`Type`  
ログデータがソースからシンクに転送されるときにパイプによって適用される変換のタイプ (ある場合) を指定します。`RegexFilterPipe` はサポートされる唯一の値です。この値は、ログレコードの基になるテキスト表現の正規表現フィルタリングを有効にします。フィルタリングを使用すると、関連するログレコードのみをデータパイプラインの下流に送信することで、送信とストレージのコストを削減できます。このキーと値のペアはオプションです。デフォルト値では、変換は行われません。

`FilterPattern`  
シンクに転送される前にソースによって収集されたログレコードをフィルタリングするために使用される `RegexFilterPipe` パイプラインの正規表現を指定します。正規表現がレコードの元のテキスト表現と一致すると、ログレコードは `RegexFilterPipe` タイプのパイプで転送されます。たとえば、`DirectorySource` 宣言で `ExtractionPattern` キーと値のペアを使用するときに生成される構造化ログレコードは、`RegexFilterPipe` メカニズムを使用してフィルタリングできます。これは、このメカニズムが解析前の元のテキスト表現に対して機能するためです。このキーと値のペアはオプションですが、パイプが `RegexFilterPipe` タイプを指定している場合は指定する必要があります。  
以下は `RegexFilterPipe` パイプ宣言の例です。  

```
{
	"Id": "MyAppLog2ToFirehose",
	"Type": "RegexFilterPipe",
	"SourceRef": "MyAppLog2",
	"SinkRef": "MyFirehose",
	"FilterPattern": "^(10|11),.*",
	"IgnoreCase": false,
	"Negate": false
}
```

`SourceRef`  
パイプのログ、イベント、およびメトリクスデータを収集するソースを定義するソース宣言の名前 (`Id` キーと値のペアの値) を指定します (必須)。

`SinkRef`  
パイプのログ、イベント、およびメトリクスデータを受け取るシンクを定義するシンク宣言の名前 (`Id` キーと値のペアの値) を指定します (必須)。

`IgnoreCase`  
省略可能。次の値を受け入れます`true`または`false`。に設定した場合`true`の場合、Regexは大文字と小文字を区別しない方法でレコードに一致します。

`Negate`  
省略可能。次の値を受け入れます`true`または`false`。に設定した場合`true`の場合、パイプはレコードを*しない*正規表現に一致します。

`RegexFilterPipe` パイプタイプを使用した完全な設定ファイルの例については、「[パイプの使用](configuring-kaw-examples.md#configuring-kaw-examples-pipes)」を参照してください。

## Windows メトリックパイプ用の Kinesis エージェントの設定
<a name="kinesis-agent-metric-pipe-configuration"></a>

という名前の組み込みメトリクスソースがあります`_KinesisTapMetricsSource`で、Windows 用 Kinesis エージェントに関するメトリックスを生成します。ある場合`CloudWatch`シンク宣言を`Id`の`MyCloudWatchSink`次のパイプライン宣言は Windows が生成したメトリクスをそのシンクに転送します。

```
{
   "Id": "KinesisAgentMetricsToCloudWatch",
   "SourceRef": "_KinesisTapMetricsSource",
   "SinkRef": "MyCloudWatchSink"
}
```

Kinesis エージェント for Windows 組み込みメトリクスソースの詳細については、」[Windows 組み込みメトリクスソース Kinesis エージェント](source-object-declarations.md#kinesis-agent-builin-metrics-source)。

設定ファイルが Windows パフォーマンスカウンターメトリクスもストリーミングする場合は、Kinesis Agent for Windows メトリクスと Windows パフォーマンスカウンターメトリックの両方に同じシンクを使用するのではなく、別々のパイプとシンクを使用することをお勧めします。