Class: AWSCDK::OpenSearchService::CustomEndpointOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_service/custom_endpoint_options.rb

Overview

Configures a custom domain endpoint for the Amazon OpenSearch Service domain.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, certificate: nil, hosted_zone: nil) ⇒ CustomEndpointOptions

Returns a new instance of CustomEndpointOptions.

Parameters:



10
11
12
13
14
15
16
17
 
# File 'open_search_service/custom_endpoint_options.rb', line 10

def initialize(domain_name:, certificate: nil, hosted_zone: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @certificate = certificate
  Jsii::Type.check_type(@certificate, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jZXJ0aWZpY2F0ZW1hbmFnZXIuSUNlcnRpZmljYXRlUmVmIn0=")), "certificate") unless @certificate.nil?
  @hosted_zone = hosted_zone
  Jsii::Type.check_type(@hosted_zone, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5JSG9zdGVkWm9uZSJ9")), "hostedZone") unless @hosted_zone.nil?
end

Instance Attribute Details

#certificate ⇒ AWSCDK::Interfaces::AWSCertificatemanager::ICertificateRef? (readonly)

Note:

Default: - create a new one

The certificate to use.

Returns:



27
28
29
 
# File 'open_search_service/custom_endpoint_options.rb', line 27

def certificate
  @certificate
end

#domain_name ⇒ String (readonly)

The custom domain name to assign.

Returns:

  • (String) 


22
23
24
 
# File 'open_search_service/custom_endpoint_options.rb', line 22

def domain_name
  @domain_name
end

#hosted_zone ⇒ AWSCDK::Route53::IHostedZone? (readonly)

Note:

Default: - do not create a CNAME

The hosted zone in Route53 to create the CNAME record in.

Returns:



32
33
34
 
# File 'open_search_service/custom_endpoint_options.rb', line 32

def hosted_zone
  @hosted_zone
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
40
 
# File 'open_search_service/custom_endpoint_options.rb', line 34

def self.jsii_properties
  {
    :domain_name => "domainName",
    :certificate => "certificate",
    :hosted_zone => "hostedZone",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'open_search_service/custom_endpoint_options.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "certificate" => @certificate,
    "hostedZone" => @hosted_zone,
  })
  result.compact
end