Trail ¶

class Trail(TypedDict, closed=True):
    name: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is 128 characters.</p>"""
    s3_bucket_name: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Amazon S3 Bucket naming rules</a>.</p>"""
    s3_key_prefix: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/get-and-view-cloudtrail-log-files.html#cloudtrail-find-log-files">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>"""
    sns_topic_name: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>This field is no longer in use. Use <code>SnsTopicARN</code>.</p>"""
    sns_topic_arn: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>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.</p> <p> <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code> </p>"""
    include_global_service_events: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Set to <b>True</b> to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, <b>False</b>. Setting this value to <code>true</code> only delivers global service events to the trail if the trail is multi-Region or if the trail's home Region is the partition leader Region (for example, us-east-1).</p>"""
    is_multi_region_trail: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies whether the trail exists only in one Region or exists in all Regions.</p>"""
    home_region: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>The Region in which the trail was created.</p>"""
    trail_arn: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies the ARN of the trail. The following is the format of a trail ARN.</p> <p> <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p>"""
    log_file_validation_enabled: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies whether log file validation is enabled.</p>"""
    cloud_watch_logs_log_group_arn: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.</p>"""
    cloud_watch_logs_role_arn: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>"""
    kms_key_id: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>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.</p> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>"""
    has_custom_event_selectors: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies if the trail has custom event selectors.</p>"""
    has_insight_selectors: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code> list.</p>"""
    is_organization_trail: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies whether the trail is an organization trail.</p>"""
    recursive_logging: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies whether recursive logging is enabled for the trail. If you set <code>RecursiveLogging</code> to <code>false</code>, CloudTrail suppresses events generated by CloudTrail when it delivers log files to your trail's destinations, including Amazon S3 and CloudWatch Logs. The default value is <code>true</code>.</p>"""