기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
HttpApiDomainConfiguration
API의 사용자 지정 도메인을 구성합니다.
구문
AWS Serverless Application Model (AWS SAM) 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.
YAML
BasePath:
List
CertificateArn:String
DomainName:String
EndpointConfiguration:String
MutualTlsAuthentication:MutualTlsAuthentication
OwnershipVerificationCertificateArn:String
Route53:Route53Configuration
SecurityPolicy:String
속성
-
BasePath
-
Amazon API Gateway 도메인 이름을 사용하여 구성할 basepath 목록입니다.
유형: 목록
필수 항목 여부: 아니요
기본값: /
AWS CloudFormation 호환성:이 속성은
AWS::ApiGatewayV2::ApiMapping
리소스의ApiMappingKey
속성과 유사합니다.는이 속성에 지정된 값당 하나씩 여러AWS::ApiGatewayV2::ApiMapping
리소스를 AWS SAM 생성합니다. -
CertificateArn
-
이 도메인 이름의 엔드포인트에 대한 AWS 관리형 인증서의 Amazon 리소스 이름(ARN)은 지원되는 유일한 소스 AWS Certificate Manager 입니다.
유형: 문자열
필수 항목 여부: 예
AWS CloudFormation 호환성:이 속성은
AWS::ApiGateway2::DomainName DomainNameConfiguration
리소스의CertificateArn
속성으로 직접 전달됩니다. -
DomainName
-
Amazon API Gateway의 API에 대한 사용자 지정 도메인 이름입니다. 대문자는 지원되지 않습니다.
AWS SAM 는이 속성이 설정되면
AWS::ApiGatewayV2::DomainName
리소스를 생성합니다. 이 시나리오에 대한 자세한 내용은 DomainName 속성이 지정되었습니다. 섹션을 참조하세요. 생성된 AWS CloudFormation 리소스에 대한 자세한 내용은 섹션을 참조하세요에 대해 생성된 AWS CloudFormation 리소스 AWS SAM.유형: 문자열
필수 항목 여부: 예
AWS CloudFormation 호환성:이 속성은
AWS::ApiGateway2::DomainName
리소스의DomainName
속성으로 직접 전달됩니다. -
EndpointConfiguration
-
사용자 지정 도메인에 매핑할 API Gateway 엔드포인트의 유형을 정의합니다. 이 속성의 값은
CertificateArn
속성이 매핑되는 방법을 결정합니다 AWS CloudFormation.HTTP API의 유일한 유효 값은
REGIONAL
입니다.유형: 문자열
필수 항목 여부: 아니요
기본값:
REGIONAL
AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.
-
MutualTlsAuthentication
-
사용자 지정 도메인 이름에 대한 상호 전송 계층 보안(TLS) 인증 구성입니다.
필수 항목 여부: 아니요
AWS CloudFormation 호환성:이 속성은
AWS::ApiGatewayV2::DomainName
리소스의MutualTlsAuthentication
속성으로 직접 전달됩니다. -
OwnershipVerificationCertificateArn
-
사용자 지정 도메인의 소유권을 확인하기 위해 ACM에서 발급한 공인 인증서의 ARN입니다. 상호 TLS를 구성하고
CertificateArn
에 대해 ACM 가져오기 또는 사설 CA 인증서 ARN을 지정하는 경우에만 필요합니다.유형: 문자열
필수 항목 여부: 아니요
AWS CloudFormation 호환성:이 속성은
AWS::ApiGatewayV2::DomainName
DomainNameConfiguration
데이터 유형의OwnershipVerificationCertificateArn
속성으로 직접 전달됩니다. -
Route53
-
Amazon Route 53 구성을 정의합니다.
필수 항목 여부: 아니요
AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.
-
SecurityPolicy
-
이 도메인 이름에 대한 보안 정책의 TLS(전송 계층 보안) 버전입니다.
HTTP API의 유일한 유효 값은
TLS_1_2
입니다.유형: 문자열
필수 항목 여부: 아니요
AWS CloudFormation 호환성:이 속성은
AWS::ApiGatewayV2::DomainName
DomainNameConfiguration
데이터 유형의SecurityPolicy
속성으로 직접 전달됩니다.
예시
DomainName
DomainName 예제
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: REGIONAL Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar