AWS-EnableAppSyncGraphQLApiLogging

PDF

Beschreibung

Das AWS-EnableAppSyncGraphQLApiLogging Runbook ermöglicht die Protokollierung auf Feldebene und die Protokollierung auf Anforderungsebene für die AWS AppSync von Ihnen angegebene GraphQL-API. Das Runbook wendet Änderungen an der angegebenen GraphQL-API an, auch wenn die Protokollierung bereits aktiviert wurde.

Führen Sie diese Automatisierung aus (Konsole)

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

Linux, macOS, Windows

Parameter

• AutomationAssumeRole

  Typ: Zeichenfolge

  Beschreibung: (Optional) Der Amazon-Ressourcenname (ARN) der AWS Identity and Access Management (IAM) -Rolle, mit der Systems Manager Automation die Aktionen in Ihrem Namen ausführen kann. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

• ApiId

  Typ: Zeichenfolge

  Beschreibung: (Erforderlich) Die ID der API, für die Sie die Protokollierung aktivieren möchten.

• FieldLogLevel

  Typ: Zeichenfolge

  Gültige Werte: ERROR | ALL

  Beschreibung: (Erforderlich) Die Ebene der Feldprotokollierung.

• CloudWatchLogsRoleArn

  Typ: Zeichenfolge

  Beschreibung: (Erforderlich) Der ARN der Servicerolle, die AWS AppSync davon ausgeht, in Amazon CloudWatch Logs zu veröffentlichen.

• ExcludeVerboseContent

  Typ: Boolesch

  Standard: False

  Beschreibung: (Optional) Legt fest, True dass Informationen wie Header, Kontext und evaluierte Zuordnungsvorlagen unabhängig von der Protokollierungsstufe ausgeschlossen werden.

Erforderliche IAM-Berechtigungen

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

• ssm:StartAutomationExecution

• ssm:GetAutomationExecution

• appsync:GetGraphqlApi

• appsync:UpdateGraphqlApi

• iam:PassRole

Dokumentschritte

• aws: executeAwsApi — Sammelt den Authentifizierungstyp und die Konfigurationsinformationen, die für den primären Authentifizierungstyp relevant sind.

• aws:branch — Verzweigt auf der Grundlage des Authentifizierungstyps.

• aws: executeAwsApi - Aktualisiert die Logging-Konfiguration für die AWS AppSync GraphQL-API auf der Grundlage der Werte, die für die Eingabeparameter des Runbooks angegeben wurden.

Ausgaben

• EnableApiLoggingWithApiKeyOrAwsIamAuthorization.UpdateGraphQLApiResponse: Antwort auf den UpdateGraphqlApi Anruf.

• EnableApiLoggingWithLambdaAuthorization.UpdateGraphQLApiResponse: Antwort auf den UpdateGraphqlApi Anruf.

• EnableApiLoggingWithCognitoAuth.UpdateGraphQLApiResponse: Antwort auf den UpdateGraphqlApi Anruf.

• EnableApiLoggingWithOpenIdAuthorization.UpdateGraphQLApiResponse: Antwort auf den UpdateGraphqlApi Anruf.