Class: AWSCDK::CloudFrontOrigins::OriginGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_front_origins/origin_group_props.rb

Overview

Construction properties for OriginGroup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fallback_origin:, primary_origin:, fallback_status_codes: nil, selection_criteria: nil) ⇒ OriginGroupProps

Returns a new instance of OriginGroupProps.

Parameters:

  • fallback_origin (AWSCDK::CloudFront::IOrigin) —

    The fallback origin that should serve requests when the primary fails.

  • primary_origin (AWSCDK::CloudFront::IOrigin) —

    The primary origin that should serve requests for this group.

  • fallback_status_codes (Array<Numeric>, nil) (defaults to: nil) —

    The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin.

  • selection_criteria (AWSCDK::CloudFront::OriginSelectionCriteria, nil) (defaults to: nil) —

    The selection criteria for the origin group.



11
12
13
14
15
16
17
18
19
20
 
# File 'cloud_front_origins/origin_group_props.rb', line 11

def initialize(fallback_origin:, primary_origin:, fallback_status_codes: nil, selection_criteria: nil)
  @fallback_origin = fallback_origin
  Jsii::Type.check_type(@fallback_origin, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5JT3JpZ2luIn0=")), "fallbackOrigin")
  @primary_origin = primary_origin
  Jsii::Type.check_type(@primary_origin, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5JT3JpZ2luIn0=")), "primaryOrigin")
  @fallback_status_codes = fallback_status_codes
  Jsii::Type.check_type(@fallback_status_codes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6Im51bWJlciJ9LCJraW5kIjoiYXJyYXkifX0=")), "fallbackStatusCodes") unless @fallback_status_codes.nil?
  @selection_criteria = selection_criteria
  Jsii::Type.check_type(@selection_criteria, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5PcmlnaW5TZWxlY3Rpb25Dcml0ZXJpYSJ9")), "selectionCriteria") unless @selection_criteria.nil?
end

Instance Attribute Details

#fallback_origin ⇒ AWSCDK::CloudFront::IOrigin (readonly)

The fallback origin that should serve requests when the primary fails.

Returns:



25
26
27
 
# File 'cloud_front_origins/origin_group_props.rb', line 25

def fallback_origin
  @fallback_origin
end

#fallback_status_codes ⇒ Array<Numeric>? (readonly)

Note:

Default: - 500, 502, 503 and 504

The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin.

Returns:

  • (Array<Numeric>, nil) 


34
35
36
 
# File 'cloud_front_origins/origin_group_props.rb', line 34

def fallback_status_codes
  @fallback_status_codes
end

#primary_origin ⇒ AWSCDK::CloudFront::IOrigin (readonly)

The primary origin that should serve requests for this group.

Returns:



29
30
31
 
# File 'cloud_front_origins/origin_group_props.rb', line 29

def primary_origin
  @primary_origin
end

#selection_criteria ⇒ AWSCDK::CloudFront::OriginSelectionCriteria? (readonly)

Note:

Default: - OriginSelectionCriteria.DEFAULT

The selection criteria for the origin group.

Returns:

See Also:



40
41
42
 
# File 'cloud_front_origins/origin_group_props.rb', line 40

def selection_criteria
  @selection_criteria
end

Class Method Details

.jsii_properties ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'cloud_front_origins/origin_group_props.rb', line 42

def self.jsii_properties
  {
    :fallback_origin => "fallbackOrigin",
    :primary_origin => "primaryOrigin",
    :fallback_status_codes => "fallbackStatusCodes",
    :selection_criteria => "selectionCriteria",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'cloud_front_origins/origin_group_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "fallbackOrigin" => @fallback_origin,
    "primaryOrigin" => @primary_origin,
    "fallbackStatusCodes" => @fallback_status_codes,
    "selectionCriteria" => @selection_criteria,
  })
  result.compact
end