Sign In to the Console
AWS CloudFormation
User Guide (Version )

AWS Documentation » AWS CloudFormation » User Guide » CloudFront Resource Type Reference » AWS::CloudFront::Distribution » AWS::CloudFront::Distribution Logging
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::CloudFront::Distribution Logging

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Bucket" : String,
  "IncludeCookies" : Boolean,
  "Prefix" : String
}

YAML

  Bucket: String
  IncludeCookies: Boolean
  Prefix: String

Properties

Bucket

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

Required: Yes

Type: String

Update requires: No interruption

IncludeCookies

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.

Required: No

Type: Boolean

Update requires: No interruption

Prefix

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.

Required: No

Type: String

Update requires: No interruption

See Also

On this page: