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

# DomainConfiguration
<a name="sam-property-api-domainconfiguration"></a>

API의 사용자 지정 도메인을 구성합니다.

## 구문
<a name="sam-property-api-domainconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-api-domainconfiguration-syntax.yaml"></a>

```
  [AccessAssociation](#sam-api-domainconfiguration-domainaccessassociation): DomainAccessAssociation
  [BasePath](#sam-api-domainconfiguration-basepath): List
  [CertificateArn](#sam-api-domainconfiguration-certificatearn): String
  [DomainName](#sam-api-domainconfiguration-domainname): String
  [EndpointConfiguration](#sam-api-domainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-api-domainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)
  [NormalizeBasePath](#sam-api-domainconfiguration-normalizebasepath): Boolean
  [OwnershipVerificationCertificateArn](#sam-api-domainconfiguration-ownershipverificationcertificatearn): String
  [Policy: ](#sam-api-domainconfiguration-policy)Json
  [Route53](#sam-api-domainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-api-domainconfiguration-securitypolicy): String
```

## 속성
<a name="sam-property-api-domainconfiguration-properties"></a>

 `AccessAssociation`   <a name="sam-api-domainconfiguration-domainaccessassociation"></a>
` AWS::ApiGateway::DomainNameAccessAssociation` 리소스를 생성하는 데 필요한 구성입니다.  
AWS SAM 는이 속성이 설정되면 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html) 리소스를 생성합니다. 생성된 CloudFormation 리소스에 대한 자세한 내용은 섹션을 참조하세요[에 대해 생성된 CloudFormation 리소스 AWS SAM](sam-specification-generated-resources.md).  
*유형*: [DomainAccessAssociation](sam-property-api-domainaccessassociation.md)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `BasePath`   <a name="sam-api-domainconfiguration-basepath"></a>
Amazon API Gateway 도메인 이름을 사용하여 구성할 basepath 목록입니다.  
*유형*: 목록  
*필수 항목 여부*: 아니요  
*기본값*: /  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::BasePathMapping` 리소스의 `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` 속성과 유사합니다.는이 속성에 `BasePath` 지정된당 하나씩 여러 `AWS::ApiGateway::BasePathMapping` 리소스를 AWS SAM 생성합니다.

 `CertificateArn`   <a name="sam-api-domainconfiguration-certificatearn"></a>
이 도메인 이름의 엔드포인트인 AWS 관리형 인증서의 Amazon 리소스 이름(ARN)은 유일하게 지원되는 소스 AWS Certificate Manager 입니다.  
*유형*: 문자열  
*필수 항목 여부:* 예  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::DomainName` 리소스의 `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)` 속성과 유사합니다. `EndpointConfiguration`이 `REGIONAL`(기본값)로 설정된 경우 `CertificateArn`이 `AWS::ApiGateway::DomainName`의 [RegionalCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn)에 매핑됩니다. `EndpointConfiguration`이 `EDGE`로 설정된 경우 `CertificateArn`이 `AWS::ApiGateway::DomainName`의 [CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)에 매핑됩니다. `EndpointConfiguration`이(가) `PRIVATE`(으)로 설정된 경우, 이 속성은 [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2) 리소스로 전달됩니다.  
*추가 참고* 사항: `EDGE` 엔드포인트의 경우 `us-east-1` AWS 리전에서 인증서를 생성해야 합니다.

 `DomainName`   <a name="sam-api-domainconfiguration-domainname"></a>
Amazon API Gateway의 API에 대한 사용자 지정 도메인 이름입니다. 대문자는 지원되지 않습니다.  
AWS SAM 는이 속성이 설정되면 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) 리소스를 생성합니다. 이 시나리오에 대한 자세한 내용은 [DomainName 속성이 지정되었습니다.](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-domain-name) 섹션을 참조하세요. 생성된 CloudFormation 리소스에 대한 자세한 내용은 섹션을 참조하세요[에 대해 생성된 CloudFormation 리소스 AWS SAM](sam-specification-generated-resources.md).  
*유형*: 문자열  
*필수 항목 여부:* 예  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::DomainName` 리소스의 `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname)` 속성으로 직접 전달되거나 EndpointConfiguration이 로 설정된 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2) 경우 로 전달됩니다`PRIVATE`.

 `EndpointConfiguration`   <a name="sam-api-domainconfiguration-endpointconfiguration"></a>
사용자 지정 도메인에 매핑할 API Gateway 엔드포인트의 유형을 정의합니다. 이 속성의 값은 `CertificateArn` 속성이 매핑되는 방식을 결정합니다 CloudFormation.  
*유효한 값*: `EDGE`, `REGIONAL` 또는 `PRIVATE`  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*기본값*: `REGIONAL`  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `MutualTlsAuthentication`   <a name="sam-api-domainconfiguration-mutualtlsauthentication"></a>
사용자 지정 도메인 이름에 대한 상호 전송 계층 보안(TLS) 인증 구성입니다.  
*유형*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::DomainName` 리소스의 `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)` 속성으로 직접 전달됩니다.

 `NormalizeBasePath`   <a name="sam-api-domainconfiguration-normalizebasepath"></a>
`BasePath` 속성으로 정의된 basepath에 영숫자가 아닌 문자를 사용할 수 있는지 여부를 나타냅니다. `True`로 설정하면 basepath에서 영숫자가 아닌 문자가 제거됩니다.  
`BasePath` 속성과 함께 `NormalizeBasePath`을 사용합니다.  
*유형*: 부울  
*필수 항목 여부*: 아니요  
*기본값*: True  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `OwnershipVerificationCertificateArn`   <a name="sam-api-domainconfiguration-ownershipverificationcertificatearn"></a>
사용자 지정 도메인의 소유권을 확인하기 위해 ACM에서 발급한 공인 인증서의 ARN입니다. 상호 TLS를 구성하고 `CertificateArn`에 대해 ACM 가져오기 또는 사설 CA 인증서 ARN을 지정하는 경우에만 필요합니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::DomainName` 리소스의 `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn)` 속성으로 직접 전달됩니다.

 `Policy`   <a name="sam-api-domainconfiguration-policy"></a>
API Gateway 도메인 이름에 연결할 IAM 정책입니다. `EndpointConfiguration`이(가) `PRIVATE`(으)로 설정된 경우에만 적용됩니다.  
*유형*: Json  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은가 로 `EndpointConfiguration` 설정된 경우 `AWS::ApiGateway::DomainNameV2` 리소스의 `Policy` 속성으로 직접 전달됩니다`PRIVATE`. 유효한 정책 문서의 예시는 [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)를 참조하세요.

 `Route53`   <a name="sam-api-domainconfiguration-route53"></a>
Amazon Route 53 구성을 정의합니다.  
*유형*: [Route53Configuration](sam-property-api-route53configuration.md)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `SecurityPolicy`   <a name="sam-api-domainconfiguration-securitypolicy"></a>
이 도메인 이름에 대한 TLS 버전과 암호 그룹의 결합입니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::DomainName` 리소스의 `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy)` 속성으로 직접 전달되거나 `EndpointConfiguration`가 로 설정된 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2) 경우 로 전달됩니다`PRIVATE`. `PRIVATE` 엔드포인트의 경우, TLS\$11\$12만 지원됩니다.

## 예제
<a name="sam-property-api-domainconfiguration--examples"></a>

### DomainName
<a name="sam-property-api-domainconfiguration--examples--domainname"></a>

DomainName 예제

#### YAML
<a name="sam-property-api-domainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```