Skip to content
AWS for Query.Farm

aws.apigatewayv2.get_domain_name

Example SQL Queries

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

Description

Gets a domain name.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The name of the DomainName resource.

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.

api_mapping_selection_expression

The API mapping selection expression.

VARCHAR
domain_name_configurations

The domain name configurations.

STRUCT(
    "api_gateway_domain_name" VARCHAR,
    "certificate_arn" VARCHAR,
    "certificate_name" VARCHAR,
    "certificate_upload_date" TIMESTAMP_S,
    "domain_name_status" VARCHAR,
    "domain_name_status_message" VARCHAR,
    "endpoint_type" VARCHAR,
    "hosted_zone_id" VARCHAR,
    "security_policy" VARCHAR,
    "ownership_verification_certificate_arn" VARCHAR
)[]
Show child fields
domain_name_configurations[]
Show child fields
domain_name_configurations[].api_gateway_domain_name

A domain name for the API.

domain_name_configurations[].certificate_arn

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

domain_name_configurations[].certificate_name

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

domain_name_configurations[].certificate_upload_date

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

domain_name_configurations[].domain_name_status

The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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.

domain_name_configurations[].domain_name_status_message

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

domain_name_configurations[].endpoint_type

The endpoint type.

domain_name_configurations[].hosted_zone_id

The Amazon Route 53 Hosted Zone ID of the endpoint.

domain_name_configurations[].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

domain_name_configurations[].security_policy

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

mutual_tls_authentication

The mutual TLS authentication configuration for a custom domain name.

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[]
tags

The collection of tags associated with a domain name.

MAP(VARCHAR, VARCHAR)