AWS-QueryCloudTrailLogs - Amazon Systems Manager Automation runbook reference
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS-QueryCloudTrailLogs

Description

The AWS-QueryCloudTrailLogs runbook creates an Amazon Athena table from the Amazon Simple Storage Service (Amazon S3) bucket of your choice containing Amazon CloudTrail (CloudTrail) logs. After creating the table, the automation runs SQL queries you specify and then deletes the table.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Databases

Parameters

  • AutomationAssumeRole

    Type: String

    Description: (Optional) The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses the permissions of the user that starts this runbook.

  • Query

    Type: String

    Description: (Required) The SQL query you want to run.

  • SourceBucketPath

    Type: String

    Description: (Required) The name of the Amazon S3 bucket containing the CloudTrail log files you want to query.

  • TableName

    Type: String

    Description: (Optional) The name of the Athena table created by the automation.

    Default: cloudtrail_logs

Required IAM permissions

The AutomationAssumeRole parameter requires the following actions to use the runbook successfully.

  • athena:GetQueryResults

  • athena:GetQueryExecution

  • athena:StartQueryExecution

  • glue:CreateTable

  • glue:DeleteTable

  • glue:GetDatabase

  • glue:GetPartitions

  • glue:GetTable

  • s3:AbortMultipartUpload

  • s3:CreateBucket

  • s3:GetBucketLocation

  • s3:GetObject

  • s3:ListBucket

  • s3:ListBucketMultipartUploads

  • s3:ListMultipartUploadParts

  • s3:PutObject

Document Steps

  • aws:executeAwsApi - Creates an Athena table.

  • aws:executeAwsApi - Runs the query string you specify in the Query parameter.

  • aws:executeScript - Polls and waits for the query to complete.

  • aws:executeAwsApi - Gets the results of the query.

  • aws:executeAwsApi - Deletes the table created by the automation.