Skip to content
AWS for Query.Farm

aws.apigateway.get_domain_name

Example SQL Queries

SELECT * FROM
aws.apigateway.get_domain_name
WHERE
"domain_name" = 'VALUE';

Description

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The custom domain name as an API host name, for example, my-api.example.com.

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
certificate_arn

The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.

VARCHAR
certificate_name

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

VARCHAR
certificate_upload_date

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

TIMESTAMP_S
distribution_domain_name

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

VARCHAR
distribution_hosted_zone_id

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway. 

VARCHAR
domain_name_status

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

VARCHAR
domain_name_status_message

An optional text message containing detailed information about status of the DomainName migration.

VARCHAR
endpoint_configuration

The endpoint configuration of this DomainName showing the endpoint types of the domain name. 

STRUCT(
    "types" VARCHAR[],
    "vpc_endpoint_ids" VARCHAR[]
)
Show child fields
endpoint_configuration.types[]
endpoint_configuration.vpc_endpoint_ids[]
mutual_tls_authentication

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

STRUCT(
    "truststore_uri" VARCHAR,
    "truststore_version" VARCHAR,
    "truststore_warnings" VARCHAR[]
)
Show child fields
mutual_tls_authentication.truststore_uri

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

mutual_tls_authentication.truststore_version

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

mutual_tls_authentication.truststore_warnings[]
ownership_verification_certificate_arn

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

VARCHAR
regional_certificate_arn

The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.

VARCHAR
regional_certificate_name

The name of the certificate that will be used for validating the regional domain name.

VARCHAR
regional_domain_name

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

VARCHAR
regional_hosted_zone_id

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway. 

VARCHAR
security_policy

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

VARCHAR
tags

The collection of tags. Each tag element is associated with a given resource.

MAP(VARCHAR, VARCHAR)