The 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 in the API Gateway Developer Guide.
domain_name
(String) The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.domain_name_configurations
(Attributes List) The domain name configurations. (see below for nested schema)mutual_tls_authentication
(Attributes) The mutual TLS authentication configuration for a custom domain name. (see below for nested schema)tags
(Map of String) The collection of tags associated with a domain name.id
(String) Uniquely identifies the resource.regional_domain_name
(String)regional_hosted_zone_id
(String)domain_name_configurations
Optional:
certificate_arn
(String) 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.certificate_name
(String) The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.endpoint_type
(String) The endpoint type.ownership_verification_certificate_arn
(String) The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.security_policy
(String) 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
Optional:
truststore_uri
(String) 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.truststore_version
(String) The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.Import is supported using the following syntax:
$ terraform import awscc_apigatewayv2_domain_name.example <resource ID>