AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The settings for a trail.

Inheritance Hierarchy

System.Object
  Amazon.CloudTrail.Model.Trail

Namespace: Amazon.CloudTrail.Model
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z

Syntax

C#
public class Trail

The Trail type exposes the following members

Constructors

NameDescription
Public Method Trail()

Properties

NameTypeDescription
Public Property CloudWatchLogsLogGroupArn System.String

Gets and sets the property CloudWatchLogsLogGroupArn.

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

Public Property CloudWatchLogsRoleArn System.String

Gets and sets the property CloudWatchLogsRoleArn.

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

Public Property HasCustomEventSelectors System.Boolean

Gets and sets the property HasCustomEventSelectors.

Specifies if the trail has custom event selectors.

Public Property HomeRegion System.String

Gets and sets the property HomeRegion.

The region in which the trail was created.

Public Property IncludeGlobalServiceEvents System.Boolean

Gets and sets the property IncludeGlobalServiceEvents.

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

Public Property IsMultiRegionTrail System.Boolean

Gets and sets the property IsMultiRegionTrail.

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

Public Property KmsKeyId System.String

Gets and sets the property 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-1:123456789012:key/12345678-1234-1234-1234-123456789012

Public Property LogFileValidationEnabled System.Boolean

Gets and sets the property LogFileValidationEnabled.

Specifies whether log file validation is enabled.

Public Property Name System.String

Gets and sets the property Name.

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

Public Property S3BucketName System.String

Gets and sets the property S3BucketName.

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

Public Property S3KeyPrefix System.String

Gets and sets the property 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.

Public Property SnsTopicARN System.String

Gets and sets the property 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-1:123456789012:MyTopic

Public Property SnsTopicName System.String

Gets and sets the property SnsTopicName.

This field is deprecated. Use SnsTopicARN.

Public Property TrailARN System.String

Gets and sets the property TrailARN.

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

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms