Class: AWSCDK::CloudFront::ViewerCertificate

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

Overview

Viewer certificate configuration class.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ ViewerCertificate

Returns a new instance of ViewerCertificate.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'cloud_front/viewer_certificate.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_cloudfront.ViewerCertificate does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.from_acm_certificate(certificate, options = nil) ⇒ AWSCDK::CloudFront::ViewerCertificate

Generate an AWS Certificate Manager (ACM) viewer certificate configuration.

Parameters:

Returns:

  • (AWSCDK::CloudFront::ViewerCertificate) 


24
25
26
27
28
29
 
# File 'cloud_front/viewer_certificate.rb', line 24

def self.from_acm_certificate(certificate, options = nil)
  Jsii::Type.check_type(certificate, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jZXJ0aWZpY2F0ZW1hbmFnZXIuSUNlcnRpZmljYXRlUmVmIn0=")), "certificate")
  options = options.is_a?(Hash) ? ::AWSCDK::CloudFront::ViewerCertificateOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5WaWV3ZXJDZXJ0aWZpY2F0ZU9wdGlvbnMifQ==")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.ViewerCertificate", "fromAcmCertificate", [certificate, options])
end

.from_cloud_front_default_certificate(*aliases) ⇒ AWSCDK::CloudFront::ViewerCertificate

Generate a viewer certificate configuration using the CloudFront default certificate (e.g. d111111abcdef8.cloudfront.net) and a SecurityPolicyProtocol.TLS_V1 security policy.

Parameters:

  • aliases (Array<String>) —

    Alternative CNAME aliases You also must create a CNAME record with your DNS service to route queries.

Returns:

  • (AWSCDK::CloudFront::ViewerCertificate) 


35
36
37
38
39
40
 
# File 'cloud_front/viewer_certificate.rb', line 35

def self.from_cloud_front_default_certificate(*aliases)
  aliases.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aliases[#{index}]")
  end
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.ViewerCertificate", "fromCloudFrontDefaultCertificate", [*aliases])
end

.from_iam_certificate(iam_certificate_id, options = nil) ⇒ AWSCDK::CloudFront::ViewerCertificate

Generate an IAM viewer certificate configuration.

Parameters:

Returns:

  • (AWSCDK::CloudFront::ViewerCertificate) 


47
48
49
50
51
52
 
# File 'cloud_front/viewer_certificate.rb', line 47

def self.from_iam_certificate(iam_certificate_id, options = nil)
  Jsii::Type.check_type(iam_certificate_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamCertificateId")
  options = options.is_a?(Hash) ? ::AWSCDK::CloudFront::ViewerCertificateOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5WaWV3ZXJDZXJ0aWZpY2F0ZU9wdGlvbnMifQ==")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.ViewerCertificate", "fromIamCertificate", [iam_certificate_id, options])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'cloud_front/viewer_certificate.rb', line 12

def self.jsii_overridable_methods
  {
    :aliases => { kind: :property, name: "aliases", is_optional: false },
    :props => { kind: :property, name: "props", is_optional: false },
  }
end

Instance Method Details

#aliases ⇒ Array<String>

Returns:

  • (Array<String>) 


55
56
57
 
# File 'cloud_front/viewer_certificate.rb', line 55

def aliases()
  jsii_get_property("aliases")
end

#props ⇒ AWSCDK::CloudFront::CfnDistribution::ViewerCertificateProperty

Returns:



60
61
62
 
# File 'cloud_front/viewer_certificate.rb', line 60

def props()
  jsii_get_property("props")
end