MQ - AWS Serverless Application Model
構文プロパティ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

MQ

MQ イベントソースタイプを説明するオブジェクトです。詳細については、AWS Lambda デベロッパーガイドの「Amazon MQ での Lambda の使用」を参照してください。

AWS Serverless Application Model （AWS SAM) は、このイベントタイプが設定されると AWS::Lambda::EventSourceMappingリソースを生成します。

注記

パブリックネットワークで Lambda 関数に接続する仮想プライベートクラウド (VPC) に Amazon MQ キューを配置するには、関数の実行ロールに次の許可が含まれている必要があります。

  • ec2:CreateNetworkInterface

  • ec2:DeleteNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

詳細については、AWS Lambda デベロッパーガイドの「実行ロールのアクセス許可」を参照してください。

構文

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

プロパティ

BatchSize

単一のバッチで取得する項目の最大数です。

タイプ: 整数

必須: いいえ

デフォルト: 100

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの BatchSizeプロパティに直接渡されます。

最小: 1

最大: 10000

Broker

Amazon MQ ブローカーの Amazon リソースネーム (ARN) です。

型: 文字列

必須: はい

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの EventSourceArnプロパティに直接渡されます。

DynamicPolicyName

デフォルトでは、 AWS Identity and Access Management (IAM) ポリシー名は下位互換性SamAutoGeneratedAMQPolicyのために です。IAM ポリシーのために自動生成された名前を使用するには true を指定します。この名前には、Amazon MQ イベントソースの論理 ID が含まれます。

注記

複数の Amazon MQ イベントソースを使用する場合は、IAM ポリシー名の重複を避けるために true を指定します。

タイプ: ブール

必須: いいえ

デフォルト: false

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

Enabled

true の場合、イベントソースマッピングがアクティブになります。ポーリングと呼び出しを一時停止するには、false に設定します。

タイプ: ブール

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの Enabledプロパティに直接渡されます。

FilterCriteria

Lambda がイベントを処理する必要があるかどうかを判断する基準を定義するオブジェクト。詳細については、AWS Lambda デベロッパーガイドの AWS Lambda イベントのフィルタリングを参照してください。

タイプ: FilterCriteria

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの FilterCriteriaプロパティに直接渡されます。

KmsKeyArn

このイベントに関連する情報を暗号化するためのキーの Amazon リソースネーム (ARN)。

型: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの KmsKeyArnプロパティに直接渡されます。

MaximumBatchingWindowInSeconds

関数を呼び出すまでのレコード収集の最大時間 (秒) です。

タイプ: 整数

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの MaximumBatchingWindowInSecondsプロパティに直接渡されます。

Queues

消費する Amazon MQ ブローカーの送信先キューの名前です。

タイプ: リスト

必須: はい

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの Queuesプロパティに直接渡されます。

SecretsManagerKmsKeyId

カスタマーマネージドキーの AWS Key Management Service （AWS KMS) キー ID AWS Secrets Manager。kms:Decrypt アクセス許可が含まれていない Lambda 実行ロールを使用して Secrets Manager からのカスタマーマネージドキーを使用する場合に必要です。

このプロパティの値は UUID です。例: 1abc23d4-567f-8ab9-cde0-1fab234c5d67。

型: 文字列

必須: 条件に応じて異なります

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

SourceAccessConfigurations

認証プロトコルまたは仮想ホストの配列です。これは、SourceAccessConfigurations データ型を使用して指定します。

MQ イベントソースタイプの場合、有効な設定タイプは BASIC_AUTH と VIRTUAL_HOST だけです。

  • BASIC_AUTH – ブローカー認証情報を保存する Secrets Manager シークレットです。このタイプの場合、資格情報は {"username": "your-username", "password": "your-password"} 形式にする必要があります。BASIC_AUTH タイプのオブジェクトが 1 つだけ許可されます。

  • VIRTUAL_HOST – RabbitMQ ブローカー内の仮想ホストの名前です。Lambda は、この Rabbit MQ のホストをイベントソースとして使用します。VIRTUAL_HOST タイプのオブジェクトが 1 つだけ許可されます。

タイプ: リスト

必須: はい

CloudFormation 互換性: このプロパティは、 AWS::Lambda::EventSourceMappingリソースの SourceAccessConfigurationsプロパティに直接渡されます。

例

Amazon MQ イベントソース

以下は、Amazon MQ ブローカー向けの MQ イベントソースタイプの例です。

YAML

Events:
  MQEvent:
    Type: MQ
    Properties:
      Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
      Queues: List of queues
      SourceAccessConfigurations:
        - Type: BASIC_AUTH
          URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName
      BatchSize: 200
      Enabled: true