Skip to main content

domain_names_list_only

Lists domain_names in a region or regions, for all properties use domain_names

Overview

Namedomain_names_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.domain_names_list_only

Fields

NameDatatypeDescription
mutual_tls_authenticationobjectThe mutual TLS authentication configuration for a custom domain name.
regional_hosted_zone_idstring
regional_domain_namestring
domain_namestringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
domain_name_configurationsarrayThe domain name configurations.
tagsobjectThe collection of tags associated with a domain name.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all domain_names in a region.

SELECT
region,
domain_name
FROM aws.apigatewayv2.domain_names_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the domain_names_list_only resource, see domain_names