Class: AWSCDK::Route53::PublicHostedZone

Inherits:
HostedZone
  • Object
show all
Includes:
IPublicHostedZone
Defined in:
route53/public_hosted_zone.rb

Overview

Create a Route53 public hosted zone.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ PublicHostedZone

Returns a new instance of PublicHostedZone.

Parameters:



12
13
14
15
16
17
18
 
# File 'route53/public_hosted_zone.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Route53::PublicHostedZoneProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5QdWJsaWNIb3N0ZWRab25lUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_public_hosted_zone_attributes(scope, id, attrs) ⇒ AWSCDK::Route53::IPublicHostedZone

Imports a public hosted zone from another stack.

Use when both hosted zone ID and hosted zone name are known.

Parameters:

  • scope (Constructs::Construct) —

    the parent Construct for this Construct.

  • id (String) —

    the logical name of this Construct.

  • attrs (AWSCDK::Route53::PublicHostedZoneAttributes) —

    the PublicHostedZoneAttributes (hosted zone ID and hosted zone name).

Returns:



57
58
59
60
61
62
63
 
# File 'route53/public_hosted_zone.rb', line 57

def self.from_public_hosted_zone_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::Route53::PublicHostedZoneAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5QdWJsaWNIb3N0ZWRab25lQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53.PublicHostedZone", "fromPublicHostedZoneAttributes", [scope, id, attrs])
end

.from_public_hosted_zone_id(scope, id, public_hosted_zone_id) ⇒ AWSCDK::Route53::IPublicHostedZone

Import a Route 53 public hosted zone defined either outside the CDK, or in a different CDK stack.

Use when hosted zone ID is known. If a PublicHostedZone is imported with this method the zoneName cannot be referenced. If the zoneName is needed then the PublicHostedZone should be imported with from_public_hosted_zone_attributes().

Parameters:

  • scope (Constructs::Construct) —

    the parent Construct for this Construct.

  • id (String) —

    the logical name of this Construct.

  • public_hosted_zone_id (String) —

    the ID of the public hosted zone to import.

Returns:



74
75
76
77
78
79
 
# File 'route53/public_hosted_zone.rb', line 74

def self.from_public_hosted_zone_id(scope, id, public_hosted_zone_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(public_hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publicHostedZoneId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53.PublicHostedZone", "fromPublicHostedZoneId", [scope, id, public_hosted_zone_id])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'route53/public_hosted_zone.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grants => { kind: :property, name: "grants", is_optional: false },
    :hosted_zone_arn => { kind: :property, name: "hostedZoneArn", is_optional: false },
    :hosted_zone_id => { kind: :property, name: "hostedZoneId", is_optional: false },
    :hosted_zone_ref => { kind: :property, name: "hostedZoneRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :vpcs => { kind: :property, name: "vpcs", is_optional: false },
    :zone_name => { kind: :property, name: "zoneName", is_optional: false },
    :hosted_zone_name_servers => { kind: :property, name: "hostedZoneNameServers", is_optional: true },
    :cross_account_zone_delegation_role => { kind: :property, name: "crossAccountZoneDelegationRole", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_vpc => { kind: :method, name: "addVpc", is_optional: false },
    :enable_dnssec => { kind: :method, name: "enableDnssec", is_optional: false },
    :grant_delegation => { kind: :method, name: "grantDelegation", is_optional: false },
    :add_delegation => { kind: :method, name: "addDelegation", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


127
128
129
 
# File 'route53/public_hosted_zone.rb', line 127

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_route53.PublicHostedZone", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_delegation(delegate, opts = nil) ⇒ void

This method returns an undefined value.

Adds a delegation from this zone to a designated zone.

Parameters:



323
324
325
326
327
328
 
# File 'route53/public_hosted_zone.rb', line 323

def add_delegation(delegate, opts = nil)
  Jsii::Type.check_type(delegate, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5JUHVibGljSG9zdGVkWm9uZSJ9")), "delegate")
  opts = opts.is_a?(Hash) ? ::AWSCDK::Route53::ZoneDelegationOptions.new(**opts.transform_keys(&:to_sym)) : opts
  Jsii::Type.check_type(opts, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5ab25lRGVsZWdhdGlvbk9wdGlvbnMifQ==")), "opts") unless opts.nil?
  jsii_call_method("addDelegation", [delegate, opts])
end

#add_vpc(_vpc) ⇒ void

This method returns an undefined value.

Add another VPC to this private hosted zone.

Parameters:



288
289
290
291
 
# File 'route53/public_hosted_zone.rb', line 288

def add_vpc(_vpc)
  Jsii::Type.check_type(_vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "_vpc")
  jsii_call_method("addVpc", [_vpc])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



227
228
229
230
 
# File 'route53/public_hosted_zone.rb', line 227

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



244
245
246
247
 
# File 'route53/public_hosted_zone.rb', line 244

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#cross_account_zone_delegation_role ⇒ AWSCDK::IAM::Role?

Role for cross account zone delegation.

Returns:



190
191
192
 
# File 'route53/public_hosted_zone.rb', line 190

def ()
  jsii_get_property("crossAccountZoneDelegationRole")
end

#enable_dnssec(options) ⇒ AWSCDK::Route53::IKeySigningKey

Enable DNSSEC for this hosted zone.

This will create a key signing key with the given options and enable DNSSEC signing for the hosted zone.

Parameters:

Returns:



300
301
302
303
304
 
# File 'route53/public_hosted_zone.rb', line 300

def enable_dnssec(options)
  options = options.is_a?(Hash) ? ::AWSCDK::Route53::ZoneSigningOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5ab25lU2lnbmluZ09wdGlvbnMifQ==")), "options")
  jsii_call_method("enableDnssec", [options])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



99
100
101
 
# File 'route53/public_hosted_zone.rb', line 99

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


250
251
252
 
# File 'route53/public_hosted_zone.rb', line 250

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


264
265
266
267
268
269
 
# File 'route53/public_hosted_zone.rb', line 264

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


279
280
281
282
 
# File 'route53/public_hosted_zone.rb', line 279

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_delegation(grantee, options = nil) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



311
312
313
314
315
316
 
# File 'route53/public_hosted_zone.rb', line 311

def grant_delegation(grantee, options = nil)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  options = options.is_a?(Hash) ? ::AWSCDK::Route53::GrantDelegationOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5HcmFudERlbGVnYXRpb25PcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("grantDelegation", [grantee, options])
end

#grants ⇒ AWSCDK::Route53::HostedZoneGrants

Grants helper for this hosted zone.

Returns:



134
135
136
 
# File 'route53/public_hosted_zone.rb', line 134

def grants()
  jsii_get_property("grants")
end

#hosted_zone_arn ⇒ String

ARN of this hosted zone, such as arn:$Partition:route53:::hostedzone/$Id.

Returns:

  • (String) 


141
142
143
 
# File 'route53/public_hosted_zone.rb', line 141

def hosted_zone_arn()
  jsii_get_property("hostedZoneArn")
end

#hosted_zone_id ⇒ String

ID of this hosted zone, such as "Z23ABC4XYZL05B".

Returns:

  • (String) 


148
149
150
 
# File 'route53/public_hosted_zone.rb', line 148

def hosted_zone_id()
  jsii_get_property("hostedZoneId")
end

#hosted_zone_name_servers ⇒ Array<String>?

Returns the set of name servers for the specific hosted zone. For example: ns1.example.com.

This attribute will be undefined for private hosted zones or hosted zones imported from another stack.

Returns:

  • (Array<String>, nil) 


183
184
185
 
# File 'route53/public_hosted_zone.rb', line 183

def hosted_zone_name_servers()
  jsii_get_property("hostedZoneNameServers")
end

#hosted_zone_ref ⇒ AWSCDK::Interfaces::AWSRoute53::HostedZoneReference

A reference to a HostedZone resource.

Returns:



155
156
157
 
# File 'route53/public_hosted_zone.rb', line 155

def hosted_zone_ref()
  jsii_get_property("hostedZoneRef")
end

#name ⇒ String

FQDN of this hosted zone.

Returns:

  • (String) 


162
163
164
 
# File 'route53/public_hosted_zone.rb', line 162

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


84
85
86
 
# File 'route53/public_hosted_zone.rb', line 84

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


113
114
115
 
# File 'route53/public_hosted_zone.rb', line 113

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



120
121
122
 
# File 'route53/public_hosted_zone.rb', line 120

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


197
198
199
 
# File 'route53/public_hosted_zone.rb', line 197

def to_string()
  jsii_call_method("toString", [])
end

#vpcs ⇒ Array<AWSCDK::Route53::CfnHostedZone::VPCProperty>

Returns:



167
168
169
 
# File 'route53/public_hosted_zone.rb', line 167

def vpcs()
  jsii_get_property("vpcs")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


210
211
212
213
214
215
 
# File 'route53/public_hosted_zone.rb', line 210

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#zone_name ⇒ String

FQDN of this hosted zone.

Returns:

  • (String) 


174
175
176
 
# File 'route53/public_hosted_zone.rb', line 174

def zone_name()
  jsii_get_property("zoneName")
end