メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::Logs::SubscriptionFilter

AWS::Logs::SubscriptionFilter リソースは、Kinesis ストリームまたは AWS Lambda (Lambda) 関数に配信されるログイベントと、ログイベントの送信先を定義する Amazon CloudWatch Logs (CloudWatch Logs) サブスクリプションフィルタを作成します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::Logs::SubscriptionFilter", "Properties" : { "DestinationArn" : String, "FilterPattern" : String, "LogGroupName" : String, "RoleArn" : String } }

YAML

Copy
Type: "AWS::Logs::SubscriptionFilter" Properties: DestinationArn: String FilterPattern: String LogGroupName: String RoleArn: String

プロパティ

DestinationArn

サブスクリプションフィードの送信先として使用する Kinesis ストリームまたは Lambda 関数の Amazon リソースネーム (ARN)。

Required: Yes

Type: String

更新に伴う要件: 置換

FilterPattern

送信先の AWS リソースに配信される内容を制限するフィルタ式。フィルタパターン構文の詳細については、「フィルタとパターンの構文」(Amazon CloudWatch ユーザーガイド) を参照してください。

Required: Yes

Type: String

更新に伴う要件: 置換

LogGroupName

サブスクリプションフィルタを関連付けるロググループ。このロググループにアップロードされたすべてのログイベントは、サブスクリプションフィルタの対象となり、フィルタパターンがログイベントに一致する場合、指定された AWS リソースに配信されます。

Required: Yes

Type: String

更新に伴う要件: 置換

RoleArn

指定した Kinesis ストリームにデータを入力する CloudWatch Logs アクセス権を付与する IAM ロール。Lambda と CloudWatch Logs の配信先については、CloudWatch Logs が配信先リソースから必要な権限を取得するため、このプロパティは指定しないでください。

Required: No

Type: String

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、ストリームに Root ユーザーに関連付けられたログイベントを Kinesis ストリームに送信します。

JSON

Copy
"SubscriptionFilter" : { "Type" : "AWS::Logs::SubscriptionFilter", "Properties" : { "RoleArn" : { "Fn::GetAtt" : [ "CloudWatchIAMRole", "Arn" ] }, "LogGroupName" : { "Ref" : "LogGroup" }, "FilterPattern" : "{$.userIdentity.type = Root}", "DestinationArn" : { "Fn::GetAtt" : [ "KinesisStream", "Arn" ] } } }

YAML

Copy
SubscriptionFilter: Type: "AWS::Logs::SubscriptionFilter" Properties: RoleArn: Fn::GetAtt: - "CloudWatchIAMRole" - "Arn" LogGroupName: Ref: "LogGroup" FilterPattern: "{$.userIdentity.type = Root}" DestinationArn: Fn::GetAtt: - "KinesisStream" - "Arn"

このページの内容: