Class: AWSCDK::CloudFront::CacheCookieBehavior

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

Overview

Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ CacheCookieBehavior

Returns a new instance of CacheCookieBehavior.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'cloud_front/cache_cookie_behavior.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_cloudfront.CacheCookieBehavior does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.all ⇒ AWSCDK::CloudFront::CacheCookieBehavior

All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

Returns:

  • (AWSCDK::CloudFront::CacheCookieBehavior) 


22
23
24
 
# File 'cloud_front/cache_cookie_behavior.rb', line 22

def self.all()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CacheCookieBehavior", "all", [])
end

.allow_list(*cookies) ⇒ AWSCDK::CloudFront::CacheCookieBehavior

Only the provided cookies are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Parameters:

  • cookies (Array<String>)

Returns:

  • (AWSCDK::CloudFront::CacheCookieBehavior) 


30
31
32
33
34
35
 
# File 'cloud_front/cache_cookie_behavior.rb', line 30

def self.allow_list(*cookies)
  cookies.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cookies[#{index}]")
  end
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CacheCookieBehavior", "allowList", [*cookies])
end

.deny_list(*cookies) ⇒ AWSCDK::CloudFront::CacheCookieBehavior

All cookies except the provided cookies are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Parameters:

  • cookies (Array<String>)

Returns:

  • (AWSCDK::CloudFront::CacheCookieBehavior) 


41
42
43
44
45
46
 
# File 'cloud_front/cache_cookie_behavior.rb', line 41

def self.deny_list(*cookies)
  cookies.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cookies[#{index}]")
  end
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CacheCookieBehavior", "denyList", [*cookies])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'cloud_front/cache_cookie_behavior.rb', line 12

def self.jsii_overridable_methods
  {
    :behavior => { kind: :property, name: "behavior", is_optional: false },
    :cookies => { kind: :property, name: "cookies", is_optional: true },
  }
end

.none ⇒ AWSCDK::CloudFront::CacheCookieBehavior

Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

Returns:

  • (AWSCDK::CloudFront::CacheCookieBehavior) 


51
52
53
 
# File 'cloud_front/cache_cookie_behavior.rb', line 51

def self.none()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CacheCookieBehavior", "none", [])
end

Instance Method Details

#behavior ⇒ String

The behavior of cookies: allow all, none, an allow list, or a deny list.

Returns:

  • (String) 


58
59
60
 
# File 'cloud_front/cache_cookie_behavior.rb', line 58

def behavior()
  jsii_get_property("behavior")
end

#cookies ⇒ Array<String>?

The cookies to allow or deny, if the behavior is an allow or deny list.

Returns:

  • (Array<String>, nil) 


65
66
67
 
# File 'cloud_front/cache_cookie_behavior.rb', line 65

def cookies()
  jsii_get_property("cookies")
end