Skip to content
v2.277.0

LoggingProperty Struct ​

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

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.CfnStreamingDistribution.LoggingProperty = {
  bucket: 'bucket',
  enabled: 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.CfnStreamingDistribution.LoggingProperty(
    bucket="bucket",
    enabled=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")
        .enabled(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",
    Enabled = 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"),
	Enabled: jsii.Boolean(false),
	Prefix: jsii.String("prefix"),
}

Properties ​

bucketstringbucketstrbucketStringBucketstringBucket*string required #
The Amazon S3 bucket to store the access logs in, for example, `amzn-s3-demo-bucket.s3.amazonaws.com` .
enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{} required #
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.
notes

If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled , and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix , the values are automatically deleted.

prefixstringprefixstrprefixStringPrefixstringPrefix*string required #
An optional string that you want CloudFront to prefix to the access log filenames for this streaming 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.