Route53Configuration - AWS Serverless Application Model
SintaksisPropertiContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Route53Configuration

Mengonfigurasi set catatan Route53 untuk API.

Sintaksis

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

Properti

DistributionDomainName

Mengonfigurasi distribusi kustom nama domain kustom API.

Tipe: String

Wajib: Tidak

Default: Gunakan distribusi API Gateway.

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke DNSName properti AWS::Route53::RecordSetGroup AliasTarget sumber daya.

Catatan tambahan: Nama domain CloudFrontdistribusi.

EvaluateTargetHealth

Kapan EvaluateTargetHealth benar, catatan alias mewarisi kesehatan AWS sumber daya yang direferensikan, seperti penyeimbang beban Elastic Load Balancing atau catatan lain di zona yang dihosting.

Tipe: Boolean

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke EvaluateTargetHealth properti AWS::Route53::RecordSetGroup AliasTarget sumber daya.

Catatan tambahan: Anda tidak dapat mengatur EvaluateTargetHealth ke true ketika target alias adalah CloudFront distribusi.

HostedZoneId

ID zona yang di-hosting tempat Anda ingin membuat catatan.

Tentukan HostedZoneName atau HostedZoneId, tapi tidak keduanya. Jika Anda memiliki beberapa zona yang di-hosting dengan nama domain yang sama, Anda harus menentukan zona yang di-hosting menggunakan HostedZoneId.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke HostedZoneId properti AWS::Route53::RecordSetGroup RecordSet sumber daya.

HostedZoneName

Nama zona yang di-hosting tempat ingin Anda membuat catatan.

Tentukan HostedZoneName atau HostedZoneId, jangan keduanya. Jika Anda memiliki beberapa zona yang di-hosting dengan nama domain yang sama, Anda harus menentukan zona yang di-hosting menggunakan HostedZoneId.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke HostedZoneName properti AWS::Route53::RecordSetGroup RecordSet sumber daya.

IpV6

Saat properti ini disetel, AWS SAM buat AWS::Route53::RecordSet sumber daya dan set Type AAAA untuk yang disediakan HostedZone.

Tipe: Boolean

Wajib: Tidak

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

Region

Hanya set catatan sumber daya berbasis latensi: EC2 Wilayah Amazon tempat Anda membuat sumber daya yang dirujuk oleh kumpulan catatan sumber daya ini. Sumber daya biasanya adalah AWS sumber daya, seperti EC2 instance atau penyeimbang beban ELB, dan disebut dengan alamat IP atau nama domain DNS, tergantung pada jenis catatan.

Saat Amazon Route 53 menerima kueri DNS untuk nama domain dan jenis yang telah Anda buat set catatan sumber daya latensi, Route 53 memilih kumpulan catatan sumber daya latensi yang memiliki latensi terendah antara pengguna akhir dan Wilayah Amazon terkait. EC2 Route 53 kemudian mengembalikan nilai yang terkait dengan set catatan sumber daya yang dipilih.

Perhatikan hal berikut:

  • Anda hanya dapat menentukan satu ResourceRecord per set catatan sumber daya latensi.

  • Anda hanya dapat membuat satu set catatan sumber daya latensi untuk setiap EC2 Wilayah Amazon.

  • Anda tidak diharuskan membuat kumpulan rekaman sumber daya latensi untuk semua EC2 Wilayah Amazon. Route 53 akan memilih wilayah dengan latensi terbaik dari antara wilayah yang Anda buat set catatan sumber daya latensi.

  • Anda tidak dapat membuat set catatan sumber daya non-latensi yang memiliki nilai yang sama untuk elemen Name dan Type sebagai set catatan sumber daya latensi.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Region properti tipe AWS::Route53::RecordSetGroup RecordSet data.

SetIdentifier

Set catatan sumber daya yang memiliki kebijakan perutean selain sederhana: Pengenal yang membedakan antara beberapa set catatan sumber daya yang memiliki kombinasi nama dan jenis yang sama, seperti beberapa set catatan sumber daya tertimbang bernama acme.example.com yang memiliki tipe A. Dalam grup set catatan sumber daya yang memiliki nama dan tipe yang sama, nilai SetIdentifier harus unik untuk setiap set catatan sumber daya.

Untuk informasi tentang kebijakan perutean, lihat Memilih kebijakan perutean di Panduan Pengembang Amazon Route 53.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke SetIdentifier properti tipe AWS::Route53::RecordSetGroup RecordSet data.

VpcEndpointDomainName

Nama DNS dari titik akhir antarmuka VPC yang terkait dengan layanan VPC API Gateway. Properti ini hanya diperlukan untuk domain pribadi.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke DNSName properti AWS::Route53::RecordSet AliasTarget bidang.

VpcEndpointHostedZoneId

ID zona yang dihosting dari titik akhir antarmuka VPC yang terkait dengan layanan VPC API Gateway. Properti ini hanya diperlukan untuk domain pribadi.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke HostedZoneId properti AWS::Route53::RecordSet AliasTarget bidang.

Contoh

Contoh basic

Dalam contoh ini, kami mengonfigurasi domain kustom dan set rekaman Route 53 untuk API kami.

YAML

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Domain:
        DomainName: www.example.com
        CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/abcdef12-3456-7890-abcd-ef1234567890
        EndpointConfiguration: REGIONAL
        Route53:
          HostedZoneId: ABCDEFGHIJKLMNOP