기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DomainConfiguration
API의 사용자 지정 도메인을 구성합니다.
명령문
귀하의 AWS Serverless Application Model(AWS SAM) 템플릿에서 이 객체를 선언하려면 다음 명령문을 사용합니다.
YAML
BasePath:
List
NormalizeBasePath:Boolean
CertificateArn:String
DomainName:String
EndpointConfiguration:String
MutualTlsAuthentication:MutualTlsAuthentication
OwnershipVerificationCertificateArn:String
Route53:Route53Configuration
SecurityPolicy:String
속성
-
BasePath
-
Amazon API Gateway 도메인 이름을 사용하여 구성할 basepath 목록입니다.
유형: 목록
필수 항목 여부: 아니요
기본값: /
AWS CloudFormation 호환성: 이 속성은
AWS::ApiGateway::BasePathMapping
리소스의BasePath
속성과 유사합니다. AWS SAM은 이 속성에 지정된BasePath
당 하나씩 여러AWS::ApiGateway::BasePathMapping
리소스를 만듭니다. -
NormalizeBasePath
-
BasePath
속성으로 정의된 basepath에 영숫자가 아닌 문자를 사용할 수 있는지 여부를 나타냅니다.True
로 설정하면 basepath에서 영숫자가 아닌 문자가 제거됩니다.BasePath
속성과 함께NormalizeBasePath
을 사용합니다.유형: 부울
필수 항목 여부: 아니요
기본값: True
AWS CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 AWS CloudFormation 동등한 속성이 없습니다.
-
CertificateArn
-
이 도메인 이름 엔드포인트의 AWS 관리형 인증서의 Amazon 리소스 이름(ARN)입니다. 유일하게 지원되는 소스는 AWS Certificate Manager입니다.
타입: 문자열
필수 항목 여부: 예
AWS CloudFormation호환성: 이 속성은
CertificateArn
리소스의AWS::ApiGateway::DomainName
속성과 유사합니다.EndpointConfiguration
가REGIONAL
(기본값) 로 설정된 경우 RegionalCertificateArnin에CertificateArn
AWS::ApiGateway::DomainName
매핑됩니다.EndpointConfiguration
가 로 설정된 경우EDGE
CertificateArnin에CertificateArn
AWS::ApiGateway::DomainName
매핑됩니다.추가 참고 사항:
EDGE
엔드포인트의 경우us-east-1
AWS 리전에 인증서를 생성해야 합니다. -
DomainName
-
Amazon API Gateway의 API에 대한 사용자 지정 도메인 이름입니다. 대문자는 지원되지 않습니다.
AWS SAM은 이 속성이 설정되면 AWS::ApiGateway::DomainName 리소스를 생성합니다. 이 시나리오에 대한 자세한 내용은 DomainName속성이 지정됩니다. 섹션을 참조하세요. AWS CloudFormation 리소스 태그 지정에 대한 자세한 내용은 에 대한 AWS CloudFormation 리소스 생성 AWS SAM 섹션을 참조하세요.
타입: 문자열
필수 항목 여부: 예
AWS CloudFormation호환성: 이 속성은
DomainName
리소스의AWS::ApiGateway::DomainName
속성으로 직접 전달됩니다. -
EndpointConfiguration
-
사용자 지정 도메인에 매핑할 API Gateway 엔드포인트의 유형을 정의합니다. 이 속성의 값에 따라
CertificateArn
속성이 AWS CloudFormation에 매핑되는 방식이 결정됩니다.유효한 값:
REGIONAL
또는EDGE
타입: 문자열
필수 항목 여부: 아니요
기본값:
REGIONAL
AWS CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 AWS CloudFormation 동등한 속성이 없습니다.
-
MutualTlsAuthentication
-
사용자 지정 도메인 이름에 대한 상호 전송 계층 보안(TLS) 인증 구성입니다.
필수 항목 여부: 아니요
AWS CloudFormation호환성: 이 속성은
MutualTlsAuthentication
리소스의AWS::ApiGateway::DomainName
속성으로 직접 전달됩니다. -
OwnershipVerificationCertificateArn
-
사용자 지정 도메인의 소유권을 확인하기 위해 ACM에서 발급한 공인 인증서의 ARN입니다. 상호 TLS를 구성하고
CertificateArn
에 대해 ACM 가져오기 또는 사설 CA 인증서 ARN을 지정하는 경우에만 필요합니다.타입: 문자열
필수 항목 여부: 아니요
AWS CloudFormation 호환성: 이 속성은
AWS::ApiGateway::DomainName
리소스의OwnershipVerificationCertificateArn
속성으로 직접 전달됩니다. -
Route53
-
Amazon Route 53 구성을 정의합니다.
필수 항목 여부: 아니요
AWS CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 AWS CloudFormation 동등한 속성이 없습니다.
-
SecurityPolicy
-
이 도메인 이름에 대한 TLS 버전과 암호 그룹의 결합입니다.
타입: 문자열
필수 항목 여부: 아니요
AWS CloudFormation호환성: 이 속성은
SecurityPolicy
리소스의AWS::ApiGateway::DomainName
속성으로 직접 전달됩니다.
예제
DomainName
DomainName 예시
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: EDGE Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar