software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.LoggingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.LoggingProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(value=Stable)
public static interface CfnDistribution.LoggingProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // 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")
         // the properties below are optional
         .includeCookies(false)
         .prefix("prefix")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDistribution.LoggingProperty.Builder A builder for CfnDistribution.LoggingProperty
static class	CfnDistribution.LoggingProperty.Jsii$Proxy An implementation for CfnDistribution.LoggingProperty

Method Summary

Modifier and Type	Method and Description
static CfnDistribution.LoggingProperty.Builder	builder()
String	getBucket() The Amazon S3 bucket to store the access logs in, for example, `myawslogbucket.s3.amazonaws.com` .
default Object	getIncludeCookies() Specifies whether you want CloudFront to include cookies in access logs, specify `true` for `IncludeCookies` .
default String	getPrefix() An optional string that you want CloudFront to prefix to the access log `filenames` for this distribution, for example, `myprefix/` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucket

@Stability(value=Stable)
 @NotNull
String getBucket()

The Amazon S3 bucket to store the access logs in, for example, `myawslogbucket.s3.amazonaws.com` .

getIncludeCookies

@Stability(value=Stable)
 @Nullable
default Object getIncludeCookies()

Specifies whether you want CloudFront to include cookies in access logs, specify `true` for `IncludeCookies` .

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 .

getPrefix

@Stability(value=Stable)
 @Nullable
default String getPrefix()

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.

builder

@Stability(value=Stable)
static CfnDistribution.LoggingProperty.Builder builder()

Returns:

a CfnDistribution.LoggingProperty.Builder of CfnDistribution.LoggingProperty