You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFront::Types::LoggingConfig

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LoggingConfig as input to an Aws::Client method, you can use a vanilla Hash:

{
  enabled: false, # required
  include_cookies: false, # required
  bucket: "string", # required
  prefix: "string", # required
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

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

Returns:

  • (String) —

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

#enabled ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.

#include_cookies ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#prefix ⇒ String

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.

Returns:

  • (String) —

    An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/.