Class: AWSCDK::APIGatewayv2::DomainMappingOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2/domain_mapping_options.rb

Overview

Options for DomainMapping.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, mapping_key: nil) ⇒ DomainMappingOptions

Returns a new instance of DomainMappingOptions.

Parameters:



9
10
11
12
13
14
 
# File 'api_gatewayv2/domain_mapping_options.rb', line 9

def initialize(domain_name:, mapping_key: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5djIuSURvbWFpbk5hbWVSZWYifQ==")), "domainName")
  @mapping_key = mapping_key
  Jsii::Type.check_type(@mapping_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mappingKey") unless @mapping_key.nil?
end

Instance Attribute Details

#domain_name ⇒ AWSCDK::Interfaces::AWSApigatewayv2::IDomainNameRef (readonly)

The domain name for the mapping.

Returns:



19
20
21
 
# File 'api_gatewayv2/domain_mapping_options.rb', line 19

def domain_name
  @domain_name
end

#mapping_key ⇒ String? (readonly)

Note:

Default: - empty key for the root path mapping

The API mapping key.

Leave it undefined for the root path mapping.

Returns:

  • (String, nil) 


26
27
28
 
# File 'api_gatewayv2/domain_mapping_options.rb', line 26

def mapping_key
  @mapping_key
end

Class Method Details

.jsii_properties ⇒ Object 



28
29
30
31
32
33
 
# File 'api_gatewayv2/domain_mapping_options.rb', line 28

def self.jsii_properties
  {
    :domain_name => "domainName",
    :mapping_key => "mappingKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'api_gatewayv2/domain_mapping_options.rb', line 35

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "mappingKey" => @mapping_key,
  })
  result.compact
end