AWS-EnableAppSyncGraphQLApiLogging - AWS Systems Manager オートメーションランブックリファレンス

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS-EnableAppSyncGraphQLApiLogging

説明

AWS-EnableAppSyncGraphQLApiLogging ランブックは、指定した GraphQL API AWS AppSync のフィールドレベルのログ記録とリクエストレベルのログ記録を有効にします。ランブックは、ログ記録がすでに有効になっている場合でも、指定された GraphQL API に変更を適用します。

この自動化を実行する (コンソール)

ドキュメントタイプ

Automation

所有者

Amazon

[Platforms] (プラットフォーム)

Linux、macOS、Windows

パラメータ

  • AutomationAssumeRole

    型: 文字列

    説明: (オプション) Systems Manager Automation がユーザーに代わってアクションを実行できるようにする AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。ロールを指定しない場合、Systems Manager Automation はこのランブックを開始するユーザーのアクセス許可を使用します。

  • ApiId

    型: 文字列

    説明: (必須) ログ記録を有効にする API の ID。

  • FieldLogLevel

    型: 文字列

    有効な値: ERROR | ALL

    説明: (必須) フィールドのログ記録レベル。

  • CloudWatchLogsRoleArn

    型: 文字列

    説明: (必須) Amazon CloudWatch Logs に発行するために がAWS AppSync引き受けるサービスロールの ARN。

  • ExcludeVerboseContent

    タイプ: ブール

    デフォルト: False

    説明: (オプション) に設定すると、ログ記録レベルに関係なく、ヘッダー、コンテキスト、評価されたマッピングテンプレートなどの情報がTrue除外されます。

必要な IAM アクセス許可

AutomationAssumeRole パラメータでは、ランブックを正常に使用するために、次のアクションが必要です。

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • appsync:GetGraphqlApi

  • appsync:UpdateGraphqlApi

  • iam:PassRole

ドキュメントステップ

  • aws:executeAwsApi - プライマリ認証タイプに関連する認証タイプと設定情報を収集します。

  • aws:branch - 認証タイプに基づくブランチ。

  • aws:executeAwsApi - AWS AppSync ランブックの入力パラメータに指定された値に基づいて、GraphQL API のログ記録設定を更新します。

[Outputs] (出力)

  • EnableApiLoggingWithApiKeyOrAwsIamAuthorization.UpdateGraphQLApiResponse: UpdateGraphqlApi呼び出しからのレスポンス。

  • EnableApiLoggingWithLambdaAuthorization.UpdateGraphQLApiResponse: UpdateGraphqlApi呼び出しからのレスポンス。

  • EnableApiLoggingWithCognitoAuth.UpdateGraphQLApiResponse: UpdateGraphqlApi呼び出しからのレスポンス。

  • EnableApiLoggingWithOpenIdAuthorization.UpdateGraphQLApiResponse: UpdateGraphqlApi呼び出しからのレスポンス。