/AWS1/CL_TRL=>CREATETRAIL()¶
About CreateTrail¶
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
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-_namespaceandmy--namespaceare not valid.Not be in IP address format (for example, 192.168.5.4)
IV_S3BUCKETNAME TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
Specifies the name of the Amazon S3 bucket designated for publishing log files. For information about bucket naming rules, see Bucket naming rules in the Amazon Simple Storage Service User Guide.
Optional arguments:¶
IV_S3KEYPREFIX TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
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.
IV_SNSTOPICNAME TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
IV_INCLUDEGLOBALSVCEVENTS TYPE /AWS1/TRLBOOLEAN /AWS1/TRLBOOLEAN¶
Specifies whether the trail is publishing events from global services such as IAM to the log files.
IV_ISMULTIREGIONTRAIL TYPE /AWS1/TRLBOOLEAN /AWS1/TRLBOOLEAN¶
Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.
IV_ENABLELOGFILEVALIDATION TYPE /AWS1/TRLBOOLEAN /AWS1/TRLBOOLEAN¶
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 does 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.
IV_CLOUDWATCHLOGSLOGGROUPARN TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
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. You must use a log group that exists in your account.
Not required unless you specify
CloudWatchLogsRoleArn.
IV_CLOUDWATCHLOGSROLEARN TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.
IV_KMSKEYID TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING¶
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.CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
IV_ISORGANIZATIONTRAIL TYPE /AWS1/TRLBOOLEAN /AWS1/TRLBOOLEAN¶
Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.
IT_TAGSLIST TYPE /AWS1/CL_TRLTAG=>TT_TAGSLIST TT_TAGSLIST¶
TagsList