Skip to content

CreateTrailResponse

Source code in docs_src/capo_cloudtrail/types/create_trail_response.py
class CreateTrailResponse(TypedDict, closed=True):
    name: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies the name of the trail.</p>"""
    s3_bucket_name: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</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>.</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 format of a topic ARN is:</p> <p> <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code> </p>"""
    include_global_service_events: NotRequired["capo_cloudtrail.types.boolean.Boolean"]
    """<p>Specifies whether the trail is publishing events from global services such as IAM to the log files. 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 in one Region or in all Regions.</p>"""
    trail_arn: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies the ARN of the trail that was created. The format of a trail ARN is:</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 integrity validation is enabled.</p>"""
    cloud_watch_logs_log_group_arn: NotRequired["capo_cloudtrail.types.string.String"]
    """<p>Specifies the Amazon Resource Name (ARN) of 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 events 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>"""
    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.</p>"""

cloud_watch_logs_log_group_arn instance-attribute

cloud_watch_logs_log_group_arn: NotRequired[String]

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

cloud_watch_logs_role_arn instance-attribute

cloud_watch_logs_role_arn: NotRequired[String]

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

include_global_service_events instance-attribute

include_global_service_events: NotRequired[Boolean]

Specifies whether the trail is publishing events from global services such as IAM to the log files. Setting this value to true 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).

is_multi_region_trail instance-attribute

is_multi_region_trail: NotRequired[Boolean]

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

is_organization_trail instance-attribute

is_organization_trail: NotRequired[Boolean]

Specifies whether the trail is an organization trail.

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

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 instance-attribute

log_file_validation_enabled: NotRequired[Boolean]

Specifies whether log file integrity validation is enabled.

name instance-attribute

name: NotRequired[String]

Specifies the name of the trail.

recursive_logging instance-attribute

recursive_logging: NotRequired[Boolean]

Specifies whether recursive logging is enabled for the trail.

s3_bucket_name instance-attribute

s3_bucket_name: NotRequired[String]

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

s3_key_prefix instance-attribute

s3_key_prefix: NotRequired[String]

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 instance-attribute

sns_topic_arn: NotRequired[String]

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 instance-attribute

sns_topic_name: NotRequired[String]

This field is no longer in use. Use SnsTopicARN.

trail_arn instance-attribute

trail_arn: NotRequired[String]

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