Skip to content

BucketAccessLogConfig

Used by
Source code in docs_src/capo_lightsail/types/bucket_access_log_config.py 
15
16
17
18
19
20
21
22
23
class BucketAccessLogConfig(TypedDict, closed=True):
    enabled: "capo_lightsail.types.boolean.boolean"
    """<p>A Boolean value that indicates whether bucket access logging is enabled for the bucket.</p>"""
    destination: NotRequired["capo_lightsail.types.bucket_name.BucketName"]
    """<p>The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.</p> <note> <p>This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.</p> </note>"""
    prefix: NotRequired[
        "capo_lightsail.types.bucket_access_log_prefix.BucketAccessLogPrefix"
    ]
    """<p>The optional object prefix for the bucket access log.</p> <p>The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a <code>logs/</code> prefix, then each log object will begin with the <code>logs/</code> prefix in its key (for example, <code>logs/2021-11-01-21-32-16-E568B2907131C0C0</code>).</p> <note> <p>This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.</p> </note>"""

destination instance-attribute 

destination: NotRequired[BucketName]

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

enabled instance-attribute 

enabled: boolean

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

prefix instance-attribute 

prefix: NotRequired[BucketAccessLogPrefix]

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.