HttpApiDomainConfiguration

Konfiguriert eine benutzerdefinierte Domain für eine API.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM)-Vorlage zu deklarieren.

YAML

  BasePath: List
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  MutualTlsAuthentication: MutualTlsAuthentication
  OwnershipVerificationCertificateArn: String
  Route53: Route53Configuration
  SecurityPolicy: String

Eigenschaften

BasePath

Eine Liste der Basispfade, die mit dem Amazon API Gateway-Domänennamen konfiguriert werden sollen.

Typ : Liste

Required: No

Standard: /

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der -ApiMappingKeyEigenschaft einer -AWS::ApiGatewayV2::ApiMappingRessource. AWS SAM erstellt mehrere AWS::ApiGatewayV2::ApiMapping Ressourcen, eine pro Wert, der in dieser Eigenschaft angegeben ist.

CertificateArn

Der Amazon-Ressourcenname (ARN) eines von AWS verwalteten Zertifikats für den Endpunkt dieses Domänennamens. AWS Certificate Manager ist die einzige unterstützte Quelle.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -CertificateArnEigenschaft einer -AWS::ApiGateway2::DomainName DomainNameConfigurationRessource übergeben.

DomainName

Der benutzerdefinierte Domänenname für Ihre API Gateway-API. Großbuchstaben werden nicht unterstützt.

AWS SAM generiert eine -AWS::ApiGatewayV2::DomainNameRessource, wenn diese Eigenschaft festgelegt ist. Weitere Informationen zu diesem Szenario finden Sie unter DomainNameEigenschaft ist spezifiziert. Informationen zu generierten AWS CloudFormation Ressourcen finden Sie unter Generierte AWS CloudFormation Ressourcen für AWS SAM.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -DomainNameEigenschaft einer -AWS::ApiGateway2::DomainNameRessource übergeben.

EndpointConfiguration

Definiert den Typ des API Gateway-Endpunkts, der der benutzerdefinierten Domain zugeordnet werden soll. Der Wert dieser Eigenschaft bestimmt, wie die CertificateArn Eigenschaft in zugeordnet wirdAWS CloudFormation.

Der einzige gültige Wert für HTTP-APIs ist REGIONAL.

Typ: Zeichenfolge

Required: No

Standardwert: REGIONAL

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist eindeutig für AWS SAM und hat kein AWS CloudFormationÄquivalent.

MutualTlsAuthentication

Die Konfiguration der gegenseitigen Transportschicht-Sicherheitsauthentifizierung (TLS) für einen benutzerdefinierten Domänennamen.

Geben Sie ein: MutualTlsAuthentication

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -MutualTlsAuthenticationEigenschaft einer -AWS::ApiGatewayV2::DomainNameRessource übergeben.

OwnershipVerificationCertificateArn

Die ARN des öffentlichen Zertifikats, das von ACM ausgestellt wurde, um den Besitz Ihrer benutzerdefinierten Domain zu überprüfen. Nur erforderlich, wenn Sie gegenseitige TLS konfigurieren und einen ARN für ein importiertes oder privates CA-Zertifikat für die angebenCertificateArn.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -OwnershipVerificationCertificateArnEigenschaft des -AWS::ApiGatewayV2::DomainNameDomainNameConfigurationDatentyps übergeben.

Route53

Definiert eine Amazon Route 53-Konfiguration.

Typ : Route53Configuration

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist eindeutig für AWS SAM und hat kein AWS CloudFormationÄquivalent.

SecurityPolicy

Die TLS-Version der Sicherheitsrichtlinie für diesen Domänennamen.

Der einzige gültige Wert für HTTP-APIs ist TLS_1_2.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die SecurityPolicy Eigenschaft des AWS::ApiGatewayV2::DomainName DomainNameConfiguration Datentyps übergeben.

Beispiele

DomainName

DomainName Beispiel

YAML

Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar