A shared CNAME (canonical name) record is similar to a regular CNAME record.
The difference is that a shared CNAME record should be added to a shared
record group. If the shared record group is associated with other zones,
the shared CNAME record is shared among these zones.
Fields
These fields are actual members of the object;
thus, they can be requested by using _return_fields,
if the fields are readable.
The basic version of the object contains the field(s): canonical, name, shared_record_group.
The following fields are required to create this object:
| Field |
Notes |
|---|
| canonical |
|
| name |
|
| shared_record_group |
|
canonical
-
canonical
Canonical name in FQDN format.
This value can be in unicode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
- ‘:=’ (case insensitive search)
- ‘=’ (exact equality)
- ‘~=’ (regular expression)
Notes
The canonical is part of the base object.
disable
-
disable
Determines if this shared record is disabled or not.
False means that the record is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
dns_canonical
-
dns_canonical
Canonical name in punycode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The dns_canonical cannot be updated.
dns_canonical cannot be written.
dns_name
-
dns_name
The name for this shared record in punycode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The dns_name cannot be updated.
dns_name cannot be written.
extattrs
-
extattrs
Extensible attributes associated with the object.
For valid values for extensible attributes,
see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
name
-
name
Name for this shared record.
This value can be in unicode format.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
- ‘:=’ (case insensitive search)
- ‘=’ (exact equality)
- ‘~=’ (regular expression)
Notes
The name is part of the base object.
shared_record_group
-
shared_record_group
The name of the shared record group in which the record resides.
Type
String.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The shared_record_group is part of the base object.
ttl
-
ttl
The Time To Live (TTL) value for this shared record. A 32-bit unsigned integer
that represents the duration, in seconds, for which the shared record
is valid (cached). Zero indicates that the shared record should not be
cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
ttl is associated with the field use_ttl (see use flag).
use_ttl
-
use_ttl
Use flag for: ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
