Skip to content

CloudTrail  >  Operations  >  create_trail

create_trail

Operation

create_trail async 

create_trail(input: CreateTrailInput, plugins: list[Plugin] | None = None) -> CreateTrailOutput

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

Parameters:

Name Type Description Default
input CreateTrailInput

An instance of CreateTrailInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateTrailOutput

An instance of CreateTrailOutput.

Input

CreateTrailInput dataclass

Specifies the settings for each trail.

Attributes

cloud_watch_logs_log_group_arn class-attribute instance-attribute 
cloud_watch_logs_log_group_arn: str | None = None

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.

cloud_watch_logs_role_arn class-attribute instance-attribute 
cloud_watch_logs_role_arn: str | None = None

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.

enable_log_file_validation class-attribute instance-attribute 
enable_log_file_validation: bool | None = None

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

Note

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.

include_global_service_events class-attribute instance-attribute 
include_global_service_events: bool | None = None

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

is_multi_region_trail class-attribute instance-attribute 
is_multi_region_trail: bool | None = None

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.

is_organization_trail class-attribute instance-attribute 
is_organization_trail: bool | None = None

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.

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = None

Specifies the KMS key ID to use to encrypt the logs and digest files 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

name class-attribute instance-attribute 
name: str | None = None

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

  • Not be in IP address format (for example, 192.168.5.4)

s3_bucket_name class-attribute instance-attribute 
s3_bucket_name: str | None = None

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.

s3_key_prefix class-attribute instance-attribute 
s3_key_prefix: str | None = None

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.

sns_topic_name class-attribute instance-attribute 
sns_topic_name: str | None = None

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

tags_list class-attribute instance-attribute 
tags_list: list[Tag] | None = None

A list of tags.

Output

CreateTrailOutput dataclass

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

Attributes

cloud_watch_logs_log_group_arn class-attribute instance-attribute 
cloud_watch_logs_log_group_arn: str | None = None

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

cloud_watch_logs_role_arn class-attribute instance-attribute 
cloud_watch_logs_role_arn: str | None = None

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

include_global_service_events class-attribute instance-attribute 
include_global_service_events: bool | None = None

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

is_multi_region_trail class-attribute instance-attribute 
is_multi_region_trail: bool | None = None

Specifies whether the trail exists in one Region or in all Regions.

is_organization_trail class-attribute instance-attribute 
is_organization_trail: bool | None = None

Specifies whether the trail is an organization trail.

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = None

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

log_file_validation_enabled class-attribute instance-attribute 
log_file_validation_enabled: bool | None = None

Specifies whether log file integrity validation is enabled.

name class-attribute instance-attribute 
name: str | None = None

Specifies the name of the trail.

s3_bucket_name class-attribute instance-attribute 
s3_bucket_name: str | None = None

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

s3_key_prefix class-attribute instance-attribute 
s3_key_prefix: str | None = None

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.

sns_topic_arn class-attribute instance-attribute 
sns_topic_arn: str | None = None

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

sns_topic_name class-attribute instance-attribute 
sns_topic_name: str | None = None

This field is no longer in use. Use SnsTopicARN.

trail_arn class-attribute instance-attribute 
trail_arn: str | None = None

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail