Network.AWS.CloudTrail.UpdateTrail

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.

Creating a Request

updateTrail

Arguments

:: Text

utName

-> UpdateTrail

Creates a value of UpdateTrail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• utS3KeyPrefix
• utSNSTopicName
• utEnableLogFileValidation
• utCloudWatchLogsLogGroupARN
• utKMSKeyId
• utIncludeGlobalServiceEvents
• utCloudWatchLogsRoleARN
• utS3BucketName
• utIsMultiRegionTrail
• utName

data UpdateTrail

Specifies settings to update for the trail.

See: updateTrail smart constructor.

Instances

Eq UpdateTrail

Data UpdateTrail

Read UpdateTrail

Show UpdateTrail

Generic UpdateTrail

ToJSON UpdateTrail

Hashable UpdateTrail

AWSRequest UpdateTrail

ToPath UpdateTrail

ToHeaders UpdateTrail

ToQuery UpdateTrail

type Rep UpdateTrail

type Rs UpdateTrail = UpdateTrailResponse

Request Lenses

utS3KeyPrefix :: Lens' UpdateTrail (Maybe Text)

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.

utSNSTopicName :: Lens' UpdateTrail (Maybe Text)

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

utEnableLogFileValidation :: Lens' UpdateTrail (Maybe Bool)

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.

utCloudWatchLogsLogGroupARN :: Lens' UpdateTrail (Maybe Text)

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.

utKMSKeyId :: Lens' UpdateTrail (Maybe Text)

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

utIncludeGlobalServiceEvents :: Lens' UpdateTrail (Maybe Bool)

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

utCloudWatchLogsRoleARN :: Lens' UpdateTrail (Maybe Text)

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

utS3BucketName :: Lens' UpdateTrail (Maybe Text)

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

utIsMultiRegionTrail :: Lens' UpdateTrail (Maybe Bool)

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.

utName :: Lens' UpdateTrail Text

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 are invalid.
• Not be in IP address format (for example, 192.168.5.4)

If Name is a trail ARN, it must be in the format 'arn:aws:cloudtrail:us-east-1:123456789012:trail\/MyTrail'.

Destructuring the Response

updateTrailResponse

Arguments

:: Int

utrsResponseStatus

-> UpdateTrailResponse

Creates a value of UpdateTrailResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• utrsLogFileValidationEnabled
• utrsTrailARN
• utrsS3KeyPrefix
• utrsSNSTopicName
• utrsCloudWatchLogsLogGroupARN
• utrsKMSKeyId
• utrsName
• utrsIncludeGlobalServiceEvents
• utrsCloudWatchLogsRoleARN
• utrsS3BucketName
• utrsIsMultiRegionTrail
• utrsResponseStatus

data UpdateTrailResponse

Returns the objects or data listed below if successful. Otherwise, returns an error.

See: updateTrailResponse smart constructor.

Instances

Eq UpdateTrailResponse

Data UpdateTrailResponse

Read UpdateTrailResponse

Show UpdateTrailResponse

Generic UpdateTrailResponse

type Rep UpdateTrailResponse

Response Lenses

utrsLogFileValidationEnabled :: Lens' UpdateTrailResponse (Maybe Bool)

Specifies whether log file integrity validation is enabled.

utrsTrailARN :: Lens' UpdateTrailResponse (Maybe Text)

Specifies the ARN of the trail that was updated.

utrsS3KeyPrefix :: Lens' UpdateTrailResponse (Maybe Text)

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.

utrsSNSTopicName :: Lens' UpdateTrailResponse (Maybe Text)

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

utrsCloudWatchLogsLogGroupARN :: Lens' UpdateTrailResponse (Maybe Text)

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

utrsKMSKeyId :: Lens' UpdateTrailResponse (Maybe Text)

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'

utrsName :: Lens' UpdateTrailResponse (Maybe Text)

Specifies the name of the trail.

utrsIncludeGlobalServiceEvents :: Lens' UpdateTrailResponse (Maybe Bool)

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

utrsCloudWatchLogsRoleARN :: Lens' UpdateTrailResponse (Maybe Text)

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

utrsS3BucketName :: Lens' UpdateTrailResponse (Maybe Text)

Specifies the name of the Amazon S3 bucket designated for publishing log files.

utrsIsMultiRegionTrail :: Lens' UpdateTrailResponse (Maybe Bool)

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

utrsResponseStatus :: Lens' UpdateTrailResponse Int

The response status code.