View a markdown version of this page

AWSSupport-DeploySESSendingLogsToCloudWatchLogs - AWS Systems Manager Runbook-Referenz für Automation

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWSSupport-DeploySESSendingLogsToCloudWatchLogs

Beschreibung

Das AWSSupport-DeploySESSendingLogsToCloudWatchLogs Automatisierungs-Runbook hilft bei der Konfiguration der Infrastruktur, die für die Veröffentlichung von Amazon Simple Email Service (Amazon SES) -Ereignissen in Amazon CloudWatch Logs (CloudWatch Logs) erforderlich ist. Dieses Runbook richtet die Komponenten ein, die erforderlich sind, um Ereignisse beim Senden von E-Mails zu erfassen und sie zur Überwachung und Analyse in CloudWatch Protokollen zu speichern. Weitere Informationen zur Veröffentlichung von Amazon SES-Ereignissen finden Sie unter Überwachen des E-Mail-Versands mithilfe der Amazon SES-Eventveröffentlichung.

Wenn der ApproveDeployAnalyticEnvironment Parameter auf gesetzt istapprove, erstellt dieses Runbook neue AWS Ressourcen in Ihrem AWS Konto. Der CloudFormation Stack wird nach der im SleepTime Parameter angegebenen Zeit automatisch gelöscht, sofern nicht auf 0 gesetzt.

Wie funktioniert es?

Dieses Runbook führt die folgenden Aktionen aus:

  • Führt vorhandene Konfigurationssätze auf, für die Eventziele für Amazon Simple Notification Service (Amazon SNS) -Themen oder Übermittlungsstreams konfiguriert sind.

  • Erstellt die Infrastruktur, die für die Veröffentlichung von Amazon SES-Ereignissen in CloudWatch Logs erforderlich ist, wenn der ApproveDeployAnalyticEnvironment Parameter auf approve gesetzt ist.

Wenn der ApproveDeployAnalyticEnvironment Parameter auf gesetzt istapprove, erstellt das Runbook die folgenden Ressourcen:

  • Ein CloudFormation Stack mit dem NamenAWSSupport-SESSendingLogsToCloudWatchLogs, der Folgendes beinhaltet:

    • Amazon SNS-Thema mit AWS Key Management Service (AWS KMS) -Verschlüsselung

    • Amazon Simple Queue Service-Warteschlange (Amazon SQS)

    • AWS Lambda Funktion zur Verarbeitung von E-Mail-Versandereignissen

    • AWS Identity and Access Management (IAM) -Ausführungsrolle mit Berechtigungen für Amazon SQS und Logs CloudWatch

    • CloudWatch Logs, Protokollgruppe

    • AWS KMS Schlüssel für die Verschlüsselung

    • Amazon SES-Konfigurationssatz mit Veranstaltungszielen

  • Die Infrastruktur verarbeitet E-Mail-Versandereignisse im folgenden Ablauf: Amazon SES-Ereignisse zum Senden von E-Mails → Amazon SES-Konfigurationssatz → Amazon SNS-Thema → Amazon SQS-Warteschlange → Lambda-Funktion → Protokolle CloudWatch

  • Ordnet den erstellten Konfigurationssatz als Standardkonfigurationssatz für eine angegebene Amazon SES-Identität zu, wenn der SesIdentity Parameter bereitgestellt wird.

Führen Sie diese Automatisierung aus (Konsole)

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

/

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

  • 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

Beispiel für eine Richtlinie: 

{
       "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": "*"
           }
       ]
       }

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSSupport-DeploySESSendingLogsToCloudWatchLogs im Systems Manager unter Dokumente zu.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • AutomationAssumeRole (Fakultativ):

      • Beschreibung: (Optional) Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen auszuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

      • Typ: AWS::IAM::Role::Arn

    • ApproveDeployAnalyticEnvironment (Fakultativ):

      • Beschreibung: (Optional) Genehmigung zur Bereitstellung der Amazon SES-Infrastruktur für die Veröffentlichung von Veranstaltungen. Geben Sie einapprove, um den CloudFormation Stack und die zugehörigen Ressourcen zu erstellen. Wenn das Feld leer gelassen wird, werden im Runbook nur vorhandene Konfigurationssätze mit oder Amazon SNS-Eventzielen in der aktuellen Region angezeigt.

      • Typ: String

      • Muster zulassen: ^$|^approve$

      • Standard: ""

    • SesIdentity (Fakultativ):

      • Beschreibung: (Optional) Amazon SES-Identität (E-Mail-Adresse oder Domain), die dem neu erstellten Konfigurationssatz als Standardkonfigurationssatz zugeordnet werden soll. Dadurch werden alle vorhandenen Standardkonfigurationen für die angegebene Identität überschrieben.

      • Typ: String

      • Standard: ""

    • CloudWatchLogGroupName (Fakultativ):

      • Beschreibung: (Optional) Name der CloudWatch Logs-Protokollgruppe, die zum Speichern von Amazon SES-E-Mail-Sendeereignissen erstellt werden soll.

      • Typ: String

      • Muster zulassen: ^[0-9a-zA-Z_.#/\\-]{1,512}$

      • Standard: /ses/sending_event_logs

    • MaskPIIData (optional):

      • Beschreibung: (Optional) Geben Sie an, ob personenbezogene Daten (PII) wie Ziel-E-Mail-Adressen und E-Mail-Betreff in Protokollen maskiert werden sollen. CloudWatch Stellen Sie diese Option False auf ein, um diese Informationen in die Protokolle aufzunehmen.

      • Typ: String

      • Zulässige Werte: [True, False]

      • Standard: True

    • SleepTime (Fakultativ):

      • Beschreibung: (Optional) Anzahl der Minuten, die gewartet werden muss, bevor der CloudFormation Stapel automatisch gelöscht wird. Der Standardwert ist 24 Stunden (1.440 Minuten), der Höchstwert ist 7 Tage (10.080 Minuten). Stellen Sie diese Option ein, um 0 automatisches Löschen zu verhindern.

      • Typ: String

      • Muster zulassen: ^(?:[0-9]|[1-9]\\d{1,3}|100[0-7][0-9])$

      • Standard: 1440

    • RetainCloudWatchLogsOnDeletion (Fakultativ):

      • Beschreibung: (Optional) Geben Sie an, ob die CloudWatch Logs-Protokollgruppe beibehalten werden soll, wenn der CloudFormation Stapel gelöscht wird. Stellen Sie auf False ein, um die Protokollgruppe zusammen mit dem Stapel zu löschen.

      • Typ: String

      • Zulässige Werte: [True, False]

      • Standard: True

    • UniqueId (Fakultativ):

      • Beschreibung: (Optional) Eine eindeutige Kennung für den Workflow.

      • Typ: String

      • Muster zulassen: \\{\\{ automation:EXECUTION_ID \\}\\}|[a-zA-Z0-9-]+

      • Standard: {{ automation:EXECUTION_ID }}

      • Max. Zeichen: 64

  4. Wählen Sie Ausführen aus.

  5. Die Automatisierung wird initiiert.

  6. Das Dokument führt die folgenden Schritte aus:

    • BranchOnValueOfParameterApproveDeployAnalyticEnvironment

      Legt anhand des ApproveDeployAnalyticEnvironment Parameterwerts fest, ob die Amazon SES-Infrastruktur zur Eventveröffentlichung bereitgestellt werden soll.

    • GetEligibleConfigurationSets

      Ruft vorhandene Amazon SES-Konfigurationssätze ab und identifiziert diejenigen, deren Veranstaltungsziele für Delivery Streams oder Amazon SNS-Themen konfiguriert sind.

    • CheckConcurrency

      Überprüft, ob kein vorhandener Stack existiert und dass keine anderen gleichzeitigen Ausführungen dieses Runbooks denselben Stack erstellen.

    • DeploySesEventDestinations

      Erstellt den CloudFormation Stack, der die Amazon SES-Infrastruktur zur Eventveröffentlichung enthält, einschließlich des Amazon SNS-Themas, der Amazon SQS-Warteschlange, der Lambda-Funktion und der Logs-Protokollgruppe. CloudWatch

    • RelateConfigurationSetAsDefaultConfigurationSet

      Ordnet den neu erstellten Amazon SES-Konfigurationssatz als Standardkonfigurationssatz für die angegebene Amazon SES-Identität zu (falls vorhanden).

    • SleepBeforeDeleteCloudFormationStack

      Wartet die im SleepTime Parameter angegebene Dauer ab, bevor mit dem Löschen des CloudFormation Stacks fortgefahren wird.

    • DeleteCloudFormationStack

      Löscht den CloudFormation Stapel nach dem angegebenen Zeitraum.

  7. Nach Abschluss des Vorgangs finden Sie im Abschnitt Ausgaben die detaillierten Ergebnisse der Ausführung.

Referenzen

Systems Manager Automation