AWS-EnableStepFunctionsStateMachineLogging

PDF

説明

AWS-EnableStepFunctionsStateMachineLogging ランブックは、指定した AWS Step Functions ステートマシンのログ記録を有効化または更新します。最小ログ記録レベルは、ALL、ERROR、または に設定する必要がありますFATAL。

このオートメーションを実行する (コンソール)

ドキュメントタイプ

Automation

[所有者]

Amazon

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

Linux、macOS、Windows

パラメータ

• AutomationAssumeRole

  タイプ: 文字列

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

• レベル

  タイプ: 文字列

  有効な値: ALL | ERROR | FATAL

  説明: (必須) 暗号化を有効にする Amazon SQS キューの URL。

• LogGroupArn

  タイプ: 文字列

  説明: (必須) ステートマシンログを送信する Amazon CloudWatch Logs ロググループの ARN。

• StateMachineArn

  タイプ: 文字列

  説明: (必須) ログ記録を有効にするステートマシンの ARN。

• IncludeExecutionData

  型: ブール値

  デフォルト: False

  説明: (オプション) 実行データをログに含めるかどうかを決定します。

• TracingConfiguration

  型: ブール値

  デフォルト: False

  説明: (オプション) AWS X-Ray トレースを有効にするかどうかを決定します。

必要な IAM アクセス許可

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

• ssm:GetAutomationExecution

• ssm:StartAutomationExecution

• states:DescribeStateMachine

• states:UpdateStateMachine

ドキュメントステップ

• EnableStepFunctionsStateMachineLogging (aws:executeAwsApi) - 指定されたステートマシンを、指定されたログ記録設定で更新します。

• VerifyStepFunctionsStateMachineLoggingEnabled (aws:assertAwsResourceProperty) - 指定されたステートマシンでログ記録が有効になっていることを確認します。

出力

• EnableStepFunctionsStateMachineLogging.Response - UpdateStateMachine API コールからのレスポンス。