如何从 CloudFormation 模板启用/禁用 Cloudfront 日志记录？

Question

In DistributionConfig we have the logging configuration:

Logging:
  IncludeCookies: 'true'
  Bucket: !Sub '${BucketName}-logs.s3.amazonaws.com'
  Prefix: 'CF'

However is there a config parameter to enable/disable logging, similar to the option in the AWS Console?

Answer 1

There is no such parameter for disabling logging in the AWS::CloudFront::Distribution DistributionConfig resource.

It is the presence of the Logging property in the resource definition that enables logging. To disable logs, you can simply remove the Logging property section from your resource, and update the stack.

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html

Answer 2

There is a Logging toggle in the CloudFront distribution settings page. Click and edit the CloudFront distribution settings where there is the toggle to turn on/off logging .

You can also set the Enabled flag to false in the cloudformation resource for Cloudfront.

AWSTemplateFormatVersion: 2010-09-09
Resources:
  cloudfrontdistribution:
    Type: AWS::CloudFront::Distribution
    Properties:
      DistributionConfig:
        Logging:
          Enabled: false

Enabled Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

Type: Boolean

reference: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_LoggingConfig.html

Hope this helps.

Answer 3

Adding the attribute - "Enabled": "false" inside the Logging object will disable logging.

Here is the change that can be applied to the cloud-formation template:

"Logging" : {
    "IncludeCookies" : "false",
    "Bucket" : "s3-bucket-name",
    "Prefix" : "logging-prefix",
    "Enabled": "false"
}

More information:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-cloudfront.html