AWS::ApiGatewayV2::DomainName DomainNameConfiguration - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::ApiGatewayV2::DomainName DomainNameConfiguration

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

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

Syntax

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

JSON

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

Properties

CertificateArn

An Amazon-managed certificate that will be used by the edge-optimized endpoint for this domain name. Amazon 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

OwnershipVerificationCertificateArn

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.

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