DomainConfiguration

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
  NormalizeBasePath: Boolean
  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 -BasePathEigenschaft einer -AWS::ApiGateway::BasePathMappingRessource. AWS SAM erstellt mehrere AWS::ApiGateway::BasePathMapping Ressourcen, eine pro BasePath angegeben in dieser Eigenschaft.

NormalizeBasePath

Gibt an, ob nicht alphanumerische Zeichen in Basispfaden zulässig sind, die durch die -BasePathEigenschaft definiert sind. Wenn diese Option auf festgelegt istTrue, werden nicht alphanumerische Zeichen aus Basispfaden entfernt.

Verwenden Sie NormalizeBasePath mit der -BasePathEigenschaft.

Typ: Boolesch

Required: No

Standard: True

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

CertificateArn

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

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der CertificateArn Eigenschaft einer -AWS::ApiGateway::DomainNameRessource. Wenn auf REGIONAL (Standardwert) festgelegt EndpointConfiguration ist, CertificateArn wird RegionalCertificateArn in zugeordnetAWS::ApiGateway::DomainName. Wenn auf festgelegt EndpointConfiguration istEDGE, CertificateArn wird CertificateArn in zugeordnetAWS::ApiGateway::DomainName.

Zusätzliche Hinweise: Für einen EDGE Endpunkt müssen Sie das Zertifikat in der us-east-1 AWS Region erstellen.

DomainName

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

AWS SAM generiert eine -AWS::ApiGateway::DomainNameRessource, wenn diese Eigenschaft festgelegt ist. Weitere Informationen zu diesem Szenario finden Sie unter DomainNameEigenschaft ist angegeben. Informationen zu generierten AWS CloudFormation Ressourcen finden Sie unter Generierte AWS CloudFormation Ressourcen.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -DomainNameEigenschaft einer -AWS::ApiGateway::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.

Zulässige Werte: REGIONAL oder EDGE.

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 gegenseitige TLS-Authentifizierungskonfiguration (Transport Layer Security) 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::ApiGateway::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 einer -AWS::ApiGateway::DomainNameRessource ü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 plus Verschlüsselungssuite für diesen Domänennamen.

Typ: Zeichenfolge

Required: No

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

Beispiele

DomainName

DomainName Beispiel

YAML

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