# Amazon API Gateway의 보안
AWS은 클라우드 보안을 가장 중요하게 생각합니다. AWS 고객으로서 여러분은 가장 높은 보안 요구 사항을 충족하기 위해 설계된 데이터 센터 및 네트워크 아키텍처의 혜택을 받게 됩니다.
보안은 AWS와 여러분의 공동 책임입니다. [공동 책임 모델](https://aws.amazon.com/compliance/shared-responsibility-model/)은 이 사항을 클라우드*의* 보안 및 클라우드 *내* 보안으로 설명합니다.
+ **클라우드의 보안**: AWS는 AWS클라우드에서 AWS서비스를 실행하는 인프라를 보호할 책임이 있습니다. AWS는 안전하게 사용할 수 있는 서비스 또한 제공합니다. 외부 감사자는 [AWS 규정 준수 프로그램](https://aws.amazon.com/compliance/programs/)의 일환으로 보안 효과를 정기적으로 테스트하고 검증합니다. Amazon API Gateway에 적용되는 규정 준수 프로그램에 대한 자세한 내용은 [규정 준수 프로그램 제공 범위 내 AWS 서비스 ](https://aws.amazon.com/compliance/services-in-scope/)를 참조하세요.
+ **클라우드 내 보안** – 귀하의 책임은 귀하가 사용하는 AWS 서비스에 의해 결정됩니다. 또한 귀하는 귀사의 데이터 민감도, 귀사의 요구 사항, 관련 법률 및 규정을 비롯한 기타 요소에 대해서도 책임이 있습니다.
이 설명서는 API Gateway를 사용할 때 공동 책임 모델을 적용하는 방법을 이해하는 데 도움이 됩니다. 다음 주제에서는 보안 및 규정 준수 목적에 맞게 API Gateway를 구성하는 방법을 보여줍니다. 또한 API Gateway 리소스를 모니터링하고 보호하는 데 도움이 되는 다른 AWS 서비스를 사용하는 방법을 배우게 됩니다.
자세한 내용은 [Amazon API Gateway의 보안 개요](https://d1.awsstatic.com/whitepapers/api-gateway-security.pdf)를 참조하세요.
**Topics**
+ [Amazon API Gateway에서의 데이터 보호](data-protection.md)
+ [Amazon API Gateway의 Identity and Access Management](security-iam.md)
+ [Amazon API Gateway에서 로깅 및 모니터링](security-monitoring.md)
+ [Amazon API Gateway에 대한 규정 준수 확인](apigateway-compliance.md)
+ [Amazon API Gateway의 복원성](disaster-recovery-resiliency.md)
+ [Amazon API Gateway의 인프라 보안](infrastructure-security.md)
+ [Amazon API Gateway의 취약성 분석](vulnerability-analysis.md)
+ [Amazon API Gateway의 보안 모범 사례](security-best-practices.md)
# Amazon API Gateway에서의 데이터 보호
AWS [공동 책임 모델](https://aws.amazon.com/compliance/shared-responsibility-model/)은 Amazon API Gateway의 데이터 보호에 적용됩니다. 이 모델에서 설명하는 것처럼 AWS는 모든 AWS 클라우드를 실행하는 글로벌 인프라를 보호할 책임이 있습니다. 사용자는 인프라에서 호스팅되는 콘텐츠를 관리해야 합니다. 사용하는 AWS 서비스의 보안 구성과 관리 작업에 대한 책임도 사용자에게 있습니다. 데이터 프라이버시에 대한 자세한 내용은 [데이터 프라이버시 FAQ](https://aws.amazon.com/compliance/data-privacy-faq/)를 참조하세요. 유럽의 데이터 보호에 대한 자세한 내용은 *AWS 보안 블로그*의 [AWS 공동 책임 모델 및 GDPR](https://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/) 블로그 게시물을 참조하세요.
데이터를 보호하려면 AWS 계정보안 인증 정보를 보호하고 AWS IAM Identity Center또는 AWS Identity and Access Management(IAM)를 통해 개별 사용자 계정을 설정하는 것이 좋습니다. 이렇게 하면 개별 사용자에게 자신의 직무를 충실히 이행하는 데 필요한 권한만 부여됩니다. 또한 다음과 같은 방법으로 데이터를 보호하는 것이 좋습니다.
+ 각 계정에 멀티 팩터 인증 설정(MFA)을 사용하세요.
+ SSL/TLS를 사용하여 AWS 리소스와 통신하세요. TLS 1.2는 필수이며 TLS 1.3을 권장합니다.
+ AWS CloudTrail로 API 및 사용자 활동 로깅을 설정하세요. AWS 활동 캡처에 CloudTrail 추적을 사용하는 방법에 대한 자세한 내용은 *AWS CloudTrail 사용 설명서*의 [CloudTrail 추적 작업](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-trails.html)을 참조하세요.
+ AWS 암호화 솔루션을 AWS 서비스 내의 모든 기본 보안 컨트롤과 함께 사용하세요.
+ Amazon S3에 저장된 민감한 데이터를 검색하고 보호하는 데 도움이 되는 Amazon Macie와 같은 고급 관리형 보안 서비스를 사용하세요.
+ 명령행 인터페이스 또는 API를 통해 AWS에 액세스할 때 FIPS 140-3 검증된 암호화 모듈이 필요한 경우, FIPS 엔드포인트를 사용합니다. 사용 가능한 FIPS 엔드포인트에 대한 자세한 내용은 [Federal Information Processing Standard(FIPS) 140-3](https://aws.amazon.com/compliance/fips/)을 참조하세요.
고객의 이메일 주소와 같은 기밀 정보나 중요한 정보는 태그나 **이름** 필드와 같은 자유 양식 필드에 입력하지 않는 것이 좋습니다. 여기에는 콘솔, API, AWS CLI 또는 AWS SDK를 사용하여 API Gateway 또는 기타 AWS 서비스 서비스에서 작업하는 경우가 포함됩니다. 이름에 사용되는 태그 또는 자유 형식 텍스트 필드에 입력하는 모든 데이터는 청구 또는 진단 로그에 사용될 수 있습니다. 외부 서버로 URL을 제공할 때 해당 서버에 대한 요청을 검증하기 위해 자격 증명 정보를 URL에 포함해서는 안 됩니다.
# Amazon API Gateway에서의 데이터 암호화
데이터 보호란 전송 중(API Gateway 안팎으로 데이터가 이동 중)과 유휴 시(에 데이터가 저장된 동안)에 데이터를 보호하는 것을 말합니다AWS
## Amazon API Gateway에서 저장된 데이터 암호화
REST API에 대한 캐싱을 활성화하도록 선택한 경우 캐시 암호화를 활성화할 수 있습니다. 자세한 내용은 [API Gateway의 REST API 캐시 설정](api-gateway-caching.md) 단원을 참조하십시오.
데이터 보호에 대한 자세한 내용은 *AWS 보안 블로그*의 [AWS 공동 책임 모델 및 GDPR](https://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/) 블로그 게시물을 참조하세요.
### 인증서 프라이빗 키의 암호화 및 암호 해독
프라이빗 API에 대한 사용자 지정 도메인 이름을 생성하면 별칭 **aws/acm**가 있는 AWS 관리형 KMS 키를 사용하여 ACM 인증서와 프라이빗 키가 암호화됩니다. AWS KMS 콘솔의 **AWS 관리형 키**에서 이 별칭이 포함된 키 ID를 확인할 수 있습니다.
API Gateway는 ACM 리소스에 직접 액세스하지 않습니다. AWS TLS Connection Manager를 사용하여 인증서의 프라이빗 키를 보호하고 액세스합니다. ACM 인증서를 사용하여 프라이빗 API에 대한 API Gateway 사용자 지정 도메인 이름을 생성하면 API Gateway가 인증서를 AWS TLS Connection Manager와 연결합니다. 이렇게 하려면 접두사가 **aws/acm**인 AWS 관리형 키에 대한 권한 부여를 AWS KMS에 생성하면 됩니다. 권한 부여는 TLS 연결 관리자가 암호화 작업에서 KMS 키를 사용할 수 있도록 하는 정책 도구입니다. 권한 부여를 통해 피부여자 보안 주체(TLS 연결 관리자)는 KMS 키에 대해 지정된 권한 부여 작업을 호출해 인증서의 프라이빗 키를 해독할 수 있습니다. 그런 다음 TLS Connection Manager는 인증서와 해독된(일반 텍스트) 프라이빗 키를 사용하여 API Gateway 서비스의 클라이언트와 보안 연결(SSL/TLS 세션)을 설정합니다. 인증서가 프라이빗 API의 API Gateway 사용자 지정 도메인 이름에서 연결 해제되면 권한 부여는 사용 중지됩니다.
KMS 키에 대한 액세스 권한을 제거하려면 AWS CLI에서 AWS Management Console 또는 `update-service` 명령을 사용하여 서비스에서 인증서를 바꾸거나 삭제하는 것이 좋습니다.
### API Gateway의 암호화 컨텍스트
[암호화 컨텍스트](https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html)는 프라이빗 키의 사용 용도에 대한 컨텍스트 정보를 포함할 수 있는 선택적 키-값 페어 집합입니다. AWS KMS는 암호화 컨텍스트를 암호화된 데이터에 바인딩하고 이를 추가 인증 데이터로 사용하여 인증된 암호화를 지원합니다.
API Gateway와 TLS 연결 관리자에서 TLS 키를 사용하는 경우, 저장된 키를 암호화하는 데 사용되는 암호화 컨텍스트에 API Gateway 서비스의 이름이 포함됩니다. 다음 섹션과 같이 CloudTrail 로그의 암호화 컨텍스트를 보거나 ACM 콘솔의 **관련 리소스** 탭을 보면 인증서와 프라이빗 키가 사용되는 API Gateway 사용자 지정 도메인 이름을 확인할 수 있습니다.
데이터를 해독하기 위해 동일한 암호화 컨텍스트를 요청에 포함시킵니다. API Gateway는 모든 AWS KMS 암호화 작업에서 동일한 암호화 컨텍스트를 사용합니다. 여기서 키는 `aws:apigateway:arn`이고 값은 API Gateway `PrivateDomainName` 리소스의 Amazon 리소스 이름(ARN)입니다.
다음 예시에서는 작업(예: `CreateGrant`) 출력의 암호화 컨텍스트를 보여줍니다.
```
"constraints": {
"encryptionContextEquals": {
"aws:acm:arn": "arn:aws:acm:us-west-2:859412291086:certificate/9177097a-f0ae-4be1-93b1-19f911ea4f88",
"aws:apigateway:arn": "arn:aws:apigateway:us-west-2:859412291086:/domainnames/denytest-part1.pdx.sahig.people.aws.dev+cbaeumzjhg"
}
},
"operations": [
"Decrypt"
],
"granteePrincipal": "tlsconnectionmanager.amazonaws.com"
```
## Amazon API Gateway에서 전송 중 데이터 암호화
Amazon API Gateway를 통해 생성된 API는 HTTPS 엔드포인트만 제공합니다. API Gateway는 암호화되지 않은(HTTP) 엔드포인트를 지원하지 않습니다.
API Gateway는 기본 `execute-api` 엔드포인트의 인증서를 관리합니다. 사용자 지정 도메인 이름을 구성하는 경우 [도메인 이름에 대한 인증서를 지정](how-to-custom-domains.md#custom-domain-names-certificates)합니다. [인증서를 고정](https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-pinning.html)하지 않는 것이 좋습니다.
보안 강화를 위해 API Gateway 사용자 지정 도메인에 적용할 최소 전송 계층 보안(TLS) 프로토콜 버전을 선택할 수 있습니다. WebSocket API 및 HTTP API는 TLS 1.2만 지원합니다. 자세한 내용은 [API Gateway에서 사용자 지정 도메인에 대한 보안 정책 선택](apigateway-custom-domain-tls-version.md) 단원을 참조하십시오.
계정에서 사용자 정의 SSL 인증서를 사용하여 Amazon CloudFront 배포를 설정하고 리전 API를 통해 사용할 수 있습니다. 그런 다음 보안 및 규정 준수 사항에 따라 TLS 1.1 이상을 사용하는 CloudFront 배포에 대한 보안 정책을 구성할 수 있습니다.
데이터 보호에 대한 자세한 내용은 *AWS 보안 블로그*의 [API Gateway에서 REST API 보호](rest-api-protect.md) 및 [AWS 공동 책임 모델 및 GDPR](https://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/) 블로그 게시물을 참조하세요.
# 인터네트워크 트래픽 개인 정보
Amazon API Gateway를 사용하면 Amazon Virtual Private Cloud(VPC)에서만 액세스할 수 있는 프라이빗 REST API를 생성할 수 있습니다. VPC는 VPC에서 생성하는 엔드포인트 네트워크 인터페이스인 [인터페이스 VPC 종단점](https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html)를 사용합니다. 여러 AWS 계정은 물론 선택한 VPC 및 VPC 엔드포인트에서 API에 액세스하는 것을 [리소스 정책](apigateway-private-api-create.md#apigateway-private-api-set-up-resource-policy)으로 허용하거나 거부할 수 있습니다. 각 엔드포인트를 사용하여 여러 개의 프라이빗 API에 액세스할 수 있습니다. 또한 Direct Connect를 사용하여 온프레미스 네트워크에서 Amazon VPC에 연결한 다음 그 연결을 통해 프라이빗 API에 액세스할 수도 있습니다. 어떤 경우에든 프라이빗 API로 가는 트래픽은 안전한 연결을 사용하고, Amazon 네트워크를 벗어나지 않으며, 퍼블릭 인터넷과 격리됩니다. 자세한 내용은 [API Gateway의 프라이빗 REST API](apigateway-private-apis.md) 단원을 참조하십시오.
# Amazon API Gateway의 Identity and Access Management
AWS Identity and Access Management(IAM)는 관리자가 AWS 리소스에 대한 액세스를 안전하게 제어할 수 있도록 지원하는 AWS 서비스입니다. IAM 관리자는 어떤 사용자가 API Gateway 리소스를 사용하도록 *인증*(로그인)되고 *권한 부여*(권한 있음)될 수 있는지를 제어합니다. IAM은 추가 비용 없이 사용할 수 있는 AWS 서비스입니다.
**Topics**
+ [고객](#security_iam_audience)
+ [ID를 통한 인증](#security_iam_authentication)
+ [정책을 사용하여 액세스 관리](#security_iam_access-manage)
+ [Amazon API Gateway에서 IAM을 사용하는 방식](security_iam_service-with-iam.md)
+ [Amazon API Gateway 자격 증명 기반 정책 예제](security_iam_id-based-policy-examples.md)
+ [Amazon API Gateway 리소스 기반 정책 예제](security_iam_resource-based-policy-examples.md)
+ [Amazon API Gateway 자격 증명 및 액세스 문제 해결](security_iam_troubleshoot.md)
+ [API Gateway에 서비스 연결 역할 사용](using-service-linked-roles.md)
## 고객
AWS Identity and Access Management(IAM)를 사용하는 방법은 역할에 따라 다릅니다.
+ **서비스 사용자** - 기능에 액세스할 수 없는 경우 관리자에게 권한 요청(참조[Amazon API Gateway 자격 증명 및 액세스 문제 해결](security_iam_troubleshoot.md))
+ **서비스 관리자** - 사용자 액세스 결정 및 권한 요청 제출([Amazon API Gateway에서 IAM을 사용하는 방식](security_iam_service-with-iam.md) 참조)
+ **IAM 관리자** - 액세스를 관리하기 위한 정책 작성([Amazon API Gateway 자격 증명 기반 정책 예제](security_iam_id-based-policy-examples.md) 참조)
## ID를 통한 인증
인증은 ID 자격 증명을 사용하여 AWS에 로그인하는 방식입니다. AWS 계정 루트 사용자이나 IAM 사용자로, 또는 IAM 역할을 수임하여 인증(에 로그인)받아야 합니다.
AWS IAM Identity Center(IAM Identity Center), Single Sign-On 인증 또는 Google/Facebook 자격 증명과 같은 자격 증명 소스의 자격 증명을 사용하여 페더레이션 ID로 로그인할 수 있습니다. 로그인하는 방법에 대한 자세한 내용은 *AWS Sign-In사용 설명서*의 [AWS 계정에 로그인하는 방법](https://docs.aws.amazon.com/signin/latest/userguide/how-to-sign-in.html) 섹션을 참조하세요.
프로그래밍 방식 액세스를 위해 AWS는 요청에 암호화 방식으로 서명할 수 있는 SDK 및 CLI를 제공합니다. 자세한 내용은 *IAM 사용자 설명서*의 [API 요청용 AWS Signature Version 4](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) 섹션을 참조하세요.
### AWS 계정 루트 사용자
AWS 계정을 생성하는 경우에는 모든 AWS 서비스 서비스와 리소스에 대한 완전한 액세스 권한이 있는 AWS 계정 *루트 사용자*라는 단일 로그인 ID로 시작합니다. 일상적인 태스크에 루트 사용자를 사용하지 않을 것을 강력히 권장합니다. 루트 사용자가 필요한 작업 목록은 *IAM 사용자 설명서*의 [루트 사용자 자격 증명이 필요한 작업](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks)을 참조하세요.
### IAM 사용자 및 그룹
*[IAM 사용자](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html)*는 단일 개인 또는 애플리케이션에 대한 특정 권한을 가진 ID입니다. 장기 자격 증명이 있는 IAM 사용자 대신 임시 자격 증명을 사용하는 것이 좋습니다. 자세한 내용은 *IAM 사용자 설명서*에서 [임시 자격 증명을 사용하여 AWS에 액세스하려면 인간 사용자가 ID 제공업체와의 페더레이션을 사용하도록 요구](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp)를 참조하세요.
[https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html)은 IAM 사용자 모음을 지정하고 대규모 사용자 집합에 대한 관리 권한을 더 쉽게 만듭니다. 자세한 내용은 *IAM 사용자 설명서*의 [IAM 사용자 사용 사례](https://docs.aws.amazon.com/IAM/latest/UserGuide/gs-identities-iam-users.html) 섹션을 참조하세요.
### IAM 역할
*[IAM 역할](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)*은 임시 자격 증명을 제공하는 특정 권한이 있는 자격 증명입니다. [사용자에서 IAM 역할(콘솔)로 전환](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-console.html)하거나 AWS CLI또는 AWS API 작업을 직접 호출하여 역할을 수임할 수 있습니다. 자세한 내용은 *IAM 사용자 설명서*의 [역할 수임 방법](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html)을 참조하세요.
IAM 역할은 페더레이션 사용자 액세스, 임시 IAM 사용자 권한, 교차 계정 액세스, 교차 서비스 액세스 및 Amazon EC2에서 실행되는 애플리케이션에 유용합니다. 자세한 내용은 *IAM 사용자 설명서*의 [교차 계정 리소스 액세스](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-cross-account-resource-access.html)를 참조하세요.
## 정책을 사용하여 액세스 관리
정책을 생성하고 AWS ID 또는 리소스에 연결하여 AWS에서 내 액세스를 제어합니다. 정책은 자격 증명이나 리소스와 연결될 때 해당 권한을 정의합니다. AWS는 보안 주체가 요청을 보낼 때 이러한 정책을 평가합니다. 대부분의 정책은 AWS에 JSON 문서로 저장됩니다. JSON 정책 문서에 대한 자세한 내용은 *IAM 사용자 설명서*의 [JSON 정책 개요](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) 섹션을 참조하세요.
정책을 사용하여 관리자는 어떤 **보안 주체**가 어떤 **리소스**에 대해 어떤 **조건**에서 **작업**을 수행할 수 있는지 정의하여 누가 무엇을 액세스할 수 있는지 지정합니다.
기본적으로 사용자 및 역할에는 어떠한 권한도 없습니다. IAM 관리자는 IAM 정책을 생성하고 사용자가 수임할 수 있는 역할에 추가합니다. IAM 정책은 작업을 수행하기 위해 사용하는 방법과 관계없이 작업에 대한 권한을 정의합니다.
### 자격 증명 기반 정책
ID 기반 정책은 ID(사용자, 사용자 그룹 또는 역할)에 연결하는 JSON 권한 정책 문서입니다. 이러한 정책은 자격 증명이 수행할 수 있는 작업, 대상 리소스 및 이에 관한 조건을 제어합니다. ID 기반 정책을 생성하는 방법을 알아보려면 *IAM 사용자 설명서*에서 [고객 관리형 정책으로 사용자 지정 IAM 권한 정의](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html)를 참조하세요.
ID 기반 정책은 *인라인 정책*(단일 ID에 직접 포함) 또는 *관리형 정책*(여러 ID에 연결된 독립 실행형 정책)일 수 있습니다. 관리형 정책 또는 인라인 정책을 선택하는 방법을 알아보려면 *IAM 사용자 설명서*의 [관리형 정책 및 인라인 정책 중에서 선택](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-choosing-managed-or-inline.html) 섹션을 참조하세요.
### 리소스 기반 정책
리소스 기반 정책은 리소스에 연결하는 JSON 정책 설명서입니다. 예를 들어 IAM *역할 신뢰 정책* 및 Amazon S3 *버킷 정책*이 있습니다. 리소스 기반 정책을 지원하는 서비스에서 서비스 관리자는 이러한 정책을 사용하여 특정 리소스에 대한 액세스를 통제할 수 있습니다. 리소스 기반 정책에서 [보안 주체를 지정](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)해야 합니다.
리소스 기반 정책은 해당 서비스에 있는 인라인 정책입니다. 리소스 기반 정책에서는 IAM의 AWS 관리형 정책을 사용할 수 없습니다.
### 액세스 제어 목록(ACL)
액세스 제어 목록(ACL)은 어떤 위탁자(계정 멤버, 사용자 또는 역할)가 리소스에 액세스할 수 있는 권한을 가지고 있는지를 제어합니다. ACLs는 JSON 정책 문서 형식을 사용하지 않지만 리소스 기반 정책과 유사합니다.
Amazon S3, AWS WAF 및 Amazon VPC는 ACL을 지원하는 대표적인 서비스입니다. ACL에 관한 자세한 내용은 *Amazon Simple Storage Service 개발자 가이드*의 [액세스 제어 목록(ACL) 개요](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html)를 참조하세요.
### 기타 정책 유형
AWS는 이러한 정책 타입이 부여하는 최대 권한을 설정할 수 있는 추가 정책 타입을 지지합니다.
+ **권한 경계** - ID 기반 정책에서 IAM 엔터티에 부여할 수 있는 최대 권한을 설정합니다. 자세한 정보는 *IAM 사용자 설명서*의 [IAM 엔터티의 권한 범위](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)를 참조하세요.
+ **서비스 제어 정책(SCP)** - AWS Organizations내 조직 또는 조직 단위에 대한 최대 권한을 지정합니다. 자세한 내용은 AWS Organizations사용 설명서의 [서비스 제어 정책](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html)을 참조하세요.**
+ **리소스 제어 정책(RCP)** – 계정의 리소스에 사용할 수 있는 최대 권한을 설정합니다. 자세한 내용은 *AWS Organizations사용 설명서*의 [리소스 제어 정책(RCP)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_rcps.html)을 참조하세요.
+ **세션 정책** – 역할 또는 페더레이션 사용자에 대해 임시 세션을 프로그래밍 방식으로 생성할 때 파라미터로 전달하는 고급 정책입니다. 자세한 내용은 *IAM 사용자 설명서*의 [세션 정책](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session)을 참조하세요.
### 여러 정책 유형
여러 정책 유형이 요청에 적용되는 경우, 결과 권한은 이해하기가 더 복잡합니다. 여러 정책 유형이 관련될 때 AWS가 요청을 허용할지 여부를 결정하는 방법을 알아보려면 *IAM 사용 설명서*의 [정책 평가 로직](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html)을 참조하세요.
# Amazon API Gateway에서 IAM을 사용하는 방식
IAM을 사용하여 API Gateway에 대한 액세스를 관리하기 전에 API Gateway에서 사용할 수 있는 IAM 기능을 이해해야 합니다. API Gateway 및 기타 AWS 서비스에서 IAM을 사용하는 방법을 전체적으로 알아보려면 *IAM 사용 설명서*의 [IAM으로 작업하는 AWS 서비스](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)를 참조하세요.
**Topics**
+ [API Gateway 자격 증명 기반 정책](#security_iam_service-with-iam-id-based-policies)
+ [API Gateway 리소스 기반 정책](#security_iam_service-with-iam-resource-based-policies)
+ [API Gateway 태그 기반 권한 부여](#security_iam_service-with-iam-tags)
+ [API Gateway IAM 역할](#security_iam_service-with-iam-roles)
## API Gateway 자격 증명 기반 정책
IAM 자격 증명 기반 정책을 사용하면 허용되거나 거부되는 작업과 리소스뿐 아니라 작업이 허용되거나 거부되는 조건을 지정할 수 있습니다. API Gateway는 특정 작업, 리소스 및 조건 키를 지원합니다. API Gateway 관련 작업, 리소스 및 조건 키에 대한 자세한 내용은 [Amazon API Gateway Management에 사용되는 작업, 리소스 및 조건 키](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigatewaymanagement.html) 및 [Amazon API Gateway Management V2에 사용되는 작업, 리소스 및 조건 키](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigatewaymanagementv2.html)를 참조하세요. JSON 정책에서 사용하는 모든 요소에 대한 자세한 내용은 *IAM 사용 설명서*의 [IAM JSON 정책 요소 참조](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html)를 참조합니다.
다음 예제에서는 사용자가 프라이빗 REST API만 생성하거나 업데이트할 수 있도록 허용하는 자격 증명 기반 정책을 보여 줍니다. 더 많은 예제는 [Amazon API Gateway 자격 증명 기반 정책 예제](security_iam_id-based-policy-examples.md)를 참조합니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "ScopeToPrivateApis",
"Effect": "Allow",
"Action": [
"apigateway:PATCH",
"apigateway:POST",
"apigateway:PUT"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/restapis",
"arn:aws:apigateway:us-east-1::/restapis/??????????"
],
"Condition": {
"ForAllValues:StringEqualsIfExists": {
"apigateway:Request/EndpointType": "PRIVATE",
"apigateway:Resource/EndpointType": "PRIVATE"
}
}
},
{
"Sid": "AllowResourcePolicyUpdates",
"Effect": "Allow",
"Action": [
"apigateway:UpdateRestApiPolicy"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/restapis/*"
]
}
]
}
```
------
### 작업
JSON 정책의 `Action` 요소는 정책에서 액세스를 허용하거나 거부하는 데 사용할 수 있는 작업을 설명합니다.
API Gateway의 정책 작업은 작업 앞에 `apigateway:` 접두사를 사용합니다. 정책 설명에는 `Action` 또는 `NotAction` 요소가 반드시 추가되어야 합니다. API Gateway는 이 서비스로 수행할 수 있는 작업을 설명하는 고유한 작업 세트를 정의합니다.
API 관리 `Action` 표현식은 `apigateway:action` 형식을 갖습니다. 여기서 *action*은 API Gateway 작업 **GET**, **POST**, **PUT**, **DELETE**, **PATCH**(리소스 업데이트용) 또는 **\$1**(모든 이전 작업) 중 하나입니다.
다음은 `Action` 표현식의 몇 가지 예입니다.
+ **apigateway:\$1**: 모든 API Gateway 작업
+ **apigateway:GET**: API Gateway의 GET 작업만
명령문 하나에 여러 작업을 지정하려면 다음과 같이 쉼표로 구분합니다.
```
"Action": [
"apigateway:action1",
"apigateway:action2"
```
특정 API Gateway 작업에 사용할 HTTP 동사에 대한 자세한 내용은 [Amazon API Gateway 버전 1 API 참조](https://docs.aws.amazon.com/apigateway/api-reference/)(REST API) 및 [Amazon API Gateway 버전 2 API 참조](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/api-reference.html)(WebSocket 및 HTTP API)를 참조하세요.
자세한 내용은 [Amazon API Gateway 자격 증명 기반 정책 예제](security_iam_id-based-policy-examples.md) 섹션을 참조하세요.
### 리소스
관리자는 AWS JSON 정책을 사용하여 누가 무엇에 액세스할 수 있는지를 지정할 수 있습니다. 즉, 어떤 **보안 주체**가 어떤 **리소스**와 어떤 **조건**에서 **작업**을 수행할 수 있는지를 지정할 수 있습니다.
`Resource` JSON 정책 요소는 작업이 적용되는 하나 이상의 객체를 지정합니다. 모범 사례에 따라 [Amazon 리소스 이름(ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)을 사용하여 리소스를 지정합니다. 리소스 수준 권한을 지원하지 않는 작업의 경우, 와일드카드(\$1)를 사용하여 해당 문이 모든 리소스에 적용됨을 나타냅니다.
```
"Resource": "*"
```
API Gateway 리소스에는 다음과 같은 ARN 형식이 있습니다.
```
arn:aws:apigateway:region::resource-path-specifier
```
예를 들어, ID *`api-id`*와 하위 리소스(예: 명령문의 권한 부여자)가 있는 REST API를 지정하려면 다음 ARN을 사용합니다.
```
"Resource": "arn:aws:apigateway:us-east-2::/restapis/api-id/*"
```
특정 계정에 속하는 모든 REST API 및 하위 리소스를 지정하려면 와일드카드(\$1)를 사용합니다.
```
"Resource": "arn:aws:apigateway:us-east-2::/restapis/*"
```
API Gateway 리소스 유형 및 해당 ARN 목록은 [API Gateway Amazon 리소스 이름(ARN) 참조](arn-format-reference.md) 단원을 참조하세요.
### 조건 키
관리자는 AWSJSON 정책을 사용하여 누가 무엇에 액세스할 수 있는지를 지정할 수 있습니다. 즉, 어떤 **보안 주체**가 어떤 **리소스**와 어떤 **조건**에서 **작업**을 수행할 수 있는지를 지정할 수 있습니다.
`Condition` 요소는 정의된 기준에 따라 문이 실행되는 시기를 지정합니다. 같음(equals) 또는 미만(less than)과 같은 [조건 연산자](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html)를 사용하여 정책의 조건을 요청의 값과 일치시키는 조건식을 생성할 수 있습니다. 모든 AWS 전역 조건 키를 보려면 *IAM 사용자 설명서*의 [AWS 전역 조건 컨텍스트 키](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html)를 참조하세요.
API Gateway는 자체 조건 키 세트를 정의하고 일부 전역 조건 키 사용도 지원합니다. API Gateway 조건 키 목록은 *IAM 사용 설명서*의 [Amazon API Gateway의 조건 키](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_manageamazonapigateway.html#manageamazonapigateway-policy-keys)를 참조하세요. 조건 키를 사용할 수 있는 작업과 리소스에 대한 내용은 [Amazon API Gateway에서 정의한 작업](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_manageamazonapigateway.html#amazonapigateway-actions-as-permissions)을 참조하세요.
속성 기반 액세스 제어를 포함하여 태그 지정에 대한 자세한 내용은 [API Gateway 리소스 태그 지정](apigateway-tagging.md) 섹션을 참조하세요.
### 예제
API Gateway 자격 증명 기반 정책의 예는 [Amazon API Gateway 자격 증명 기반 정책 예제](security_iam_id-based-policy-examples.md) 단원을 참조하세요.
## API Gateway 리소스 기반 정책
리소스 기반 정책은 지정된 보안 주체가 API Gateway 리소스에 대해 어떤 작업을 어떤 조건에서 수행할 수 있는지를 지정하는 JSON 정책 문서입니다. API Gateway는 REST API에 대한 리소스 기반 권한 정책을 지원합니다. 리소스 정책을 사용하여 REST API를 호출할 수 있는 사용자를 제어합니다. 자세한 내용은 [API Gateway 리소스 정책을 사용하여 REST API에 대한 액세스 제어](apigateway-resource-policies.md) 섹션을 참조하세요.
### 예제
API Gateway 리소스 기반 정책의 예는 [API Gateway 리소스 정책 예제](apigateway-resource-policies-examples.md) 단원을 참조하세요.
## API Gateway 태그 기반 권한 부여
API Gateway 리소스에 태그를 연결하거나 요청에서 태그를 API Gateway에 전달할 수 있습니다. 태그를 기반으로 액세스를 제어하려면 `apigateway:ResourceTag/key-name`, `aws:RequestTag/key-name` 또는 `aws:TagKeys` 조건 키를 사용하여 정책의 [조건 요소](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html)에 태그 정보를 제공합니다. API Gateway 리소스에 태그를 지정하는 방법에 대한 자세한 내용은 [태그를 사용하여 API Gateway REST API 리소스에 대한 액세스 제어](apigateway-tagging-iam-policy.md) 단원을 참조하십시오.
리소스의 태그를 기반으로 리소스에 대한 액세스를 제한하는 자격 증명 기반 정책의 예는 [태그를 사용하여 API Gateway REST API 리소스에 대한 액세스 제어](apigateway-tagging-iam-policy.md) 단원을 참조하세요.
## API Gateway IAM 역할
[IAM 역할](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)은 특정 권한을 가지고 있는 AWS 계정 내 개체입니다.
### API Gateway에 임시 자격 증명 사용
임시 자격 증명을 사용하여 페더레이션을 통해 로그인하거나, IAM 역할을 맡거나, 교차 계정 역할을 맡을 수 있습니다. [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) 또는 [GetFederationToken](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetFederationToken.html) 같은 AWS STS API 작업을 호출하여 임시 보안 자격 증명을 가져옵니다.
API Gateway는 임시 자격 증명 사용을 지원합니다.
### 서비스 연결 역할
[서비스 연결 역할](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role)을 사용하면 AWS 서비스에서 다른 서비스의 리소스에 액세스하여 사용자 대신 작업을 완료할 수 있습니다. 서비스 연결 역할은 IAM 계정에 나타나고 서비스가 소유합니다. IAM 관리자는 서비스 연결 역할의 권한을 볼 수 있지만 편집은 할 수 없습니다.
API Gateway는 서비스 연결 역할을 지원합니다. API Gateway 서비스 연결 역할을 생성하거나 관리하는 방법에 대한 자세한 내용은 [API Gateway에 서비스 연결 역할 사용](using-service-linked-roles.md) 단원을 참조하세요.
### 서비스 역할
서비스가 귀하를 대신해 [서비스 역할](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-role)을 맡을 수 있습니다. 서비스 역할을 사용하면 서비스는 다른 서비스의 리소스에 액세스해 사용자를 대신해 작업을 완료할 수 있습니다. 서비스 역할은 IAM 계정에 표시되며 계정에서 소유하므로 관리자가 이 역할에 대한 권한을 변경할 수 있습니다. 그러나 권한을 변경하면 서비스의 기능이 손상될 수 있습니다.
API Gateway는 서비스 역할을 지원합니다.
# Amazon API Gateway 자격 증명 기반 정책 예제
기본적으로 IAM 사용자 및 역할은 API Gateway 리소스를 생성하거나 수정할 수 있는 권한이 없습니다. 또한 AWS Management Console, AWS CLI 또는 AWS SDK를 사용해 작업을 수행할 수 없습니다. IAM 관리자는 지정된 리소스에서 특정 API 작업을 수행할 수 있는 권한을 사용자와 역할에게 부여하는 IAM 정책을 생성해야 합니다. 그런 다음 관리자는 해당 권한이 필요한 IAM 사용자 또는 그룹에 이러한 정책을 연결해야 합니다.
IAM 정책을 생성하는 방법에 대한 자세한 내용은 *IAM 사용 설명서*의 [JSON 탭에서 정책 생성](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html#access_policies_create-json-editor)을 참조하세요. API Gateway 관련 작업, 리소스 및 조건에 대한 자세한 내용은 [Amazon API Gateway Management에 사용되는 작업, 리소스 및 조건 키](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigatewaymanagement.html) 및 [Amazon API Gateway Management V2에 사용되는 작업, 리소스 및 조건 키](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigatewaymanagementv2.html)를 참조하세요.
**Topics**
+ [정책 모범 사례](#security_iam_service-with-iam-policy-best-practices)
+ [사용자가 자신의 고유한 권한을 볼 수 있도록 허용](#security_iam_id-based-policy-examples-view-own-permissions)
+ [단순 읽기 권한](#api-gateway-policy-example-apigateway-general)
+ [REQUEST 또는 JWT 권한 부여자만 생성](#security_iam_id-based-policy-examples-v2-import)
+ [기본 `execute-api` 엔드포인트가 비활성화되어 있어야 함](#security_iam_id-based-policy-examples-v2-endpoint-status)
+ [사용자가 프라이빗 REST API만 생성하거나 업데이트할 수 있도록 허용](#security_iam_id-based-policy-examples-private-api)
+ [API 경로에 권한이 있어야 함](#security_iam_id-based-policy-examples-require-authorization)
+ [사용자가 VPC 링크를 생성하거나 업데이트하지 못하도록 방지](#security_iam_id-based-policy-examples-deny-vpc-link)
+ [라우팅 규칙 사용에 대한 정책 예제](#security_iam_id-based-policy-examples-routing-mode)
## 정책 모범 사례
ID 기반 정책에 따라 계정에서 사용자가 API Gateway 리소스를 생성, 액세스 또는 삭제할 수 있는지 여부가 결정됩니다. 이 작업으로 인해 AWS 계정에 비용이 발생할 수 있습니다. 자격 증명 기반 정책을 생성하거나 편집할 때는 다음 지침과 권장 사항을 따르세요.
+ **AWS 관리형 정책으로 시작하고 최소 권한을 향해 나아가기** - 사용자 및 워크로드에 권한 부여를 시작하려면 많은 일반 사용 사례에 대한 권한을 부여하는 *AWS관리형 정책*을 사용합니다. AWS 계정에서 사용할 수 있습니다. 사용 사례에 고유한 AWS고객 관리형 정책을 정의하여 권한을 줄이는 것이 좋습니다. 자세한 내용은 *IAM 사용자 설명서*의 [AWS 관리형 정책](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) 또는 [AWS직무에 대한 관리형 정책](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html)을 참조하세요.
+ **최소 권한 적용** – IAM 정책을 사용하여 권한을 설정하는 경우, 작업을 수행하는 데 필요한 권한만 부여합니다. 이렇게 하려면 *최소 권한*으로 알려진 특정 조건에서 특정 리소스에 대해 수행할 수 있는 작업을 정의합니다. IAM을 사용하여 권한을 적용하는 방법에 대한 자세한 정보는 *IAM 사용자 설명서*에 있는 [IAM의 정책 및 권한](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)을 참조하세요.
+ **IAM 정책의 조건을 사용하여 액세스 추가 제한** – 정책에 조건을 추가하여 작업 및 리소스에 대한 액세스를 제한할 수 있습니다. 예를 들어, SSL을 사용하여 모든 요청을 전송해야 한다고 지정하는 정책 조건을 작성할 수 있습니다. CloudFormation와 같이, 특정 AWS 서비스를 통해 사용되는 경우에만 서비스 작업에 대한 액세스 권한을 부여할 수도 있습니다. 자세한 내용은 *IAM 사용자 설명서*의 [IAM JSON 정책 요소: 조건](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html)을 참조하세요.
+ **IAM Access Analyzer를 통해 IAM 정책을 확인하여 안전하고 기능적인 권한 보장** - IAM Access Analyzer에서는 IAM 정책 언어(JSON)와 모범 사례가 정책에서 준수되도록 새로운 및 기존 정책을 확인합니다. IAM Access Analyzer는 100개 이상의 정책 확인 항목과 실행 가능한 추천을 제공하여 안전하고 기능적인 정책을 작성하도록 돕습니다. 자세한 내용은 *IAM 사용자 설명서*의 [IAM Access Analyzer에서 정책 검증](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-validation.html)을 참조하세요.
+ **다중 인증(MFA) 필요** – AWS 계정에 IAM 사용자 또는 루트 사용자가 필요한 시나리오가 있는 경우, 추가 보안을 위해 MFA를 설정합니다. API 작업을 직접적으로 호출할 때 MFA가 필요하면 정책에 MFA 조건을 추가합니다. 자세한 내용은 *IAM 사용자 설명서*의 [MFA를 통한 보안 API 액세스](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_configure-api-require.html)를 참조하세요.
IAM의 모범 사례에 대한 자세한 내용은 *IAM 사용자 설명서*의 [IAM의 보안 모범 사례](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html)를 참조하세요.
## 사용자가 자신의 고유한 권한을 볼 수 있도록 허용
이 예제는 IAM 사용자가 자신의 사용자 ID에 연결된 인라인 및 관리형 정책을 볼 수 있도록 허용하는 정책을 생성하는 방법을 보여줍니다. 이 정책에는 콘솔에서 또는 AWS CLI나 AWS API를 사용하여 프로그래밍 방식으로 이 작업을 완료할 수 있는 권한이 포함됩니다.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "ViewOwnUserInfo",
"Effect": "Allow",
"Action": [
"iam:GetUserPolicy",
"iam:ListGroupsForUser",
"iam:ListAttachedUserPolicies",
"iam:ListUserPolicies",
"iam:GetUser"
],
"Resource": ["arn:aws:iam::*:user/${aws:username}"]
},
{
"Sid": "NavigateInConsole",
"Effect": "Allow",
"Action": [
"iam:GetGroupPolicy",
"iam:GetPolicyVersion",
"iam:GetPolicy",
"iam:ListAttachedGroupPolicies",
"iam:ListGroupPolicies",
"iam:ListPolicyVersions",
"iam:ListPolicies",
"iam:ListUsers"
],
"Resource": "*"
}
]
}
```
## 단순 읽기 권한
이 예제 정책은 us-east-1의 AWS 리전에서 `a123456789`의 식별자를 사용하여 HTTP 또는 WebSocket API의 모든 리소스에 대한 정보를 가져올 수 있는 권한을 사용자에게 부여합니다. 리소스 `arn:aws:apigateway:us-east-1::/apis/a123456789/*`에는 권한 부여자 및 배포와 같은 API의 모든 하위 리소스가 포함됩니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"apigateway:GET"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/apis/a123456789/*"
]
}
]
}
```
------
## REQUEST 또는 JWT 권한 부여자만 생성
이 예제 정책은 사용자가 [가져오기](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#ImportApi)를 포함하여 `REQUEST` 또는 `JWT` 권한 부여자로만 API를 생성할 수 있도록 허용합니다. 정책의 `Resource` 섹션에서 `arn:aws:apigateway:us-east-1::/apis/??????????`에 따라 리소스에는 최대 10자(API의 하위 리소스 제외)를 포함해야 합니다. 이 예제에서는 사용자가 API를 가져와서 한 번에 여러 권한 부여자를 생성할 수 있기 때문에 `ForAllValues` 섹션에서 `Condition`을 사용합니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "OnlyAllowSomeAuthorizerTypes",
"Effect": "Allow",
"Action": [
"apigateway:PUT",
"apigateway:POST",
"apigateway:PATCH"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/apis",
"arn:aws:apigateway:us-east-1::/apis/??????????",
"arn:aws:apigateway:us-east-1::/apis/*/authorizers",
"arn:aws:apigateway:us-east-1::/apis/*/authorizers/*"
],
"Condition": {
"ForAllValues:StringEqualsIfExists": {
"apigateway:Request/AuthorizerType": [
"REQUEST",
"JWT"
]
}
}
}
]
}
```
------
## 기본 `execute-api` 엔드포인트가 비활성화되어 있어야 함
이 예제 정책은 사용자가 `DisableExecuteApiEndpoint`가 `true`인 요구 사항을 사용하여 API를 생성, 업데이트 또는 가져올 수 있도록 허용합니다. `DisableExecuteApiEndpoint`가 `true`인 경우 클라이언트는 API를 호출하는 데 기본 `execute-api` 엔드포인트를 사용할 수 없습니다.
`BoolIfExists` 조건을 사용하여 `DisableExecuteApiEndpoint` 조건 키가 채워지지 않은 API를 업데이트하는 호출을 처리합니다. 사용자가 API를 생성하거나 가져오려고 하면 `DisableExecuteApiEndpoint` 조건 키가 항상 채워집니다.
`apis/*` 리소스는 권한 부여자나 메서드와 같은 하위 리소스도 캡처하므로 `Deny` 명령문을 통해 API만 사용하도록 명시적으로 범위를 지정합니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "DisableExecuteApiEndpoint",
"Effect": "Allow",
"Action": [
"apigateway:PATCH",
"apigateway:POST",
"apigateway:PUT"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/apis",
"arn:aws:apigateway:us-east-1::/apis/*"
],
"Condition": {
"BoolIfExists": {
"apigateway:Request/DisableExecuteApiEndpoint": true
}
}
},
{
"Sid": "ScopeDownToJustApis",
"Effect": "Deny",
"Action": [
"apigateway:PATCH",
"apigateway:POST",
"apigateway:PUT"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/apis/*/*"
]
}
]
}
```
------
## 사용자가 프라이빗 REST API만 생성하거나 업데이트할 수 있도록 허용
이 예제 정책은 조건 키를 사용하여 사용자가 `PRIVATE` API만 생성하도록 요구하고 API를 `PRIVATE`에서 다른 유형(예: `REGIONAL`)으로 변경할 수 있는 업데이트를 방지합니다.
`ForAllValues`는 API에 추가된 모든 `EndpointType`이 `PRIVATE`여야 한다고 요구하기 위해 사용합니다. `PRIVATE`인 경우에 한해 리소스 조건 키를 사용하여 API에 대한 업데이트를 허용합니다. `ForAllValues`는 조건 키가 있는 경우에만 적용됩니다.
비API 리소스(예: 권한 부여자) 허용을 방지하기 위해 최소 일치(`?`)를 사용하여 API ID에 대해 명시적으로 일치시킵니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "ScopePutToPrivateApis",
"Effect": "Allow",
"Action": [
"apigateway:PUT"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/restapis",
"arn:aws:apigateway:us-east-1::/restapis/??????????"
],
"Condition": {
"ForAllValues:StringEquals": {
"apigateway:Resource/EndpointType": "PRIVATE"
}
}
},
{
"Sid": "ScopeToPrivateApis",
"Effect": "Allow",
"Action": [
"apigateway:DELETE",
"apigateway:PATCH",
"apigateway:POST"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/restapis",
"arn:aws:apigateway:us-east-1::/restapis/??????????"
],
"Condition": {
"ForAllValues:StringEquals": {
"apigateway:Request/EndpointType": "PRIVATE",
"apigateway:Resource/EndpointType": "PRIVATE"
}
}
},
{
"Sid": "AllowResourcePolicyUpdates",
"Effect": "Allow",
"Action": [
"apigateway:UpdateRestApiPolicy"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/restapis/*"
]
}
]
}
```
------
## API 경로에 권한이 있어야 함
이 정책은 경로에 권한이 없는 경우 경로를 생성하거나 업데이트하려는 시도([가져오기](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#ImportApi)를 통한 시도 포함)가 실패하게 합니다. `ForAnyValue`은(는) 경로가 생성되거나 업데이트되지 않는 경우와 같이 키가 없으면 false로 평가됩니다. 가져오기를 통해 여러 경로를 생성할 수 있기 때문에 `ForAnyValue`을(를) 사용합니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "AllowUpdatesOnApisAndRoutes",
"Effect": "Allow",
"Action": [
"apigateway:POST",
"apigateway:PATCH",
"apigateway:PUT"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/apis",
"arn:aws:apigateway:us-east-1::/apis/??????????",
"arn:aws:apigateway:us-east-1::/apis/*/routes",
"arn:aws:apigateway:us-east-1::/apis/*/routes/*"
]
},
{
"Sid": "DenyUnauthorizedRoutes",
"Effect": "Deny",
"Action": [
"apigateway:POST",
"apigateway:PATCH",
"apigateway:PUT"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/apis",
"arn:aws:apigateway:us-east-1::/apis/*"
],
"Condition": {
"ForAnyValue:StringEqualsIgnoreCase": {
"apigateway:Request/RouteAuthorizationType": "NONE"
}
}
}
]
}
```
------
## 사용자가 VPC 링크를 생성하거나 업데이트하지 못하도록 방지
이 정책은 사용자가 VPC 링크를 생성하거나 업데이트하는 것을 방지합니다. VPC 링크를 사용하면 Amazon VPC 내의 리소스를 VPC 외부의 클라이언트에 노출할 수 있습니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "DenyVPCLink",
"Effect": "Deny",
"Action": [
"apigateway:POST",
"apigateway:PUT",
"apigateway:PATCH"
],
"Resource": [
"arn:aws:apigateway:us-east-1::/vpclinks",
"arn:aws:apigateway:us-east-1::/vpclinks/*"
]
}
]
}
```
------
## 라우팅 규칙 사용에 대한 정책 예제
다음 예제 정책은 사용자가 사용자 지정 도메인 이름에서 REST API로 트래픽을 어떻게 라우팅할 수 있는지 RoutingRule 조건 키를 사용하여 제어하는 방법을 보여줍니다. 이러한 예제를 사용하여 사용자가 만들 수 있는 라우팅 규칙의 종류에 대한 세분화된 정책을 생성할 수 있습니다. 자세한 내용은 [API 스테이지를 REST API의 사용자 지정 도메인 이름에 연결하는 라우팅 규칙](rest-api-routing-rules.md) 섹션을 참조하세요.
### 사용자가 사용자 지정 도메인 이름이 요청을 라우팅하는 방법을 변경하지 못하도록 방지
이 정책은 사용자가 `BasePathMapping`, `ApiMapping` 또는 `RoutingRule`을 만들거나 업데이트하는 것을 방지합니다. 이러한 모든 리소스는 사용자 지정 도메인 이름이 요청을 API로 라우팅하는 방식을 변경할 수 있습니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "DenyAccessBasePathMappingsApiMappingsRoutingRules",
"Effect": "Deny",
"Action": "apigateway:*",
"Resource": [
"arn:aws:apigateway:us-east-1::/domainnames/example.com/basepathmappings/*",
"arn:aws:apigateway:us-east-1::/domainnames/example.com/apimappings/*",
"arn:aws:apigateway:us-east-1:111122223333:/domainnames/example.com/routingrules/*"
]
}
]
}
```
------
### 사용자가 특정 우선 순위로 라우팅 규칙을 업데이트하도록 허용
이 정책은 사용자가 라우팅 규칙을 1001에서 2000 사이의 우선 순위로만 업데이트할 수 있도록 허용합니다. 이 규칙을 사용하여 프로덕션 규칙을 우선 순위가 낮은 규칙과 분리할 수 있습니다. 그러면 사용자가 프로덕션 규칙에 영향을 주지 않고 우선 순위가 낮은 규칙을 수정할 수 있습니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "UpdatingRoutingRulePriorityBetween1001And2000",
"Effect": "Allow",
"Action": "apigateway:UpdateRoutingRule",
"Resource": "arn:aws:apigateway:us-east-1:111122223333:/domainnames/example.com/routingrules/*",
"Condition": {
"NumericGreaterThanEquals": {
"apigateway:Resource/Priority": 1001,
"apigateway:Request/Priority": 1001
},
"NumericLessThanEquals": {
"apigateway:Resource/Priority": 2000,
"apigateway:Request/Priority": 2000
}
}
}
]
}
```
------
### 사용자가 특정 기본 경로 값에 대한 라우팅 규칙 또는 기본 경로 매핑을 업데이트하도록 허용
이 정책은 사용자가 `orders`로 시작하는 기본 경로에 대한 기본 경로 매핑만 업데이트하거나 `orders`로 시작하는 기본 경로와 일치하는 라우팅 규칙을 업데이트할 수 있도록 허용합니다. 이 정책에서 사용자는 `orders/create` 또는 `orders123`에 대한 기본 경로 매핑 또는 라우팅 규칙을 업데이트할 수 있지만, `payment/orders`에 대한 기본 경로 매핑 또는 라우팅 규칙은 업데이트할 수 없습니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "AllowUpdateRoutingRuleUnderPathOrders",
"Effect": "Allow",
"Action": "apigateway:UpdateRoutingRule",
"Resource": "arn:aws:apigateway:us-east-1:111122223333:/domainnames/example.com/routingrules/*",
"Condition": {
"ForAllValues:StringLike": {
"apigateway:Request/ConditionBasePaths": ["orders*"],
"apigateway:Resource/ConditionBasePaths": ["orders*"]
},
"Null":{
"apigateway:Request/ConditionBasePaths":"false",
"apigateway:Resource/ConditionBasePaths":"false"
}
}
}
]
}
```
------
### 사용자가 라우팅 모드를 특정 값으로 업데이트하도록 허용
이 정책은 사용자가 라우팅 모드를 `API_MAPPING_ONLY` 및 `ROUTING_RULE_THEN_API_MAPPING`으로만 업데이트할 수 있도록 허용합니다. 라우팅 모드에 대한 자세한 내용은 [사용자 지정 도메인 이름의 라우팅 모드 설정](set-routing-mode.md) 섹션을 참조하세요.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "AllowUpdateRoutingModeToAnythingWithApiMapping",
"Effect": "Allow",
"Action": ["apigateway:PATCH"],
"Resource": "arn:aws:apigateway:us-east-1::/domainnames/example.com",
"Condition": {
"StringLike": {
"apigateway:Request/RoutingMode":"*API_MAPPING*"
}
}
}
]
}
```
------
# Amazon API Gateway 리소스 기반 정책 예제
리소스 기반 정책 예제는 [API Gateway 리소스 정책 예제](apigateway-resource-policies-examples.md) 단원을 참조하십시오.
# Amazon API Gateway 자격 증명 및 액세스 문제 해결
다음 정보를 사용하여 API Gateway 및 IAM으로 작업할 때 발생할 수 있는 일반적인 문제를 진단하고 수정할 수 있습니다.
**Topics**
+ [API Gateway에서 작업을 수행할 권한이 없음](#security_iam_troubleshoot-no-permissions)
+ [iam:PassRole을 수행하도록 인증되지 않음](#security_iam_troubleshoot-passrole)
+ [AWS 계정 외부의 사용자가 API Gateway 리소스에 액세스할 수 있도록 허용하려고 함](#security_iam_troubleshoot-cross-account-access)
## API Gateway에서 작업을 수행할 권한이 없음
작업을 수행할 권한이 없다는 오류가 표시되면 작업을 수행할 수 있도록 정책을 업데이트해야 합니다.
다음의 예제 오류는 `mateojackson` IAM 사용자가 콘솔을 사용하여 가상 `my-example-widget` 리소스에 대한 세부 정보를 보려고 하지만 가상 `apigateway:GetWidget` 권한이 없을 때 발생합니다.
```
User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: apigateway:GetWidget on resource: my-example-widget because no identity-based policy allows the GetWidget action
```
이 경우, `apigateway:GetWidget` 작업을 사용하여 `my-example-widget` 리소스에 액세스할 수 있도록 `mateojackson` 사용자 정책을 업데이트해야 합니다.
도움이 필요한 경우 AWS 관리자에게 문의하세요. 관리자는 로그인 자격 증명을 제공한 사람입니다.
## iam:PassRole을 수행하도록 인증되지 않음
`iam:PassRole` 작업을 수행할 수 있는 권한이 없다는 오류가 수신되면 API Gateway에 역할을 전달할 수 있도록 정책을 업데이트해야 합니다.
일부 AWS 서비스에서는 새로운 서비스 역할 또는 서비스 연결 역할을 생성하는 대신 해당 서비스에 기존 역할을 전달할 수 있습니다. 이렇게 하려면 사용자가 서비스에 역할을 전달할 수 있는 권한을 가지고 있어야 합니다.
다음 예제 오류는 `marymajor`라는 IAM 사용자가 콘솔을 사용하여 API Gateway에서 작업을 수행하려고 하는 경우에 발생합니다. 하지만 작업을 수행하려면 서비스 역할이 부여한 권한이 서비스에 있어야 합니다. Mary는 서비스에 역할을 전달할 수 있는 권한을 가지고 있지 않습니다.
```
User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole
```
이 경우, Mary가 `iam:PassRole`작업을 수행할 수 있도록 Mary의 정책을 업데이트해야 합니다.
도움이 필요한 경우 AWS관리자에게 문의하세요. 관리자는 로그인 자격 증명을 제공한 사람입니다.
## AWS 계정 외부의 사용자가 API Gateway 리소스에 액세스할 수 있도록 허용하려고 함
다른 계정의 사용자 또는 조직 외부의 사람이 리소스에 액세스하는 데 사용할 수 있는 역할을 생성할 수 있습니다. 역할을 수임할 신뢰할 수 있는 사람을 지정할 수 있습니다. 리소스 기반 정책 또는 액세스 제어 목록(ACL)을 지원하는 서비스의 경우, 이러한 정책을 사용하여 다른 사람에게 리소스에 대한 액세스 권한을 부여할 수 있습니다.
자세히 알아보려면 다음을 참조하십시오.
+ API Gateway가 이러한 기능을 지원하는지 여부를 알아보려면 [Amazon API Gateway에서 IAM을 사용하는 방식](security_iam_service-with-iam.md) 단원을 참조하세요.
+ 소유하고 있는 AWS 계정의 리소스에 대한 액세스 권한을 제공하는 방법을 알아보려면 *IAM 사용 설명서*의 [자신이 소유한 다른 AWS 계정의 IAM 사용자에 대한 액세스 권한 제공](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_aws-accounts.html)을 참조하세요.
+ 리소스에 대한 액세스 권한을 서드 파티 AWS 계정에게 제공하는 방법을 알아보려면 *IAM 사용자 설명서*의 [서드 파티가 소유한 AWS 계정에 대한 액세스 제공](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html)을 참조하세요.
+ ID 페더레이션을 통해 액세스 권한을 제공하는 방법을 알아보려면 *IAM 사용자 설명서*의 [외부에서 인증된 사용자에게 액세스 권한 제공(ID 페더레이션)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_federated-users.html)을 참조하세요.
+ 크로스 계정 액세스에 대한 역할과 리소스 기반 정책 사용의 차이점을 알아보려면 *IAM 사용자 설명서*의 [IAM의 크로스 계정 리소스 액세스](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-cross-account-resource-access.html)를 참조하세요.
# API Gateway에 서비스 연결 역할 사용
Amazon API Gateway는 AWS Identity and Access Management(IAM) [서비스 연결 역할](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role)을 사용합니다. 서비스 연결 역할은 API Gateway에 직접 연결된 고유한 유형의 IAM 역할입니다. 서비스 연결 역할은 API Gateway에서 사전 정의하며, 서비스에서 사용자를 대신하여 다른 AWS 서비스를 호출하기 위해 필요한 모든 권한을 포함합니다.
서비스 연결 역할을 사용하면 필요한 권한을 수동으로 추가할 필요가 없으므로 API Gateway를 더 쉽게 설정할 수 있습니다. API Gateway에서 서비스 연결 역할의 권한을 정의하므로 다르게 정의되지 않은 한, API Gateway만 해당 역할을 수임할 수 있습니다. 정의된 권한에는 신뢰 정책과 권한 정책이 포함되며, 이 권한 정책은 다른 IAM 엔터티에 연결할 수 없습니다.
먼저 관련 리소스를 삭제한 후에만 서비스 연결 역할을 삭제할 수 있습니다. 이렇게 하면 리소스에 대한 액세스 권한을 실수로 삭제할 수 없기 때문에 API Gateway 리소스가 보호됩니다.
서비스 연결 역할을 지원하는 기타 서비스에 대한 자세한 내용은 [IAM으로 작업하는 AWS 서비스](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) 섹션을 참조하고 **서비스 연결 역할** 열에 **예**가 있는 서비스를 찾습니다. 해당 서비스에 대한 서비스 연결 역할 설명서를 보려면 **예** 링크를 선택합니다.
## API Gateway에 대한 서비스 연결 역할 권한
API Gateway는 **AWSServiceRoleForAPIGateway**라는 서비스 연결 역할을 사용합니다. 이 역할을 사용하면 API Gateway가 사용자를 대신하여 Elastic Load Balancing, Amazon Data Firehose 및 기타 서비스 리소스에 액세스할 수 있습니다.
AWSServiceRoleForAPIGateway 서비스 연결 역할은 역할을 수임하기 위해 다음 서비스를 신뢰합니다.
+ `ops.apigateway.amazonaws.com`
역할 권한 정책은 API Gateway가 지정된 리소스에서 다음 작업을 완료하도록 허용합니다.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticloadbalancing:AddListenerCertificates",
"elasticloadbalancing:RemoveListenerCertificates",
"elasticloadbalancing:ModifyListener",
"elasticloadbalancing:DescribeListeners",
"elasticloadbalancing:DescribeLoadBalancers",
"xray:PutTraceSegments",
"xray:PutTelemetryRecords",
"xray:GetSamplingTargets",
"xray:GetSamplingRules",
"logs:CreateLogDelivery",
"logs:GetLogDelivery",
"logs:UpdateLogDelivery",
"logs:DeleteLogDelivery",
"logs:ListLogDeliveries",
"servicediscovery:DiscoverInstances"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"firehose:DescribeDeliveryStream",
"firehose:PutRecord",
"firehose:PutRecordBatch"
],
"Resource": "arn:aws:firehose:*:*:deliverystream/amazon-apigateway-*"
},
{
"Effect": "Allow",
"Action": [
"acm:DescribeCertificate",
"acm:GetCertificate"
],
"Resource": "arn:aws:acm:*:*:certificate/*"
},
{
"Effect": "Allow",
"Action": "ec2:CreateNetworkInterfacePermission",
"Resource": "arn:aws:ec2:*:*:network-interface/*"
},
{
"Effect": "Allow",
"Action": "ec2:CreateTags",
"Resource": "arn:aws:ec2:*:*:network-interface/*",
"Condition": {
"ForAllValues:StringEquals": {
"aws:TagKeys": [
"Owner",
"VpcLinkId"
]
}
}
},
{
"Effect": "Allow",
"Action": [
"ec2:ModifyNetworkInterfaceAttribute",
"ec2:DeleteNetworkInterface",
"ec2:AssignPrivateIpAddresses",
"ec2:CreateNetworkInterface",
"ec2:DeleteNetworkInterfacePermission",
"ec2:DescribeNetworkInterfaces",
"ec2:DescribeAvailabilityZones",
"ec2:DescribeNetworkInterfaceAttribute",
"ec2:DescribeVpcs",
"ec2:DescribeNetworkInterfacePermissions",
"ec2:UnassignPrivateIpAddresses",
"ec2:DescribeSubnets",
"ec2:DescribeRouteTables",
"ec2:DescribeSecurityGroups"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": "servicediscovery:GetNamespace",
"Resource": "arn:aws:servicediscovery:*:*:namespace/*"
},
{
"Effect": "Allow",
"Action": "servicediscovery:GetService",
"Resource": "arn:aws:servicediscovery:*:*:service/*"
}
]
}
```
------
IAM 개체(사용자, 그룹, 역할 등)가 서비스 연결 역할을 작성하고 편집하거나 삭제할 수 있도록 권한을 구성할 수 있습니다. 자세한 내용은 *IAM 사용 설명서*의 [서비스 연결 역할 권한](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#service-linked-role-permissions)을 참조하세요.
## API Gateway에 대한 서비스 연결 역할 생성
서비스 연결 역할은 수동으로 생성할 필요가 없습니다. AWS Management Console, AWS CLI 또는 AWS API에서 API, 사용자 지정 도메인 이름 또는 VPC 링크를 생성하면 API Gateway가 서비스 연결 역할을 자동으로 생성합니다.
이 서비스 연결 역할을 삭제한 다음 다시 생성해야 하는 경우 동일한 프로세스를 사용하여 계정에서 역할을 다시 생성할 수 있습니다. API, 사용자 지정 도메인 이름 또는 VPC 링크를 생성하면 API Gateway가 서비스 연결 역할을 자동으로 다시 생성합니다.
## API Gateway에 대한 서비스 연결 역할 편집
API Gateway에서는 AWSServiceRoleForAPIGateway 서비스 연결 역할을 편집할 수 없습니다. 서비스 연결 역할을 생성한 후에는 다양한 개체가 역할을 참조할 수 있기 때문에 역할 이름을 변경할 수 없습니다. 하지만 IAM을 사용하여 역할의 설명을 편집할 수 있습니다. 자세한 내용은 *IAM 사용 설명서*의 [서비스 연결 역할 편집](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#edit-service-linked-role)을 참조하세요.
## API Gateway에 대한 서비스 연결 역할 삭제
서비스 연결 역할이 필요한 기능 또는 서비스가 더 이상 필요 없는 경우에는 해당 역할을 삭제할 것을 권합니다. 이렇게 하면 적극적으로 모니터링하거나 유지 관리하지 않은 미사용 엔터티가 없습니다. 단, 서비스 연결 역할에 대한 리소스를 먼저 정리해야 수동으로 삭제할 수 있습니다.
**참고**
리소스를 삭제하려고 할 때 API Gateway 서비스가 역할을 사용 중이면 삭제에 실패할 수 있습니다. 이 문제가 발생하면 몇 분 기다렸다가 작업을 다시 시도하십시오.
**AWSServiceRoleForAPIGateway에서 사용하는 API Gateway 리소스를 삭제하려면**
1. [https://console.aws.amazon.com/apigateway/](https://console.aws.amazon.com/apigateway/)에서 Amazon API Gateway 콘솔을 엽니다.
1. 서비스 연결 역할을 사용하는 API, 사용자 지정 도메인 이름 또는 VPC 링크로 이동합니다.
1. 콘솔을 사용하여 리소스를 삭제합니다.
1. 이 절차를 반복하여 서비스 연결 역할을 사용하는 모든 API, 사용자 지정 도메인 이름 또는 VPC 링크를 삭제합니다.
**IAM을 사용하여 수동으로 서비스 연결 역할을 삭제하려면 다음을 수행하세요**
AWS CLI 또는 AWS API를 사용하여 AWSServiceRoleForAPIGateway 서비스 연결 역할을 삭제합니다. 자세한 내용은 *IAM 사용 설명서*의 [서비스 연결 역할 삭제](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role)를 참조하십시오.
## API Gateway 서비스 연결 역할이 지원되는 리전
API Gateway는 서비스가 제공되는 모든 리전에서 서비스 연결 역할을 사용할 수 있도록 지원합니다. 자세한 내용은 [AWS 서비스 엔드포인트](https://docs.aws.amazon.com/general/latest/gr/rande.html)를 참조하십시오.
## API Gateway를 AWS 관리형 정책으로 업데이트
이 서비스가 해당 변경 사항을 추적하기 시작한 이후 API Gateway용 AWS 관리형 정책 업데이트에 대한 세부 정보를 확인합니다. 이 페이지의 변경 사항에 대한 자동 알림을 받아보려면 API Gateway [문서 기록](history.md) 페이지에서 RSS 피드를 구독하세요.
| 변경 사항 | 설명 | 날짜 |
| --- | --- | --- |
| `AWSServiceRoleForAPIGateway` 정책에 `acm:GetCertificate` 지원이 추가되었습니다. | 이 `AWSServiceRoleForAPIGateway` 정책이 ACM `GetCertificate` API 작업 호출 권한을 포함합니다. | 2021년 7월 12일 |
| API Gateway 변경 내용 추적 시작 | API Gateway가 AWS 관리형 정책에 대한 변경 내용 추적을 시작했습니다. | 2021년 7월 12일 |
# Amazon API Gateway에서 로깅 및 모니터링
모니터링은 API Gateway 및 AWS 솔루션의 안정성, 가용성 및 성능을 유지하는 데 중요한 부분입니다. 다중 지점 실패가 발생할 경우 보다 쉽게 디버깅할 수 있도록 AWS 솔루션의 모든 부분으로부터 모니터링 데이터를 수집해야 합니다. AWS는 API Gateway 리소스를 모니터링하고 잠재적 인시던트에 대응하기 위한 여러 도구를 제공합니다.
**Amazon CloudWatch Logs**
요청 실행 또는 API에 대한 클라이언트 액세스와 관련된 문제를 디버깅하기 위해 CloudWatch Logs를 활성화하여 API 호출을 로깅할 수 있습니다. 자세한 내용은 [API Gateway에서 REST API에 대한 CloudWatch 로깅 설정](set-up-logging.md) 단원을 참조하세요.
**Amazon CloudWatch 경보**
CloudWatch 경보를 사용하면 지정한 기간 동안 단일 지표를 감시할 수 있습니다. 지표가 지정된 임계값을 초과하면 Amazon Simple Notification Service 주제 또는 AWS Auto Scaling 정책으로 알림이 전송됩니다. CloudWatch 경보는 지표가 특정 상태에 있다고 해서 작업을 호출하지 않습니다. 대신, 상태가 변경되어 지정된 기간 동안 유지되어야 합니다. 자세한 내용은 [Amazon CloudWatch 지표를 사용한 REST API 실행 모니터링](monitoring-cloudwatch.md) 단원을 참조하십시오.
**Firehose에 대한 액세스 로깅**
API에 대한 클라이언트 액세스와 관련된 문제의 디버깅을 위해 API 직접 호출을 Firehose에 로깅할 수 있습니다. 자세한 내용은 [API Gateway에서 Amazon Data Firehose에 대한 REST API 직접 호출 로깅](apigateway-logging-to-kinesis.md) 단원을 참조하십시오.
**AWS CloudTrail**
CloudTrail은 API Gateway에서 사용자, 역할 또는 AWS 서비스가 수행한 작업의 기록을 제공합니다. CloudTrail에서 수집한 정보를 사용하여 API Gateway에 수행된 요청, 요청이 수행된 IP 주소, 요청을 수행한 사람, 요청이 수행된 시간 및 추가 세부 정보를 확인할 수 있습니다. 자세한 내용은 [AWS CloudTrail을 사용하여 Amazon API Gateway API에 대한 직접 호출 로깅](cloudtrail.md) 단원을 참조하세요.
**AWS X-Ray**
X-Ray는 애플리케이션이 처리하는 요청에 대한 정보를 수집하고 이를 사용하여 애플리케이션 관련 문제와 최적화 기회를 찾는 데 사용할 수 있는 서비스 맵을 구성하는 AWS 서비스입니다. 자세한 내용은 [API Gateway REST API를 사용하여 AWS X-Ray 설정](apigateway-enabling-xray.md) 단원을 참조하세요.
**AWS Config**
AWS Config는 AWS 계정에 있는 리소스의 구성을 자세히 보여 줍니다. 리소스 간에 어떤 관계가 있는지 파악하고, 구성 변경 이력을 확인하고, 시간이 지나면서 구성과 관계가 어떻게 변하는지 확인할 수 있습니다. AWS Config를 사용해 리소스 구성이 데이터 규칙을 준수하는지 평가하는 규칙을 정의할 수 있습니다. AWS Config 규칙은 API Gateway 리소스에 대한 이상적인 구성 설정을 나타냅니다. 리소스가 규칙을 위반하고 규정 위반으로 플래그가 지정된 경우 AWS Config에서는 Amazon SNS(단순 알림 서비스) 주제를 사용하여 알림을 제공할 수 있습니다. 자세한 내용은 단원을 참조하십시오[로 API Gateway API 구성 모니터링AWS Config](apigateway-config.md)
# AWS CloudTrail을 사용하여 Amazon API Gateway API에 대한 직접 호출 로깅
Amazon API Gateway는 사용자, 역할 또는 AWS 서비스가 수행한 작업에 대한 레코드를 제공하는 서비스인 [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html)과 통합됩니다. CloudTrail은 API Gateway 서비스에 대한 모든 REST API 직접 호출을 이벤트로 캡처합니다. 캡처된 직접 호출에는 API 게이트웨이 콘솔에서의 직접 호출과 API 게이트웨이 서비스 API에 대한 코드 직접 호출이 포함됩니다. CloudTrail에서 수집한 정보를 사용하여 API Gateway에 수행된 요청, 요청이 수행된 IP 주소, 요청이 수행된 시간, 추가 세부 정보를 확인할 수 있습니다.
**참고**
[TestInvokeAuthorizer](https://docs.aws.amazon.com/cli/latest/reference/apigateway/test-invoke-authorizer.html) 및 [TestInvokeMethod](https://docs.aws.amazon.com/cli/latest/reference/apigateway/test-invoke-method.html)는 CloudTrail에서 로깅되지 않습니다.
모든 이벤트 또는 로그 항목에는 요청을 생성했던 사용자에 대한 정보가 포함됩니다. 자격 증명을 이용하면 다음을 쉽게 판단할 수 있습니다.
+ 요청을 루트 사용자로 했는지 사용자 보안 인증으로 했는지 여부.
+ IAM Identity Center 사용자를 대신하여 요청이 이루어졌는지 여부입니다.
+ 역할 또는 페더레이션 사용자에 대한 임시 자격 증명을 사용하여 요청이 생성되었는지 여부.
+ 다른 AWS 서비스에서 요청했는지 여부.
계정을 생성할 때 AWS 계정에서 CloudTrail이 활성 상태이며, CloudTrail **이벤트 기록**에 자동으로 액세스할 수 있습니다. CloudTrail **이벤트 기록**은 지난 90일 간 AWS 리전의 관리 이벤트에 대해 보기, 검색 및 다운로드가 가능하고, 수정이 불가능한 레코드를 제공합니다. 자세한 설명은 **AWS CloudTrail 사용 설명서의 [CloudTrail 이벤트 기록 작업](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html)을 참조하세요. **Event history(이벤트 기록)** 보기는 CloudTrail 요금이 부과되지 않습니다.
지난 90일 동안 AWS 계정에서 진행 중인 이벤트 기록을 보려면 추적 또는 [CloudTrail Lake](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake.html) 이벤트 데이터 스토어를 생성합니다.
**CloudTrail 추적**
CloudTrail은 *추적*을 사용하여 Amazon S3 버킷으로 로그 파일을 전송할 수 있습니다. AWS Management Console을 사용하여 만든 추적은 모두 다중 리전입니다. AWS CLI를 사용하여 단일 리전 또는 다중 리전 추적을 생성할 수 있습니다. 계정의 모든 AWS 리전에서 활동을 캡처하므로, 다중 리전 추적 생성이 권장됩니다. 단일 리전 추적을 생성하는 경우 추적의 AWS 리전에 로깅된 이벤트만 볼 수 있습니다. 추적에 대한 자세한 내용은 **AWS CloudTrail 사용 설명서의 [Creating a trail for your AWS 계정](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) 및 [Creating a trail for an organization](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-trail-organization.html)을 참조하세요.
CloudTrail에서 추적을 생성하여 진행 중인 관리 이벤트의 사본 하나를 Amazon S3 버킷으로 무료로 전송할 수는 있지만, Amazon S3 스토리지 요금이 부과됩니다. CloudTrail 요금에 대한 자세한 내용은 [AWS CloudTrail 요금](https://aws.amazon.com/cloudtrail/pricing/)을 참조하세요. Amazon S3 요금에 대한 자세한 내용은 [Amazon S3 요금](https://aws.amazon.com/s3/pricing/)을 참조하세요.
**CloudTrail Lake 이벤트 데이터 스토어**
*CloudTrail Lake*를 사용하면 이벤트에 대해 SQL 기반 쿼리를 실행할 수 있습니다. CloudTrail Lake는 행 기반 JSON 형식의 기존 이벤트를 [Apache ORC](https://orc.apache.org/) 형식으로 변환합니다. ORC는 빠른 데이터 검색에 최적화된 열 기반 스토리지 형식입니다. 이벤트는 *이벤트 데이터 스토어*로 집계되며, 이벤트 데이터 스토어는 [고급 이벤트 선택기](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-concepts.html#adv-event-selectors)를 적용하여 선택한 기준을 기반으로 하는 변경 불가능한 이벤트 컬렉션입니다. 이벤트 데이터 스토어에 적용하는 선택기는 어떤 이벤트가 지속되고 쿼리할 수 있는지 제어합니다. CloudTrail Lake에 대한 자세한 내용은 **AWS CloudTrail 사용 설명서의 [Working with AWS CloudTrail Lake](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake.html)를 참조하세요.
CloudTrail Lake 이벤트 데이터 스토어 및 쿼리에는 비용이 발생합니다. 이벤트 데이터 스토어를 생성할 때 이벤트 데이터 스토어에 사용할 [요금 옵션](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html#cloudtrail-lake-manage-costs-pricing-option)을 선택합니다. 요금 옵션에 따라 이벤트 모으기 및 저장 비용과 이벤트 데이터 스토어의 기본 및 최대 보존 기간이 결정됩니다. CloudTrail 요금에 대한 자세한 내용은 [AWS CloudTrail 요금](https://aws.amazon.com/cloudtrail/pricing/)을 참조하세요.
## CloudTrail의 API Gateway 관리 이벤트
[관리 이벤트](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events)는 AWS 계정의 리소스에 대해 수행되는 관리 작업에 대한 정보를 제공합니다. 이를 컨트롤 플레인 작업이라고도 합니다. 기본적으로 CloudTrail은 관리 이벤트를 로깅합니다.
Amazon API Gateway는 [TestInvokeAuthorizer](https://docs.aws.amazon.com/cli/latest/reference/apigateway/test-invoke-authorizer.html)와 [TestInvokeMethod](https://docs.aws.amazon.com/cli/latest/reference/apigateway/test-invoke-method.html)를 제외한 모든 API Gateway 작업을 관리 이벤트로 기록합니다. API Gateway가 CloudTrail에 기록하는 Amazon API Gateway 작업 목록은 [Amazon API Gateway API 참조](https://docs.aws.amazon.com/apigateway/latest/api/API_Operations.html)를 참조합니다.
## API Gateway 이벤트 예제
이벤트는 모든 소스로부터의 단일 요청을 나타내며 요청된 API 작업, 작업 날짜와 시간, 요청 파라미터 등에 대한 정보가 들어 있습니다. CloudTrail 로그 파일은 퍼블릭 API 직접 호출의 주문 스택 추적이 아니므로 이벤트가 특정 순서로 표시되지 않습니다.
다음 예에 API Gateway `GetResource` 작업을 보여 주는 CloudTrail 이벤트가 나와 있습니다.
```
{
Records: [
{
eventVersion: "1.03",
userIdentity: {
type: "Root",
principalId: "AKIAI44QH8DHBEXAMPLE",
arn: "arn:aws:iam::123456789012:root",
accountId: "123456789012",
accessKeyId: "AKIAIOSFODNN7EXAMPLE",
sessionContext: {
attributes: {
mfaAuthenticated: "false",
creationDate: "2015-06-16T23:37:58Z"
}
}
},
eventTime: "2015-06-17T00:47:28Z",
eventSource: "apigateway.amazonaws.com",
eventName: "GetResource",
awsRegion: "us-east-1",
sourceIPAddress: "203.0.113.11",
userAgent: "example-user-agent-string",
requestParameters: {
restApiId: "3rbEXAMPLE",
resourceId: "5tfEXAMPLE",
template: false
},
responseElements: null,
requestID: "6d9c4bfc-148a-11e5-81b6-7577cEXAMPLE",
eventID: "4d293154-a15b-4c33-9e0a-ff5eeEXAMPLE",
readOnly: true,
eventType: "AwsApiCall",
recipientAccountId: "123456789012"
},
... additional entries ...
]
}
```
CloudTrail 레코드 콘텐츠에 대한 자세한 내용은 **AWS CloudTrail 사용 설명서의 [CloudTrail record contents](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html)를 참조하세요.
# 로 API Gateway API 구성 모니터링AWS Config
[AWS Config](https://aws.amazon.com/config/)를 사용하여 API Gateway API 리소스에 대한 구성 변경을 기록하고, 리소스 변경을 기반으로 알림을 보낼 수 있습니다. API Gateway 리소스에 대한 구성 변경 기록을 유지 관리하면 운영 문제 해결, 감사 및 규정 준수 사용 사례에 도움이 됩니다.
AWS Config는 다음에 대한 변경을 추적할 수 있습니다.
+ 다음과 같은 **API 단계 구성**
+ 캐시 클러스터 설정
+ 스로틀 설정
+ 액세스 로그 설정
+ 단계의 활성 배포 세트
+ 다음과 같은 **API 구성**
+ 엔드포인트 구성
+ version
+ protocol
+ tags
또한 AWS Config 규칙 기능을 사용하여 구성 규칙을 정의하고, 이러한 규칙에 대한 위반을 자동으로 감지 및 추적하고 알릴 수 있습니다. 이러한 리소스 구성 속성의 변경 사항을 추적하면 API Gateway 리소스에 대해 변경으로 트리거되는 AWS Config 규칙을 작성하고, 모범 사례를 기준으로 리소스 구성을 테스트할 수도 있습니다.
계정에서 AWS Config 콘솔 또는 AWS Config를 사용하여 AWS CLI를 활성화할 수 있습니다. 그런 다음 변경 사항을 추적하려는 리소스 유형을 선택합니다. 이전에 구성한 AWS Config가 모든 리소스 유형을 기록하는 경우 이러한 API Gateway 리소스가 계정에 자동으로 기록됩니다. AWS Config의 Amazon API Gateway에 대한 지원은 모든 AWS 퍼블릭 리전 및 AWS GovCloud (US)에서 사용할 수 있습니다. 지원되는 리전의 전체 목록은 AWS 일반 참조에서 [Amazon API Gateway 엔드포인트 및 할당량](https://docs.aws.amazon.com/general/latest/gr/apigateway.html)을 참조하세요.
**Topics**
+ [지원되는 리소스 유형](#apigateway-config-resources-rules)
+ [설정AWS Config](#apigateway-config-setup)
+ [API Gateway 리소스를 기록하도록 AWS Config 구성](#apigateway-config-configuring)
+ [AWS Config 콘솔에서 API Gateway 구성 세부 정보 보기](#apigateway-config-console)
+ [AWS Config 규칙을 사용하여 API Gateway 리소스 평가](#apigateway-config-rules)
## 지원되는 리소스 유형
다음 API Gateway 리소스 유형은 AWS Config와 통합되며, [AWS Config 지원 AWS 리소스 유형과 리소스 관계](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html)에서 설명합니다.
+ `AWS::ApiGatewayV2::Api`(WebSocket 및 HTTP API)
+ `AWS::ApiGateway::RestApi`(REST API)
+ `AWS::ApiGatewayV2::Stage`(WebSocket 및 HTTP API 단계)
+ `AWS::ApiGateway::Stage`(REST API 단계)
AWS Config에 대한 자세한 내용은 [AWS Config개발자 안내서](https://docs.aws.amazon.com/config/latest/developerguide/) 단원을 참조하십시오. 요금에 대한 자세한 내용은 [AWS Config 요금 정보 페이지](https://aws.amazon.com/config/pricing/)를 참조하십시오.
**중요**
API를 배포한 후 다음과 같은 API 속성을 변경한 경우, *반드시* API를 [재배포](how-to-deploy-api.md)하여 변경을 전파해야 합니다. 이렇게 하지 않으면 AWS Config 콘솔에서는 속성 변경이 표시되지만, 이전 속성 설정이 여전히 유효하며 API의 런타임 동작이 변경되지 않습니다.
**`AWS::ApiGateway::RestApi`** – `binaryMediaTypes`, `minimumCompressionSize`, `apiKeySource`
**`AWS::ApiGatewayV2::Api`** – `apiKeySelectionExpression`
## 설정AWS Config
처음 AWS Config를 설정한다면 [AWS Config 개발자 안내서](https://docs.aws.amazon.com/config/latest/developerguide/)의 다음 주제를 참조하세요.
+ [콘솔을 사용하여 AWS Config 설정](https://docs.aws.amazon.com/config/latest/developerguide/gs-console.html)
+ [AWS CLI를 사용하여 AWS Config 설정](https://docs.aws.amazon.com/config/latest/developerguide/gs-cli.html)
## API Gateway 리소스를 기록하도록 AWS Config 구성
기본적으로 AWS Config는 해당 환경이 실행 중인 리전에서 검색하는 지원되는 모든 유형의 리전 리소스에 대한 구성 변경을 기록합니다. 특정 리소스 유형만의 변경 또는 글로벌 리소스 변경을 기록하도록 AWS Config를 사용자 지정할 수 있습니다.
리전 리소스와 글로벌 리소스를 확인하고 AWS Config 구성을 사용자 지정하는 방법을 알아보려면 [AWS Config가 기록할 리소스 선택](https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html)을 참조하십시오.
## AWS Config 콘솔에서 API Gateway 구성 세부 정보 보기
AWS Config 콘솔을 사용해 API Gateway 리소스를 찾고, 현재 및 과거 구성에 대한 세부 정보를 얻을 수 있습니다. 다음 절차는 API Gateway API에 대한 정보를 찾는 방법을 보여 줍니다.
**AWS config 콘솔에서 API Gateway 리소스 찾기**
1. [AWS Config 콘솔](https://console.aws.amazon.com/config)을 엽니다.
1. **리소스**를 선택합니다.
1. **리소스** 인벤토리 페이지에서 **리소스**를 선택합니다.
1. **리소스 유형(Resource type)** 메뉴를 열고 APIGateway 또는 APIGatewayV2로 스크롤 한 후 API Gateway 리소스 유형 중 하나 이상을 선택합니다.
1. **Look up(조회)**을 선택합니다.
1. AWS Config가 표시할 리소스 목록의 리소스 ID를 선택합니다. AWS Config는 선택한 리소스에 대한 구성의 세부 정보와 기타 정보를 표시합니다.
1. 기록이 된 구성의 세부 정보를 완전히 확인하려면 **세부 정보 보기**를 선택합니다.
이 페이지의 리소스 및 보기 정보를 찾는 방법에 대한 자세한 내용은 AWS Config 개발자 안내서의 [AWS 리소스 구성 및 기록 보기](https://docs.aws.amazon.com/config/latest/developerguide/view-manage-resource.html)를 참조하세요.
## AWS Config 규칙을 사용하여 API Gateway 리소스 평가
API Gateway 리소스에 대한 이상적인 구성 설정을 나타내는 AWS Config 규칙을 생성할 수 있습니다. 미리 정의된 [AWS Config 관리형 규칙](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html)을 사용하거나, 사용자 지정 규칙을 정의할 수 있습니다. AWS Config는 사용자 리소스의 구성을 계속 추적해 변경 사항이 사용자 규칙의 조건을 위반하는지 여부를 결정합니다. AWS Config 콘솔에는 규칙과 리소스의 준수 상태가 표시됩니다.
리소스가 규칙을 위반하고 규정 위반으로 플래그가 지정된 경우 AWS Config에서는 [Amazon Simple Notification Service 개발자 안내서](https://docs.aws.amazon.com/sns/latest/dg/)(Amazon SNS) 주제를 사용하여 알림을 제공할 수 있습니다. 이러한 AWS Config 알림의 데이터를 프로그래밍 방식으로 사용하려면 Amazon Simple Queue Service(Amazon SQS) 대기열을 Amazon SNS 주제의 알림 엔드포인트로 사용합니다.
규칙 설정 및 사용에 대한 자세한 내용은 [AWS Config 개발자 안내서](https://docs.aws.amazon.com/config/latest/developerguide/)의 [규칙으로 리소스 평가](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html)를 참조하세요.
# Amazon API Gateway에 대한 규정 준수 확인
AWS 서비스가 특정 규정 준수 프로그램의 범위에 포함되는지 알아보려면 [규정 준수 프로그램 제공 범위 내 AWS 서비스](https://aws.amazon.com/compliance/services-in-scope/)를 참조하고 관심 있는 규정 준수 프로그램을 선택하십시오. 일반적인 정보는 [AWS 규정 준수 프로그램](https://aws.amazon.com/compliance/programs/)을 참조하세요.
AWS Artifact(을)를 사용하여 타사 감사 보고서를 다운로드할 수 있습니다. 자세한 내용은 [AWS Artifact에서 보고서 다운로드](https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html)를 참조하세요.
AWS 서비스 사용 시 규정 준수 책임은 데이터의 민감도, 회사의 규정 준수 목표 및 관련 법률 및 규정에 따라 결정됩니다. AWS 서비스 사용 시 규정 준수 책임에 대한 자세한 내용은 [AWS 보안 설명서](https://docs.aws.amazon.com/security/)를 참조하세요.
# Amazon API Gateway의 복원성
AWS 글로벌 인프라는 AWS리전 및 가용 영역을 중심으로 구축됩니다. AWS 리전은 물리적으로 분리되고 격리된 다수의 가용 리전을 제공하며 이러한 가용 리전은 짧은 지연 시간, 높은 처리량 및 높은 중복성을 갖춘 네트워크에 연결되어 있습니다. 가용 영역을 사용하면 중단 없이 영역 간에 자동으로 장애 극복 조치가 이루어지는 애플리케이션 및 데이터베이스를 설계하고 운영할 수 있습니다. 가용 영역은 기존의 단일 또는 다중 데이터 센터 인프라보다 가용성, 내결함성, 확장성이 뛰어납니다.
완전관리형 리전 서비스인 API Gateway는 가용성 위험 범주로서의 인프라 장애를 최소화하기 위해 가용 영역의 이중화를 사용하여 각 리전의 여러 가용 영역에서 운영됩니다. API Gateway는 가용 영역 장애 발생 시 자동으로 복구하도록 설계되었습니다.
AWS 리전 및 가용 영역에 대한 자세한 내용은 [AWS 글로벌 인프라](https://aws.amazon.com/about-aws/global-infrastructure/)를 참조하십시오.
API가 너무 많은 요청에 의해 압도되는 것을 방지하기 위해 API에 대한 API Gateway 요청을 조절합니다. 특히 API Gateway에서는 계정의 모든 API에 대한 요청 제출 버스트 및 안정적인 상태의 속도에 관한 한도를 설정합니다. API에 대한 사용자 지정 조절을 구성할 수 있습니다. 자세한 내용은 [API Gateway의 처리량 향상을 위해 REST API에 대한 요청을 제한할 수 있습니다.](api-gateway-request-throttling.md)을 참조하십시오.
Route 53 상태 확인을 사용하여 기본 리전의 API Gateway API에서 보조 리전의 API Gateway API로의 DNS 장애 조치를 제어할 수 있습니다. 관련 예제는 [API Gateway API에 DNS 장애 조치에 대한 사용자 지정 상태 확인 구성](dns-failover.md) 섹션을 참조하세요
# Amazon API Gateway의 인프라 보안
관리형 서비스인 Amazon API Gateway는 AWS 글로벌 네트워크 보안으로 보호됩니다. AWS 보안 서비스와 AWS의 인프라 보호 방법에 대한 자세한 내용은 [AWS Cloud Security](https://aws.amazon.com/security/)을 참조하세요. 인프라 보안에 대한 모범 사례를 사용하여 AWS 환경을 설계하려면 보안 원칙 AWS Well‐Architected Framework**의 [인프라 보호](https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/infrastructure-protection.html)를 참조하세요.
AWS에서 게시한 API 직접 호출을 사용하여 네트워크를 통해 API Gateway에 액세스합니다. 고객은 다음을 지원해야 합니다.
+ Transport Layer Security(TLS) TLS 1.2는 필수이며 TLS 1.3을 권장합니다.
+ DHE(Ephemeral Diffie-Hellman) 또는 ECDHE(Elliptic Curve Ephemeral Diffie-Hellman)와 같은 완전 전송 보안(PFS)이 포함된 암호 제품군 Java 7 이상의 최신 시스템은 대부분 이러한 모드를 지원합니다.
이러한 API 작업은 어떤 네트워크 위치에서든 호출할 수 있지만, API Gateway는 소스 IP 주소에 따른 제한 사항을 포함할 수 있는 리소스 기반 액세스 정책을 지원합니다. 리소스 기반 정책을 사용하여 특정 Amazon Virtual Private Cloud(Amazon VPC) 엔드포인트 또는 특정 VPC에서 액세스를 제어할 수도 있습니다. 그러면 AWS 네트워크의 특정 VPC에서만 특정 API Gateway 리소스에 대한 네트워크 액세스가 효과적으로 격리됩니다.
# Amazon API Gateway의 취약성 분석
구성 및 IT 제어는 AWS와 고객 간의 공동 책임입니다. 자세한 내용은 AWS [공동 책임 모델](https://aws.amazon.com/compliance/shared-responsibility-model/)을 참조하십시오.
# Amazon API Gateway의 보안 모범 사례
API Gateway는 자체 보안 정책을 개발하고 구현할 때 고려해야 할 여러 보안 기능을 제공합니다. 다음 모범 사례는 일반적인 지침이며 완벽한 보안 솔루션을 나타내지는 않습니다. 이러한 모범 사례는 환경에 적절하지 않거나 충분하지 않을 수 있으므로 참고용으로만 사용해 주세요.
**최소 권한 액세스 구현**
IAM 정책을 사용하여 API Gateway API 생성, 읽기, 업데이트 또는 삭제에 대한 최소 권한 액세스를 구현합니다. 자세한 내용은 [Amazon API Gateway의 Identity and Access Management](security-iam.md) 단원을 참조하세요. API Gateway에서는 생성한 API에 대한 액세스를 제어하는 몇 가지 옵션을 제공합니다. 자세한 내용은 [API Gateway에서 REST API에 대한 액세스 제어 및 관리](apigateway-control-access-to-api.md), [API Gateway에서 WebSocket API에 대한 액세스 제어 및 관리](apigateway-websocket-api-control-access.md) 및 [API Gateway에서 JWT 권한 부여자를 사용하여 HTTP API에 대한 액세스 제어](http-api-jwt-authorizer.md) 단원을 참조하세요.
**로깅 구현**
CloudWatch Logs 또는 Amazon Data Firehose를 사용하여 API에 요청을 기록합니다. 자세한 내용은 [API Gateway에서 REST API 모니터링](rest-api-monitor.md), [API Gateway에서 WebSocket API 로깅 구성](websocket-api-logging.md) 및 [API Gateway에서 HTTP API 로깅 구성](http-api-logging.md) 단원을 참조하세요.
**Amazon CloudWatch 경보 구현**
CloudWatch 경보를 사용하면 지정한 기간 동안 단일 지표를 감시할 수 있습니다. 지표가 지정된 임계값을 초과하면 Amazon Simple Notification Service 주제 또는 AWS Auto Scaling 정책으로 알림이 전송됩니다. CloudWatch 경보는 지표가 특정 상태에 있다고 해서 작업을 호출하지 않습니다. 대신, 상태가 변경되어 지정된 기간 동안 유지되어야 합니다. 자세한 내용은 [Amazon CloudWatch 지표를 사용한 REST API 실행 모니터링](monitoring-cloudwatch.md) 단원을 참조하세요.
**AWS CloudTrail 활성화**
CloudTrail은 API Gateway에서 사용자, 역할 또는 AWS 서비스가 수행한 작업의 기록을 제공합니다. CloudTrail에서 수집한 정보를 사용하여 API Gateway에 수행된 요청, 요청이 수행된 IP 주소, 요청을 수행한 사람, 요청이 수행된 시간 및 추가 세부 정보를 확인할 수 있습니다. 자세한 내용은 [AWS CloudTrail을 사용하여 Amazon API Gateway API에 대한 직접 호출 로깅](cloudtrail.md) 단원을 참조하세요.
**AWS Config 활성화**
AWS Config는 AWS 계정에 있는 리소스의 구성을 자세히 보여 줍니다. 리소스 간에 어떤 관계가 있는지 파악하고, 구성 변경 이력을 확인하고, 시간이 지나면서 구성과 관계가 어떻게 변하는지 확인할 수 있습니다. AWS Config를 사용해 리소스 구성이 데이터 규칙을 준수하는지 평가하는 규칙을 정의할 수 있습니다. AWS Config 규칙은 API Gateway 리소스에 대한 이상적인 구성 설정을 나타냅니다. 리소스가 규칙을 위반하고 규정 위반으로 플래그가 지정된 경우 AWS Config에서는 Amazon SNS(단순 알림 서비스) 주제를 사용하여 알림을 제공할 수 있습니다. 자세한 내용은 [로 API Gateway API 구성 모니터링AWS Config](apigateway-config.md)을 참조하세요.
**AWS Security Hub CSPM 사용**
[AWS Security Hub CSPM](https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html)을 사용하여 보안 모범 사례와 관련된 API Gateway의 사용량을 모니터링하세요. Security Hub CSPM은 *보안 제어*를 사용하여 리소스 구성 및 *보안 표준*을 평가하여 다양한 규정 준수 프레임워크를 준수할 수 있도록 지원합니다. Security Hub CSPM을 사용하여 Lambda 리소스를 평가하는 방법에 대한 자세한 내용은 *AWS Security Hub 사용자 설명서*의 [Amazon API Gateway 제어](https://docs.aws.amazon.com/securityhub/latest/userguide/apigateway-controls.html)를 참조하세요.