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.

Container for the parameters to the UpdateTrail operation. Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

Inheritance Hierarchy


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


public class UpdateTrailRequest : AmazonCloudTrailRequest

The UpdateTrailRequest type exposes the following members


Public Method UpdateTrailRequest()


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 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 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.

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 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.


  • 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 or trail ARN. If Name is a trail name, the string 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,

If Name is a trail ARN, it must be in the format:


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 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