DomainConfiguration

AWS::ApiGateway::DomainNameAccessAssociation 리소스를 생성하는 데 필요한 구성입니다.

AWS SAM은 이 속성이 설정되면 AWS::ApiGateway::DomainNameAccessAssociation 리소스를 생성합니다. CloudFormation 리소스 태그 지정에 대한 자세한 내용은 AWS SAM용으로 생성된 CloudFormation 리소스 섹션을 참조하세요.

유형: DomainAccessAssociation

필수 항목 여부: 아니요

CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 CloudFormation 동등한 속성이 없습니다.

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

유형: 목록

필수 항목 여부: 아니요

기본값: /

CloudFormation 호환성: 이 속성은 AWS::ApiGateway::BasePathMapping 리소스의 BasePath 속성과 유사합니다. AWS SAM은 이 속성에 지정된 BasePath당 하나씩 여러 AWS::ApiGateway::BasePathMapping 리소스를 만듭니다.

이 도메인 이름 엔드포인트의 AWS 관리형 인증서의 Amazon 리소스 이름(ARN)입니다. 유일하게 지원되는 소스는 AWS Certificate Manager입니다.

유형: 문자열

필수 항목 여부: 예

CloudFormation 호환성: 이 속성은 AWS::ApiGateway::DomainName 리소스의 CertificateArn 속성과 유사합니다. EndpointConfiguration이 REGIONAL(기본값)로 설정된 경우 CertificateArn이 AWS::ApiGateway::DomainName의 RegionalCertificateArn에 매핑됩니다. EndpointConfiguration이 EDGE로 설정된 경우 CertificateArn이 AWS::ApiGateway::DomainName의 CertificateArn에 매핑됩니다. EndpointConfiguration이(가) PRIVATE(으)로 설정된 경우, 이 속성은 AWS::ApiGateway::DomainNameV2 리소스로 전달됩니다.

추가 참고 사항: EDGE 엔드포인트의 경우 us-east-1 AWS 리전에 인증서를 생성해야 합니다.

Amazon API Gateway의 API에 대한 사용자 지정 도메인 이름입니다. 대문자는 지원되지 않습니다.

AWS SAM은 이 속성이 설정되면 AWS::ApiGateway::DomainName 리소스를 생성합니다. 이 시나리오에 대한 자세한 내용은 DomainName 속성이 지정되었습니다. 섹션을 참조하세요. CloudFormation 리소스 태그 지정에 대한 자세한 내용은 AWS SAM용으로 생성된 CloudFormation 리소스 섹션을 참조하세요.

유형: 문자열

필수 항목 여부: 예

CloudFormation 호환성: 이 속성은 EndpointConfiguration이 PRIVATE(으)로 설정된 경우 AWS::ApiGateway::DomainName 리소스의 DomainName 속성으로 직접 전달되거나, AWS::ApiGateway::DomainNameV2(으)로 전달됩니다.

사용자 지정 도메인에 매핑할 API Gateway 엔드포인트의 유형을 정의합니다. 이 속성의 값에 따라 CertificateArn 속성이 CloudFormation에 매핑되는 방식이 결정됩니다.

유효한 값: EDGE, REGIONAL 또는 PRIVATE

유형: 문자열

필수 항목 여부: 아니요

기본값: REGIONAL

CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 CloudFormation 동등한 속성이 없습니다.

사용자 지정 도메인 이름에 대한 상호 전송 계층 보안(TLS) 인증 구성입니다.

유형: MutualTlsAuthentication

필수 항목 여부: 아니요

CloudFormation호환성: 이 속성은 AWS::ApiGateway::DomainName 리소스의 MutualTlsAuthentication 속성으로 직접 전달됩니다.

BasePath 속성으로 정의된 basepath에 영숫자가 아닌 문자를 사용할 수 있는지 여부를 나타냅니다. True로 설정하면 basepath에서 영숫자가 아닌 문자가 제거됩니다.

BasePath 속성과 함께 NormalizeBasePath을 사용합니다.

유형: 부울

필수 항목 여부: 아니요

기본값: True

CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 CloudFormation 동등한 속성이 없습니다.

사용자 지정 도메인의 소유권을 확인하기 위해 ACM에서 발급한 공인 인증서의 ARN입니다. 상호 TLS를 구성하고 CertificateArn에 대해 ACM 가져오기 또는 사설 CA 인증서 ARN을 지정하는 경우에만 필요합니다.

유형: 문자열

필수 항목 여부: 아니요

CloudFormation호환성: 이 속성은 AWS::ApiGateway::DomainName 리소스의 OwnershipVerificationCertificateArn 속성으로 직접 전달됩니다.

API Gateway 도메인 이름에 연결할 IAM 정책입니다. EndpointConfiguration이(가) PRIVATE(으)로 설정된 경우에만 적용됩니다.

유형: Json

필수 항목 여부: 아니요

CloudFormation호환성: EndpointConfiguration이(가) PRIVATE(으)로 설정된 경우, 이 속성은 AWS::ApiGateway::DomainNameV2 리소스의 Policy 속성으로 직접 전달됩니다. 유효한 정책 문서의 예시는 AWS::ApiGateway::DomainNameV2를 참조하세요.

Amazon Route 53 구성을 정의합니다.

유형: Route53Configuration

필수 항목 여부: 아니요

CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 CloudFormation 동등한 속성이 없습니다.

이 도메인 이름에 대한 TLS 버전과 암호 그룹의 결합입니다.

유형: 문자열

필수 항목 여부: 아니요

CloudFormation호환성: EndpointConfiguration이(가) PRIVATE(으)로 설정된 경우, 이 속성은 AWS::ApiGateway::DomainName 리소스의 SecurityPolicy 속성으로 직접 전달되거나, AWS::ApiGateway::DomainNameV2(으)로 전달됩니다. PRIVATE 엔드포인트의 경우, TLS_1_2만 지원됩니다.