Class: AWSCDK::Route53::HostedZoneProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
route53/hosted_zone_provider_props.rb

Overview

Zone properties for looking up the Hosted Zone.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, private_zone: nil, vpc_id: nil) ⇒ HostedZoneProviderProps

Returns a new instance of HostedZoneProviderProps.

Parameters:

  • domain_name (String) —

    The zone domain e.g. example.com.

  • private_zone (Boolean, nil) (defaults to: nil) —

    Whether the zone that is being looked up is a private hosted zone.

  • vpc_id (String, nil) (defaults to: nil) —

    Specifies the ID of the VPC associated with a private hosted zone.



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

def initialize(domain_name:, private_zone: nil, vpc_id: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @private_zone = private_zone
  Jsii::Type.check_type(@private_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "privateZone") unless @private_zone.nil?
  @vpc_id = vpc_id
  Jsii::Type.check_type(@vpc_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") unless @vpc_id.nil?
end

Instance Attribute Details

#domain_name ⇒ String (readonly)

The zone domain e.g. example.com.

Returns:

  • (String) 


22
23
24
 
# File 'route53/hosted_zone_provider_props.rb', line 22

def domain_name
  @domain_name
end

#private_zone ⇒ Boolean? (readonly)

Note:

Default: false

Whether the zone that is being looked up is a private hosted zone.

Returns:

  • (Boolean, nil) 


27
28
29
 
# File 'route53/hosted_zone_provider_props.rb', line 27

def private_zone
  @private_zone
end

#vpc_id ⇒ String? (readonly)

Note:

Default: - No VPC ID

Specifies the ID of the VPC associated with a private hosted zone.

If a VPC ID is provided and privateZone is false, no results will be returned and an error will be raised

Returns:

  • (String, nil) 


35
36
37
 
# File 'route53/hosted_zone_provider_props.rb', line 35

def vpc_id
  @vpc_id
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'route53/hosted_zone_provider_props.rb', line 37

def self.jsii_properties
  {
    :domain_name => "domainName",
    :private_zone => "privateZone",
    :vpc_id => "vpcId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'route53/hosted_zone_provider_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "privateZone" => @private_zone,
    "vpcId" => @vpc_id,
  })
  result.compact
end