Menu
AWS CloudTrail
API Reference (API Version 2013-11-01)

Trail

The settings for a trail.

Contents

CloudWatchLogsLogGroupArn

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

Type: String

Required: No

CloudWatchLogsRoleArn

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Type: String

Required: No

HasCustomEventSelectors

Specifies if the trail has custom event selectors.

Type: Boolean

Required: No

HomeRegion

The region in which the trail was created.

Type: String

Required: No

IncludeGlobalServiceEvents

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Type: Boolean

Required: No

IsMultiRegionTrail

Specifies whether the trail belongs only to one region or exists in all regions.

Type: Boolean

Required: No

KmsKeyId

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

Type: String

Required: No

LogFileValidationEnabled

Specifies whether log file validation is enabled.

Type: Boolean

Required: No

Name

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

Type: String

Required: No

S3BucketName

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

Type: String

Required: No

S3KeyPrefix

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.

Type: String

Required: No

SnsTopicARN

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

Type: String

Required: No

SnsTopicName

This field is deprecated. Use Trail:SnsTopicARN.

Type: String

Required: No

TrailARN

Specifies the ARN of the trail. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: