DomainEntry - Amazon Lightsail

DomainEntry

Describes a domain recordset entry.

Contents

id

The ID of the domain recordset entry.

Type: String

Pattern: .*\S.*

Required: No

isAlias

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource.

Type: Boolean

Required: No

name

The name of the domain.

Type: String

Required: No

options

This member has been deprecated.

(Discontinued) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now discontinued.

Type: String to string map

Required: No

target

The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

Type: String

Required: No

type

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A

  • AAAA

  • CNAME

  • MX

  • NS

  • SOA

  • SRV

  • TXT

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: