trails

Creates, updates, deletes or gets a trail resource or lists trails in a region

Overview

Name	trails
Type	Resource
Description	Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Id	aws.cloudtrail.trails

Fields

Name	Datatype	Description
cloud_watch_logs_log_group_arn	string	Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
cloud_watch_logs_role_arn	string	Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enable_log_file_validation	boolean	Specifies whether log file validation is enabled. The default is false.
advanced_event_selectors	array	The advanced event selectors that were used to select events for the data store.
event_selectors	array	Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
include_global_service_events	boolean	Specifies whether the trail is publishing events from global services such as IAM to the log files.
is_logging	boolean	Whether the CloudTrail is currently logging AWS API calls.
is_multi_region_trail	boolean	Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
is_organization_trail	boolean	Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
kms_key_id	string	Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
s3_bucket_name	string	Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
s3_key_prefix	string	Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
sns_topic_name	string	Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tags	array
trail_name	string
arn	string
sns_topic_arn	string
insight_selectors	array	Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	S3BucketName, IsLogging, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all trails in a region.

SELECT
region,
cloud_watch_logs_log_group_arn,
cloud_watch_logs_role_arn,
enable_log_file_validation,
advanced_event_selectors,
event_selectors,
include_global_service_events,
is_logging,
is_multi_region_trail,
is_organization_trail,
kms_key_id,
s3_bucket_name,
s3_key_prefix,
sns_topic_name,
tags,
trail_name,
arn,
sns_topic_arn,
insight_selectors
FROM aws.cloudtrail.trails
WHERE region = 'us-east-1';

Gets all properties from an individual trail.

SELECT
region,
cloud_watch_logs_log_group_arn,
cloud_watch_logs_role_arn,
enable_log_file_validation,
advanced_event_selectors,
event_selectors,
include_global_service_events,
is_logging,
is_multi_region_trail,
is_organization_trail,
kms_key_id,
s3_bucket_name,
s3_key_prefix,
sns_topic_name,
tags,
trail_name,
arn,
sns_topic_arn,
insight_selectors
FROM aws.cloudtrail.trails
WHERE region = 'us-east-1' AND data__Identifier = '<TrailName>';

INSERT example

Use the following StackQL query and manifest file to create a new trail resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cloudtrail.trails (
 IsLogging,
 S3BucketName,
 region
)
SELECT 
'{{ IsLogging }}',
 '{{ S3BucketName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudtrail.trails (
 CloudWatchLogsLogGroupArn,
 CloudWatchLogsRoleArn,
 EnableLogFileValidation,
 AdvancedEventSelectors,
 EventSelectors,
 IncludeGlobalServiceEvents,
 IsLogging,
 IsMultiRegionTrail,
 IsOrganizationTrail,
 KMSKeyId,
 S3BucketName,
 S3KeyPrefix,
 SnsTopicName,
 Tags,
 TrailName,
 InsightSelectors,
 region
)
SELECT 
 '{{ CloudWatchLogsLogGroupArn }}',
 '{{ CloudWatchLogsRoleArn }}',
 '{{ EnableLogFileValidation }}',
 '{{ AdvancedEventSelectors }}',
 '{{ EventSelectors }}',
 '{{ IncludeGlobalServiceEvents }}',
 '{{ IsLogging }}',
 '{{ IsMultiRegionTrail }}',
 '{{ IsOrganizationTrail }}',
 '{{ KMSKeyId }}',
 '{{ S3BucketName }}',
 '{{ S3KeyPrefix }}',
 '{{ SnsTopicName }}',
 '{{ Tags }}',
 '{{ TrailName }}',
 '{{ InsightSelectors }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: trail
    props:
      - name: CloudWatchLogsLogGroupArn
        value: '{{ CloudWatchLogsLogGroupArn }}'
      - name: CloudWatchLogsRoleArn
        value: '{{ CloudWatchLogsRoleArn }}'
      - name: EnableLogFileValidation
        value: '{{ EnableLogFileValidation }}'
      - name: AdvancedEventSelectors
        value:
          - Name: '{{ Name }}'
            FieldSelectors:
              - Field: '{{ Field }}'
                Equals:
                  - '{{ Equals[0] }}'
                StartsWith:
                  - '{{ StartsWith[0] }}'
                EndsWith:
                  - '{{ EndsWith[0] }}'
                NotEquals:
                  - '{{ NotEquals[0] }}'
                NotStartsWith:
                  - '{{ NotStartsWith[0] }}'
                NotEndsWith:
                  - '{{ NotEndsWith[0] }}'
      - name: EventSelectors
        value:
          - DataResources:
              - Type: '{{ Type }}'
                Values:
                  - '{{ Values[0] }}'
            IncludeManagementEvents: '{{ IncludeManagementEvents }}'
            ReadWriteType: '{{ ReadWriteType }}'
            ExcludeManagementEventSources:
              - '{{ ExcludeManagementEventSources[0] }}'
      - name: IncludeGlobalServiceEvents
        value: '{{ IncludeGlobalServiceEvents }}'
      - name: IsLogging
        value: '{{ IsLogging }}'
      - name: IsMultiRegionTrail
        value: '{{ IsMultiRegionTrail }}'
      - name: IsOrganizationTrail
        value: '{{ IsOrganizationTrail }}'
      - name: KMSKeyId
        value: '{{ KMSKeyId }}'
      - name: S3BucketName
        value: '{{ S3BucketName }}'
      - name: S3KeyPrefix
        value: '{{ S3KeyPrefix }}'
      - name: SnsTopicName
        value: '{{ SnsTopicName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: TrailName
        value: '{{ TrailName }}'
      - name: InsightSelectors
        value:
          - InsightType: '{{ InsightType }}'

DELETE example

/*+ delete */
DELETE FROM aws.cloudtrail.trails
WHERE data__Identifier = '<TrailName>'
AND region = 'us-east-1';

Permissions

To operate on the trails resource, the following permissions are required:

Create

CloudTrail:CreateTrail,
CloudTrail:StartLogging,
CloudTrail:AddTags,
CloudTrail:PutEventSelectors,
CloudTrail:PutInsightSelectors,
iam:GetRole,
iam:PassRole,
iam:CreateServiceLinkedRole,
organizations:DescribeOrganization,
organizations:ListAWSServiceAccessForOrganization

Read

CloudTrail:GetTrail,
CloudTrail:GetTrailStatus,
CloudTrail:ListTags,
CloudTrail:GetEventSelectors,
CloudTrail:GetInsightSelectors,
CloudTrail:DescribeTrails

Update

CloudTrail:UpdateTrail,
CloudTrail:StartLogging,
CloudTrail:StopLogging,
CloudTrail:AddTags,
CloudTrail:RemoveTags,
CloudTrail:PutEventSelectors,
CloudTrail:PutInsightSelectors,
iam:GetRole,
iam:PassRole,
iam:CreateServiceLinkedRole,
organizations:DescribeOrganization,
organizations:ListAWSServiceAccessForOrganization,
CloudTrail:GetTrail,
CloudTrail:DescribeTrails

Delete

CloudTrail:DeleteTrail

List

CloudTrail:ListTrails,
CloudTrail:GetTrail,
CloudTrail:GetTrailStatus,
CloudTrail:ListTags,
CloudTrail:GetEventSelectors,
CloudTrail:GetInsightSelectors,
CloudTrail:DescribeTrails