Class: AWSCDK::CloudFrontOrigins::S3StaticWebsiteOrigin

Inherits:
HttpOrigin
  • Object
show all
Defined in:
cloud_front_origins/s3_static_website_origin.rb

Overview

An Origin for a S3 bucket configured as a website endpoint.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket, props = nil) ⇒ S3StaticWebsiteOrigin

Returns a new instance of S3StaticWebsiteOrigin.

Parameters:



10
11
12
13
14
15
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 10

def initialize(bucket, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudFrontOrigins::S3StaticWebsiteOriginProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udF9vcmlnaW5zLlMzU3RhdGljV2Vic2l0ZU9yaWdpblByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(bucket, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 17

def self.jsii_overridable_methods
  {
    :bind => { kind: :method, name: "bind", is_optional: false },
    :render_custom_origin_config => { kind: :method, name: "renderCustomOriginConfig", is_optional: false },
    :render_s3_origin_config => { kind: :method, name: "renderS3OriginConfig", is_optional: false },
    :render_vpc_origin_config => { kind: :method, name: "renderVpcOriginConfig", is_optional: false },
    :validate_response_completion_timeout_with_read_timeout => { kind: :method, name: "validateResponseCompletionTimeoutWithReadTimeout", is_optional: false },
  }
end

Instance Method Details

#bind(scope, options) ⇒ AWSCDK::CloudFront::OriginBindConfig

Binds the origin to the associated Distribution.

Can be used to grant permissions, create dependent resources, etc.

Parameters:

Returns:



34
35
36
37
38
39
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 34

def bind(scope, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  options = options.is_a?(Hash) ? ::AWSCDK::CloudFront::OriginBindOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5PcmlnaW5CaW5kT3B0aW9ucyJ9")), "options")
  jsii_call_method("bind", [scope, options])
end

#render_custom_origin_config ⇒ AWSCDK::CloudFront::CfnDistribution::CustomOriginConfigProperty?

Returns:



42
43
44
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 42

def render_custom_origin_config()
  jsii_call_method("renderCustomOriginConfig", [])
end

#render_s3_origin_config ⇒ AWSCDK::CloudFront::CfnDistribution::S3OriginConfigProperty?

Returns:



47
48
49
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 47

def render_s3_origin_config()
  jsii_call_method("renderS3OriginConfig", [])
end

#render_vpc_origin_config ⇒ AWSCDK::CloudFront::CfnDistribution::VPCOriginConfigProperty?

Returns:



52
53
54
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 52

def render_vpc_origin_config()
  jsii_call_method("renderVpcOriginConfig", [])
end

#validate_response_completion_timeout_with_read_timeout(response_completion_timeout = nil, read_timeout = nil) ⇒ void

This method returns an undefined value.

Validates that responseCompletionTimeout is greater than or equal to readTimeout when both are specified.

This method should be called by subclasses that support readTimeout.

Parameters:



63
64
65
66
67
 
# File 'cloud_front_origins/s3_static_website_origin.rb', line 63

def validate_response_completion_timeout_with_read_timeout(response_completion_timeout = nil, read_timeout = nil)
  Jsii::Type.check_type(response_completion_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "responseCompletionTimeout") unless response_completion_timeout.nil?
  Jsii::Type.check_type(read_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "readTimeout") unless read_timeout.nil?
  jsii_call_method("validateResponseCompletionTimeoutWithReadTimeout", [response_completion_timeout, read_timeout])
end