AWS::ApiGatewayV2::DomainName DomainNameConfiguration - Amazon CloudFormation
SyntaxPropertiesSee also
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 (PDF).

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