AWSSupport-DeploySESSendingLogsToCloudWatchLogs - AWS Systems Manager オートメーションランブックリファレンス

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

AWSSupport-DeploySESSendingLogsToCloudWatchLogs

説明

AWSSupport-DeploySESSendingLogsToCloudWatchLogs オートメーションランブックは、Amazon CloudWatch Logs (CloudWatch Logs) への Amazon Simple Email Service (Amazon SES) イベント発行に必要なインフラストラクチャを設定するのに役立ちます。このランブックは、E メール送信イベントをキャプチャし、モニタリングと分析のために CloudWatch Logs に保存するために必要なコンポーネントを設定します。Amazon SES イベント発行の詳細については、Amazon SESイベント発行を使用した E メール送信のモニタリング」を参照してください。

ApproveDeployAnalyticEnvironment パラメータが に設定されている場合approve、このランブックは AWS アカウントに新しい AWS リソースを作成します。 CloudFormation スタックは、 に設定されない限り、 SleepTimeパラメータで指定された時間後に自動的に削除されます0

動作の仕組み

このランブックは、次のアクションを実行します。

  • Amazon Simple Notification Service (Amazon SNS) トピックまたは配信ストリーム用に設定されたイベント送信先を持つ既存の設定セットを一覧表示します。

  • ApproveDeployAnalyticEnvironment パラメータが に設定されている場合、CloudWatch Logs への Amazon SES イベント発行に必要なインフラストラクチャを作成しますapprove

ApproveDeployAnalyticEnvironment パラメータを に設定するとapprove、ランブックは次のリソースを作成します。

  • 以下を含む という名前AWSSupport-SESSendingLogsToCloudWatchLogsの CloudFormation スタック。

    • AWS Key Management Service (AWS KMS) 暗号化を使用した Amazon SNS トピック

    • Amazon Simple Queue Service (Amazon SQS) キュー

    • AWS Lambda E メール送信イベントを処理する 関数

    • AWS Identity and Access Management Amazon SQS および CloudWatch Logs のアクセス許可を持つ (IAM) 実行ロール CloudWatch

    • CloudWatch Logs ロググループ

    • AWS KMS 暗号化用の キー

    • イベント送信先を含む Amazon SES 設定セット

  • インフラストラクチャは、Amazon SES Email Sending Events → Amazon SES Configuration Set → Amazon SNS Topic → Amazon SQS Queue → Lambda Function → CloudWatch Logs のフローで E メール送信イベントを処理します。

  • SesIdentity パラメータが指定されている場合、作成された設定セットを指定された Amazon SES ID のデフォルト設定セットとして関連付けます。

このオートメーションを実行する (コンソール)

ドキュメントタイプ

オートメーション

[所有者]

Amazon

[Platforms] (プラットフォーム)

/

必要な IAM アクセス許可

AutomationAssumeRole パラメータでは、ランブックを正常に使用するために、次のアクションが必要です。

  • cloudformation:CreateStack

  • cloudformation:DeleteStack

  • cloudformation:DescribeStackEvents

  • cloudformation:DescribeStacks

  • iam:CreateRole

  • iam:AttachRolePolicy

  • iam:PassRole

  • kms:CreateKey

  • kms:CreateAlias

  • lambda:CreateFunction

  • lambda:AddPermission

  • logs:CreateLogGroup

  • logs:PutRetentionPolicy

  • ses:CreateConfigurationSet

  • ses:CreateConfigurationSetEventDestination

  • ses:ListConfigurationSets

  • ses:PutEmailIdentityConfigurationSetAttributes

  • sns:CreateTopic

  • sns:Subscribe

  • sqs:CreateQueue

  • sqs:SetQueueAttributes

  • ssm:DescribeAutomationExecutions

ポリシーの例:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:DescribeStackEvents", "cloudformation:DescribeStacks", "iam:CreateRole", "iam:AttachRolePolicy", "iam:PassRole", "kms:CreateKey", "kms:CreateAlias", "lambda:CreateFunction", "lambda:AddPermission", "logs:CreateLogGroup", "logs:PutRetentionPolicy", "ses:CreateConfigurationSet", "ses:CreateConfigurationSetEventDestination", "ses:ListConfigurationSets", "ses:PutEmailIdentityConfigurationSetAttributes", "sns:CreateTopic", "sns:Subscribe", "sqs:CreateQueue", "sqs:SetQueueAttributes", "ssm:DescribeAutomationExecutions" ], "Resource": "*" } ] }

指示

次の手順に従って自動化を設定します。

  1. ドキュメントの Systems Manager AWSSupport-DeploySESSendingLogsToCloudWatchLogsで に移動します。

  2. [Execute automation] (オートメーションを実行) を選択します。

  3. 入力パラメータには、次のように入力します。

    • AutomationAssumeRole(オプション):

      • 説明: (オプション) Systems Manager Automation がユーザーに代わってアクションを実行できるようにする IAM ロールの Amazon リソースネーム (ARN)。ロールを指定しない場合、Systems Manager Automation はこのランブックを開始するユーザーのアクセス許可を使用します。

      • 型: AWS::IAM::Role::Arn

    • ApproveDeployAnalyticEnvironment (オプション):

      • 説明: (オプション) Amazon SES イベント発行インフラストラクチャをデプロイするための承認。approve を入力して、 CloudFormation スタックと関連リソースを作成します。空のままにすると、ランブックには、現在のリージョンの または Amazon SNS イベント送信先を持つ既存の設定セットのみが表示されます。

      • 型: String

      • 許可パターン: ^$|^approve$

      • デフォルト: ""

    • SesIdentity (オプション):

      • 説明: (オプション) 新しく作成された設定セットをデフォルトの設定セットとして関連付ける Amazon SES ID (E メールアドレスまたはドメイン)。これにより、指定された ID の既存のデフォルト設定セットが上書きされます。

      • 型: String

      • デフォルト: ""

    • CloudWatchLogGroupName (オプション):

      • 説明: (オプション) Amazon SES E メール送信イベントを保存するために作成する CloudWatch Logs ロググループの名前。

      • 型: String

      • 許可パターン: ^[0-9a-zA-Z_.#/\\-]{1,512}$

      • デフォルト: /ses/sending_event_logs

    • MaskPIIData (オプション):

      • 説明: (オプション) CloudWatch Logs の送信先 E メールアドレスや E メール件名などの個人を特定できる情報 (PII) データをマスクするかどうかを指定します。に設定するとFalse、この情報がログに含まれます。

      • 型: String

      • 使用できる値: [True, False]

      • デフォルト: True

    • SleepTime (オプション):

      • 説明: (オプション) CloudFormation スタックを自動的に削除するまで待機する分数。デフォルトは 24 時間 (1,440 分)、最大は 7 日 (10,080 分) です。自動削除を防ぐ0には、 に設定します。

      • 型: String

      • 許可パターン: ^(?:[0-9]|[1-9]\\d{1,3}|100[0-7][0-9])$

      • デフォルト: 1440

    • RetainCloudWatchLogsOnDeletion (オプション):

      • 説明: (オプション) CloudFormation スタックが削除されたときに CloudWatch Logs ロググループを保持するかどうかを指定します。スタックとともにロググループFalseを削除するには、 に設定します。

      • 型: String

      • 使用できる値: [True, False]

      • デフォルト: True

    • UniqueId (オプション):

      • 説明: (オプション) ワークフローの一意の識別子。

      • 型: String

      • 許可パターン: \\{\\{ automation:EXECUTION_ID \\}\\}|[a-zA-Z0-9-]+

      • デフォルト: {{ automation:EXECUTION_ID }}

      • ax 文字: 64

  4. [実行] を選択します。

  5. 自動化が開始されます。

  6. ドキュメントは以下のステップを実行します。

    • BranchOnValueOfParameterApproveDeployAnalyticEnvironment

      ApproveDeployAnalyticEnvironment パラメータ値に基づいて Amazon SES イベント発行インフラストラクチャをデプロイするかどうかを決定します。

    • GetEligibleConfigurationSets

      既存の Amazon SES 設定セットを取得し、配信ストリームまたは Amazon SNS トピック用に設定されたイベント送信先を持つ設定セットを識別します。

    • CheckConcurrency

      既存のスタックが存在しないこと、およびこのランブックの他の同時実行が同じスタックを作成していないことを確認します。

    • DeploySesEventDestinations

      Amazon SNS Amazon SES Amazon SQSキュー、Lambda 関数、CloudWatch Logs ロググループなどの Amazon SES イベント発行インフラストラクチャを含む CloudFormation スタックを作成します。

    • RelateConfigurationSetAsDefaultConfigurationSet

      新しく作成された Amazon SES 設定セットを、指定された Amazon SES ID (指定されている場合) のデフォルト設定セットとして関連付けます。

    • SleepBeforeDeleteCloudFormationStack

      CloudFormation スタックの削除に進む前に、SleepTime パラメータで指定された期間待機します。

    • DeleteCloudFormationStack

      指定された期間の後に CloudFormation スタックを削除します。

  7. 完了したら、出力セクションで実行の詳細な結果を確認します。

リファレンス

Systems Manager Automation