CFNでSNS入門 – email版

2022-07-302024-04-22

CFNでSNS入門 – email版

AWS SNSはメッセージングサービスです。

今回は入門編ということで、通知先にEmailを指定する方法をご紹介します。

構築する環境

Diagram of introduction to SNS with CFN.

2種類のリソースを作成します。

1つ目はSNSトピックです。
サブスクライバーとして、メールアドレスを指定します。

2つ目はLambda関数です。
SNSトピックにメッセージを送信するパブリッシャーとして動作します。
関数のランタイム環境はPython3.8とします。

CloudFormationテンプレートファイル

上記の構成をCloudFormationで構築します。
以下のURLにCloudFormationテンプレートを配置しています。

https://github.com/awstut-an-r/awstut-fa/tree/main/067

テンプレートファイルのポイント解説

SNSトピック

Resources:
  Topic:
    Type: AWS::SNS::Topic
    Properties:
      Subscription:
        - Endpoint: !Ref MailAddress
          Protocol: email
      TopicName: !Ref Prefix
Code language: YAML (yaml)

Subscriptionプロパティがポイントです。
メッセージをメールに送信する場合は、内部の2つのプロパティを設定します。
Protocolプロパティに「email」を指定します。
Endpointプロパティにメールアドレスを指定します。

Lambda関数

Resources:
  Function:
    Type: AWS::Lambda::Function
    Properties:
      Architectures:
        - !Ref Architecture
      Environment:
        Variables:
          REGION: !Ref AWS::Region
          TOPIC: !Ref TopicArn
      Code:
        ZipFile: |
          import boto3
          import json
          import os

          topic = os.environ['TOPIC']
          region = os.environ['REGION']

          client = boto3.client('sns', region_name=region)

          def lambda_handler(event, context):
            response = client.publish(
              TopicArn=topic,
              Subject='hogehoge',
              Message='fugafuga'
              )

            return {
              'statusCode': 200,
              'body': json.dumps(response, indent=2)
            }
      FunctionName: !Sub "${Prefix}-function"
      Handler: !Ref Handler
      Runtime: !Ref Runtime
      Role: !GetAtt FunctionRole.Arn
Code language: YAML (yaml)

Environmentプロパティで関数に渡すことができる環境変数を定義できます。
先述のSNSトピックのARNや、トピックを作成したリージョン情報を渡します。

Lambda関数で実行するコードをインライン表記で定義します。
詳細につきましては、以下のページをご確認ください。

実行するコードの内容ですが、以下の通りです。

CloudFormationテンプレートで定義した環境変数を、os.environにアクセスして取得する。
Boto3でSNSクライアントオブジェクトを作成する。
クライアントオブジェクトを使用して、SNSトピックにメッセージをパブリッシュする。
上記の実行結果をreturn文で返す。

なおメッセージをパブリッシュするためには、題名と本文を指定する必要があります。
今回は検証ということで、テスト用の文字列「hogehoge」と「fugafuga」を指定します。

ちなみに関数用のIAMロールは以下の通りです。

Resources:
  FunctionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service:
                - lambda.amazonaws.com
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Policies:
        - PolicyName: SNSPublishPolicy
          PolicyDocument:
            Version: 2012-10-17
            Statement:
              - Effect: Allow
                Action:
                  - sns:Publish
                Resource:
                  - !Ref TopicArn
Code language: YAML (yaml)