在 python 中使用 cloudformation 在 ApiGateway 中为私有类型设置端点 ID

Question

我正在创建一个 YAML 格式的模板来创建堆栈。在 api 网关中，我想为私有类型的端点 id 设置一个值。有没有办法在模板中做到这一点？或者我可以使用 boto3 吗？

ApiGateway：

Type: 'AWS::ApiGateway::RestApi'
Properties:
  Description: A test API
  Name: !Ref ApiName
  EndpointConfiguration:
    Types:
      - "PRIVATE"
    vpcEndpointIds:
      - !Ref VPC

此代码给出没有属性 vpcEndpointIds 的错误。

Answer 1

Cloudforamtion 不支持。这可以使用 boto3 api 网关客户端完成：

client_api_gateway.update_rest_api(restApiId=self.api_id,
                                            patchOperations=[
                                                {
                                                    'op': 'add',
                                                    'path': '/endpointConfiguration/vpcEndpointIds',
                                                    'value': vpc_endpoint_id
                                                }
                                            ])

Answer 2

从这个cloudformation 文档看来，它现在已添加到cloudformation。但是aws-cdk 似乎没有反映此更新，但假设cloudformation 文档反映了当前状态，以下（未经测试的）代码应该可以得到您想要的。

const api = new RestApi(this, 'APIGateway', {
    deploy: true,
    deployOptions: {
        stageName: 'live',
        tracingEnabled: true,
    },
    endpointTypes: [EndpointType.PRIVATE],
    retainDeployments: false,
    restApiName: 'my-api',
    description: 'an api',
});

const cfnApi = api.node.defaultChild as CfnMethod;

cfnApi.addOverride('Properties.EndpointConfiguration.VpcEndpointIds', ['12345']);

请参阅此处here，了解向构造添加缺失功能的详细信息。