Class: AWSCDK::Lightsail::CfnLoadBalancerTLSCertificateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lightsail/cfn_load_balancer_tls_certificate_props.rb

Overview

Properties for defining a CfnLoadBalancerTlsCertificate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_domain_name:, certificate_name:, load_balancer_name:, certificate_alternative_names: nil, https_redirection_enabled: nil, is_attached: nil) ⇒ CfnLoadBalancerTLSCertificateProps

Returns a new instance of CfnLoadBalancerTLSCertificateProps.

Parameters:

  • certificate_domain_name (String) —

    The domain name for the SSL/TLS certificate.

  • certificate_name (String) —

    The name of the SSL/TLS certificate.

  • load_balancer_name (String) —

    The name of the load balancer that the SSL/TLS certificate is attached to.

  • certificate_alternative_names (Array<String>, nil) (defaults to: nil) —

    An array of alternative domain names and subdomain names for your SSL/TLS certificate.

  • https_redirection_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

  • is_attached (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 15

def initialize(certificate_domain_name:, certificate_name:, load_balancer_name:, certificate_alternative_names: nil, https_redirection_enabled: nil, is_attached: nil)
  @certificate_domain_name = certificate_domain_name
  Jsii::Type.check_type(@certificate_domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateDomainName")
  @certificate_name = certificate_name
  Jsii::Type.check_type(@certificate_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateName")
  @load_balancer_name = load_balancer_name
  Jsii::Type.check_type(@load_balancer_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerName")
  @certificate_alternative_names = certificate_alternative_names
  Jsii::Type.check_type(@certificate_alternative_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "certificateAlternativeNames") unless @certificate_alternative_names.nil?
  @https_redirection_enabled = https_redirection_enabled
  Jsii::Type.check_type(@https_redirection_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "httpsRedirectionEnabled") unless @https_redirection_enabled.nil?
  @is_attached = is_attached
  Jsii::Type.check_type(@is_attached, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isAttached") unless @is_attached.nil?
end

Instance Attribute Details

#certificate_alternative_names ⇒ Array<String>? (readonly)

An array of alternative domain names and subdomain names for your SSL/TLS certificate.

In addition to the primary domain name, you can have up to nine alternative domain names. Wildcards (such as *.example.com ) are not supported.

Returns:

  • (Array<String>, nil)

See Also:



53
54
55
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 53

def certificate_alternative_names
  @certificate_alternative_names
end

#certificate_domain_name ⇒ String (readonly)

The domain name for the SSL/TLS certificate.

For example, example.com or www.example.com .

Returns:

  • (String)

See Also:



36
37
38
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 36

def certificate_domain_name
  @certificate_domain_name
end

#certificate_name ⇒ String (readonly)

The name of the SSL/TLS certificate.

Returns:

  • (String)

See Also:



41
42
43
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 41

def certificate_name
  @certificate_name
end

#https_redirection_enabled ⇒ Boolean, ... (readonly)

A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.

Returns:

See Also:



58
59
60
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 58

def https_redirection_enabled
  @https_redirection_enabled
end

#is_attached ⇒ Boolean, ... (readonly)

A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.

Returns:

See Also:



63
64
65
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 63

def is_attached
  @is_attached
end

#load_balancer_name ⇒ String (readonly)

The name of the load balancer that the SSL/TLS certificate is attached to.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 46

def load_balancer_name
  @load_balancer_name
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 65

def self.jsii_properties
  {
    :certificate_domain_name => "certificateDomainName",
    :certificate_name => "certificateName",
    :load_balancer_name => "loadBalancerName",
    :certificate_alternative_names => "certificateAlternativeNames",
    :https_redirection_enabled => "httpsRedirectionEnabled",
    :is_attached => "isAttached",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lightsail/cfn_load_balancer_tls_certificate_props.rb', line 76

def to_jsii
  result = {}
  result.merge!({
    "certificateDomainName" => @certificate_domain_name,
    "certificateName" => @certificate_name,
    "loadBalancerName" => @load_balancer_name,
    "certificateAlternativeNames" => @certificate_alternative_names,
    "httpsRedirectionEnabled" => @https_redirection_enabled,
    "isAttached" => @is_attached,
  })
  result.compact
end