翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# WebSocketApiDomainConfiguration
<a name="sam-property-websocketapi-websocketapidomainconfiguration"></a>

WebSocket API のカスタムドメインを設定します。

## 構文
<a name="sam-property-websocketapi-websocketapidomainconfiguration-syntax"></a>

 AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

### YAML
<a name="sam-property-websocketapi-websocketapidomainconfiguration-syntax.yaml"></a>

```
  [BasePath](#sam-websocketapi-websocketapidomainconfiguration-basepath): {{List}}
  [CertificateArn](#sam-websocketapi-websocketapidomainconfiguration-certificatearn): {{String}}
  [DomainName](#sam-websocketapi-websocketapidomainconfiguration-domainname): {{String}}
  [EndpointConfiguration](#sam-websocketapi-websocketapidomainconfiguration-endpointconfiguration): {{String}}
  [Route53](#sam-websocketapi-websocketapidomainconfiguration-route53): {{Route53Configuration}}
  [SecurityPolicy](#sam-websocketapi-websocketapidomainconfiguration-securitypolicy): {{String}}
```

## プロパティ
<a name="sam-property-websocketapi-websocketapidomainconfiguration-properties"></a>

 `BasePath`   <a name="sam-websocketapi-websocketapidomainconfiguration-basepath"></a>
Amazon API Gateway ドメイン名で設定する basepaths のリストです。  
*タイプ*: リスト  
*必須:* いいえ  
*デフォルト*: /  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::ApiMapping` resource. AWS SAM creates の `[ApiMappingKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey)` プロパティに似ています。このプロパティで指定された値ごとに 1 つずつ、複数の`AWS::ApiGatewayV2::ApiMapping`リソースを作成します。

 `CertificateArn`   <a name="sam-websocketapi-websocketapidomainconfiguration-certificatearn"></a>
このドメイン名のエンドポイントの AWS マネージド証明書の Amazon リソースネーム (ARN)。 は、サポートされている唯一のソース AWS Certificate Manager です。  
*タイプ*: 文字列  
*必須*: はい  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::DomainName DomainNameConfiguration`リソースの `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn)`プロパティに直接渡されます。

 `DomainName`   <a name="sam-websocketapi-websocketapidomainconfiguration-domainname"></a>
API Gateway WebSocket API のカスタムドメイン名。大文字はサポートされていません。  
AWS SAM このプロパティが設定されると、 は `AWS::ApiGatewayV2::DomainName`リソースを生成します。生成された CloudFormation リソースの詳細については、「」を参照してください[の生成済み CloudFormation リソース AWS SAM](sam-specification-generated-resources.md)。  
*タイプ*: 文字列  
*必須*: はい  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::DomainName`リソースの `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname)`プロパティに直接渡されます。

 `EndpointConfiguration`   <a name="sam-websocketapi-websocketapidomainconfiguration-endpointconfiguration"></a>
カスタムドメインにマップする API Gateway エンドポイントのタイプを定義します。このプロパティの値は、`CertificateArn`プロパティのマッピング方法を決定します CloudFormation。  
WebSocket APIs の唯一の有効な値は です`REGIONAL`。  
*タイプ*: 文字列  
*必須:* いいえ  
*デフォルト*: `REGIONAL`  
*CloudFormation 互換性*: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

 `Route53`   <a name="sam-websocketapi-websocketapidomainconfiguration-route53"></a>
Route 53 の設定を定義します。  
*タイプ*: [Route53Configuration](sam-property-websocketapi-route53configuration.md)  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

 `SecurityPolicy`   <a name="sam-websocketapi-websocketapidomainconfiguration-securitypolicy"></a>
このドメイン名に対するセキュリティポリシーの TLS バージョンです。  
WebSocket APIs の唯一の有効な値は です`TLS_1_2`。  
*タイプ*: 文字列  
*必須:* いいえ  
*CloudFormation 互換性*: このプロパティは、 `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` データ型の `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy)`プロパティに直接渡されます。

## 例
<a name="sam-property-websocketapi-websocketapidomainconfiguration--examples"></a>

### DomainName
<a name="sam-property-websocketapi-websocketapidomainconfiguration--examples--domainname"></a>

DomainName の例

#### YAML
<a name="sam-property-websocketapi-websocketapidomainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: ws.example.com
  CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - v1
    - v2
```