DomainConfiguration

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
  NormalizeBasePath: Boolean
  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 BasePath dari sumber daya AWS::ApiGateway::BasePathMapping. AWS SAM membuat beberapa sumber daya AWS::ApiGateway::BasePathMapping, satu per BasePath ditentukan dalam properti ini.

NormalizeBasePath

Menunjukkan apakah karakter non-alfanumerik diizinkan dalam basepaths yang ditentukan oleh properti. BasePath Ketika diatur keTrue, karakter non-alfanumerik dihapus dari basepaths.

Gunakan NormalizeBasePath dengan BasePath properti.

Tipe: Boolean

Wajib: Tidak

Default: BETUL

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

CertificateArn

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

Tipe: String

Wajib: Ya

Kompatibilitas AWS CloudFormation: Properti ini mirip dengan properti CertificateArn dari sumber daya AWS::ApiGateway::DomainName. Jika EndpointConfiguration diatur ke REGIONAL (nilai default), CertificateArn peta ke RegionalCertificateArninAWS::ApiGateway::DomainName. Jika EndpointConfiguration diatur keEDGE, CertificateArn petakan ke CertificateArninAWS::ApiGateway::DomainName.

Catatan tambahan: Untuk titik akhir EDGE, Anda harus membuat sertifikat di Wilayah us-east-1 AWS.

DomainName

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

AWS SAM membuat sumber daya AWS::ApiGateway::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::ApiGateway::DomainName.

EndpointConfiguration

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

Nilai yang valid: REGIONAL atau EDGE

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) yang saling terkait untuk nama domain kustom.

Jenis: MutualTlsAuthentication

Wajib: Tidak

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti MutualTlsAuthentication dari sumber daya AWS::ApiGateway::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 sumber daya AWS::ApiGateway::DomainName.

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 ditambah paket sandi untuk nama domain ini.

Tipe: String

Wajib: Tidak

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

Contoh-contoh

DomainName

DomainName contoh

YAML

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