record:alias : DNS Alias record object.

Alias resource record allows you to create typed aliases for standard DNS resource records which are resolved dynamically by an authoritative server. Unlike CNAME Alias can be created in the zone apex.

Object Reference

References to record:alias are object references. The name part of a DNS Alias object reference has the following components:

  • Name of the record
  • Name of the view

Example: record:alias/ZG5zLmJpbmRfY25h:some.name.com/myview

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): name, target_name, target_type, view.

The following fields are required to create this object:

Field Notes
name  
target_name  
target_type  

aws_rte53_record_info

aws_rte53_record_info

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.

cloud_info

cloud_info

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

comment

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

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

creator

creator

The record creator.

Type

String.

Valid values are:
  • STATIC

Create

The default value is STATIC.

Search

The field is not available for search.

disable

disable

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.

dns_name

dns_name

The name for an Alias 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.

dns_target_name

dns_target_name

Target 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_target_name cannot be updated.

dns_target_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.

last_queried

last_queried

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.

name

name

The name for an Alias 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

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

target_name

target_name

Target 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 target_name is part of the base object.

target_type

target_type

Target type.

Type

String.

Valid values are:
  • A
  • AAAA
  • MX
  • NAPTR
  • PTR
  • SPF
  • SRV
  • TXT

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The target_type is part of the base object.

ttl

ttl

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

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.

view

view

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

  • ‘=’ (exact equality)

Notes

The view is part of the base object.

zone

zone

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

  • ‘=’ (exact equality)

Notes

The zone cannot be updated.

zone cannot be written.

Fields List

Field Type Req R/O Base Search
aws_rte53_record_info struct N Y N N/A
cloud_info struct N Y N N/A
comment String N N N : = ~
creator String N N N N/A
disable Bool N N N N/A
dns_name String N Y N N/A
dns_target_name String N Y N N/A
extattrs Extattr N N N ext
last_queried Timestamp N Y N N/A
name String Y N Y : = ~
target_name String Y N Y : = ~
target_type String Y N Y =
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 =