DomainConfiguration

Konfigurasi yang diperlukan untuk menghasilkan AWS::ApiGateway::DomainNameAccessAssociation sumber daya.

AWS SAM menghasilkan sebuah AWS::ApiGateway::DomainNameAccessAssociationsumber daya saat properti ini disetel. Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihatCloudFormation Sumber daya yang dihasilkan untuk AWS SAM.

Jenis: DomainAccessAssociation

Wajib: Tidak

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

Daftar basepaths untuk mengonfigurasi dengan nama domain Amazon API Gateway.

Tipe: Daftar

Wajib: Tidak

Default:/

CloudFormation kompatibilitas: Properti ini mirip dengan BasePath properti AWS::ApiGateway::BasePathMapping sumber daya. AWS SAM menciptakan beberapa AWS::ApiGateway::BasePathMapping sumber daya, satu per BasePath ditentukan dalam properti ini.

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

Tipe: String

Wajib: Ya

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

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

Nama domain khusus untuk API dari API Gateway Anda. Tidak didukung huruf besar.

AWS SAM menghasilkan sebuah AWS::ApiGateway::DomainNamesumber daya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat DomainNameproperti ditentukan. Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihatCloudFormation Sumber daya yang dihasilkan untuk AWS SAM.

Tipe: String

Wajib: Ya

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke DomainName properti AWS::ApiGateway::DomainName sumber daya, atau AWS::ApiGateway::DomainNameV2kapan EndpointConfiguration disetel kePRIVATE.

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

Nilai yang valid: EDGE, REGIONAL, atau PRIVATE

Tipe: String

Wajib: Tidak

Default: REGIONAL

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

Konfigurasi autentikasi Keamanan Lapisan Pengangkutan (TLS) yang saling terkait untuk nama domain kustom.

Jenis: MutualTlsAuthentication

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke MutualTlsAuthentication properti AWS::ApiGateway::DomainName sumber daya.

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

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

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

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke OwnershipVerificationCertificateArn properti AWS::ApiGateway::DomainName sumber daya.

Kebijakan IAM untuk melampirkan ke nama domain API Gateway. Hanya berlaku bila EndpointConfiguration disetel kePRIVATE.

Jenis: Json

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Policy properti AWS::ApiGateway::DomainNameV2 sumber daya saat EndpointConfiguration disetel kePRIVATE. Untuk contoh dokumen kebijakan yang valid, lihat AWS::ApiGateway::DomainNameV2.

Menentukan konfigurasi Amazon Route 53.

Tipe:Route53Configuration

Wajib: Tidak

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

Versi TLS ditambah paket sandi untuk nama domain ini.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke SecurityPolicy properti AWS::ApiGateway::DomainName sumber daya, atau AWS::ApiGateway::DomainNameV2kapan EndpointConfiguration disetel kePRIVATE. Untuk PRIVATE titik akhir, hanya TLS_1_2 yang didukung.