Class: OCI::Dns::Models::CreateZoneDetails

Inherits:
CreateZoneBaseDetails show all
Defined in:
lib/oci/dns/models/create_zone_details.rb

Overview

The body for defining a new zone.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

ZONE_TYPE_ENUM = 
[
  ZONE_TYPE_PRIMARY = 'PRIMARY'.freeze,
  ZONE_TYPE_SECONDARY = 'SECONDARY'.freeze
].freeze
SCOPE_ENUM = 
[
  SCOPE_GLOBAL = 'GLOBAL'.freeze,
  SCOPE_PRIVATE = 'PRIVATE'.freeze
].freeze
DNSSEC_STATE_ENUM = 
[
  DNSSEC_STATE_ENABLED = 'ENABLED'.freeze,
  DNSSEC_STATE_DISABLED = 'DISABLED'.freeze
].freeze

Constants inherited from CreateZoneBaseDetails

OCI::Dns::Models::CreateZoneBaseDetails::MIGRATION_SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateZoneBaseDetails

#compartment_id, #defined_tags, #freeform_tags, #migration_source, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateZoneBaseDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateZoneDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 140

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['migrationSource'] = 'NONE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.zone_type = attributes[:'zoneType'] if attributes[:'zoneType']

  raise 'You cannot provide both :zoneType and :zone_type' if attributes.key?(:'zoneType') && attributes.key?(:'zone_type')

  self.zone_type = attributes[:'zone_type'] if attributes[:'zone_type']

  self.view_id = attributes[:'viewId'] if attributes[:'viewId']

  raise 'You cannot provide both :viewId and :view_id' if attributes.key?(:'viewId') && attributes.key?(:'view_id')

  self.view_id = attributes[:'view_id'] if attributes[:'view_id']

  self.scope = attributes[:'scope'] if attributes[:'scope']

  self.external_masters = attributes[:'externalMasters'] if attributes[:'externalMasters']

  raise 'You cannot provide both :externalMasters and :external_masters' if attributes.key?(:'externalMasters') && attributes.key?(:'external_masters')

  self.external_masters = attributes[:'external_masters'] if attributes[:'external_masters']

  self.external_downstreams = attributes[:'externalDownstreams'] if attributes[:'externalDownstreams']

  raise 'You cannot provide both :externalDownstreams and :external_downstreams' if attributes.key?(:'externalDownstreams') && attributes.key?(:'external_downstreams')

  self.external_downstreams = attributes[:'external_downstreams'] if attributes[:'external_downstreams']

  self.dnssec_state = attributes[:'dnssecState'] if attributes[:'dnssecState']
  self.dnssec_state = "DISABLED" if dnssec_state.nil? && !attributes.key?(:'dnssecState') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :dnssecState and :dnssec_state' if attributes.key?(:'dnssecState') && attributes.key?(:'dnssec_state')

  self.dnssec_state = attributes[:'dnssec_state'] if attributes[:'dnssec_state']
  self.dnssec_state = "DISABLED" if dnssec_state.nil? && !attributes.key?(:'dnssecState') && !attributes.key?(:'dnssec_state') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#dnssec_state ⇒ String

The state of DNSSEC on the zone.

For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the KskDnssecKeyVersion data. You can find the DS data in the dsData attribute of the KskDnssecKeyVersion. Then, use the PromoteZoneDnssecKeyVersion operation to promote the KskDnssecKeyVersion.

New KskDnssecKeyVersions are generated annually, a week before the existing KskDnssecKeyVersion's expiration. To rollover a KskDnssecKeyVersion, you must replace the parent zone's DS record containing the old KskDnssecKeyVersion data with the data from the new KskDnssecKeyVersion.

To remove the old DS record without causing service disruption, wait until the old DS record's TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the PromoteZoneDnssecKeyVersion operation must be called.

Metrics are emitted in the oci_dns namespace daily for each KskDnssecKeyVersion indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the PromoteZoneDnssecKeyVersion operation can be called.

Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency.

For more information, see DNSSEC.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 84

def dnssec_state
  @dnssec_state
end

#external_downstreams ⇒ Array<OCI::Dns::Models::ExternalDownstream>

External secondary servers for the zone. This field is currently not supported when zoneType is SECONDARY or scope is PRIVATE.

Returns:



55
56
57
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 55

def external_downstreams
  @external_downstreams
end

#external_masters ⇒ Array<OCI::Dns::Models::ExternalMaster>

External master servers for the zone. externalMasters becomes a required parameter when the zoneType value is SECONDARY.

Returns:



49
50
51
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 49

def external_masters
  @external_masters
end

#scope ⇒ String

The scope of the zone.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 43

def scope
  @scope
end

#view_id ⇒ String

This value will be null for zones in the global DNS.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 39

def view_id
  @view_id
end

#zone_type ⇒ String

The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 34

def zone_type
  @zone_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'migration_source': :'migrationSource',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'zone_type': :'zoneType',
    'view_id': :'viewId',
    'scope': :'scope',
    'external_masters': :'externalMasters',
    'external_downstreams': :'externalDownstreams',
    'dnssec_state': :'dnssecState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 106

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'migration_source': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'zone_type': :'String',
    'view_id': :'String',
    'scope': :'String',
    'external_masters': :'Array<OCI::Dns::Models::ExternalMaster>',
    'external_downstreams': :'Array<OCI::Dns::Models::ExternalDownstream>',
    'dnssec_state': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 216

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    migration_source == other.migration_source &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    zone_type == other.zone_type &&
    view_id == other.view_id &&
    scope == other.scope &&
    external_masters == other.external_masters &&
    external_downstreams == other.external_downstreams &&
    dnssec_state == other.dnssec_state
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 256

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


236
237
238
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 236

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 245

def hash
  [migration_source, name, compartment_id, freeform_tags, defined_tags, zone_type, view_id, scope, external_masters, external_downstreams, dnssec_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 289

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



283
284
285
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 283

def to_s
  to_hash.to_s
end