HttpApiDomainConfiguration
Configures a custom domain for an API.
Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
YAML
BasePath:
List
CertificateArn:String
DomainName:String
EndpointConfiguration:String
MutualTlsAuthentication:MutualTlsAuthentication
OwnershipVerificationCertificateArn:String
Route53:Route53Configuration
SecurityPolicy:String
Properties
-
BasePath
-
A list of the basepaths to configure with the Amazon API Gateway domain name.
Type: List
Required: No
Default: /
Amazon CloudFormation compatibility: This property is similar to the
ApiMappingKey
property of anAWS::ApiGatewayV2::ApiMapping
resource. Amazon SAM creates multipleAWS::ApiGatewayV2::ApiMapping
resources, one per value specified in this property. -
CertificateArn
-
The Amazon Resource Name (ARN) of an Amazon managed certificate for this domain name's endpoint. Amazon Certificate Manager is the only supported source.
Type: String
Required: Yes
Amazon CloudFormation compatibility: This property is passed directly to the
CertificateArn
property of anAWS::ApiGateway2::DomainName DomainNameConfiguration
resource. -
DomainName
-
The custom domain name for your API Gateway API. Uppercase letters are not supported.
Amazon SAM generates an
AWS::ApiGatewayV2::DomainName
resource when this property is set. For information about this scenario, see DomainName property is specified. For information about generated Amazon CloudFormation resources, see Generated Amazon CloudFormation resources for Amazon SAM.Type: String
Required: Yes
Amazon CloudFormation compatibility: This property is passed directly to the
DomainName
property of anAWS::ApiGateway2::DomainName
resource. -
EndpointConfiguration
-
Defines the type of API Gateway endpoint to map to the custom domain. The value of this property determines how the
CertificateArn
property is mapped in Amazon CloudFormation.The only valid value for HTTP APIs is
REGIONAL
.Type: String
Required: No
Default:
REGIONAL
Amazon CloudFormation compatibility: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
-
MutualTlsAuthentication
-
The mutual transport layer security (TLS) authentication configuration for a custom domain name.
Type: MutualTlsAuthentication
Required: No
Amazon CloudFormation compatibility: This property is passed directly to the
MutualTlsAuthentication
property of anAWS::ApiGatewayV2::DomainName
resource. -
OwnershipVerificationCertificateArn
-
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Required only when you configure mutual TLS and you specify an ACM imported or private CA certificate ARN for the
CertificateArn
.Type: String
Required: No
Amazon CloudFormation compatibility: This property is passed directly to the
OwnershipVerificationCertificateArn
property of theAWS::ApiGatewayV2::DomainName
DomainNameConfiguration
data type. -
Route53
-
Defines an Amazon Route 53 configuration.
Type: Route53Configuration
Required: No
Amazon CloudFormation compatibility: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
-
SecurityPolicy
-
The TLS version of the security policy for this domain name.
The only valid value for HTTP APIs is
TLS_1_2
.Type: String
Required: No
Amazon CloudFormation compatibility: This property is passed directly to the
SecurityPolicy
property of theAWS::ApiGatewayV2::DomainName
DomainNameConfiguration
data type.
Examples
DomainName
DomainName example
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: REGIONAL Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar