WebSocketApiDomainConfiguration

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

構文

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

YAML

  BasePath: List
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  Route53: Route53Configuration
  SecurityPolicy: String

プロパティ

BasePath

Amazon API Gateway ドメイン名で設定する basepaths のリストです。

タイプ: リスト

必須: いいえ

デフォルト: /

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::ApiMapping resource. AWS SAM creates の ApiMappingKey プロパティに似ています。このプロパティで指定された値ごとに 1 つずつ、複数のAWS::ApiGatewayV2::ApiMappingリソースを作成します。

CertificateArn

このドメイン名のエンドポイントの AWS マネージド証明書の Amazon リソースネーム (ARN)。 は、サポートされている唯一のソース AWS Certificate Manager です。

タイプ: 文字列

必須: はい

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::DomainName DomainNameConfigurationリソースの CertificateArnプロパティに直接渡されます。

DomainName

API Gateway WebSocket API のカスタムドメイン名。大文字はサポートされていません。

AWS SAM このプロパティが設定されると、 は AWS::ApiGatewayV2::DomainNameリソースを生成します。生成された CloudFormation リソースの詳細については、「」を参照してくださいの生成済み CloudFormation リソース AWS SAM。

タイプ: 文字列

必須: はい

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::DomainNameリソースの DomainNameプロパティに直接渡されます。

EndpointConfiguration

カスタムドメインにマップする API Gateway エンドポイントのタイプを定義します。このプロパティの値は、CertificateArnプロパティのマッピング方法を決定します CloudFormation。

WebSocket APIs の唯一の有効な値は ですREGIONAL。

タイプ: 文字列

必須: いいえ

デフォルト: REGIONAL

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

Route53

Route 53 の設定を定義します。

タイプ: Route53Configuration

必須: いいえ

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

SecurityPolicy

このドメイン名に対するセキュリティポリシーの TLS バージョンです。

WebSocket APIs の唯一の有効な値は ですTLS_1_2。

タイプ: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::DomainName DomainNameConfiguration データ型の SecurityPolicyプロパティに直接渡されます。

例

DomainName

DomainName の例

YAML

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