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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass LoggingConfig data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)

9466
9467
9468
9469
9470
9471
9472
9473
# File 'lib/aws-sdk-cloudfront/types.rb', line 9466

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

#enabledBoolean

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)

9466
9467
9468
9469
9470
9471
9472
9473
# File 'lib/aws-sdk-cloudfront/types.rb', line 9466

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

#include_cookiesBoolean

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)

9466
9467
9468
9469
9470
9471
9472
9473
# File 'lib/aws-sdk-cloudfront/types.rb', line 9466

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

#prefixString

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)

9466
9467
9468
9469
9470
9471
9472
9473
# File 'lib/aws-sdk-cloudfront/types.rb', line 9466

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