Class: AWSCDK::CloudFront::CfnOriginRequestPolicy::CookiesConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CloudFront::CfnOriginRequestPolicy::CookiesConfigProperty

Defined in:

cloud_front/cfn_origin_request_policy.rb

Overview

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html

Instance Attribute Summary

• #cookie_behavior ⇒ String readonly

  Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin.

• #cookies ⇒ Array<String>^? readonly

  Contains a list of cookie names.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(cookie_behavior:, cookies: nil) ⇒ CookiesConfigProperty constructor

  A new instance of CookiesConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(cookie_behavior:, cookies: nil) ⇒ CookiesConfigProperty

Returns a new instance of CookiesConfigProperty.

Parameters:

• cookie_behavior (String) —

  Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:.

• cookies (Array<String>, nil) (defaults to: nil) —

  Contains a list of cookie names.

# File 'cloud_front/cfn_origin_request_policy.rb', line 527

def initialize(cookie_behavior:, cookies: nil)
  @cookie_behavior = cookie_behavior
  Jsii::Type.check_type(@cookie_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cookieBehavior")
  @cookies = cookies
  Jsii::Type.check_type(@cookies, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "cookies") unless @cookies.nil?
end

Instance Attribute Details

#cookie_behavior ⇒ String (readonly)

Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:.

• none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.
• whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.
• all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.
• all_except – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookiebehavior

# File 'cloud_front/cfn_origin_request_policy.rb', line 543

def cookie_behavior
  @cookie_behavior
end

#cookies ⇒ Array<String>^? (readonly)

Contains a list of cookie names.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-cookiesconfig.html#cfn-cloudfront-originrequestpolicy-cookiesconfig-cookies

# File 'cloud_front/cfn_origin_request_policy.rb', line 548

def cookies
  @cookies
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cloud_front/cfn_origin_request_policy.rb', line 550

def self.jsii_properties
  {
    :cookie_behavior => "cookieBehavior",
    :cookies => "cookies",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cloud_front/cfn_origin_request_policy.rb', line 557

def to_jsii
  result = {}
  result.merge!({
    "cookieBehavior" => @cookie_behavior,
    "cookies" => @cookies,
  })
  result.compact
end