Class: AWSCDK::APIGateway::DomainNameAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/domain_name_attributes.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, domain_name_alias_hosted_zone_id:, domain_name_alias_target:) ⇒ DomainNameAttributes

Returns a new instance of DomainNameAttributes.

Parameters:

  • domain_name (String) —

    The domain name (e.g. example.com).

  • domain_name_alias_hosted_zone_id (String) —

    The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

  • domain_name_alias_target (String) —

    The Route53 alias target to use in order to connect a record set to this domain through an alias.



9
10
11
12
13
14
15
16
 
# File 'api_gateway/domain_name_attributes.rb', line 9

def initialize(domain_name:, domain_name_alias_hosted_zone_id:, domain_name_alias_target:)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @domain_name_alias_hosted_zone_id = domain_name_alias_hosted_zone_id
  Jsii::Type.check_type(@domain_name_alias_hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainNameAliasHostedZoneId")
  @domain_name_alias_target = domain_name_alias_target
  Jsii::Type.check_type(@domain_name_alias_target, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainNameAliasTarget")
end

Instance Attribute Details

#domain_name ⇒ String (readonly)

The domain name (e.g. example.com).

Returns:

  • (String) 


21
22
23
 
# File 'api_gateway/domain_name_attributes.rb', line 21

def domain_name
  @domain_name
end

#domain_name_alias_hosted_zone_id ⇒ String (readonly)

The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

Returns:

  • (String) 


25
26
27
 
# File 'api_gateway/domain_name_attributes.rb', line 25

def domain_name_alias_hosted_zone_id
  @domain_name_alias_hosted_zone_id
end

#domain_name_alias_target ⇒ String (readonly)

The Route53 alias target to use in order to connect a record set to this domain through an alias.

Returns:

  • (String) 


29
30
31
 
# File 'api_gateway/domain_name_attributes.rb', line 29

def domain_name_alias_target
  @domain_name_alias_target
end

Class Method Details

.jsii_properties ⇒ Object 



31
32
33
34
35
36
37
 
# File 'api_gateway/domain_name_attributes.rb', line 31

def self.jsii_properties
  {
    :domain_name => "domainName",
    :domain_name_alias_hosted_zone_id => "domainNameAliasHostedZoneId",
    :domain_name_alias_target => "domainNameAliasTarget",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



39
40
41
42
43
44
45
46
47
 
# File 'api_gateway/domain_name_attributes.rb', line 39

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "domainNameAliasHostedZoneId" => @domain_name_alias_hosted_zone_id,
    "domainNameAliasTarget" => @domain_name_alias_target,
  })
  result.compact
end