AWS-EnableAppSyncGraphQLApiLogging - AWS Systems Manager Guide de référence du manuel d'automatisation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS-EnableAppSyncGraphQLApiLogging

Description

Le AWS-EnableAppSyncGraphQLApiLogging runbook permet la journalisation au niveau du champ et la journalisation au niveau des demandes pour l'API AWS AppSync GraphQL que vous spécifiez. Le runbook appliquera les modifications à l'API GraphQL spécifiée même si la journalisation a déjà été activée.

Exécuter cette automatisation (console)

Type de document

 Automatisation

Propriétaire

Amazon

Plateformes

Linux,macOS, Windows

Paramètres

  • AutomationAssumeRole

    Type : chaîne

    Description : (Facultatif) Le nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui lance ce runbook.

  • ApiId

    Type : chaîne

    Description : (Obligatoire) L'ID de l'API pour laquelle vous souhaitez activer la journalisation.

  • FieldLogLevel

    Type : chaîne

    Valeurs valides : ERROR | ALL

    Description : (Obligatoire) Le niveau de journalisation du champ.

  • CloudWatchLogsRoleArn

    Type : chaîne

    Description : (Obligatoire) L'ARN du rôle de service AWS AppSync censé publier sur Amazon CloudWatch Logs.

  • ExcludeVerboseContent

    Type : booléen

    Par défaut : false

    Description : (Facultatif) Définissez sur True pour exclure des informations telles que les en-têtes, le contexte et les modèles de mappage évalués, quel que soit le niveau de journalisation.

Autorisations IAM requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • appsync:GetGraphqlApi

  • appsync:UpdateGraphqlApi

  • iam:PassRole

Étapes de document

  • aws : executeAwsApi - Recueille le type d'authentification et les informations de configuration pertinentes pour le type d'authentification principal.

  • aws:branch - Branches basées sur le type d'authentification.

  • aws : executeAwsApi - Met à jour la configuration de journalisation pour l'API AWS AppSync GraphQL en fonction des valeurs spécifiées pour les paramètres d'entrée du runbook.

Sorties

  • EnableApiLoggingWithApiKeyOrAwsIamAuthorization.UpdateGraphQLApiResponse: Réponse à l'UpdateGraphqlApiappel.

  • EnableApiLoggingWithLambdaAuthorization.UpdateGraphQLApiResponse: Réponse à l'UpdateGraphqlApiappel.

  • EnableApiLoggingWithCognitoAuth.UpdateGraphQLApiResponse: Réponse à l'UpdateGraphqlApiappel.

  • EnableApiLoggingWithOpenIdAuthorization.UpdateGraphQLApiResponse: Réponse à l'UpdateGraphqlApiappel.