aws / aws/aws-toolkit-vscode

sam.schema.json: VPCEndpointIds: CloudFormation construct not recognized

Open
#3,200 1 comment 0 reactions 0 assignees View on GitHub
aws-documents aws-documents-sam-cfn bug
Dominant language
TypeScript
Stars
2k
Forks
807
Avg merge
10h 12m
Merged PRs (30d)
7

Description

## Problem

## Steps to reproduce the issue

when specifying VPCEndpointIds: in a AWS::Serverless::Api resource I get a validation error:
`Property VPCEndpointIds is not allowed.yaml-schema: aws://sam.schema.json`

ApiGateway:
Type: AWS::Serverless::Api
DependsOn: ApiCWLRoleArn
Properties:
EndpointConfiguration:
Type: PRIVATE
VPCEndpointIds: # Property VPCEndpointIds is not allowed.yaml-schema: aws://sam.schema.json
- !Ref APIGWVPCEndpoint
Name: !Ref apiName
StageName: "Prod"
TracingEnabled: True
DefinitionBody:
'Fn::Transform':
Name: 'AWS::Include'
Parameters:
Location: './api.yml'

## Expected behavior

- validation error should not pop up

## System details (run the `AWS: About Toolkit` command)

Desktop (please complete the following information):
OS: MacOS 13.1 (Ventura)
Visual Studio Code Version: v1.75.1
AWS Toolkit Version: v1.63.0

Contributor guide

Open the contributing guide

Research direction

Start by locating sam.schema.json and inspect the AWS::Serverless::Api EndpointConfiguration definition. Reproduce the validation error with the VPCEndpointIds example, then update the schema so this CloudFormation construct is accepted and verify the warning no longer appears.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, vscode
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.