Class: AWSCDK::CloudFront::LoggingConfiguration

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_front/logging_configuration.rb

Overview

Logging configuration for incoming requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket: nil, include_cookies: nil, prefix: nil) ⇒ LoggingConfiguration

Returns a new instance of LoggingConfiguration.

Parameters:

  • bucket (AWSCDK::S3::IBucket, nil) (defaults to: nil)

    Bucket to log requests to.

  • include_cookies (Boolean, nil) (defaults to: nil)

    Whether to include the cookies in the logs.

  • prefix (String, nil) (defaults to: nil)

    Where in the bucket to store logs.



10
11
12
13
14
15
16
17
# File 'cloud_front/logging_configuration.rb', line 10

def initialize(bucket: nil, include_cookies: nil, prefix: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket") unless @bucket.nil?
  @include_cookies = include_cookies
  Jsii::Type.check_type(@include_cookies, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "includeCookies") unless @include_cookies.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
end

Instance Attribute Details

#bucketAWSCDK::S3::IBucket? (readonly)

Note:

Default: - A logging bucket is automatically created.

Bucket to log requests to.

Returns:



23
24
25
# File 'cloud_front/logging_configuration.rb', line 23

def bucket
  @bucket
end

#include_cookiesBoolean? (readonly)

Note:

Default: false

Whether to include the cookies in the logs.

Returns:

  • (Boolean, nil)


28
29
30
# File 'cloud_front/logging_configuration.rb', line 28

def include_cookies
  @include_cookies
end

#prefixString? (readonly)

Note:

Default: - No prefix.

Where in the bucket to store logs.

Returns:

  • (String, nil)


33
34
35
# File 'cloud_front/logging_configuration.rb', line 33

def prefix
  @prefix
end

Class Method Details

.jsii_propertiesObject



35
36
37
38
39
40
41
# File 'cloud_front/logging_configuration.rb', line 35

def self.jsii_properties
  {
    :bucket => "bucket",
    :include_cookies => "includeCookies",
    :prefix => "prefix",
  }
end

Instance Method Details

#to_jsiiObject



43
44
45
46
47
48
49
50
51
# File 'cloud_front/logging_configuration.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "includeCookies" => @include_cookies,
    "prefix" => @prefix,
  })
  result.compact
end