Erstellen Sie eine private API

Der folgende create-vpc-endpointBefehl kann verwendet werden, um einen VPC Endpunkt zu erstellen:

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

Kopieren Sie die resultierende VPC Endpunkt-ID, da Sie sie in future Schritten verwenden könnten.

Nachdem Sie die vorherigen Schritte abgeschlossen haben, können Sie den Anweisungen unter folgenErste Schritte mit der REST API Konsole, um Methoden und Integrationen dafür einzurichtenAPI, aber Sie können Ihre API nicht bereitstellen. Um Ihre bereitzustellenAPI, folgen Sie Schritt 3 und fügen Sie Ihrem API eine Ressourcenrichtlinie bei.

Der folgende create-rest-apiBefehl zeigt, wie Sie ein privates erstellenAPI:

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

Bei einem erfolgreichen Aufruf sieht die zurückgegebene Ausgabe in etwa wie folgt aus:

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

Nachdem Sie die vorherigen Schritte abgeschlossen haben, können Sie den Anweisungen unter folgenTutorial: Erstellen Sie eine REST-API mit AWS SDKs oder AWS CLI, um Methoden und Integrationen dafür einzurichtenAPI, aber Sie können Ihre API nicht bereitstellen. Um Ihre bereitzustellenAPI, folgen Sie Schritt 3 und fügen Sie Ihrem API eine Ressourcenrichtlinie bei.

Das folgende Beispiel zeigt, wie Sie mithilfe API von AWS SDK for JavaScript v3 eine private Datei erstellen:

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)
 }
};

Bei einem erfolgreichen Aufruf sieht die zurückgegebene Ausgabe in etwa wie folgt aus:

{
  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'
}

Nachdem Sie die vorherigen Schritte abgeschlossen haben, können Sie den Anweisungen unter folgenTutorial: Erstellen Sie eine REST-API mit AWS SDKs oder AWS CLI, um Methoden und Integrationen dafür einzurichtenAPI, aber Sie können Ihre API nicht bereitstellen. Um Ihre bereitzustellenAPI, folgen Sie Schritt 3 und fügen Sie Ihrem API eine Ressourcenrichtlinie bei.

Das folgende Beispiel zeigt, wie Sie mithilfe API von AWS SDK for Python eine private erstellen:

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

Bei einem erfolgreichen Aufruf sieht die zurückgegebene Ausgabe in etwa wie folgt aus:

"{\"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\"}"

Nachdem Sie die vorherigen Schritte abgeschlossen haben, können Sie den Anweisungen unter folgenTutorial: Erstellen Sie eine REST-API mit AWS SDKs oder AWS CLI, um Methoden und Integrationen dafür einzurichtenAPI, aber Sie können Ihre API nicht bereitstellen. Um Ihre bereitzustellenAPI, folgen Sie Schritt 3 und fügen Sie Ihrem API eine Ressourcenrichtlinie bei.

Der folgende update-rest-apiBefehl zeigt, wie eine Ressourcenrichtlinie an eine bestehende angehängt wird: API

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

Sie können einen VPC Endpunkt Ihrem privaten Endpunkt zuordnen, API wenn Sie ihn erstellen oder nachdem er erstellt wurde. Das folgende Verfahren zeigt, wie Sie einen VPC Endpunkt einem zuvor erstellten Endpunkt zuordnenAPI.

Der folgende create-rest-apiBefehl zeigt, wie VPC Endpunkte zum Zeitpunkt der API Erstellung verknüpft werden:

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

Die Ausgabe sieht wie folgt aus:

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

Der folgende update-rest-apiBefehl zeigt, wie API Sie VPC Endpoints einem bereits erstellten zuordnen:

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

Die Ausgabe sieht wie folgt aus:

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

Stellen Sie Ihre API erneut bereit, damit die Änderungen wirksam werden.

Der folgende update-rest-apiBefehl zeigt, wie Sie die Zuordnung eines VPC Endpunkts zu einem privaten Endpunkt aufheben können: API

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

Die Ausgabe sieht wie folgt aus:

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

Stellen Sie Ihre API erneut bereit, damit die Änderungen wirksam werden.

Der folgende Befehl create-deployment zeigt, wie Sie einen privaten bereitstellen: API

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