AWS::ApiGatewayV2::DomainName DomainNameConfiguration - AWS CloudFormation
SyntaxPropertiesSee also

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApiGatewayV2::DomainName DomainNameConfiguration

The DomainNameConfiguration property type specifies the configuration for an API's domain name.

DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CertificateArn" : String,
  "CertificateName" : String,
  "EndpointType" : String,
  "IpAddressType" : String,
  "OwnershipVerificationCertificateArn" : String,
  "SecurityPolicy" : String
}

Properties

CertificateArn

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.

Required: No

Type: String

Update requires: No interruption

CertificateName

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

Required: No

Type: String

Update requires: No interruption

EndpointType

The endpoint type.

Required: No

Type: String

Update requires: No interruption

IpAddressType

The IP address types that can invoke the domain name. Use ipv4 to allow only IPv4 addresses to invoke your domain name, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your domain name.

Required: No

Type: String

Update requires: No interruption

OwnershipVerificationCertificateArn

The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager. 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.

Required: No

Type: String

Update requires: No interruption

SecurityPolicy

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.

Required: No

Type: String

Update requires: No interruption

See also