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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFront::Types::LoggingConfig

Includes:

Structure

Defined in:

lib/aws-sdk-cloudfront/types.rb

Overview

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

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

• #enabled ⇒ 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`.

• #prefix ⇒ String

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

Instance Attribute Details

#bucket ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudfront/types.rb', line 8387

class LoggingConfig < Struct.new(
  :enabled,
  :include_cookies,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#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` and `prefix`, the values are automatically deleted.

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudfront/types.rb', line 8387

class LoggingConfig < Struct.new(
  :enabled,
  :include_cookies,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-cloudfront/types.rb', line 8387

class LoggingConfig < Struct.new(
  :enabled,
  :include_cookies,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-cloudfront/types.rb', line 8387

class LoggingConfig < Struct.new(
  :enabled,
  :include_cookies,
  :bucket,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end