Class: AWSCDK::CloudFront::OriginRequestPolicyProps

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

Overview

Properties for creating a Origin Request Policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, cookie_behavior: nil, header_behavior: nil, origin_request_policy_name: nil, query_string_behavior: nil) ⇒ OriginRequestPolicyProps

Returns a new instance of OriginRequestPolicyProps.

Parameters:



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'cloud_front/origin_request_policy_props.rb', line 12

def initialize(comment: nil, cookie_behavior: nil, header_behavior: nil, origin_request_policy_name: nil, query_string_behavior: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @cookie_behavior = cookie_behavior
  Jsii::Type.check_type(@cookie_behavior, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5PcmlnaW5SZXF1ZXN0Q29va2llQmVoYXZpb3IifQ==")), "cookieBehavior") unless @cookie_behavior.nil?
  @header_behavior = header_behavior
  Jsii::Type.check_type(@header_behavior, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5PcmlnaW5SZXF1ZXN0SGVhZGVyQmVoYXZpb3IifQ==")), "headerBehavior") unless @header_behavior.nil?
  @origin_request_policy_name = origin_request_policy_name
  Jsii::Type.check_type(@origin_request_policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "originRequestPolicyName") unless @origin_request_policy_name.nil?
  @query_string_behavior = query_string_behavior
  Jsii::Type.check_type(@query_string_behavior, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5PcmlnaW5SZXF1ZXN0UXVlcnlTdHJpbmdCZWhhdmlvciJ9")), "queryStringBehavior") unless @query_string_behavior.nil?
end

Instance Attribute Details

#comment ⇒ String? (readonly)

Note:

Default: - no comment

A comment to describe the origin request policy.

Returns:

  • (String, nil) 


29
30
31
 
# File 'cloud_front/origin_request_policy_props.rb', line 29

def comment
  @comment
end

#cookie_behavior ⇒ AWSCDK::CloudFront::OriginRequestCookieBehavior? (readonly)

Note:

Default: OriginRequestCookieBehavior.none()

The cookies from viewer requests to include in origin requests.

Returns:



34
35
36
 
# File 'cloud_front/origin_request_policy_props.rb', line 34

def cookie_behavior
  @cookie_behavior
end

#header_behavior ⇒ AWSCDK::CloudFront::OriginRequestHeaderBehavior? (readonly)

Note:

Default: OriginRequestHeaderBehavior.none()

The HTTP headers to include in origin requests.

These can include headers from viewer requests and additional headers added by CloudFront.

Returns:



41
42
43
 
# File 'cloud_front/origin_request_policy_props.rb', line 41

def header_behavior
  @header_behavior
end

#origin_request_policy_name ⇒ String? (readonly)

Note:

Default: - generated from the id

A unique name to identify the origin request policy.

The name must only include '-', '_', or alphanumeric characters.

Returns:

  • (String, nil) 


48
49
50
 
# File 'cloud_front/origin_request_policy_props.rb', line 48

def origin_request_policy_name
  @origin_request_policy_name
end

#query_string_behavior ⇒ AWSCDK::CloudFront::OriginRequestQueryStringBehavior? (readonly)

Note:

Default: OriginRequestQueryStringBehavior.none()

The URL query strings from viewer requests to include in origin requests.

Returns:



53
54
55
 
# File 'cloud_front/origin_request_policy_props.rb', line 53

def query_string_behavior
  @query_string_behavior
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'cloud_front/origin_request_policy_props.rb', line 55

def self.jsii_properties
  {
    :comment => "comment",
    :cookie_behavior => "cookieBehavior",
    :header_behavior => "headerBehavior",
    :origin_request_policy_name => "originRequestPolicyName",
    :query_string_behavior => "queryStringBehavior",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'cloud_front/origin_request_policy_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "comment" => @comment,
    "cookieBehavior" => @cookie_behavior,
    "headerBehavior" => @header_behavior,
    "originRequestPolicyName" => @origin_request_policy_name,
    "queryStringBehavior" => @query_string_behavior,
  })
  result.compact
end