Amazon API Gateway에서 IAM을 사용하는 방식 - Amazon API Gateway
API Gateway 자격 증명 기반 정책API Gateway 리소스 기반 정책API Gateway 태그 기반 권한 부여API Gateway IAM 역할

Amazon API Gateway에서 IAM을 사용하는 방식

IAM을 사용하여 API Gateway에 대한 액세스를 관리하기 전에 API Gateway에서 사용할 수 있는 IAM 기능을 이해해야 합니다. API Gateway 및 기타 AWS 서비스에서 IAM을 사용하는 방법을 전체적으로 알아보려면 IAM 사용 설명서의 IAM으로 작업하는 AWS 서비스를 참조하세요.

API Gateway 자격 증명 기반 정책

IAM 자격 증명 기반 정책을 사용하면 허용되거나 거부되는 작업과 리소스뿐 아니라 작업이 허용되거나 거부되는 조건을 지정할 수 있습니다. API Gateway는 특정 작업, 리소스 및 조건 키를 지원합니다. API Gateway 관련 작업, 리소스 및 조건 키에 대한 자세한 내용은 Amazon API Gateway Management에 사용되는 작업, 리소스 및 조건 키 및 Amazon API Gateway Management V2에 사용되는 작업, 리소스 및 조건 키를 참조하세요. JSON 정책에서 사용하는 모든 요소에 대한 자세한 내용은 IAM 사용 설명서의 IAM JSON 정책 요소 참조를 참조합니다.

다음 예제에서는 사용자가 프라이빗 REST API만 생성하거나 업데이트할 수 있도록 허용하는 자격 증명 기반 정책을 보여 줍니다. 더 많은 예제는 Amazon API Gateway 자격 증명 기반 정책 예제를 참조합니다.

{
  "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(리소스 업데이트용) 또는 *(모든 이전 작업) 중 하나입니다.

다음은 Action 표현식의 몇 가지 예입니다.

  • apigateway:*: 모든 API Gateway 작업

  • apigateway:GET: API Gateway의 GET 작업만

명령문 하나에 여러 작업을 지정하려면 다음과 같이 쉼표로 구분합니다.

"Action": [
      "apigateway:action1",
      "apigateway:action2"

특정 API Gateway 작업에 사용할 HTTP 동사에 대한 자세한 내용은 Amazon API Gateway 버전 1 API 참조(REST API) 및 Amazon API Gateway 버전 2 API 참조(WebSocket 및 HTTP API)를 참조하세요.

자세한 내용은 Amazon API Gateway 자격 증명 기반 정책 예제 단원을 참조하십시오.

리소스

관리자는 AWSJSON 정책을 사용하여 누가 무엇에 액세스할 수 있는지를 지정할 수 있습니다. 즉, 어떤 보안 주체가 어떤 리소스와 어떤 조건에서 작업을 수행할 수 있는지를 지정할 수 있습니다.

Resource JSON 정책 요소는 작업이 적용되는 하나 이상의 개체를 지정합니다. 문장에는 Resource또는 NotResource요소가 반드시 추가되어야 합니다. 모범 사례에 따라 Amazon 리소스 이름(ARN)을 사용하여 리소스를 지정합니다. 리소스 수준 권한이라고 하는 특정 리소스 유형을 지원하는 작업에 대해 이 태스크를 수행할 수 있습니다.

작업 나열과 같이 리소스 수준 권한을 지원하지 않는 작업의 경우 와일드카드(*)를 사용하여 명령문이 모든 리소스에 적용됨을 나타냅니다.

"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 및 하위 리소스를 지정하려면 와일드카드(*)를 사용합니다.

"Resource": "arn:aws:apigateway:us-east-2::/restapis/*"

API Gateway 리소스 유형 및 해당 ARN 목록은 API Gateway Amazon 리소스 이름(ARN) 참조 단원을 참조하세요.

조건 키

관리자는 AWSJSON 정책을 사용하여 누가 무엇에 액세스할 수 있는지를 지정할 수 있습니다. 즉, 어떤 보안 주체가 어떤 리소스와 어떤 조건에서 작업을 수행할 수 있는지를 지정할 수 있습니다.

Condition 요소(또는 Condition 블록)를 사용하면 정책이 발효되는 조건을 지정할 수 있습니다. Condition 요소는 옵션입니다. 같거나 작음과 같은 조건 연산자를 사용하여 정책의 조건을 요청의 값과 일치시키는 조건식을 생성할 수 있습니다.

한 문에서 여러 Condition 요소를 지정하거나 단일 Condition 요소에서 여러 키를 지정하는 경우, AWS는 논리적 AND 태스크를 사용하여 평가합니다. 단일 조건 키의 여러 값을 지정하는 경우, AWS는 논리적 OR 태스크를 사용하여 조건을 평가합니다. 명문의 권한을 부여하기 전에 모든 조건을 충족해야 합니다.

조건을 지정할 때 자리 표시자 변수를 사용할 수도 있습니다. 예컨대, IAM 사용자에게 IAM 사용자 이름으로 태그가 지정된 경우에만 리소스에 액세스할 수 있는 권한을 부여할 수 있습니다. 자세한 내용은 IAM 사용 설명서의 IAM 정책 요소: 변수 및 태그를 참조하세요.

AWS는 전역 조건 키와 서비스별 조건 키를 지원합니다. 모든 AWS 전역 조건 키를 보려면 IAM 사용 설명서의 AWS 전역 조건 컨텍스트 키를 참조하세요.

API Gateway는 자체 조건 키 세트를 정의하고 일부 전역 조건 키 사용도 지원합니다. API Gateway 조건 키 목록은 IAM 사용 설명서의 Amazon API Gateway의 조건 키를 참조하세요. 조건 키를 사용할 수 있는 작업과 리소스에 대한 내용은 Amazon API Gateway에서 정의한 작업을 참조하세요.

속성 기반 액세스 제어를 포함하여 태그 지정에 대한 자세한 내용은 API Gateway 리소스 태그 지정 섹션을 참조하세요.

예시

API Gateway 자격 증명 기반 정책의 예는 Amazon API Gateway 자격 증명 기반 정책 예제 단원을 참조하세요.

API Gateway 리소스 기반 정책

리소스 기반 정책은 지정된 보안 주체가 API Gateway 리소스에 대해 어떤 작업을 어떤 조건에서 수행할 수 있는지를 지정하는 JSON 정책 문서입니다. API Gateway는 REST API에 대한 리소스 기반 권한 정책을 지원합니다. 리소스 정책을 사용하여 REST API를 호출할 수 있는 사용자를 제어합니다. 자세한 내용은 API Gateway 리소스 정책을 사용하여 REST API에 대한 액세스 제어 단원을 참조하십시오.

예시

API Gateway 리소스 기반 정책의 예는 API Gateway 리소스 정책 예제 단원을 참조하세요.

API Gateway 태그 기반 권한 부여

API Gateway 리소스에 태그를 연결하거나 요청에서 태그를 API Gateway에 전달할 수 있습니다. 태그를 기반으로 액세스를 제어하려면 apigateway:ResourceTag/key-name, aws:RequestTag/key-name 또는 aws:TagKeys 조건 키를 사용하여 정책의 조건 요소에 태그 정보를 제공합니다. API Gateway 리소스에 태그를 지정하는 방법에 대한 자세한 내용은 태그를 사용하여 API Gateway REST API 리소스에 대한 액세스 제어 단원을 참조하십시오.

리소스의 태그를 기반으로 리소스에 대한 액세스를 제한하는 자격 증명 기반 정책의 예는 태그를 사용하여 API Gateway REST API 리소스에 대한 액세스 제어 단원을 참조하세요.

API Gateway IAM 역할

IAM 역할은 특정 권한을 가지고 있는 AWS 계정 내 개체입니다.

API Gateway에 임시 자격 증명 사용

임시 자격 증명을 사용하여 페더레이션을 통해 로그인하거나, IAM 역할을 맡거나, 교차 계정 역할을 맡을 수 있습니다. AssumeRole 또는 GetFederationToken 같은 AWS STS API 작업을 호출하여 임시 보안 자격 증명을 가져옵니다.

API Gateway는 임시 자격 증명 사용을 지원합니다.

서비스 연결 역할

서비스 연결 역할을 사용하면 AWS 서비스에서 다른 서비스의 리소스에 액세스하여 사용자 대신 작업을 완료할 수 있습니다. 서비스 연결 역할은 IAM 계정에 나타나고 서비스가 소유합니다. IAM 관리자는 서비스 연결 역할의 권한을 볼 수 있지만 편집은 할 수 없습니다.

API Gateway는 서비스 연결 역할을 지원합니다. API Gateway 서비스 연결 역할을 생성하거나 관리하는 방법에 대한 자세한 내용은 API Gateway에 서비스 연결 역할 사용 단원을 참조하세요.

서비스 역할

서비스가 귀하를 대신해 서비스 역할을 맡을 수 있습니다. 서비스 역할을 사용하면 서비스는 다른 서비스의 리소스에 액세스해 사용자를 대신해 작업을 완료할 수 있습니다. 서비스 역할은 IAM 계정에 표시되며 계정에서 소유하므로 관리자가 이 역할에 대한 권한을 변경할 수 있습니다. 그러나 권한을 변경하면 서비스의 기능이 손상될 수 있습니다.

API Gateway는 서비스 역할을 지원합니다.