Zone¶

class oci.dns.models.Zone(**kwargs)¶

Bases: object

A DNS zone.

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

Attributes

`DNSSEC_STATE_DISABLED`	A constant which can be used with the dnssec_state property of a Zone.
`DNSSEC_STATE_ENABLED`	A constant which can be used with the dnssec_state property of a Zone.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Zone.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Zone.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Zone.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Zone.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Zone.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Zone.
`SCOPE_GLOBAL`	A constant which can be used with the scope property of a Zone.
`SCOPE_PRIVATE`	A constant which can be used with the scope property of a Zone.
`ZONE_TYPE_PRIMARY`	A constant which can be used with the zone_type property of a Zone.
`ZONE_TYPE_SECONDARY`	A constant which can be used with the zone_type property of a Zone.
`compartment_id`	[Required] Gets the compartment_id of this Zone.
`defined_tags`	[Required] Gets the defined_tags of this Zone.
`dnssec_config`	Gets the dnssec_config of this Zone.
`dnssec_state`	[Required] Gets the dnssec_state of this Zone.
`external_downstreams`	[Required] Gets the external_downstreams of this Zone.
`external_masters`	[Required] Gets the external_masters of this Zone.
`freeform_tags`	[Required] Gets the freeform_tags of this Zone.
`id`	[Required] Gets the id of this Zone.
`is_protected`	[Required] Gets the is_protected of this Zone.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Zone.
`name`	[Required] Gets the name of this Zone.
`nameservers`	[Required] Gets the nameservers of this Zone.
`scope`	[Required] Gets the scope of this Zone.
`self_uri`	[Required] Gets the self_uri of this Zone.
`serial`	[Required] Gets the serial of this Zone.
`time_created`	[Required] Gets the time_created of this Zone.
`version`	[Required] Gets the version of this Zone.
`view_id`	Gets the view_id of this Zone.
`zone_transfer_servers`	Gets the zone_transfer_servers of this Zone.
`zone_type`	[Required] Gets the zone_type of this Zone.

Methods

__init__(**kwargs) Initializes a new Zone object with values from keyword arguments.

DNSSEC_STATE_DISABLED = 'DISABLED'¶: A constant which can be used with the dnssec_state property of a Zone. This constant has a value of “DISABLED”

DNSSEC_STATE_ENABLED = 'ENABLED'¶: A constant which can be used with the dnssec_state property of a Zone. This constant has a value of “ENABLED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Zone. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Zone. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Zone. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Zone. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Zone. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Zone. This constant has a value of “UPDATING”

SCOPE_GLOBAL = 'GLOBAL'¶: A constant which can be used with the scope property of a Zone. This constant has a value of “GLOBAL”

SCOPE_PRIVATE = 'PRIVATE'¶: A constant which can be used with the scope property of a Zone. This constant has a value of “PRIVATE”

ZONE_TYPE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the zone_type property of a Zone. This constant has a value of “PRIMARY”

ZONE_TYPE_SECONDARY = 'SECONDARY'¶: A constant which can be used with the zone_type property of a Zone. This constant has a value of “SECONDARY”

__init__(**kwargs)¶

Initializes a new Zone object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this Zone.
zone_type (str) – The value to assign to the zone_type property of this Zone. Allowed values for this property are: “PRIMARY”, “SECONDARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this Zone.
view_id (str) – The value to assign to the view_id property of this Zone.
scope (str) – The value to assign to the scope property of this Zone. Allowed values for this property are: “GLOBAL”, “PRIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Zone.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Zone.
dnssec_state (str) – The value to assign to the dnssec_state property of this Zone. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
external_masters (list[oci.dns.models.ExternalMaster]) – The value to assign to the external_masters property of this Zone.
external_downstreams (list[oci.dns.models.ExternalDownstream]) – The value to assign to the external_downstreams property of this Zone.
self_uri (str) – The value to assign to the self_uri property of this Zone.
id (str) – The value to assign to the id property of this Zone.
time_created (datetime) – The value to assign to the time_created property of this Zone.
version (str) – The value to assign to the version property of this Zone.
serial (int) – The value to assign to the serial property of this Zone.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Zone. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_protected (bool) – The value to assign to the is_protected property of this Zone.
dnssec_config (oci.dns.models.DnssecConfig) – The value to assign to the dnssec_config property of this Zone.
nameservers (list[oci.dns.models.Nameserver]) – The value to assign to the nameservers property of this Zone.
zone_transfer_servers (list[oci.dns.models.ZoneTransferServer]) – The value to assign to the zone_transfer_servers property of this Zone.

compartment_id¶

[Required] Gets the compartment_id of this Zone. The OCID of the compartment containing the zone.

Returns:	The compartment_id of this Zone.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this Zone. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this Zone.
Return type:	dict(str, dict(str, object))

dnssec_config¶

Gets the dnssec_config of this Zone.

Returns:	The dnssec_config of this Zone.
Return type:	oci.dns.models.DnssecConfig

dnssec_state¶

[Required] Gets the dnssec_state of this Zone. 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 KskDnssecKeyVersion`s 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.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The dnssec_state of this Zone.
Return type:	str

external_downstreams¶

[Required] Gets the external_downstreams of this Zone. External secondary servers for the zone. This field is currently not supported when zoneType is SECONDARY or scope is PRIVATE.

Returns:	The external_downstreams of this Zone.
Return type:	list[oci.dns.models.ExternalDownstream]

external_masters¶

[Required] Gets the external_masters of this Zone. External master servers for the zone. externalMasters becomes a required parameter when the zoneType value is SECONDARY.

Returns:	The external_masters of this Zone.
Return type:	list[oci.dns.models.ExternalMaster]

freeform_tags¶

[Required] Gets the freeform_tags of this Zone. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this Zone.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Zone. The OCID of the zone.

Returns:	The id of this Zone.
Return type:	str

is_protected¶

[Required] Gets the is_protected of this Zone. A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.

Returns:	The is_protected of this Zone.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this Zone. The current state of the zone resource.

Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Zone.
Return type:	str

name¶

[Required] Gets the name of this Zone. The name of the zone.

Returns:	The name of this Zone.
Return type:	str

nameservers¶

[Required] Gets the nameservers of this Zone. The authoritative nameservers for the zone.

Returns:	The nameservers of this Zone.
Return type:	list[oci.dns.models.Nameserver]

scope¶

[Required] Gets the scope of this Zone. The scope of the zone.

Allowed values for this property are: “GLOBAL”, “PRIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The scope of this Zone.
Return type:	str

self_uri¶

[Required] Gets the self_uri of this Zone. The canonical absolute URL of the resource.

Returns:	The self_uri of this Zone.
Return type:	str

serial¶

[Required] Gets the serial of this Zone. The current serial of the zone. As seen in the zone’s SOA record.

Returns:	The serial of this Zone.
Return type:	int

time_created¶

[Required] Gets the time_created of this Zone. The date and time the resource was created in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

Returns:	The time_created of this Zone.
Return type:	datetime

version¶

[Required] Gets the version of this Zone. Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone’s SOA record is derived.

Returns:	The version of this Zone.
Return type:	str

view_id¶

Gets the view_id of this Zone. The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.

Returns:	The view_id of this Zone.
Return type:	str

zone_transfer_servers¶

Gets the zone_transfer_servers of this Zone. The OCI nameservers that transfer the zone data with external nameservers.

Returns:	The zone_transfer_servers of this Zone.
Return type:	list[oci.dns.models.ZoneTransferServer]

zone_type¶

[Required] Gets the zone_type of this Zone. The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.

Allowed values for this property are: “PRIMARY”, “SECONDARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The zone_type of this Zone.
Return type:	str