AWS SDK Version 2 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.

.NET Framework 4.5
 
 
Container for the parameters to the CreateTrail operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudTrail.AmazonCloudTrailRequest
      Amazon.CloudTrail.Model.CreateTrailRequest

Namespace: Amazon.CloudTrail.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public class CreateTrailRequest : AmazonCloudTrailRequest
         IRequestEvents

The CreateTrailRequest type exposes the following members

Constructors

NameDescription
Public Method CreateTrailRequest()

Properties

NameTypeDescription
Public Property CloudWatchLogsLogGroupArn System.String Gets and sets the property CloudWatchLogsLogGroupArn.

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.

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

Specifies whether log file integrity validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
Public Property IncludeGlobalServiceEvents System.Boolean Gets and sets the property IncludeGlobalServiceEvents.

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Public Property IsMultiRegionTrail System.Boolean Gets and sets the property IsMultiRegionTrail.

Specifies whether the trail is created in the current region or in all regions. The default is false.

Public Property KmsKeyId System.String Gets and sets the property KmsKeyId.

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a 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.

Examples:

  • alias/MyAliasName
  • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
  • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
  • 12345678-1234-1234-1234-123456789012
Public Property Name System.String Gets and sets the property Name.

Specifies the name of the trail. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
  • Start with a letter or number, and end with a letter or number
  • Be between 3 and 128 characters
  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
  • Not be in IP address format (for example, 192.168.5.4)
Public Property S3BucketName System.String Gets and sets the property S3BucketName.

Specifies the name of the Amazon S3 bucket designated for publishing log 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 SnsTopicName System.String Gets and sets the property SnsTopicName.

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8