Skip to content

aws.lightsail.get_domain

Example SQL Queries

SELECT * FROM
aws.lightsail.get_domain
WHERE
"domain_name" = 'VALUE';

Description

Returns information about a specific domain recordset.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The domain name for which your want to return information about.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
domain

An array of key-value pairs containing information about your get domain request.

STRUCT(
"name" VARCHAR,
"arn" VARCHAR,
"support_code" VARCHAR,
"created_at" TIMESTAMP_S,
"location" STRUCT(
"availability_zone" VARCHAR,
"region_name" VARCHAR
),
"resource_type" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"domain_entries" STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"target" VARCHAR,
"is_alias" BOOLEAN,
"type" VARCHAR,
"options" MAP(VARCHAR, VARCHAR)
)[],
"registered_domain_delegation_info" STRUCT(
"name_servers_update_state" STRUCT(
"code" VARCHAR,
"message" VARCHAR
),
"r53_hosted_zone_deletion_state" STRUCT(
"code" VARCHAR,
"message" VARCHAR
)
)
)
Show child fields
domain.arn

The Amazon Resource Name (ARN) of the domain recordset (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

domain.created_at

The date when the domain recordset was created.

domain.domain_entries[]
Show child fields
domain.domain_entries[].id

The ID of the domain recordset entry.

domain.domain_entries[].is_alias

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 Amazon Web Services 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 Amazon Web Services resource and routes traffic to that resource.

domain.domain_entries[].name

The name of the domain.

domain.domain_entries[].options

(Discontinued) The options for the domain entry.

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

domain.domain_entries[].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.

domain.domain_entries[].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

domain.location

The AWS Region and Availability Zones where the domain recordset was created.

Show child fields
domain.location.availability_zone

The Availability Zone. Follows the format us-east-2a (case-sensitive).

domain.location.region_name

The Amazon Web Services Region name.

domain.name

The name of the domain.

domain.registered_domain_delegation_info

An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone.

Show child fields
domain.registered_domain_delegation_info.name_servers_update_state

An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail.

Show child fields
domain.registered_domain_delegation_info.name_servers_update_state.code

The status code for the name servers update.

Following are the possible values:

  • SUCCEEDED - The name server records were successfully updated.

  • PENDING - The name server record update is in progress.

  • FAILED - The name server record update failed.

  • STARTED - The automatic name server record update started.

domain.registered_domain_delegation_info.name_servers_update_state.message

The message that describes the reason for the status code.

domain.registered_domain_delegation_info.r53_hosted_zone_deletion_state

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

Show child fields
domain.registered_domain_delegation_info.r53_hosted_zone_deletion_state.code

The status code for the deletion state.

Following are the possible values:

  • SUCCEEDED - The hosted zone was successfully deleted.

  • PENDING - The hosted zone deletion is in progress.

  • FAILED - The hosted zone deletion failed.

  • STARTED - The hosted zone deletion started.

domain.registered_domain_delegation_info.r53_hosted_zone_deletion_state.message

The message that describes the reason for the status code.

domain.resource_type

The resource type.

domain.support_code

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

domain.tags[]
Show child fields
domain.tags[].key

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@

domain.tags[].value

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ :/@