프라이빗 API 생성

다음 create-vpc-endpoint 명령을 사용하여 VPC 엔드포인트를 생성할 수 있습니다.

aws ec2 create-vpc-endpoint \
    --vpc-id vpc-1a2b3c4d \
    --vpc-endpoint-type Interface \
    --service-name com.amazonaws.us-east-1.execute-api \
    --subnet-ids subnet-7b16de0c \
    --security-group-id sg-1a2b3c4d

이후 단계에서 사용할 수 있도록 결과 VPC 엔드포인트 ID를 복사합니다.

이전 단계를 완료한 후에 REST API 콘솔 시작하기의 지침에 따라 이 API에 대해 메서드와 통합을 설정할 수 있습니다. 하지만 API를 배포할 수는 없습니다. API를 배포하려면 3단계를 따르고 API에 리소스 정책을 연결합니다.

다음 update-rest-api 명령은 프라이빗 API를 생성하는 방법을 보여줍니다.

aws apigateway create-rest-api \
        --name 'Simple PetStore (AWS CLI, Private)' \
        --description 'Simple private PetStore API' \
        --region us-west-2 \
        --endpoint-configuration '{ "types": ["PRIVATE"] }'

성공적으로 호출되면 다음과 비슷한 출력 결과를 반환합니다.

{
    "createdDate": "2017-10-13T18:41:39Z",
    "description": "Simple private PetStore API",
    "endpointConfiguration": {
        "types": "PRIVATE"
    },
    "id": "0qzs2sy7bh",
    "name": "Simple PetStore (AWS CLI, Private)"
}

이전 단계를 완료한 후에 튜토리얼: AWS SDK 또는 AWS CLI를 사용하여 엣지 최적화 API 생성의 지침에 따라 이 API에 대해 메서드와 통합을 설정할 수 있습니다. 하지만 API를 배포할 수는 없습니다. API를 배포하려면 3단계를 따르고 API에 리소스 정책을 연결합니다.

다음 예시는 AWS SDK for JavaScript v3를 사용하여 프라이빗 API를 생성하는 방법을 보여줍니다.

import {APIGatewayClient, CreateRestApiCommand} from "@aws-sdk/client-api-gateway";
const apig = new APIGatewayClient({region:"us-east-1"});

const input = { // CreateRestApiRequest
  name: "Simple PetStore (JavaScript v3 SDK, private)", // required
  description: "Demo private API created using the AWS SDK for JavaScript v3",
  version: "0.00.001",
  endpointConfiguration: { // EndpointConfiguration
    types: [ "PRIVATE"],
  },  
};

export const handler = async (event) => {
const command = new CreateRestApiCommand(input);
try {
  const result = await apig.send(command);
  console.log(result);
} catch (err){
  console.error(err)
 }
};

성공적으로 호출되면 다음과 비슷한 출력 결과를 반환합니다.

{
  apiKeySource: 'HEADER',
  createdDate: 2024-04-03T17:56:36.000Z,
  description: 'Demo private API created using the AWS SDK for JavaScript v3',
  disableExecuteApiEndpoint: false,
  endpointConfiguration: { types: [ 'PRIVATE' ] },
  id: 'abcd1234',
  name: 'Simple PetStore (JavaScript v3 SDK, private)',
  rootResourceId: 'efg567',
  version: '0.00.001'
}

이전 단계를 완료한 후에 튜토리얼: AWS SDK 또는 AWS CLI를 사용하여 엣지 최적화 API 생성의 지침에 따라 이 API에 대해 메서드와 통합을 설정할 수 있습니다. 하지만 API를 배포할 수는 없습니다. API를 배포하려면 3단계를 따르고 API에 리소스 정책을 연결합니다.

다음 예시는 AWS SDK for Python을 사용하여 프라이빗 API를 생성하는 방법을 보여줍니다.

import json
import boto3
import logging

logger = logging.getLogger()
apig = boto3.client('apigateway')

def lambda_handler(event, context):
    try:
      result = apig.create_rest_api(
      name='Simple PetStore (Python SDK, private)',
      description='Demo private API created using the AWS SDK for Python',
      version='0.00.001',
      endpointConfiguration={
          'types': [
             'PRIVATE',
          ],
      },
      )
    except botocore.exceptions.ClientError as error:
            logger.exception("Couldn't create private API %s.", error)
            raise
    attribute=["id", "name", "description", "createdDate", "version", "apiKeySource", "endpointConfiguration"]
    filtered_data ={key:result[key] for key in attribute}
    result = json.dumps(filtered_data, default=str, sort_keys='true')
    return result

성공적으로 호출되면 다음과 비슷한 출력 결과를 반환합니다.

"{\"apiKeySource\": \"HEADER\", \"createdDate\": \"2024-04-03 17:27:05+00:00\", \"description\": \"Demo private API created using the AWS SDK for \", \"endpointConfiguration\": {\"types\": [\"PRIVATE\"]}, \"id\": \"abcd1234\", \"name\": \"Simple PetStore (Python SDK, private)\", \"version\": \"0.00.001\"}"

이전 단계를 완료한 후에 튜토리얼: AWS SDK 또는 AWS CLI를 사용하여 엣지 최적화 API 생성의 지침에 따라 이 API에 대해 메서드와 통합을 설정할 수 있습니다. 하지만 API를 배포할 수는 없습니다. API를 배포하려면 3단계를 따르고 API에 리소스 정책을 연결합니다.

다음 update-rest-api 명령은 기존 API에 리소스 정책을 연결하는 방법을 보여줍니다.

aws apigateway update-rest-api \
    --rest-api-id a1b2c3 \
    --patch-operations op=replace,path=/policy,value='"{\"jsonEscapedPolicyDocument\"}"'

VPC 엔드포인트를 생성할 때 또는 생성한 후에 프라이빗 API와 연결할 수 있습니다. 다음 절차는 VPC 엔드포인트를 이전에 생성된 API와 연결하는 방법을 보여줍니다.

다음 create-rest-api 명령은 API 생성 시 VPC 엔드포인트를 연결하는 방법을 보여줍니다.

aws apigateway create-rest-api \
    --name Petstore \
    --endpoint-configuration '{ "types": ["PRIVATE"], "vpcEndpointIds" : ["vpce-0212a4ababd5b8c3e", "vpce-0393a628149c867ee"] }' \
    --region us-west-2

출력은 다음과 같습니다.

{
    "apiKeySource": "HEADER",
    "endpointConfiguration": {
        "types": [
            "PRIVATE"
        ],
        "vpcEndpointIds": [
            "vpce-0212a4ababd5b8c3e",
            "vpce-0393a628149c867ee"
        ]
    },
    "id": "u67n3ov968",
    "createdDate": 1565718256,
    "name": "Petstore"
}
            

다음 update-rest-api 명령은 이미 생성한 API에 VPC 엔드포인트를 연결하는 방법을 보여줍니다.

aws apigateway update-rest-api \
    --rest-api-id u67n3ov968 \
    --patch-operations "op='add',path='/endpointConfiguration/vpcEndpointIds',value='vpce-01d622316a7df47f9'" \
    --region us-west-2

출력은 다음과 같습니다.

{
    "name": "Petstore",
    "apiKeySource": "1565718256",
    "tags": {},
    "createdDate": 1565718256,
    "endpointConfiguration": {
        "vpcEndpointIds": [
            "vpce-0212a4ababd5b8c3e",
            "vpce-0393a628149c867ee",
            "vpce-01d622316a7df47f9"
        ],
        "types": [
            "PRIVATE"
        ]
    },
    "id": "u67n3ov968"
}

변경 사항을 적용하려면 API를 재배포합니다.

다음 update-rest-api 명령은 프라이빗 API에서 VPC 엔드포인트 연결을 해제하는 방법을 보여줍니다.

aws apigateway update-rest-api \
    --rest-api-id u67n3ov968 \
    --patch-operations "op='remove',path='/endpointConfiguration/vpcEndpointIds',value='vpce-0393a628149c867ee'" \
    --region us-west-2

출력은 다음과 같습니다.

{
    "name": "Petstore",
    "apiKeySource": "1565718256",
    "tags": {},
    "createdDate": 1565718256,
    "endpointConfiguration": {
        "vpcEndpointIds": [
            "vpce-0212a4ababd5b8c3e",
            "vpce-01d622316a7df47f9"
        ],
        "types": [
            "PRIVATE"
        ]
    },
    "id": "u67n3ov968"
}

변경 사항을 적용하려면 API를 재배포합니다.

다음 create-deployment 명령은 프라이빗 API를 배포하는 방법을 보여줍니다.

aws apigateway create-deployment --rest-api-id a1b2c3 \ 
  --stage-name test \
  --stage-description 'Private API test stage' \
  --description 'First deployment'