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

# DomainConfiguration
<a name="sam-property-api-domainconfiguration"></a>

Mengonfigurasi domain kustom untuk API.

## Sintaksis
<a name="sam-property-api-domainconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-api-domainconfiguration-syntax.yaml"></a>

```
  [AccessAssociation](#sam-api-domainconfiguration-domainaccessassociation): DomainAccessAssociation
  [BasePath](#sam-api-domainconfiguration-basepath): List
  [CertificateArn](#sam-api-domainconfiguration-certificatearn): String
  [DomainName](#sam-api-domainconfiguration-domainname): String
  [EndpointConfiguration](#sam-api-domainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-api-domainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)
  [NormalizeBasePath](#sam-api-domainconfiguration-normalizebasepath): Boolean
  [OwnershipVerificationCertificateArn](#sam-api-domainconfiguration-ownershipverificationcertificatearn): String
  [Policy: ](#sam-api-domainconfiguration-policy)Json
  [Route53](#sam-api-domainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-api-domainconfiguration-securitypolicy): String
```

## Sifat-sifat
<a name="sam-property-api-domainconfiguration-properties"></a>

 `AccessAssociation`   <a name="sam-api-domainconfiguration-domainaccessassociation"></a>
Konfigurasi yang diperlukan untuk menghasilkan ` AWS::ApiGateway::DomainNameAccessAssociation` sumber daya.  
AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html)daya saat properti ini disetel. Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Jenis*: [DomainAccessAssociation](sam-property-api-domainaccessassociation.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `BasePath`   <a name="sam-api-domainconfiguration-basepath"></a>
Daftar basepaths untuk mengonfigurasi dengan nama domain Amazon API Gateway.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*:/  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` properti `AWS::ApiGateway::BasePathMapping` sumber daya. AWS SAM menciptakan beberapa `AWS::ApiGateway::BasePathMapping` sumber daya, satu per `BasePath` ditentukan dalam properti ini.

 `CertificateArn`   <a name="sam-api-domainconfiguration-certificatearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)` properti `AWS::ApiGateway::DomainName` sumber daya. Jika `EndpointConfiguration` diatur ke `REGIONAL` (nilai default), `CertificateArn` peta ke [RegionalCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn)in`AWS::ApiGateway::DomainName`. Jika `EndpointConfiguration` diatur ke`EDGE`, `CertificateArn` petakan ke [CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)in`AWS::ApiGateway::DomainName`. Jika `EndpointConfiguration` disetel ke`PRIVATE`, properti ini diteruskan ke sumber daya [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2).  
*Catatan tambahan*: Untuk `EDGE` titik akhir, Anda harus membuat sertifikat di `us-east-1` AWS Wilayah.

 `DomainName`   <a name="sam-api-domainconfiguration-domainname"></a>
Nama domain khusus untuk API dari API Gateway Anda. Tidak didukung huruf besar.  
AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html)daya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat [DomainName properti ditentukan](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-domain-name). Untuk informasi tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname)` properti `AWS::ApiGateway::DomainName` sumber daya, atau [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)kapan EndpointConfiguration disetel ke`PRIVATE`.

 `EndpointConfiguration`   <a name="sam-api-domainconfiguration-endpointconfiguration"></a>
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.

 `MutualTlsAuthentication`   <a name="sam-api-domainconfiguration-mutualtlsauthentication"></a>
Konfigurasi autentikasi Keamanan Lapisan Pengangkutan (TLS) yang saling terkait untuk nama domain kustom.  
*Jenis*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)` properti `AWS::ApiGateway::DomainName` sumber daya.

 `NormalizeBasePath`   <a name="sam-api-domainconfiguration-normalizebasepath"></a>
Menunjukkan apakah karakter non-alfanumerik diizinkan dalam basepaths yang ditentukan oleh properti. `BasePath` Ketika diatur ke`True`, 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.

 `OwnershipVerificationCertificateArn`   <a name="sam-api-domainconfiguration-ownershipverificationcertificatearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn)` properti `AWS::ApiGateway::DomainName` sumber daya.

 `Policy`   <a name="sam-api-domainconfiguration-policy"></a>
Kebijakan IAM untuk melampirkan ke nama domain API Gateway. Hanya berlaku bila `EndpointConfiguration` disetel ke`PRIVATE`.  
*Jenis*: Json  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `Policy` properti `AWS::ApiGateway::DomainNameV2` sumber daya saat `EndpointConfiguration` disetel ke`PRIVATE`. Untuk contoh dokumen kebijakan yang valid, lihat [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2).

 `Route53`   <a name="sam-api-domainconfiguration-route53"></a>
Menentukan konfigurasi Amazon Route 53.  
*Tipe*:[Route53Configuration](sam-property-api-route53configuration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SecurityPolicy`   <a name="sam-api-domainconfiguration-securitypolicy"></a>
Versi TLS ditambah paket sandi untuk nama domain ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy)` properti `AWS::ApiGateway::DomainName` sumber daya, atau [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)kapan `EndpointConfiguration` disetel ke`PRIVATE`. Untuk `PRIVATE` titik akhir, hanya TLS\$11\$12 yang didukung.

## Contoh
<a name="sam-property-api-domainconfiguration--examples"></a>

### DomainName
<a name="sam-property-api-domainconfiguration--examples--domainname"></a>

DomainName contoh

#### YAML
<a name="sam-property-api-domainconfiguration--examples--domainname--yaml"></a>

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