Skip to content

aws.apprunner.describe_custom_domains

Example SQL Queries

SELECT * FROM
aws.apprunner.describe_custom_domains
WHERE
"service_arn" = 'VALUE';

Description

Return a description of custom domain names that are associated with an App Runner service.

Table Definition

Column NameColumn Data Type
service_arn Required Input Column

The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

VARCHAR
max_results Input Column

The maximum number of results that each response (result page) can include. It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

BIGINT
next_token Input Column

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

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
custom_domains

A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.

STRUCT(
"domain_name" VARCHAR,
"enable_www_subdomain" BOOLEAN,
"certificate_validation_records" STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"value" VARCHAR,
"status" VARCHAR
)[],
"status" VARCHAR
)[]
Show child fields
custom_domains[]
Show child fields
custom_domains[].certificate_validation_records[]
Show child fields
custom_domains[].certificate_validation_records[].name

The certificate CNAME record name.

custom_domains[].certificate_validation_records[].status

The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

custom_domains[].certificate_validation_records[].type

The record type, always CNAME.

custom_domains[].certificate_validation_records[].value

The certificate CNAME record value.

custom_domains[].domain_name

An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

custom_domains[].enable_www_subdomain

When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

custom_domains[].status

The current state of the domain name association.

dns_target

The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

VARCHAR
vpc_dns_targets

DNS Target records for the custom domains of this Amazon VPC.

STRUCT(
"vpc_ingress_connection_arn" VARCHAR,
"vpc_id" VARCHAR,
"domain_name" VARCHAR
)[]
Show child fields
vpc_dns_targets[]
Show child fields
vpc_dns_targets[].domain_name

The domain name of your target DNS that is associated with the Amazon VPC.

vpc_dns_targets[].vpc_id

The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

vpc_dns_targets[].vpc_ingress_connection_arn

The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.