amazonka-cloudtrail-1.4.0: Amazon CloudTrail SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudTrail.CreateTrail

Contents

Description

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.

Synopsis

Creating a Request

Request Lenses

ctS3KeyPrefix :: Lens' CreateTrail (Maybe Text) Source

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.

ctSNSTopicName :: Lens' CreateTrail (Maybe Text) Source

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

ctEnableLogFileValidation :: Lens' CreateTrail (Maybe Bool) Source

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.

ctCloudWatchLogsLogGroupARN :: Lens' CreateTrail (Maybe Text) Source

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.

ctKMSKeyId :: Lens' CreateTrail (Maybe Text) Source

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

ctIncludeGlobalServiceEvents :: Lens' CreateTrail (Maybe Bool) Source

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

ctCloudWatchLogsRoleARN :: Lens' CreateTrail (Maybe Text) Source

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

ctIsMultiRegionTrail :: Lens' CreateTrail (Maybe Bool) Source

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

ctName :: Lens' CreateTrail Text Source

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

ctS3BucketName :: Lens' CreateTrail Text Source

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

Destructuring the Response

data CreateTrailResponse Source

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

See: createTrailResponse smart constructor.

Response Lenses

ctrsLogFileValidationEnabled :: Lens' CreateTrailResponse (Maybe Bool) Source

Specifies whether log file integrity validation is enabled.

ctrsTrailARN :: Lens' CreateTrailResponse (Maybe Text) Source

Specifies the ARN of the trail that was created.

ctrsS3KeyPrefix :: Lens' CreateTrailResponse (Maybe Text) Source

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.

ctrsSNSTopicName :: Lens' CreateTrailResponse (Maybe Text) Source

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

ctrsCloudWatchLogsLogGroupARN :: Lens' CreateTrailResponse (Maybe Text) Source

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

ctrsKMSKeyId :: Lens' CreateTrailResponse (Maybe Text) Source

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'

ctrsName :: Lens' CreateTrailResponse (Maybe Text) Source

Specifies the name of the trail.

ctrsIncludeGlobalServiceEvents :: Lens' CreateTrailResponse (Maybe Bool) Source

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

ctrsCloudWatchLogsRoleARN :: Lens' CreateTrailResponse (Maybe Text) Source

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

ctrsS3BucketName :: Lens' CreateTrailResponse (Maybe Text) Source

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

ctrsIsMultiRegionTrail :: Lens' CreateTrailResponse (Maybe Bool) Source

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