Class: AWSCDK::CloudFront::OriginFailoverConfig

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

Overview

The failover configuration used for Origin Groups, returned in OriginBindConfig.failoverConfig.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(failover_origin:, status_codes: nil) ⇒ OriginFailoverConfig

Returns a new instance of OriginFailoverConfig.

Parameters:

  • failover_origin (AWSCDK::CloudFront::IOrigin)

    The origin to use as the fallback origin.

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

    The HTTP status codes of the response that trigger querying the failover Origin.



9
10
11
12
13
14
# File 'cloud_front/origin_failover_config.rb', line 9

def initialize(failover_origin:, status_codes: nil)
  @failover_origin = failover_origin
  Jsii::Type.check_type(@failover_origin, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5JT3JpZ2luIn0=")), "failoverOrigin")
  @status_codes = status_codes
  Jsii::Type.check_type(@status_codes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6Im51bWJlciJ9LCJraW5kIjoiYXJyYXkifX0=")), "statusCodes") unless @status_codes.nil?
end

Instance Attribute Details

#failover_originAWSCDK::CloudFront::IOrigin (readonly)

The origin to use as the fallback origin.



19
20
21
# File 'cloud_front/origin_failover_config.rb', line 19

def failover_origin
  @failover_origin
end

#status_codesArray<Numeric>? (readonly)

Note:

Default: - 500, 502, 503 and 504

The HTTP status codes of the response that trigger querying the failover Origin.

Returns:

  • (Array<Numeric>, nil)


24
25
26
# File 'cloud_front/origin_failover_config.rb', line 24

def status_codes
  @status_codes
end

Class Method Details

.jsii_propertiesObject



26
27
28
29
30
31
# File 'cloud_front/origin_failover_config.rb', line 26

def self.jsii_properties
  {
    :failover_origin => "failoverOrigin",
    :status_codes => "statusCodes",
  }
end

Instance Method Details

#to_jsiiObject



33
34
35
36
37
38
39
40
# File 'cloud_front/origin_failover_config.rb', line 33

def to_jsii
  result = {}
  result.merge!({
    "failoverOrigin" => @failover_origin,
    "statusCodes" => @status_codes,
  })
  result.compact
end