Amazon SQS Connector 5.10 リファレンス - Mule 4

Amazon SQS 用 Anypoint Connector (Amazon SQS Connector) を使用すると、Amazon Simple Queue Service (Amazon SQS) API に接続し、Amazon SQSAPI を直接操作することなく SQS キューサービスを管理できます。

設定


デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Default Global Queue URL (デフォルトのグローバルキュー URL)

String (文字列)

この値は、操作レベルでキュー URL を設定しない場合に使用されます。ここで、または操作レベルでキュー URL を指定しない場合、例外がスローされます。キュー URL は、​https://sqs.{REGION}.amazonaws.com/{ACCOUNT_NUMBER}/{QUEUE_NAME}​ 形式で作成されます (例: https://sqs.us-east-1.amazonaws.com/123456789101/test-queue​)。

Default Wait Time (デフォルトの待機時間)

Number (数値)

単一ポーリングの最大期間のデフォルト値 (秒)。

  • ロングポーリングを使用するには、この項目を ​1​ ~ ​20​ の値に設定します。ロングポーリングでは、すぐに使用できるメッセージがある場合、コネクタはクエリ結果をすぐに返します。それ以外の場合、コネクタはメッセージが追加されるまで指定された秒数待機してから、空の応答を返します。

  • ショートポーリングを使用するには、この項目を ​0​ に設定します。ショートポーリングでは、空の応答を返す場合でも、コネクタは常にできるだけ早くクエリ結果を返します。

20

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

接続種別

Basic (基本)

基本認証方法では、Amazon STS が提供するセッショントークンを使用して Amazon SQS に接続します。

パラメーター
名前 説明 デフォルト値 必須

Session Token (セッショントークン)

String (文字列)

Amazon STS が提供するセッショントークン。

Test Queue ARN (キュー ARN をテスト)

String (文字列)

このパラメーターは、SQS Connector への接続をテストするために使用されます。このパラメーターを指定しない場合、テスト接続は実行されません。キュー ARN は、​arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}​ 形式で作成されます (例: arn:aws:sqs:us-east-1:123456789101:test-queue​)。

Large Payload Support (大容量のペイロードサポート)

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがギブアップまたはタイムアウトする前に、接続を最初に確立するのを待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Max Connections (最大接続数)

Number (数値)

許可される開いた HTTP 接続の最大数を設定します。

Socket Timeout (ソケットタイムアウト)

Number (数値)

接続がタイムアウトする前に、確立または開いた接続でのデータの転送を待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Access Key (アクセスキー)

String (文字列)

Amazon が提供するアクセスキー。

x

Secret Key (シークレットキー)

String (文字列)

Amazon が提供するシークレットキー。

x

Try Default AWSCredentials Provider Chain (デフォルトの AWSCredentials プロバイダーチェーンを試す)

Boolean (ブール)

AWS 環境からログイン情報を取得するには、この項目を ​true​ に設定します。​https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.htmlLeaving the Site を参照してください。

false

Region Endpoint (リージョンエンドポイント)

String (文字列)

トピックリージョンエンドポイントを設定します。

US_EAST_1

Custom SQS Endpoint (カスタム SQS エンドポイント)

String (文字列)

カスタム SQS エンドポイントを設定します。Virtual Private Cloud (VPC) エンドポイントなど、非標準のサービスエンドポイントが必要な場合に役立ちます。

TLS Configuration (TLS 設定)

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Host (ホスト)

String (文字列)

省略可能なプロキシホスト。

Port (ポート)

Number (数値)

省略可能なプロキシポート。

Username (ユーザー名)

String (文字列)

省略可能なプロキシユーザー名。

Password (パスワード)

String (文字列)

省略可能なプロキシパスワード。

Domain (ドメイン)

String (文字列)

省略可能なプロキシドメイン。

Workstation (ワークステーション)

String (文字列)

省略可能なプロキシワークステーション。

Role (ロール)

クロスアカウントアクセスを許可することを前提とするロールを一意に特定する Amazon ロール ARN を設定します。

パラメーター
名前 説明 デフォルト値 必須

Role ARN (ロール ARN)

String (文字列)

クロスアカウントアクセスを取得することを前提とするロールを一意に特定するロール ARN。

x

Test Queue ARN (キュー ARN をテスト)

String (文字列)

コネクタへの接続をテストするために使用するパラメーター。このパラメーターを指定しない場合、テスト接続は実行されません。キュー ARN は、​arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}​ 形式で作成されます (例: arn:aws:sqs:us-east-1:123456789101:test-queue​)。

Large Payload Support (大容量のペイロードサポート)

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがタイムアウトする前に、接続を最初に確立するのを待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Max Connections (最大接続数)

Number (数値)

許可される開いた HTTP 接続の最大数を設定します。

Socket Timeout (ソケットタイムアウト)

Number (数値)

接続がタイムアウトする前に、確立または開いた接続でのデータの転送を待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Access Key (アクセスキー)

String (文字列)

Amazon が提供するアクセスキー。

x

Secret Key (シークレットキー)

String (文字列)

Amazon が提供するシークレットキー。

x

Try Default AWSCredentials Provider Chain (デフォルトの AWSCredentials プロバイダーチェーンを試す)

Boolean (ブール)

AWS 環境からログイン情報を取得するには、この項目を true に設定します。 https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.htmlLeaving the Site を参照してください。

false

Region Endpoint (リージョンエンドポイント)

String (文字列)

トピックリージョンエンドポイントを設定します。

US_EAST_1

Custom SQS Endpoint (カスタム SQS エンドポイント)

String (文字列)

カスタム SQS エンドポイントを設定します。Virtual Private Cloud (VPC) エンドポイントなど、非標準のサービスエンドポイントが必要な場合に役立ちます。

TLS Configuration (TLS 設定)

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Host (ホスト)

String (文字列)

省略可能なプロキシホスト。

Port (ポート)

Number (数値)

省略可能なプロキシポート。

Username (ユーザー名)

String (文字列)

省略可能なプロキシユーザー名。

Password (パスワード)

String (文字列)

省略可能なプロキシパスワード。

Domain (ドメイン)

String (文字列)

省略可能なプロキシドメイン。

Workstation (ワークステーション)

String (文字列)

省略可能なプロキシワークステーション。

ソース

Receive messages

<sqs:receivemessages>

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Visibility Timeout (表示タイムアウト)

Number (数値)

他のコンシューマーがキュー内の同じメッセージを受信および処理することを防止する期間。

30

Visibility Timeout Unit (表示タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

表示タイムアウト設定で使用する時間単位。

SECONDS (秒)

Preserve Messages (メッセージを保持)

Boolean (ブール)

メッセージを読み取った直後にキューから削除する代わりに、メッセージを読み取った後に保持します。

false

Number Of Messages (メッセージ数)

Number (数値)

1

Queue Url (キュー URL)

String (文字列)

メッセージを受信するキューの URL。

Wait time (待機時間)

Number (数値)

単一ポーリングの最大期間 (秒)。

  • ロングポーリングを使用するには、この項目を ​1​ ~ ​20​ の値に設定します。ロングポーリングでは、すぐに使用できるメッセージがある場合、コネクタはクエリ結果をすぐに返します。それ以外の場合、コネクタはメッセージが追加されるまで指定された秒数待機してから、空の応答を返します。

  • ショートポーリングを使用するには、この項目を ​0​ に設定します。ショートポーリングでは、空の応答を返す場合でも、コネクタは常にできるだけ早くクエリ結果を返します。

Number of consuming threads (コンシュームスレッドの数)

Number (数値)

インバウンドフローでメッセージをコンシュームするために使用されるスレッドの数。この値は、0 よりも大きい整数である必要があります。

1

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターモードでの実行時、このソースをプライマリノード上でのみ実行するかどうか。

Frequency (頻度)

number (数値)

[Time unit (時間単位)] 項目で指定された時間単位で、コネクタが受信メッセージをポーリングする頻度。この値を ​0​ に設定すると、コネクタは可能な限り速くポーリングします。

1000

Start delay (開始遅延)

Number (数値)

[Time unit (時間単位)] 項目で指定された時間単位で、コネクタが受信メッセージのポーリングを開始する前に待機する時間。デフォルト値の ​0​ は、コネクタがすぐにポーリングを開始することを意味します。

0

Time unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Frequency (頻度)] および [Start delay (開始遅延)] 項目値の時間単位。

MILLISECONDS (ミリ秒)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

String (文字列)

次の設定の場合

操作

Add Permission

<sqs:add-permission>

この操作は、権限をメッセージキューに追加します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Label (表示ラベル)

String (文字列)

この権限の名前。

x

Account Ids (アカウント ID)

Array of String (文字列の配列)

このキューを共有する AWS アカウントの ID。

x

Actions (アクション)

Array of String (文字列の配列)

どのような権限を付与するのか示すリスト (SendMessage、ReceiveMessage、ChangeMessageVisibility、DeleteMessage、GetQueueAttributes)。

x

Queue Url (キュー URL)

String (文字列)

権限は、この URL で表されるキューに追加されます。このパラメーターは省略可能で、​queueUrl​ を指定しない場合、設定レベルで [Default Global Queue URL (デフォルトのグローバルキュー URL)] を指定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Change Message Visibility

<sqs:change-message-visibility>

この操作は、キューの指定されたメッセージの表示タイムアウトを新しい (12 時間を超えない) 値に変更します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Receipt Handle (受信ハンドル)

String (文字列)

表示タイムアウトを変更する必要があるメッセージに関連付けられている受信ハンドル。

Visibility Timeout (表示タイムアウト)

Number (数値)

メッセージ表示タイムアウトの新しい値 (最大 4300 秒または 12 時間)。

x

Visibility Timeout Unit (表示タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

SECONDS (秒)

Queue Url (キュー URL)

String (文字列)

アクションを実行する Amazon SQS キューの URL。このパラメーターは省略可能で、​queueUrl​ を指定しない場合、設定レベルで [Default Global Queue URL (デフォルトのグローバルキュー URL)] を指定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Change Message Visibility Batch

<sqs:change-message-visibility-batch>

この操作は、最大 10 個の ChangeMessageVisibility 要求の表示タイムアウトを変更し、応答で各結果を個別に報告します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Receipt Handles (受信ハンドル)

表示タイムアウトを変更する必要があるメッセージの受信ハンドルのリスト。

#[payload]

Queue Url (キュー URL)

String (文字列)

アクションを実行する Amazon SQS キューの URL。このパラメーターは省略可能で、​queueUrl​ を指定しない場合、設定レベルで [Default Global Queue URL (デフォルトのグローバルキュー URL)] を指定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Batch Result

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Create Queue

<sqs:create-queue>

この操作は、新しいキューを作成するか、既存のキューの URL を返します。

キュー属性

名前 説明 デフォルト値 必須

DelaySeconds

Number (数値)

キュー内のすべてのメッセージの配信を遅延する時間 (秒)。有効な値: 0 ~ 900 秒 (15 分) の整数。

0

MaximumMessageSize

Number (数値)

Amazon SQS がメッセージを拒否する前にそのメッセージに含めることができるバイト数の制限。有効な値: 1,024 バイト (1 KiB) ~ 262,144 バイト (256 KiB) の整数。

262,144 (256 KiB)

MessageRetentionPeriod

Number (数値)

Amazon SQS がメッセージを保持する時間 (秒)。有効な値: 60 秒 (1 分) ~ 1,209,600 秒 (14 日) の整数。

345,600 (4 日)

Policy (ポリシー)

String (文字列)

キューのポリシー。有効な AWS ポリシー。

ReceiveMessageWaitTimeSeconds

Number (数値)

ReceiveMessage アクションがメッセージの到着を待機する時間 (秒)。有効な値: 0 ~ 20 の整数 (秒)。

0

RedrivePolicy

String (文字列)

ソースキューのデッドレターキュー機能のパラメーターを JSON オブジェクトとして含む文字列。

VisibilityTimeout

Number (数値)

キューの表示タイムアウト (秒)。有効な値: 0 ~ 43,200 (12 時間) の整数。

30

KmsMasterKeyId

String (文字列)

Amazon SQS またはカスタム CMK の AWS 管理 Customer Master Key (CMK) の ID。

KmsDataKeyReusePeriodSeconds

Number (数値)

AWS KMS を再度コールする前に、Amazon SQS がデータキーを再利用してメッセージを暗号化または復号化できる時間 (秒)。60 秒 (1 分) ~ 86,400 秒 (24 時間) の秒を表す整数。

300 (5 minutes)

FifoQueue

Boolean (ブール)

キューを FIFO として指定します。有効な値は true または false です。FifoQueue 属性を指定しない場合、Amazon SQS は標準キューを作成します。キューの作成時にこの属性を指定する必要があり、既存のキューでこの属性を変更することはできません。この属性を設定するときは、メッセージの MessageGroupId も明示的に指定する必要があります。

ContentBasedDeduplication

Boolean (ブール)

コンテンツベースの重複排除を有効にします。有効な値は true、false です。すべてのメッセージには、一意の MessageDeduplicationId が必要です。

ApproximateNumberOfMessages

Number (数値)

キューから取得できるおおよそのメッセージ数。

ApproximateNumberOfMessagesDelayed

Number (数値)

遅延していてすぐに読み取ることができないキュー内のおおよそのメッセージ数。これは、キューが遅延キューとして設定されている場合、またはメッセージが遅延パラメーターを使用して送信された場合に発生する可能性があります。

ApproximateNumberOfMessagesNotVisible

Number (数値)

おおよそのインフライトメッセージ数。メッセージがクライアントに送信されてもまだ削除されていないか、表示ウィンドウの最後に到達していない場合、インフライトメッセージとみなされます。

CreatedTimestamp

Number (数値)

キューが作成された時刻 (秒)。

LastModifiedTimestamp

Number (数値)

キューが最後に変更された時刻 (秒)。

QueueArn

String (文字列)

キューの Amazon リソース名 (ARN)。

リドライブポリシー

名前 説明 デフォルト値 必須

deadLetterTargetArn

String (文字列)

maxReceiveCount の値を超えた後に、Amazon SQS によってメッセージが移動されるデッドレターキューの Amazon リソース名 (ARN)。

maxReceiveCount

Number (数値)

メッセージがデッドレターキューに移動される前にソースキューに配信された回数。メッセージの ReceiveCount がキューの maxReceiveCount を超えると、Amazon SQS はメッセージをデッドレターキューに移動します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Name (キュー名)

String (文字列)

作成するキューの名前。

x

Attributes (属性)

Object (オブジェクト)

対応する値との属性のマップ。(上の表を参照)。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Delete Message

<sqs:delete-message>

この操作は、キュー内のメッセージオブジェクトによって特定されたメッセージを削除します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Receipt Handle (受信ハンドル)

String (文字列)

削除するメッセージの受信ハンドル。

x

Queue Url (キュー URL)

String (文字列)

メッセージを削除するキューの URL。このパラメーターは省略可能で、queueUrl を指定しない場合、設定レベルの [Default Global Queue URL (デフォルトのグローバルキュー URL)] で設定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Delete Message Batch

<sqs:delete-message-batch>

この操作は、指定されたキューから最大 10 個のメッセージを削除します。これは、DeleteMessage のバッチバージョンです。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Entries (エントリ)

削除するメッセージの受信ハンドルのリスト。

x

Queue Url (キュー URL)

String (文字列)

バッチとしてメッセージを削除するキューの URL。このパラメーターは省略可能で、queueUrl を指定しない場合、設定レベルで [Default Global Queue URL (デフォルトのグローバルキュー URL)] を指定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Batch Result

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Delete Queue

<sqs:delete-queue>

この操作は、このオブジェクトによって表されるメッセージキューを削除し、空でないキューも削除できます。キューの削除には最大 60 秒かかるため、同じ名前で新しいキューを作成する前に、少なくともその時間待機します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Url (キュー URL)

String (文字列)

削除するキューの URL。このパラメーターは省略可能で、queueUrl を指定しない場合、設定レベルの [Default Global Queue URL (デフォルトのグローバルキュー URL)] で設定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Approximate Number Of Messages

<sqs:get-approximate-number-of-messages>

この操作は、表示されるキューのメッセージのおおよその数を取得します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Url (キュー URL)

String (文字列)

キューの URL。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Number (数値)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Queue Attributes

<sqs:get-queue-attributes>

この操作は、基盤となる機能を公開するためのキュー属性を表示します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Attribute Names (属性名)

Array of String (文字列の配列)

情報を取得する属性のリスト。

Queue Url (キュー URL)

String (文字列)

アクションを実行する Amazon SQS キューの URL。このパラメーターは省略可能で、queueUrl を指定しない場合、設定成レベルの [Default Global Queue URL (デフォルトのグローバルキュー URL)] で設定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Object (オブジェクト)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Get Queue Url

<sqs:get-queue-url>

この操作は、既存のキューの URL を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Name (キュー名)

String (文字列)

URL をフェッチする必要があるキューの名前。

x

Queue Owner AWS Account Id (キューのオーナーの AWS アカウント ID)

String (文字列)

キューを作成したオーナーの AWS アカウント ID。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

List Dead Letter Source Queues

<sqs:list-dead-letter-source-queues>

この操作は、デッドレターキューで RedrivePolicy キュー属性が設定されているキューのリストを返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Url (キュー URL)

String (文字列)

デッドレターキューのキュー URL。このパラメーターは省略可能で、queueUrl を指定しない場合、設定レベルの [Default Global Queue URL (デフォルトのグローバルキュー URL)] で設定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Array of String (文字列の配列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

List Queues

<sqs:list-queues>

この操作は、キューのリストを返します。返すことができるキューの最大数は 1000 です。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Name Prefix (キュー名のプレフィックス)

String (文字列)

リスト結果の絞り込みに使用する文字列。指定された文字列で始まる名前のキューのみが返されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Array of String (文字列の配列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Purge Queue

<sqs:purge-queue>

この操作は、キュー URL で指定されるキューのメッセージを削除します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Url (キュー URL)

String (文字列)

メッセージをフェッチするキュー URL。このパラメーターは省略可能で、queueUrl を指定しない場合、設定レベルの [Default Global Queue URL (デフォルトのグローバルキュー URL)] で設定する必要があります。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Read

<sqs:read>

この操作は、キューからメッセージの数を読み取ります。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue Url (キュー URL)

String (文字列)

キューの URL。

Max Number Of Messages (最大メッセージ数)

Number (数値)

読み取るメッセージの最大数。

x

Wait time (待機時間)

Number (数値)

単一ポーリングの最大期間 (秒)。

  • ロングポーリングを使用するには、この項目を ​1​ ~ ​20​ の値に設定します。

    ロングポーリングでは、すぐに使用できるメッセージがある場合、コネクタはクエリ結果をすぐに返します。それ以外の場合、コネクタはメッセージが追加されるまで指定された秒数待機してから、空の応答を返します。

  • ショートポーリングを使用するには、この項目を ​0​ に設定します。ショートポーリングでは、空の応答を返す場合でも、コネクタは常にできるだけ早くクエリ結果を返します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Message (メッセージ)​ の配列

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Remove Permission

<sqs:remove-permission>

この操作は、このメッセージキューから権限を削除します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Label (表示ラベル)

String (文字列)

削除する権限の名前。

x

Queue Url (キュー URL)

String (文字列)

権限は、この URL で表されるキューから削除されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Send Message

<sqs:send-message>

この操作は、指定されたキューにメッセージを送信します。メッセージは 1 ~ 256 KB にする必要があります。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Message (メッセージ)

送信するメッセージ。

#[payload]

Queue Url (キュー URL)

String (文字列)

メッセージを送信するキュー。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Send Message Batch

<sqs:send-message-batch>

この操作は、指定されたキューに最大 10 個のメッセージを配信します。これは、SendMessage のバッチバージョンです。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Messages

SendMessageBatchRequestEntry 項目のリスト。

#[payload]

Queue Url (キュー URL)

String (文字列)

メッセージを送信するキュー。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Batch Result

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:MESSAGE_SIZE_THRESHOLD_OUT_OF_RANGE

  • SQS:S3_BUCKET_ACCESS_DENIED

  • SQS:RETRY_EXHAUSTED

  • SQS:S3_BUCKET_NOT_FOUND

  • SQS:CONNECTIVITY

Set Queue Attributes

<sqs:set-queue-attributes>

この操作は、1 つ以上のキュー属性の値を設定します。SQS システム全体に伝播されるのに最大 60 秒かかります (ただし、MessageRetentionPeriod 属性への変更には最大 15 分かかります)。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Attributes (属性)

Object (オブジェクト)

設定する属性のマップ。

#[payload]

Queue Url (キュー URL)

String (文字列)

キューの URL。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SQS:RETRY_EXHAUSTED

  • SQS:CONNECTIVITY

Large Payload Support (大容量のペイロードサポート)

項目 説明 デフォルト値 必須

Bucket (バケット)

String (文字列)

大容量のペイロードメッセージを保存する AWS S3 バケットの名前。AWS S3 バケットは、AWS S3 ですでに作成および設定されている必要があります。この機能を有効にすると、AWS S3 の使用で追加料金が発生します。

x

Message Size Threshold (メッセージサイズしきい値)

Number (数値)

AWS S3 バケットにメッセージペイロードを保存するためのメッセージサイズしきい値。メッセージサイズしきい値のデフォルト値は 256 KB で、最大しきい値サイズの値は 256 KB です。最大メッセージサイズは 2 GB です。

256

Message Size Threshold Unit (メッセージサイズしきい値単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

メッセージサイズしきい値のデータ単位を設定します。

KB

Custom S3 Endpoint (カスタム S3 エンドポイント)

String (文字列)

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

サーバーの場合、トラストストアには信頼済みのクライアントの証明書が格納されています。クライアントの場合、トラストストアには信頼済みサーバーの証明書が格納されています。

Key Store (キーストア)

サーバーの場合、キーストアにはサーバーの非公開キーと公開キーが格納されています。クライアントの場合、キーストアにはクライアントの非公開キーと公開キーが格納されています。

Revocation Check (取り消し確認)

証明書が失効したことを検証します。

トラストストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所。このパスは、可能であれば、現在のクラスパスとファイルシステムに対して解決されます。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するトラストストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、証明書の検証が行われず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所。このパスは、可能であれば、現在のクラスパスとファイルシステムに対して解決されます。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに複数の非公開キーが格納されている場合に使用するキーの別名。定義しない場合、ファイルにある最初のキーがデフォルトで使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 ([Prefer Crls (CRL を優先)] 項目で指定されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

Redelivery Policy (再配信ポリシー)

項目 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずにプロセス失敗メッセージがトリガーされるまでにメッセージを再配信できる最大回数。

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。

Object Store (オブジェクトストア)

Object Store (オブジェクトストア)

各メッセージの再配信カウンターが保存されるオブジェクトストア。

Batch Result

項目 説明 デフォルト値 必須

Failed (失敗)

BatchResultErrorEntry​ の配列

Successful (成功)

Array of String (文字列の配列)

Batch Result Error Entry (バッチ結果エラーエントリ)

項目 説明 デフォルト値 必須

Code (コード)

String (文字列)

このエントリでアクションが失敗した理由を表すエラーコード。

Id

String (文字列)

バッチ要求のエントリの ID。

Message (メッセージ)

String (文字列)

このエントリでアクションが失敗した理由を説明するメッセージ。

Sender Fault (送信者エラー)

Boolean (ブール)

送信者のエラーが原因でエラーが発生したかどうか。

Request ID Attribute (要求 ID 属性)

項目 説明 デフォルト値 必須

Request Id (要求 ID)

String (文字列)

サービスコールが期待どおりに機能せず、AWS サポートと連携して問題をデバッグする必要がある場合に使用できる AWS 要求 ID。

Change Message Visibility Batch Request Entry (メッセージ表示のバッチ変更要求エントリ)

項目 説明 デフォルト値 必須

Id

String (文字列)

この特定の受信ハンドルの識別子。これは、結果を伝えるために使用されます。バッチ要求の ​Id​ は、要求内で一意である必要があります。

Receipt Handle (受信ハンドル)

String (文字列)

このエントリの受信ハンドル。

Visibility Timeout (表示タイムアウト)

Number (数値)

メッセージの表示タイムアウトの新しい値 (秒)。

Delete Message Batch Request Entry (メッセージのバッチ削除要求エントリ)

項目 説明 デフォルト値 必須

Id

String (文字列)

この特定の受信ハンドルの識別子。これは、結果を伝えるために使用されます。バッチ要求の ​Id​ は、要求内で一意である必要があります。

Receipt Handle (受信ハンドル)

String (文字列)

このエントリの受信ハンドル。

Message (メッセージ)

送信されたメッセージの出力属性。

項目 説明 デフォルト値 必須

body (本文)

String (文字列)

送信するメッセージ本文。

deduplicationId

String (文字列)

送信されたメッセージを重複排除するためのトークン。同じ重複排除 ID で複数のメッセージが送信された場合、Amazon SQS はメッセージを正常に受け入れますが、5 分間の重複排除間隔中に最初のメッセージのみを配信します。

delaySeconds

Number (数値)

特定のメッセージを遅延する秒数。有効な値は 0 ~ 900 です。 値が指定されていない場合、キューのデフォルト値が使用されます。このパラメーターはキューレベルでのみ設定できます。FifoQueue が設定されている場合、メッセージごとに DelaySeconds を設定することはできません。

groupId

String (文字列)

FIFO キューでこのメッセージが属するグループ。このパラメーターは、FIFO キューにのみ適用されます。 FIFO キューを作成するときに、このパラメーターは必須です。

id

String (文字列)

メッセージの一意の識別子。

message Attributes (メッセージ属性)

Object (オブジェクト)

メッセージ属性として送信する型付けされたキー-値ペアのマップ。各エントリの値、キー、およびデータ型を指定する必要があります。

receipt Handle (受信ハンドル)

String (文字列)

このエントリの受信ハンドル。

Send Message Result (メッセージの送信結果)

項目 説明 デフォルト値 必須

MD5 Of Message Attributes (メッセージ属性の MD5)

String (文字列)

URL エンコードされていないメッセージ属性文字列の MD5 ダイジェスト。これを使用して、Amazon SQS がメッセージを適切に受信したことを確認できます。Amazon SQS は、MD5 ダイジェストを作成する前メッセージを URL デコードします。MD5 についての詳細は、 「RFC 1321 - The MD5 Message-Digest Algorithm (RFC 1321 - MD5 メッセージ-ダイジェストアルゴリズム)」Leaving the Site​を参照してください。

MD5 Of Message Body (メッセージ本文の MD5)

String (文字列)

URL エンコードされていないメッセージ本文文字列の MD5 ダイジェスト。これを使用して、Amazon SQS がメッセージを適切に受信したことを確認できます。Amazon SQS は、MD5 ダイジェストを作成する前メッセージを URL デコードします。MD5 についての詳細は、 「RFC 1321 - The MD5 Message-Digest Algorithm (RFC 1321 - MD5 メッセージ-ダイジェストアルゴリズム)」Leaving the Site​を参照してください。

Message Id (メッセージ ID)

String (文字列)

キューに送信されたメッセージのメッセージ ID を含む要素。詳細は、 「Amazon SQS キューとメッセージの識別子」Leaving the Site​を参照してください。