AWS-EnableAppSyncGraphQLApiLogging - AWS Systems Manager Referencia del manual de automatización

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWS-EnableAppSyncGraphQLApiLogging

Descripción

El AWS-EnableAppSyncGraphQLApiLogging runbook permite el registro a nivel de campo y el registro a nivel de solicitud para la API AWS AppSync GraphQL que especifique. El runbook aplicará los cambios a la API GraphQL especificada incluso si el registro ya está habilitado.

Ejecuta esta automatización (consola)

Tipo de documento

Automation

Propietario

Amazon

Plataformas

Linux, macOS, Windows

Parámetros

  • AutomationAssumeRole

    Tipo: cadena

    Descripción: (Opcional) el Nombre de recurso de Amazon (ARN) del rol (IAM) AWS Identity and Access Managementque permite a System Automation realizar las acciones en su nombre. Si no se especifica ningún rol, Systems Manager Automation utilizará los permisos del usuario que ejecuta este manual de procedimientos.

  • ApiId

    Tipo: cadena

    Descripción: (obligatorio) El ID de la API para la que quieres habilitar el registro.

  • FieldLogLevel

    Tipo: cadena

    Valores válidos: ERROR | TODOS

    Descripción: (obligatorio) El nivel de registro del campo.

  • CloudWatchLogsRoleArn

    Tipo: cadena

    Descripción: (obligatorio) El ARN del rol de servicio que AWS AppSync asume publicar en Amazon CloudWatch Logs.

  • ExcludeVerboseContent

    Tipo: Booleano

    Valor predeterminado: False

    Descripción: (opcional) Se configura True para excluir información como los encabezados, el contexto y las plantillas de mapeo evaluadas, independientemente del nivel de registro.

Permisos de IAM necesarios

El parámetro AutomationAssumeRole requiere las siguientes acciones para utilizar el manual de procedimientos correctamente.

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • appsync:GetGraphqlApi

  • appsync:UpdateGraphqlApi

  • iam:PassRole

Pasos de documentos

  • aws: executeAwsApi - Recopila el tipo de autenticación y la información de configuración relevante para el tipo de autenticación principal.

  • aws:branch: se ramifica según el tipo de autenticación.

  • aws: executeAwsApi - Actualiza la configuración de registro de la API AWS AppSync GraphQL en función de los valores especificados para los parámetros de entrada del runbook.

Salidas

  • EnableApiLoggingWithApiKeyOrAwsIamAuthorization.UpdateGraphQLApiResponse: Respuesta de la UpdateGraphqlApi llamada.

  • EnableApiLoggingWithLambdaAuthorization.UpdateGraphQLApiResponse: Respuesta de la UpdateGraphqlApi llamada.

  • EnableApiLoggingWithCognitoAuth.UpdateGraphQLApiResponse: Respuesta de la UpdateGraphqlApi llamada.

  • EnableApiLoggingWithOpenIdAuthorization.UpdateGraphQLApiResponse: Respuesta de la UpdateGraphqlApi llamada.