Feature request: Support DisableExecuteApiEndpoint for Serverless::HttpApi with DefinitionUri

[LesUski]

Support DisableExecuteApiEndpoint: true when creating AWS::Serverless::HttpApi with DefinitionUri.

Proposal

When running sam validate on a template with resource Serverless::HttpApi with DefinitionUri property allow disabling the execute API endpoint.

template.yaml

HttpApi:
    Type: AWS::Serverless::HttpApi
    Properties:
        DefinitionUri:
            Bucket: !Ref Bucket
            Key: 'openapi.yaml'
        DisableExecuteApiEndpoint: true

That raises error: `[InvalidResourceException('HttpApi', "DisableExecuteApiEndpoint works only within 'DefinitionBody' property.")]

The alternative way with 'DefinitionBody' property doesn't solve the problem instead leads to another one. When trying to create HttpApi with:

template.yaml

HttpApi:
    Type: AWS::Serverless::HttpApi
    Properties:
        DefinitionBody:
            'Fn::Transform':
                Name: 'AWS::Include'
                Parameters:
                    Location: './openapi.yaml'
        DisableExecuteApiEndpoint: true

Another error is being raised: [InvalidTemplateException("Invalid OpenApi document. Invalid values or missing keys for 'openapi' or 'paths' in 'DefinitionBody'.")]

openapi.yaml

openapi: 3.0.1
info:
    title: 'api'
    version: '1.0'
    description: test
paths:
    /hello:
        get:
...

Additional Details

SAM CLI, version 1.81.0

[sriram-mv]

aws-sam-translator powers sam validate. I'm moving this issue to the aws sam translator repository.

[aaythapa]

Hi @CloudedThings, thanks for reporting this.

When you define DisableExecuteApiEndpoint it doesn't actually get passed through to the DisableExecuteApiEndpoint property of an AWS::ApiGatewayV2::Api resource. It gets passed into the x-amazon-apigateway-endpoint-configuration OpenApi extension instead (our docs are don't reflect this yet, we'll be updating them). So when you use DisableExecuteApiEndpoint with DefinitionUri we can't change the OpenApi definition, thus we can't add the extension.

Using DisableExecuteApiEndpoint with DefinitionBody, we should be able to change the OpenApi definition. I used your template and was able to reproduce the error message. Seems the issue was related to the intrinsic rather than the property. Using the AWS::LanguageExtensions transform made the template deployable and should work for you as well (see #2533 for more info on language extensions).

Closing this issue for now, please re-open if needed.