S3DataNode

Amazon S3 を使用するデータノードを定義します。デフォルトでは、S3DataNode ではサーバー側の暗号化が使用されます。この機能を無効にするには、s3EncryptionType を NONE に設定してください。

注記

CopyActivity の入力として S3DataNode を使用するときは、CSV データ形式および TSV データ形式のみがサポートされます。

例

以下は、このオブジェクト型の例です。このオブジェクトは、同じパイプライン定義ファイルで定義した別のオブジェクトを参照します。CopyPeriod は Schedule オブジェクトです。

{
  "id" : "OutputData",
  "type" : "S3DataNode",
  "schedule" : { "ref" : "CopyPeriod" },
  "filePath" : "s3://myBucket/#{@scheduledStartTime}.csv"
}

Syntax

オブジェクト呼び出しフィールド	説明	スロットタイプ
schedule	このオブジェクトは、スケジュール期間の実行中に呼び出されます。ユーザーは、このオブジェクトの依存関係の実行順序を設定するには、別のオブジェクトへのスケジュール参照を指定する必要があります。ユーザーは、オブジェクトでスケジュールを明示的に設定して、この要件を満たすことができます。たとえば、"schedule": {"ref": "DefaultSchedule"} と指定します。ほとんどの場合、すべてのオブジェクトがそのスケジュールを継承するように、スケジュール参照をデフォルトのパイプラインオブジェクトに配置することをお勧めします。または、パイプラインにスケジュールのツリー (マスタースケジュール内のスケジュール) がある場合、ユーザーは、スケジュール参照がある親オブジェクトを作成することができます。オプションのスケジュール設定の例については、「https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-object-schedule.html」を参照してください。	参照オブジェクト ("schedule":{"ref":"myScheduleId"} など)

オプションのフィールド	説明	スロットタイプ
attemptStatus	リモートアクティビティから最も最近報告されたステータス。	文字列
attemptTimeout	リモートの作業完了のタイムアウト。設定された場合、設定された開始時間内に完了しなかったリモートアクティビティを再試行することができます。	[Period] (期間)
compression	S3DataNode によって記述されたデータの圧縮タイプ。"none" は圧縮なしで、"gzip" は gzip アルゴリズムで圧縮されています。このフィールドは、Amazon Redshift で S3DataNode を CopyActivity に使用する場合にのみサポートされます。	一覧表
dataFormat	この S3DataNode データノードで説明されるデータの DataFormat。	参照オブジェクト ("dataFormat":{"ref":"myDataFormatId"} など)
dependsOn	実行可能な別のオブジェクトで依存関係を指定します	参照オブジェクト ("dependsOn":{"ref":"myActivityId"} など)
directoryPath	URI としての Amazon S3 のディレクトリパス: s3://my-bucket/my-key-for-directory。filePath または directoryPath のどちらかの値を指定する必要があります。	文字列
failureAndRerunMode	依存関係が失敗または再実行されたときのコンシューマーノードの動作を示します。	一覧表
filePath	URI としての Amazon S3 のオブジェクトに対するパス: s3://my-bucket/my-key-for-file。filePath または directoryPath のどちらかの値を指定する必要があります。これらの値は、フォルダとファイル名を表します。ディレクトリに複数のファイルを格納する場合は、directoryPath 値を使用します。	文字列
lateAfterTimeout	オブジェクトが完了しなければならない、パイプライン開始からの経過時間。スケジュールタイプが ondemand に設定されていない場合にのみトリガーされます。	[Period] (期間)
manifestFilePath	Amazon Redshift がサポートする形式のマニフェストファイルへの Amazon S3 パス。AWS Data Pipeline はマニフェストファイルを使用して、指定された Amazon S3 ファイルをテーブルにコピーします。このフィールドは、RedShiftCopyActivity が S3DataNode を参照する場合にのみ有効です。	文字列
maxActiveInstances	コンポーネントで同時にアクティブになるインスタンスの最大数。再実行はアクティブなインスタンスの数にはカウントされません。	整数
maximumRetries	失敗時の最大再試行回数	整数
onFail	現在のオブジェクトが失敗したときに実行するアクション。	参照オブジェクト (onFail:{"ref":"myActionId"} など)
onLateAction	オブジェクトが予定されていないか、まだ完了していない場合にトリガーされるアクション。	参照オブジェクト ("onLateAction":{"ref":"myActionId"} など)
onSuccess	現在のオブジェクトが成功したときに実行するアクション。	参照オブジェクト ("onSuccess":{"ref":"myActionId"} など)
parent	スロットの継承元となる現在のオブジェクトの親。	参照オブジェクト ("parent":{"ref":"myBaseObjectId"} など)
pipelineLogUri	パイプラインのログをアップロードするための S3 URI (s3://BucketName/Key/ など)。	文字列
precondition	オプションで前提条件を定義します。すべての前提条件を満たすまで、データノードは "READY" とマークされません。	参照オブジェクト ("precondition":{"ref":"myPreconditionId"} など)
reportProgressTimeout	reportProgress へのリモート作業の連続した呼び出しのタイムアウト。設定された場合、指定された期間の進捗状況を報告しないリモートアクティビティは停止されたと見なし、再試行できます。	[Period] (期間)
retryDelay	2 回の再試行の間のタイムアウト期間。	[Period] (期間)
runsOn	アクティビティまたはコマンドを実行するコンピューティングリソース。たとえば、Amazon EC2 インスタンスまたは Amazon EMR クラスター。	参照オブジェクト ("runsOn":{"ref":"myResourceId"} など)
s3EncryptionType	Amazon S3 の暗号化タイプをオーバーライドします。値は SERVER_SIDE_ENCRYPTION または NONE です。デフォルトではサーバー側の暗号化が有効化されます。	一覧表
scheduleType	スケジュールタイプによって、パイプライン定義のオブジェクトを、期間の最初にスケジュールするか、最後にスケジュールするかを指定できます。[Time Series Style Scheduling] は、インスタンスが各間隔の最後にスケジュールされることを意味し、[Cron Style Scheduling] は、インスタンスが各間隔の最初にスケジュールされることを意味します。オンデマンドスケジュールにより、アクティベーションごとに 1 回パイプラインを実行することができます。つまり、パイプラインを再実行するために、クローンしたり再作成したりする必要はありません。オンデマンドスケジュールを使用する場合は、デフォルトオブジェクトで指定し、パイプラインのオブジェクトに対して指定される唯一の scheduleType である必要があります。オンデマンドパイプラインを使用するには、それ以降の実行ごとに、ActivatePipeline オペレーションを呼び出すだけです。値は、cron、ondemand、および timeseries です。	一覧表
workerGroup	ワーカーグループ。これはルーティングタスクに使用されます。runsOn 値を指定して、workerGroup がある場合、workerGroup は無視されます。	文字列

実行時フィールド	説明	スロットタイプ
@activeInstances	現在スケジュールされているアクティブなインスタンスオブジェクトのリスト。	参照オブジェクト ("activeInstances":{"ref":"myRunnableObjectId"} など)
@actualEndTime	このオブジェクトの実行が終了した時刻。	DateTime
@actualStartTime	このオブジェクトの実行が開始された時刻。	DateTime
cancellationReason	このオブジェクトがキャンセルされた場合の cancellationReason。	文字列
@cascadeFailedOn	オブジェクトが失敗した際の依存関係チェーンの説明。	参照オブジェクト ("cascadeFailedOn":{"ref":"myRunnableObjectId"} など)
emrStepLog	EMR アクティビティの試行でのみ使用可能な EMR ステップログ	文字列
errorId	このオブジェクトが失敗した場合は errorId。	文字列
errorMessage	このオブジェクトが失敗した場合は errorMessage。	文字列
errorStackTrace	このオブジェクトが失敗した場合は、エラースタックトレース。	文字列
@finishedTime	このオブジェクトが実行を終了した時刻。	DateTime
hadoopJobLog	EMR ベースのアクティビティで試みることができる Hadoop ジョブのログ。	文字列
@healthStatus	終了状態に達した最後のオブジェクトインスタンスの成功または失敗を反映する、オブジェクトのヘルスステータス。	文字列
@healthStatusFromInstanceId	終了状態に達した最後のインスタンスオブジェクトの ID。	文字列
@healthStatusUpdatedTime	ヘルス状態が最後に更新された時間。	DateTime
hostname	タスクの試行を取得したクライアントのホスト名。	文字列
@lastDeactivatedTime	このオブジェクトが最後に非アクティブ化された時刻。	DateTime
@latestCompletedRunTime	実行が完了した最後の実行の時刻。	DateTime
@latestRunTime	実行がスケジュールされた最後の実行の時刻。	DateTime
@nextRunTime	次回にスケジュールされた実行の時刻。	DateTime
reportProgressTime	リモートアクティビティで進捗状況が報告された最新の時刻。	DateTime
@scheduledEndTime	オブジェクトの予定された終了時刻	DateTime
@scheduledStartTime	オブジェクトの予定された開始時刻	DateTime
@status	このオブジェクトのステータス。	文字列
@version	オブジェクトが作成されたパイプラインのバージョン。	文字列
@waitingOn	このオブジェクトが待機している依存関係のリストの説明。	参照オブジェクト ("waitingOn":{"ref":"myRunnableObjectId"} など)

システムフィールド	説明	スロットタイプ
@error	形式が正しくないオブジェクトを説明するエラー	文字列
@pipelineId	このオブジェクトが属するパイプラインの ID	文字列
@sphere	オブジェクトの球は、ライフサイクルにおける場所を示します。コンポーネントオブジェクトにより、試行オブジェクトを実行するインスタンスオブジェクトが発生します	文字列

以下の資料も参照してください。

• MySqlDataNode