Class: AWSCDK::APIGatewayv2::DomainNameAttributes

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

Overview

custom domain name attributes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, regional_domain_name:, regional_hosted_zone_id:) ⇒ DomainNameAttributes

Returns a new instance of DomainNameAttributes.

Parameters:

  • name (String)

    domain name string.

  • regional_domain_name (String)

    The domain name associated with the regional endpoint for this custom domain name.

  • regional_hosted_zone_id (String)

    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.



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

def initialize(name:, regional_domain_name:, regional_hosted_zone_id:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @regional_domain_name = regional_domain_name
  Jsii::Type.check_type(@regional_domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "regionalDomainName")
  @regional_hosted_zone_id = regional_hosted_zone_id
  Jsii::Type.check_type(@regional_hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "regionalHostedZoneId")
end

Instance Attribute Details

#nameString (readonly)

domain name string.

Returns:

  • (String)


22
23
24
# File 'api_gatewayv2/domain_name_attributes.rb', line 22

def name
  @name
end

#regional_domain_nameString (readonly)

The domain name associated with the regional endpoint for this custom domain name.

Returns:

  • (String)


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

def regional_domain_name
  @regional_domain_name
end

#regional_hosted_zone_idString (readonly)

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

Returns:

  • (String)


30
31
32
# File 'api_gatewayv2/domain_name_attributes.rb', line 30

def regional_hosted_zone_id
  @regional_hosted_zone_id
end

Class Method Details

.jsii_propertiesObject



32
33
34
35
36
37
38
# File 'api_gatewayv2/domain_name_attributes.rb', line 32

def self.jsii_properties
  {
    :name => "name",
    :regional_domain_name => "regionalDomainName",
    :regional_hosted_zone_id => "regionalHostedZoneId",
  }
end

Instance Method Details

#to_jsiiObject



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

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "regionalDomainName" => @regional_domain_name,
    "regionalHostedZoneId" => @regional_hosted_zone_id,
  })
  result.compact
end