Module: AWSCDK::Route53::IHostedZone

Includes:
IResource, INamedHostedZoneRef
Included in:
HostedZone, IPrivateHostedZone, IPublicHostedZone
Defined in:
route53/i_hosted_zone.rb

Overview

Imported or created hosted zone.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'route53/i_hosted_zone.rb', line 123

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :hosted_zone_ref => { kind: :property, name: "hostedZoneRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :hosted_zone_arn => { kind: :property, name: "hostedZoneArn", is_optional: false },
    :hosted_zone_id => { kind: :property, name: "hostedZoneId", is_optional: false },
    :zone_name => { kind: :property, name: "zoneName", is_optional: false },
    :hosted_zone_name_servers => { kind: :property, name: "hostedZoneNameServers", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_delegation => { kind: :method, name: "grantDelegation", is_optional: false },
  }
end

Instance Method Details

#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:



106
107
108
109
 
# File 'route53/i_hosted_zone.rb', line 106

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



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

def env()
  jsii_get_property("env")
end

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

Grant permissions to add delegation records to this zone.

Parameters:

Returns:



116
117
118
119
120
121
 
# File 'route53/i_hosted_zone.rb', line 116

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

#hosted_zone_arn ⇒ String

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

Returns:

  • (String) 


53
54
55
 
# File 'route53/i_hosted_zone.rb', line 53

def hosted_zone_arn()
  jsii_get_property("hostedZoneArn")
end

#hosted_zone_id ⇒ String

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

Returns:

  • (String) 


60
61
62
 
# File 'route53/i_hosted_zone.rb', line 60

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) 


76
77
78
 
# File 'route53/i_hosted_zone.rb', line 76

def hosted_zone_name_servers()
  jsii_get_property("hostedZoneNameServers")
end

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

A reference to a HostedZone resource.

Returns:



41
42
43
 
# File 'route53/i_hosted_zone.rb', line 41

def hosted_zone_ref()
  jsii_get_property("hostedZoneRef")
end

#name ⇒ String

Returns:

  • (String) 


46
47
48
 
# File 'route53/i_hosted_zone.rb', line 46

def name()
  jsii_get_property("name")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'route53/i_hosted_zone.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'route53/i_hosted_zone.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



87
88
89
90
91
92
 
# File 'route53/i_hosted_zone.rb', line 87

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) 


67
68
69
 
# File 'route53/i_hosted_zone.rb', line 67

def zone_name()
  jsii_get_property("zoneName")
end