Package 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(Stable)
public static interface CfnDistribution.LoggingProperty
extends software.amazon.jsii.JsiiSerializable

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 .

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")
         .includeCookies(false)
         .prefix("prefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDistribution.LoggingProperty.Builder	builder()
default String	getBucket()	The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.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 Details

getBucket

@Stability(Stable)
@Nullable
default String getBucket()

The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-bucket

getIncludeCookies

@Stability(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 .

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-includecookies

getPrefix

@Stability(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.

Default: - ""

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-prefix

builder

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

Returns:

a CfnDistribution.LoggingProperty.Builder of CfnDistribution.LoggingProperty