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

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

SNS

SNS イベントソースタイプを説明するオブジェクトです。

このイベントタイプが設定されていると、SAM は AWS::SNS::Subscription リソースを生成します。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

プロパティ

FilterPolicy

サブスクリプションに割り当てられているフィルターポリシー JSON です。詳細については、Amazon Simple Notification Service API リファレンスの「GetSubscriptionAttributes」を参照してください。

タイプ: SNSFilterPolicy

必須: いいえ

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

FilterPolicyScope

この属性では、次の文字列値のタイプのいずれかを使用してフィルタリング範囲を選択できます。

  • MessageAttributes – フィルターはメッセージ属性に適用されます。

  • MessageBody - フィルターはメッセージ本文に適用されます。

型: 文字列

必須: いいえ

デフォルト: MessageAttributes

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

RedrivePolicy

指定すると、指定された Amazon SQS デッドレターキューに配信不能メッセージを送信します。クライアントエラー（例: サブスクライブされたエンドポイントに到達できない）またはサーバーエラー（例: サブスクライブされたエンドポイントに電力を供給するサービスが使用できなくなる）が原因で配信できないメッセージは、詳細な分析や再処理のためにデッドレターキューに保持されます。

再処理ポリシーとデッドレターキューの詳細については、「Amazon Simple Queue Service デベロッパーガイド」の「Amazon SQS デッドレターキュー」を参照してください。

型: Json

必須: いいえ

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

Region

クロスリージョンサブスクリプションの場合に、トピックが格納されるリージョンです。

リージョンが指定されていない場合、CloudFormation は発信者のリージョンをデフォルトとして使用します。

型: 文字列

必須: いいえ

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

SqsSubscription

このプロパティを true に設定するか、SqsSubscriptionObject を指定して SQS キューで SNS トピック通知のバッチ処理を有効にします。このプロパティを true に設定することによって新しい SQS キューが作成されますが、SqsSubscriptionObject を指定すると既存の SQS キューが使用されます。

タイプ: ブール | SqsSubscriptionObject

必須: いいえ

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

Topic

サブスクライブ先のトピックの ARN です。

型: 文字列

必須: はい

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

例

SNS イベントソースの例

SNS イベントソースの例

YAML

Events:
  SNSEvent:
    Type: SNS
    Properties:
      Topic: arn:aws:sns:us-east-1:123456789012:my_topic
      SqsSubscription: true
      FilterPolicy:
        store:
          - example_corp
        price_usd:
          - numeric:
              - ">="
              - 100