6.4. エンドポイントオプション

bucketNameOrArn (common)

必須 のバケット名または ARN。

String

amazonS3Client (common)

Autowired レジストリーの com.amazonaws.services.s3.AmazonS3 への参照。

S3Client

amazonS3Presigner (common)

Autowired リクエストの S3 Presigner。主に createDownloadLink 操作で使用されます。

S3Presigner

autoCreateBucket (common)

S3 バケット bucketName の自動作成の設定。moveAfterRead オプションが有効になっている場合も適用され、destinationBucket が存在しない場合は作成されます。

false

boolean

overrideEndpoint (common)

エンドポイントをオーバーライドする必要性を設定します。このオプションは uriEndpointOverride オプションと併用する必要があります。

false

boolean

pojoRequest (common)

POJO リクエストをボディーとして使用するかどうか。

false

boolean

policy (common)

com.amazonaws.services.s3.AmazonS3#setBucketPolicy() メソッドに設定されるこのキューのポリシー。

String

proxyHost (common)

SQS クライアントをインスタンス化するときにプロキシーホストを定義します。

String

proxyPort (common)

クライアント定義内で使用されるプロキシーポートを指定します。

Integer

proxyProtocol (common)

S3 クライアントをインスタンス化するときにプロキシープロトコルを定義します。

列挙値:

HTTPS

Protocol

region (common)

S3 クライアントが機能する必要があるリージョン。このパラメーターを使用する場合、設定には小文字のリージョン名を指定します (例 ap-east-1)。名前 Region.EU_WEST_1.id() を使用する必要があります。

String

trustAllCertificates (common)

エンドポイントをオーバーライドするときにすべての証明書を信頼する場合。

false

boolean

uriEndpointOverride (common)

オーバーライドする URI エンドポイントを設定します。このオプションは overrideEndpoint オプションと組み合わせて使用する必要があります。

String

useDefaultCredentialsProvider (common)

デフォルトのクレデンシャルプロバイダー経由でクレデンシャルをロードすること、または静的クレデンシャルが渡されることを S3 クライアントは想定すべきかどうかを設定します。

false

boolean

customerAlgorithm (common (advanced))

CustomerKey が有効になっている場合に使用するカスタマーアルゴリズムを定義します。

String

customerKeyId (common (advanced))

CustomerKey が有効になっている場合に使用するカスタマーキーの ID を定義します。

String

customerKeyMD5 (common (advanced))

CustomerKey が有効になっている場合に使用するカスタマーキーの MD5 を定義します。

String

bridgeErrorHandler (consumer)

コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。

false

boolean

deleteAfterRead (consumer)

取得後に S3 からオブジェクトを削除します。削除は、エクスチェンジがコミットされた場合にのみ実行されます。ロールバックが発生すると、オブジェクトは削除されません。このオプションが false の場合、同じオブジェクトがポーリングで繰り返し取得されます。そのため、ルートで Idempotent Consumer EIP を使用して重複を除外する必要があります。AWS2S3Constants#BUCKET_NAME および AWS2S3Constants#KEY ヘッダーを使用してフィルターすることも、AWS2S3Constants#KEY ヘッダーのみを使用してフィルターすることもできます。

true

boolean

delimiter (consumer)

対象のオブジェクトのみを消費するために com.amazonaws.services.s3.model.ListObjectsRequest で使用される区切り文字。

String

destinationBucket (consumer)

moveAfterRead が true に設定されている場合にオブジェクトを移動する必要がある宛先バケットを定義します。

String

destinationBucketPrefix (consumer)

オブジェクトを移動する必要があり、moveAfterRead が true に設定されている場合に使用する宛先バケット接頭辞を定義します。

String

destinationBucketSuffix (consumer)

オブジェクトを移動する必要があり、moveAfterRead が true に設定されている場合に使用する宛先バケット接尾辞を定義します。

String

doneFileName (consumer)

指定すると、Camel は完了したファイルが存在する場合にのみファイルを消費します。

String

fileName (consumer)

指定のファイル名を持つバケットからオブジェクトを取得します。

String

ignoreBody (consumer)

true の場合、S3 オブジェクトボディは完全に無視されます。false に設定されている場合、S3 オブジェクトはボディに配置されます。これを true に設定すると、includeBody オプションで定義された動作がオーバーライドされます。

false

boolean

includeBody (consumer)

true の場合、S3Object エクスチェンジが消費され、ボディーに配置され、閉じられます。false の場合、S3Object ストリームは raw でボディーに配置され、ヘッダーは S3 オブジェクトメタデータで設定されます。このオプションは、autocloseBody オプションと密接に関係します。S3Object ストリームが消費されるため includeBody を true に設定した場合、includeBody が false であっても閉じられるため、S3Object ストリームを閉じるのは呼び出し側が判断します。しかし、includeBody が false の場合に autocloseBody を true に設定すると、エクスチェンジの完了時に S3Object ストリームを自動的に閉じるようにスケジュールされます。

true

boolean

includeFolders (consumer)

true の場合、フォルダー/ディレクトリーが消費されます。false の場合は無視され、エクスチェンジは作成されません。

true

boolean

maxConnections (consumer)

S3 クライアント設定の maxConnections パラメーターを設定します。

60

int

maxMessagesPerPoll (consumer)

各ポーリングのポーリング制限としてメッセージの最大数を取得します。各ポーリングのポーリング制限としてメッセージの最大数を取得します。デフォルト値は 10 です。0 または負の値を使用すると、無制限として設定されます。

10

int

moveAfterRead (consumer)

オブジェクトの取得後に S3 バケットから別のバケットに移動します。操作を実行するには、destinationBucket オプションを設定する必要があります。copy bucket 操作は、エクスチェンジがコミットされた場合にのみ実行されます。ロールバックが発生した場合、オブジェクトは移動しません。

false

boolean

prefix (consumer)

対象のオブジェクトのみを消費するために com.amazonaws.services.s3.model.ListObjectsRequest で使用される接頭辞。

String

sendEmptyMessageWhenIdle (consumer)

ポーリング consumer がファイルをポーリングしなかった場合、このオプションを有効にして、代わりに空のメッセージ (ボディーなし) を送信できます。

false

boolean

autocloseBody (consumer (advanced))

このオプションが true で、includeBody が false の場合、エクスチェンジの完了時に S3Object.close() メソッドが呼び出されます。このオプションは includeBody オプションと密接に関係しています。includeBody を false に設定し、autocloseBody を false に設定した場合、S3Object ストリームを閉じるのは呼び出し側が判断します。autocloseBody を true に設定すると、S3Object ストリームが自動的に閉じられます。

true

boolean

exceptionHandler (consumer (advanced))

consumer によるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。

ExceptionHandler

exchangePattern (consumer (advanced))

consumer がエクスチェンジを作成する際に交換パターンを設定します。

列挙値:

ExchangePattern

pollStrategy (consumer (advanced))

プラグ可能な org.apache.camel.PollingConsumerPollingStrategy を使用すると、エクスチェンジが作成され、Camel でルーティングされる前に、通常はポーリング操作中に発生するエラー処理を制御するカスタム実装が提供できます。

PollingConsumerPollStrategy

batchMessageNumber (producer)

ストリーミングのアップロードモードでバッチを作成するメッセージの数

10

int

batchSize (producer)

ストリーミングのアップロードモードのバッチサイズ (バイト単位)

1000000

int

deleteAfterWrite (producer)

S3 ファイルのアップロード後にファイルオブジェクトを削除します。

false

boolean

keyName (producer)

endpoint パラメーター経由でバケットの要素のキー名を設定します。

String

lazyStartProducer (producer)

最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時に producer が失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、producer の作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。

false

boolean

multiPartUpload (producer)

true の場合、Camel はマルチパート形式のファイルをアップロードし、パートサイズは partSize のオプションによって決定されます。

false

boolean

namingStrategy (producer)

ストリーミングのアップロードモードで使用する命名ストラテジー。

列挙値:

progressive

AWSS3NamingStrategyEnum

operation (producer)

ユーザーがアップロードだけをしたくない場合に行う操作。

列挙値:

AWS2S3Operations

partSize (producer)

マルチパートのアップロードで使用される partSize を設定します。デフォルトのサイズは 25M です。

26214400

long

restartingPolicy (producer)

ストリーミングのアップロードモードで使用する再起動ポリシー。

列挙値:

override

AWSS3RestartingPolicyEnum

storageClass (producer)

com.amazonaws.services.s3.model.PutObjectRequest リクエストに設定するストレージクラス。

String

streamingUploadMode (producer)

ストリームモードが true の場合、バケットへのアップロードはストリーミングで行われます。

false

boolean

streamingUploadTimeout (producer)

ストリーミングアップロードモードが true の場合、このオプションはタイムアウトを設定してアップロードを完了します。

long

awsKMSKeyId (producer (advanced))

KMS が有効になっている場合に使用する KMS キーの ID を定義します。

String

useAwsKMS (producer (advanced))

KMS を使用する必要があるかどうかを定義します。

false

boolean

useCustomerKey (producer (advanced))

カスタマーキーを使用する必要があるかどうかを定義します。

false

boolean

backoffErrorThreshold (scheduler)

backoffMultipler が開始する前に発生する必要がある後続のエラーポーリング (エラーによって失敗した) の数。

int

backoffIdleThreshold (scheduler)

backoffMultipler が開始する前に発生する必要がある後続のアイドルポーリングの数。

int

backoffMultiplier (scheduler)

後続のアイドル状態/エラーが連続して発生した場合に、スケジュールされたポーリング consumer のバックオフを許可します。乗数は、実際に次の試行が行われる前にスキップされるポーリングの数です。このオプションが使用されている場合は、backoffIdleThreshold や backoffErrorThreshold も設定する必要があります。

int

delay (scheduler)

次のポーリングまでの時間 (ミリ秒単位)。

500

long

greedy (scheduler)

greedy が有効で、以前の実行が 1 つ以上のメッセージをポーリングした場合、ScheduledPollConsumer は即座に再度実行されます。

false

boolean

initialDelay (scheduler)

最初のポーリングが開始されるまでの時間 (ミリ秒単位)。

1000

long

repeatCount (scheduler)

実行の最大数を指定します。そのため、これを 1 に設定するとスケジューラーは 1 度だけ実行されます。これを 5 に設定した場合、5 回だけ実行されます。0 または負の値を設定すると、無制限に実行されます。

0

long

runLoggingLevel (scheduler)

consumer はポーリング時に開始/完了のログ行を記録します。このオプションを使用すると、ログレベルを設定できます。

列挙値:

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

consumer に使用するカスタム/共有スレッドプールを設定できます。デフォルトでは、各 consumer に独自の単一スレッドのスレッドプールがあります。

ScheduledExecutorService

scheduler (scheduler)

camel-spring または camel-quartz コンポーネントから cron スケジューラーを使用します。スケジューラーにビルドされた値 spring または quartz を使用。

none

Object

schedulerProperties (scheduler)

カスタムスケジューラーまたは Quartz や Spring ベースのスケジューラーを使用する場合に、追加のプロパティーを設定します。

Map

startScheduler (scheduler)

スケジューラーを自動起動するかどうか。

true

boolean

timeUnit (scheduler)

initialDelay および delay オプションの時間単位。

列挙値:

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

固定遅延または固定レートを使用するかどうかを制御します。詳細は、JDK の ScheduledExecutorService を参照してください。

true

boolean

accessKey (security)

Amazon AWS Access Key。

String

secretKey (security)

Amazon AWS Secret Key。

String