AWS CloudFormation で Amazon SQS キューと Amazon SNS トピックの間にサブスクリプションを作成するにはどうすればよいですか ?

最終更新日: 2019 年 10 月 2 日

AWS CloudFormation で Amazon Simple Queue Service (Amazon SQS) キューと Amazon Simple Notification Service (Amazon SNS) トピックの間にサブスクリプションを作成する方法を教えてください。

解決方法

ユースケースに応じ、次の中からいずれかをソリューションを選択してください。

  • SNS トピックと SQS キューが同じスタックにある場合、 AWS CloudFormation テンプレートを使用して SQS キューにメッセージを送信するトピックを作成します
  • 同じ AWS リージョン内で、ある SNS トピックと、その SNS トピックにサブスクライブする SQS キューが別々のスタックにある場合は、クロススタックの参照を作成します
    注: クロススタックの参照を作成するときは、SQS キューの Amazon リソースネーム (ARN) をそのスタックからエクスポートします。次に、その SQS キュー ARN を、もう 1 つのスタックにある SNS トピックの サブスクリプションエンドポイントのプロパティ にインポートします。
  • SNS トピックと SQS キューが別の AWS リージョンにある場合は、AWS::SNS::Subscription リソースを使い、クロスリージョンのサブスクリプションをセットアップするの手順に従います。
  • SNS トピックと SQS キューが別の AWS アカウントにある場合は、AWS::SNS::Subscription リソースを使い、クロスアカウントのサブスクリプションをセットアップするの手順に従います。

AWS::SNS::Subscription リソースを使い、クロスリージョンのサブスクリプションをセットアップする

1.    SNS トピックを、当該 AWS リージョンにあるスタック用の AWS CloudFormation テンプレートで 宣言した後、その SNS トピックの ARN をアノテーションするための出力リソースを作成します。

次に示す、JSON と YAML で記述したテンプレートの例をご参照ください。

JSON:

{
 "Resources": {
  "SnsTopic": {
   "Type": "AWS::SNS::Topic"
  }
 },
 "Outputs": {
  "SnsTopicArn": {
   "Value": "SnsTopic"
  }
 }
}

YAML:

Resources:
  SnsTopic:
    Type: AWS::SNS::Topic
Outputs:
  SnsTopicArn:
    Value: !Ref SnsTopic

2.    もう一方の AWS リージョンにあるスタック用の AWS CloudFormation テンプレートで、AWS::SNS::Subscription リソースと SQS キューを定義します。

注: awsSNSTopicArnExample をご自身の SNS トピック ARN と置き換え、us-east-1 をご使用のAWS リージョンと置き換えます。

次に示す、JSON と YAML で記述したテンプレートの例をご参照ください。

JSON:

{
 "Parameters": {
  "SNSTopicARN": {
   "Type": "String",
   "Description": "awsSNSTopicArnExample"
  },
  "TopicRegion": {
   "Type": "String",
   "Description": "us-east-1"
  }
 },
 "Resources": {
  "Queue": {
   "Type": "AWS::SQS::Queue"
  },
  "SnsSubscription": {
   "Type": "AWS::SNS::Subscription",
   "Properties": {
    "Protocol": "sqs",
    "Endpoint": {
     "Fn::GetAtt": [
      "Queue",
      "Arn"
     ]
    },
    "Region": {
     "Ref": "TopicRegion"
    },
    "TopicArn": {
     "Ref": "SNSTopicARN"
    }
   }
  }
 }
}

YAML:

Parameters:
  SNSTopicARN:
    Type: String
    Description: awsSNSTopicArnExample 
  TopicRegion:
    Type: String
    Description: us-east-1

Resources:
  Queue:
    Type: AWS::SQS::Queue

  SnsSubscription:
    Type: AWS::SNS::Subscription
    Properties:
      Protocol: sqs
      Endpoint: !GetAtt Queue.Arn
      Region: !Ref TopicRegion
      TopicArn: !Ref SNSTopicARN

これで、クロスリージョンサブスクリプションが設定されました。

AWS::SNS::Subscription リソースを使い、クロスアカウントのサブスクリプションをセットアップする

1.    まず、SNS トピックと AWS::SNS::TopicPolicyを、当該 AWS ソースアカウントにあるスタック用の AWS CloudFormation テンプレートで宣言します。次に、SNS トピック ARN をアノテーションするために出力リソースを作成し、パラメータとして送信先 AWS アカウントを指定します。

次に示す、JSON と YAML で記述したテンプレートの例をご参照ください。

JSON:

{
  "Parameters": {
    "CrossAccountNumber": {
      "AllowedPattern": "[0-9]+",
      "Description": "The 12 digit AWS account number to grant access to.",
      "MaxLength": "12",
      "MinLength": "12",
      "Type": "String",
      "Default": 123456789101
    }
  },
  "Resources": {
    "SnsTopic": {
      "Type": "AWS::SNS::Topic"
    },
    "SnsTopicPolicy": {
      "Type": "AWS::SNS::TopicPolicy",
      "DependsOn": "SnsTopic",
      "Properties": {
        "PolicyDocument": {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Sid": "SnsTopicPolicy",
              "Effect": "Allow",
              "Principal": {
                "AWS": {
                  "Fn::Sub": "arn:aws:iam::${CrossAccountNumber}:root"
                }
              },
              "Action": [
                "sns:Subscribe"
              ],
              "Resource": {
                "Ref": "SnsTopic"
              }
            }
          ]
        },
        "Topics": [
          {
            "Ref": "SnsTopic"
          }
        ]
      }
    }
  },
  "Outputs": {
    "SnsTopicArn": {
      "Value": {
        "Ref": "SnsTopic"
      }
    }
  }
}

YAML:

Parameters:
 CrossAccountNumber:
  AllowedPattern: '[0-9]+'
  Description: The 12 digit AWS account number to grant access to.
  MaxLength: '12'
  MinLength: '12'
  Type: String
  Default: 123456789101
Resources:
 SnsTopic:
  Type: AWS::SNS::Topic
 SnsTopicPolicy:
  Type: AWS::SNS::TopicPolicy
  DependsOn: SnsTopic
  Properties:
   PolicyDocument:
    Version: '2012-10-17'
    Statement:
    - Sid: SnsTopicPolicy
     Effect: Allow
     Principal:
      AWS: !Sub arn:aws:iam::${CrossAccountNumber}:root
     Action:
     - sns:Subscribe
     Resource: !Ref SnsTopic
   Topics:
    - !Ref SnsTopic
Outputs:
 SnsTopicArn:
  Value: !Ref SnsTopic

2.    サブスクリプションを拡張する AWS アカウントにあるスタック用の AWS CloudFormation テンプレートで、 AWS::SNS::Subscription リソース、SQS キュー、および AWS::SQS::QueuePolicy ポリシーを定義します。

注: awsSNSTopicArn をご自身の SNS トピック ARN と置き換え、us-east-1 をご使用のAWS リージョンと置き換えます。

次に示す、JSON と YAML で記述したテンプレートの例をご参照ください。

JSON:

{
 "Parameters": {
  "SNSTopicARN": {
   "Type": "String",
   "Default": "awsSNSTopicArn"
  },
  "TopicRegion": {
   "Type": "String",
   "Default": "us-east-1"
  }
 },
 "Resources": {
  "Queue": {
   "Type": "AWS::SQS::Queue"
  },
  "SqsQueuePolicy": {
   "Type": "AWS::SQS::QueuePolicy",
   "Properties": {
    "PolicyDocument": {
     "Version": "2012-10-17",
     "Id": "MyQueuePolicy",
     "Statement": [
      {
       "Sid": "Allow-SNS-SendMessage",
       "Effect": "Allow",
       "Principal": "*",
       "Action": [
        "sqs:SendMessage"
       ],
       "Resource": {
        "Fn::GetAtt": [
         "Queue",
         "Arn"
        ]
       },
       "Condition": {
        "ArnEquals": {
         "aws:SourceArn": {
          "Ref": "SNSTopicARN"
         }
        }
       }
      }
     ]
    },
    "Queues" : [
     {
      "Ref" : "Queue"
     }
    ]
   }
  },
  "SnsSubscription": {
   "Type": "AWS::SNS::Subscription",
   "Properties": {
    "Protocol": "sqs",
    "Endpoint": {
     "Fn::GetAtt": [
      "Queue",
      "Arn"
     ]
    },
    "Region": {
     "Ref": "TopicRegion"
    },
    "TopicArn": {
     "Ref": "SNSTopicARN"
    }
   }
  }
 }
}

YAML:

Parameters:
 SNSTopicARN:
  Type: String
  Default: awsSNSTopicArn
 TopicRegion:
  Type: String
  Default: us-east-1
Resources:
 Queue:
  Type: AWS::SQS::Queue
 SqsQueuePolicy:
  Type: AWS::SQS::QueuePolicy
  Properties:
   PolicyDocument:
    Version: '2012-10-17'
    Id: MyQueuePolicy
    Statement:
    - Sid: Allow-SNS-SendMessage
     Effect: Allow
     Principal: "*"
     Action:
     - sqs:SendMessage
     Resource: !GetAtt Queue.Arn
     Condition:
      ArnEquals:
       aws:SourceArn: !Ref SNSTopicARN
   Queues:
    - !Ref Queue
 SnsSubscription:
  Type: AWS::SNS::Subscription
  Properties:
   Protocol: sqs
   Endpoint: !GetAtt Queue.Arn
   Region: !Ref TopicRegion
   TopicArn: !Ref SNSTopicARN

この記事はお役に立ちましたか?

改善できることはありますか?


さらにサポートが必要な場合