AWS CDK Reference

Appearance

v2.277.0

LoggingProperty Struct ​

A complex type that specifies whether access logs are written for the distribution.

If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a different Amazon S3 bucket or use a separate path in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see Standard logging (access logs) in the Amazon CloudFront Developer Guide .

Source
Generated code
Type last changed
v2.174.0 · 4 Jan 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const loggingProperty: cloudfront.CfnDistribution.LoggingProperty = {
  bucket: 'bucket',
  includeCookies: false,
  prefix: 'prefix',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

logging_property = cloudfront.CfnDistribution.LoggingProperty(
    bucket="bucket",
    include_cookies=False,
    prefix="prefix"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudfront.*;

LoggingProperty loggingProperty = LoggingProperty.builder()
        .bucket("bucket")
        .includeCookies(false)
        .prefix("prefix")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var loggingProperty = new LoggingProperty {
    Bucket = "bucket",
    IncludeCookies = false,
    Prefix = "prefix"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

loggingProperty := &LoggingProperty{
	Bucket: jsii.String("bucket"),
	IncludeCookies: jsii.Boolean(false),
	Prefix: jsii.String("prefix"),
}

Properties ​

bucketoptionalstringbucketoptionalstrbucketoptionalStringBucketoptionalstringBucketoptional*string#
The Amazon S3 bucket to store the access logs in, for example, `amzn-s3-demo-bucket.s3.amazonaws.com` .
includeCookiesoptionalboolean | IResolvableinclude_cookiesoptionaltyping.Union[bool, IResolvable]includeCookiesoptionalBooleanIncludeCookiesoptionalboolIncludeCookiesoptionalinterface{}= false#
Specifies whether you want CloudFront to include cookies in access logs, specify `true` for `IncludeCookies` .
notes

If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies .

prefixoptionalstringprefixoptionalstrprefixoptionalStringPrefixoptionalstringPrefixoptional*string= ""#
An optional string that you want CloudFront to prefix to the access log `filenames` for this distribution, for example, `myprefix/` .

If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.