Trail¶
Structure Class¶
dataclass
¶
The settings for a trail.
Attributes¶
class-attribute
instance-attribute
¶
cloud_watch_logs_log_group_arn: str | None = None
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
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.
class-attribute
instance-attribute
¶
has_custom_event_selectors: bool | None = None
Specifies if the trail has custom event selectors.
class-attribute
instance-attribute
¶
has_insight_selectors: bool | None = None
Specifies whether a trail has insight types specified in an
InsightSelector list.
class-attribute
instance-attribute
¶
home_region: str | None = None
The Region in which the trail was created.
class-attribute
instance-attribute
¶
include_global_service_events: bool | None = None
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
class-attribute
instance-attribute
¶
is_multi_region_trail: bool | None = None
Specifies whether the trail exists only in one Region or exists in all Regions.
class-attribute
instance-attribute
¶
is_organization_trail: bool | None = None
Specifies whether the trail is an organization trail.
class-attribute
instance-attribute
¶
kms_key_id: str | None = None
Specifies the KMS key ID that encrypts the logs and digest files 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
class-attribute
instance-attribute
¶
log_file_validation_enabled: bool | None = None
Specifies whether log file validation is enabled.
class-attribute
instance-attribute
¶
name: str | None = None
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
class-attribute
instance-attribute
¶
s3_bucket_name: str | None = None
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
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.
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 following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic