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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudfront/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.

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)


4140
4141
4142
4143
4144
4145
4146
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4140

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

#enabledBoolean

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not 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)


4140
4141
4142
4143
4144
4145
4146
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4140

class LoggingConfig < Struct.new(
  :enabled,
  :include_cookies,
  :bucket,
  :prefix)
  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 do not 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)


4140
4141
4142
4143
4144
4145
4146
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4140

class LoggingConfig < Struct.new(
  :enabled,
  :include_cookies,
  :bucket,
  :prefix)
  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 do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Returns:

  • (String)


4140
4141
4142
4143
4144
4145
4146
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 4140

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