Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
DomainConfiguration
Mengkonfigurasi domain kustom untuk fileAPI.
Sintaks
Untuk mendeklarasikan entitas ini dalam template 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 dikonfigurasi dengan nama domain Amazon API Gateway.
Tipe: Daftar
Wajib: Tidak
Default:/
AWS CloudFormation kompatibilitas: Properti ini mirip dengan
BasePath
propertiAWS::ApiGateway::BasePathMapping
sumber daya. AWS SAM menciptakan beberapaAWS::ApiGateway::BasePathMapping
sumber daya, satu perBasePath
ditentukan dalam properti ini. -
NormalizeBasePath
-
Menunjukkan apakah karakter non-alfanumerik diperbolehkan dalam basepaths yang ditentukan oleh properti.
BasePath
Ketika diatur keTrue
, karakter non-alfanumerik dihapus dari basepaths.Gunakan
NormalizeBasePath
denganBasePath
properti.Tipe: Boolean
Wajib: Tidak
Default: BETUL
AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.
-
CertificateArn
-
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
AWS CloudFormation kompatibilitas: Properti ini mirip dengan
CertificateArn
propertiAWS::ApiGateway::DomainName
sumber daya. JikaEndpointConfiguration
diatur keREGIONAL
(nilai default),CertificateArn
peta ke RegionalCertificateArninAWS::ApiGateway::DomainName
. JikaEndpointConfiguration
diatur keEDGE
,CertificateArn
petakan ke CertificateArninAWS::ApiGateway::DomainName
.Catatan tambahan: Untuk
EDGE
titik akhir, Anda harus membuat sertifikat dius-east-1
AWS Wilayah. -
DomainName
-
Nama domain khusus untuk API Gateway AndaAPI. Huruf kapital tidak didukung.
AWS SAM menghasilkan sumber AWS::ApiGateway::DomainNamedaya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat DomainNameproperti ditentukan. Untuk informasi tentang AWS CloudFormation sumber daya yang dihasilkan, lihatAWS CloudFormation Sumber daya yang dihasilkan untuk AWS SAM.
Tipe: String
Wajib: Ya
AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke
DomainName
propertiAWS::ApiGateway::DomainName
sumber daya. -
EndpointConfiguration
-
Mendefinisikan jenis titik akhir API Gateway untuk dipetakan ke domain kustom. Nilai properti ini menentukan bagaimana
CertificateArn
properti dipetakan. AWS CloudFormationNilai yang valid:
REGIONAL
atauEDGE
Tipe: String
Wajib: Tidak
Default:
REGIONAL
AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.
-
MutualTlsAuthentication
-
Konfigurasi autentikasi mutual Transport Layer Security (TLS) untuk nama domain kustom.
Jenis: MutualTlsAuthentication
Wajib: Tidak
AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke
MutualTlsAuthentication
propertiAWS::ApiGateway::DomainName
sumber daya. -
OwnershipVerificationCertificateArn
-
Sertifikat publik yang dikeluarkan oleh ACM untuk memvalidasi kepemilikan domain kustom Anda. ARN Diperlukan hanya ketika Anda mengonfigurasi timbal balik TLS dan Anda menentukan sertifikat CA yang ACM diimpor atau pribadi ARN untuk
CertificateArn
.Tipe: String
Wajib: Tidak
AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke
OwnershipVerificationCertificateArn
propertiAWS::ApiGateway::DomainName
sumber daya. -
Route53
-
Menentukan konfigurasi Amazon Route 53.
Tipe:Route53Configuration
Wajib: Tidak
AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.
-
SecurityPolicy
-
TLSVersi plus cipher suite untuk nama domain ini.
Tipe: String
Wajib: Tidak
AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke
SecurityPolicy
propertiAWS::ApiGateway::DomainName
sumber daya.
Contoh
DomainName
DomainName contoh
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: EDGE Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar