View a markdown version of this page

AWSPremiumSupport-OnboardWorkloadToIDR - 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.

AWSPremiumSupport-OnboardWorkloadToIDR

Beschreibung

Das AWSPremiumSupport-OnboardWorkloadToIDR Runbook hilft AWS Enterprise Support-Kunden dabei, mithilfe von Incident Detection and Response einen Workload für die Überwachung und das Management kritischer AWS Vorfälle zu integrieren. Eine Arbeitslast kann als eine Sammlung von AWS Ressourcen definiert werden, die einer AWS Ressourcengruppe oder einer AWS Service AppRegistry Cataloganwendung zugeordnet sind. Wenn keine AWS Ressourcengruppe oder eine AWS Service AppRegistry Cataloganwendung angegeben ist, erstellt das Runbook in Ihrem Namen eine Ressourcengruppe mithilfe von Tagfiltern oder der AWS CloudFormation Stack-ID, deren Ressourcen Sie in die Gruppe aufnehmen möchten. Wenn Sie den Parameter CreateApplicationInsights auf setzenYes, stellt die Automatisierung eine Amazon CloudWatch Application Insights-Anwendung mithilfe von AWS CloudFormation bereit. CloudWatch Application Insights richtet empfohlene Metriken und Protokolle für ausgewählte Anwendungsressourcen ein. Dabei werden CloudWatch Amazon-Metriken, -Protokolle und -Ereignisse für Benachrichtigungen bei erkannten Problemen verwendet.

Wichtig

Dieses Runbook führt abhängig von den angegebenen Eingabeparametern die folgenden Aktionen in Ihrem Konto aus:

  • Erstellt eine neue AWS Ressourcengruppe unter Verwendung von „ AWS CloudFormation if“ ResourceGroupName oder „AppRegistryApplicationnot specified“. Nachdem der Stack erstellt wurde, versucht das Runbook, den Kündigungsschutz einzurichten.

  • Kennzeichnet die dem Workload zugeordnete AWS Ressourcengruppe, einschließlich des aws_idr Tags.

  • Erstellt eine auf Amazon CloudWatch Application Insights-Ressourcengruppen basierende Anwendung, wenn der CreateApplicationInsights Eingabeparameter auf Yes gesetzt ist. Nachdem der Stack erstellt wurde, versucht das Runbook, den Kündigungsschutz für den Stack einzurichten.

  • Installiert die AWSServiceRoleForHealth_EventProcessor Service Linked Role (SLR), um den Zugriff für die Erfassung von Warnmeldungen an Incident Detection and Response zu ermöglichen, wenn der InstallServiceLinkedRole Eingabeparameter auf gesetzt ist. Yes

  • Erstellt einen AWS Support-Fall mit AWS Incident Detection and Response.

Wichtig

Um dieses Runbook zu verwenden und AWS Incident Detection and Response nutzen zu können, benötigen Sie ein AWS Enterprise Support (gegen Aufpreis) oder ein Unified Operations Abonnement. Weitere Informationen finden Sie unter Support Tarife https://aws.amazon.com/premiumsupport/plans/ vergleichen.

Wie funktioniert das?

Das Runbook führt die folgenden allgemeinen Schritte aus:

  • Prüft, ob der aktuelle AWS Account Support Plan Enterprise ist; andernfalls wird die Automatisierung beendet.

  • Legt anhand der angegebenen Parameter fest, ob eine vorhandene AWS Ressourcengruppe verwendet oder eine neue erstellt werden soll.

  • Wenn Sie eine neue Ressourcengruppe erstellen, wird eine AWS CloudFormation Vorlage generiert und der Stapel mit den entsprechenden Tags erstellt.

  • Versieht die Ressourcengruppe mit den erforderlichen Tags für die Erkennung und Reaktion von AWS Vorfällen.

  • Installiert optional die serviceverknüpfte Rolle für AWS Incident Detection and Response.

  • Erstellt optional eine Amazon CloudWatch Application Insights-Anwendung für eine verbesserte Überwachung.

  • Erstellt einen AWS Support-Fall, um den Onboarding-Prozess abzuschließen.

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:DescribeStackResource

  • cloudformation:DescribeStacks

  • cloudformation:UpdateTerminationProtection

  • iam:CreateServiceLinkedRole

  • resource-groups:CreateGroup

  • resource-groups:GetGroup

  • resource-groups:TagResource

  • servicecatalog-appregistry:GetApplication

  • support:CreateCase

  • support:DescribeSeverityLevels

  • support:DescribeServices

  • support:DescribeSupportLevel

Beispiel für eine Richtlinie:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudformation:CreateStack", "cloudformation:DescribeStackResource", "cloudformation:DescribeStacks", "cloudformation:UpdateTerminationProtection", "iam:CreateServiceLinkedRole", "resource-groups:CreateGroup", "resource-groups:GetGroup", "resource-groups:TagResource", "servicecatalog-appregistry:GetApplication", "support:CreateCase", "support:DescribeSeverityLevels", "support:DescribeServices", "support:DescribeSupportLevel" ], "Resource": "*" } ] }

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSPremiumSupport-OnboardWorkloadToIDR 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 AWS Identity and Access Management (IAM) -Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen durchzuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

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

    • WorkloadName (Erforderlich):

      • Beschreibung: (Erforderlich) Der Name des Workloads. Wenn nicht angegeben, ResourceGroupName wird der Workload-Name verwendet, um eine neue AWS Ressourcengruppe mit dem Namen einzurichtenIDR-AWS-<WorkloadName>.

      • Typ: String

      • Muster zulassen: ^[a-zA-Z0-9_-]{1,128}$

    • WorkloadDescription (Erforderlich):

      • Beschreibung: (Erforderlich) Die Beschreibung der Arbeitslast. Geben Sie eine kurze Beschreibung ein, um die Anwendungsfälle dieser Arbeitslast detailliert zu beschreiben. Bitte geben Sie den primären Endbenutzer und die Funktion dieses Workloads an.

      • Typ: String

      • Muster zulassen: ^[a-zA-Z0-9.:;,-_&() ]{1,1024}$

    • AppRegistryApplication (Fakultativ):

      • Beschreibung: (Optional) Der Name oder die ID der AWS Service AppRegistry Catalog-Anwendung. Wenn nicht angegeben, müssen Sie eine Eingabe für angebenResourceGroupName.

      • Typ: String

      • Muster zulassen: ^$|^[a-zA-Z0-9.-_]{1,128}$

      • Standard: ""

    • ResourceGroupName (Fakultativ):

      • Beschreibung: (Optional) Der Name einer vorhandenen AWS Ressourcengruppe, falls AppRegistryApplication nicht angegeben. Wenn Sie eine Ressourcengruppe erstellen möchten, müssen Sie eine Eingabe für eine neue Ressourcengruppe angeben TagFilters und optional ResourceTypeFilters eine neue AWS Ressourcengruppe erstellen.

      • Typ: String

      • Muster zulassen: ^$|^[a-zA-Z0-9_.-]{1,128}$

      • Standard: ""

    • TagFilters (Befristet):

      • Beschreibung: (Begrenzt) Die Liste der Paare key/values (string/list von Zeichenketten), die mit den Tags verglichen werden, die an Ihre AWS Ressourcen angehängt sind. Dieser Parameter wird verwendet, um eine neue AWS Ressourcengruppe zu erstellen, wenn Sie kein vorhandenes ResourceGroupName oder angebenAppRegistryApplication.

      • Typ: StringMap

    • ResourceTypeFilters (Befristet):

      • Beschreibung: (Befristet) Die Liste der Ressourcentypen, die von Resource Groups unterstützt werden.

      • Typ: StringList

      • Max. Anzahl Artikel: 10

      • Standard: AWS::AllSupported

    • InstallServiceLinkedRole (Fakultativ):

      • Beschreibung: (Optional) Wählen Sie Yes diese Option, um die AWSServiceRoleForHealth_EventProcessor serviceverknüpfte Rolle (SLR) zu installieren.

      • Typ: String

      • Zulässige Werte: [Yes,No]

      • Standard: No

    • CreateApplicationInsights (Fakultativ):

      • Beschreibung: (Optional) Wählen Sie Yes diese Option, um eine gruppenbasierte Amazon CloudWatch Application Insights Resource-Anwendung zu erstellen.

      • Typ: String

      • Zulässige Werte: [Yes,No]

      • Standard: No

    • ComplianceAndRegulatoryRequirements (Erforderlich):

      • Beschreibung: (Erforderlich) Geltende and/or behördliche Anforderungen für diesen Workload und alle Maßnahmen, die AWS nach einem Vorfall erforderlich sind.

      • Typ: String

      • Muster zulassen: ^[a-zA-Z0-9.:;,\\-_&() ]{1,1024}$

    • Keine AWS-Komponenten (optional):

      • Beschreibung: (Optional) Geben Sie irgendwelche lokalen oder externen AWS Komponenten für diesen Workload an? Wenn ja, um welche handelt es sich und welche Funktionen erfüllen sie?

      • Typ: String

      • Muster zulassen: ^$|^[a-zA-Z0-9.:;,\\-_&() ]{1,1024}$

      • Standard: ""

    • UpstreamDownstreamDependencies (Fakultativ):

      • Beschreibung: (Optional) Angaben zu upstream/downstream Komponenten, die nicht integriert sind und die sich bei einem Ausfall auf diese Arbeitslast auswirken könnten.

      • Typ: String

      • Muster zulassen: ^$|^[a-zA-Z0-9.:;,\\-_&() ]{1,1024}$

      • Standard: ""

    • FailoverDisasterRecoveryPlan (Fakultativ):

      • Beschreibung: (Optional) Geben Sie Einzelheiten zu allen manuellen oder automatisierten failover/disaster Wiederherstellungsplänen auf AZ- und regionaler Ebene an.

      • Typ: String

      • Muster zulassen: ^$|^[a-zA-Z0-9.:;,\\-_&() ]{1,1024}$

      • Standard: ""

    • BridgeDetails (Fakultativ):

      • Beschreibung: (Optional) Die statische incident/crisis Managementbrücke, die von Ihrem Unternehmen eingerichtet wurde. Wenn Sie eine nichtstatische Bridge verwenden, geben Sie Ihre bevorzugte Anwendung an und fordern AWS Sie diese Informationen bei einem Vorfall an.

      • Typ: String

      • Zulässige Werte: [Amazon Chime bridge, Non-Static bridge, Static bridge]

      • Standard: Amazon Chime bridge

    • SubscriptionStartDate (Erforderlich):

      • Beschreibung: (Erforderlich) Das Datum in dem YYYY-MM-DD Format, an dem Sie Ihr Abonnement für AWS Incident Detection and Response starten möchten.

      • Typ: String

      • Muster zulassen: ^(202[4-9]|20[3-9][0-9])-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$

  4. Wählen Sie Ausführen aus.

  5. Die Automatisierung wird initiiert.

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

    • CheckAWSSupportPlan:

      Prüft, ob der aktuelle AWS Account Support Plan Enterprise ist; andernfalls wird die Automatisierung beendet.

    • BranchOnResourceGroup:

      Verzweigt die Automatisierung danach, ob eine vorhandene AWS Ressourcengruppe bereitgestellt wurde. Wenn nicht angegeben, erstellt die Automatisierung eine neue AWS Ressourcengruppe.

    • GetAppRegistryApplication:

      Ruft Metadateninformationen über die AWS Service AppRegistry Catalog-Anwendung ab, sofern diese bereitgestellt werden.

    • GenerateResourceGroupTemplate:

      Generiert eine AWS CloudFormation Vorlage für die AWS Ressourcengruppe mit den angegebenen Tagfiltern.

    • CreateResourceGroup:

      Erstellt eine neue AWS Ressourcengruppe mithilfe von AWS CloudFormation.

    • TagResourceGroup:

      Versieht die Ressourcengruppe mit den erforderlichen IDR-Tags ( AWS Incident Detection and Response).

    • InstallServiceLinkedRole:

      Installiert auf Anfrage die serviceverknüpfte Rolle AWS Incident Detection and Response (IDR).

    • CreateApplicationInsightsApplication:

      Erstellt auf Anfrage eine Amazon CloudWatch Application Insights-Anwendung.

    • CreateAwsSupportCase:

      Erstellt einen AWS Support-Fall mit AWS Incident Detection and Response.

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

Referenzen

Systems Manager Automation