View a markdown version of this page

WebSocketApiDomainConfiguration - AWS Serverless Application Model

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

WebSocketApiDomainConfiguration

WebSocket API에 대한 사용자 지정 도메인을 구성합니다.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.

속성

BasePath

Amazon API Gateway 도메인 이름을 사용하여 구성할 basepath 목록입니다.

유형: 목록

필수 항목 여부: 아니요

기본값: /

CloudFormation 호환성:이 속성은 AWS::ApiGatewayV2::ApiMapping 리소스의 ApiMappingKey 속성과 유사합니다.는이 속성에 지정된 값당 하나씩 여러 AWS::ApiGatewayV2::ApiMapping 리소스를 AWS SAM 생성합니다.

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