A CNAME record maps an alias to a canonical name. You can use CNAME records in both forward- and IPv4 reverse-mapping zones to serve two different purposes. (At this time, you cannot use CNAME records with IPv6 reverse-mapping zones.)
In a forward-mapping zone, a CNAME record maps an alias to a canonical (or official) name. CNAME records are often more convenient to use than canonical names because they can be shorter or more descriptive.
References to record:cname are object references. The name part of a DNS CNAME object reference has the following components:
- Name of the record
- Name of the view
Example: record:cname/ZG5zLmJpbmRfY25h:some.name.com/myview
The object does not support the following operations when managed on Cloud Platform members:
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, view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| canonical | |
| name |
Aws Route 53 record information.
Type
A/An ‘Aws Rte53 Record Info struct.
Search
The field is not available for search.
Notes
The aws_rte53_record_info cannot be updated.
aws_rte53_record_info cannot be written.
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
Notes
The canonical is part of the base object.
Structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
Comment for the record; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
The time of the record creation in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The creation_time cannot be updated.
creation_time cannot be written.
The record creator.
Note that changing creator from or to ‘SYSTEM’ value is not allowed.
Type
String.
Create
The default value is STATIC.
Search
The field is available for search via
The GSS-TSIG principal that owns this record.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Determines if the DDNS updates for this record are allowed or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the 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.
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.
The name for the CNAME 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.
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.
Determines if the reclamation is allowed for the record or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The time of the last DNS query in Epoch seconds format.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_queried cannot be updated.
last_queried cannot be written.
The name for a CNAME record in FQDN format. This value can be in unicode format. Regular expression search is not supported for unicode values.
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
Notes
The name is part of the base object.
Determines if the record is reclaimable or not.
Type
Bool.
Search
The field is available for search via
Notes
The reclaimable cannot be updated.
reclaimable cannot be written.
The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
Use flag for: ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the DNS view in which the record resides. Example: “external”.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default DNS view.
Search
The field is available for search via
Notes
The view is part of the base object.
The name of the zone in which the record resides. Example: “zone.com”. If a view is not specified when searching by zone, the default view is used.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The zone cannot be updated.
zone cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| aws_rte53_record_info | struct | N | Y | N | N/A |
| canonical | String | Y | N | Y | : = ~ |
| cloud_info | struct | N | Y | N | N/A |
| comment | String | N | N | N | : = ~ |
| creation_time | Timestamp | N | Y | N | N/A |
| creator | String | N | N | N | = |
| ddns_principal | String | N | N | N | : = ~ |
| ddns_protected | Bool | N | N | N | N/A |
| disable | Bool | N | N | N | N/A |
| dns_canonical | String | N | Y | N | N/A |
| dns_name | String | N | Y | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| forbid_reclamation | Bool | N | N | N | N/A |
| last_queried | Timestamp | N | Y | N | N/A |
| name | String | Y | N | Y | : = ~ |
| reclaimable | Bool | N | Y | N | = |
| shared_record_group | String | N | Y | N | N/A |
| ttl | Unsigned int | N | N | N | N/A |
| use_ttl | Bool | N | N | N | N/A |
| view | String | N | N | Y | = |
| zone | String | N | Y | N | = |
record:caa : DNS CAA record object.
