HttpApiDomainConfiguration

Mengonfigurasi domain kustom untuk API.

Sintaks

Untuk mendeklarasikan entitas ini di templat AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

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

Properti

BasePath

Daftar basepaths untuk mengonfigurasi dengan nama domain Amazon API Gateway.

Tipe: Daftar

Wajib: Tidak

Default:/

Kompatibilitas AWS CloudFormation: Properti ini mirip dengan properti ApiMappingKey dari sumber daya AWS::ApiGatewayV2::ApiMapping. AWS SAM membuat beberapa sumber daya AWS::ApiGatewayV2::ApiMapping, satu per nilai yang ditentukan dalam properti ini.

CertificateArn

Amazon Resource Name (ARN) dari sertifikat terkelola AWS untuk titik akhir nama domain ini. AWS Certificate Manager adalah satu-satunya sumber yang didukung.

Tipe: String

Wajib: Ya

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti CertificateArn dari sumber daya AWS::ApiGateway2::DomainName DomainNameConfiguration.

DomainName

Nama domain khusus untuk API dari API Gateway Anda. Huruf besar tidak didukung.

AWS SAM membuat sumber daya AWS::ApiGatewayV2::DomainName ketika properti ini diatur. Untuk informasi selengkapnya tentang skenario ini, lihat DomainNameproperti ditentukan. Untuk informasi tentang sumber daya AWS CloudFormation yang dibuat, lihat AWS CloudFormation Sumber daya yang dihasilkan.

Tipe: String

Wajib: Ya

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti DomainName dari sumber daya AWS::ApiGateway2::DomainName.

EndpointConfiguration

Menentukan tipe titik akhir API Gateway untuk memetakan ke domain kustom. Nilai properti ini menentukan bagaimana properti CertificateArn dipetakan di AWS CloudFormation.

Satu-satunya nilai valid untuk API HTTP adalah REGIONAL.

Tipe: String

Wajib: Tidak

Default: REGIONAL

Kompatibilitas AWS CloudFormation: Properti ini unik bagi AWS SAM dan tidak memiliki padananAWS CloudFormation.

MutualTlsAuthentication

Konfigurasi autentikasi Keamanan Lapisan Pengangkutan (TLS) bersama untuk nama domain kustom.

Jenis: MutualTlsAuthentication

Wajib: Tidak

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti MutualTlsAuthentication dari sumber daya AWS::ApiGatewayV2::DomainName.

OwnershipVerificationCertificateArn

ARN sertifikat publik yang dikeluarkan oleh ACM untuk memvalidasi kepemilikan domain kustom Anda. Diperlukan hanya ketika Anda mengonfigurasi TLS timbal balik dan Anda menentukan ARN sertifikat CA yang diimpor atau pribadi ACM untuk ARN. CertificateArn

Tipe: String

Wajib: Tidak

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti OwnershipVerificationCertificateArn dari tipe data AWS::ApiGatewayV2::DomainName DomainNameConfiguration.

Route53

Menentukan konfigurasi Amazon Route 53.

Tipe: Route53Configuration

Wajib: Tidak

Kompatibilitas AWS CloudFormation: Properti ini unik bagi AWS SAM dan tidak memiliki padananAWS CloudFormation.

SecurityPolicy

Versi TLS kebijakan keamanan untuk nama domain ini.

Satu-satunya nilai valid untuk API HTTP adalah TLS_1_2.

Tipe: String

Wajib: Tidak

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti SecurityPolicy dari tipe data AWS::ApiGatewayV2::DomainName DomainNameConfiguration.

Contoh-contoh

DomainName

DomainName contoh

YAML

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