Amazon Kinesisトリガー

オペレーション名

Amazon Kinesisトリガー

機能概要

Amazon Kinesisトリガーは、Amazon Kinesis Streamを監視し、Amazon Kinesis Streamに追加されたデータレコードを受信して、スクリプトを実行するトリガー機能です。
Amazon Kinesisトリガーは、Kinesis Client Library(以下、KCL)を使用しています。トリガーの動作および仕様制限はKCLに準じます。
詳細については、「Amazon Kinesis Client Library を使用した Amazon Kinesis コンシューマーの開発」(http://docs.aws.amazon.com/ja_jp/kinesis/latest/dev/developing-consumers-with-kcl.html)を参照してください。
Amazon Kinesisトリガーが必要とするIAM権限については、「Amazon Web Servicesアダプタ IAMアクセス権限」-「Amazon Kinesisトリガー」を参照してください。

発火イメージ

プロパティ

Amazon Kinesisトリガーの設定
項目名 内容 備考
トリガー名 トリガーの名前を入力します。  
Access Key ID Access Key IDを入力します。  
Secret Access Key Secret Access Keyを入力します。  
リージョン リージョンを選択します。
  • [US East (N. Virginia)]:(デフォルト)
  • [US West (N. California)]
  • [US West (Oregon)]
  • [EU (Ireland)]
  • [EU (Frankfurt)]
  • [Asia Pacific (Singapore)]
  • [Asia Pacific (Sydney)]
  • [Asia Pacific (Tokyo)]
  
ストリーム名 監視対象のストリーム名を入力します。  
Kinesisアプリケーション名 Kinesisアプリケーション名を入力します。
  • トリガー作成時に、指定したKinesisアプリケーション名でAmazon DynamoDBテーブルを作成し、データレコードの取得状況を管理します。
シャードイテレータータイプ シャードイテレータータイプを選択します。
  • [LATEST]:(デフォルト)
    シャード内の最新のデータレコードからを読み取ります。
  • [TRIM_HORIZON]
    シャード内の最も古いデータレコードから読み取ります。
  
エンコード エンコードを選択または入力します。

入力する場合は、Java SE Runtime Environment 8でサポートされているエンコードを指定します。
詳細については、「Supported Encodings」(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html)を参照してください。
  • デフォルト値は「UTF-8」です。
監視間隔 ストリームの監視間隔をミリ秒単位で入力します。
  • デフォルト値は「1000」です。
  • 省略した場合、「0」を入力した場合、または不正な値を入力した場合、デフォルト値が適用されます。
  • [シャードイテレータータイプ]で[LATEST]を選択した場合、「300000」未満の値を指定してください。
実行内容の設定
項目名 内容 備考
トリガー所有者 作成するトリガーの所有者を選択します。
  • 管理者権限を持ったユーザのみ選択できます。
    (一般ユーザは自分以外を選択することはできません。)
実行ユーザ名 [スクリプト]で指定したスクリプトを実行するユーザを選択します。  
パスワード [実行ユーザ名]で指定したユーザに対応したパスワードを入力します。  
サービス トリガーで実行するスクリプトを含むサービスを選択します。
  • サービスとして登録されたプロジェクトが表示されます。
スクリプト トリガーで実行するスクリプトを選択します。
  • [サービス]で指定したサービス内のスクリプトが表示されます。
スクリプト引数 [スクリプト]で指定したスクリプトに設定されているスクリプト入力変数が表示されます。
  • スクリプト出力変数は表示されません。
  • スクリプトにスクリプト入力変数を設定し、使用する方法については、「入出力変数について」を参照してください。
スクリプト引数/変数名 スクリプト変数名が表示されます。
  • 編集はできません。
スクリプト引数/型 スクリプト変数の型が表示されます。
  • 編集はできません。
スクリプト引数/値 スクリプト変数の値を入力します。
実行オプションの設定
実行オプションの設定については、「実行オプションの設定」を参照してください。

トリガー変数

トリガー変数をスクリプト入力変数に設定することで、Amazon Kinesis Streamから受信したデータレコードをスクリプト実行時に使用することができます。

トリガー変数名 値 内容 備考
入力データ trigger.inputData Amazon Kinesis Streamから受信したデータレコードです。
  • 指定例:${trigger.inputData}
  • 値を設定できるスクリプト入力変数はXML型のみです。
  • 入力データのスキーマについては、「入力データのスキーマ」を参照してください。

入力データのスキーマ

入力データのデータモデルはXML型です。
スキーマは以下の通りです。 
<?xml version="1.0"?>
<root>
  <shardId>シャードID</shardId>
  <records>
    <record>
      <partitionKey>パーティションキー</partitionKey>
      <sequenceNumber>シーケンス番号</sequenceNumber>
      <data>データ</data>
    </record>
      :
  </records>
</root>
要素名 属性名 説明 備考
root -    
shardId - データレコードを読み取ったシャードIDが出力されます。  
records -    
record -    
partitionKey - データレコードのパーティションキーが出力されます。  
sequenceNumber - データレコードのシーケンス番号が出力されます。  
data - データレコードのデータが出力されます。 [エンコード]の値でデコードされます。

仕様制限

ありません。

主な例外

ありません。

注意事項